Date: Sun, 5 Jan 2003 15:00:21 -0800 (PST) From: Giorgos Keramidas <keramida@freebsd.org> To: freebsd-doc@FreeBSD.org Subject: Re: docs/46787: compress(1) manpage missing BUGS; other cleanup. Message-ID: <200301052300.h05N0LKU003644@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/46787; it has been noted by GNATS. From: Giorgos Keramidas <keramida@freebsd.org> To: "Gary W. Swearingen" <swear@attbi.com> Cc: bug-followup@freebsd.org Subject: Re: docs/46787: compress(1) manpage missing BUGS; other cleanup. Date: Mon, 6 Jan 2003 00:50:20 +0200 On 2003-01-05 10:18, "Gary W. Swearingen" <swear@attbi.com> wrote: > --- /tmp/compress..orig.1 Sun Jan 5 06:33:35 2003 > +++ /tmp/compress.1 Sun Jan 5 10:02:14 2003 > @@ -54,17 +54,17 @@ > .Sh DESCRIPTION > The > .Nm > -utility reduces the size of the named files using adaptive Lempel-Ziv coding. > +utility attempts to reduce the size of the > +named files using adaptive Lempel-Ziv coding. This is not ok. It breaks a line that is not over 80 characters, and introduces whitespace at eol (first added line). > Each > .Ar file > is renamed to the same name plus the extension > .Dq .Z . > -As many of the modification time, access time, file flags, file mode, > -user ID, and group ID as allowed by permissions are retained in the > -new file. Does this really need to be moved further below? I think it was put where it is not because the first paragraph describes the change to the file name and the author refers to the rest of the file attributes to keep them close to the file -> file.Z change. > -If compression would not reduce the size of a > +If attempted compression would not reduce the size of a Well, "attempted" sounds just a tiny bit too verbose here. I think it's more or less implied. > .Ar file , > -the file is ignored. > +or if the filename ends with > +.Dq .Z , > +the file is not compressed. Exceptions are discussed below. "already ends with .Z" perhaps? I think this is a good & useful change. > .Pp > The > .Nm uncompress > @@ -72,38 +72,53 @@ > files by deleting the > .Dq .Z > extension. > +If a specified filename doesn't end with > +.Dq .Z , > +one will be assumed unless a file with the extended filename does not > +exist, in which case the named file will be removed (because of a bug). I am not sure I can understand the sentence above at all :( > .Pp > If no files are specified or a > .Ar file > argument is a single dash > .Pq Sq Fl , > the standard input is compressed or uncompressed to the standard output. > -If either the input and output files are not regular files, the checks for > +If either the input and output are not regular files, the checks for I think that removing "files" above is ok, but it probably sounds better without "the" when "files" is gone: +If either input and output are not regular files, ... > reduction in size and file overwriting are not performed, the input file is > -not removed, and the attributes of the input file are not retained. > +not removed, and the attributes of the input file > +are not retained in the output. I'm not sure I like this for some reasons. It wraps the line to a very short length. Content changes shouldn't be mixed with whitespace changes if at all possible. The addition of "in the output" is ok though and I like that part of the change. > .It Fl c > Compressed or uncompressed output is written to the standard output. > -No files are modified. > +Compression is attempted even if the results will be larger than the > +original. > +No files are modified. The The line containing "No files are modified." is unnecessarily touched in this part of the diff. The new sentence should start on a new line, and "The" be added on a line of its own. > +Files are overwritten without prompting for confirmation. > +For compression, proceed even if the > +results will be larger than the original. New text should be wrapped at about 70-80 characters if possible. Wrapping at too short line lengths isn't very nice either, though. > .It Fl v > -Print the percentage reduction of each file. > +The size reduction of each file is printed as a percentage to > +the standard output. Ignored for uncompressiong or if the > +.Fl c > +flag is also used. Sentences should start on a new line. Also s/uncompressiong/uncompressing/ above. > @@ -187,3 +195,9 @@ > .Nm > command appeared in > .Bx 4.3 . > +.Sh BUGS > +For uncompression, if a specified filename doesn't end with > +.Dq .Z > +and a file with the filename extended with > +.Dq .Z > +does not exist, the named file will be removed. Hmmm, not very clear. Let's ignore the whitespace at eol for a while.... Can you elaborate a bit, perhaps provide an example? How can I reproduce this? - Giorgos To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200301052300.h05N0LKU003644>