Skip to content

Commit ae9f631

Browse files
Tom Russellogitster
authored andcommitted
doc: change configuration variables format
This change configuration variables that where in italic style to monospace font according to the guideline. It was obtained with grep '[[:alpha:]]*\.[[:alpha:]]*::$' config.txt | \ sed -e 's/::$//' -e 's/\./\\\\./' | \ xargs -iP perl -pi -e "s/\'P\'/\`P\`/g" ./*.txt Signed-off-by: Tom Russello <[email protected]> Signed-off-by: Erwan Mathoniere <[email protected]> Signed-off-by: Samuel Groot <[email protected]> Signed-off-by: Matthieu Moy <[email protected]> Reviewed-by: Matthieu Moy <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 47d81b5 commit ae9f631

17 files changed

+86
-86
lines changed

Documentation/config.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ core.compression::
545545
-1 is the zlib default. 0 means no compression,
546546
and 1..9 are various speed/size tradeoffs, 9 being slowest.
547547
If set, this provides a default to other compression variables,
548-
such as 'core.looseCompression' and 'pack.compression'.
548+
such as `core.looseCompression` and `pack.compression`.
549549

550550
core.looseCompression::
551551
An integer -1..9, indicating the compression level for objects that
@@ -1400,18 +1400,18 @@ gitcvs.usecrlfattr::
14001400
treat it as text. If they suppress text conversion, the file
14011401
will be set with '-kb' mode, which suppresses any newline munging
14021402
the client might otherwise do. If the attributes do not allow
1403-
the file type to be determined, then 'gitcvs.allBinary' is
1403+
the file type to be determined, then `gitcvs.allBinary` is
14041404
used. See linkgit:gitattributes[5].
14051405

14061406
gitcvs.allBinary::
1407-
This is used if 'gitcvs.usecrlfattr' does not resolve
1407+
This is used if `gitcvs.usecrlfattr` does not resolve
14081408
the correct '-kb' mode to use. If true, all
14091409
unresolved files are sent to the client in
14101410
mode '-kb'. This causes the client to treat them
14111411
as binary files, which suppresses any newline munging it
14121412
otherwise might do. Alternatively, if it is set to "guess",
14131413
then the contents of the file are examined to decide if
1414-
it is binary, similar to 'core.autocrlf'.
1414+
it is binary, similar to `core.autocrlf`.
14151415

14161416
gitcvs.dbName::
14171417
Database used by git-cvsserver to cache revision information
@@ -1430,7 +1430,7 @@ gitcvs.dbDriver::
14301430
See linkgit:git-cvsserver[1].
14311431

14321432
gitcvs.dbUser, gitcvs.dbPass::
1433-
Database user and password. Only useful if setting 'gitcvs.dbDriver',
1433+
Database user and password. Only useful if setting `gitcvs.dbDriver`,
14341434
since SQLite has no concept of database users and/or passwords.
14351435
'gitcvs.dbUser' supports variable substitution (see
14361436
linkgit:git-cvsserver[1] for details).
@@ -1442,8 +1442,8 @@ gitcvs.dbTableNamePrefix::
14421442
linkgit:git-cvsserver[1] for details). Any non-alphabetic
14431443
characters will be replaced with underscores.
14441444

1445-
All gitcvs variables except for 'gitcvs.usecrlfattr' and
1446-
'gitcvs.allBinary' can also be specified as
1445+
All gitcvs variables except for `gitcvs.usecrlfattr` and
1446+
`gitcvs.allBinary` can also be specified as
14471447
'gitcvs.<access_method>.<varname>' (where 'access_method'
14481448
is one of "ext" and "pserver") to make them apply only for the given
14491449
access method.
@@ -1476,7 +1476,7 @@ grep.patternType::
14761476

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

14821482
grep.threads::
@@ -2587,7 +2587,7 @@ sendemail.identity::
25872587
A configuration identity. When given, causes values in the
25882588
'sendemail.<identity>' subsection to take precedence over
25892589
values in the 'sendemail' section. The default identity is
2590-
the value of 'sendemail.identity'.
2590+
the value of `sendemail.identity`.
25912591

25922592
sendemail.smtpEncryption::
25932593
See linkgit:git-send-email[1] for description. Note that this
@@ -2604,7 +2604,7 @@ sendemail.<identity>.*::
26042604
Identity-specific versions of the 'sendemail.*' parameters
26052605
found below, taking precedence over those when the this
26062606
identity is selected, through command-line or
2607-
'sendemail.identity'.
2607+
`sendemail.identity`.
26082608

26092609
sendemail.aliasesFile::
26102610
sendemail.aliasFileType::
@@ -2634,7 +2634,7 @@ sendemail.xmailer::
26342634
See linkgit:git-send-email[1] for description.
26352635

26362636
sendemail.signedoffcc (deprecated)::
2637-
Deprecated alias for 'sendemail.signedoffbycc'.
2637+
Deprecated alias for `sendemail.signedoffbycc`.
26382638

26392639
showbranch.default::
26402640
The default set of branches for linkgit:git-show-branch[1].
@@ -2864,8 +2864,8 @@ user.name::
28642864
environment variables. See linkgit:git-commit-tree[1].
28652865

28662866
user.useConfigOnly::
2867-
Instruct Git to avoid trying to guess defaults for 'user.email'
2868-
and 'user.name', and instead retrieve the values only from the
2867+
Instruct Git to avoid trying to guess defaults for `user.email`
2868+
and `user.name`, and instead retrieve the values only from the
28692869
configuration. For example, if you have multiple email addresses
28702870
and would like to use a different one for each repository, then
28712871
with this configuration option set to `true` in the global config

Documentation/diff-config.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ diff.ignoreSubmodules::
7575
commands such as 'git diff-files'. 'git checkout' also honors
7676
this setting when reporting uncommitted changes. Setting it to
7777
'all' disables the submodule summary normally shown by 'git commit'
78-
and 'git status' when 'status.submoduleSummary' is set unless it is
78+
and 'git status' when `status.submoduleSummary` is set unless it is
7979
overridden by using the --ignore-submodules command-line option.
8080
The 'git submodule' commands are not affected by this setting.
8181

Documentation/git-commit.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ default::
201201
Otherwise `whitespace`.
202202
--
203203
+
204-
The default can be changed by the 'commit.cleanup' configuration
204+
The default can be changed by the `commit.cleanup` configuration
205205
variable (see linkgit:git-config[1]).
206206

207207
-e::

Documentation/git-format-patch.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ output, unless the `--stdout` option is specified.
5858

5959
If `-o` is specified, output files are created in <dir>. Otherwise
6060
they are created in the current working directory. The default path
61-
can be set with the 'format.outputDirectory' configuration option.
61+
can be set with the `format.outputDirectory` configuration option.
6262
The `-o` option takes precedence over `format.outputDirectory`.
6363
To store patches in the current working directory even when
6464
`format.outputDirectory` points elsewhere, use `-o .`.
@@ -146,9 +146,9 @@ series, where the head is chosen from the cover letter, the
146146
`--in-reply-to`, and the first patch mail, in this order. 'deep'
147147
threading makes every mail a reply to the previous one.
148148
+
149-
The default is `--no-thread`, unless the 'format.thread' configuration
149+
The default is `--no-thread`, unless the `format.thread` configuration
150150
is set. If `--thread` is specified without a style, it defaults to the
151-
style specified by 'format.thread' if any, or else `shallow`.
151+
style specified by `format.thread` if any, or else `shallow`.
152152
+
153153
Beware that the default for 'git send-email' is to thread emails
154154
itself. If you want `git format-patch` to take care of threading, you

Documentation/git-gc.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ automatic consolidation of packs.
8282
Configuration
8383
-------------
8484

85-
The optional configuration variable 'gc.reflogExpire' can be
85+
The optional configuration variable `gc.reflogExpire` can be
8686
set to indicate how long historical entries within each branch's
8787
reflog should remain available in this repository. The setting is
8888
expressed as a length of time, for example '90 days' or '3 months'.
8989
It defaults to '90 days'.
9090

91-
The optional configuration variable 'gc.reflogExpireUnreachable'
91+
The optional configuration variable `gc.reflogExpireUnreachable`
9292
can be set to indicate how long historical reflog entries which
9393
are not part of the current branch should remain available in
9494
this repository. These types of entries are generally created as
@@ -107,30 +107,30 @@ branches:
107107
reflogExpireUnreachable = 3 days
108108
------------
109109

110-
The optional configuration variable 'gc.rerereResolved' indicates
110+
The optional configuration variable `gc.rerereResolved` indicates
111111
how long records of conflicted merge you resolved earlier are
112112
kept. This defaults to 60 days.
113113

114-
The optional configuration variable 'gc.rerereUnresolved' indicates
114+
The optional configuration variable `gc.rerereUnresolved` indicates
115115
how long records of conflicted merge you have not resolved are
116116
kept. This defaults to 15 days.
117117

118-
The optional configuration variable 'gc.packRefs' determines if
118+
The optional configuration variable `gc.packRefs` determines if
119119
'git gc' runs 'git pack-refs'. This can be set to "notbare" to enable
120120
it within all non-bare repos or it can be set to a boolean value.
121121
This defaults to true.
122122

123-
The optional configuration variable 'gc.aggressiveWindow' controls how
123+
The optional configuration variable `gc.aggressiveWindow` controls how
124124
much time is spent optimizing the delta compression of the objects in
125125
the repository when the --aggressive option is specified. The larger
126126
the value, the more time is spent optimizing the delta compression. See
127127
the documentation for the --window' option in linkgit:git-repack[1] for
128128
more details. This defaults to 250.
129129

130-
Similarly, the optional configuration variable 'gc.aggressiveDepth'
130+
Similarly, the optional configuration variable `gc.aggressiveDepth`
131131
controls --depth option in linkgit:git-repack[1]. This defaults to 250.
132132

133-
The optional configuration variable 'gc.pruneExpire' controls how old
133+
The optional configuration variable `gc.pruneExpire` controls how old
134134
the unreferenced loose objects have to be before they are pruned. The
135135
default is "2 weeks ago".
136136

Documentation/git-grep.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ grep.patternType::
5151

5252
grep.extendedRegexp::
5353
If set to true, enable '--extended-regexp' option by default. This
54-
option is ignored when the 'grep.patternType' option is set to a value
54+
option is ignored when the `grep.patternType` option is set to a value
5555
other than 'default'.
5656

5757
grep.threads::

Documentation/git-help.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ OPTIONS
5757
--man::
5858
Display manual page for the command in the 'man' format. This
5959
option may be used to override a value set in the
60-
'help.format' configuration variable.
60+
`help.format` configuration variable.
6161
+
6262
By default the 'man' program will be used to display the manual page,
63-
but the 'man.viewer' configuration variable may be used to choose
63+
but the `man.viewer` configuration variable may be used to choose
6464
other display programs (see below).
6565

6666
-w::
@@ -69,7 +69,7 @@ other display programs (see below).
6969
format. A web browser will be used for that purpose.
7070
+
7171
The web browser can be specified using the configuration variable
72-
'help.browser', or 'web.browser' if the former is not set. If none of
72+
`help.browser`, or `web.browser` if the former is not set. If none of
7373
these config variables is set, the 'git web{litdd}browse' helper script
7474
(called by 'git help') will pick a suitable default. See
7575
linkgit:git-web{litdd}browse[1] for more information about this.
@@ -80,7 +80,7 @@ CONFIGURATION VARIABLES
8080
help.format
8181
~~~~~~~~~~~
8282

83-
If no command-line option is passed, the 'help.format' configuration
83+
If no command-line option is passed, the `help.format` configuration
8484
variable will be checked. The following values are supported for this
8585
variable; they make 'git help' behave as their corresponding command-
8686
line option:
@@ -92,15 +92,15 @@ line option:
9292
help.browser, web.browser and browser.<tool>.path
9393
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9494

95-
The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
95+
The `help.browser`, `web.browser` and `browser.<tool>.path` will also
9696
be checked if the 'web' format is chosen (either by command-line
9797
option or configuration variable). See '-w|--web' in the OPTIONS
9898
section above and linkgit:git-web{litdd}browse[1].
9999

100100
man.viewer
101101
~~~~~~~~~~
102102

103-
The 'man.viewer' configuration variable will be checked if the 'man'
103+
The `man.viewer` configuration variable will be checked if the 'man'
104104
format is chosen. The following values are currently supported:
105105

106106
* "man": use the 'man' program as usual,
@@ -110,9 +110,9 @@ format is chosen. The following values are currently supported:
110110
tab (see 'Note about konqueror' below).
111111

112112
Values for other tools can be used if there is a corresponding
113-
'man.<tool>.cmd' configuration entry (see below).
113+
`man.<tool>.cmd` configuration entry (see below).
114114

115-
Multiple values may be given to the 'man.viewer' configuration
115+
Multiple values may be given to the `man.viewer` configuration
116116
variable. Their corresponding programs will be tried in the order
117117
listed in the configuration file.
118118

@@ -135,25 +135,25 @@ man.<tool>.path
135135
~~~~~~~~~~~~~~~
136136

137137
You can explicitly provide a full path to your preferred man viewer by
138-
setting the configuration variable 'man.<tool>.path'. For example, you
138+
setting the configuration variable `man.<tool>.path`. For example, you
139139
can configure the absolute path to konqueror by setting
140140
'man.konqueror.path'. Otherwise, 'git help' assumes the tool is
141141
available in PATH.
142142

143143
man.<tool>.cmd
144144
~~~~~~~~~~~~~~
145145

146-
When the man viewer, specified by the 'man.viewer' configuration
146+
When the man viewer, specified by the `man.viewer` configuration
147147
variables, is not among the supported ones, then the corresponding
148-
'man.<tool>.cmd' configuration variable will be looked up. If this
148+
`man.<tool>.cmd` configuration variable will be looked up. If this
149149
variable exists then the specified tool will be treated as a custom
150150
command and a shell eval will be used to run the command with the man
151151
page passed as arguments.
152152

153153
Note about konqueror
154154
~~~~~~~~~~~~~~~~~~~~
155155

156-
When 'konqueror' is specified in the 'man.viewer' configuration
156+
When 'konqueror' is specified in the `man.viewer` configuration
157157
variable, we launch 'kfmclient' to try to open the man page on an
158158
already opened konqueror in a new tab if possible.
159159

Documentation/git-instaweb.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ You may specify configuration in your .git/config
8080

8181
-----------------------------------------------------------------------
8282

83-
If the configuration variable 'instaweb.browser' is not set,
84-
'web.browser' will be used instead if it is defined. See
83+
If the configuration variable `instaweb.browser` is not set,
84+
`web.browser` will be used instead if it is defined. See
8585
linkgit:git-web{litdd}browse[1] for more information about this.
8686

8787
SEE ALSO

Documentation/git-push.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,8 @@ already exists on the remote side.
137137
and also push annotated tags in `refs/tags` that are missing
138138
from the remote but are pointing at commit-ish that are
139139
reachable from the refs being pushed. This can also be specified
140-
with configuration variable 'push.followTags'. For more
141-
information, see 'push.followTags' in linkgit:git-config[1].
140+
with configuration variable `push.followTags`. For more
141+
information, see `push.followTags` in linkgit:git-config[1].
142142

143143
--[no-]signed::
144144
--sign=(true|false|if-asked)::
@@ -240,7 +240,7 @@ origin +master` to force a push to the `master` branch). See the
240240
For every branch that is up to date or successfully pushed, add
241241
upstream (tracking) reference, used by argument-less
242242
linkgit:git-pull[1] and other commands. For more information,
243-
see 'branch.<name>.merge' in linkgit:git-config[1].
243+
see `branch.<name>.merge` in linkgit:git-config[1].
244244

245245
--[no-]thin::
246246
These options are passed to linkgit:git-send-pack[1]. A thin transfer

0 commit comments

Comments
 (0)