Re: [PATCH] rev-list-options.txt: use correct directional reference

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 27, 2017, 01:29 UTC
Message-ID: <xmqq4lqle5tz.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20171026152637.21629-1-szeder.dev@gmail.com>

SZEDER Gábor <szeder.dev@gmail.com> writes:

Show 9 quoted lines

> The descriptions of the options '--parents', '--children' and
> '--graph' say "see 'History Simplification' below", although the
> referred section is in fact above the description of these options.
>
> Send readers in the right direction by saying "above" instead of
> "below".
>
> Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
> ---

Thanks.

It turns out that this is not a recent regression, but was done at f98fd436 ("git-log.txt,rev-list-options.txt: put option blocks in proper order", 2011-03-08), which moved Commit Formatting and Diff Formatting sections, which used to appear very early, to near the end of the sequence.

Show 30 quoted lines

>  Documentation/rev-list-options.txt | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
> index 7d860bfca..13501e155 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -799,11 +799,11 @@ endif::git-rev-list[]
>  
>  --parents::
>  	Print also the parents of the commit (in the form "commit parent...").
> -	Also enables parent rewriting, see 'History Simplification' below.
> +	Also enables parent rewriting, see 'History Simplification' above.
>  
>  --children::
>  	Print also the children of the commit (in the form "commit child...").
> -	Also enables parent rewriting, see 'History Simplification' below.
> +	Also enables parent rewriting, see 'History Simplification' above.
>  
>  ifdef::git-rev-list[]
>  --timestamp::
> @@ -846,7 +846,7 @@ you would get an output like this:
>  	to be drawn properly.
>  	Cannot be combined with `--no-walk`.
>  +
> -This enables parent rewriting, see 'History Simplification' below.
> +This enables parent rewriting, see 'History Simplification' above.
>  +
>  This implies the `--topo-order` option by default, but the
>  `--date-order` option may also be specified.