Skip to content

Commit 6955047

Browse files
Martin Ågrengitster
authored andcommitted
git-[short]log.txt: unify quoted standalone --
In git-log.txt, we have an instance of \--, which is known to sometimes render badly. This one is even worse than normal though, since ``\-- '' (with or without that trailing space) appears to be entirely broken, both in HTML and manpages, both with AsciiDoc (version 8.6.9) and Asciidoctor (version 1.5.4). Further down in git-log.txt we have a ``--'', which renders good. In git-shortlog.txt, we use "\-- " (including the quotes and the space), which happens to look fairly good. I failed to find any other similar instances. So all in all, we quote a double-dash in three different places and do it differently each time, with various degrees of success. Switch all of these to `--`. This sets the double-dash in monospace and matches what we usually do with example command line usages and options. Note that we drop the trailing space as well, since `-- ` does not render well. These should still be clear enough since just a few lines above each instance, the space is clearly visible in a longer context. Signed-off-by: Martin Ågren <[email protected]>
1 parent 933c758 commit 6955047

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Documentation/git-log.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ include::line-range-format.txt[]
9696
Simplification' below for details and other simplification
9797
modes.
9898
+
99-
Paths may need to be prefixed with ``\-- '' to separate them from
99+
Paths may need to be prefixed with `--` to separate them from
100100
options or the revision range, when confusion arises.
101101

102102
include::rev-list-options.txt[]
@@ -125,7 +125,7 @@ EXAMPLES
125125
`git log --since="2 weeks ago" -- gitk`::
126126

127127
Show the changes during the last two weeks to the file 'gitk'.
128-
The ``--'' is necessary to avoid confusion with the *branch* named
128+
The `--` is necessary to avoid confusion with the *branch* named
129129
'gitk'
130130

131131
`git log --name-status release..test`::

Documentation/git-shortlog.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ them.
7373
Consider only commits that are enough to explain how the files
7474
that match the specified paths came to be.
7575
+
76-
Paths may need to be prefixed with "\-- " to separate them from
76+
Paths may need to be prefixed with `--` to separate them from
7777
options or the revision range, when confusion arises.
7878

7979
MAPPING AUTHORS

0 commit comments

Comments
 (0)