git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH] rev-list-options.txt: use correct directional reference
@ 2017-10-26 15:26 SZEDER Gábor
  2017-10-27  1:29 ` Junio C Hamano
  0 siblings, 1 reply; 2+ messages in thread
From: SZEDER Gábor @ 2017-10-26 15:26 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, SZEDER Gábor

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>
---
 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.
-- 
2.15.0.rc2.80.g094badb02


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] rev-list-options.txt: use correct directional reference
  2017-10-26 15:26 [PATCH] rev-list-options.txt: use correct directional reference SZEDER Gábor
@ 2017-10-27  1:29 ` Junio C Hamano
  0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2017-10-27  1:29 UTC (permalink / raw)
  To: SZEDER Gábor; +Cc: git

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

> 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.

>  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.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2017-10-27  1:29 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-10-26 15:26 [PATCH] rev-list-options.txt: use correct directional reference SZEDER Gábor
2017-10-27  1:29 ` Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).