mirror of
https://github.com/git/git
synced 2024-08-25 02:35:46 +00:00
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 <martin.agren@gmail.com>
This commit is contained in:
parent
933c758c7d
commit
6955047ff4
|
@ -96,7 +96,7 @@ include::line-range-format.txt[]
|
||||||
Simplification' below for details and other simplification
|
Simplification' below for details and other simplification
|
||||||
modes.
|
modes.
|
||||||
+
|
+
|
||||||
Paths may need to be prefixed with ``\-- '' to separate them from
|
Paths may need to be prefixed with `--` to separate them from
|
||||||
options or the revision range, when confusion arises.
|
options or the revision range, when confusion arises.
|
||||||
|
|
||||||
include::rev-list-options.txt[]
|
include::rev-list-options.txt[]
|
||||||
|
@ -125,7 +125,7 @@ EXAMPLES
|
||||||
`git log --since="2 weeks ago" -- gitk`::
|
`git log --since="2 weeks ago" -- gitk`::
|
||||||
|
|
||||||
Show the changes during the last two weeks to the file 'gitk'.
|
Show the changes during the last two weeks to the file 'gitk'.
|
||||||
The ``--'' is necessary to avoid confusion with the *branch* named
|
The `--` is necessary to avoid confusion with the *branch* named
|
||||||
'gitk'
|
'gitk'
|
||||||
|
|
||||||
`git log --name-status release..test`::
|
`git log --name-status release..test`::
|
||||||
|
|
|
@ -73,7 +73,7 @@ them.
|
||||||
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.
|
||||||
+
|
+
|
||||||
Paths may need to be prefixed with "\-- " to separate them from
|
Paths may need to be prefixed with `--` to separate them from
|
||||||
options or the revision range, when confusion arises.
|
options or the revision range, when confusion arises.
|
||||||
|
|
||||||
MAPPING AUTHORS
|
MAPPING AUTHORS
|
||||||
|
|
Loading…
Reference in a new issue