From nobody@FreeBSD.org  Wed Apr 23 12:17:47 2008
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 4422B106564A
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 23 Apr 2008 12:17:47 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id 28FF98FC19
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 23 Apr 2008 12:17:47 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.2/8.14.2) with ESMTP id m3NCHMKt043440
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 23 Apr 2008 12:17:22 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.2/8.14.1/Submit) id m3NCHMGO043439;
	Wed, 23 Apr 2008 12:17:22 GMT
	(envelope-from nobody)
Message-Id: <200804231217.m3NCHMGO043439@www.freebsd.org>
Date: Wed, 23 Apr 2008 12:17:22 GMT
From: Andrew Wright <andrewhw@ieee.org>
To: freebsd-gnats-submit@FreeBSD.org
Subject: Misleading Documentation
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         123010
>Category:       docs
>Synopsis:       Misleading Documentation in gzip(1)
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    delphij
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Apr 23 12:20:01 UTC 2008
>Closed-Date:    Mon Nov 03 11:31:25 UTC 2008
>Last-Modified:  Mon Nov 03 11:31:25 UTC 2008
>Originator:     Andrew Wright
>Release:        7.0
>Organization:
>Environment:
All architectures -- documentation issue only.
>Description:
The gzip(1) man page could do with a little clarification when it comes
to gzcat.

In particular, I expected the following two constructions to do the same thing:
   gzcat *.gz | command
   cat *.gz | gzcat | command

They don't -- it seems that gzcat expects each argument to be a separate
compressed archive whose contents are then concatenated together; the
second of course expects the concatenation of the set of provided files
to be a single archive (which in this case was my expectation of both).

While this is fine functionality, a note to this effect on the man page
certainly couldn't hurt.  Right now there is no discussion whatsoever
about how gzcat (or in fact "zcat" as it is referred to there) handles
multiple files. 
>How-To-Repeat:
n/a -- documentation issue
>Fix:
Doc issue only.

>Release-Note:
>Audit-Trail:

From: "A. Hamilton-Wright" <andrew@qemg.org>
To: bug-followup@FreeBSD.org
Cc: "A. Hamilton-Wright" <andrew@qemg.org>
Subject: Re: docs/123010: Misleading Documentation in gzip(1)
Date: Sun, 27 Apr 2008 20:17:27 -0300 (ADT)

 Suggested modification to source of /usr/share/man/man1/gzip.1.gz
 below:
 
 
 --- gzip.1.old	2008-04-27 20:08:23.000000000 -0300
 +++ gzip.1.new	2008-04-27 20:13:54.000000000 -0300
 @@ -72,10 +72,17 @@
   will be replaced with another file with the suffix, set by the
   .Fl S Ar suffix
   option, added, if possible.
 +.Pp
   In decompression mode, each
   .Ar file
   will be checked for existence, as will the file with the suffix
   added.
 +Each file argument must contain a separate complete archive;
 +when multiple files are indicated, each is decompressed in turn.
 +In the case of
 +.Nm gzcat
 +the resulting data is then concatenated in the manner of
 +.Xr cat 1 .
   .Pp
   If invoked as
   .Nm gunzip

From: "A. Hamilton-Wright" <andrew@qemg.org>
To: bug-followup@FreeBSD.org
Cc: "A. Hamilton-Wright" <andrew@qemg.org>
Subject: Re: docs/123010: Misleading Documentation in gzip(1)
Date: Sun, 27 Apr 2008 20:28:26 -0300 (ADT)

 On Sun, 27 Apr 2008, A. Hamilton-Wright wrote:
 
 > Suggested modification to source of /usr/share/man/man1/gzip.1.gz
 > below:
 
 I just noticed that I hadn't flagged "file" as per the argument
 notation.  Updated patch:
 
 
 --- gzip.1.old	2008-04-27 20:08:23.000000000 -0300
 +++ gzip.1.new	2008-04-27 20:26:30.000000000 -0300
 @@ -72,10 +72,21 @@
   will be replaced with another file with the suffix, set by the
   .Fl S Ar suffix
   option, added, if possible.
 +.Pp
   In decompression mode, each
   .Ar file
   will be checked for existence, as will the file with the suffix
   added.
 +Each
 +.Ar file
 +argument must contain a separate complete archive;
 +when multiple
 +.Ar files
 +are indicated, each is decompressed in turn.
 +In the case of
 +.Nm gzcat
 +the resulting data is then concatenated in the manner of
 +.Xr cat 1 .
   .Pp
   If invoked as
   .Nm gunzip
 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/123010: commit references a PR
Date: Mon, 30 Jun 2008 17:46:02 +0000 (UTC)

 delphij     2008-06-30 17:45:47 UTC
 
   FreeBSD src repository
 
   Modified files:
     usr.bin/gzip         gzip.1 
   Log:
   SVN rev 180126 on 2008-06-30 17:45:47Z by delphij
   
   Make it clear that gzcat expects each argument to be separate files.
   
   PR:             docs/123010
   Submitted by:   Andrew Wright <andrewhw ieee org>
   MFC after:      2 weeks
   
   Revision  Changes    Path
   1.5       +13 -1     src/usr.bin/gzip/gzip.1
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->patched 
State-Changed-By: delphij 
State-Changed-When: Mon Jun 30 17:50:50 UTC 2008 
State-Changed-Why:  
-HEAD patched, awaiting MFC. 


Responsible-Changed-From-To: freebsd-doc->delphij 
Responsible-Changed-By: delphij 
Responsible-Changed-When: Mon Jun 30 17:50:50 UTC 2008 
Responsible-Changed-Why:  
Take 

http://www.freebsd.org/cgi/query-pr.cgi?pr=123010 
State-Changed-From-To: patched->closed 
State-Changed-By: delphij 
State-Changed-When: Mon Nov 3 11:29:36 UTC 2008 
State-Changed-Why:  
Patch MFC'ed months ago.  Thanks for your submission! 

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