Skip to contentSkip to conversation

rev-list-options.txt: use correct directional reference

PATCH In review SZEDER Gábor 2 participants 2 messages Oct 26, 2017 – Oct 27, 2017 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rev-list-options.txt: use correct directional reference

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

---
 Documentation/rev-list-options.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/rev-list-options.txt +3 -3
index 7d860bfca..13501e155 100644
@@ -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.
Signature · 1 line
2.15.0.rc2.80.g094badb02
#1 lore raw
Quoted 9 lines · 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".

---

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.

Quoted 30 lines
 Documentation/rev-list-options.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/rev-list-options.txt +3 -3
index 7d860bfca..13501e155 100644
@@ -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.