Skip to content

Commit ce18123

Browse files
gitstergitster
committed
Merge branch 'mm/doc-tt'
More mark-up updates to typeset strings that are expected to literally typed by the end user in fixed-width font. * mm/doc-tt: doc: typeset HEAD and variants as literal CodingGuidelines: formatting HEAD in documentation doc: typeset long options with argument as literal doc: typeset '--' as literal doc: typeset long command-line options as literal doc: typeset short command-line options as literal Documentation/git-mv.txt: fix whitespace indentation
2 parents fc8a3a6 + 661c3e9 commit ce18123

Some content is hidden

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

62 files changed

+228
-227
lines changed

‎Documentation/CodingGuidelines‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -527,12 +527,13 @@ Writing Documentation:
527527
or commands:
528528

529529
Literal examples (e.g. use of command-line options, command names,
530-
configuration and environment variables) must be typeset in monospace (i.e.
531-
wrapped with backticks):
530+
branch names, configuration and environment variables) must be
531+
typeset in monospace (i.e. wrapped with backticks):
532532
`--pretty=oneline`
533533
`git rev-list`
534534
`remote.pushDefault`
535535
`GIT_DIR`
536+
`HEAD`
536537

537538
An environment variable must be prefixed with "$" only when referring to its
538539
value and not when referring to the variable itself, in this case there is

‎Documentation/config.txt‎

Lines changed: 20 additions & 20 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

@@ -488,7 +488,7 @@ core.worktree::
488488
If `GIT_COMMON_DIR` environment variable is set, core.worktree
489489
is ignored and not used for determining the root of working tree.
490490
This can be overridden by the `GIT_WORK_TREE` environment
491-
variable and the '--work-tree' command-line option.
491+
variable and the `--work-tree` command-line option.
492492
The value can be an absolute path or relative to the path to
493493
the .git directory, which is either specified by --git-dir
494494
or GIT_DIR, or automatically discovered.
@@ -786,7 +786,7 @@ core.abbrev::
786786
add.ignoreErrors::
787787
add.ignore-errors (deprecated)::
788788
Tells 'git add' to continue adding files when some files cannot be
789-
added due to indexing errors. Equivalent to the '--ignore-errors'
789+
added due to indexing errors. Equivalent to the `--ignore-errors`
790790
option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
791791
as it does not follow the usual naming convention for configuration
792792
variables.
@@ -812,9 +812,9 @@ from the original current directory. See linkgit:git-rev-parse[1].
812812

813813
am.keepcr::
814814
If true, git-am will call git-mailsplit for patches in mbox format
815-
with parameter '--keep-cr'. In this case git-mailsplit will
815+
with parameter `--keep-cr`. In this case git-mailsplit will
816816
not remove `\r` from lines ending with `\r\n`. Can be overridden
817-
by giving '--no-keep-cr' from the command line.
817+
by giving `--no-keep-cr` from the command line.
818818
See linkgit:git-am[1], linkgit:git-mailsplit[1].
819819

820820
am.threeWay::
@@ -827,15 +827,15 @@ am.threeWay::
827827

828828
apply.ignoreWhitespace::
829829
When set to 'change', tells 'git apply' to ignore changes in
830-
whitespace, in the same way as the '--ignore-space-change'
830+
whitespace, in the same way as the `--ignore-space-change`
831831
option.
832832
When set to one of: no, none, never, false tells 'git apply' to
833833
respect all whitespace differences.
834834
See linkgit:git-apply[1].
835835

836836
apply.whitespace::
837837
Tells 'git apply' how to handle whitespaces, in the same way
838-
as the '--whitespace' option. See linkgit:git-apply[1].
838+
as the `--whitespace` option. See linkgit:git-apply[1].
839839

840840
branch.autoSetupMerge::
841841
Tells 'git branch' and 'git checkout' to set up new branches
@@ -937,7 +937,7 @@ browser.<tool>.cmd::
937937

938938
browser.<tool>.path::
939939
Override the path for the given tool that may be used to
940-
browse HTML help (see '-w' option in linkgit:git-help[1]) or a
940+
browse HTML help (see `-w` option in linkgit:git-help[1]) or a
941941
working repository in gitweb (see linkgit:git-instaweb[1]).
942942

943943
clean.requireForce::
@@ -1436,9 +1436,9 @@ gitcvs.logFile::
14361436

14371437
gitcvs.usecrlfattr::
14381438
If true, the server will look up the end-of-line conversion
1439-
attributes for files to determine the '-k' modes to use. If
1439+
attributes for files to determine the `-k` modes to use. If
14401440
the attributes force Git to treat a file as text,
1441-
the '-k' mode will be left blank so CVS clients will
1441+
the `-k` mode will be left blank so CVS clients will
14421442
treat it as text. If they suppress text conversion, the file
14431443
will be set with '-kb' mode, which suppresses any newline munging
14441444
the client might otherwise do. If the attributes do not allow
@@ -1508,16 +1508,16 @@ gitweb.snapshot::
15081508
See linkgit:gitweb.conf[5] for description.
15091509

15101510
grep.lineNumber::
1511-
If set to true, enable '-n' option by default.
1511+
If set to true, enable `-n` option by default.
15121512

