Skip to content

Commit bcf9626

Browse files
moygitster
moy
authored and
gitster
committed
doc: typeset long command-line options as literal
Similarly to the previous commit, use backquotes instead of forward-quotes, for long options. This was obtained with: perl -pi -e "s/'(--[a-z][a-z=<>-]*)'/\`\$1\`/g" *.txt and manual tweak to remove false positive in ascii-art (o'--o'--o' to describe rewritten history). Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 23f8239 commit bcf9626

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+149
-149
lines changed

‎Documentation/config.txt‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ boolean::
140140
false;; Boolean false can be spelled as `no`, `off`,
141141
`false`, or `0`.
142142
+
143-
When converting value to the canonical form using '--bool' type
143+
When converting value to the canonical form using `--bool` type
144144
specifier; 'git config' will ensure that the output is "true" or
145145
"false" (spelled in lowercase).
146146

@@ -481,7 +481,7 @@ core.worktree::
481481
If `GIT_COMMON_DIR` environment variable is set, core.worktree
482482
is ignored and not used for determining the root of working tree.
483483
This can be overridden by the `GIT_WORK_TREE` environment
484-
variable and the '--work-tree' command-line option.
484+
variable and the `--work-tree` command-line option.
485485
The value can be an absolute path or relative to the path to
486486
the .git directory, which is either specified by --git-dir
487487
or GIT_DIR, or automatically discovered.
@@ -762,7 +762,7 @@ core.abbrev::
762762
add.ignoreErrors::
763763
add.ignore-errors (deprecated)::
764764
Tells 'git add' to continue adding files when some files cannot be
765-
added due to indexing errors. Equivalent to the '--ignore-errors'
765+
added due to indexing errors. Equivalent to the `--ignore-errors`
766766
option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
767767
as it does not follow the usual naming convention for configuration
768768
variables.
@@ -788,9 +788,9 @@ from the original current directory. See linkgit:git-rev-parse[1].
788788

789789
am.keepcr::
790790
If true, git-am will call git-mailsplit for patches in mbox format
791-
with parameter '--keep-cr'. In this case git-mailsplit will
791+
with parameter `--keep-cr`. In this case git-mailsplit will
792792
not remove `\r` from lines ending with `\r\n`. Can be overridden
793-
by giving '--no-keep-cr' from the command line.
793+
by giving `--no-keep-cr` from the command line.
794794
See linkgit:git-am[1], linkgit:git-mailsplit[1].
795795

796796
am.threeWay::
@@ -803,15 +803,15 @@ am.threeWay::
803803

804804
apply.ignoreWhitespace::
805805
When set to 'change', tells 'git apply' to ignore changes in
806-
whitespace, in the same way as the '--ignore-space-change'
806+
whitespace, in the same way as the `--ignore-space-change`
807807
option.
808808
When set to one of: no, none, never, false tells 'git apply' to
809809
respect all whitespace differences.
810810
See linkgit:git-apply[1].
811811

812812
apply.whitespace::
813813
Tells 'git apply' how to handle whitespaces, in the same way
814-
as the '--whitespace' option. See linkgit:git-apply[1].
814+
as the `--whitespace` option. See linkgit:git-apply[1].
815815

816816
branch.autoSetupMerge::
817817
Tells 'git branch' and 'git checkout' to set up new branches
@@ -1470,12 +1470,12 @@ grep.lineNumber::
14701470

14711471
grep.patternType::
14721472
Set the default matching behavior. Using a value of 'basic', 'extended',
1473-
'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1474-
'--fixed-strings', or '--perl-regexp' option accordingly, while the
1473+
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1474+
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
14751475
value 'default' will return to the default matching behavior.
14761476

14771477
grep.extendedRegexp::
1478-
If set to true, enable '--extended-regexp' option by default. This
1478+
If set to true, enable `--extended-regexp` option by default. This
14791479
option is ignored when the `grep.patternType` option is set to a value
14801480
other than 'default'.
14811481

@@ -1916,7 +1916,7 @@ log.decorate::
19161916
command. If 'short' is specified, the ref name prefixes 'refs/heads/',
19171917
'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
19181918
specified, the full ref name (including prefix) will be printed.
1919-
This is the same as the log commands '--decorate' option.
1919+
This is the same as the log commands `--decorate` option.
19201920

19211921
log.follow::
19221922
If `true`, `git log` will act as if the `--follow` option was used when
@@ -2298,16 +2298,16 @@ new default).
22982298
--
22992299

23002300
push.followTags::
2301-
If set to true enable '--follow-tags' option by default. You
2301+
If set to true enable `--follow-tags` option by default. You
23022302
may override this configuration at time of push by specifying
2303-
'--no-follow-tags'.
2303+
`--no-follow-tags`.
23042304

23052305
push.gpgSign::
23062306
May be set to a boolean value, or the string 'if-asked'. A true
2307-
value causes all pushes to be GPG signed, as if '--signed' is
2307+
value causes all pushes to be GPG signed, as if `--signed` is
23082308
passed to linkgit:git-push[1]. The string 'if-asked' causes
23092309
pushes to be signed if the server supports it, as if
2310-
'--signed=if-asked' is passed to 'git push'. A false value may
2310+
`--signed=if-asked` is passed to 'git push'. A false value may
23112311
override a value from a lower-priority config file. An explicit
23122312
command-line flag always overrides this config option.
23132313

@@ -2330,7 +2330,7 @@ rebase.stat::
23302330
rebase. False by default.
23312331

23322332
rebase.autoSquash::
2333-
If set to true enable '--autosquash' option by default.
2333+
If set to true enable `--autosquash` option by default.
23342334

23352335
rebase.autoStash::
23362336
When set to true, automatically create a temporary stash

‎Documentation/diff-format.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ diff format for merges
8686
----------------------
8787

8888
"git-diff-tree", "git-diff-files" and "git-diff --raw"
89-
can take `-c` or '--cc' option
89+
can take `-c` or `--cc` option
9090
to generate diff output also for merge commits. The output differs
9191
from the format described above in the following way:
9292

‎Documentation/diff-generate-patch.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Generating patches with -p
22
--------------------------
33

44
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
66
"git log" with the "-p" option, they
77
do not produce the output described above; instead they produce a
88
patch file. You can customize the creation of such patches via the
@@ -118,7 +118,7 @@ index fabadb8,cc95eb0..4866510
118118

119119
diff --combined file
120120
+
121-
or like this (when '--cc' option is used):
121+
or like this (when `--cc` option is used):
122122

123123
diff --cc file
124124

‎Documentation/fetch-options.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ ifndef::git-pull[]
8888
to whatever else would otherwise be fetched. Using this
8989
option alone does not subject tags to pruning, even if --prune
9090
is used (though tags may be pruned anyway if they are also the
91-
destination of an explicit refspec; see '--prune').
91+
destination of an explicit refspec; see `--prune`).
9292

9393
--recurse-submodules[=yes|on-demand|no]::
9494
This option controls if and under what conditions new commits of
@@ -110,7 +110,7 @@ ifndef::git-pull[]
110110

111111
--no-recurse-submodules::
112112
Disable recursive fetching of submodules (this has the same effect as
113-
using the '--recurse-submodules=no' option).
113+
using the `--recurse-submodules=no` option).
114114

115115
--submodule-prefix=<path>::
116116
Prepend <path> to paths printed in informative messages
@@ -137,7 +137,7 @@ endif::git-pull[]
137137

138138
--upload-pack <upload-pack>::
139139
When given, and the repository to fetch from is handled
140-
by 'git fetch-pack', '--exec=<upload-pack>' is passed to
140+
by 'git fetch-pack', `--exec=<upload-pack>` is passed to
141141
the command to specify non-default path for the command
142142
run on the other end.
143143

‎Documentation/git-am.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,12 +198,12 @@ When initially invoking `git am`, you give it the names of the mailboxes
198198
to process. Upon seeing the first patch that does not apply, it
199199
aborts in the middle. You can recover from this in one of two ways:
200200

201-
. skip the current patch by re-running the command with the '--skip'
201+
. skip the current patch by re-running the command with the `--skip`
202202
option.
203203

204204
. hand resolve the conflict in the working directory, and update
205205
the index file to bring it into a state that the patch should
206-
have produced. Then run the command with the '--continue' option.
206+
have produced. Then run the command with the `--continue` option.
207207

208208
The command refuses to process new mailboxes until the current
209209
operation is finished, so if you decide to start over from scratch,

‎Documentation/git-branch.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ This option is only applicable in non-verbose mode.
172172
+
173173
This behavior is the default when the start point is a remote-tracking branch.
174174
Set the branch.autoSetupMerge configuration variable to `false` if you
175-
want `git checkout` and `git branch` to always behave as if '--no-track'
175+
want `git checkout` and `git branch` to always behave as if `--no-track`
176176
were given. Set it to `always` if you want this behavior when the
177177
start-point is either a local or remote-tracking branch.
178178

‎Documentation/git-cat-file.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ DESCRIPTION
1616
-----------
1717
In its first form, the command provides the content or the type of an object in
1818
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
19+
object type, or `-s` is used to find the object size, or `--textconv` is used
2020
(which implies type "blob").
2121

2222
In the second form, a list of objects (separated by linefeeds) is provided on

‎Documentation/git-cherry-pick.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ OPTIONS
4747
For a more complete list of ways to spell commits, see
4848
linkgit:gitrevisions[7].
4949
Sets of commits can be passed but no traversal is done by
50-
default, as if the '--no-walk' option was specified, see
50+
default, as if the `--no-walk` option was specified, see
5151
linkgit:git-rev-list[1]. Note that specifying a range will
5252
feed all <commit>... arguments to a single revision walk
5353
(see a later example that uses 'maint master..next').

‎Documentation/git-commit.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
260260
staged for other paths. This is the default mode of operation of
261261
'git commit' if any paths are given on the command line,
262262
in which case this option can be omitted.
263-
If this option is specified together with '--amend', then
263+
If this option is specified together with `--amend`, then
264264
no paths need to be specified, which can be used to amend
265265
the last commit without committing changes that have
266266
already been staged.

‎Documentation/git-config.txt‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,29 +31,29 @@ You can query/set/replace/unset options with this command. The name is
3131
actually the section and the key separated by a dot, and the value will be
3232
escaped.
3333

34-
Multiple lines can be added to an option by using the '--add' option.
34+
Multiple lines can be added to an option by using the `--add` option.
3535
If you want to update or unset an option which can occur on multiple
3636
lines, a POSIX regexp `value_regex` needs to be given. Only the
3737
existing values that match the regexp are updated or unset. If
3838
you want to handle the lines that do *not* match the regex, just
3939
prepend a single exclamation mark in front (see also <<EXAMPLES>>).
4040

41-
The type specifier can be either '--int' or '--bool', to make
41+
The type specifier can be either `--int` or `--bool`, to make
4242
'git config' ensure that the variable(s) are of the given type and
4343
convert the value to the canonical form (simple decimal number for int,
44-
a "true" or "false" string for bool), or '--path', which does some
45-
path expansion (see '--path' below). If no type specifier is passed, no
44+
a "true" or "false" string for bool), or `--path`, which does some
45+
path expansion (see `--path` below). If no type specifier is passed, no
4646
checks or transformations are performed on the value.
4747

4848
When reading, the values are read from the system, global and
4949
repository local configuration files by default, and options
50-
'--system', '--global', '--local' and '--file <filename>' can be
50+
`--system`, `--global`, `--local` and '--file <filename>' can be
5151
used to tell the command to read from only that location (see <<FILES>>).
5252

5353
When writing, the new value is written to the repository local
54-
configuration file by default, and options '--system', '--global',
54+
configuration file by default, and options `--system`, `--global`,
5555
'--file <filename>' can be used to tell the command to write to
56-
that location (you can say '--local' but that is the default).
56+
that location (you can say `--local` but that is the default).
5757

5858
This command will fail with non-zero status upon error. Some exit
5959
codes are:
@@ -138,7 +138,7 @@ See also <<FILES>>.
138138
Use the given config file instead of the one specified by GIT_CONFIG.
139139

140140
--blob blob::
141-
Similar to '--file' but use the given blob instead of a file. E.g.
141+
Similar to `--file` but use the given blob instead of a file. E.g.
142142
you can use 'master:.gitmodules' to read values from the file
143143
'.gitmodules' in the master branch. See "SPECIFYING REVISIONS"
144144
section in linkgit:gitrevisions[7] for a more complete list of
@@ -220,7 +220,7 @@ See also <<FILES>>.
220220
-e::
221221
--edit::
222222
Opens an editor to modify the specified config file; either
223-
'--system', '--global', or repository (default).
223+
`--system`, `--global`, or repository (default).
224224

225225
--[no-]includes::
226226
Respect `include.*` directives in config files when looking up
@@ -232,7 +232,7 @@ See also <<FILES>>.
232232
FILES
233233
-----
234234

235-
If not set explicitly with '--file', there are four files where
235+
If not set explicitly with `--file`, there are four files where
236236
'git config' will search for configuration options:
237237

238238
$(prefix)/etc/gitconfig::
@@ -264,11 +264,11 @@ precedence over values read earlier. When multiple values are taken then all
264264
values of a key from all files will be used.
265265

266266
All writing options will per default write to the repository specific
267-
configuration file. Note that this also affects options like '--replace-all'
268-
and '--unset'. *'git config' will only ever change one file at a time*.
267+
configuration file. Note that this also affects options like `--replace-all`
268+
and `--unset`. *'git config' will only ever change one file at a time*.
269269

270270
You can override these rules either by command-line options or by environment
271-
variables. The '--global' and the '--system' options will limit the file used
271+
variables. The `--global` and the `--system` options will limit the file used
272272
to the global or system-wide file respectively. The `GIT_CONFIG` environment
273273
variable has a similar effect, but you can specify any filename you want.
274274

0 commit comments

Comments
 (0)