NetBSD Problem Report #56607

From www@netbsd.org  Wed Jan  5 17:02:52 2022
Return-Path: <www@netbsd.org>
Received: from mail.netbsd.org (mail.netbsd.org [199.233.217.200])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits))
	(Client CN "mail.NetBSD.org", Issuer "mail.NetBSD.org CA" (not verified))
	by mollari.NetBSD.org (Postfix) with ESMTPS id 17CB81A9239
	for <gnats-bugs@gnats.NetBSD.org>; Wed,  5 Jan 2022 17:02:52 +0000 (UTC)
Message-Id: <20220105170250.9F4CC1A923A@mollari.NetBSD.org>
Date: Wed,  5 Jan 2022 17:02:50 +0000 (UTC)
From: jlmuir@imca-cat.org
Reply-To: jlmuir@imca-cat.org
To: gnats-bugs@NetBSD.org
Subject: Inconsistent and misspelled shebang terms in pkgsrc Developer's Guide
X-Send-Pr-Version: www-1.0

>Number:         56607
>Category:       pkg
>Synopsis:       Inconsistent and misspelled shebang terms in pkgsrc Developer's Guide
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    gutteridge
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Wed Jan 05 17:05:00 +0000 2022
>Closed-Date:    Thu Jun 02 21:22:58 +0000 2022
>Last-Modified:  Thu Jun 02 21:22:58 +0000 2022
>Originator:     J. Lewis Muir
>Release:        current
>Organization:
>Environment:
>Description:
In

  https://netbsd.org/docs/pkgsrc/fixes.html

if you search for "bang", you will find the following two terms used:

1. she-bang
2. hash bang

Those are misspelled, and it would be better to use one term throughout for the construct.
>How-To-Repeat:

>Fix:
For the first, I haven't seen "she-bang" (i.e., with a dash); I think that would normally be "shebang" (i.e., without a dash).  Wikipedia

  https://en.wikipedia.org/wiki/Shebang_(Unix)

does list "sha-bang" if perhaps that was the intended spelling.

For the second, that should probably be "hash-bang" (i.e., with a dash), again according to Wikipedia (which lists sources).

For the whole guide (which is just fixes.xml as far as I can tell), I think it would be better to choose one term to use throughout.  My vote would be "shebang", but whatever is chosen, it should be consistently used.

>Release-Note:

>Audit-Trail:

Responsible-Changed-From-To: pkg-manager->gutteridge
Responsible-Changed-By: gutteridge@NetBSD.org
Responsible-Changed-When: Thu, 02 Jun 2022 21:14:37 +0000
Responsible-Changed-Why:
I'll handle this.

From: "David H. Gutteridge" <gutteridge@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/56607 CVS commit: pkgsrc/doc/guide/files
Date: Thu, 2 Jun 2022 21:20:32 +0000

 Module Name:	pkgsrc
 Committed By:	gutteridge
 Date:		Thu Jun  2 21:20:32 UTC 2022

 Modified Files:
 	pkgsrc/doc/guide/files: fixes.xml

 Log Message:
 fixes.xml: use "she-bang" consistently, and tweak wording

 Addresses PR pkg/56607 from J. Lewis Muir.


 To generate a diff of this commit:
 cvs rdiff -u -r1.178 -r1.179 pkgsrc/doc/guide/files/fixes.xml

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

State-Changed-From-To: open->closed
State-Changed-By: gutteridge@NetBSD.org
State-Changed-When: Thu, 02 Jun 2022 21:22:58 +0000
State-Changed-Why:
The guide is now consistent, thanks.

>Unformatted:

Home	PR Database Search