Skip to content

Commit 535cfa3

Browse files
committed
Merge branch 'ma/double-dashes-in-docs'
Doc formatting updates. * ma/double-dashes-in-docs: git-submodule.txt: quote usage in monospace, drop backslash git-[short]log.txt: unify quoted standalone -- doc: convert [\--] to [--] doc: convert \--option to --option
2 parents 3138f23 + 4c57a4f commit 535cfa3

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

Documentation/git-format-patch.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ There are two ways to specify which commits to operate on.
4747

4848
The first rule takes precedence in the case of a single <commit>. To
4949
apply the second rule, i.e., format everything since the beginning of
50-
history up until <commit>, use the '\--root' option: `git format-patch
50+
history up until <commit>, use the `--root` option: `git format-patch
5151
--root <commit>`. If you want to format only <commit> itself, you
5252
can do this with `git format-patch -1 <commit>`.
5353

Documentation/git-log.txt

Lines changed: 4 additions & 4 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,13 +90,13 @@ 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
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-push.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ origin +master` to force a push to the `master` branch). See the
300300
These options are passed to linkgit:git-send-pack[1]. A thin transfer
301301
significantly reduces the amount of sent data when the sender and
302302
receiver share many of the same objects in common. The default is
303-
\--thin.
303+
`--thin`.
304304

305305
-q::
306306
--quiet::

Documentation/git-shortlog.txt

Lines changed: 3 additions & 3 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,11 +69,11 @@ 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
+
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

Documentation/git-submodule.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ sync [--recursive] [--] [<path>...]::
213213
submodule URLs change upstream and you need to update your local
214214
repositories accordingly.
215215
+
216-
"git submodule sync" synchronizes all submodules while
217-
"git submodule sync \-- A" synchronizes submodule "A" only.
216+
`git submodule sync` synchronizes all submodules while
217+
`git submodule sync -- A` synchronizes submodule "A" only.
218218
+
219219
If `--recursive` is specified, this command will recurse into the
220220
registered submodules, and sync any nested submodules within.

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)