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
This commit is contained in:
Junio C Hamano
commit
94c61d25da
@ -526,12 +526,19 @@ Writing Documentation:
|
||||
modifying paragraphs or option/command explanations that contain options
|
||||
or commands:
|
||||
|
||||
Literal examples (e.g. use of command-line options, command names, and
|
||||
configuration variables) are typeset in monospace, and if you can use
|
||||
`backticks around word phrases`, do so.
|
||||
Literal examples (e.g. use of command-line options, command names,
|
||||
configuration and environment variables) must be typeset in monospace (i.e.
|
||||
wrapped with backticks):
|
||||
`--pretty=oneline`
|
||||
`git rev-list`
|
||||
`remote.pushDefault`
|
||||
`GIT_DIR`
|
||||
|
||||
An environment variable must be prefixed with "$" only when referring to its
|
||||
value and not when referring to the variable itself, in this case there is
|
||||
nothing to add except the backticks:
|
||||
`GIT_DIR` is specified
|
||||
`$GIT_DIR/hooks/pre-receive`
|
||||
|
||||
Word phrases enclosed in `backtick characters` are rendered literally
|
||||
and will not be further expanded. The use of `backticks` to achieve the
|
||||
|
||||
@ -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).
|
||||
+
|
||||
@ -478,9 +478,9 @@ false), while all other repositories are assumed to be bare (bare
|
||||
|
||||
core.worktree::
|
||||
Set the path to the root of the working tree.
|
||||
If GIT_COMMON_DIR environment variable is set, core.worktree
|
||||
If `GIT_COMMON_DIR` environment variable is set, core.worktree
|
||||
is ignored and not used for determining the root of working tree.
|
||||
This can be overridden by the GIT_WORK_TREE environment
|
||||
This can be overridden by the `GIT_WORK_TREE` environment
|
||||
variable and the '--work-tree' command-line option.
|
||||
The value can be an absolute path or relative to the path to
|
||||
the .git directory, which is either specified by --git-dir
|
||||
@ -545,7 +545,7 @@ core.compression::
|
||||
-1 is the zlib default. 0 means no compression,
|
||||
and 1..9 are various speed/size tradeoffs, 9 being slowest.
|
||||
If set, this provides a default to other compression variables,
|
||||
such as 'core.looseCompression' and 'pack.compression'.
|
||||
such as `core.looseCompression` and `pack.compression`.
|
||||
|
||||
core.looseCompression::
|
||||
An integer -1..9, indicating the compression level for objects that
|
||||
@ -619,9 +619,9 @@ 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
|
||||
`SSH_ASKPASS` environment variable or, failing that, a simple password
|
||||
prompt. The external program shall be given a suitable prompt as
|
||||
command-line argument and write the password on its STDOUT.
|
||||
|
||||
@ -764,7 +764,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
|
||||
@ -800,7 +800,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::
|
||||
@ -1435,18 +1435,18 @@ gitcvs.usecrlfattr::
|
||||
treat it as text. If they suppress text conversion, the file
|
||||
will be set with '-kb' mode, which suppresses any newline munging
|
||||
the client might otherwise do. If the attributes do not allow
|
||||
the file type to be determined, then 'gitcvs.allBinary' is
|
||||
the file type to be determined, then `gitcvs.allBinary` is
|
||||
used. See linkgit:gitattributes[5].
|
||||
|
||||
gitcvs.allBinary::
|
||||
This is used if 'gitcvs.usecrlfattr' does not resolve
|
||||
This is used if `gitcvs.usecrlfattr` does not resolve
|
||||
the correct '-kb' mode to use. If true, all
|
||||
unresolved files are sent to the client in
|
||||
mode '-kb'. This causes the client to treat them
|
||||
as binary files, which suppresses any newline munging it
|
||||
otherwise might do. Alternatively, if it is set to "guess",
|
||||
then the contents of the file are examined to decide if
|
||||
it is binary, similar to 'core.autocrlf'.
|
||||
it is binary, similar to `core.autocrlf`.
|
||||
|
||||
gitcvs.dbName::
|
||||
Database used by git-cvsserver to cache revision information
|
||||
@ -1465,7 +1465,7 @@ gitcvs.dbDriver::
|
||||
See linkgit:git-cvsserver[1].
|
||||
|
||||
gitcvs.dbUser, gitcvs.dbPass::
|
||||
Database user and password. Only useful if setting 'gitcvs.dbDriver',
|
||||
Database user and password. Only useful if setting `gitcvs.dbDriver`,
|
||||
since SQLite has no concept of database users and/or passwords.
|
||||
'gitcvs.dbUser' supports variable substitution (see
|
||||
linkgit:git-cvsserver[1] for details).
|
||||
@ -1477,8 +1477,8 @@ gitcvs.dbTableNamePrefix::
|
||||
linkgit:git-cvsserver[1] for details). Any non-alphabetic
|
||||
characters will be replaced with underscores.
|
||||
|
||||
All gitcvs variables except for 'gitcvs.usecrlfattr' and
|
||||
'gitcvs.allBinary' can also be specified as
|
||||
All gitcvs variables except for `gitcvs.usecrlfattr` and
|
||||
`gitcvs.allBinary` can also be specified as
|
||||
'gitcvs.<access_method>.<varname>' (where 'access_method'
|
||||
is one of "ext" and "pserver") to make them apply only for the given
|
||||
access method.
|
||||
@ -1511,7 +1511,7 @@ grep.patternType::
|
||||
|
||||
grep.extendedRegexp::
|
||||
If set to true, enable '--extended-regexp' option by default. This
|
||||
option is ignored when the 'grep.patternType' option is set to a value
|
||||
option is ignored when the `grep.patternType` option is set to a value
|
||||
other than 'default'.
|
||||
|
||||
grep.threads::
|
||||
@ -1596,7 +1596,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).
|
||||
|
||||
@ -1617,7 +1617,7 @@ guitool.<name>.confirm::
|
||||
|
||||
guitool.<name>.argPrompt::
|
||||
Request a string argument from the user, and pass it to the tool
|
||||
through the 'ARGS' environment variable. Since requesting an
|
||||
through the `ARGS` environment variable. Since requesting an
|
||||
argument implies confirmation, the 'confirm' option has no effect
|
||||
if this is enabled. If the option is set to 'true', 'yes', or '1',
|
||||
the dialog uses a built-in generic prompt; otherwise the exact
|
||||
@ -1625,7 +1625,7 @@ guitool.<name>.argPrompt::
|
||||
|
||||
guitool.<name>.revPrompt::
|
||||
Request a single valid revision from the user, and set the
|
||||
'REVISION' environment variable. In other aspects this option
|
||||
`REVISION` environment variable. In other aspects this option
|
||||
is similar to 'argPrompt', and can be used together with it.
|
||||
|
||||
guitool.<name>.revUnmerged::
|
||||
@ -1681,7 +1681,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:
|
||||
+
|
||||
--
|
||||
@ -1740,9 +1740,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::
|
||||
@ -1753,41 +1753,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
|
||||
@ -1807,7 +1807,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
|
||||
@ -1826,13 +1826,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::
|
||||
@ -1842,7 +1842,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.
|
||||
@ -2639,7 +2639,7 @@ sendemail.identity::
|
||||
A configuration identity. When given, causes values in the
|
||||
'sendemail.<identity>' subsection to take precedence over
|
||||
values in the 'sendemail' section. The default identity is
|
||||
the value of 'sendemail.identity'.
|
||||
the value of `sendemail.identity`.
|
||||
|
||||
sendemail.smtpEncryption::
|
||||
See linkgit:git-send-email[1] for description. Note that this
|
||||
@ -2656,7 +2656,7 @@ sendemail.<identity>.*::
|
||||
Identity-specific versions of the 'sendemail.*' parameters
|
||||
found below, taking precedence over those when the this
|
||||
identity is selected, through command-line or
|
||||
'sendemail.identity'.
|
||||
`sendemail.identity`.
|
||||
|
||||
sendemail.aliasesFile::
|
||||
sendemail.aliasFileType::
|
||||
@ -2686,7 +2686,7 @@ sendemail.xmailer::
|
||||
See linkgit:git-send-email[1] for description.
|
||||
|
||||
sendemail.signedoffcc (deprecated)::
|
||||
Deprecated alias for 'sendemail.signedoffbycc'.
|
||||
Deprecated alias for `sendemail.signedoffbycc`.
|
||||
|
||||
showbranch.default::
|
||||
The default set of branches for linkgit:git-show-branch[1].
|
||||
@ -2918,17 +2918,17 @@ 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
|
||||
'EMAIL' environment variables. See linkgit:git-commit-tree[1].
|
||||
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::
|
||||
Instruct Git to avoid trying to guess defaults for 'user.email'
|
||||
and 'user.name', and instead retrieve the values only from the
|
||||
Instruct Git to avoid trying to guess defaults for `user.email`
|
||||
and `user.name`, and instead retrieve the values only from the
|
||||
configuration. For example, if you have multiple email addresses
|
||||
and would like to use a different one for each repository, then
|
||||
with this configuration option set to `true` in the global config
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
DATE FORMATS
|
||||
------------
|
||||
|
||||
The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables
|
||||
The `GIT_AUTHOR_DATE`, `GIT_COMMITTER_DATE` environment variables
|
||||
ifdef::git-commit[]
|
||||
and the `--date` option
|
||||
endif::git-commit[]
|
||||
|
||||
@ -75,7 +75,7 @@ diff.ignoreSubmodules::
|
||||
commands such as 'git diff-files'. 'git checkout' also honors
|
||||
this setting when reporting uncommitted changes. Setting it to
|
||||
'all' disables the submodule summary normally shown by 'git commit'
|
||||
and 'git status' when 'status.submoduleSummary' is set unless it is
|
||||
and 'git status' when `status.submoduleSummary` is set unless it is
|
||||
overridden by using the --ignore-submodules command-line option.
|
||||
The 'git submodule' commands are not affected by this setting.
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ with a '-p' option, "git diff" without the '--raw' option, or
|
||||
"git log" with the "-p" option, they
|
||||
do not produce the output described above; instead they produce a
|
||||
patch file. You can customize the creation of such patches via the
|
||||
GIT_EXTERNAL_DIFF and the GIT_DIFF_OPTS environment variables.
|
||||
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables.
|
||||
|
||||
What the -p option produces is slightly different from the traditional
|
||||
diff format:
|
||||
|
||||
@ -366,7 +366,7 @@ skip" to do the same thing. (In fact the special exit code 125 makes
|
||||
|
||||
Or if you want more control, you can inspect the current state using
|
||||
for example "git bisect visualize". It will launch gitk (or "git log"
|
||||
if the DISPLAY environment variable is not set) to help you find a
|
||||
if the `DISPLAY` environment variable is not set) to help you find a
|
||||
better bisection point.
|
||||
|
||||
Either way, if you have a string of untestable commits, it might
|
||||
|
||||
@ -205,7 +205,7 @@ $ git bisect visualize
|
||||
|
||||
`view` may also be used as a synonym for `visualize`.
|
||||
|
||||
If the 'DISPLAY' environment variable is not set, 'git log' is used
|
||||
If the `DISPLAY` environment variable is not set, 'git log' is used
|
||||
instead. You can also give command-line options such as `-p` and
|
||||
`--stat`.
|
||||
|
||||
|
||||
@ -201,7 +201,7 @@ default::
|
||||
Otherwise `whitespace`.
|
||||
--
|
||||
+
|
||||
The default can be changed by the 'commit.cleanup' configuration
|
||||
The default can be changed by the `commit.cleanup` configuration
|
||||
variable (see linkgit:git-config[1]).
|
||||
|
||||
-e::
|
||||
@ -450,8 +450,8 @@ include::i18n.txt[]
|
||||
ENVIRONMENT AND CONFIGURATION VARIABLES
|
||||
---------------------------------------
|
||||
The editor used to edit the commit log message will be chosen from the
|
||||
GIT_EDITOR environment variable, the core.editor configuration variable, the
|
||||
VISUAL environment variable, or the EDITOR environment variable (in that
|
||||
`GIT_EDITOR` environment variable, the core.editor configuration variable, the
|
||||
`VISUAL` environment variable, or the `EDITOR` environment variable (in that
|
||||
order). See linkgit:git-var[1] for details.
|
||||
|
||||
HOOKS
|
||||
|
||||
@ -269,7 +269,7 @@ and '--unset'. *'git config' will only ever change one file at a time*.
|
||||
|
||||
You can override these rules either by command-line options or by environment
|
||||
variables. The '--global' and the '--system' options will limit the file used
|
||||
to the global or system-wide file respectively. The GIT_CONFIG environment
|
||||
to the global or system-wide file respectively. The `GIT_CONFIG` environment
|
||||
variable has a similar effect, but you can specify any filename you want.
|
||||
|
||||
|
||||
|
||||
@ -188,7 +188,7 @@ Git configuration files in that directory are readable by `<user>`.
|
||||
arguments. The external command can decide to decline the
|
||||
service by exiting with a non-zero status (or to allow it by
|
||||
exiting with a zero status). It can also look at the $REMOTE_ADDR
|
||||
and $REMOTE_PORT environment variables to learn about the
|
||||
and `$REMOTE_PORT` environment variables to learn about the
|
||||
requestor when making this decision.
|
||||
+
|
||||
The external command can optionally write a single line to its
|
||||
|
||||
@ -61,7 +61,7 @@ Filters
|
||||
The filters are applied in the order as listed below. The <command>
|
||||
argument is always evaluated in the shell context using the 'eval' command
|
||||
(with the notable exception of the commit filter, for technical reasons).
|
||||
Prior to that, the $GIT_COMMIT environment variable will be set to contain
|
||||
Prior to that, the `$GIT_COMMIT` environment variable will be set to contain
|
||||
the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
|
||||
GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
|
||||
and GIT_COMMITTER_DATE are taken from the current commit and exported to
|
||||
|
||||
@ -58,7 +58,7 @@ output, unless the `--stdout` option is specified.
|
||||
|
||||
If `-o` is specified, output files are created in <dir>. Otherwise
|
||||
they are created in the current working directory. The default path
|
||||
can be set with the 'format.outputDirectory' configuration option.
|
||||
can be set with the `format.outputDirectory` configuration option.
|
||||
The `-o` option takes precedence over `format.outputDirectory`.
|
||||
To store patches in the current working directory even when
|
||||
`format.outputDirectory` points elsewhere, use `-o .`.
|
||||
@ -146,9 +146,9 @@ series, where the head is chosen from the cover letter, the
|
||||
`--in-reply-to`, and the first patch mail, in this order. 'deep'
|
||||
threading makes every mail a reply to the previous one.
|
||||
+
|
||||
The default is `--no-thread`, unless the 'format.thread' configuration
|
||||
The default is `--no-thread`, unless the `format.thread` configuration
|
||||
is set. If `--thread` is specified without a style, it defaults to the
|
||||
style specified by 'format.thread' if any, or else `shallow`.
|
||||
style specified by `format.thread` if any, or else `shallow`.
|
||||
+
|
||||
Beware that the default for 'git send-email' is to thread emails
|
||||
itself. If you want `git format-patch` to take care of threading, you
|
||||
|
||||
@ -82,13 +82,13 @@ automatic consolidation of packs.
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
The optional configuration variable 'gc.reflogExpire' can be
|
||||
The optional configuration variable `gc.reflogExpire` can be
|
||||
set to indicate how long historical entries within each branch's
|
||||
reflog should remain available in this repository. The setting is
|
||||
expressed as a length of time, for example '90 days' or '3 months'.
|
||||
It defaults to '90 days'.
|
||||
|
||||
The optional configuration variable 'gc.reflogExpireUnreachable'
|
||||
The optional configuration variable `gc.reflogExpireUnreachable`
|
||||
can be set to indicate how long historical reflog entries which
|
||||
are not part of the current branch should remain available in
|
||||
this repository. These types of entries are generally created as
|
||||
@ -107,30 +107,30 @@ branches:
|
||||
reflogExpireUnreachable = 3 days
|
||||
------------
|
||||
|
||||
The optional configuration variable 'gc.rerereResolved' indicates
|
||||
The optional configuration variable `gc.rerereResolved` indicates
|
||||
how long records of conflicted merge you resolved earlier are
|
||||
kept. This defaults to 60 days.
|
||||
|
||||
The optional configuration variable 'gc.rerereUnresolved' indicates
|
||||
The optional configuration variable `gc.rerereUnresolved` indicates
|
||||
how long records of conflicted merge you have not resolved are
|
||||
kept. This defaults to 15 days.
|
||||
|
||||
The optional configuration variable 'gc.packRefs' determines if
|
||||
The optional configuration variable `gc.packRefs` determines if
|
||||
'git gc' runs 'git pack-refs'. This can be set to "notbare" to enable
|
||||
it within all non-bare repos or it can be set to a boolean value.
|
||||
This defaults to true.
|
||||
|
||||
The optional configuration variable 'gc.aggressiveWindow' controls how
|
||||
The optional configuration variable `gc.aggressiveWindow` controls how
|
||||
much time is spent optimizing the delta compression of the objects in
|
||||
the repository when the --aggressive option is specified. The larger
|
||||
the value, the more time is spent optimizing the delta compression. See
|
||||
the documentation for the --window' option in linkgit:git-repack[1] for
|
||||
more details. This defaults to 250.
|
||||
|
||||
Similarly, the optional configuration variable 'gc.aggressiveDepth'
|
||||
Similarly, the optional configuration variable `gc.aggressiveDepth`
|
||||
controls --depth option in linkgit:git-repack[1]. This defaults to 250.
|
||||
|
||||
The optional configuration variable 'gc.pruneExpire' controls how old
|
||||
The optional configuration variable `gc.pruneExpire` controls how old
|
||||
the unreferenced loose objects have to be before they are pruned. The
|
||||
default is "2 weeks ago".
|
||||
|
||||
|
||||
@ -51,7 +51,7 @@ grep.patternType::
|
||||
|
||||
grep.extendedRegexp::
|
||||
If set to true, enable '--extended-regexp' option by default. This
|
||||
option is ignored when the 'grep.patternType' option is set to a value
|
||||
option is ignored when the `grep.patternType` option is set to a value
|
||||
other than 'default'.
|
||||
|
||||
grep.threads::
|
||||
|
||||
@ -57,10 +57,10 @@ OPTIONS
|
||||
--man::
|
||||
Display manual page for the command in the 'man' format. This
|
||||
option may be used to override a value set in the
|
||||
'help.format' configuration variable.
|
||||
`help.format` configuration variable.
|
||||
+
|
||||
By default the 'man' program will be used to display the manual page,
|
||||
but the 'man.viewer' configuration variable may be used to choose
|
||||
but the `man.viewer` configuration variable may be used to choose
|
||||
other display programs (see below).
|
||||
|
||||
-w::
|
||||
@ -69,7 +69,7 @@ other display programs (see below).
|
||||
format. A web browser will be used for that purpose.
|
||||
+
|
||||
The web browser can be specified using the configuration variable
|
||||
'help.browser', or 'web.browser' if the former is not set. If none of
|
||||
`help.browser`, or `web.browser` if the former is not set. If none of
|
||||
these config variables is set, the 'git web{litdd}browse' helper script
|
||||
(called by 'git help') will pick a suitable default. See
|
||||
linkgit:git-web{litdd}browse[1] for more information about this.
|
||||
@ -80,7 +80,7 @@ CONFIGURATION VARIABLES
|
||||
help.format
|
||||
~~~~~~~~~~~
|
||||
|
||||
If no command-line option is passed, the 'help.format' configuration
|
||||
If no command-line option is passed, the `help.format` configuration
|
||||
variable will be checked. The following values are supported for this
|
||||
variable; they make 'git help' behave as their corresponding command-
|
||||
line option:
|
||||
@ -92,7 +92,7 @@ line option:
|
||||
help.browser, web.browser and browser.<tool>.path
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also
|
||||
The `help.browser`, `web.browser` and `browser.<tool>.path` will also
|
||||
be checked if the 'web' format is chosen (either by command-line
|
||||
option or configuration variable). See '-w|--web' in the OPTIONS
|
||||
section above and linkgit:git-web{litdd}browse[1].
|
||||
@ -100,7 +100,7 @@ section above and linkgit:git-web{litdd}browse[1].
|
||||
man.viewer
|
||||
~~~~~~~~~~
|
||||
|
||||
The 'man.viewer' configuration variable will be checked if the 'man'
|
||||
The `man.viewer` configuration variable will be checked if the 'man'
|
||||
format is chosen. The following values are currently supported:
|
||||
|
||||
* "man": use the 'man' program as usual,
|
||||
@ -110,9 +110,9 @@ format is chosen. The following values are currently supported:
|
||||
tab (see 'Note about konqueror' below).
|
||||
|
||||
Values for other tools can be used if there is a corresponding
|
||||
'man.<tool>.cmd' configuration entry (see below).
|
||||
`man.<tool>.cmd` configuration entry (see below).
|
||||
|
||||
Multiple values may be given to the 'man.viewer' configuration
|
||||
Multiple values may be given to the `man.viewer` configuration
|
||||
variable. Their corresponding programs will be tried in the order
|
||||
listed in the configuration file.
|
||||
|
||||
@ -128,14 +128,14 @@ will try to use konqueror first. But this may fail (for example, if
|
||||
DISPLAY is not set) and in that case emacs' woman mode will be tried.
|
||||
|
||||
If everything fails, or if no viewer is configured, the viewer specified
|
||||
in the GIT_MAN_VIEWER environment variable will be tried. If that
|
||||
in the `GIT_MAN_VIEWER` environment variable will be tried. If that
|
||||
fails too, the 'man' program will be tried anyway.
|
||||
|
||||
man.<tool>.path
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
You can explicitly provide a full path to your preferred man viewer by
|
||||
setting the configuration variable 'man.<tool>.path'. For example, you
|
||||
setting the configuration variable `man.<tool>.path`. For example, you
|
||||
can configure the absolute path to konqueror by setting
|
||||
'man.konqueror.path'. Otherwise, 'git help' assumes the tool is
|
||||
available in PATH.
|
||||
@ -143,9 +143,9 @@ available in PATH.
|
||||
man.<tool>.cmd
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
When the man viewer, specified by the 'man.viewer' configuration
|
||||
When the man viewer, specified by the `man.viewer` configuration
|
||||
variables, is not among the supported ones, then the corresponding
|
||||
'man.<tool>.cmd' configuration variable will be looked up. If this
|
||||
`man.<tool>.cmd` configuration variable will be looked up. If this
|
||||
variable exists then the specified tool will be treated as a custom
|
||||
command and a shell eval will be used to run the command with the man
|
||||
page passed as arguments.
|
||||
@ -153,7 +153,7 @@ page passed as arguments.
|
||||
Note about konqueror
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
When 'konqueror' is specified in the 'man.viewer' configuration
|
||||
When 'konqueror' is specified in the `man.viewer` configuration
|
||||
variable, we launch 'kfmclient' to try to open the man page on an
|
||||
already opened konqueror in a new tab if possible.
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ pushing using the smart HTTP protocol.
|
||||
It verifies that the directory has the magic file
|
||||
"git-daemon-export-ok", and it will refuse to export any Git directory
|
||||
that hasn't explicitly been marked for export this way (unless the
|
||||
GIT_HTTP_EXPORT_ALL environmental variable is set).
|
||||
`GIT_HTTP_EXPORT_ALL` environmental variable is set).
|
||||
|
||||
By default, only the `upload-pack` service is enabled, which serves
|
||||
'git fetch-pack' and 'git ls-remote' clients, which are invoked from
|
||||
@ -241,7 +241,7 @@ $HTTP["url"] =~ "^/git/private" {
|
||||
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
'git http-backend' relies upon the CGI environment variables set
|
||||
'git http-backend' relies upon the `CGI` environment variables set
|
||||
by the invoking web server, including:
|
||||
|
||||
* PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
|
||||
@ -251,7 +251,7 @@ by the invoking web server, including:
|
||||
* QUERY_STRING
|
||||
* REQUEST_METHOD
|
||||
|
||||
The GIT_HTTP_EXPORT_ALL environmental variable may be passed to
|
||||
The `GIT_HTTP_EXPORT_ALL` environmental variable may be passed to
|
||||
'git-http-backend' to bypass the check for the "git-daemon-export-ok"
|
||||
file in each repository before allowing export of that repository.
|
||||
|
||||
@ -269,7 +269,7 @@ GIT_COMMITTER_EMAIL to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}',
|
||||
ensuring that any reflogs created by 'git-receive-pack' contain some
|
||||
identifying information of the remote user who performed the push.
|
||||
|
||||
All CGI environment variables are available to each of the hooks
|
||||
All `CGI` environment variables are available to each of the hooks
|
||||
invoked by the 'git-receive-pack'.
|
||||
|
||||
GIT
|
||||
|
||||
@ -47,7 +47,7 @@ Only print error and warning messages; all other output will be suppressed.
|
||||
|
||||
--bare::
|
||||
|
||||
Create a bare repository. If GIT_DIR environment is not set, it is set to the
|
||||
Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
|
||||
current working directory.
|
||||
|
||||
--template=<template_directory>::
|
||||
|
||||
@ -80,8 +80,8 @@ You may specify configuration in your .git/config
|
||||
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
If the configuration variable 'instaweb.browser' is not set,
|
||||
'web.browser' will be used instead if it is defined. See
|
||||
If the configuration variable `instaweb.browser` is not set,
|
||||
`web.browser` will be used instead if it is defined. See
|
||||
linkgit:git-web{litdd}browse[1] for more information about this.
|
||||
|
||||
SEE ALSO
|
||||
|
||||
@ -203,7 +203,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].
|
||||
+
|
||||
@ -212,7 +212,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
|
||||
|
||||
@ -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.
|
||||
@ -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>::
|
||||
@ -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::
|
||||
@ -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.
|
||||
|
||||
@ -134,7 +134,7 @@ Submit
|
||||
~~~~~~
|
||||
Submitting changes from a Git repository back to the p4 repository
|
||||
requires a separate p4 client workspace. This should be specified
|
||||
using the 'P4CLIENT' environment variable or the Git configuration
|
||||
using the `P4CLIENT` environment variable or the Git configuration
|
||||
variable 'git-p4.client'. The p4 client must exist, but the client root
|
||||
will be created and populated if it does not already exist.
|
||||
|
||||
@ -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::
|
||||
|
||||
@ -137,8 +137,8 @@ already exists on the remote side.
|
||||
and also push annotated tags in `refs/tags` that are missing
|
||||
from the remote but are pointing at commit-ish that are
|
||||
reachable from the refs being pushed. This can also be specified
|
||||
with configuration variable 'push.followTags'. For more
|
||||
information, see 'push.followTags' in linkgit:git-config[1].
|
||||
with configuration variable `push.followTags`. For more
|
||||
information, see `push.followTags` in linkgit:git-config[1].
|
||||
|
||||
--[no-]signed::
|
||||
--sign=(true|false|if-asked)::
|
||||
@ -240,7 +240,7 @@ origin +master` to force a push to the `master` branch). See the
|
||||
For every branch that is up to date or successfully pushed, add
|
||||
upstream (tracking) reference, used by argument-less
|
||||
linkgit:git-pull[1] and other commands. For more information,
|
||||
see 'branch.<name>.merge' in linkgit:git-config[1].
|
||||
see `branch.<name>.merge` in linkgit:git-config[1].
|
||||
|
||||
--[no-]thin::
|
||||
These options are passed to linkgit:git-send-pack[1]. A thin transfer
|
||||
|
||||
@ -46,14 +46,14 @@ OPTIONS
|
||||
The directory to find the quilt patches.
|
||||
+
|
||||
The default for the patch directory is patches
|
||||
or the value of the $QUILT_PATCHES environment
|
||||
or the value of the `$QUILT_PATCHES` environment
|
||||
variable.
|
||||
|
||||
--series <file>::
|
||||
The quilt series file.
|
||||
+
|
||||
The default for the series file is <patches>/series
|
||||
or the value of the $QUILT_SERIES environment
|
||||
or the value of the `$QUILT_SERIES` environment
|
||||
variable.
|
||||
|
||||
GIT
|
||||
|
||||
@ -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
|
||||
|
||||
@ -47,18 +47,18 @@ Composing
|
||||
|
||||
--annotate::
|
||||
Review and edit each patch you're about to send. Default is the value
|
||||
of 'sendemail.annotate'. See the CONFIGURATION section for
|
||||
'sendemail.multiEdit'.
|
||||
of `sendemail.annotate`. See the CONFIGURATION section for
|
||||
`sendemail.multiEdit`.
|
||||
|
||||
--bcc=<address>,...::
|
||||
Specify a "Bcc:" value for each email. Default is the value of
|
||||
'sendemail.bcc'.
|
||||
`sendemail.bcc`.
|
||||
+
|
||||
This option may be specified multiple times.
|
||||
|
||||
--cc=<address>,...::
|
||||
Specify a starting "Cc:" value for each email.
|
||||
Default is the value of 'sendemail.cc'.
|
||||
Default is the value of `sendemail.cc`.
|
||||
+
|
||||
This option may be specified multiple times.
|
||||
|
||||
@ -74,12 +74,12 @@ and In-Reply-To headers will be used unless they are removed.
|
||||
+
|
||||
Missing From or In-Reply-To headers will be prompted for.
|
||||
+
|
||||
See the CONFIGURATION section for 'sendemail.multiEdit'.
|
||||
See the CONFIGURATION section for `sendemail.multiEdit`.
|
||||
|
||||
--from=<address>::
|
||||
Specify the sender of the emails. If not specified on the command line,
|
||||
the value of the 'sendemail.from' configuration option is used. If
|
||||
neither the command-line option nor 'sendemail.from' are set, then the
|
||||
the value of the `sendemail.from` configuration option is used. If
|
||||
neither the command-line option nor `sendemail.from` are set, then the
|
||||
user will be prompted for the value. The default for the prompt will be
|
||||
the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
|
||||
set, as returned by "git var -l".
|
||||
@ -114,7 +114,7 @@ is not set, this will be prompted for.
|
||||
--to=<address>,...::
|
||||
Specify the primary recipient of the emails generated. Generally, this
|
||||
will be the upstream maintainer of the project involved. Default is the
|
||||
value of the 'sendemail.to' configuration value; if that is unspecified,
|
||||
value of the `sendemail.to` configuration value; if that is unspecified,
|
||||
and --to-cmd is not specified, this will be prompted for.
|
||||
+
|
||||
This option may be specified multiple times.
|
||||
@ -138,7 +138,7 @@ Note that no attempts whatsoever are made to validate the encoding.
|
||||
can be useful when the repository contains files that contain carriage
|
||||
returns, but makes the raw patch email file (as saved from a MUA) much
|
||||
harder to inspect manually. base64 is even more fool proof, but also
|
||||
even more opaque. Default is the value of the 'sendemail.transferEncoding'
|
||||
even more opaque. Default is the value of the `sendemail.transferEncoding`
|
||||
configuration value; if that is unspecified, git will use 8bit and not
|
||||
add a Content-Transfer-Encoding header.
|
||||
|
||||
@ -157,20 +157,20 @@ Sending
|
||||
subscribed to a list. In order to use the 'From' address, set the
|
||||
value to "auto". If you use the sendmail binary, you must have
|
||||
suitable privileges for the -f parameter. Default is the value of the
|
||||
'sendemail.envelopeSender' configuration variable; if that is
|
||||
`sendemail.envelopeSender` configuration variable; if that is
|
||||
unspecified, choosing the envelope sender is left to your MTA.
|
||||
|
||||
--smtp-encryption=<encryption>::
|
||||
Specify the encryption to use, either 'ssl' or 'tls'. Any other
|
||||
value reverts to plain SMTP. Default is the value of
|
||||
'sendemail.smtpEncryption'.
|
||||
`sendemail.smtpEncryption`.
|
||||
|
||||
--smtp-domain=<FQDN>::
|
||||
Specifies the Fully Qualified Domain Name (FQDN) used in the
|
||||
HELO/EHLO command to the SMTP server. Some servers require the
|
||||
FQDN to match your IP address. If not set, git send-email attempts
|
||||
to determine your FQDN automatically. Default is the value of
|
||||
'sendemail.smtpDomain'.
|
||||
`sendemail.smtpDomain`.
|
||||
|
||||
--smtp-auth=<mechanisms>::
|
||||
Whitespace-separated list of allowed SMTP-AUTH mechanisms. This setting
|
||||
@ -188,13 +188,13 @@ is specified, all mechanisms supported by the SASL library can be used.
|
||||
--smtp-pass[=<password>]::
|
||||
Password for SMTP-AUTH. The argument is optional: If no
|
||||
argument is specified, then the empty string is used as
|
||||
the password. Default is the value of 'sendemail.smtpPass',
|
||||
the password. Default is the value of `sendemail.smtpPass`,
|
||||
however '--smtp-pass' always overrides this value.
|
||||
+
|
||||
Furthermore, passwords need not be specified in configuration files
|
||||
or on the command line. If a username has been specified (with
|
||||
'--smtp-user' or a 'sendemail.smtpUser'), but no password has been
|
||||
specified (with '--smtp-pass' or 'sendemail.smtpPass'), then
|
||||
'--smtp-user' or a `sendemail.smtpUser`), but no password has been
|
||||
specified (with '--smtp-pass' or `sendemail.smtpPass`), then
|
||||
a password is obtained using 'git-credential'.
|
||||
|
||||
--smtp-server=<host>::
|
||||
@ -202,7 +202,7 @@ a password is obtained using 'git-credential'.
|
||||
`smtp.example.com` or a raw IP address). Alternatively it can
|
||||
specify a full pathname of a sendmail-like program instead;
|
||||
the program must support the `-i` option. Default value can
|
||||
be specified by the 'sendemail.smtpServer' configuration
|
||||
be specified by the `sendemail.smtpServer` configuration
|
||||
option; the built-in default is `/usr/sbin/sendmail` or
|
||||
`/usr/lib/sendmail` if such program is available, or
|
||||
`localhost` otherwise.
|
||||
@ -213,11 +213,11 @@ a password is obtained using 'git-credential'.
|
||||
submission port 587, or the common SSL smtp port 465);
|
||||
symbolic port names (e.g. "submission" instead of 587)
|
||||
are also accepted. The port can also be set with the
|
||||
'sendemail.smtpServerPort' configuration variable.
|
||||
`sendemail.smtpServerPort` configuration variable.
|
||||
|
||||
--smtp-server-option=<option>::
|
||||
If set, specifies the outgoing SMTP server option to use.
|
||||
Default value can be specified by the 'sendemail.smtpServerOption'
|
||||
Default value can be specified by the `sendemail.smtpServerOption`
|
||||
configuration option.
|
||||
+
|
||||
The --smtp-server-option option must be repeated for each option you want
|
||||
@ -234,13 +234,13 @@ must be used for each option.
|
||||
certificates concatenated together: see verify(1) -CAfile and
|
||||
-CApath for more information on these). Set it to an empty string
|
||||
to disable certificate verification. Defaults to the value of the
|
||||
'sendemail.smtpsslcertpath' configuration variable, if set, or the
|
||||
`sendemail.smtpsslcertpath` configuration variable, if set, or the
|
||||
backing SSL library's compiled-in default otherwise (which should
|
||||
be the best choice on most platforms).
|
||||
|
||||
--smtp-user=<user>::
|
||||
Username for SMTP-AUTH. Default is the value of 'sendemail.smtpUser';
|
||||
if a username is not specified (with '--smtp-user' or 'sendemail.smtpUser'),
|
||||
Username for SMTP-AUTH. Default is the value of `sendemail.smtpUser`;
|
||||
if a username is not specified (with '--smtp-user' or `sendemail.smtpUser`),
|
||||
then authentication is not attempted.
|
||||
|
||||
--smtp-debug=0|1::
|
||||
@ -261,25 +261,25 @@ Automating
|
||||
Specify a command to execute once per patch file which
|
||||
should generate patch file specific "Cc:" entries.
|
||||
Output of this command must be single email address per line.
|
||||
Default is the value of 'sendemail.ccCmd' configuration value.
|
||||
Default is the value of `sendemail.ccCmd` configuration value.
|
||||
|
||||
--[no-]chain-reply-to::
|
||||
If this is set, each email will be sent as a reply to the previous
|
||||
email sent. If disabled with "--no-chain-reply-to", all emails after
|
||||
the first will be sent as replies to the first email sent. When using
|
||||
this, it is recommended that the first file given be an overview of the
|
||||
entire patch series. Disabled by default, but the 'sendemail.chainReplyTo'
|
||||
entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
|
||||
configuration variable can be used to enable it.
|
||||
|
||||
--identity=<identity>::
|
||||
A configuration identity. When given, causes values in the
|
||||
'sendemail.<identity>' subsection to take precedence over
|
||||
values in the 'sendemail' section. The default identity is
|
||||
the value of 'sendemail.identity'.
|
||||
the value of `sendemail.identity`.
|
||||
|
||||
--[no-]signed-off-by-cc::
|
||||
If this is set, add emails found in Signed-off-by: or Cc: lines to the
|
||||
cc list. Default is the value of 'sendemail.signedoffbycc' configuration
|
||||
cc list. Default is the value of `sendemail.signedoffbycc` configuration
|
||||
value; if that is unspecified, default to --signed-off-by-cc.
|
||||
|
||||
--[no-]cc-cover::
|
||||
@ -312,13 +312,13 @@ Automating
|
||||
- 'all' will suppress all auto cc values.
|
||||
--
|
||||
+
|
||||
Default is the value of 'sendemail.suppresscc' configuration value; if
|
||||
Default is the value of `sendemail.suppresscc` configuration value; if
|
||||
that is unspecified, default to 'self' if --suppress-from is
|
||||
specified, as well as 'body' if --no-signed-off-cc is specified.
|
||||
|
||||
--[no-]suppress-from::
|
||||
If this is set, do not add the From: address to the cc: list.
|
||||
Default is the value of 'sendemail.suppressFrom' configuration
|
||||
Default is the value of `sendemail.suppressFrom` configuration
|
||||
value; if that is unspecified, default to --no-suppress-from.
|
||||
|
||||
--[no-]thread::
|
||||
@ -330,7 +330,7 @@ specified, as well as 'body' if --no-signed-off-cc is specified.
|
||||
+
|
||||
If disabled with "--no-thread", those headers will not be added
|
||||
(unless specified with --in-reply-to). Default is the value of the
|
||||
'sendemail.thread' configuration value; if that is unspecified,
|
||||
`sendemail.thread` configuration value; if that is unspecified,
|
||||
default to --thread.
|
||||
+
|
||||
It is up to the user to ensure that no In-Reply-To header already
|
||||
@ -355,7 +355,7 @@ Administering
|
||||
- 'auto' is equivalent to 'cc' + 'compose'
|
||||
--
|
||||
+
|
||||
Default is the value of 'sendemail.confirm' configuration value; if that
|
||||
Default is the value of `sendemail.confirm` configuration value; if that
|
||||
is unspecified, default to 'auto' unless any of the suppress options
|
||||
have been specified, in which case default to 'compose'.
|
||||
|
||||
@ -381,7 +381,7 @@ have been specified, in which case default to 'compose'.
|
||||
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
|
||||
--
|
||||
+
|
||||
Default is the value of 'sendemail.validate'; if this is not set,
|
||||
Default is the value of `sendemail.validate`; if this is not set,
|
||||
default to '--validate'.
|
||||
|
||||
--force::
|
||||
@ -403,7 +403,7 @@ CONFIGURATION
|
||||
|
||||
sendemail.aliasesFile::
|
||||
To avoid typing long email addresses, point this to one or more
|
||||
email aliases files. You must also supply 'sendemail.aliasFileType'.
|
||||
email aliases files. You must also supply `sendemail.aliasFileType`.
|
||||
|
||||
sendemail.aliasFileType::
|
||||
Format of the file(s) specified in sendemail.aliasesFile. Must be
|
||||
|
||||
@ -41,7 +41,7 @@ usage::
|
||||
die with the usage message.
|
||||
|
||||
set_reflog_action::
|
||||
Set GIT_REFLOG_ACTION environment to a given string (typically
|
||||
Set `GIT_REFLOG_ACTION` environment to a given string (typically
|
||||
the name of the program) unless it is already set. Whenever
|
||||
the script runs a `git` command that updates refs, a reflog
|
||||
entry is created using the value of this string to leave the
|
||||
|
||||
@ -748,7 +748,7 @@ svn-remote.<name>.rewriteUUID::
|
||||
|
||||
svn-remote.<name>.pushurl::
|
||||
|
||||
Similar to Git's 'remote.<name>.pushurl', this key is designed
|
||||
Similar to Git's `remote.<name>.pushurl`, this key is designed
|
||||
to be used in cases where 'url' points to an SVN repository
|
||||
via a read-only transport, to provide an alternate read/write
|
||||
transport. It is assumed that both keys point to the same
|
||||
|
||||
@ -104,7 +104,7 @@ OPTIONS
|
||||
order can also be affected by the
|
||||
"versionsort.prereleaseSuffix" configuration variable.
|
||||
The keys supported are the same as those in `git for-each-ref`.
|
||||
Sort order defaults to the value configured for the 'tag.sort'
|
||||
Sort order defaults to the value configured for the `tag.sort`
|
||||
variable if it exists, or lexicographic order otherwise. See
|
||||
linkgit:git-config[1].
|
||||
|
||||
|
||||
@ -62,14 +62,14 @@ CONF.VAR (from -c option) and web.browser
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The web browser can be specified using a configuration variable passed
|
||||
with the -c (or --config) command-line option, or the 'web.browser'
|
||||
with the -c (or --config) command-line option, or the `web.browser`
|
||||
configuration variable if the former is not used.
|
||||
|
||||
browser.<tool>.path
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can explicitly provide a full path to your preferred browser by
|
||||
setting the configuration variable 'browser.<tool>.path'. For example,
|
||||
setting the configuration variable `browser.<tool>.path`. For example,
|
||||
you can configure the absolute path to firefox by setting
|
||||
'browser.firefox.path'. Otherwise, 'git web{litdd}browse' assumes the tool
|
||||
is available in PATH.
|
||||
@ -79,7 +79,7 @@ browser.<tool>.cmd
|
||||
|
||||
When the browser, specified by options or configuration variables, is
|
||||
not among the supported ones, then the corresponding
|
||||
'browser.<tool>.cmd' configuration variable will be looked up. If this
|
||||
`browser.<tool>.cmd` configuration variable will be looked up. If this
|
||||
variable exists then 'git web{litdd}browse' will treat the specified tool
|
||||
as a custom command and will use a shell eval to run the command with
|
||||
the URLs passed as arguments.
|
||||
|
||||
@ -577,7 +577,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string.
|
||||
|
||||
--git-dir=<path>::
|
||||
Set the path to the repository. This can also be controlled by
|
||||
setting the GIT_DIR environment variable. It can be an absolute
|
||||
setting the `GIT_DIR` environment variable. It can be an absolute
|
||||
path or relative path to current working directory.
|
||||
|
||||
--work-tree=<path>::
|
||||
@ -827,46 +827,46 @@ These environment variables apply to 'all' core Git commands. Nb: it
|
||||
is worth noting that they may be used/overridden by SCMS sitting above
|
||||
Git so take care if using a foreign front-end.
|
||||
|
||||
'GIT_INDEX_FILE'::
|
||||
`GIT_INDEX_FILE`::
|
||||
This environment allows the specification of an alternate
|
||||
index file. If not specified, the default of `$GIT_DIR/index`
|
||||
is used.
|
||||
|
||||
'GIT_INDEX_VERSION'::
|
||||
`GIT_INDEX_VERSION`::
|
||||
This environment variable allows the specification of an index
|
||||
version for new repositories. It won't affect existing index
|
||||
files. By default index file version 2 or 3 is used. See
|
||||
linkgit:git-update-index[1] for more information.
|
||||
|
||||
'GIT_OBJECT_DIRECTORY'::
|
||||
`GIT_OBJECT_DIRECTORY`::
|
||||
If the object storage directory is specified via this
|
||||
environment variable then the sha1 directories are created
|
||||
underneath - otherwise the default `$GIT_DIR/objects`
|
||||
directory is used.
|
||||
|
||||
'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
|
||||
`GIT_ALTERNATE_OBJECT_DIRECTORIES`::
|
||||
Due to the immutable nature of Git objects, old objects can be
|
||||
archived into shared, read-only directories. This variable
|
||||
specifies a ":" separated (on Windows ";" separated) list
|
||||
of Git object directories which can be used to search for Git
|
||||
objects. New objects will not be written to these directories.
|
||||
|
||||
'GIT_DIR'::
|
||||
If the 'GIT_DIR' environment variable is set then it
|
||||
`GIT_DIR`::
|
||||
If the `GIT_DIR` environment variable is set then it
|
||||
specifies a path to use instead of the default `.git`
|
||||
for the base of the repository.
|
||||
The '--git-dir' command-line option also sets this value.
|
||||
|
||||
'GIT_WORK_TREE'::
|
||||
`GIT_WORK_TREE`::
|
||||
Set the path to the root of the working tree.
|
||||
This can also be controlled by the '--work-tree' command-line
|
||||
option and the core.worktree configuration variable.
|
||||
|
||||
'GIT_NAMESPACE'::
|
||||
`GIT_NAMESPACE`::
|
||||
Set the Git namespace; see linkgit:gitnamespaces[7] for details.
|
||||
The '--namespace' command-line option also sets this value.
|
||||
|
||||
'GIT_CEILING_DIRECTORIES'::
|
||||
`GIT_CEILING_DIRECTORIES`::
|
||||
This should be a colon-separated list of absolute paths. If
|
||||
set, it is a list of directories that Git should not chdir up
|
||||
into while looking for a repository directory (useful for
|
||||
@ -879,19 +879,19 @@ Git so take care if using a foreign front-end.
|
||||
can add an empty entry to the list to tell Git that the
|
||||
subsequent entries are not symlinks and needn't be resolved;
|
||||
e.g.,
|
||||
'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
|
||||
`GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
|
||||
|
||||
'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
|
||||
`GIT_DISCOVERY_ACROSS_FILESYSTEM`::
|
||||
When run in a directory that does not have ".git" repository
|
||||
directory, Git tries to find such a directory in the parent
|
||||
directories to find the top of the working tree, but by default it
|
||||
does not cross filesystem boundaries. This environment variable
|
||||
can be set to true to tell Git not to stop at filesystem
|
||||
boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
|
||||
an explicit repository directory set via 'GIT_DIR' or on the
|
||||
boundaries. Like `GIT_CEILING_DIRECTORIES`, this will not affect
|
||||
an explicit repository directory set via `GIT_DIR` or on the
|
||||
command line.
|
||||
|
||||
'GIT_COMMON_DIR'::
|
||||
`GIT_COMMON_DIR`::
|
||||
If this variable is set to a path, non-worktree files that are
|
||||
normally in $GIT_DIR will be taken from this path
|
||||
instead. Worktree-specific files such as HEAD or index are
|
||||
@ -902,28 +902,28 @@ Git so take care if using a foreign front-end.
|
||||
|
||||
Git Commits
|
||||
~~~~~~~~~~~
|
||||
'GIT_AUTHOR_NAME'::
|
||||
'GIT_AUTHOR_EMAIL'::
|
||||
'GIT_AUTHOR_DATE'::
|
||||
'GIT_COMMITTER_NAME'::
|
||||
'GIT_COMMITTER_EMAIL'::
|
||||
'GIT_COMMITTER_DATE'::
|
||||
`GIT_AUTHOR_NAME`::
|
||||
`GIT_AUTHOR_EMAIL`::
|
||||
`GIT_AUTHOR_DATE`::
|
||||
`GIT_COMMITTER_NAME`::
|
||||
`GIT_COMMITTER_EMAIL`::
|
||||
`GIT_COMMITTER_DATE`::
|
||||
'EMAIL'::
|
||||
see linkgit:git-commit-tree[1]
|
||||
|
||||
Git Diffs
|
||||
~~~~~~~~~
|
||||
'GIT_DIFF_OPTS'::
|
||||
`GIT_DIFF_OPTS`::
|
||||
Only valid setting is "--unified=??" or "-u??" to set the
|
||||
number of context lines shown when a unified diff is created.
|
||||
This takes precedence over any "-U" or "--unified" option
|
||||
value passed on the Git diff command line.
|
||||
|
||||
'GIT_EXTERNAL_DIFF'::
|
||||
When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
|
||||
`GIT_EXTERNAL_DIFF`::
|
||||
When the environment variable `GIT_EXTERNAL_DIFF` is set, the
|
||||
program named by it is called, instead of the diff invocation
|
||||
described above. For a path that is added, removed, or modified,
|
||||
'GIT_EXTERNAL_DIFF' is called with 7 parameters:
|
||||
`GIT_EXTERNAL_DIFF` is called with 7 parameters:
|
||||
|
||||
path old-file old-hex old-mode new-file new-hex new-mode
|
||||
+
|
||||
@ -937,42 +937,42 @@ where:
|
||||
The file parameters can point at the user's working file
|
||||
(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
|
||||
when a new file is added), or a temporary file (e.g. `old-file` in the
|
||||
index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
|
||||
temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
|
||||
index). `GIT_EXTERNAL_DIFF` should not worry about unlinking the
|
||||
temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
|
||||
+
|
||||
For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
|
||||
For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
|
||||
parameter, <path>.
|
||||
+
|
||||
For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
|
||||
'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
|
||||
For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
|
||||
`GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
|
||||
|
||||
'GIT_DIFF_PATH_COUNTER'::
|
||||
`GIT_DIFF_PATH_COUNTER`::
|
||||
A 1-based counter incremented by one for every path.
|
||||
|
||||
'GIT_DIFF_PATH_TOTAL'::
|
||||
`GIT_DIFF_PATH_TOTAL`::
|
||||
The total number of paths.
|
||||
|
||||
other
|
||||
~~~~~
|
||||
'GIT_MERGE_VERBOSITY'::
|
||||
`GIT_MERGE_VERBOSITY`::
|
||||
A number controlling the amount of output shown by
|
||||
the recursive merge strategy. Overrides merge.verbosity.
|
||||
See linkgit:git-merge[1]
|
||||
|
||||
'GIT_PAGER'::
|
||||
`GIT_PAGER`::
|
||||
This environment variable overrides `$PAGER`. If it is set
|
||||
to an empty string or to the value "cat", Git will not launch
|
||||
a pager. See also the `core.pager` option in
|
||||
linkgit:git-config[1].
|
||||
|
||||
'GIT_EDITOR'::
|
||||
`GIT_EDITOR`::
|
||||
This environment variable overrides `$EDITOR` and `$VISUAL`.
|
||||
It is used by several Git commands when, on interactive mode,
|
||||
an editor is to be launched. See also linkgit:git-var[1]
|
||||
and the `core.editor` option in linkgit:git-config[1].
|
||||
|
||||
'GIT_SSH'::
|
||||
'GIT_SSH_COMMAND'::
|
||||
`GIT_SSH`::
|
||||
`GIT_SSH_COMMAND`::
|
||||
If either of these environment variables is set then 'git fetch'
|
||||
and 'git push' will use the specified command instead of 'ssh'
|
||||
when they need to connect to a remote system.
|
||||
@ -992,18 +992,18 @@ Usually it is easier to configure any desired options through your
|
||||
personal `.ssh/config` file. Please consult your ssh documentation
|
||||
for further details.
|
||||
|
||||
'GIT_ASKPASS'::
|
||||
`GIT_ASKPASS`::
|
||||
If this environment variable is set, then Git commands which need to
|
||||
acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
|
||||
will call this program with a suitable prompt as command-line argument
|
||||
and read the password from its STDOUT. See also the 'core.askPass'
|
||||
and read the password from its STDOUT. See also the `core.askPass`
|
||||
option in linkgit:git-config[1].
|
||||
|
||||
'GIT_TERMINAL_PROMPT'::
|
||||
`GIT_TERMINAL_PROMPT`::
|
||||
If this environment variable is set to `0`, git will not prompt
|
||||
on the terminal (e.g., when asking for HTTP authentication).
|
||||
|
||||
'GIT_CONFIG_NOSYSTEM'::
|
||||
`GIT_CONFIG_NOSYSTEM`::
|
||||
Whether to skip reading settings from the system-wide
|
||||
`$(prefix)/etc/gitconfig` file. This environment variable can
|
||||
be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
|
||||
@ -1011,7 +1011,7 @@ for further details.
|
||||
temporarily to avoid using a buggy `/etc/gitconfig` file while
|
||||
waiting for someone with sufficient permissions to fix it.
|
||||
|
||||
'GIT_FLUSH'::
|
||||
`GIT_FLUSH`::
|
||||
If this environment variable is set to "1", then commands such
|
||||
as 'git blame' (in incremental mode), 'git rev-list', 'git log',
|
||||
'git check-attr' and 'git check-ignore' will
|
||||
@ -1022,7 +1022,7 @@ for further details.
|
||||
not set, Git will choose buffered or record-oriented flushing
|
||||
based on whether stdout appears to be redirected to a file or not.
|
||||
|
||||
'GIT_TRACE'::
|
||||
`GIT_TRACE`::
|
||||
Enables general trace messages, e.g. alias expansion, built-in
|
||||
command execution and external command execution.
|
||||
+
|
||||
@ -1043,21 +1043,21 @@ into it.
|
||||
Unsetting the variable, or setting it to empty, "0" or
|
||||
"false" (case insensitive) disables trace messages.
|
||||
|
||||
'GIT_TRACE_PACK_ACCESS'::
|
||||
`GIT_TRACE_PACK_ACCESS`::
|
||||
Enables trace messages for all accesses to any packs. For each
|
||||
access, the pack file name and an offset in the pack is
|
||||
recorded. This may be helpful for troubleshooting some
|
||||
pack-related performance problems.
|
||||
See 'GIT_TRACE' for available trace output options.
|
||||
See `GIT_TRACE` for available trace output options.
|
||||
|
||||
'GIT_TRACE_PACKET'::
|
||||
`GIT_TRACE_PACKET`::
|
||||
Enables trace messages for all packets coming in or out of a
|
||||
given program. This can help with debugging object negotiation
|
||||
or other protocol issues. Tracing is turned off at a packet
|
||||
starting with "PACK" (but see 'GIT_TRACE_PACKFILE' below).
|
||||
See 'GIT_TRACE' for available trace output options.
|
||||
starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
|
||||
See `GIT_TRACE` for available trace output options.
|
||||
|
||||
'GIT_TRACE_PACKFILE'::
|
||||
`GIT_TRACE_PACKFILE`::
|
||||
Enables tracing of packfiles sent or received by a
|
||||
given program. Unlike other trace output, this trace is
|
||||
verbatim: no headers, and no quoting of binary data. You almost
|
||||
@ -1068,22 +1068,22 @@ Unsetting the variable, or setting it to empty, "0" or
|
||||
Note that this is currently only implemented for the client side
|
||||
of clones and fetches.
|
||||
|
||||
'GIT_TRACE_PERFORMANCE'::
|
||||
`GIT_TRACE_PERFORMANCE`::
|
||||
Enables performance related trace messages, e.g. total execution
|
||||
time of each Git command.
|
||||
See 'GIT_TRACE' for available trace output options.
|
||||
See `GIT_TRACE` for available trace output options.
|
||||
|
||||
'GIT_TRACE_SETUP'::
|
||||
`GIT_TRACE_SETUP`::
|
||||
Enables trace messages printing the .git, working tree and current
|
||||
working directory after Git has completed its setup phase.
|
||||
See 'GIT_TRACE' for available trace output options.
|
||||
See `GIT_TRACE` for available trace output options.
|
||||
|
||||
'GIT_TRACE_SHALLOW'::
|
||||
`GIT_TRACE_SHALLOW`::
|
||||
Enables trace messages that can help debugging fetching /
|
||||
cloning of shallow repositories.
|
||||
See 'GIT_TRACE' for available trace output options.
|
||||
See `GIT_TRACE` for available trace output options.
|
||||
|
||||
'GIT_LITERAL_PATHSPECS'::
|
||||
`GIT_LITERAL_PATHSPECS`::
|
||||
Setting this variable to `1` will cause Git to treat all
|
||||
pathspecs literally, rather than as glob patterns. For example,
|
||||
running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
|
||||
@ -1092,19 +1092,19 @@ of clones and fetches.
|
||||
literal paths to Git (e.g., paths previously given to you by
|
||||
`git ls-tree`, `--raw` diff output, etc).
|
||||
|
||||
'GIT_GLOB_PATHSPECS'::
|
||||
`GIT_GLOB_PATHSPECS`::
|
||||
Setting this variable to `1` will cause Git to treat all
|
||||
pathspecs as glob patterns (aka "glob" magic).
|
||||
|
||||
'GIT_NOGLOB_PATHSPECS'::
|
||||
`GIT_NOGLOB_PATHSPECS`::
|
||||
Setting this variable to `1` will cause Git to treat all
|
||||
pathspecs as literal (aka "literal" magic).
|
||||
|
||||
'GIT_ICASE_PATHSPECS'::
|
||||
`GIT_ICASE_PATHSPECS`::
|
||||
Setting this variable to `1` will cause Git to treat all
|
||||
pathspecs as case-insensitive.
|
||||
|
||||
'GIT_REFLOG_ACTION'::
|
||||
`GIT_REFLOG_ACTION`::
|
||||
When a ref is updated, reflog entries are created to keep
|
||||
track of the reason why the ref was updated (which is
|
||||
typically the name of the high-level command that updated
|
||||
@ -1114,7 +1114,7 @@ of clones and fetches.
|
||||
variable when it is invoked as the top level command by the
|
||||
end user, to be recorded in the body of the reflog.
|
||||
|
||||
'GIT_REF_PARANOIA'::
|
||||
`GIT_REF_PARANOIA`::
|
||||
If set to `1`, include broken or badly named refs when iterating
|
||||
over lists of refs. In a normal, non-corrupted repository, this
|
||||
does nothing. However, enabling it may help git to detect and
|
||||
@ -1125,7 +1125,7 @@ of clones and fetches.
|
||||
an operation has touched every ref (e.g., because you are
|
||||
cloning a repository to make a backup).
|
||||
|
||||
'GIT_ALLOW_PROTOCOL'::
|
||||
`GIT_ALLOW_PROTOCOL`::
|
||||
If set, provide a colon-separated list of protocols which are
|
||||
allowed to be used with fetch/push/clone. This is useful to
|
||||
restrict recursive submodule initialization from an untrusted
|
||||
|
||||
@ -38,7 +38,7 @@ precedence, the last matching pattern decides the outcome):
|
||||
* Patterns read from `$GIT_DIR/info/exclude`.
|
||||
|
||||
* Patterns read from the file specified by the configuration
|
||||
variable 'core.excludesFile'.
|
||||
variable `core.excludesFile`.
|
||||
|
||||
Which file to place a pattern in depends on how the pattern is meant to
|
||||
be used.
|
||||
|
||||
@ -43,7 +43,7 @@ arguments. The first argument specifies a remote repository as in Git;
|
||||
it is either the name of a configured remote or a URL. The second
|
||||
argument specifies a URL; it is usually of the form
|
||||
'<transport>://<address>', but any arbitrary string is possible.
|
||||
The 'GIT_DIR' environment variable is set up for the remote helper
|
||||
The `GIT_DIR` environment variable is set up for the remote helper
|
||||
and can be used to determine where to store additional data or from
|
||||
which directory to invoke auxiliary Git commands.
|
||||
|
||||
@ -61,10 +61,10 @@ argument. If such a URL is encountered directly on the command line,
|
||||
the first argument is '<address>', and if it is encountered in a
|
||||
configured remote, the first argument is the name of that remote.
|
||||
|
||||
Additionally, when a configured remote has 'remote.<name>.vcs' set to
|
||||
Additionally, when a configured remote has `remote.<name>.vcs` set to
|
||||
'<transport>', Git explicitly invokes 'git remote-<transport>' with
|
||||
'<name>' as the first argument. If set, the second argument is
|
||||
'remote.<name>.url'; otherwise, the second argument is omitted.
|
||||
`remote.<name>.url`; otherwise, the second argument is omitted.
|
||||
|
||||
INPUT FORMAT
|
||||
------------
|
||||
|
||||
@ -376,7 +376,7 @@ $site_name::
|
||||
Name of your site or organization, to appear in page titles. Set it
|
||||
to something descriptive for clearer bookmarks etc. If this variable
|
||||
is not set or is, then gitweb uses the value of the `SERVER_NAME`
|
||||
CGI environment variable, setting site name to "$SERVER_NAME Git",
|
||||
`CGI` environment variable, setting site name to "$SERVER_NAME Git",
|
||||
or "Untitled Git" if this variable is not set (e.g. if running gitweb
|
||||
as standalone script).
|
||||
+
|
||||
|
||||
@ -206,8 +206,8 @@ $export_auth_hook = sub {
|
||||
Per-repository gitweb configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
You can configure individual repositories shown in gitweb by creating file
|
||||
in the 'GIT_DIR' of Git repository, or by setting some repo configuration
|
||||
variable (in 'GIT_DIR/config', see linkgit:git-config[1]).
|
||||
in the `GIT_DIR` of Git repository, or by setting some repo configuration
|
||||
variable (in `GIT_DIR/config`, see linkgit:git-config[1]).
|
||||
|
||||
You can use the following files in repository:
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ merge.verbosity::
|
||||
message if conflicts were detected. Level 1 outputs only
|
||||
conflicts, 2 outputs conflicts and file changes. Level 5 and
|
||||
above outputs debugging information. The default is level 2.
|
||||
Can be overridden by the 'GIT_MERGE_VERBOSITY' environment variable.
|
||||
Can be overridden by the `GIT_MERGE_VERBOSITY` environment variable.
|
||||
|
||||
merge.<driver>.name::
|
||||
Defines a human-readable name for a custom low-level
|
||||
|
||||
@ -26,7 +26,7 @@ people using 80-column terminals.
|
||||
--no-abbrev-commit::
|
||||
Show the full 40-byte hexadecimal commit object name. This negates
|
||||
`--abbrev-commit` and those options which imply it such as
|
||||
"--oneline". It also overrides the 'log.abbrevCommit' variable.
|
||||
"--oneline". It also overrides the `log.abbrevCommit` variable.
|
||||
|
||||
--oneline::
|
||||
This is a shorthand for "--pretty=oneline --abbrev-commit"
|
||||
@ -65,7 +65,7 @@ ifndef::git-rev-list[]
|
||||
on the command line.
|
||||
+
|
||||
By default, the notes shown are from the notes refs listed in the
|
||||
'core.notesRef' and 'notes.displayRef' variables (or corresponding
|
||||
`core.notesRef` and `notes.displayRef` variables (or corresponding
|
||||
environment overrides). See linkgit:git-config[1] for more details.
|
||||
+
|
||||
With an optional '<treeish>' argument, use the treeish to find the notes
|
||||
|
||||
Loading…
Reference in New Issue
Block a user