doc: typeset short command-line options as literal
It was common in our documentation to surround short option names with forward quotes, which renders as italic in HTML. Instead, use backquotes which renders as monospace. This is one more step toward conformance to Documentation/CodingGuidelines. This was obtained with: perl -pi -e "s/'(-[a-z])'/\`\$1\`/g" *.txt Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Matthieu Moy committed
Jun 28, 2016 at 13:40 UTC
23f8239bbe0a893bd8754a03e9d4fda62804ac14
23 files changed
+52
-52
Documentation/config.txt
+4
-4
@@ -913,7 +913,7 @@ browser.<tool>.cmd::
913
914
browser.<tool>.path::
915
Override the path for the given tool that may be used to
916
- browse HTML help (see '-w' option in linkgit:git-help[1]) or a
916
+ browse HTML help (see `-w` option in linkgit:git-help[1]) or a
917
working repository in gitweb (see linkgit:git-instaweb[1]).
918
919
clean.requireForce::
@@ -1394,9 +1394,9 @@ gitcvs.logFile::
1394
1395
gitcvs.usecrlfattr::
1396
If true, the server will look up the end-of-line conversion
1397
- attributes for files to determine the '-k' modes to use. If
1397
+ attributes for files to determine the `-k` modes to use. If
1398
the attributes force Git to treat a file as text,
1399
- the '-k' mode will be left blank so CVS clients will
1399
+ the `-k` mode will be left blank so CVS clients will
1400
treat it as text. If they suppress text conversion, the file
1401
will be set with '-kb' mode, which suppresses any newline munging
1402
the client might otherwise do. If the attributes do not allow
@@ -1466,7 +1466,7 @@ gitweb.snapshot::
1466
See linkgit:gitweb.conf[5] for description.
1467
1468
grep.lineNumber::
1469
- If set to true, enable '-n' option by default.
1469
+ If set to true, enable `-n` option by default.
1470
1471
grep.patternType::
1472
Set the default matching behavior. Using a value of 'basic', 'extended',
Documentation/diff-config.txt
+1
-1
@@ -105,7 +105,7 @@ diff.orderFile::
105
106
diff.renameLimit::
107
The number of files to consider when performing the copy/rename
108
- detection; equivalent to the 'git diff' option '-l'.
108
+ detection; equivalent to the 'git diff' option `-l`.
109
110
diff.renames::
111
Tells Git to detect renames. If set to any boolean value, it
Documentation/diff-format.txt
+4
-4
@@ -46,11 +46,11 @@ That is, from the left to the right:
46
. sha1 for "dst"; 0\{40\} if creation, unmerged or "look at work tree".
47
. a space.
48
. status, followed by optional "score" number.
49
-. a tab or a NUL when '-z' option is used.
49
+. a tab or a NUL when `-z` option is used.
50
. path for "src"
51
-. a tab or a NUL when '-z' option is used; only exists for C or R.
51
+. a tab or a NUL when `-z` option is used; only exists for C or R.
52
. path for "dst"; only exists for C or R.
53
-. an LF or a NUL when '-z' option is used, to terminate the record.
53
+. an LF or a NUL when `-z` option is used, to terminate the record.
54
55
Possible status letters are:
56
@@ -86,7 +86,7 @@ diff format for merges
86
----------------------
87
88
"git-diff-tree", "git-diff-files" and "git-diff --raw"
89
-can take '-c' or '--cc' option
89
+can take `-c` or '--cc' option
90
to generate diff output also for merge commits. The output differs
91
from the format described above in the following way:
92
Documentation/diff-generate-patch.txt
+2
-2
@@ -2,7 +2,7 @@ Generating patches with -p
2
--------------------------
3
4
When "git-diff-index", "git-diff-tree", or "git-diff-files" are run
5
-with a '-p' option, "git diff" without the '--raw' option, or
5
+with a `-p` option, "git diff" without the '--raw' option, or
6
"git log" with the "-p" option, they
7
do not produce the output described above; instead they produce a
8
patch file. You can customize the creation of such patches via the
@@ -114,7 +114,7 @@ index fabadb8,cc95eb0..4866510
114
------------
115
116
1. It is preceded with a "git diff" header, that looks like
117
- this (when '-c' option is used):
117
+ this (when `-c` option is used):
118
119
diff --combined file
120
+
Documentation/git-cat-file.txt
+6
-6
@@ -15,8 +15,8 @@ SYNOPSIS
15
DESCRIPTION
16
-----------
17
In its first form, the command provides the content or the type of an object in
18
-the repository. The type is required unless '-t' or '-p' is used to find the
19
-object type, or '-s' is used to find the object size, or '--textconv' is used
18
+the repository. The type is required unless `-t` or `-p` is used to find the
19
+object type, or `-s` is used to find the object size, or '--textconv' is used
20
(which implies type "blob").
21
22
In the second form, a list of objects (separated by linefeeds) is provided on
@@ -144,13 +144,13 @@ respectively print:
144
145
OUTPUT
146
------
147
-If '-t' is specified, one of the <type>.
147
+If `-t` is specified, one of the <type>.
148
149
-If '-s' is specified, the size of the <object> in bytes.
149
+If `-s` is specified, the size of the <object> in bytes.
150
151
-If '-e' is specified, no output.
151
+If `-e` is specified, no output.
152
153
-If '-p' is specified, the contents of <object> are pretty-printed.
153
+If `-p` is specified, the contents of <object> are pretty-printed.
154
155
If <type> is specified, the raw (though uncompressed) contents of the <object>
156
will be returned.
Documentation/git-checkout.txt
+2
-2
@@ -157,7 +157,7 @@ of it").
157
When creating a new branch, set up "upstream" configuration. See
158
"--track" in linkgit:git-branch[1] for details.
159
+
160
-If no '-b' option is given, the name of the new branch will be
160
+If no `-b` option is given, the name of the new branch will be
161
derived from the remote-tracking branch, by looking at the local part of
162
the refspec configured for the corresponding remote, and then stripping
163
the initial part up to the "*".
@@ -165,7 +165,7 @@ This would tell us to use "hack" as the local branch when branching
165
off of "origin/hack" (or "remotes/origin/hack", or even
166
"refs/remotes/origin/hack"). If the given name has no slash, or the above
167
guessing results in an empty name, the guessing is aborted. You can
168
-explicitly give a name with '-b' in such a case.
168
+explicitly give a name with `-b` in such a case.
169
170
--no-track::
171
Do not set up "upstream" configuration, even if the
Documentation/git-clean.txt
+1
-1
@@ -16,7 +16,7 @@ DESCRIPTION
16
Cleans the working tree by recursively removing files that are not
17
under version control, starting from the current directory.
18
19
-Normally, only files unknown to Git are removed, but if the '-x'
19
+Normally, only files unknown to Git are removed, but if the `-x`
20
option is specified, ignored files are also removed. This can, for
21
example, be useful to remove all build products.
22
Documentation/git-commit-tree.txt
+1
-1
@@ -44,7 +44,7 @@ OPTIONS
44
An existing tree object
45
46
-p <parent>::
47
- Each '-p' indicates the id of a parent commit object.
47
+ Each `-p` indicates the id of a parent commit object.
48
49
-m <message>::
50
A paragraph in the commit log message. This can be given more than
Documentation/git-commit.txt
+1
-1
@@ -75,7 +75,7 @@ OPTIONS
75
76
-c <commit>::
77
--reedit-message=<commit>::
78
- Like '-C', but with '-c' the editor is invoked, so that
78
+ Like '-C', but with `-c` the editor is invoked, so that
79
the user can further edit the commit message.
80
81
--fixup=<commit>::
Documentation/git-cvsimport.txt
+3
-3
@@ -103,7 +103,7 @@ the old cvs2git tool.
103
104
-p <options-for-cvsps>::
105
Additional options for cvsps.
106
- The options '-u' and '-A' are implicit and should not be used here.
106
+ The options `-u` and '-A' are implicit and should not be used here.
107
+
108
If you need to pass multiple options, separate them with a comma.
109
@@ -122,7 +122,7 @@ If you need to pass multiple options, separate them with a comma.
122
123
-M <regex>::
124
Attempt to detect merges based on the commit message with a custom
125
- regex. It can be used with '-m' to enable the default regexes
125
+ regex. It can be used with `-m` to enable the default regexes
126
as well. You must escape forward slashes.
127
+
128
The regex must capture the source branch name in $1.
@@ -186,7 +186,7 @@ messages, bug-tracking systems, email archives, and the like.
186
187
OUTPUT
188
------
189
-If '-v' is specified, the script reports what it is doing.
189
+If `-v` is specified, the script reports what it is doing.
190
191
Otherwise, success is indicated the Unix way, i.e. by simply exiting with
192
a zero exit status.
Documentation/git-cvsserver.txt
+4
-4
@@ -402,12 +402,12 @@ Exports and tagging (tags and branches) are not supported at this stage.
402
CRLF Line Ending Conversions
403
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
404
405
-By default the server leaves the '-k' mode blank for all files,
405
+By default the server leaves the `-k` mode blank for all files,
406
which causes the CVS client to treat them as a text files, subject
407
to end-of-line conversion on some platforms.
408
409
You can make the server use the end-of-line conversion attributes to
410
-set the '-k' modes for files by setting the `gitcvs.usecrlfattr`
410
+set the `-k` modes for files by setting the `gitcvs.usecrlfattr`
411
config variable. See linkgit:gitattributes[5] for more information
412
about end-of-line conversion.
413
@@ -415,9 +415,9 @@ Alternatively, if `gitcvs.usecrlfattr` config is not enabled
415
or the attributes do not allow automatic detection for a filename, then
416
the server uses the `gitcvs.allBinary` config for the default setting.
417
If `gitcvs.allBinary` is set, then file not otherwise
418
-specified will default to '-kb' mode. Otherwise the '-k' mode
418
+specified will default to '-kb' mode. Otherwise the `-k` mode
419
is left blank. But if `gitcvs.allBinary` is set to "guess", then
420
-the correct '-k' mode will be guessed based on the contents of
420
+the correct `-k` mode will be guessed based on the contents of
421
the file.
422
423
For best consistency with 'cvs', it is probably best to override the
Documentation/git-diff-tree.txt
+7
-7
@@ -70,13 +70,13 @@ commits (but not trees).
70
By default, 'git diff-tree --stdin' does not show
71
differences for merge commits. With this flag, it shows
72
differences to that commit from all of its parents. See
73
- also '-c'.
73
+ also `-c`.
74
75
-s::
76
By default, 'git diff-tree --stdin' shows differences,
77
- either in machine-readable form (without '-p') or in patch
78
- form (with '-p'). This output can be suppressed. It is
79
- only useful with '-v' flag.
77
+ either in machine-readable form (without `-p`) or in patch
78
+ form (with `-p`). This output can be suppressed. It is
79
+ only useful with `-v` flag.
80
81
-v::
82
This flag causes 'git diff-tree --stdin' to also show
@@ -94,14 +94,14 @@ include::pretty-options.txt[]
94
one <tree-ish>, or '--stdin'). It shows the differences
95
from each of the parents to the merge result simultaneously
96
instead of showing pairwise diff between a parent and the
97
- result one at a time (which is what the '-m' option does).
97
+ result one at a time (which is what the `-m` option does).
98
Furthermore, it lists only files which were modified
99
from all parents.
100
101
--cc::
102
This flag changes the way a merge commit patch is displayed,
103
- in a similar way to the '-c' option. It implies the '-c'
104
- and '-p' options and further compresses the patch output
103
+ in a similar way to the `-c` option. It implies the `-c`
104
+ and `-p` options and further compresses the patch output
105
by omitting uninteresting hunks whose the contents in the parents
106
have only two variants and the merge result picks one of them
107
without modification. When all hunks are uninteresting, the commit
Documentation/git-fetch-pack.txt
+1
-1
@@ -47,7 +47,7 @@ be in a separate packet, and the list must end with a flush packet.
47
48
-q::
49
--quiet::
50
- Pass '-q' flag to 'git unpack-objects'; this makes the
50
+ Pass `-q` flag to 'git unpack-objects'; this makes the
51
cloning process less verbose.
52
53
-k::
Documentation/git-filter-branch.txt
+1
-1
@@ -52,7 +52,7 @@ if different from the rewritten ones, will be stored in the namespace
52
53
Note that since this operation is very I/O expensive, it might
54
be a good idea to redirect the temporary directory off-disk with the
55
-'-d' option, e.g. on tmpfs. Reportedly the speedup is very noticeable.
55
+`-d` option, e.g. on tmpfs. Reportedly the speedup is very noticeable.
56
57
58
Filters
Documentation/git-grep.txt
+1
-1
@@ -41,7 +41,7 @@ CONFIGURATION
41
-------------
42
43
grep.lineNumber::
44
- If set to true, enable '-n' option by default.
44
+ If set to true, enable `-n` option by default.
45
46
grep.patternType::
47
Set the default matching behavior. Using a value of 'basic', 'extended',
Documentation/git-help.txt
+2
-2
@@ -18,10 +18,10 @@ With no options and no COMMAND or GUIDE given, the synopsis of the 'git'
18
command and a list of the most commonly used Git commands are printed
19
on the standard output.
20
21
-If the option '--all' or '-a' is given, all available commands are
21
+If the option '--all' or `-a` is given, all available commands are
22
printed on the standard output.
23
24
-If the option '--guide' or '-g' is given, a list of the useful
24
+If the option '--guide' or `-g` is given, a list of the useful
25
Git guides is also printed on the standard output.
26
27
If a command, or a guide, is given, a manual page for that command or
Documentation/git-ls-tree.txt
+2
-2
@@ -20,7 +20,7 @@ in the current working directory. Note that:
20
21
- the behaviour is slightly different from that of "/bin/ls" in that the
22
'<path>' denotes just a list of patterns to match, e.g. so specifying
23
- directory name (without '-r') will behave differently, and order of the
23
+ directory name (without `-r`) will behave differently, and order of the
24
arguments does not matter.
25
26
- the behaviour is similar to that of "/bin/ls" in that the '<path>' is
@@ -46,7 +46,7 @@ OPTIONS
46
47
-t::
48
Show tree entries even when going to recurse them. Has no effect
49
- if '-r' was not passed. '-d' implies '-t'.
49
+ if `-r` was not passed. `-d` implies `-t`.
50
51
-l::
52
--long::
Documentation/git-mktree.txt
+1
-1
@@ -32,7 +32,7 @@ OPTIONS
32
--batch::
33
Allow building of more than one tree object before exiting. Each
34
tree is separated by as single blank line. The final new-line is
35
- optional. Note - if the '-z' option is used, lines are terminated
35
+ optional. Note - if the `-z` option is used, lines are terminated
36
with NUL.
37
38
GIT
Documentation/git-mv.txt
+1
-1
@@ -35,7 +35,7 @@ OPTIONS
35
Skip move or rename actions which would lead to an error
36
condition. An error happens when a source is neither existing nor
37
controlled by Git, or when it would overwrite an existing
38
- file unless '-f' is given.
38
+ file unless `-f` is given.
39
-n::
40
--dry-run::
41
Do nothing; only show what would happen
Documentation/git-notes.txt
+1
-1
@@ -152,7 +152,7 @@ OPTIONS
152
153
-c <object>::
154
--reedit-message=<object>::
155
- Like '-C', but with '-c' the editor is invoked, so that
155
+ Like '-C', but with `-c` the editor is invoked, so that
156
the user can further edit the note message.
157
158
--allow-empty::
Documentation/git-repack.txt
+2
-2
@@ -33,7 +33,7 @@ OPTIONS
33
pack everything referenced into a single pack.
34
Especially useful when packing a repository that is used
35
for private development. Use
36
- with '-d'. This will clean up the objects that `git prune`
36
+ with `-d`. This will clean up the objects that `git prune`
37
leaves behind, but `git fsck --full --dangling` shows as
38
dangling.
39
+
@@ -42,7 +42,7 @@ whole new pack in order to get any contained object, no matter how many
42
other objects in that pack they already have locally.
43
44
-A::
45
- Same as `-a`, unless '-d' is used. Then any unreachable
45
+ Same as `-a`, unless `-d` is used. Then any unreachable
46
objects in a previous pack become loose, unpacked objects,
47
instead of being left in the old pack. Unreachable objects
48
are never intentionally added to a pack, even when repacking.
Documentation/git-shell.txt
+2
-2
@@ -24,7 +24,7 @@ named `git-shell-commands` in the user's home directory.
24
COMMANDS
25
--------
26
27
-'git shell' accepts the following commands after the '-c' option:
27
+'git shell' accepts the following commands after the `-c` option:
28
29
'git receive-pack <argument>'::
30
'git upload-pack <argument>'::
@@ -43,7 +43,7 @@ directory.
43
INTERACTIVE USE
44
---------------
45
46
-By default, the commands above can be executed only with the '-c'
46
+By default, the commands above can be executed only with the `-c`
47
option; the shell is not interactive.
48
49
If a `~/git-shell-commands` directory is present, 'git shell'
Documentation/git.txt
+2
-2
@@ -508,7 +508,7 @@ OPTIONS
508
509
--help::
510
Prints the synopsis and a list of the most commonly used
511
- commands. If the option '--all' or '-a' is given then all
511
+ commands. If the option '--all' or `-a` is given then all
512
available commands are printed. If a Git command is named this
513
option will bring up the manual page for that command.
514
+
@@ -974,7 +974,7 @@ other
974
The command will be given exactly two or four arguments: the
975
'username@host' (or just 'host') from the URL and the shell
976
command to execute on that remote system, optionally preceded by
977
- '-p' (literally) and the 'port' from the URL when it specifies
977
+ `-p` (literally) and the 'port' from the URL when it specifies
978
something other than the default SSH port.
979
+
980
`$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted