undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: change configuration variables format

Browse Source 
This change configuration variables that where in italic style
to monospace font according to the guideline. It was obtained with

	grep '[[:alpha:]]*\.[[:alpha:]]*::$' config.txt | \
	sed -e 's/::$//' -e 's/\./\\\\./' | \
	xargs -iP perl -pi -e "s/\'P\'/\`P\`/g" ./*.txt

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>
This commit is contained in:
Tom Russello 2016-06-08 19:23:16 +02:00 committed by Junio C Hamano
parent 47d81b5c7a
commit ae9f6311e9
17 changed files with 86 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation/config.txt
View File

@ -545,7 +545,7 @@ core.compression::
-1 is the zlib default. 0 means no compression, -1 is the zlib default. 0 means no compression,
and 1..9 are various speed/size tradeoffs, 9 being slowest. and 1..9 are various speed/size tradeoffs, 9 being slowest.
If set, this provides a default to other compression variables, 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:: core.looseCompression::
An integer -1..9, indicating the compression level for objects that An integer -1..9, indicating the compression level for objects that
@ -1400,18 +1400,18 @@ gitcvs.usecrlfattr::
treat it as text. If they suppress text conversion, the file treat it as text. If they suppress text conversion, the file
will be set with '-kb' mode, which suppresses any newline munging will be set with '-kb' mode, which suppresses any newline munging
the client might otherwise do. If the attributes do not allow 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]. used. See linkgit:gitattributes[5].
gitcvs.allBinary:: 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 the correct '-kb' mode to use. If true, all
unresolved files are sent to the client in unresolved files are sent to the client in
mode '-kb'. This causes the client to treat them mode '-kb'. This causes the client to treat them
as binary files, which suppresses any newline munging it as binary files, which suppresses any newline munging it
otherwise might do. Alternatively, if it is set to "guess", otherwise might do. Alternatively, if it is set to "guess",
then the contents of the file are examined to decide if 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:: gitcvs.dbName::
Database used by git-cvsserver to cache revision information Database used by git-cvsserver to cache revision information
@ -1430,7 +1430,7 @@ gitcvs.dbDriver::
See linkgit:git-cvsserver[1]. See linkgit:git-cvsserver[1].
gitcvs.dbUser, gitcvs.dbPass:: 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. since SQLite has no concept of database users and/or passwords.
'gitcvs.dbUser' supports variable substitution (see 'gitcvs.dbUser' supports variable substitution (see
linkgit:git-cvsserver[1] for details). linkgit:git-cvsserver[1] for details).
@ -1442,8 +1442,8 @@ gitcvs.dbTableNamePrefix::
linkgit:git-cvsserver[1] for details). Any non-alphabetic linkgit:git-cvsserver[1] for details). Any non-alphabetic
characters will be replaced with underscores. characters will be replaced with underscores.
All gitcvs variables except for 'gitcvs.usecrlfattr' and All gitcvs variables except for `gitcvs.usecrlfattr` and
'gitcvs.allBinary' can also be specified as `gitcvs.allBinary` can also be specified as
'gitcvs.<access_method>.<varname>' (where 'access_method' 'gitcvs.<access_method>.<varname>' (where 'access_method'
is one of "ext" and "pserver") to make them apply only for the given is one of "ext" and "pserver") to make them apply only for the given
access method. access method.
@ -1476,7 +1476,7 @@ grep.patternType::
grep.extendedRegexp:: grep.extendedRegexp::
If set to true, enable '--extended-regexp' option by default. This 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'. other than 'default'.
grep.threads:: grep.threads::
@ -2587,7 +2587,7 @@ sendemail.identity::
A configuration identity. When given, causes values in the A configuration identity. When given, causes values in the
'sendemail.<identity>' subsection to take precedence over 'sendemail.<identity>' subsection to take precedence over
values in the 'sendemail' section. The default identity is values in the 'sendemail' section. The default identity is
the value of 'sendemail.identity'. the value of `sendemail.identity`.
sendemail.smtpEncryption:: sendemail.smtpEncryption::
See linkgit:git-send-email[1] for description. Note that this See linkgit:git-send-email[1] for description. Note that this
@ -2604,7 +2604,7 @@ sendemail.<identity>.*::
Identity-specific versions of the 'sendemail.*' parameters Identity-specific versions of the 'sendemail.*' parameters
found below, taking precedence over those when the this found below, taking precedence over those when the this
identity is selected, through command-line or identity is selected, through command-line or
'sendemail.identity'. `sendemail.identity`.
sendemail.aliasesFile:: sendemail.aliasesFile::
sendemail.aliasFileType:: sendemail.aliasFileType::
@ -2634,7 +2634,7 @@ sendemail.xmailer::
See linkgit:git-send-email[1] for description. See linkgit:git-send-email[1] for description.
sendemail.signedoffcc (deprecated):: sendemail.signedoffcc (deprecated)::
Deprecated alias for 'sendemail.signedoffbycc'. Deprecated alias for `sendemail.signedoffbycc`.
showbranch.default:: showbranch.default::
The default set of branches for linkgit:git-show-branch[1]. The default set of branches for linkgit:git-show-branch[1].
@ -2864,8 +2864,8 @@ user.name::
environment variables. See linkgit:git-commit-tree[1]. environment variables. See linkgit:git-commit-tree[1].
user.useConfigOnly:: user.useConfigOnly::
Instruct Git to avoid trying to guess defaults for 'user.email' Instruct Git to avoid trying to guess defaults for `user.email`
and 'user.name', and instead retrieve the values only from the and `user.name`, and instead retrieve the values only from the
configuration. For example, if you have multiple email addresses configuration. For example, if you have multiple email addresses
and would like to use a different one for each repository, then and would like to use a different one for each repository, then
with this configuration option set to `true` in the global config with this configuration option set to `true` in the global config

2
Documentation/diff-config.txt
View File

@ -75,7 +75,7 @@ diff.ignoreSubmodules::
commands such as 'git diff-files'. 'git checkout' also honors commands such as 'git diff-files'. 'git checkout' also honors
this setting when reporting uncommitted changes. Setting it to this setting when reporting uncommitted changes. Setting it to
'all' disables the submodule summary normally shown by 'git commit' '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. overridden by using the --ignore-submodules command-line option.
The 'git submodule' commands are not affected by this setting. The 'git submodule' commands are not affected by this setting.

2
Documentation/git-commit.txt
View File

@ -201,7 +201,7 @@ default::
Otherwise `whitespace`. 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]). variable (see linkgit:git-config[1]).
-e:: -e::

6
Documentation/git-format-patch.txt
View File

@ -58,7 +58,7 @@ output, unless the `--stdout` option is specified.
If `-o` is specified, output files are created in <dir>. Otherwise If `-o` is specified, output files are created in <dir>. Otherwise
they are created in the current working directory. The default path 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`. The `-o` option takes precedence over `format.outputDirectory`.
To store patches in the current working directory even when To store patches in the current working directory even when
`format.outputDirectory` points elsewhere, use `-o .`. `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' `--in-reply-to`, and the first patch mail, in this order. 'deep'
threading makes every mail a reply to the previous one. 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 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 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 itself. If you want `git format-patch` to take care of threading, you

16
Documentation/git-gc.txt
View File

@ -82,13 +82,13 @@ automatic consolidation of packs.
Configuration 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 set to indicate how long historical entries within each branch's
reflog should remain available in this repository. The setting is reflog should remain available in this repository. The setting is
expressed as a length of time, for example '90 days' or '3 months'. expressed as a length of time, for example '90 days' or '3 months'.
It defaults to '90 days'. 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 can be set to indicate how long historical reflog entries which
are not part of the current branch should remain available in are not part of the current branch should remain available in
this repository. These types of entries are generally created as this repository. These types of entries are generally created as
@ -107,30 +107,30 @@ branches:
reflogExpireUnreachable = 3 days 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 how long records of conflicted merge you resolved earlier are
kept. This defaults to 60 days. 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 how long records of conflicted merge you have not resolved are
kept. This defaults to 15 days. 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 '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. it within all non-bare repos or it can be set to a boolean value.
This defaults to true. 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 much time is spent optimizing the delta compression of the objects in
the repository when the --aggressive option is specified. The larger the repository when the --aggressive option is specified. The larger
the value, the more time is spent optimizing the delta compression. See the value, the more time is spent optimizing the delta compression. See
the documentation for the --window' option in linkgit:git-repack[1] for the documentation for the --window' option in linkgit:git-repack[1] for
more details. This defaults to 250. 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. 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 the unreferenced loose objects have to be before they are pruned. The
default is "2 weeks ago". default is "2 weeks ago".

2
Documentation/git-grep.txt
View File

@ -51,7 +51,7 @@ grep.patternType::
grep.extendedRegexp:: grep.extendedRegexp::
If set to true, enable '--extended-regexp' option by default. This 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'. other than 'default'.
grep.threads:: grep.threads::

24
Documentation/git-help.txt
View File

@ -57,10 +57,10 @@ OPTIONS
--man:: --man::
Display manual page for the command in the 'man' format. This Display manual page for the command in the 'man' format. This
option may be used to override a value set in the 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, 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). other display programs (see below).
-w:: -w::
@ -69,7 +69,7 @@ other display programs (see below).
format. A web browser will be used for that purpose. format. A web browser will be used for that purpose.
+ +
The web browser can be specified using the configuration variable 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 these config variables is set, the 'git web{litdd}browse' helper script
(called by 'git help') will pick a suitable default. See (called by 'git help') will pick a suitable default. See
linkgit:git-web{litdd}browse[1] for more information about this. linkgit:git-web{litdd}browse[1] for more information about this.
@ -80,7 +80,7 @@ CONFIGURATION VARIABLES
help.format 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 will be checked. The following values are supported for this
variable; they make 'git help' behave as their corresponding command- variable; they make 'git help' behave as their corresponding command-
line option: line option:
@ -92,7 +92,7 @@ line option:
help.browser, web.browser and browser.<tool>.path 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 be checked if the 'web' format is chosen (either by command-line
option or configuration variable). See '-w|--web' in the OPTIONS option or configuration variable). See '-w|--web' in the OPTIONS
section above and linkgit:git-web{litdd}browse[1]. section above and linkgit:git-web{litdd}browse[1].
@ -100,7 +100,7 @@ section above and linkgit:git-web{litdd}browse[1].
man.viewer 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: format is chosen. The following values are currently supported:
* "man": use the 'man' program as usual, * "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). tab (see 'Note about konqueror' below).
Values for other tools can be used if there is a corresponding 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 variable. Their corresponding programs will be tried in the order
listed in the configuration file. listed in the configuration file.
@ -135,7 +135,7 @@ man.<tool>.path
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
You can explicitly provide a full path to your preferred man viewer by 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 can configure the absolute path to konqueror by setting
'man.konqueror.path'. Otherwise, 'git help' assumes the tool is 'man.konqueror.path'. Otherwise, 'git help' assumes the tool is
available in PATH. available in PATH.
@ -143,9 +143,9 @@ available in PATH.
man.<tool>.cmd 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 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 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 command and a shell eval will be used to run the command with the man
page passed as arguments. page passed as arguments.
@ -153,7 +153,7 @@ page passed as arguments.
Note about konqueror 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 variable, we launch 'kfmclient' to try to open the man page on an
already opened konqueror in a new tab if possible. already opened konqueror in a new tab if possible.

4
Documentation/git-instaweb.txt
View File

@ -80,8 +80,8 @@ You may specify configuration in your .git/config
----------------------------------------------------------------------- -----------------------------------------------------------------------
If the configuration variable 'instaweb.browser' is not set, If the configuration variable `instaweb.browser` is not set,
'web.browser' will be used instead if it is defined. See `web.browser` will be used instead if it is defined. See
linkgit:git-web{litdd}browse[1] for more information about this. linkgit:git-web{litdd}browse[1] for more information about this.
SEE ALSO SEE ALSO

6
Documentation/git-push.txt
View File

@ -137,8 +137,8 @@ already exists on the remote side.
and also push annotated tags in `refs/tags` that are missing and also push annotated tags in `refs/tags` that are missing
from the remote but are pointing at commit-ish that are from the remote but are pointing at commit-ish that are
reachable from the refs being pushed. This can also be specified reachable from the refs being pushed. This can also be specified
with configuration variable 'push.followTags'. For more with configuration variable `push.followTags`. For more
information, see 'push.followTags' in linkgit:git-config[1]. information, see `push.followTags` in linkgit:git-config[1].
--[no-]signed:: --[no-]signed::
--sign=(true|false|if-asked):: --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 For every branch that is up to date or successfully pushed, add
upstream (tracking) reference, used by argument-less upstream (tracking) reference, used by argument-less
linkgit:git-pull[1] and other commands. For more information, 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:: --[no-]thin::
These options are passed to linkgit:git-send-pack[1]. A thin transfer These options are passed to linkgit:git-send-pack[1]. A thin transfer

62
Documentation/git-send-email.txt
View File

@ -47,18 +47,18 @@ Composing
--annotate:: --annotate::
Review and edit each patch you're about to send. Default is the value Review and edit each patch you're about to send. Default is the value
of 'sendemail.annotate'. See the CONFIGURATION section for of `sendemail.annotate`. See the CONFIGURATION section for
'sendemail.multiEdit'. `sendemail.multiEdit`.
--bcc=<address>,...:: --bcc=<address>,...::
Specify a "Bcc:" value for each email. Default is the value of Specify a "Bcc:" value for each email. Default is the value of
'sendemail.bcc'. `sendemail.bcc`.
+ +
This option may be specified multiple times. This option may be specified multiple times.
--cc=<address>,...:: --cc=<address>,...::
Specify a starting "Cc:" value for each email. 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. 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. 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>:: --from=<address>::
Specify the sender of the emails. If not specified on the command line, Specify the sender of the emails. If not specified on the command line,
the value of the 'sendemail.from' configuration option is used. If the value of the `sendemail.from` configuration option is used. If
neither the command-line option nor 'sendemail.from' are set, then the 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 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 the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
set, as returned by "git var -l". set, as returned by "git var -l".
@ -114,7 +114,7 @@ is not set, this will be prompted for.
--to=<address>,...:: --to=<address>,...::
Specify the primary recipient of the emails generated. Generally, this Specify the primary recipient of the emails generated. Generally, this
will be the upstream maintainer of the project involved. Default is the 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. and --to-cmd is not specified, this will be prompted for.
+ +
This option may be specified multiple times. 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 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 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 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 configuration value; if that is unspecified, git will use 8bit and not
add a Content-Transfer-Encoding header. add a Content-Transfer-Encoding header.
@ -157,20 +157,20 @@ Sending
subscribed to a list. In order to use the 'From' address, set the 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 value to "auto". If you use the sendmail binary, you must have
suitable privileges for the -f parameter. Default is the value of the 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. unspecified, choosing the envelope sender is left to your MTA.
--smtp-encryption=<encryption>:: --smtp-encryption=<encryption>::
Specify the encryption to use, either 'ssl' or 'tls'. Any other Specify the encryption to use, either 'ssl' or 'tls'. Any other
value reverts to plain SMTP. Default is the value of value reverts to plain SMTP. Default is the value of
'sendemail.smtpEncryption'. `sendemail.smtpEncryption`.
--smtp-domain=<FQDN>:: --smtp-domain=<FQDN>::
Specifies the Fully Qualified Domain Name (FQDN) used in the Specifies the Fully Qualified Domain Name (FQDN) used in the
HELO/EHLO command to the SMTP server. Some servers require 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 FQDN to match your IP address. If not set, git send-email attempts
to determine your FQDN automatically. Default is the value of to determine your FQDN automatically. Default is the value of
'sendemail.smtpDomain'. `sendemail.smtpDomain`.
--smtp-auth=<mechanisms>:: --smtp-auth=<mechanisms>::
Whitespace-separated list of allowed SMTP-AUTH mechanisms. This setting 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>]:: --smtp-pass[=<password>]::
Password for SMTP-AUTH. The argument is optional: If no Password for SMTP-AUTH. The argument is optional: If no
argument is specified, then the empty string is used as 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. however '--smtp-pass' always overrides this value.
+ +
Furthermore, passwords need not be specified in configuration files Furthermore, passwords need not be specified in configuration files
or on the command line. If a username has been specified (with or on the command line. If a username has been specified (with
'--smtp-user' or a 'sendemail.smtpUser'), but no password has been '--smtp-user' or a `sendemail.smtpUser`), but no password has been
specified (with '--smtp-pass' or 'sendemail.smtpPass'), then specified (with '--smtp-pass' or `sendemail.smtpPass`), then
a password is obtained using 'git-credential'. a password is obtained using 'git-credential'.
--smtp-server=<host>:: --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 `smtp.example.com` or a raw IP address). Alternatively it can
specify a full pathname of a sendmail-like program instead; specify a full pathname of a sendmail-like program instead;
the program must support the `-i` option. Default value can 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 option; the built-in default is `/usr/sbin/sendmail` or
`/usr/lib/sendmail` if such program is available, or `/usr/lib/sendmail` if such program is available, or
`localhost` otherwise. `localhost` otherwise.
@ -213,11 +213,11 @@ a password is obtained using 'git-credential'.
submission port 587, or the common SSL smtp port 465); submission port 587, or the common SSL smtp port 465);
symbolic port names (e.g. "submission" instead of 587) symbolic port names (e.g. "submission" instead of 587)
are also accepted. The port can also be set with the are also accepted. The port can also be set with the
'sendemail.smtpServerPort' configuration variable. `sendemail.smtpServerPort` configuration variable.
--smtp-server-option=<option>:: --smtp-server-option=<option>::
If set, specifies the outgoing SMTP server option to use. 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. configuration option.
+ +
The --smtp-server-option option must be repeated for each option you want 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 certificates concatenated together: see verify(1) -CAfile and
-CApath for more information on these). Set it to an empty string -CApath for more information on these). Set it to an empty string
to disable certificate verification. Defaults to the value of the 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 backing SSL library's compiled-in default otherwise (which should
be the best choice on most platforms). be the best choice on most platforms).
--smtp-user=<user>:: --smtp-user=<user>::
Username for SMTP-AUTH. Default is the value of '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'), if a username is not specified (with '--smtp-user' or `sendemail.smtpUser`),
then authentication is not attempted. then authentication is not attempted.
--smtp-debug=0|1:: --smtp-debug=0|1::
@ -261,25 +261,25 @@ Automating
Specify a command to execute once per patch file which Specify a command to execute once per patch file which
should generate patch file specific "Cc:" entries. should generate patch file specific "Cc:" entries.
Output of this command must be single email address per line. 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:: --[no-]chain-reply-to::
If this is set, each email will be sent as a reply to the previous 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 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 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 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. configuration variable can be used to enable it.
--identity=<identity>:: --identity=<identity>::
A configuration identity. When given, causes values in the A configuration identity. When given, causes values in the
'sendemail.<identity>' subsection to take precedence over 'sendemail.<identity>' subsection to take precedence over
values in the 'sendemail' section. The default identity is values in the 'sendemail' section. The default identity is
the value of 'sendemail.identity'. the value of `sendemail.identity`.
--[no-]signed-off-by-cc:: --[no-]signed-off-by-cc::
If this is set, add emails found in Signed-off-by: or Cc: lines to the 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. value; if that is unspecified, default to --signed-off-by-cc.
--[no-]cc-cover:: --[no-]cc-cover::
@ -312,13 +312,13 @@ Automating
- 'all' will suppress all auto cc values. - '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 that is unspecified, default to 'self' if --suppress-from is
specified, as well as 'body' if --no-signed-off-cc is specified. specified, as well as 'body' if --no-signed-off-cc is specified.
--[no-]suppress-from:: --[no-]suppress-from::
If this is set, do not add the From: address to the cc: list. 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. value; if that is unspecified, default to --no-suppress-from.
--[no-]thread:: --[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 If disabled with "--no-thread", those headers will not be added
(unless specified with --in-reply-to). Default is the value of the (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. default to --thread.
+ +
It is up to the user to ensure that no In-Reply-To header already 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' - '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 is unspecified, default to 'auto' unless any of the suppress options
have been specified, in which case default to 'compose'. 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. 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'. default to '--validate'.
--force:: --force::
@ -403,7 +403,7 @@ CONFIGURATION
sendemail.aliasesFile:: sendemail.aliasesFile::
To avoid typing long email addresses, point this to one or more 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:: sendemail.aliasFileType::
Format of the file(s) specified in sendemail.aliasesFile. Must be Format of the file(s) specified in sendemail.aliasesFile. Must be

2
Documentation/git-svn.txt
View File

@ -748,7 +748,7 @@ svn-remote.<name>.rewriteUUID::
svn-remote.<name>.pushurl:: 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 to be used in cases where 'url' points to an SVN repository
via a read-only transport, to provide an alternate read/write via a read-only transport, to provide an alternate read/write
transport. It is assumed that both keys point to the same transport. It is assumed that both keys point to the same

2
Documentation/git-tag.txt
View File

@ -104,7 +104,7 @@ OPTIONS
order can also be affected by the order can also be affected by the
"versionsort.prereleaseSuffix" configuration variable. "versionsort.prereleaseSuffix" configuration variable.
The keys supported are the same as those in `git for-each-ref`. 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 variable if it exists, or lexicographic order otherwise. See
linkgit:git-config[1]. linkgit:git-config[1].

6
Documentation/git-web--browse.txt
View File

@ -62,14 +62,14 @@ CONF.VAR (from -c option) and web.browser
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The web browser can be specified using a configuration variable passed 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. configuration variable if the former is not used.
browser.<tool>.path browser.<tool>.path
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
You can explicitly provide a full path to your preferred browser by 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 you can configure the absolute path to firefox by setting
'browser.firefox.path'. Otherwise, 'git web{litdd}browse' assumes the tool 'browser.firefox.path'. Otherwise, 'git web{litdd}browse' assumes the tool
is available in PATH. is available in PATH.
@ -79,7 +79,7 @@ browser.<tool>.cmd
When the browser, specified by options or configuration variables, is When the browser, specified by options or configuration variables, is
not among the supported ones, then the corresponding 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 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 as a custom command and will use a shell eval to run the command with
the URLs passed as arguments. the URLs passed as arguments.

2
Documentation/git.txt
View File

@ -991,7 +991,7 @@ for further details.
If this environment variable is set, then Git commands which need to If this environment variable is set, then Git commands which need to
acquire passwords or passphrases (e.g. for HTTP or IMAP authentication) acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
will call this program with a suitable prompt as command-line argument 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]. option in linkgit:git-config[1].
`GIT_TERMINAL_PROMPT`:: `GIT_TERMINAL_PROMPT`::

2
Documentation/gitignore.txt
View File

@ -38,7 +38,7 @@ precedence, the last matching pattern decides the outcome):
* Patterns read from `$GIT_DIR/info/exclude`. * Patterns read from `$GIT_DIR/info/exclude`.
* Patterns read from the file specified by the configuration * 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 Which file to place a pattern in depends on how the pattern is meant to
be used. be used.

4
Documentation/gitremote-helpers.txt
View File

@ -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 the first argument is '<address>', and if it is encountered in a
configured remote, the first argument is the name of that remote. 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 '<transport>', Git explicitly invokes 'git remote-<transport>' with
'<name>' as the first argument. If set, the second argument is '<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 INPUT FORMAT
------------ ------------

4
Documentation/pretty-options.txt
View File

@ -26,7 +26,7 @@ people using 80-column terminals.
--no-abbrev-commit:: --no-abbrev-commit::
Show the full 40-byte hexadecimal commit object name. This negates Show the full 40-byte hexadecimal commit object name. This negates
`--abbrev-commit` and those options which imply it such as `--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:: --oneline::
This is a shorthand for "--pretty=oneline --abbrev-commit" This is a shorthand for "--pretty=oneline --abbrev-commit"
@ -51,7 +51,7 @@ ifndef::git-rev-list[]
on the command line. on the command line.
+ +
By default, the notes shown are from the notes refs listed in the 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. environment overrides). See linkgit:git-config[1] for more details.
+ +
With an optional '<treeish>' argument, use the treeish to find the notes With an optional '<treeish>' argument, use the treeish to find the notes