From soil@jg.dyn.ml.org  Mon Apr  7 18:35:49 1997
Received: from jg.dyn.ml.org (soil@newport-1-11.quick.net [207.212.160.211])
          by freefall.freebsd.org (8.8.5/8.8.5) with ESMTP id SAA07753
          for <FreeBSD-gnats-submit@freebsd.org>; Mon, 7 Apr 1997 18:35:45 -0700 (PDT)
Received: (from soil@localhost)
	by jg.dyn.ml.org (8.8.5/8.8.5) id SAA13474;
	Mon, 7 Apr 1997 18:35:41 -0700 (PDT)
Message-Id: <199704080135.SAA13474@jg.dyn.ml.org>
Date: Mon, 7 Apr 1997 18:35:41 -0700 (PDT)
From: soil@quick.net
Reply-To: soil@quick.net
To: FreeBSD-gnats-submit@freebsd.org
Subject: bad grammar in rm.1
X-Send-Pr-Version: 3.2

>Number:         3223
>Category:       docs
>Synopsis:       bad grammar in rm.1
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-bugs
>State:          closed
>Quarter:
>Keywords:
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Apr  7 18:40:01 PDT 1997
>Closed-Date:    Tue Apr 8 13:27:54 PDT 1997
>Last-Modified:  Tue Apr  8 13:29:27 PDT 1997
>Originator:     Josh Gilliam
>Release:        FreeBSD 3.0-CURRENT i386
>Organization:
>Environment:

FreeBSD 3.0-CURRENT i386

>Description:

The NOTE section of rm.1 has bad grammar.

>How-To-Repeat:

man 1 rm
/NOTE

>Fix:
	
The NOTE section should be removed since it's not unique to rm.

--- rm.1.orig	Sat Feb 22 06:05:26 1997
+++ rm.1	Mon Apr  7 18:33:01 1997
@@ -122,28 +122,6 @@
 If an error occurs,
 .Nm rm
 exits with a value >0.
-.Sh NOTE
-.Nm rm
-use 
-.Xr getopt 3
-parsing routine. Getopt accept a
-.Sq Li --
-argument, which stop reading options, anything after this
-is not an option.
-So 
-.Nm rm
-handle files whose names begins with a
-.Sq Li - .
-Example:
-
-``$ rm -- -filename''.
-.Sh SEE ALSO
-.Xr rmdir 1 ,
-.Xr undelete 2 ,
-.Xr unlink 2 ,
-.Xr fts 3 ,
-.Xr getopt 3 ,
-.Xr symlink 7
 .Sh BUGS
 The
 .Fl P
>Release-Note:
>Audit-Trail:

From: Josh Gilliam <soil@quick.net>
To: FreeBSD-gnats-submit@freebsd.org
Cc: GNATS Management <gnats@freefall.freebsd.org>,
        freebsd-bugs@freefall.freebsd.org
Subject: Re: docs/3223: bad grammar in rm.1
Date: Mon, 7 Apr 1997 19:07:03 -0700 (PDT)

 In <199704080135.SAA13474@jg.dyn.ml.org>, soil@quick.net wrote:
 
 > >Fix:
 > 	
 > The NOTE section should be removed since it's not unique to rm.
 > 
 > --- rm.1.orig	Sat Feb 22 06:05:26 1997
 > +++ rm.1	Mon Apr  7 18:33:01 1997
 > @@ -122,28 +122,6 @@
 >  If an error occurs,
 >  .Nm rm
 >  exits with a value >0.
 > -.Sh NOTE
 > -.Nm rm
 > -use 
 > -.Xr getopt 3
 > -parsing routine. Getopt accept a
 > -.Sq Li --
 > -argument, which stop reading options, anything after this
 > -is not an option.
 > -So 
 > -.Nm rm
 > -handle files whose names begins with a
 > -.Sq Li - .
 > -Example:
 > -
 > -``$ rm -- -filename''.
 > -.Sh SEE ALSO
 > -.Xr rmdir 1 ,
 > -.Xr undelete 2 ,
 > -.Xr unlink 2 ,
 > -.Xr fts 3 ,
 > -.Xr getopt 3 ,
 > -.Xr symlink 7
 >  .Sh BUGS
 >  The
 >  .Fl P
 
 I removed too much, here is the correct diff file.
 
 --- rm.1.orig	Sat Feb 22 06:05:26 1997
 +++ rm.1	Mon Apr  7 18:46:42 1997
 @@ -122,21 +122,6 @@
  If an error occurs,
  .Nm rm
  exits with a value >0.
 -.Sh NOTE
 -.Nm rm
 -use 
 -.Xr getopt 3
 -parsing routine. Getopt accept a
 -.Sq Li --
 -argument, which stop reading options, anything after this
 -is not an option.
 -So 
 -.Nm rm
 -handle files whose names begins with a
 -.Sq Li - .
 -Example:
 -
 -``$ rm -- -filename''.
  .Sh SEE ALSO
  .Xr rmdir 1 ,
  .Xr undelete 2 ,
 
 
 --
 Josh Gilliam
 Orange, California, USA
 soil@quick.net
 

From: Tim Vanderhoek <tim@X2296>
To: soil@quick.net
Cc: FreeBSD-gnats-submit@freebsd.org, freebsd-bugs@freefall.freebsd.org
Subject: Re: docs/3223: bad grammar in rm.1
Date: Tue, 8 Apr 1997 00:06:58 -0400 (EDT)

 On Mon, 7 Apr 1997 soil@quick.net wrote:
 
 > >Fix:
 > 	
 > The NOTE section should be removed since it's not unique to rm.
 
 No, it's not, but I think that it's important to include it
 there.  It's not necessary to include it with every utility
 that uses getopt(3), but I think that rm(1) is a special
 case since it's what a beginner will use in their last-ditch
 attempt to get rid of that damn file that they _somehow_
 created.
 
 I would, btw, make the same argument for _adding_ the
 mentioned NOTE to the mv(1) manpage...  <hint!> <hint!>
 Arguably it's even more important to have it in the mv(1)
 page than the rm(1) page (even if not historically correct).
 
 
 --
 tIM...HOEk
 Who's been messing with my anti-paranoi shot?!
 
State-Changed-From-To: open->closed 
State-Changed-By: mpp 
State-Changed-When: Tue Apr 8 13:27:54 PDT 1997 
State-Changed-Why:  
I improved the wording of the NOTES section in rev 1.8 of 
rm.1.  I left the NOTES section in, despite the fact that 
accepting the -- option is not unique to rm, because the 
rm man page is where many novice users will look to try 
and figure out how to remove a file name that begins 
with a dash. 
>Unformatted:
