[v2,4/4] rev-list-description.txt: fix Asciidoc syntax
diff mbox series

Message ID 3b923780c1f38ee183397b5766aae65933eec4aa.1593747509.git.gitgitgadget@gmail.com
State New
Headers show
Series
  • doc: include git rev-list description in git log doc
Related show

Commit Message

Elijah Newren via GitGitGadget July 3, 2020, 3:38 a.m. UTC
From: Philippe Blain <levraiphilippeblain@gmail.com>

Using '{caret}' inside double quotes and immediately following with a
single quoted word does not create the desired output: '<commit1>'
appears verbatim instead of being emphasized.

Use a litteral caret ('^') instead.

Also, remove the leading tabs in shell examples to bring them more in
line with the rest of the documentation.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
---
 Documentation/rev-list-description.txt | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

Comments

Junio C Hamano July 7, 2020, 12:59 a.m. UTC | #1
"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Philippe Blain <levraiphilippeblain@gmail.com>
>
> Using '{caret}' inside double quotes and immediately following with a
> single quoted word does not create the desired output: '<commit1>'
> appears verbatim instead of being emphasized.
>
> Use a litteral caret ('^') instead.
>
> Also, remove the leading tabs in shell examples to bring them more in
> line with the rest of the documentation.

These should be done _before_ 2/4 as a preliminary clean-up, I
think.

Thanks for a pleasant read.
Philippe Blain July 7, 2020, 1:12 p.m. UTC | #2
> Le 6 juil. 2020 à 20:59, Junio C Hamano <gitster@pobox.com> a écrit :
> 
> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 
>> From: Philippe Blain <levraiphilippeblain@gmail.com>
>> 
>> Using '{caret}' inside double quotes and immediately following with a
>> single quoted word does not create the desired output: '<commit1>'
>> appears verbatim instead of being emphasized.
>> 
>> Use a litteral caret ('^') instead.
>> 
>> Also, remove the leading tabs in shell examples to bring them more in
>> line with the rest of the documentation.
> 
> These should be done _before_ 2/4 as a preliminary clean-up, I
> think.

I agree. I'll reorder that for v3.

Patch
diff mbox series

diff --git a/Documentation/rev-list-description.txt b/Documentation/rev-list-description.txt
index dce78561be..4bde2fd4fe 100644
--- a/Documentation/rev-list-description.txt
+++ b/Documentation/rev-list-description.txt
@@ -14,12 +14,12 @@  Thus, the following command:
 
 ifdef::git-rev-list[]
 -----------------------------------------------------------------------
-	$ git rev-list foo bar ^baz
+$ git rev-list foo bar ^baz
 -----------------------------------------------------------------------
 endif::git-rev-list[]
 ifdef::git-log[]
 -----------------------------------------------------------------------
-	$ git log foo bar ^baz
+$ git log foo bar ^baz
 -----------------------------------------------------------------------
 endif::git-log[]
 
@@ -27,19 +27,19 @@  means "list all the commits which are reachable from 'foo' or 'bar', but
 not from 'baz'".
 
 A special notation "'<commit1>'..'<commit2>'" can be used as a
-short-hand for "{caret}'<commit1>' '<commit2>'". For example, either of
+short-hand for "^'<commit1>' '<commit2>'". For example, either of
 the following may be used interchangeably:
 
 ifdef::git-rev-list[]
 -----------------------------------------------------------------------
-	$ git rev-list origin..HEAD
-	$ git rev-list HEAD ^origin
+$ git rev-list origin..HEAD
+$ git rev-list HEAD ^origin
 -----------------------------------------------------------------------
 endif::git-rev-list[]
 ifdef::git-log[]
 -----------------------------------------------------------------------
-	$ git log origin..HEAD
-	$ git log HEAD ^origin
+$ git log origin..HEAD
+$ git log HEAD ^origin
 -----------------------------------------------------------------------
 endif::git-log[]
 
@@ -49,13 +49,13 @@  between the two operands.  The following two commands are equivalent:
 
 ifdef::git-rev-list[]
 -----------------------------------------------------------------------
-	$ git rev-list A B --not $(git merge-base --all A B)
-	$ git rev-list A...B
+$ git rev-list A B --not $(git merge-base --all A B)
+$ git rev-list A...B
 -----------------------------------------------------------------------
 endif::git-rev-list[]
 ifdef::git-log[]
 -----------------------------------------------------------------------
-	$ git log A B --not $(git merge-base --all A B)
-	$ git log A...B
+$ git log A B --not $(git merge-base --all A B)
+$ git log A...B
 -----------------------------------------------------------------------
 endif::git-log[]