Skip to content

Commit 94c61d2

Browse files
gitstergitster
committed
Merge branch 'tr/doc-tt'
The documentation set has been updated so that literal commands, configuration variables and environment variables are consistently typeset in fixed-width font and bold in manpages. * tr/doc-tt: doc: change configuration variables format doc: more consistency in environment variables format doc: change environment variables format doc: clearer rule about formatting literals
2 parents af325b0 + ae9f631 commit 94c61d2

36 files changed

+224
-217
lines changed

‎Documentation/CodingGuidelines‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -526,12 +526,19 @@ Writing Documentation:
526526
modifying paragraphs or option/command explanations that contain options
527527
or commands:
528528

529-
Literal examples (e.g. use of command-line options, command names, and
530-
configuration variables) are typeset in monospace, and if you can use
531-
`backticks around word phrases`, do so.
529+
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):
532532
`--pretty=oneline`
533533
`git rev-list`
534534
`remote.pushDefault`
535+
`GIT_DIR`
536+
537+
An environment variable must be prefixed with "$" only when referring to its
538+
value and not when referring to the variable itself, in this case there is
539+
nothing to add except the backticks:
540+
`GIT_DIR` is specified
541+
`$GIT_DIR/hooks/pre-receive`
535542

536543
Word phrases enclosed in `backtick characters` are rendered literally
537544
and will not be further expanded. The use of `backticks` to achieve the

‎Documentation/config.txt‎

