undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: convert [\--] to [--]

Browse Source 
Commit 1c262bb7b (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 <martin.agren@gmail.com>
This commit is contained in:
Martin Ågren 2018-04-17 21:15:27 +02:00 committed by Junio C Hamano
parent 9e9f132f53
commit 933c758c7d
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/git-log.txt
View File

@ -9,7 +9,7 @@ git-log - Show commit logs
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git log' [<options>] [<revision range>] [[\--] <path>...] 'git log' [<options>] [<revision range>] [[--] <path>...]
DESCRIPTION DESCRIPTION
----------- -----------
@ -90,7 +90,7 @@ include::line-range-format.txt[]
ways to spell <revision range>, see the 'Specifying Ranges' ways to spell <revision range>, see the 'Specifying Ranges'
section of linkgit:gitrevisions[7]. section of linkgit:gitrevisions[7].
[\--] <path>...:: [--] <path>...::
Show only commits that are enough to explain how the files Show only commits that are enough to explain how the files
that match the specified paths came to be. See 'History that match the specified paths came to be. See 'History
Simplification' below for details and other simplification Simplification' below for details and other simplification

4
Documentation/git-shortlog.txt
View File

@ -8,7 +8,7 @@ git-shortlog - Summarize 'git log' output
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git shortlog' [<options>] [<revision range>] [[\--] <path>...] 'git shortlog' [<options>] [<revision range>] [[--] <path>...]
git log --pretty=short | 'git shortlog' [<options>] git log --pretty=short | 'git shortlog' [<options>]
DESCRIPTION DESCRIPTION
@ -69,7 +69,7 @@ them.
ways to spell <revision range>, see the "Specifying Ranges" ways to spell <revision range>, see the "Specifying Ranges"
section of linkgit:gitrevisions[7]. section of linkgit:gitrevisions[7].
[\--] <path>...:: [--] <path>...::
Consider only commits that are enough to explain how the files Consider only commits that are enough to explain how the files
that match the specified paths came to be. that match the specified paths came to be.
+ +

2
Documentation/gitk.txt
View File

@ -8,7 +8,7 @@ gitk - The Git repository browser
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'gitk' [<options>] [<revision range>] [\--] [<path>...] 'gitk' [<options>] [<revision range>] [--] [<path>...]
DESCRIPTION DESCRIPTION
----------- -----------