bug-grep
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [patch #4610] Consolidated documentation patch


From: Benno Schulenberg
Subject: Re: [patch #4610] Consolidated documentation patch
Date: Sun, 13 Nov 2005 23:21:31 +0100
User-agent: KMail/1.8.3

Charles Levert wrote:
> +     * doc/grep.1, doc/grep.texi: Note that context lines are not
> available
> +       with --only-matching and that a warning is issued under such
> uses.

Please don't add these unneeded explanations of obvious conflicts.

> Places a line containing
> .B \-\^\-
> between contiguous groups of matches.

Hmm, it's maybe better to quote these double dashes (`--') instead 
of putting them in bold, as on my konsole I see zero difference 
between bold and normal dashes.

Also quote the dash in "patterns beginning with -"; the info page 
says "with a `-'".

The `-z --null-data' option is missing from the man page.

And to be fully consistent, the `options' at the top of that page 
should probably be uppercased.

> +Copyright @copyright{} 1999, 2000, 2001, 2002, 2005  Free
> Software Foundation, Inc. 

The "2005" will only be true if this year a release is made, no?

> +where there can be zero or more @var{options},

Maybe better start a new sentence: "There can...".

> address@hidden will only be seen as such
> +(and not as an @var{input_file_name})
> +if it wasn't already specified within @var{options},

It took a while before I understood that you were hinting at the -e 
option.  As this is a "general synopsis", I don't think it is 
necessary to mention this detail here.  Just saying that the general 
form is "options pattern files, zero or more options, zero or more 
files" will be enough, IMO.

> address@hidden comes with a rich set of options
> +from @sc{posix.2} and @sc{gnu} extensions.

This sentence has bothered me long enough now... Maybe better "a 
rich set of options: several from @sc{posix.2}, and many @sc{gnu} 
extensions.

> +Several additional options control
> +which variant of the @command{grep} matching engine is used.
> address@hidden Programs}.

This would be better placed after the menu, as otherwise the 
"additional" doesn't make sense.  It also makes it stand out more.

> address@hidden Generic Program Information

This subsection I'd really prefer to see near the end, just before 
Other Options.

All the other tweaks are looking good.  :)

Benno




reply via email to

[Prev in Thread] Current Thread [Next in Thread]