Skip to content

Commit

Permalink
doc: change environment variables format
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Tom Russello authored and gitster committed Jun 8, 2016
1 parent 41f5b21 commit eee7f4a
Show file tree
Hide file tree
Showing 9 changed files with 101 additions and 101 deletions.
46 changes: 23 additions & 23 deletions Documentation/config.txt
Expand Up @@ -434,7 +434,7 @@ core.gitProxy::
may be set multiple times and is matched in the given order;
the first match wins.
+
Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
Can be overridden by the `GIT_PROXY_COMMAND` environment variable
(which always applies universally, without the special "for"
handling).
+
Expand Down Expand Up @@ -619,7 +619,7 @@ core.excludesFile::
core.askPass::
Some commands (e.g. svn and http interfaces) that interactively
ask for a password can be told to use an external program given
via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
via the value of this variable. Can be overridden by the `GIT_ASKPASS`
environment variable. If not set, fall back to the value of the
'SSH_ASKPASS' environment variable or, failing that, a simple password
prompt. The external program shall be given a suitable prompt as
Expand Down Expand Up @@ -747,7 +747,7 @@ core.notesRef::
notes should be printed.
+
This setting defaults to "refs/notes/commits", and it can be overridden by
the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].

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

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

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

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

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

http.sslVerify::
Whether to verify the SSL certificate when fetching or pushing
over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
variable.

http.sslCert::
File containing the SSL certificate when fetching or pushing
over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
variable.

http.sslKey::
File containing the SSL private key when fetching or pushing
over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
variable.

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

http.sslCAInfo::
File containing the certificates to verify the peer with when
fetching or pushing over HTTPS. Can be overridden by the
'GIT_SSL_CAINFO' environment variable.
`GIT_SSL_CAINFO` environment variable.

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

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

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

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

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

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

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

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

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

user.useConfigOnly::
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-log.txt
Expand Up @@ -201,7 +201,7 @@ mailmap.*::

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

GIT
Expand Down
20 changes: 10 additions & 10 deletions Documentation/git-notes.txt
Expand Up @@ -161,7 +161,7 @@ OPTIONS

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

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

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


ENVIRONMENT
-----------

'GIT_NOTES_REF'::
`GIT_NOTES_REF`::
Which ref to manipulate notes from, instead of `refs/notes/commits`.
This overrides the `core.notesRef` setting.

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

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

'GIT_NOTES_REWRITE_REF'::
`GIT_NOTES_REWRITE_REF`::
When rewriting commits, which notes to copy from the original
to the rewritten commit. Must be a colon-delimited list of
refs or globs.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-p4.txt
Expand Up @@ -166,7 +166,7 @@ General options
All commands except clone accept these options.

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

-v::
--verbose::
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-replace.txt
Expand Up @@ -51,7 +51,7 @@ $ git cat-file commit foo

shows information about commit 'bar'.

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

OPTIONS
Expand Down

0 comments on commit eee7f4a

Please sign in to comment.