Skip to content

Commit 933c758

Browse files
Martin Ågrengitster
authored andcommitted
doc: convert [\--] to [--]
Commit 1c262bb (doc: convert \--option to --option, 2015-05-13) explains that we used to need to write \--option to play well with older versions of AsciiDoc, but that we do not support such versions anymore anyway, and that Asciidoctor literally renders \--. With [\--], which is used to denote the optional separator between revisions and paths, Asciidoctor renders the backslash literally. Change all [\--] to [--]. This changes nothing for AsciiDoc version 8.6.9, but is an improvement for Asciidoctor version 1.5.4. We use double-dashes in several list entries (\--::). In my testing, it appears that we do need to use the backslash there, so leave those. Signed-off-by: Martin Ågren <[email protected]>
1 parent 9e9f132 commit 933c758

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

Documentation/git-log.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-log - Show commit logs
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git log' [<options>] [<revision range>] [[\--] <path>...]
12+
'git log' [<options>] [<revision range>] [[--] <path>...]
1313

1414
DESCRIPTION
1515
-----------
@@ -90,7 +90,7 @@ include::line-range-format.txt[]
9090
ways to spell <revision range>, see the 'Specifying Ranges'
9191
section of linkgit:gitrevisions[7].
9292

93-
[\--] <path>...::
93+
[--] <path>...::
9494
Show only commits that are enough to explain how the files
9595
that match the specified paths came to be. See 'History
9696
Simplification' below for details and other simplification

Documentation/git-shortlog.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-shortlog - Summarize 'git log' output
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git shortlog' [<options>] [<revision range>] [[\--] <path>...]
11+
'git shortlog' [<options>] [<revision range>] [[--] <path>...]
1212
git log --pretty=short | 'git shortlog' [<options>]
1313

1414
DESCRIPTION
@@ -69,7 +69,7 @@ them.
6969
ways to spell <revision range>, see the "Specifying Ranges"
7070
section of linkgit:gitrevisions[7].
7171

72-
[\--] <path>...::
72+
[--] <path>...::
7373
Consider only commits that are enough to explain how the files
7474
that match the specified paths came to be.
7575
+

Documentation/gitk.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ gitk - The Git repository browser
88
SYNOPSIS
99
--------
1010
[verse]
11-
'gitk' [<options>] [<revision range>] [\--] [<path>...]
11+
'gitk' [<options>] [<revision range>] [--] [<path>...]
1212

1313
DESCRIPTION
1414
-----------

0 commit comments

Comments
 (0)