Lines changed: 42 additions & 42 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
+
@@ -478,9 +478,9 @@ false), while all other repositories are assumed to be bare (bare
478478

479479
core.worktree::
480480
Set the path to the root of the working tree.
481-
If GIT_COMMON_DIR environment variable is set, core.worktree
481+
If `GIT_COMMON_DIR` environment variable is set, core.worktree
482482
is ignored and not used for determining the root of working tree.
483-
This can be overridden by the GIT_WORK_TREE environment
483+
This can be overridden by the `GIT_WORK_TREE` environment
484484
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
@@ -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
@@ -619,9 +619,9 @@ 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
624-
'SSH_ASKPASS' environment variable or, failing that, a simple password
624+
`SSH_ASKPASS` environment variable or, failing that, a simple password
625625
prompt. The external program shall be given a suitable prompt as
626626
command-line argument and write the password on its STDOUT.
627627

@@ -764,7 +764,7 @@ core.notesRef::
764764
notes should be printed.
765765
+
766766
This setting defaults to "refs/notes/commits", and it can be overridden by
767-
the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
767+
the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
768768

769769
core.sparseCheckout::
770770
Enable "sparse checkout" feature. See section "Sparse checkout" in
@@ -800,7 +800,7 @@ it will be treated as a shell command. For example, defining
800800
"gitk --all --not ORIG_HEAD". Note that shell commands will be
801801
executed from the top-level directory of a repository, which may
802802
not necessarily be the current directory.
803-
'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
803+
`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
804804
from the original current directory. See linkgit:git-rev-parse[1].
805805

806806
am.keepcr::
@@ -1435,18 +1435,18 @@ gitcvs.usecrlfattr::
14351435
treat it as text. If they suppress text conversion, the file
14361436
will be set with '-kb' mode, which suppresses any newline munging
14371437
the client might otherwise do. If the attributes do not allow
1438-
the file type to be determined, then 'gitcvs.allBinary' is
1438+
the file type to be determined, then `gitcvs.allBinary` is
14391439
used. See linkgit:gitattributes[5].
14401440

14411441
gitcvs.allBinary::
1442-
This is used if 'gitcvs.usecrlfattr' does not resolve
1442+
This is used if `gitcvs.usecrlfattr` does not resolve
14431443
the correct '-kb' mode to use. If true, all
14441444
unresolved files are sent to the client in
14451445
mode '-kb'. This causes the client to treat them
14461446
as binary files, which suppresses any newline munging it
14471447
otherwise might do. Alternatively, if it is set to "guess",
14481448
then the contents of the file are examined to decide if
1449-
it is binary, similar to 'core.autocrlf'.
1449+
it is binary, similar to `core.autocrlf`.
14501450

14511451
gitcvs.dbName::
14521452
Database used by git-cvsserver to cache revision information
@@ -1465,7 +1465,7 @@ gitcvs.dbDriver::
14651465
See linkgit:git-cvsserver[1].
14661466

14671467
gitcvs.dbUser, gitcvs.dbPass::
1468-
Database user and password. Only useful if setting 'gitcvs.dbDriver',
1468+
Database user and password. Only useful if setting `gitcvs.dbDriver`,
14691469
since SQLite has no concept of database users and/or passwords.
14701470
'gitcvs.dbUser' supports variable substitution (see
14711471
linkgit:git-cvsserver[1] for details).
@@ -1477,8 +1477,8 @@ gitcvs.dbTableNamePrefix::
14771477
linkgit:git-cvsserver[1] for details). Any non-alphabetic
14781478
characters will be replaced with underscores.
14791479

1480-
All gitcvs variables except for 'gitcvs.usecrlfattr' and
1481-
'gitcvs.allBinary' can also be specified as
1480+
All gitcvs variables except for `gitcvs.usecrlfattr` and
1481+
`gitcvs.allBinary` can also be specified as
14821482
'gitcvs.<access_method>.<varname>' (where 'access_method'
14831483
is one of "ext" and "pserver") to make them apply only for the given
14841484
access method.
@@ -1511,7 +1511,7 @@ grep.patternType::
15111511

15121512
grep.extendedRegexp::
15131513
If set to true, enable '--extended-regexp' option by default. This
1514-
option is ignored when the 'grep.patternType' option is set to a value
1514+
option is ignored when the `grep.patternType` option is set to a value
15151515
other than 'default'.
15161516

15171517
grep.threads::
@@ -1596,7 +1596,7 @@ guitool.<name>.cmd::
15961596
of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
15971597
mandatory for every tool. The command is executed from the root of
15981598
the working directory, and in the environment it receives the name of
1599-
the tool as 'GIT_GUITOOL', the name of the currently selected file as
1599+
the tool as `GIT_GUITOOL`, the name of the currently selected file as
16001600
'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
16011601
the head is detached, 'CUR_BRANCH' is empty).
16021602

@@ -1617,15 +1617,15 @@ guitool.<name>.confirm::
16171617

16181618
guitool.<name>.argPrompt::
16191619
Request a string argument from the user, and pass it to the tool
1620-
through the 'ARGS' environment variable. Since requesting an
1620+
through the `ARGS` environment variable. Since requesting an
16211621
argument implies confirmation, the 'confirm' option has no effect
16221622
if this is enabled. If the option is set to 'true', 'yes', or '1',
16231623
the dialog uses a built-in generic prompt; otherwise the exact
16241624
value of the variable is used.
16251625

16261626
guitool.<name>.revPrompt::
16271627
Request a single valid revision from the user, and set the
1628-
'REVISION' environment variable. In other aspects this option
1628+
`REVISION` environment variable. In other aspects this option
16291629
is similar to 'argPrompt', and can be used together with it.
16301630

16311631
guitool.<name>.revUnmerged::
@@ -1681,7 +1681,7 @@ http.proxyAuthMethod::
16811681
only takes effect if the configured proxy string contains a user name part
16821682
(i.e. is of the form 'user@host' or 'user@host:port'). This can be
16831683
overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1684-
Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1684+
Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
16851685
variable. Possible values are:
16861686
+
16871687
--
@@ -1740,9 +1740,9 @@ http.sslVersion::
17401740
- tlsv1.2
17411741

17421742
+
1743-
Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1743+
Can be overridden by the `GIT_SSL_VERSION` environment variable.
17441744
To force git to use libcurl's default ssl version and ignore any
1745-
explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1745+
explicit http.sslversion option, set `GIT_SSL_VERSION` to the
17461746
empty string.
17471747

17481748
http.sslCipherList::
@@ -1753,41 +1753,41 @@ http.sslCipherList::
17531753
option; see the libcurl documentation for more details on the format
17541754
of this list.
17551755
+
1756-
Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1756+
Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
17571757
To force git to use libcurl's default cipher list and ignore any
1758-
explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1758+
explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
17591759
empty string.
17601760

17611761
http.sslVerify::
17621762
Whether to verify the SSL certificate when fetching or pushing
1763-
over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1763+
over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
17641764
variable.
17651765

17661766
http.sslCert::
17671767
File containing the SSL certificate when fetching or pushing
1768-
over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1768+
over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
17691769
variable.
17701770

17711771
http.sslKey::
17721772
File containing the SSL private key when fetching or pushing
1773-
over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1773+
over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
17741774
variable.
17751775

17761776
http.sslCertPasswordProtected::
17771777
Enable Git's password prompt for the SSL certificate. Otherwise
17781778
OpenSSL will prompt the user, possibly many times, if the
17791779
certificate or private key is encrypted. Can be overridden by the
1780-
'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1780+
`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
17811781

17821782
http.sslCAInfo::
17831783
File containing the certificates to verify the peer with when
17841784
fetching or pushing over HTTPS. Can be overridden by the
1785-
'GIT_SSL_CAINFO' environment variable.
1785+
`GIT_SSL_CAINFO` environment variable.
17861786

17871787
http.sslCAPath::
17881788
Path containing files with the CA certificates to verify the peer
17891789
with when fetching or pushing over HTTPS. Can be overridden
1790-
by the 'GIT_SSL_CAPATH' environment variable.
1790+
by the `GIT_SSL_CAPATH` environment variable.
17911791

17921792
http.pinnedpubkey::
17931793
Public key of the https service. It may either be the filename of
@@ -1807,7 +1807,7 @@ http.sslTry::
18071807

18081808
http.maxRequests::
18091809
How many HTTP requests to launch in parallel. Can be overridden
1810-
by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1810+
by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
18111811

18121812
http.minSessions::
18131813
The number of curl sessions (counted across slots) to be kept across
@@ -1826,13 +1826,13 @@ http.postBuffer::
18261826
http.lowSpeedLimit, http.lowSpeedTime::
18271827
If the HTTP transfer speed is less than 'http.lowSpeedLimit'
18281828
for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1829-
Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1830-
'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1829+
Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1830+
`GIT_HTTP_LOW_SPEED_TIME` environment variables.
18311831

18321832
http.noEPSV::
18331833
A boolean which disables using of EPSV ftp command by curl.
18341834
This can helpful with some "poor" ftp servers which don't
1835-
support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1835+
support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
18361836
environment variable. Default is false (curl will use EPSV).
18371837

18381838
http.userAgent::
@@ -1842,7 +1842,7 @@ http.userAgent::
18421842
such as Mozilla/4.0. This may be necessary, for instance, if
18431843
connecting through a firewall that restricts HTTP connections to a set
18441844
of common USER_AGENT strings (but not including those like git/1.7.1).
1845-
Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1845+
Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
18461846

18471847
http.<url>.*::
18481848
Any of the http.* options above can be applied selectively to some URLs.
@@ -2639,7 +2639,7 @@ sendemail.identity::
26392639
A configuration identity. When given, causes values in the
26402640
'sendemail.<identity>' subsection to take precedence over
26412641
values in the 'sendemail' section. The default identity is
2642-
the value of 'sendemail.identity'.
2642+
the value of `sendemail.identity`.
26432643

26442644
sendemail.smtpEncryption::
26452645
See linkgit:git-send-email[1] for description. Note that this
@@ -2656,7 +2656,7 @@ sendemail.<identity>.*::
26562656
Identity-specific versions of the 'sendemail.*' parameters
26572657
found below, taking precedence over those when the this
26582658
identity is selected, through command-line or
2659-
'sendemail.identity'.
2659+
`sendemail.identity`.
26602660

26612661
sendemail.aliasesFile::
26622662
sendemail.aliasFileType::
@@ -2686,7 +2686,7 @@ sendemail.xmailer::
26862686
See linkgit:git-send-email[1] for description.
26872687

26882688
sendemail.signedoffcc (deprecated)::
2689-
Deprecated alias for 'sendemail.signedoffbycc'.
2689+
Deprecated alias for `sendemail.signedoffbycc`.
26902690

26912691
showbranch.default::
26922692
The default set of branches for linkgit:git-show-branch[1].
@@ -2918,17 +2918,17 @@ url.<base>.pushInsteadOf::
29182918

29192919
user.email::
29202920
Your email address to be recorded in any newly created commits.
2921-
Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2922-
'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2921+
Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
2922+
`EMAIL` environment variables. See linkgit:git-commit-tree[1].
29232923

29242924
user.name::
29252925
Your full name to be recorded in any newly created commits.
2926-
Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2926+
Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
29272927
environment variables. See linkgit:git-commit-tree[1].
29282928

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

‎Documentation/date-formats.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
DATE FORMATS
22
------------
33

4-
The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables
4+
The `GIT_AUTHOR_DATE`, `GIT_COMMITTER_DATE` environment variables
55
ifdef::git-commit[]
66
and the `--date` option
77
endif::git-commit[]

‎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/diff-generate-patch.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ 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
9-
GIT_EXTERNAL_DIFF and the GIT_DIFF_OPTS environment variables.
9+
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables.
1010

1111
What the -p option produces is slightly different from the traditional
1212
diff format:

‎Documentation/git-bisect-lk2009.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ skip" to do the same thing. (In fact the special exit code 125 makes
366366

367367
Or if you want more control, you can inspect the current state using
368368
for example "git bisect visualize". It will launch gitk (or "git log"
369-
if the DISPLAY environment variable is not set) to help you find a
369+
if the `DISPLAY` environment variable is not set) to help you find a
370370
better bisection point.
371371

