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>
Tom Russello committed
Jun 8, 2016 at 00:35 UTC
eee7f4a233733b661e2e75e75a3b52312619112c
9 files changed
+101
-101
Documentation/config.txt
+23
-23
@@ -434,7 +434,7 @@ core.gitProxy::
434
may be set multiple times and is matched in the given order;
435
the first match wins.
436
+
437
-Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
437
+Can be overridden by the `GIT_PROXY_COMMAND` environment variable
438
(which always applies universally, without the special "for"
439
handling).
440
+
@@ -619,7 +619,7 @@ core.excludesFile::
619
core.askPass::
620
Some commands (e.g. svn and http interfaces) that interactively
621
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`
623
environment variable. If not set, fall back to the value of the
624
'SSH_ASKPASS' environment variable or, failing that, a simple password
625
prompt. The external program shall be given a suitable prompt as
@@ -747,7 +747,7 @@ core.notesRef::
747
notes should be printed.
748
+
749
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].
751
752
core.sparseCheckout::
753
Enable "sparse checkout" feature. See section "Sparse checkout" in
@@ -783,7 +783,7 @@ it will be treated as a shell command. For example, defining
783
"gitk --all --not ORIG_HEAD". Note that shell commands will be
784
executed from the top-level directory of a repository, which may
785
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'
787
from the original current directory. See linkgit:git-rev-parse[1].
788
789
am.keepcr::
@@ -1561,7 +1561,7 @@ guitool.<name>.cmd::
1561
of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1562
mandatory for every tool. The command is executed from the root of
1563
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
1565
'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1566
the head is detached, 'CUR_BRANCH' is empty).
1567
@@ -1646,7 +1646,7 @@ http.proxyAuthMethod::
1646
only takes effect if the configured proxy string contains a user name part
1647
(i.e. is of the form 'user@host' or 'user@host:port'). This can be
1648
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
1650
variable. Possible values are:
1651
+
1652
--
@@ -1699,9 +1699,9 @@ http.sslVersion::
1699
- tlsv1.2
1700
1701
+
1702
-Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1702
+Can be overridden by the `GIT_SSL_VERSION` environment variable.
1703
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
1705
empty string.
1706
1707
http.sslCipherList::
@@ -1712,41 +1712,41 @@ http.sslCipherList::
1712
option; see the libcurl documentation for more details on the format
1713
of this list.
1714
+
1715
-Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1715
+Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1716
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
1718
empty string.
1719
1720
http.sslVerify::
1721
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
1723
variable.
1724
1725
http.sslCert::
1726
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
1728
variable.
1729
1730
http.sslKey::
1731
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
1733
variable.
1734
1735
http.sslCertPasswordProtected::
1736
Enable Git's password prompt for the SSL certificate. Otherwise
1737
OpenSSL will prompt the user, possibly many times, if the
1738
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.
1740
1741
http.sslCAInfo::
1742
File containing the certificates to verify the peer with when
1743
fetching or pushing over HTTPS. Can be overridden by the
1744
- 'GIT_SSL_CAINFO' environment variable.
1744
+ `GIT_SSL_CAINFO` environment variable.
1745
1746
http.sslCAPath::
1747
Path containing files with the CA certificates to verify the peer
1748
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.
1750
1751
http.pinnedpubkey::
1752
Public key of the https service. It may either be the filename of
@@ -1766,7 +1766,7 @@ http.sslTry::
1766
1767
http.maxRequests::
1768
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.
1770
1771
http.minSessions::
1772
The number of curl sessions (counted across slots) to be kept across
@@ -1785,13 +1785,13 @@ http.postBuffer::
1785
http.lowSpeedLimit, http.lowSpeedTime::
1786
If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1787
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.
1790
1791
http.noEPSV::
1792
A boolean which disables using of EPSV ftp command by curl.
1793
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`
1795
environment variable. Default is false (curl will use EPSV).
1796
1797
http.userAgent::
@@ -1801,7 +1801,7 @@ http.userAgent::
1801
such as Mozilla/4.0. This may be necessary, for instance, if
1802
connecting through a firewall that restricts HTTP connections to a set
1803
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.
1805
1806
http.<url>.*::
1807
Any of the http.* options above can be applied selectively to some URLs.
@@ -2855,12 +2855,12 @@ url.<base>.pushInsteadOf::
2855
2856
user.email::
2857
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
2859
'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2860
2861
user.name::
2862
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`
2864
environment variables. See linkgit:git-commit-tree[1].
2865
2866
user.useConfigOnly::
Documentation/git-log.txt
+2
-2
@@ -201,7 +201,7 @@ mailmap.*::
201
202
notes.displayRef::
203
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
205
messages with the `log` family of commands. See
206
linkgit:git-notes[1].
207
+
@@ -210,7 +210,7 @@ multiple times. A warning will be issued for refs that do not exist,
210
but a glob that does not match any refs is silently ignored.
211
+
212
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,
214
and overridden by the `--notes=<ref>` option.
215
216
GIT
Documentation/git-notes.txt
+10
-10
@@ -161,7 +161,7 @@ OPTIONS
161
162
--ref <ref>::
163
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
165
specifies the full refname when it begins with `refs/notes/`; when it
166
begins with `notes/`, `refs/` and otherwise `refs/notes/` is prefixed
167
to form a full name of the ref.
@@ -333,10 +333,10 @@ notes.<name>.mergeStrategy::
333
notes.displayRef::
334
Which ref (or refs, if a glob or specified more than once), in
335
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
337
messages with the 'git log' family of commands.
338
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.
340
See linkgit:git-log[1].
341
342
notes.rewrite.<command>::
@@ -345,7 +345,7 @@ notes.rewrite.<command>::
345
notes from the original to the rewritten commit. Defaults to
346
`true`. See also "`notes.rewriteRef`" below.
347
+
348
-This setting can be overridden by the 'GIT_NOTES_REWRITE_REF'
348
+This setting can be overridden by the `GIT_NOTES_REWRITE_REF`
349
environment variable.
350
351
notes.rewriteMode::
@@ -366,33 +366,33 @@ notes.rewriteRef::
366
Does not have a default value; you must configure this variable to
367
enable note rewriting.
368
+
369
-Can be overridden with the 'GIT_NOTES_REWRITE_REF' environment variable.
369
+Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable.
370
371
372
ENVIRONMENT
373
-----------
374
375
-'GIT_NOTES_REF'::
375
+`GIT_NOTES_REF`::
376
Which ref to manipulate notes from, instead of `refs/notes/commits`.
377
This overrides the `core.notesRef` setting.
378
379
-'GIT_NOTES_DISPLAY_REF'::
379
+`GIT_NOTES_DISPLAY_REF`::
380
Colon-delimited list of refs or globs indicating which refs,
381
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
383
messages.
384
This overrides the `notes.displayRef` setting.
385
+
386
A warning will be issued for refs that do not exist, but a glob that
387
does not match any refs is silently ignored.
388
389
-'GIT_NOTES_REWRITE_MODE'::
389
+`GIT_NOTES_REWRITE_MODE`::
390
When copying notes during a rewrite, what to do if the target
391
commit already has a note.
392
Must be one of `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
393
This overrides the `core.rewriteMode` setting.
394
395
-'GIT_NOTES_REWRITE_REF'::
395
+`GIT_NOTES_REWRITE_REF`::
396
When rewriting commits, which notes to copy from the original
397
to the rewritten commit. Must be a colon-delimited list of
398
refs or globs.
Documentation/git-p4.txt
+1
-1
@@ -166,7 +166,7 @@ General options
166
All commands except clone accept these options.
167
168
--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].
170
171
-v::
172
--verbose::
Documentation/git-replace.txt
+1
-1
@@ -51,7 +51,7 @@ $ git cat-file commit foo
51
52
shows information about commit 'bar'.
53
54
-The 'GIT_NO_REPLACE_OBJECTS' environment variable can be set to
54
+The `GIT_NO_REPLACE_OBJECTS` environment variable can be set to
55
achieve the same effect as the `--no-replace-objects` option.
56
57
OPTIONS
Documentation/git.txt
+60
-60
@@ -822,46 +822,46 @@ These environment variables apply to 'all' core Git commands. Nb: it
822
is worth noting that they may be used/overridden by SCMS sitting above
823
Git so take care if using a foreign front-end.
824
825
-'GIT_INDEX_FILE'::
825
+`GIT_INDEX_FILE`::
826
This environment allows the specification of an alternate
827
index file. If not specified, the default of `$GIT_DIR/index`
828
is used.
829
830
-'GIT_INDEX_VERSION'::
830
+`GIT_INDEX_VERSION`::
831
This environment variable allows the specification of an index
832
version for new repositories. It won't affect existing index
833
files. By default index file version 2 or 3 is used. See
834
linkgit:git-update-index[1] for more information.
835
836
-'GIT_OBJECT_DIRECTORY'::
836
+`GIT_OBJECT_DIRECTORY`::
837
If the object storage directory is specified via this
838
environment variable then the sha1 directories are created
839
underneath - otherwise the default `$GIT_DIR/objects`
840
directory is used.
841
842
-'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
842
+`GIT_ALTERNATE_OBJECT_DIRECTORIES`::
843
Due to the immutable nature of Git objects, old objects can be
844
archived into shared, read-only directories. This variable
845
specifies a ":" separated (on Windows ";" separated) list
846
of Git object directories which can be used to search for Git
847
objects. New objects will not be written to these directories.
848
849
-'GIT_DIR'::
850
- If the 'GIT_DIR' environment variable is set then it
849
+`GIT_DIR`::
850
+ If the `GIT_DIR` environment variable is set then it
851
specifies a path to use instead of the default `.git`
852
for the base of the repository.
853
The '--git-dir' command-line option also sets this value.
854
855
-'GIT_WORK_TREE'::
855
+`GIT_WORK_TREE`::
856
Set the path to the root of the working tree.
857
This can also be controlled by the '--work-tree' command-line
858
option and the core.worktree configuration variable.
859
860
-'GIT_NAMESPACE'::
860
+`GIT_NAMESPACE`::
861
Set the Git namespace; see linkgit:gitnamespaces[7] for details.
862
The '--namespace' command-line option also sets this value.
863
864
-'GIT_CEILING_DIRECTORIES'::
864
+`GIT_CEILING_DIRECTORIES`::
865
This should be a colon-separated list of absolute paths. If
866
set, it is a list of directories that Git should not chdir up
867
into while looking for a repository directory (useful for
@@ -874,19 +874,19 @@ Git so take care if using a foreign front-end.
874
can add an empty entry to the list to tell Git that the
875
subsequent entries are not symlinks and needn't be resolved;
876
e.g.,
877
- 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
877
+ `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
878
879
-'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
879
+`GIT_DISCOVERY_ACROSS_FILESYSTEM`::
880
When run in a directory that does not have ".git" repository
881
directory, Git tries to find such a directory in the parent
882
directories to find the top of the working tree, but by default it
883
does not cross filesystem boundaries. This environment variable
884
can be set to true to tell Git not to stop at filesystem
885
- boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
886
- an explicit repository directory set via 'GIT_DIR' or on the
885
+ boundaries. Like `GIT_CEILING_DIRECTORIES`, this will not affect
886
+ an explicit repository directory set via `GIT_DIR` or on the
887
command line.
888
889
-'GIT_COMMON_DIR'::
889
+`GIT_COMMON_DIR`::
890
If this variable is set to a path, non-worktree files that are
891
normally in $GIT_DIR will be taken from this path
892
instead. Worktree-specific files such as HEAD or index are
@@ -897,28 +897,28 @@ Git so take care if using a foreign front-end.
897
898
Git Commits
899
~~~~~~~~~~~
900
-'GIT_AUTHOR_NAME'::
901
-'GIT_AUTHOR_EMAIL'::
902
-'GIT_AUTHOR_DATE'::
903
-'GIT_COMMITTER_NAME'::
904
-'GIT_COMMITTER_EMAIL'::
905
-'GIT_COMMITTER_DATE'::
900
+`GIT_AUTHOR_NAME`::
901
+`GIT_AUTHOR_EMAIL`::
902
+`GIT_AUTHOR_DATE`::
903
+`GIT_COMMITTER_NAME`::
904
+`GIT_COMMITTER_EMAIL`::
905
+`GIT_COMMITTER_DATE`::
906
'EMAIL'::
907
see linkgit:git-commit-tree[1]
908
909
Git Diffs
910
~~~~~~~~~
911
-'GIT_DIFF_OPTS'::
911
+`GIT_DIFF_OPTS`::
912
Only valid setting is "--unified=??" or "-u??" to set the
913
number of context lines shown when a unified diff is created.
914
This takes precedence over any "-U" or "--unified" option
915
value passed on the Git diff command line.
916
917
-'GIT_EXTERNAL_DIFF'::
918
- When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
917
+`GIT_EXTERNAL_DIFF`::
918
+ When the environment variable `GIT_EXTERNAL_DIFF` is set, the
919
program named by it is called, instead of the diff invocation
920
described above. For a path that is added, removed, or modified,
921
- 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
921
+ `GIT_EXTERNAL_DIFF` is called with 7 parameters:
922
923
path old-file old-hex old-mode new-file new-hex new-mode
924
+
@@ -932,42 +932,42 @@ where:
932
The file parameters can point at the user's working file
933
(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
934
when a new file is added), or a temporary file (e.g. `old-file` in the
935
-index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
936
-temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
935
+index). `GIT_EXTERNAL_DIFF` should not worry about unlinking the
936
+temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
937
+
938
-For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
938
+For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
939
parameter, <path>.
940
+
941
-For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
942
-'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
941
+For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
942
+`GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
943
944
-'GIT_DIFF_PATH_COUNTER'::
944
+`GIT_DIFF_PATH_COUNTER`::
945
A 1-based counter incremented by one for every path.
946
947
-'GIT_DIFF_PATH_TOTAL'::
947
+`GIT_DIFF_PATH_TOTAL`::
948
The total number of paths.
949
950
other
951
~~~~~
952
-'GIT_MERGE_VERBOSITY'::
952
+`GIT_MERGE_VERBOSITY`::
953
A number controlling the amount of output shown by
954
the recursive merge strategy. Overrides merge.verbosity.
955
See linkgit:git-merge[1]
956
957
-'GIT_PAGER'::
957
+`GIT_PAGER`::
958
This environment variable overrides `$PAGER`. If it is set
959
to an empty string or to the value "cat", Git will not launch
960
a pager. See also the `core.pager` option in
961
linkgit:git-config[1].
962
963
-'GIT_EDITOR'::
963
+`GIT_EDITOR`::
964
This environment variable overrides `$EDITOR` and `$VISUAL`.
965
It is used by several Git commands when, on interactive mode,
966
an editor is to be launched. See also linkgit:git-var[1]
967
and the `core.editor` option in linkgit:git-config[1].
968
969
-'GIT_SSH'::
970
-'GIT_SSH_COMMAND'::
969
+`GIT_SSH`::
970
+`GIT_SSH_COMMAND`::
971
If either of these environment variables is set then 'git fetch'
972
and 'git push' will use the specified command instead of 'ssh'
973
when they need to connect to a remote system.
@@ -987,18 +987,18 @@ Usually it is easier to configure any desired options through your
987
personal `.ssh/config` file. Please consult your ssh documentation
988
for further details.
989
990
-'GIT_ASKPASS'::
990
+`GIT_ASKPASS`::
991
If this environment variable is set, then Git commands which need to
992
acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
993
will call this program with a suitable prompt as command-line argument
994
and read the password from its STDOUT. See also the 'core.askPass'
995
option in linkgit:git-config[1].
996
997
-'GIT_TERMINAL_PROMPT'::
997
+`GIT_TERMINAL_PROMPT`::
998
If this environment variable is set to `0`, git will not prompt
999
on the terminal (e.g., when asking for HTTP authentication).
1000
1001
-'GIT_CONFIG_NOSYSTEM'::
1001
+`GIT_CONFIG_NOSYSTEM`::
1002
Whether to skip reading settings from the system-wide
1003
`$(prefix)/etc/gitconfig` file. This environment variable can
1004
be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
@@ -1006,7 +1006,7 @@ for further details.
1006
temporarily to avoid using a buggy `/etc/gitconfig` file while
1007
waiting for someone with sufficient permissions to fix it.
1008
1009
-'GIT_FLUSH'::
1009
+`GIT_FLUSH`::
1010
If this environment variable is set to "1", then commands such
1011
as 'git blame' (in incremental mode), 'git rev-list', 'git log',
1012
'git check-attr' and 'git check-ignore' will
@@ -1017,7 +1017,7 @@ for further details.
1017
not set, Git will choose buffered or record-oriented flushing
1018
based on whether stdout appears to be redirected to a file or not.
1019
1020
-'GIT_TRACE'::
1020
+`GIT_TRACE`::
1021
Enables general trace messages, e.g. alias expansion, built-in
1022
command execution and external command execution.
1023
+
@@ -1038,21 +1038,21 @@ into it.
1038
Unsetting the variable, or setting it to empty, "0" or
1039
"false" (case insensitive) disables trace messages.
1040
1041
-'GIT_TRACE_PACK_ACCESS'::
1041
+`GIT_TRACE_PACK_ACCESS`::
1042
Enables trace messages for all accesses to any packs. For each
1043
access, the pack file name and an offset in the pack is
1044
recorded. This may be helpful for troubleshooting some
1045
pack-related performance problems.
1046
- See 'GIT_TRACE' for available trace output options.
1046
+ See `GIT_TRACE` for available trace output options.
1047
1048
-'GIT_TRACE_PACKET'::
1048
+`GIT_TRACE_PACKET`::
1049
Enables trace messages for all packets coming in or out of a
1050
given program. This can help with debugging object negotiation
1051
or other protocol issues. Tracing is turned off at a packet
1052
- starting with "PACK" (but see 'GIT_TRACE_PACKFILE' below).
1053
- See 'GIT_TRACE' for available trace output options.
1052
+ starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
1053
+ See `GIT_TRACE` for available trace output options.
1054
1055
-'GIT_TRACE_PACKFILE'::
1055
+`GIT_TRACE_PACKFILE`::
1056
Enables tracing of packfiles sent or received by a
1057
given program. Unlike other trace output, this trace is
1058
verbatim: no headers, and no quoting of binary data. You almost
@@ -1063,22 +1063,22 @@ Unsetting the variable, or setting it to empty, "0" or
1063
Note that this is currently only implemented for the client side
1064
of clones and fetches.
1065
1066
-'GIT_TRACE_PERFORMANCE'::
1066
+`GIT_TRACE_PERFORMANCE`::
1067
Enables performance related trace messages, e.g. total execution
1068
time of each Git command.
1069
- See 'GIT_TRACE' for available trace output options.
1069
+ See `GIT_TRACE` for available trace output options.
1070
1071
-'GIT_TRACE_SETUP'::
1071
+`GIT_TRACE_SETUP`::
1072
Enables trace messages printing the .git, working tree and current
1073
working directory after Git has completed its setup phase.
1074
- See 'GIT_TRACE' for available trace output options.
1074
+ See `GIT_TRACE` for available trace output options.
1075
1076
-'GIT_TRACE_SHALLOW'::
1076
+`GIT_TRACE_SHALLOW`::
1077
Enables trace messages that can help debugging fetching /
1078
cloning of shallow repositories.
1079
- See 'GIT_TRACE' for available trace output options.
1079
+ See `GIT_TRACE` for available trace output options.
1080
1081
-'GIT_LITERAL_PATHSPECS'::
1081
+`GIT_LITERAL_PATHSPECS`::
1082
Setting this variable to `1` will cause Git to treat all
1083
pathspecs literally, rather than as glob patterns. For example,
1084
running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
@@ -1087,19 +1087,19 @@ of clones and fetches.
1087
literal paths to Git (e.g., paths previously given to you by
1088
`git ls-tree`, `--raw` diff output, etc).
1089
1090
-'GIT_GLOB_PATHSPECS'::
1090
+`GIT_GLOB_PATHSPECS`::
1091
Setting this variable to `1` will cause Git to treat all
1092
pathspecs as glob patterns (aka "glob" magic).
1093
1094
-'GIT_NOGLOB_PATHSPECS'::
1094
+`GIT_NOGLOB_PATHSPECS`::
1095
Setting this variable to `1` will cause Git to treat all
1096
pathspecs as literal (aka "literal" magic).
1097
1098
-'GIT_ICASE_PATHSPECS'::
1098
+`GIT_ICASE_PATHSPECS`::
1099
Setting this variable to `1` will cause Git to treat all
1100
pathspecs as case-insensitive.
1101
1102
-'GIT_REFLOG_ACTION'::
1102
+`GIT_REFLOG_ACTION`::
1103
When a ref is updated, reflog entries are created to keep
1104
track of the reason why the ref was updated (which is
1105
typically the name of the high-level command that updated
@@ -1109,7 +1109,7 @@ of clones and fetches.
1109
variable when it is invoked as the top level command by the
1110
end user, to be recorded in the body of the reflog.
1111
1112
-'GIT_REF_PARANOIA'::
1112
+`GIT_REF_PARANOIA`::
1113
If set to `1`, include broken or badly named refs when iterating
1114
over lists of refs. In a normal, non-corrupted repository, this
1115
does nothing. However, enabling it may help git to detect and
@@ -1120,7 +1120,7 @@ of clones and fetches.
1120
an operation has touched every ref (e.g., because you are
1121
cloning a repository to make a backup).
1122
1123
-'GIT_ALLOW_PROTOCOL'::
1123
+`GIT_ALLOW_PROTOCOL`::
1124
If set, provide a colon-separated list of protocols which are
1125
allowed to be used with fetch/push/clone. This is useful to
1126
restrict recursive submodule initialization from an untrusted
Documentation/gitremote-helpers.txt
+1
-1
@@ -43,7 +43,7 @@ arguments. The first argument specifies a remote repository as in Git;
43
it is either the name of a configured remote or a URL. The second
44
argument specifies a URL; it is usually of the form
45
'<transport>://<address>', but any arbitrary string is possible.
46
-The 'GIT_DIR' environment variable is set up for the remote helper
46
+The `GIT_DIR` environment variable is set up for the remote helper
47
and can be used to determine where to store additional data or from
48
which directory to invoke auxiliary Git commands.
49
Documentation/gitweb.txt
+2
-2
@@ -206,8 +206,8 @@ $export_auth_hook = sub {
206
Per-repository gitweb configuration
207
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
208
You can configure individual repositories shown in gitweb by creating file
209
-in the 'GIT_DIR' of Git repository, or by setting some repo configuration
210
-variable (in 'GIT_DIR/config', see linkgit:git-config[1]).
209
+in the `GIT_DIR` of Git repository, or by setting some repo configuration
210
+variable (in `GIT_DIR/config`, see linkgit:git-config[1]).
211
212
You can use the following files in repository:
213
Documentation/merge-config.txt
+1
-1
@@ -61,7 +61,7 @@ merge.verbosity::
61
message if conflicts were detected. Level 1 outputs only
62
conflicts, 2 outputs conflicts and file changes. Level 5 and
63
above outputs debugging information. The default is level 2.
64
- Can be overridden by the 'GIT_MERGE_VERBOSITY' environment variable.
64
+ Can be overridden by the `GIT_MERGE_VERBOSITY` environment variable.
65
66
merge.<driver>.name::
67
Defines a human-readable name for a custom low-level