15131513
grep.patternType::
15141514
Set the default matching behavior. Using a value of 'basic', 'extended',
1515-
'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1516-
'--fixed-strings', or '--perl-regexp' option accordingly, while the
1515+
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1516+
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
15171517
value 'default' will return to the default matching behavior.
15181518

15191519
grep.extendedRegexp::
1520-
If set to true, enable '--extended-regexp' option by default. This
1520+
If set to true, enable `--extended-regexp` option by default. This
15211521
option is ignored when the `grep.patternType` option is set to a value
15221522
other than 'default'.
15231523

@@ -1974,7 +1974,7 @@ log.decorate::
19741974
specified, the full ref name (including prefix) will be printed.
19751975
If 'auto' is specified, then if the output is going to a terminal,
19761976
the ref names are shown as if 'short' were given, otherwise no ref
1977-
names are shown. This is the same as the '--decorate' option
1977+
names are shown. This is the same as the `--decorate` option
19781978
of the `git log`.
19791979

19801980
log.follow::
@@ -2357,16 +2357,16 @@ new default).
23572357
--
23582358

23592359
push.followTags::
2360-
If set to true enable '--follow-tags' option by default. You
2360+
If set to true enable `--follow-tags` option by default. You
23612361
may override this configuration at time of push by specifying
2362-
'--no-follow-tags'.
2362+
`--no-follow-tags`.
23632363

23642364
push.gpgSign::
23652365
May be set to a boolean value, or the string 'if-asked'. A true
2366-
value causes all pushes to be GPG signed, as if '--signed' is
2366+
value causes all pushes to be GPG signed, as if `--signed` is
23672367
passed to linkgit:git-push[1]. The string 'if-asked' causes
23682368
pushes to be signed if the server supports it, as if
2369-
'--signed=if-asked' is passed to 'git push'. A false value may
2369+
`--signed=if-asked` is passed to 'git push'. A false value may
23702370
override a value from a lower-priority config file. An explicit
23712371
command-line flag always overrides this config option.
23722372

@@ -2389,7 +2389,7 @@ rebase.stat::
23892389
rebase. False by default.
23902390

23912391
rebase.autoSquash::
2392-
If set to true enable '--autosquash' option by default.
2392+
If set to true enable `--autosquash` option by default.
23932393

23942394
rebase.autoStash::
23952395
When set to true, automatically create a temporary stash

‎Documentation/diff-config.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ diff.orderFile::
105105

106106
diff.renameLimit::
107107
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`.
109109

110110
diff.renames::
111111
Whether and how Git detects renames. If set to "false",

‎Documentation/diff-format.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ That is, from the left to the right:
4646
. sha1 for "dst"; 0\{40\} if creation, unmerged or "look at work tree".
4747
. a space.
4848
. 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.
5050
. 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.
5252
. 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.
5454

5555
Possible status letters are:
5656

@@ -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: 3 additions & 3 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
@@ -114,11 +114,11 @@ index fabadb8,cc95eb0..4866510
114114
------------
115115

116116
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):
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
@@ -199,12 +199,12 @@ When initially invoking `git am`, you give it the names of the mailboxes
199199
to process. Upon seeing the first patch that does not apply, it
200200
aborts in the middle. You can recover from this in one of two ways:
201201

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

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

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

‎Documentation/git-bisect.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ OPTIONS
358358
--no-checkout::
359359
+
360360
Do not checkout the new working tree at each iteration of the bisection
361-
process. Instead just update a special reference named 'BISECT_HEAD' to make
361+
process. Instead just update a special reference named `BISECT_HEAD` to make
362362
it point to the commit that should be tested.
363363
+
364364
This option may be useful when the test you would perform in each step

‎Documentation/git-branch.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ named commit). With `--merged`, only branches merged into the named
3939
commit (i.e. the branches whose tip commits are reachable from the named
4040
commit) will be listed. With `--no-merged` only branches not merged into
4141
the named commit will be listed. If the <commit> argument is missing it
42-
defaults to 'HEAD' (i.e. the tip of the current branch).
42+
defaults to `HEAD` (i.e. the tip of the current branch).
4343

4444
The command's second form creates a new branch head named <branchname>
45-
which points to the current 'HEAD', or <start-point> if given.
45+
which points to the current `HEAD`, or <start-point> if given.
4646

4747
Note that this will create the new branch, but it will not switch the
4848
working tree to it; use "git checkout <newbranch>" to switch to the
@@ -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: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ SYNOPSIS
1515
DESCRIPTION
1616
-----------
1717
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
2020
(which implies type "blob").
2121

2222
In the second form, a list of objects (separated by linefeeds) is provided on
@@ -144,13 +144,13 @@ respectively print:
144144

145145
OUTPUT
146146
------
147-
If '-t' is specified, one of the <type>.
147+
If `-t` is specified, one of the <type>.
148148

149-
If '-s' is specified, the size of the <object> in bytes.
149+
If `-s` is specified, the size of the <object> in bytes.
150150

151-
If '-e' is specified, no output.
151+
If `-e` is specified, no output.
152152

153-
If '-p' is specified, the contents of <object> are pretty-printed.
153+
If `-p` is specified, the contents of <object> are pretty-printed.
154154

155155
If <type> is specified, the raw (though uncompressed) contents of the <object>
156156
will be returned.

0 commit comments

Comments
 (0)