372372
Either way, if you have a string of untestable commits, it might

‎Documentation/git-bisect.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ $ git bisect visualize
205205

206206
`view` may also be used as a synonym for `visualize`.
207207

208-
If the 'DISPLAY' environment variable is not set, 'git log' is used
208+
If the `DISPLAY` environment variable is not set, 'git log' is used
209209
instead. You can also give command-line options such as `-p` and
210210
`--stat`.
211211

‎Documentation/git-commit.txt‎

Lines changed: 3 additions & 3 deletions
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::
@@ -450,8 +450,8 @@ include::i18n.txt[]
450450
ENVIRONMENT AND CONFIGURATION VARIABLES
451451
---------------------------------------
452452
The editor used to edit the commit log message will be chosen from the
453-
GIT_EDITOR environment variable, the core.editor configuration variable, the
454-
VISUAL environment variable, or the EDITOR environment variable (in that
453+
`GIT_EDITOR` environment variable, the core.editor configuration variable, the
454+
`VISUAL` environment variable, or the `EDITOR` environment variable (in that
455455
order). See linkgit:git-var[1] for details.
456456

457457
HOOKS

‎Documentation/git-config.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ 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
271271
variables. The '--global' and the '--system' options will limit the file used
272-
to the global or system-wide file respectively. The GIT_CONFIG environment
272+
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

275275

‎Documentation/git-daemon.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ Git configuration files in that directory are readable by `<user>`.
188188
arguments. The external command can decide to decline the
189189
service by exiting with a non-zero status (or to allow it by
190190
exiting with a zero status). It can also look at the $REMOTE_ADDR
191-
and $REMOTE_PORT environment variables to learn about the
191+
and `$REMOTE_PORT` environment variables to learn about the
192192
requestor when making this decision.
193193
+
194194
The external command can optionally write a single line to its

0 commit comments

Comments
 (0)