Re: [PATCH v2 2/2] rev-parse(1): logically group options
John Keeping <john@keeping.me.uk> writes:
Show 34 quoted lines
> The options section of the git-rev-parse manual page has grown
> organically so that there now does not seem to be much logic behind the
> ordering of the options. It also does not make it clear that certain
> options must appear first on the command line.
>
> Address this by reorganising the options into groups with subheadings.
> The text of option descriptions does not change.
>
> Signed-off-by: John Keeping <john@keeping.me.uk>
> ---
> Documentation/git-rev-parse.txt | 104 ++++++++++++++++++++++++----------------
> 1 file changed, 64 insertions(+), 40 deletions(-)
>
> diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
> index 993903c..34c55a7 100644
> --- a/Documentation/git-rev-parse.txt
> +++ b/Documentation/git-rev-parse.txt
> @@ -24,9 +24,23 @@ distinguish between them.
>
> OPTIONS
> -------
> +
> +Operation Modes
> +~~~~~~~~~~~~~~~
> +
> +Each of these options must appear first on the command line.
> +
> --parseopt::
> Use 'git rev-parse' in option parsing mode (see PARSEOPT section below).
>
> +--sq-quote::
> + Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
> + section below). In contrast to the `--sq` option below, this
> + mode does only quoting. Nothing else is done to command input.
Much nicer ;-)
The rest also looked good to me. Thanks.