From nobody@FreeBSD.org  Thu Oct 21 23:46:45 2004
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id ADA9516A4CE
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 21 Oct 2004 23:46:45 +0000 (GMT)
Received: from www.freebsd.org (www.freebsd.org [216.136.204.117])
	by mx1.FreeBSD.org (Postfix) with ESMTP id A24E843D41
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 21 Oct 2004 23:46:45 +0000 (GMT)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.12.11/8.12.11) with ESMTP id i9LNkjow081235
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 21 Oct 2004 23:46:45 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.12.11/8.12.11/Submit) id i9LNkjZs081234;
	Thu, 21 Oct 2004 23:46:45 GMT
	(envelope-from nobody)
Message-Id: <200410212346.i9LNkjZs081234@www.freebsd.org>
Date: Thu, 21 Oct 2004 23:46:45 GMT
From: John Engelhart <johne@zang.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: `grep` man page typo/error for --line-buffering / --line-buffered option
X-Send-Pr-Version: www-2.3

>Number:         72985
>Category:       docs
>Synopsis:       `grep` man page typo/error for --line-buffering / --line-buffered option
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    keramida
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Oct 21 23:50:29 GMT 2004
>Closed-Date:    Tue Dec 21 22:24:04 GMT 2004
>Last-Modified:  Tue Dec 21 22:24:04 GMT 2004
>Originator:     John Engelhart
>Release:        5.3BETA7
>Organization:
>Environment:
FreeBSD new.zang.com 5.3-BETA7 FreeBSD 5.3-BETA7 #0: Sun Oct 17 00:32:33 EDT 2004     johne@new.zang.com:/usr/src/sys/i386/compile/new  i386
>Description:
The man page for the command grep has a typo/error in it.

The option syntax for "line-buffered" output is specified in the man page as:

--line-buffering

Whereas the command itself takes (from grep --help, and checked by running)

      --line-buffered       flush output on every line      
>How-To-Repeat:
Check "man grep" and "grep --help", also trying passing both to grep to verify.
>Fix:
Update man page to reflect actual syntax with " --line-buffered"
>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@freebsd.org>
To: John Engelhart <johne@zang.com>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/72985: `grep` man page typo/error for --line-buffering / --line-buffered option
Date: Fri, 22 Oct 2004 11:49:29 +0300

 On 2004-10-21 23:46, John Engelhart <johne@zang.com> wrote:
 > >Environment:
 > FreeBSD new.zang.com 5.3-BETA7 FreeBSD 5.3-BETA7 #0:\
 > Sun Oct 17 00:32:33 EDT 2004     \
 > johne@new.zang.com:/usr/src/sys/i386/compile/new  i386
 >
 > >Description:
 > The man page for the command grep has a typo/error in it.
 >
 > The option syntax for "line-buffered" output is specified in the man page as:
 >
 > --line-buffering
 >
 > Whereas the command itself takes (from grep --help, and checked by running)
 >
 >       --line-buffered       flush output on every line
 
 You are right.  Does the following change look ok?
 
 %%%
 Index: grep.1
 ===================================================================
 RCS file: /home/ncvs/src/gnu/usr.bin/grep/grep.1,v
 retrieving revision 1.25
 diff -u -u -r1.25 grep.1
 --- grep.1	4 Jul 2004 10:02:03 -0000	1.25
 +++ grep.1	22 Oct 2004 08:47:28 -0000
 @@ -312,8 +312,9 @@
  This is especially useful for tools like zgrep, e.g.
  .B "gzip -cd foo.gz |grep --label=foo something"
  .TP
 -.BR \-\^\-line-buffering
 -Use line buffering, it can be a performance penality.
 +.BR \-\^\-line-buffered
 +Flush output on every line.
 +Note that this incurs a performance penalty.
  .TP
  .BR \-q ", " \-\^\-quiet ", " \-\^\-silent
  Quiet; do not write anything to standard output.
 %%%
State-Changed-From-To: open->patched 
State-Changed-By: keramida 
State-Changed-When: Tue Nov 9 17:01:22 GMT 2004 
State-Changed-Why:  
I've fixed this in CURRENT.   Thanks :-) 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Tue Nov 9 17:01:22 GMT 2004 
Responsible-Changed-Why:  
I will handle the merge to RELENG_5 and RELENG_4. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=72985 
State-Changed-From-To: patched->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Dec 21 22:23:36 GMT 2004 
State-Changed-Why:  
The change is merged to RELENG_5 now. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=72985 
>Unformatted:
