Skip to content

Commit eee7f4a

Browse files
Tom Russellogitster
Tom Russello
authored and
gitster
committed
doc: change environment variables format
This change GIT_* variables that where in italic style to monospaced font according to the guideline. It was obtained with perl -pi -e "s/\'(GIT_.*?)\'/\`\1\`/g" *.txt One of the main purposes is to stick to the CodingGuidelines as possible so that people writting new documentation by mimicking the existing are more likely to have it right (even if they didn't read the CodingGuidelines). Signed-off-by: Tom Russello <tom.russello@grenoble-inp.org> Signed-off-by: Erwan Mathoniere <erwan.mathoniere@grenoble-inp.org> Signed-off-by: Samuel Groot <samuel.groot@grenoble-inp.org> Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr> Reviewed-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 41f5b21 commit eee7f4a

File tree

9 files changed

+101
-101
lines changed

9 files changed

+101
-101
lines changed

‎Documentation/config.txt‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ core.gitProxy::
434434
may be set multiple times and is matched in the given order;
435435
the first match wins.
436436
+
437-
Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
437+
Can be overridden by the `GIT_PROXY_COMMAND` environment variable
438438
(which always applies universally, without the special "for"
439439
handling).
440440
+
@@ -619,7 +619,7 @@ core.excludesFile::
619619
core.askPass::
620620
Some commands (e.g. svn and http interfaces) that interactively
621621
ask for a password can be told to use an external program given
622-
via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
622+
via the value of this variable. Can be overridden by the `GIT_ASKPASS`
623623
environment variable. If not set, fall back to the value of the
624624
'SSH_ASKPASS' environment variable or, failing that, a simple password
625625
prompt. The external program shall be given a suitable prompt as
@@ -747,7 +747,7 @@ core.notesRef::
747747
notes should be printed.
748748
+
749749
This setting defaults to "refs/notes/commits", and it can be overridden by
750-
the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
750+
the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
751751

752752
core.sparseCheckout::
753753
Enable "sparse checkout" feature. See section "Sparse checkout" in
@@ -783,7 +783,7 @@ it will be treated as a shell command. For example, defining
783783
"gitk --all --not ORIG_HEAD". Note that shell commands will be
784784
executed from the top-level directory of a repository, which may
785785
not necessarily be the current directory.
786-
'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
786+
`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
787787
from the original current directory. See linkgit:git-rev-parse[1].
788788

789789
am.keepcr::
@@ -1561,7 +1561,7 @@ guitool.<name>.cmd::
15611561
of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
15621562
mandatory for every tool. The command is executed from the root of
15631563
the working directory, and in the environment it receives the name of
1564-
the tool as 'GIT_GUITOOL', the name of the currently selected file as
1564+
the tool as `GIT_GUITOOL`, the name of the currently selected file as
15651565
'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
15661566
the head is detached, 'CUR_BRANCH' is empty).
15671567

@@ -1646,7 +1646,7 @@ http.proxyAuthMethod::
16461646
only takes effect if the configured proxy string contains a user name part
16471647
(i.e. is of the form 'user@host' or 'user@host:port'). This can be
16481648
overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1649-
Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1649+
Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
16501650
variable. Possible values are:
16511651
+
16521652
--
@@ -1699,9 +1699,9 @@ http.sslVersion::
16991699
- tlsv1.2
17001700

17011701
+
1702-
Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1702+
Can be overridden by the `GIT_SSL_VERSION` environment variable.
17031703
To force git to use libcurl's default ssl version and ignore any
1704-
explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1704+
explicit http.sslversion option, set `GIT_SSL_VERSION` to the
17051705
empty string.
17061706

17071707
http.sslCipherList::
@@ -1712,41 +1712,41 @@ http.sslCipherList::
17121712
option; see the libcurl documentation for more details on the format
17131713
of this list.
17141714
+
1715-
Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1715+
Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
17161716
To force git to use libcurl's default cipher list and ignore any
1717-
explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1717+
explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
17181718
empty string.
17191719

17201720
http.sslVerify::
17211721
Whether to verify the SSL certificate when fetching or pushing
1722-
over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1722+
over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
17231723
variable.
17241724

17251725
http.sslCert::
17261726
File containing the SSL certificate when fetching or pushing
1727-
over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1727+
over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
17281728
variable.
17291729

17301730
http.sslKey::
17311731
File containing the SSL private key when fetching or pushing
1732-
over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1732+
over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
17331733
variable.
17341734

17351735
http.sslCertPasswordProtected::
17361736
Enable Git's password prompt for the SSL certificate. Otherwise
17371737
OpenSSL will prompt the user, possibly many times, if the
17381738
certificate or private key is encrypted. Can be overridden by the
1739-
'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1739+
`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
17401740

17411741
http.sslCAInfo::
17421742
File containing the certificates to verify the peer with when
17431743
fetching or pushing over HTTPS. Can be overridden by the
1744-
'GIT_SSL_CAINFO' environment variable.
1744+
`GIT_SSL_CAINFO` environment variable.
17451745

17461746
http.sslCAPath::
17471747
Path containing files with the CA certificates to verify the peer
17481748
with when fetching or pushing over HTTPS. Can be overridden
1749-
by the 'GIT_SSL_CAPATH' environment variable.
1749+
by the `GIT_SSL_CAPATH` environment variable.
17501750

17511751
http.pinnedpubkey::
17521752
Public key of the https service. It may either be the filename of
@@ -1766,7 +1766,7 @@ http.sslTry::
17661766

17671767
http.maxRequests::
17681768
How many HTTP requests to launch in parallel. Can be overridden
1769-
by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1769+
by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
17701770

17711771
http.minSessions::
17721772
The number of curl sessions (counted across slots) to be kept across
@@ -1785,13 +1785,13 @@ http.postBuffer::
17851785
http.lowSpeedLimit, http.lowSpeedTime::
17861786
If the HTTP transfer speed is less than 'http.lowSpeedLimit'
17871787
for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1788-
Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1789-
'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1788+
Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1789+
`GIT_HTTP_LOW_SPEED_TIME` environment variables.
17901790

17911791
http.noEPSV::
17921792
A boolean which disables using of EPSV ftp command by curl.
17931793
This can helpful with some "poor" ftp servers which don't
1794-
support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1794+
support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
17951795
environment variable. Default is false (curl will use EPSV).
17961796

17971797
http.userAgent::
@@ -1801,7 +1801,7 @@ http.userAgent::
18011801
such as Mozilla/4.0. This may be necessary, for instance, if
18021802
connecting through a firewall that restricts HTTP connections to a set
18031803
of common USER_AGENT strings (but not including those like git/1.7.1).
1804-
Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1804+
Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
18051805

18061806
http.<url>.*::
18071807
Any of the http.* options above can be applied selectively to some URLs.
@@ -2855,12 +2855,12 @@ url.<base>.pushInsteadOf::
28552855

28562856
user.email::
28572857
Your email address to be recorded in any newly created commits.
2858-
Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2858+
Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
28592859
'EMAIL' environment variables. See linkgit:git-commit-tree[1].
28602860

28612861
user.name::
28622862
Your full name to be recorded in any newly created commits.
2863-
Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2863+
Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
28642864
environment variables. See linkgit:git-commit-tree[1].
28652865

28662866
user.useConfigOnly::

‎Documentation/git-log.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ mailmap.*::
201201

202202
notes.displayRef::
203203
Which refs, in addition to the default set by `core.notesRef`
204-
or 'GIT_NOTES_REF', to read notes from when showing commit
204+
or `GIT_NOTES_REF`, to read notes from when showing commit
205205
messages with the `log` family of commands. See
206206
linkgit:git-notes[1].
207207
+
@@ -210,7 +210,7 @@ multiple times. A warning will be issued for refs that do not exist,
210210
but a glob that does not match any refs is silently ignored.
211211
+
212212
This setting can be disabled by the `--no-notes` option,
213-
overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
213+
overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,
214214
and overridden by the `--notes=<ref>` option.
215215

216216
GIT

‎Documentation/git-notes.txt‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ OPTIONS
161161

162162
--ref <ref>::
163163
Manipulate the notes tree in <ref>. This overrides
164-
'GIT_NOTES_REF' and the "core.notesRef" configuration. The ref
164+
`GIT_NOTES_REF` and the "core.notesRef" configuration. The ref
165165
specifies the full refname when it begins with `refs/notes/`; when it
166166
begins with `notes/`, `refs/` and otherwise `refs/notes/` is prefixed
167167
to form a full name of the ref.
@@ -333,10 +333,10 @@ notes.<name>.mergeStrategy::
333333
notes.displayRef::
334334
Which ref (or refs, if a glob or specified more than once), in
335335
addition to the default set by `core.notesRef` or
336-
'GIT_NOTES_REF', to read notes from when showing commit
336+
`GIT_NOTES_REF`, to read notes from when showing commit
337337
messages with the 'git log' family of commands.
338338
This setting can be overridden on the command line or by the
339-
'GIT_NOTES_DISPLAY_REF' environment variable.
339+
`GIT_NOTES_DISPLAY_REF` environment variable.
340340
See linkgit:git-log[1].
341341

342342
notes.rewrite.<command>::
@@ -345,7 +345,7 @@ notes.rewrite.<command>::
345345
notes from the original to the rewritten commit. Defaults to
346346
`true`. See also "`notes.rewriteRef`" below.
347347
+
348-
This setting can be overridden by the 'GIT_NOTES_REWRITE_REF'
348+
This setting can be overridden by the `GIT_NOTES_REWRITE_REF`
349349
environment variable.
350350

351351
notes.rewriteMode::
@@ -366,33 +366,33 @@ notes.rewriteRef::
366366
Does not have a default value; you must configure this variable to
367367
enable note rewriting.
368368
+
369-
Can be overridden with the 'GIT_NOTES_REWRITE_REF' environment variable.
369+
Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable.
370370

371371

372372
ENVIRONMENT
373373
-----------
374374

375-
'GIT_NOTES_REF'::
375+
`GIT_NOTES_REF`::
376376
Which ref to manipulate notes from, instead of `refs/notes/commits`.
377377
This overrides the `core.notesRef` setting.
378378

379-
'GIT_NOTES_DISPLAY_REF'::
379+
`GIT_NOTES_DISPLAY_REF`::
380380
Colon-delimited list of refs or globs indicating which refs,
381381
in addition to the default from `core.notesRef` or
382-
'GIT_NOTES_REF', to read notes from when showing commit
382+
`GIT_NOTES_REF`, to read notes from when showing commit
383383
messages.
384384
This overrides the `notes.displayRef` setting.
385385
+
386386
A warning will be issued for refs that do not exist, but a glob that
387387
does not match any refs is silently ignored.
388388

389-
'GIT_NOTES_REWRITE_MODE'::
389+
`GIT_NOTES_REWRITE_MODE`::
390390
When copying notes during a rewrite, what to do if the target
391391
commit already has a note.
392392
Must be one of `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
393393
This overrides the `core.rewriteMode` setting.
394394

395-
'GIT_NOTES_REWRITE_REF'::
395+
`GIT_NOTES_REWRITE_REF`::
396396
When rewriting commits, which notes to copy from the original
397397
to the rewritten commit. Must be a colon-delimited list of
398398
refs or globs.

‎Documentation/git-p4.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ General options
166166
All commands except clone accept these options.
167167

168168
--git-dir <dir>::
169-
Set the 'GIT_DIR' environment variable. See linkgit:git[1].
169+
Set the `GIT_DIR` environment variable. See linkgit:git[1].
170170

171171
-v::
172172
--verbose::

‎Documentation/git-replace.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ $ git cat-file commit foo
5151

5252
shows information about commit 'bar'.
5353

54-
The 'GIT_NO_REPLACE_OBJECTS' environment variable can be set to
54+
The `GIT_NO_REPLACE_OBJECTS` environment variable can be set to
5555
achieve the same effect as the `--no-replace-objects` option.
5656

5757
OPTIONS

0 commit comments

Comments
 (0)