2006-04-25 00:59:33 +02:00
|
|
|
CONFIGURATION FILE
|
|
|
|
------------------
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
The Git configuration file contains a number of variables that affect
|
|
|
|
the Git commands' behavior. The `.git/config` file in each repository
|
2009-04-23 11:38:02 +02:00
|
|
|
is used to store the configuration for that repository, and
|
|
|
|
`$HOME/.gitconfig` is used to store a per-user configuration as
|
2009-04-23 11:38:00 +02:00
|
|
|
fallback values for the `.git/config` file. The file `/etc/gitconfig`
|
2009-04-23 11:38:02 +02:00
|
|
|
can be used to store a system-wide default configuration.
|
2007-01-17 07:45:35 +01:00
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
The configuration variables are used by both the Git plumbing
|
2009-04-23 11:38:01 +02:00
|
|
|
and the porcelains. The variables are divided into sections, wherein
|
|
|
|
the fully qualified variable name of the variable itself is the last
|
2006-04-25 00:59:33 +02:00
|
|
|
dot-separated segment and the section name is everything before the last
|
2012-03-01 11:59:45 +01:00
|
|
|
dot. The variable names are case-insensitive, allow only alphanumeric
|
|
|
|
characters and `-`, and must start with an alphabetic character. Some
|
2015-03-04 19:26:17 +01:00
|
|
|
variables may appear multiple times; we say then that the variable is
|
|
|
|
multivalued.
|
2006-04-25 00:59:33 +02:00
|
|
|
|
2007-01-22 16:25:47 +01:00
|
|
|
Syntax
|
|
|
|
~~~~~~
|
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
The syntax is fairly flexible and permissive; whitespaces are mostly
|
2007-01-22 16:25:47 +01:00
|
|
|
ignored. The '#' and ';' characters begin comments to the end of line,
|
|
|
|
blank lines are ignored.
|
|
|
|
|
|
|
|
The file consists of sections and variables. A section begins with
|
|
|
|
the name of the section in square brackets and continues until the next
|
2015-03-04 05:03:50 +01:00
|
|
|
section begins. Section names are case-insensitive. Only alphanumeric
|
2009-03-15 12:30:52 +01:00
|
|
|
characters, `-` and `.` are allowed in section names. Each variable
|
2009-04-23 11:38:00 +02:00
|
|
|
must belong to some section, which means that there must be a section
|
|
|
|
header before the first setting of a variable.
|
2007-01-22 16:25:47 +01:00
|
|
|
|
|
|
|
Sections can be further divided into subsections. To begin a subsection
|
|
|
|
put its name in double quotes, separated by space from the section name,
|
2009-04-23 11:38:00 +02:00
|
|
|
in the section header, like in the example below:
|
2007-01-22 16:25:47 +01:00
|
|
|
|
|
|
|
--------
|
|
|
|
[section "subsection"]
|
|
|
|
|
|
|
|
--------
|
|
|
|
|
2009-04-23 11:38:01 +02:00
|
|
|
Subsection names are case sensitive and can contain any characters except
|
2017-12-21 14:10:42 +01:00
|
|
|
newline and the null byte. Doublequote `"` and backslash can be included
|
|
|
|
by escaping them as `\"` and `\\`, respectively. Backslashes preceding
|
|
|
|
other characters are dropped when reading; for example, `\t` is read as
|
|
|
|
`t` and `\0` is read as `0` Section headers cannot span multiple lines.
|
|
|
|
Variables may belong directly to a section or to a given subsection. You
|
|
|
|
can have `[section]` if you have `[section "subsection"]`, but you don't
|
|
|
|
need to.
|
2007-01-22 16:25:47 +01:00
|
|
|
|
2011-10-12 17:52:06 +02:00
|
|
|
There is also a deprecated `[section.subsection]` syntax. With this
|
|
|
|
syntax, the subsection name is converted to lower-case and is also
|
|
|
|
compared case sensitively. These subsection names follow the same
|
|
|
|
restrictions as section names.
|
2007-01-22 16:25:47 +01:00
|
|
|
|
2009-07-25 02:28:50 +02:00
|
|
|
All the other lines (and the remainder of the line after the section
|
|
|
|
header) are recognized as setting variables, in the form
|
2015-03-04 20:08:34 +01:00
|
|
|
'name = value' (or just 'name', which is a short-hand to say that
|
|
|
|
the variable is the boolean "true").
|
2012-03-01 11:59:45 +01:00
|
|
|
The variable names are case-insensitive, allow only alphanumeric characters
|
2015-03-04 19:26:17 +01:00
|
|
|
and `-`, and must start with an alphabetic character.
|
2007-01-22 16:25:47 +01:00
|
|
|
|
2015-03-04 19:33:38 +01:00
|
|
|
A line that defines a value can be continued to the next line by
|
|
|
|
ending it with a `\`; the backquote and the end-of-line are
|
|
|
|
stripped. Leading whitespaces after 'name =', the remainder of the
|
|
|
|
line after the first comment character '#' or ';', and trailing
|
|
|
|
whitespaces of the line are discarded unless they are enclosed in
|
|
|
|
double quotes. Internal whitespaces within the value are retained
|
|
|
|
verbatim.
|
2007-01-22 16:25:47 +01:00
|
|
|
|
2015-03-04 19:33:38 +01:00
|
|
|
Inside double quotes, double quote `"` and backslash `\` characters
|
|
|
|
must be escaped: use `\"` for `"` and `\\` for `\`.
|
2007-01-22 16:25:47 +01:00
|
|
|
|
2009-03-15 12:30:52 +01:00
|
|
|
The following escape sequences (beside `\"` and `\\`) are recognized:
|
|
|
|
`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
|
2014-04-01 00:11:44 +02:00
|
|
|
and `\b` for backspace (BS). Other char escape sequences (including octal
|
|
|
|
escape sequences) are invalid.
|
2007-01-22 16:25:47 +01:00
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
|
config: add include directive
It can be useful to split your ~/.gitconfig across multiple
files. For example, you might have a "main" file which is
used on many machines, but a small set of per-machine
tweaks. Or you may want to make some of your config public
(e.g., clever aliases) while keeping other data back (e.g.,
your name or other identifying information). Or you may want
to include a number of config options in some subset of your
repos without copying and pasting (e.g., you want to
reference them from the .git/config of participating repos).
This patch introduces an include directive for config files.
It looks like:
[include]
path = /path/to/file
This is syntactically backwards-compatible with existing git
config parsers (i.e., they will see it as another config
entry and ignore it unless you are looking up include.path).
The implementation provides a "git_config_include" callback
which wraps regular config callbacks. Callers can pass it to
git_config_from_file, and it will transparently follow any
include directives, passing all of the discovered options to
the real callback.
Include directives are turned on automatically for "regular"
git config parsing. This includes calls to git_config, as
well as calls to the "git config" program that do not
specify a single file (e.g., using "-f", "--global", etc).
They are not turned on in other cases, including:
1. Parsing of other config-like files, like .gitmodules.
There isn't a real need, and I'd rather be conservative
and avoid unnecessary incompatibility or confusion.
2. Reading single files via "git config". This is for two
reasons:
a. backwards compatibility with scripts looking at
config-like files.
b. inspection of a specific file probably means you
care about just what's in that file, not a general
lookup for "do we have this value anywhere at
all". If that is not the case, the caller can
always specify "--includes".
3. Writing files via "git config"; we want to treat
include.* variables as literal items to be copied (or
modified), and not expand them. So "git config
--unset-all foo.bar" would operate _only_ on
.git/config, not any of its included files (just as it
also does not operate on ~/.gitconfig).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-02-06 10:54:04 +01:00
|
|
|
Includes
|
|
|
|
~~~~~~~~
|
|
|
|
|
2017-05-11 11:10:47 +02:00
|
|
|
The `include` and `includeIf` sections allow you to include config
|
|
|
|
directives from another source. These sections behave identically to
|
|
|
|
each other with the exception that `includeIf` sections may be ignored
|
|
|
|
if their condition does not evaluate to true; see "Conditional includes"
|
|
|
|
below.
|
|
|
|
|
2017-03-01 12:26:29 +01:00
|
|
|
You can include a config file from another by setting the special
|
2017-05-11 11:10:47 +02:00
|
|
|
`include.path` (or `includeIf.*.path`) variable to the name of the file
|
|
|
|
to be included. The variable takes a pathname as its value, and is
|
|
|
|
subject to tilde expansion. These variables can be given multiple times.
|
2016-04-29 19:43:55 +02:00
|
|
|
|
2017-05-11 11:13:04 +02:00
|
|
|
The contents of the included file are inserted immediately, as if they
|
|
|
|
had been found at the location of the include directive. If the value of the
|
2017-05-11 11:10:47 +02:00
|
|
|
variable is a relative path, the path is considered to
|
2017-03-01 12:26:30 +01:00
|
|
|
be relative to the configuration file in which the include directive
|
|
|
|
was found. See below for examples.
|
2016-04-29 19:43:55 +02:00
|
|
|
|
config: add conditional include
Sometimes a set of repositories want to share configuration settings
among themselves that are distinct from other such sets of repositories.
A user may work on two projects, each of which have multiple
repositories, and use one user.email for one project while using another
for the other.
Setting $GIT_DIR/.config works, but if the penalty of forgetting to
update $GIT_DIR/.config is high (especially when you end up cloning
often), it may not be the best way to go. Having the settings in
~/.gitconfig, which would work for just one set of repositories, would
not well in such a situation. Having separate ${HOME}s may add more
problems than it solves.
Extend the include.path mechanism that lets a config file include
another config file, so that the inclusion can be done only when some
conditions hold. Then ~/.gitconfig can say "include config-project-A
only when working on project-A" for each project A the user works on.
In this patch, the only supported grouping is based on $GIT_DIR (in
absolute path), so you would need to group repositories by directory, or
something like that to take advantage of it.
We already have include.path for unconditional includes. This patch goes
with includeIf.<condition>.path to make it clearer that a condition is
required. The new config has the same backward compatibility approach as
include.path: older git versions that don't understand includeIf will
simply ignore them.
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-01 12:26:31 +01:00
|
|
|
Conditional includes
|
|
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
You can include a config file from another conditionally by setting a
|
|
|
|
`includeIf.<condition>.path` variable to the name of the file to be
|
2017-05-11 11:10:47 +02:00
|
|
|
included.
|
config: add conditional include
Sometimes a set of repositories want to share configuration settings
among themselves that are distinct from other such sets of repositories.
A user may work on two projects, each of which have multiple
repositories, and use one user.email for one project while using another
for the other.
Setting $GIT_DIR/.config works, but if the penalty of forgetting to
update $GIT_DIR/.config is high (especially when you end up cloning
often), it may not be the best way to go. Having the settings in
~/.gitconfig, which would work for just one set of repositories, would
not well in such a situation. Having separate ${HOME}s may add more
problems than it solves.
Extend the include.path mechanism that lets a config file include
another config file, so that the inclusion can be done only when some
conditions hold. Then ~/.gitconfig can say "include config-project-A
only when working on project-A" for each project A the user works on.
In this patch, the only supported grouping is based on $GIT_DIR (in
absolute path), so you would need to group repositories by directory, or
something like that to take advantage of it.
We already have include.path for unconditional includes. This patch goes
with includeIf.<condition>.path to make it clearer that a condition is
required. The new config has the same backward compatibility approach as
include.path: older git versions that don't understand includeIf will
simply ignore them.
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-01 12:26:31 +01:00
|
|
|
|
|
|
|
The condition starts with a keyword followed by a colon and some data
|
|
|
|
whose format and meaning depends on the keyword. Supported keywords
|
|
|
|
are:
|
|
|
|
|
|
|
|
`gitdir`::
|
|
|
|
|
|
|
|
The data that follows the keyword `gitdir:` is used as a glob
|
|
|
|
pattern. If the location of the .git directory matches the
|
|
|
|
pattern, the include condition is met.
|
|
|
|
+
|
|
|
|
The .git location may be auto-discovered, or come from `$GIT_DIR`
|
|
|
|
environment variable. If the repository is auto discovered via a .git
|
|
|
|
file (e.g. from submodules, or a linked worktree), the .git location
|
|
|
|
would be the final location where the .git directory is, not where the
|
|
|
|
.git file is.
|
|
|
|
+
|
|
|
|
The pattern can contain standard globbing wildcards and two additional
|
|
|
|
ones, `**/` and `/**`, that can match multiple path components. Please
|
|
|
|
refer to linkgit:gitignore[5] for details. For convenience:
|
|
|
|
|
|
|
|
* If the pattern starts with `~/`, `~` will be substituted with the
|
|
|
|
content of the environment variable `HOME`.
|
|
|
|
|
|
|
|
* If the pattern starts with `./`, it is replaced with the directory
|
|
|
|
containing the current config file.
|
|
|
|
|
|
|
|
* If the pattern does not start with either `~/`, `./` or `/`, `**/`
|
|
|
|
will be automatically prepended. For example, the pattern `foo/bar`
|
|
|
|
becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
|
|
|
|
|
|
|
|
* If the pattern ends with `/`, `**` will be automatically added. For
|
|
|
|
example, the pattern `foo/` becomes `foo/**`. In other words, it
|
|
|
|
matches "foo" and everything inside, recursively.
|
|
|
|
|
|
|
|
`gitdir/i`::
|
|
|
|
This is the same as `gitdir` except that matching is done
|
|
|
|
case-insensitively (e.g. on case-insensitive file sytems)
|
|
|
|
|
|
|
|
A few more notes on matching via `gitdir` and `gitdir/i`:
|
|
|
|
|
|
|
|
* Symlinks in `$GIT_DIR` are not resolved before matching.
|
|
|
|
|
2017-05-16 10:28:46 +02:00
|
|
|
* Both the symlink & realpath versions of paths will be matched
|
|
|
|
outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
|
|
|
|
/mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
|
|
|
|
will match.
|
|
|
|
+
|
|
|
|
This was not the case in the initial release of this feature in
|
|
|
|
v2.13.0, which only matched the realpath version. Configuration that
|
|
|
|
wants to be compatible with the initial release of this feature needs
|
|
|
|
to either specify only the realpath version, or both versions.
|
|
|
|
|
config: add conditional include
Sometimes a set of repositories want to share configuration settings
among themselves that are distinct from other such sets of repositories.
A user may work on two projects, each of which have multiple
repositories, and use one user.email for one project while using another
for the other.
Setting $GIT_DIR/.config works, but if the penalty of forgetting to
update $GIT_DIR/.config is high (especially when you end up cloning
often), it may not be the best way to go. Having the settings in
~/.gitconfig, which would work for just one set of repositories, would
not well in such a situation. Having separate ${HOME}s may add more
problems than it solves.
Extend the include.path mechanism that lets a config file include
another config file, so that the inclusion can be done only when some
conditions hold. Then ~/.gitconfig can say "include config-project-A
only when working on project-A" for each project A the user works on.
In this patch, the only supported grouping is based on $GIT_DIR (in
absolute path), so you would need to group repositories by directory, or
something like that to take advantage of it.
We already have include.path for unconditional includes. This patch goes
with includeIf.<condition>.path to make it clearer that a condition is
required. The new config has the same backward compatibility approach as
include.path: older git versions that don't understand includeIf will
simply ignore them.
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-01 12:26:31 +01:00
|
|
|
* Note that "../" is not special and will match literally, which is
|
|
|
|
unlikely what you want.
|
config: add include directive
It can be useful to split your ~/.gitconfig across multiple
files. For example, you might have a "main" file which is
used on many machines, but a small set of per-machine
tweaks. Or you may want to make some of your config public
(e.g., clever aliases) while keeping other data back (e.g.,
your name or other identifying information). Or you may want
to include a number of config options in some subset of your
repos without copying and pasting (e.g., you want to
reference them from the .git/config of participating repos).
This patch introduces an include directive for config files.
It looks like:
[include]
path = /path/to/file
This is syntactically backwards-compatible with existing git
config parsers (i.e., they will see it as another config
entry and ignore it unless you are looking up include.path).
The implementation provides a "git_config_include" callback
which wraps regular config callbacks. Callers can pass it to
git_config_from_file, and it will transparently follow any
include directives, passing all of the discovered options to
the real callback.
Include directives are turned on automatically for "regular"
git config parsing. This includes calls to git_config, as
well as calls to the "git config" program that do not
specify a single file (e.g., using "-f", "--global", etc).
They are not turned on in other cases, including:
1. Parsing of other config-like files, like .gitmodules.
There isn't a real need, and I'd rather be conservative
and avoid unnecessary incompatibility or confusion.
2. Reading single files via "git config". This is for two
reasons:
a. backwards compatibility with scripts looking at
config-like files.
b. inspection of a specific file probably means you
care about just what's in that file, not a general
lookup for "do we have this value anywhere at
all". If that is not the case, the caller can
always specify "--includes".
3. Writing files via "git config"; we want to treat
include.* variables as literal items to be copied (or
modified), and not expand them. So "git config
--unset-all foo.bar" would operate _only_ on
.git/config, not any of its included files (just as it
also does not operate on ~/.gitconfig).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-02-06 10:54:04 +01:00
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
Example
|
|
|
|
~~~~~~~
|
|
|
|
|
|
|
|
# Core variables
|
|
|
|
[core]
|
|
|
|
; Don't trust file modes
|
|
|
|
filemode = false
|
|
|
|
|
|
|
|
# Our diff algorithm
|
|
|
|
[diff]
|
2008-07-27 13:12:15 +02:00
|
|
|
external = /usr/local/bin/diff-wrapper
|
2006-04-25 00:59:33 +02:00
|
|
|
renames = true
|
|
|
|
|
2006-12-07 07:36:55 +01:00
|
|
|
[branch "devel"]
|
|
|
|
remote = origin
|
|
|
|
merge = refs/heads/devel
|
|
|
|
|
2007-01-22 16:25:47 +01:00
|
|
|
# Proxy settings
|
|
|
|
[core]
|
2007-08-03 00:45:56 +02:00
|
|
|
gitProxy="ssh" for "kernel.org"
|
2007-01-22 16:25:47 +01:00
|
|
|
gitProxy=default-proxy ; for the rest
|
2006-12-07 07:36:55 +01:00
|
|
|
|
config: add include directive
It can be useful to split your ~/.gitconfig across multiple
files. For example, you might have a "main" file which is
used on many machines, but a small set of per-machine
tweaks. Or you may want to make some of your config public
(e.g., clever aliases) while keeping other data back (e.g.,
your name or other identifying information). Or you may want
to include a number of config options in some subset of your
repos without copying and pasting (e.g., you want to
reference them from the .git/config of participating repos).
This patch introduces an include directive for config files.
It looks like:
[include]
path = /path/to/file
This is syntactically backwards-compatible with existing git
config parsers (i.e., they will see it as another config
entry and ignore it unless you are looking up include.path).
The implementation provides a "git_config_include" callback
which wraps regular config callbacks. Callers can pass it to
git_config_from_file, and it will transparently follow any
include directives, passing all of the discovered options to
the real callback.
Include directives are turned on automatically for "regular"
git config parsing. This includes calls to git_config, as
well as calls to the "git config" program that do not
specify a single file (e.g., using "-f", "--global", etc).
They are not turned on in other cases, including:
1. Parsing of other config-like files, like .gitmodules.
There isn't a real need, and I'd rather be conservative
and avoid unnecessary incompatibility or confusion.
2. Reading single files via "git config". This is for two
reasons:
a. backwards compatibility with scripts looking at
config-like files.
b. inspection of a specific file probably means you
care about just what's in that file, not a general
lookup for "do we have this value anywhere at
all". If that is not the case, the caller can
always specify "--includes".
3. Writing files via "git config"; we want to treat
include.* variables as literal items to be copied (or
modified), and not expand them. So "git config
--unset-all foo.bar" would operate _only_ on
.git/config, not any of its included files (just as it
also does not operate on ~/.gitconfig).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-02-06 10:54:04 +01:00
|
|
|
[include]
|
|
|
|
path = /path/to/foo.inc ; include by absolute path
|
2017-05-11 11:14:30 +02:00
|
|
|
path = foo.inc ; find "foo.inc" relative to the current file
|
|
|
|
path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
|
config: add include directive
It can be useful to split your ~/.gitconfig across multiple
files. For example, you might have a "main" file which is
used on many machines, but a small set of per-machine
tweaks. Or you may want to make some of your config public
(e.g., clever aliases) while keeping other data back (e.g.,
your name or other identifying information). Or you may want
to include a number of config options in some subset of your
repos without copying and pasting (e.g., you want to
reference them from the .git/config of participating repos).
This patch introduces an include directive for config files.
It looks like:
[include]
path = /path/to/file
This is syntactically backwards-compatible with existing git
config parsers (i.e., they will see it as another config
entry and ignore it unless you are looking up include.path).
The implementation provides a "git_config_include" callback
which wraps regular config callbacks. Callers can pass it to
git_config_from_file, and it will transparently follow any
include directives, passing all of the discovered options to
the real callback.
Include directives are turned on automatically for "regular"
git config parsing. This includes calls to git_config, as
well as calls to the "git config" program that do not
specify a single file (e.g., using "-f", "--global", etc).
They are not turned on in other cases, including:
1. Parsing of other config-like files, like .gitmodules.
There isn't a real need, and I'd rather be conservative
and avoid unnecessary incompatibility or confusion.
2. Reading single files via "git config". This is for two
reasons:
a. backwards compatibility with scripts looking at
config-like files.
b. inspection of a specific file probably means you
care about just what's in that file, not a general
lookup for "do we have this value anywhere at
all". If that is not the case, the caller can
always specify "--includes".
3. Writing files via "git config"; we want to treat
include.* variables as literal items to be copied (or
modified), and not expand them. So "git config
--unset-all foo.bar" would operate _only_ on
.git/config, not any of its included files (just as it
also does not operate on ~/.gitconfig).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-02-06 10:54:04 +01:00
|
|
|
|
config: add conditional include
Sometimes a set of repositories want to share configuration settings
among themselves that are distinct from other such sets of repositories.
A user may work on two projects, each of which have multiple
repositories, and use one user.email for one project while using another
for the other.
Setting $GIT_DIR/.config works, but if the penalty of forgetting to
update $GIT_DIR/.config is high (especially when you end up cloning
often), it may not be the best way to go. Having the settings in
~/.gitconfig, which would work for just one set of repositories, would
not well in such a situation. Having separate ${HOME}s may add more
problems than it solves.
Extend the include.path mechanism that lets a config file include
another config file, so that the inclusion can be done only when some
conditions hold. Then ~/.gitconfig can say "include config-project-A
only when working on project-A" for each project A the user works on.
In this patch, the only supported grouping is based on $GIT_DIR (in
absolute path), so you would need to group repositories by directory, or
something like that to take advantage of it.
We already have include.path for unconditional includes. This patch goes
with includeIf.<condition>.path to make it clearer that a condition is
required. The new config has the same backward compatibility approach as
include.path: older git versions that don't understand includeIf will
simply ignore them.
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-01 12:26:31 +01:00
|
|
|
; include if $GIT_DIR is /path/to/foo/.git
|
|
|
|
[includeIf "gitdir:/path/to/foo/.git"]
|
|
|
|
path = /path/to/foo.inc
|
|
|
|
|
|
|
|
; include for all repositories inside /path/to/group
|
|
|
|
[includeIf "gitdir:/path/to/group/"]
|
|
|
|
path = /path/to/foo.inc
|
|
|
|
|
|
|
|
; include for all repositories inside $HOME/to/group
|
|
|
|
[includeIf "gitdir:~/to/group/"]
|
|
|
|
path = /path/to/foo.inc
|
2015-03-04 19:57:43 +01:00
|
|
|
|
2017-05-11 11:11:06 +02:00
|
|
|
; relative paths are always relative to the including
|
|
|
|
; file (if the condition is true); their location is not
|
|
|
|
; affected by the condition
|
|
|
|
[includeIf "gitdir:/path/to/group/"]
|
|
|
|
path = foo.inc
|
|
|
|
|
2015-03-04 19:57:43 +01:00
|
|
|
Values
|
|
|
|
~~~~~~
|
|
|
|
|
|
|
|
Values of many variables are treated as a simple string, but there
|
|
|
|
are variables that take values of specific types and there are rules
|
|
|
|
as to how to spell them.
|
|
|
|
|
|
|
|
boolean::
|
|
|
|
|
|
|
|
When a variable is said to take a boolean value, many
|
|
|
|
synonyms are accepted for 'true' and 'false'; these are all
|
|
|
|
case-insensitive.
|
|
|
|
|
2017-08-15 00:12:18 +02:00
|
|
|
true;; Boolean true literals are `yes`, `on`, `true`,
|
|
|
|
and `1`. Also, a variable defined without `= <value>`
|
2015-03-04 19:57:43 +01:00
|
|
|
is taken as true.
|
|
|
|
|
2017-08-15 00:12:18 +02:00
|
|
|
false;; Boolean false literals are `no`, `off`, `false`,
|
|
|
|
`0` and the empty string.
|
2015-03-04 19:57:43 +01:00
|
|
|
+
|
2018-09-19 18:38:18 +02:00
|
|
|
When converting a value to its canonical form using the `--type=bool` type
|
2017-08-15 00:12:18 +02:00
|
|
|
specifier, 'git config' will ensure that the output is "true" or
|
2015-03-04 19:57:43 +01:00
|
|
|
"false" (spelled in lowercase).
|
|
|
|
|
|
|
|
integer::
|
|
|
|
The value for many variables that specify various sizes can
|
|
|
|
be suffixed with `k`, `M`,... to mean "scale the number by
|
|
|
|
1024", "by 1024x1024", etc.
|
|
|
|
|
2015-03-04 08:07:13 +01:00
|
|
|
color::
|
2016-06-23 19:32:30 +02:00
|
|
|
The value for a variable that takes a color is a list of
|
|
|
|
colors (at most two, one for foreground and one for background)
|
|
|
|
and attributes (as many as you want), separated by spaces.
|
2015-03-20 21:50:51 +01:00
|
|
|
+
|
2016-06-23 19:32:30 +02:00
|
|
|
The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
|
|
|
|
`blue`, `magenta`, `cyan` and `white`. The first color given is the
|
|
|
|
foreground; the second is the background.
|
log --decorate: do not leak "commit" color into the next item
In "git log --decorate", you would see the commit header like this:
commit ... (HEAD, jc/decorate-leaky-separator-color)
where "commit ... (" is painted in color.diff.commit, "HEAD" in
color.decorate.head, ", " in color.diff.commit, the branch name in
color.decorate.branch and then closing ")" in color.diff.commit.
If you wanted to paint the HEAD and local branch name in the same
color as the body text (perhaps because cyan and green are too faint
on a black-on-white terminal to be readable), you would not want to
have to say
[color "decorate"]
head = black
branch = black
because that you would not be able to reuse same configuration on a
white-on-black terminal. You would naively expect
[color "decorate"]
head = normal
branch = normal
to work, but unfortunately it does not. It paints the string "HEAD"
and the branch name in the same color as the opening parenthesis or
comma between the decoration elements. This is because the code
forgets to reset the color after printing the "prefix" in its own
color.
It theoretically is possible that some people were expecting and
relying on that the attribute set as the "diff.commit" color, which
is used to draw these opening parenthesis and inter-item comma, is
inherited by the drawing of branch names, but it is not how the
coloring works everywhere else.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2015-03-04 20:07:12 +01:00
|
|
|
+
|
2016-06-23 19:32:30 +02:00
|
|
|
Colors may also be given as numbers between 0 and 255; these use ANSI
|
|
|
|
256-color mode (but note that not all terminals may support this). If
|
|
|
|
your terminal supports it, you may also specify 24-bit RGB values as
|
|
|
|
hex, like `#ff0ab3`.
|
|
|
|
+
|
2016-06-23 19:40:16 +02:00
|
|
|
The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
|
|
|
|
`italic`, and `strike` (for crossed-out or "strikethrough" letters).
|
|
|
|
The position of any attributes with respect to the colors
|
2016-06-23 19:39:07 +02:00
|
|
|
(before, after, or in between), doesn't matter. Specific attributes may
|
|
|
|
be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
|
|
|
|
`no-ul`, etc).
|
2016-06-23 19:32:30 +02:00
|
|
|
+
|
2017-02-02 13:42:44 +01:00
|
|
|
An empty color string produces no color effect at all. This can be used
|
|
|
|
to avoid coloring specific elements without disabling color entirely.
|
|
|
|
+
|
2016-06-23 19:32:30 +02:00
|
|
|
For git's pre-defined color slots, the attributes are meant to be reset
|
|
|
|
at the beginning of each item in the colored output. So setting
|
|
|
|
`color.decorate.branch` to `black` will paint that branch name in a
|
|
|
|
plain `black`, even if the previous thing on the same output line (e.g.
|
|
|
|
opening parenthesis before the list of branch names in `log --decorate`
|
|
|
|
output) is set to be painted with `bold` or some other attribute.
|
|
|
|
However, custom log formats may do more complicated and layered
|
|
|
|
coloring, and the negated forms may be useful there.
|
2015-03-04 08:07:13 +01:00
|
|
|
|
2016-04-29 19:43:55 +02:00
|
|
|
pathname::
|
|
|
|
A variable that takes a pathname value can be given a
|
|
|
|
string that begins with "`~/`" or "`~user/`", and the usual
|
|
|
|
tilde expansion happens to such a string: `~/`
|
|
|
|
is expanded to the value of `$HOME`, and `~user/` to the
|
|
|
|
specified user's home directory.
|
|
|
|
|
2015-03-04 19:57:43 +01:00
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
Variables
|
|
|
|
~~~~~~~~~
|
|
|
|
|
|
|
|
Note that this list is non-comprehensive and not necessarily complete.
|
2006-06-08 01:15:05 +02:00
|
|
|
For command-specific variables, you will find a more detailed description
|
2014-03-21 05:07:08 +01:00
|
|
|
in the appropriate manual page.
|
|
|
|
|
|
|
|
Other git-related tools may and do use their own variables. When
|
|
|
|
inventing new variables for use in your own tool, make sure their
|
|
|
|
names do not conflict with those that are used by Git itself and
|
|
|
|
other popular tools, and describe them in your documentation.
|
|
|
|
|
2018-10-27 08:22:35 +02:00
|
|
|
include::config/advice.txt[]
|
2009-09-09 13:38:58 +02:00
|
|
|
|
2018-10-27 08:22:36 +02:00
|
|
|
include::config/core.txt[]
|
2010-10-28 20:28:04 +02:00
|
|
|
|
2018-10-27 08:22:37 +02:00
|
|
|
include::config/add.txt[]
|
2009-05-31 07:08:02 +02:00
|
|
|
|
2018-10-27 08:22:38 +02:00
|
|
|
include::config/alias.txt[]
|
2007-02-11 01:33:58 +01:00
|
|
|
|
2018-10-27 08:22:39 +02:00
|
|
|
include::config/am.txt[]
|
2015-08-04 16:19:26 +02:00
|
|
|
|
2018-10-27 08:22:40 +02:00
|
|
|
include::config/apply.txt[]
|
2006-04-25 00:59:33 +02:00
|
|
|
|
2018-10-27 08:22:41 +02:00
|
|
|
include::config/blame.txt[]
|
2018-08-04 08:25:00 +02:00
|
|
|
|
2018-10-27 08:22:42 +02:00
|
|
|
include::config/branch.txt[]
|
2013-01-01 10:30:53 +01:00
|
|
|
|
2018-10-27 08:22:43 +02:00
|
|
|
include::config/browser.txt[]
|
2008-01-29 07:08:22 +01:00
|
|
|
|
2018-10-27 08:22:44 +02:00
|
|
|
include::config/checkout.txt[]
|
2018-08-16 20:27:11 +02:00
|
|
|
|
2018-10-27 08:22:45 +02:00
|
|
|
include::config/clean.txt[]
|
2007-04-24 02:18:16 +02:00
|
|
|
|
2018-10-27 08:22:46 +02:00
|
|
|
include::config/color.txt[]
|
2008-02-18 08:26:03 +01:00
|
|
|
|
2018-10-27 08:22:47 +02:00
|
|
|
include::config/column.txt[]
|
2012-04-13 12:54:41 +02:00
|
|
|
|
2018-10-27 08:22:48 +02:00
|
|
|
include::config/commit.txt[]
|
2016-05-05 11:50:02 +02:00
|
|
|
|
2018-10-27 08:22:49 +02:00
|
|
|
include::config/credential.txt[]
|
2015-11-10 01:26:29 +01:00
|
|
|
|
2018-10-27 08:22:50 +02:00
|
|
|
include::config/completion.txt[]
|
2018-05-20 20:40:09 +02:00
|
|
|
|
2018-10-27 08:22:51 +02:00
|
|
|
include::config/diff.txt[]
|
2009-04-07 10:21:20 +02:00
|
|
|
|
2018-10-27 08:22:52 +02:00
|
|
|
include::config/difftool.txt[]
|
2009-04-07 10:21:22 +02:00
|
|
|
|
2016-04-25 23:17:28 +02:00
|
|
|
fastimport.unpackLimit::
|
|
|
|
If the number of objects imported by linkgit:git-fast-import[1]
|
|
|
|
is below this limit, then the objects will be unpacked into
|
|
|
|
loose object files. However if the number of imported objects
|
|
|
|
equals or exceeds this limit then the pack will be stored as a
|
|
|
|
pack. Storing the pack from a fast-import can make the import
|
|
|
|
operation complete faster, especially on slow filesystems. If
|
|
|
|
not set, the value of `transfer.unpackLimit` is used instead.
|
|
|
|
|
2018-08-22 18:05:56 +02:00
|
|
|
include::fetch-config.txt[]
|
2018-07-16 20:44:01 +02:00
|
|
|
|
2018-08-22 18:05:57 +02:00
|
|
|
include::format-config.txt[]
|
2016-04-26 09:51:24 +02:00
|
|
|
|
2011-04-06 20:46:48 +02:00
|
|
|
filter.<driver>.clean::
|
|
|
|
The command which is used to convert the content of a worktree
|
|
|
|
file to a blob upon checkin. See linkgit:gitattributes[5] for
|
|
|
|
details.
|
|
|
|
|
|
|
|
filter.<driver>.smudge::
|
|
|
|
The command which is used to convert the content of a blob
|
|
|
|
object to a worktree file upon checkout. See
|
|
|
|
linkgit:gitattributes[5] for details.
|
|
|
|
|
2015-06-22 17:27:06 +02:00
|
|
|
fsck.<msg-id>::
|
2018-07-27 16:37:13 +02:00
|
|
|
During fsck git may find issues with legacy data which
|
|
|
|
wouldn't be generated by current versions of git, and which
|
|
|
|
wouldn't be sent over the wire if `transfer.fsckObjects` was
|
|
|
|
set. This feature is intended to support working with legacy
|
|
|
|
repositories containing such data.
|
|
|
|
+
|
|
|
|
Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
|
2018-07-27 16:37:17 +02:00
|
|
|
to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
|
|
|
|
to clone or fetch it set `fetch.fsck.<msg-id>`.
|
2018-07-27 16:37:13 +02:00
|
|
|
+
|
|
|
|
The rest of the documentation discusses `fsck.*` for brevity, but the
|
2018-07-27 16:37:17 +02:00
|
|
|
same applies for the corresponding `receive.fsck.*` and
|
|
|
|
`fetch.<msg-id>.*`. variables.
|
2018-07-27 16:37:13 +02:00
|
|
|
+
|
2018-07-27 16:37:18 +02:00
|
|
|
Unlike variables like `color.ui` and `core.editor` the
|
|
|
|
`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
|
|
|
|
fall back on the `fsck.<msg-id>` configuration if they aren't set. To
|
|
|
|
uniformly configure the same fsck settings in different circumstances
|
|
|
|
all three of them they must all set to the same values.
|
|
|
|
+
|
2018-07-27 16:37:13 +02:00
|
|
|
When `fsck.<msg-id>` is set, errors can be switched to warnings and
|
|
|
|
vice versa by configuring the `fsck.<msg-id>` setting where the
|
|
|
|
`<msg-id>` is the fsck message ID and the value is one of `error`,
|
|
|
|
`warn` or `ignore`. For convenience, fsck prefixes the error/warning
|
|
|
|
with the message ID, e.g. "missingEmail: invalid author/committer line
|
|
|
|
- missing email" means that setting `fsck.missingEmail = ignore` will
|
|
|
|
hide that issue.
|
|
|
|
+
|
|
|
|
In general, it is better to enumerate existing objects with problems
|
|
|
|
with `fsck.skipList`, instead of listing the kind of breakages these
|
|
|
|
problematic objects share to be ignored, as doing the latter will
|
|
|
|
allow new instances of the same breakages go unnoticed.
|
2018-07-27 16:37:20 +02:00
|
|
|
+
|
|
|
|
Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
|
|
|
|
doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
|
|
|
|
will only cause git to warn.
|
2015-06-22 17:27:06 +02:00
|
|
|
|
2015-06-22 17:27:23 +02:00
|
|
|
fsck.skipList::
|
2018-09-03 16:49:23 +02:00
|
|
|
The path to a list of object names (i.e. one unabbreviated SHA-1 per
|
2015-06-22 17:27:23 +02:00
|
|
|
line) that are known to be broken in a non-fatal way and should
|
2018-09-03 16:49:28 +02:00
|
|
|
be ignored. On versions of Git 2.20 and later comments ('#'), empty
|
|
|
|
lines, and any leading and trailing whitespace is ignored. Everything
|
|
|
|
but a SHA-1 per line will error out on older versions.
|
2018-09-03 16:49:22 +02:00
|
|
|
+
|
|
|
|
This feature is useful when an established project should be accepted
|
|
|
|
despite early commits containing errors that can be safely ignored
|
|
|
|
such as invalid committer email addresses. Note: corrupt objects
|
|
|
|
cannot be skipped with this setting.
|
2018-07-27 16:37:13 +02:00
|
|
|
+
|
2018-07-27 16:37:17 +02:00
|
|
|
Like `fsck.<msg-id>` this variable has corresponding
|
|
|
|
`receive.fsck.skipList` and `fetch.fsck.skipList` variants.
|
2018-07-27 16:37:18 +02:00
|
|
|
+
|
|
|
|
Unlike variables like `color.ui` and `core.editor` the
|
|
|
|
`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
|
|
|
|
fall back on the `fsck.skipList` configuration if they aren't set. To
|
|
|
|
uniformly configure the same fsck settings in different circumstances
|
|
|
|
all three of them they must all set to the same values.
|
fsck: document and test sorted skipList input
Ever since the skipList support was first added in cd94c6f91 ("fsck:
git receive-pack: support excluding objects from fsck'ing",
2015-06-22) the documentation for the format has that the file is a
sorted list of object names.
Thus, anyone using the feature would have thought the list needed to
be sorted. E.g. I recently in conjunction with my fetch.fsck.*
implementation in 1362df0d41 ("fetch: implement fetch.fsck.*",
2018-07-27) wrote some code to ship a skipList, and went out of my way
to sort it.
Doing so seems intuitive, since it contains fixed-width records, and
has no support for comments, so one might expect it to be binary
searched in-place on-disk.
However, as documented here this was never a requirement, so let's
change the documentation. Since this is a file format change let's
also document what was said about this in the past, so e.g. someone
like myself reading the new docs can see this never needed to be
sorted ("why do I have all this code to sort this thing...").
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-09-03 16:49:21 +02:00
|
|
|
+
|
|
|
|
Older versions of Git (before 2.20) documented that the object names
|
|
|
|
list should be sorted. This was never a requirement, the object names
|
2018-09-03 16:49:27 +02:00
|
|
|
could appear in any order, but when reading the list we tracked whether
|
|
|
|
the list was sorted for the purposes of an internal binary search
|
|
|
|
implementation, which could save itself some work with an already sorted
|
|
|
|
list. Unless you had a humongous list there was no reason to go out of
|
|
|
|
your way to pre-sort the list. After Git version 2.20 a hash implementation
|
|
|
|
is used instead, so there's now no reason to pre-sort the list.
|
2015-06-22 17:27:23 +02:00
|
|
|
|
gc --aggressive: make --depth configurable
When 1c192f3 (gc --aggressive: make it really aggressive - 2007-12-06)
made --depth=250 the default value, it didn't really explain the
reason behind, especially the pros and cons of --depth=250.
An old mail from Linus below explains it at length. Long story short,
--depth=250 is a disk saver and a performance killer. Not everybody
agrees on that aggressiveness. Let the user configure it.
From: Linus Torvalds <torvalds@linux-foundation.org>
Subject: Re: [PATCH] gc --aggressive: make it really aggressive
Date: Thu, 6 Dec 2007 08:19:24 -0800 (PST)
Message-ID: <alpine.LFD.0.9999.0712060803430.13796@woody.linux-foundation.org>
Gmane-URL: http://article.gmane.org/gmane.comp.gcc.devel/94637
On Thu, 6 Dec 2007, Harvey Harrison wrote:
>
> 7:41:25elapsed 86%CPU
Heh. And this is why you want to do it exactly *once*, and then just
export the end result for others ;)
> -r--r--r-- 1 hharrison hharrison 324094684 2007-12-06 07:26 pack-1d46...pack
But yeah, especially if you allow longer delta chains, the end result can
be much smaller (and what makes the one-time repack more expensive is the
window size, not the delta chain - you could make the delta chains longer
with no cost overhead at packing time)
HOWEVER.
The longer delta chains do make it potentially much more expensive to then
use old history. So there's a trade-off. And quite frankly, a delta depth
of 250 is likely going to cause overflows in the delta cache (which is
only 256 entries in size *and* it's a hash, so it's going to start having
hash conflicts long before hitting the 250 depth limit).
So when I said "--depth=250 --window=250", I chose those numbers more as
an example of extremely aggressive packing, and I'm not at all sure that
the end result is necessarily wonderfully usable. It's going to save disk
space (and network bandwidth - the delta's will be re-used for the network
protocol too!), but there are definitely downsides too, and using long
delta chains may simply not be worth it in practice.
(And some of it might just want to have git tuning, ie if people think
that long deltas are worth it, we could easily just expand on the delta
hash, at the cost of some more memory used!)
That said, the good news is that working with *new* history will not be
affected negatively, and if you want to be _really_ sneaky, there are ways
to say "create a pack that contains the history up to a version one year
ago, and be very aggressive about those old versions that we still want to
have around, but do a separate pack for newer stuff using less aggressive
parameters"
So this is something that can be tweaked, although we don't really have
any really nice interfaces for stuff like that (ie the git delta cache
size is hardcoded in the sources and cannot be set in the config file, and
the "pack old history more aggressively" involves some manual scripting
and knowing how "git pack-objects" works rather than any nice simple
command line switch).
So the thing to take away from this is:
- git is certainly flexible as hell
- .. but to get the full power you may need to tweak things
- .. happily you really only need to have one person to do the tweaking,
and the tweaked end results will be available to others that do not
need to know/care.
And whether the difference between 320MB and 500MB is worth any really
involved tweaking (considering the potential downsides), I really don't
know. Only testing will tell.
Linus
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-03-16 14:35:03 +01:00
|
|
|
gc.aggressiveDepth::
|
|
|
|
The depth parameter used in the delta compression
|
|
|
|
algorithm used by 'git gc --aggressive'. This defaults
|
gc: default aggressive depth to 50
This commit message is long and has lots of background and
numbers. The summary is: the current default of 250 doesn't
save much space, and costs CPU. It's not a good tradeoff.
Read on for details.
The "--aggressive" flag to git-gc does three things:
1. use "-f" to throw out existing deltas and recompute from
scratch
2. use "--window=250" to look harder for deltas
3. use "--depth=250" to make longer delta chains
Items (1) and (2) are good matches for an "aggressive"
repack. They ask the repack to do more computation work in
the hopes of getting a better pack. You pay the costs during
the repack, and other operations see only the benefit.
Item (3) is not so clear. Allowing longer chains means fewer
restrictions on the deltas, which means potentially finding
better ones and saving some space. But it also means that
operations which access the deltas have to follow longer
chains, which affects their performance. So it's a tradeoff,
and it's not clear that the tradeoff is even a good one.
The existing "250" numbers for "--aggressive" come
originally from this thread:
http://public-inbox.org/git/alpine.LFD.0.9999.0712060803430.13796@woody.linux-foundation.org/
where Linus says:
So when I said "--depth=250 --window=250", I chose those
numbers more as an example of extremely aggressive
packing, and I'm not at all sure that the end result is
necessarily wonderfully usable. It's going to save disk
space (and network bandwidth - the delta's will be re-used
for the network protocol too!), but there are definitely
downsides too, and using long delta chains may
simply not be worth it in practice.
There are some numbers in that thread, but they're mostly
focused on the improved window size, and measure the
improvement from --depth=250 and --window=250 together.
E.g.:
http://public-inbox.org/git/9e4733910712062006l651571f3w7f76ce64c6650dff@mail.gmail.com/
talks about the improved run-time of "git-blame", which
comes from the reduced pack size. But most of that reduction
is coming from --window=250, whereas most of the extra costs
come from --depth=250. There's a link in that thread showing
that increasing the depth beyond 50 doesn't seem to help
much with the size:
https://vcscompare.blogspot.com/2008/06/git-repack-parameters.html
but again, no discussion of the timing impact.
In an earlier thread from Ted Ts'o which discussed setting
the non-aggressive default (from 10 to 50):
http://public-inbox.org/git/20070509134958.GA21489%40thunk.org/
we have more numbers, with the conclusion that going past 50
does not help size much, and hurts the speed of normal
operations.
So from that, we might guess that 50 is actually a sweet
spot, even for aggressive, if we interpret aggressive to
"spend time now to make a better pack". It is not clear that
"--depth=250" is actually a better pack. It may be slightly
_smaller_, but it carries a run-time penalty.
Here are some more recent timings I did to verify that. They
show three things:
- the size of the resulting pack (so disk saved to store,
bandwidth saved on clones/fetches)
- the cost of "rev-list --objects --all", which shows the
effect of the delta chains on trees (commits typically
don't delta, and the command doesn't touch the blobs at
all)
- the cost of "log -Sfoo", which will additionally access
each blob
All cases were repacked with "git repack -adf --depth=$d
--window=250" (so basically, what would happen if we tweaked
the "gc --aggressive" default depth).
The timings are all wall-clock best-of-3. The machine itself
has plenty of RAM compared to the repositories (which is
probably typical of most workstations these days), so we're
really measuring CPU usage, as the whole thing will be in
disk cache after the first run.
The core.deltaBaseCacheLimit is at its default of 96MiB.
It's possible that tweaking it would have some impact on the
tests, as some of them (especially "log -S" on a large repo)
are likely to overflow that. But bumping that carries a
run-time memory cost, so for these tests, I focused on what
we could do just with the on-disk pack tradeoffs.
Each test is done for four depths: 250 (the current value),
50 (the current default that tested well previously), 100
(to show something on the larger side, which previous tests
showed was not a good tradeoff), and 10 (the very old
default, which previous tests showed was worse than 50).
Here are the numbers for linux.git:
depth | size | % | rev-list | % | log -Sfoo | %
-------+-------+-------+----------+--------+-----------+-------
250 | 967MB | n/a | 48.159s | n/a | 378.088 | n/a
100 | 971MB | +0.4% | 41.471s | -13.9% | 342.060 | -9.5%
50 | 979MB | +1.2% | 37.778s | -21.6% | 311.040s | -17.7%
10 | 1.1GB | +6.6% | 32.518s | -32.5% | 279.890s | -25.9%
and for git.git:
depth | size | % | rev-list | % | log -Sfoo | %
-------+-------+-------+----------+--------+-----------+-------
250 | 48MB | n/a | 2.215s | n/a | 20.922s | n/a
100 | 49MB | +0.5% | 2.140s | -3.4% | 17.736s | -15.2%
50 | 49MB | +1.7% | 2.099s | -5.2% | 15.418s | -26.3%
10 | 53MB | +9.3% | 2.001s | -9.7% | 12.677s | -39.4%
You can see that that the CPU savings for regular operations improves as we
decrease the depth. The savings are less for "rev-list" on a smaller repository
than they are for blob-accessing operations, or even rev-list on a larger
repository. This may mean that a larger delta cache would help (though setting
core.deltaBaseCacheLimit by itself doesn't).
But we can also see that the space savings are not that great as the depth goes
higher. Saving 5-10% between 10 and 50 is probably worth the CPU tradeoff.
Saving 1% to go from 50 to 100, or another 0.5% to go from 100 to 250 is
probably not.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-08-11 18:13:09 +02:00
|
|
|
to 50.
|
gc --aggressive: make --depth configurable
When 1c192f3 (gc --aggressive: make it really aggressive - 2007-12-06)
made --depth=250 the default value, it didn't really explain the
reason behind, especially the pros and cons of --depth=250.
An old mail from Linus below explains it at length. Long story short,
--depth=250 is a disk saver and a performance killer. Not everybody
agrees on that aggressiveness. Let the user configure it.
From: Linus Torvalds <torvalds@linux-foundation.org>
Subject: Re: [PATCH] gc --aggressive: make it really aggressive
Date: Thu, 6 Dec 2007 08:19:24 -0800 (PST)
Message-ID: <alpine.LFD.0.9999.0712060803430.13796@woody.linux-foundation.org>
Gmane-URL: http://article.gmane.org/gmane.comp.gcc.devel/94637
On Thu, 6 Dec 2007, Harvey Harrison wrote:
>
> 7:41:25elapsed 86%CPU
Heh. And this is why you want to do it exactly *once*, and then just
export the end result for others ;)
> -r--r--r-- 1 hharrison hharrison 324094684 2007-12-06 07:26 pack-1d46...pack
But yeah, especially if you allow longer delta chains, the end result can
be much smaller (and what makes the one-time repack more expensive is the
window size, not the delta chain - you could make the delta chains longer
with no cost overhead at packing time)
HOWEVER.
The longer delta chains do make it potentially much more expensive to then
use old history. So there's a trade-off. And quite frankly, a delta depth
of 250 is likely going to cause overflows in the delta cache (which is
only 256 entries in size *and* it's a hash, so it's going to start having
hash conflicts long before hitting the 250 depth limit).
So when I said "--depth=250 --window=250", I chose those numbers more as
an example of extremely aggressive packing, and I'm not at all sure that
the end result is necessarily wonderfully usable. It's going to save disk
space (and network bandwidth - the delta's will be re-used for the network
protocol too!), but there are definitely downsides too, and using long
delta chains may simply not be worth it in practice.
(And some of it might just want to have git tuning, ie if people think
that long deltas are worth it, we could easily just expand on the delta
hash, at the cost of some more memory used!)
That said, the good news is that working with *new* history will not be
affected negatively, and if you want to be _really_ sneaky, there are ways
to say "create a pack that contains the history up to a version one year
ago, and be very aggressive about those old versions that we still want to
have around, but do a separate pack for newer stuff using less aggressive
parameters"
So this is something that can be tweaked, although we don't really have
any really nice interfaces for stuff like that (ie the git delta cache
size is hardcoded in the sources and cannot be set in the config file, and
the "pack old history more aggressively" involves some manual scripting
and knowing how "git pack-objects" works rather than any nice simple
command line switch).
So the thing to take away from this is:
- git is certainly flexible as hell
- .. but to get the full power you may need to tweak things
- .. happily you really only need to have one person to do the tweaking,
and the tweaked end results will be available to others that do not
need to know/care.
And whether the difference between 320MB and 500MB is worth any really
involved tweaking (considering the potential downsides), I really don't
know. Only testing will tell.
Linus
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-03-16 14:35:03 +01:00
|
|
|
|
2007-05-09 21:48:39 +02:00
|
|
|
gc.aggressiveWindow::
|
|
|
|
The window size parameter used in the delta compression
|
2010-01-10 00:33:00 +01:00
|
|
|
algorithm used by 'git gc --aggressive'. This defaults
|
2010-04-13 18:52:55 +02:00
|
|
|
to 250.
|
2007-05-09 21:48:39 +02:00
|
|
|
|
2007-09-17 09:39:52 +02:00
|
|
|
gc.auto::
|
|
|
|
When there are approximately more than this many loose
|
|
|
|
objects in the repository, `git gc --auto` will pack them.
|
|
|
|
Some Porcelain commands use this command to perform a
|
2008-01-11 22:11:13 +01:00
|
|
|
light-weight garbage collection from time to time. The
|
|
|
|
default value is 6700. Setting this to 0 disables it.
|
2007-09-17 09:39:52 +02:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
gc.autoPackLimit::
|
2007-09-17 09:55:13 +02:00
|
|
|
When there are more than this many packs that are not
|
|
|
|
marked with `*.keep` file in the repository, `git gc
|
2008-01-11 22:11:13 +01:00
|
|
|
--auto` consolidates them into one larger pack. The
|
2008-03-23 08:04:48 +01:00
|
|
|
default value is 50. Setting this to 0 disables it.
|
2007-09-17 09:55:13 +02:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
gc.autoDetach::
|
2014-11-03 21:37:07 +01:00
|
|
|
Make `git gc --auto` return immediately and run in background
|
2014-02-08 08:08:52 +01:00
|
|
|
if the system supports it. Default is true.
|
|
|
|
|
2018-04-15 17:36:15 +02:00
|
|
|
gc.bigPackThreshold::
|
|
|
|
If non-zero, all packs larger than this limit are kept when
|
|
|
|
`git gc` is run. This is very similar to `--keep-base-pack`
|
|
|
|
except that all packs that meet the threshold are kept, not
|
|
|
|
just the base pack. Defaults to zero. Common unit suffixes of
|
|
|
|
'k', 'm', or 'g' are supported.
|
2018-04-15 17:36:16 +02:00
|
|
|
+
|
|
|
|
Note that if the number of kept packs is more than gc.autoPackLimit,
|
|
|
|
this configuration variable is ignored, all packs except the base pack
|
|
|
|
will be repacked. After this the number of packs should go below
|
|
|
|
gc.autoPackLimit and gc.bigPackThreshold should be respected again.
|
2018-04-15 17:36:15 +02:00
|
|
|
|
2018-08-23 17:51:19 +02:00
|
|
|
gc.writeCommitGraph::
|
|
|
|
If true, then gc will rewrite the commit-graph file when
|
|
|
|
linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
|
|
|
|
'--auto' the commit-graph will be updated if housekeeping is
|
|
|
|
required. Default is false. See linkgit:git-commit-graph[1]
|
|
|
|
for details.
|
|
|
|
|
gc: ignore old gc.log files
A server can end up in a state where there are lots of unreferenced
loose objects (say, because many users are doing a bunch of rebasing
and pushing their rebased branches). Running "git gc --auto" in
this state would cause a gc.log file to be created, preventing
future auto gcs, causing pack files to pile up. Since many git
operations are O(n) in the number of pack files, this would lead to
poor performance.
Git should never get itself into a state where it refuses to do any
maintenance, just because at some point some piece of the maintenance
didn't make progress.
Teach Git to ignore gc.log files which are older than (by default)
one day old, which can be tweaked via the gc.logExpiry configuration
variable. That way, these pack files will get cleaned up, if
necessary, at least once per day. And operators who find a need for
more-frequent gcs can adjust gc.logExpiry to meet their needs.
There is also some cleanup: a successful manual gc, or a
warning-free auto gc with an old log file, will remove any old
gc.log files.
It might still happen that manual intervention is required
(e.g. because the repo is corrupt), but at the very least it won't
be because Git is too dumb to try again.
Signed-off-by: David Turner <dturner@twosigma.com>
Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-02-10 22:28:22 +01:00
|
|
|
gc.logExpiry::
|
gc: do not return error for prior errors in daemonized mode
Some build machines started consistently failing to fetch updated
source using "repo sync", with error
error: The last gc run reported the following. Please correct the root cause
and remove /build/.repo/projects/tools/git.git/gc.log.
Automatic cleanup will not be performed until the file is removed.
warning: There are too many unreachable loose objects; run 'git prune' to remove them.
The cause takes some time to describe.
In v2.0.0-rc0~145^2 (gc: config option for running --auto in
background, 2014-02-08), "git gc --auto" learned to run in the
background instead of blocking the invoking command. In this mode, it
closed stderr to avoid interleaving output with any subsequent
commands, causing warnings like the above to be swallowed; v2.6.3~24^2
(gc: save log from daemonized gc --auto and print it next time,
2015-09-19) addressed that by storing any diagnostic output in
.git/gc.log and allowing the next "git gc --auto" run to print it.
To avoid wasteful repeated fruitless gcs, when gc.log is present, the
subsequent "gc --auto" would die after printing its contents. Most
git commands, such as "git fetch", ignore the exit status from "git gc
--auto" so all is well at this point: the user gets to see the error
message, and the fetch succeeds, without a wasteful additional attempt
at an automatic gc.
External tools like repo[1], though, do care about the exit status
from "git gc --auto". In non-daemonized mode, the exit status is
straightforward: if there is an error, it is nonzero, but after a
warning like the above, the status is zero. The daemonized mode, as a
side effect of the other properties provided, offers a very strange
exit code convention:
- if no housekeeping was required, the exit status is 0
- the first real run, after forking into the background, returns exit
status 0 unconditionally. The parent process has no way to know
whether gc will succeed.
- if there is any diagnostic output in gc.log, subsequent runs return
a nonzero exit status to indicate that gc was not triggered.
There's nothing for the calling program to act on on the basis of that
error. Use status 0 consistently instead, to indicate that we decided
not to run a gc (just like if no housekeeping was required). This
way, repo and similar tools can get the benefit of the same behavior
as tools like "git fetch" that ignore the exit status from gc --auto.
Once the period of time described by gc.pruneExpire elapses, the
unreachable loose objects will be removed by "git gc --auto"
automatically.
[1] https://gerrit-review.googlesource.com/c/git-repo/+/10598/
Reported-by: Andrii Dehtiarov <adehtiarov@google.com>
Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-07-17 08:57:40 +02:00
|
|
|
If the file gc.log exists, then `git gc --auto` will print
|
|
|
|
its content and exit with status zero instead of running
|
gc: ignore old gc.log files
A server can end up in a state where there are lots of unreferenced
loose objects (say, because many users are doing a bunch of rebasing
and pushing their rebased branches). Running "git gc --auto" in
this state would cause a gc.log file to be created, preventing
future auto gcs, causing pack files to pile up. Since many git
operations are O(n) in the number of pack files, this would lead to
poor performance.
Git should never get itself into a state where it refuses to do any
maintenance, just because at some point some piece of the maintenance
didn't make progress.
Teach Git to ignore gc.log files which are older than (by default)
one day old, which can be tweaked via the gc.logExpiry configuration
variable. That way, these pack files will get cleaned up, if
necessary, at least once per day. And operators who find a need for
more-frequent gcs can adjust gc.logExpiry to meet their needs.
There is also some cleanup: a successful manual gc, or a
warning-free auto gc with an old log file, will remove any old
gc.log files.
It might still happen that manual intervention is required
(e.g. because the repo is corrupt), but at the very least it won't
be because Git is too dumb to try again.
Signed-off-by: David Turner <dturner@twosigma.com>
Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-02-10 22:28:22 +01:00
|
|
|
unless that file is more than 'gc.logExpiry' old. Default is
|
|
|
|
"1.day". See `gc.pruneExpire` for more ways to specify its
|
|
|
|
value.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
gc.packRefs::
|
2010-01-10 03:59:41 +01:00
|
|
|
Running `git pack-refs` in a repository renders it
|
|
|
|
unclonable by Git versions prior to 1.5.1.2 over dumb
|
|
|
|
transports such as HTTP. This variable determines whether
|
2010-12-16 08:16:49 +01:00
|
|
|
'git gc' runs `git pack-refs`. This can be set to `notbare`
|
2010-01-10 03:59:41 +01:00
|
|
|
to enable it within all non-bare repos or it can be set to a
|
|
|
|
boolean value. The default is `true`.
|
2007-02-13 14:01:42 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
gc.pruneExpire::
|
2010-01-10 00:33:00 +01:00
|
|
|
When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
|
2008-12-30 20:45:11 +01:00
|
|
|
Override the grace period with this config variable. The value
|
2015-07-28 22:06:10 +02:00
|
|
|
"now" may be used to disable this grace period and always prune
|
|
|
|
unreachable objects immediately, or "never" may be used to
|
2016-11-15 20:08:51 +01:00
|
|
|
suppress pruning. This feature helps prevent corruption when
|
|
|
|
'git gc' runs concurrently with another process writing to the
|
|
|
|
repository; see the "NOTES" section of linkgit:git-gc[1].
|
gc: call "prune --expire 2.weeks.ago" by default
The only reason we did not call "prune" in git-gc was that it is an
inherently dangerous operation: if there is a commit going on, you will
prune loose objects that were just created, and are, in fact, needed by the
commit object just about to be created.
Since it is dangerous, we told users so. That led to many users not even
daring to run it when it was actually safe. Besides, they are users, and
should not have to remember such details as when to call git-gc with
--prune, or to call git-prune directly.
Of course, the consequence was that "git gc --auto" gets triggered much
more often than we would like, since unreferenced loose objects (such as
left-overs from a rebase or a reset --hard) were never pruned.
Alas, git-prune recently learnt the option --expire <minimum-age>, which
makes it a much safer operation. This allows us to call prune from git-gc,
with a grace period of 2 weeks for the unreferenced loose objects (this
value was determined in a discussion on the git list as a safe one).
If you want to override this grace period, just set the config variable
gc.pruneExpire to a different value; an example would be
[gc]
pruneExpire = 6.months.ago
or even "never", if you feel really paranoid.
Note that this new behaviour makes "--prune" be a no-op.
While adding a test to t5304-prune.sh (since it really tests the implicit
call to "prune"), also the original test for "prune --expire" was moved
there from t1410-reflog.sh, where it did not belong.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
2008-03-12 21:55:47 +01:00
|
|
|
|
2015-07-20 07:29:22 +02:00
|
|
|
gc.worktreePruneExpire::
|
2015-07-20 07:29:21 +02:00
|
|
|
When 'git gc' is run, it calls
|
2015-07-20 07:29:20 +02:00
|
|
|
'git worktree prune --expire 3.months.ago'.
|
2015-07-20 07:29:21 +02:00
|
|
|
This config variable can be used to set a different grace
|
|
|
|
period. The value "now" may be used to disable the grace
|
2016-05-04 21:24:48 +02:00
|
|
|
period and prune `$GIT_DIR/worktrees` immediately, or "never"
|
2015-07-28 22:06:10 +02:00
|
|
|
may be used to suppress pruning.
|
2014-11-30 09:24:53 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
gc.reflogExpire::
|
|
|
|
gc.<pattern>.reflogExpire::
|
2010-01-10 00:33:00 +01:00
|
|
|
'git reflog expire' removes reflog entries older than
|
2015-07-28 22:06:10 +02:00
|
|
|
this time; defaults to 90 days. The value "now" expires all
|
|
|
|
entries immediately, and "never" suppresses expiration
|
|
|
|
altogether. With "<pattern>" (e.g.
|
2010-04-14 22:12:34 +02:00
|
|
|
"refs/stash") in the middle the setting applies only to
|
|
|
|
the refs that match the <pattern>.
|
2006-12-27 10:47:57 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
gc.reflogExpireUnreachable::
|
2015-08-21 17:06:18 +02:00
|
|
|
gc.<pattern>.reflogExpireUnreachable::
|
2010-01-10 00:33:00 +01:00
|
|
|
'git reflog expire' removes reflog entries older than
|
2006-12-27 10:47:57 +01:00
|
|
|
this time and are not reachable from the current tip;
|
2015-07-28 22:06:10 +02:00
|
|
|
defaults to 30 days. The value "now" expires all entries
|
|
|
|
immediately, and "never" suppresses expiration altogether.
|
|
|
|
With "<pattern>" (e.g. "refs/stash")
|
2010-04-14 22:12:34 +02:00
|
|
|
in the middle, the setting applies only to the refs that
|
|
|
|
match the <pattern>.
|
2006-12-27 10:47:57 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
gc.rerereResolved::
|
2006-12-27 10:24:05 +01:00
|
|
|
Records of conflicted merge you resolved earlier are
|
2010-01-10 00:33:00 +01:00
|
|
|
kept for this many days when 'git rerere gc' is run.
|
2017-08-19 20:43:39 +02:00
|
|
|
You can also use more human-readable "1.month.ago", etc.
|
2007-12-29 07:20:38 +01:00
|
|
|
The default is 60 days. See linkgit:git-rerere[1].
|
2006-12-27 10:24:05 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
gc.rerereUnresolved::
|
2006-12-27 10:24:05 +01:00
|
|
|
Records of conflicted merge you have not resolved are
|
2010-01-10 00:33:00 +01:00
|
|
|
kept for this many days when 'git rerere gc' is run.
|
2017-08-19 20:43:39 +02:00
|
|
|
You can also use more human-readable "1.month.ago", etc.
|
2007-12-29 07:20:38 +01:00
|
|
|
The default is 15 days. See linkgit:git-rerere[1].
|
2006-12-27 10:24:05 +01:00
|
|
|
|
2018-08-22 18:05:58 +02:00
|
|
|
include::gitcvs-config.txt[]
|
2007-04-13 18:13:42 +02:00
|
|
|
|
2011-10-16 13:07:34 +02:00
|
|
|
gitweb.category::
|
|
|
|
gitweb.description::
|
|
|
|
gitweb.owner::
|
|
|
|
gitweb.url::
|
|
|
|
See linkgit:gitweb[1] for description.
|
|
|
|
|
|
|
|
gitweb.avatar::
|
|
|
|
gitweb.blame::
|
|
|
|
gitweb.grep::
|
|
|
|
gitweb.highlight::
|
|
|
|
gitweb.patches::
|
|
|
|
gitweb.pickaxe::
|
|
|
|
gitweb.remote_heads::
|
2015-03-11 21:32:45 +01:00
|
|
|
gitweb.showSizes::
|
2011-10-16 13:07:34 +02:00
|
|
|
gitweb.snapshot::
|
|
|
|
See linkgit:gitweb.conf[5] for description.
|
|
|
|
|
2011-03-30 21:31:05 +02:00
|
|
|
grep.lineNumber::
|
2016-06-28 13:40:10 +02:00
|
|
|
If set to true, enable `-n` option by default.
|
2011-03-30 21:31:05 +02:00
|
|
|
|
2018-06-22 17:49:49 +02:00
|
|
|
grep.column::
|
|
|
|
If set to true, enable the `--column` option by default.
|
|
|
|
|
grep: add a grep.patternType configuration setting
The grep.extendedRegexp configuration setting enables the -E flag on grep
by default but there are no equivalents for the -G, -F and -P flags.
Rather than adding an additional setting for grep.fooRegexp for current
and future pattern matching options, add a grep.patternType setting that
can accept appropriate values for modifying the default grep pattern
matching behavior. The current values are "basic", "extended", "fixed",
"perl" and "default" for setting -G, -E, -F, -P and the default behavior
respectively.
When grep.patternType is set to a value other than "default", the
grep.extendedRegexp setting is ignored. The value of "default" restores
the current default behavior, including the grep.extendedRegexp
behavior.
Signed-off-by: J Smith <dark.panda@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-03 16:53:50 +02:00
|
|
|
grep.patternType::
|
|
|
|
Set the default matching behavior. Using a value of 'basic', 'extended',
|
2016-06-28 13:40:11 +02:00
|
|
|
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
|
|
|
|
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
|
grep: add a grep.patternType configuration setting
The grep.extendedRegexp configuration setting enables the -E flag on grep
by default but there are no equivalents for the -G, -F and -P flags.
Rather than adding an additional setting for grep.fooRegexp for current
and future pattern matching options, add a grep.patternType setting that
can accept appropriate values for modifying the default grep pattern
matching behavior. The current values are "basic", "extended", "fixed",
"perl" and "default" for setting -G, -E, -F, -P and the default behavior
respectively.
When grep.patternType is set to a value other than "default", the
grep.extendedRegexp setting is ignored. The value of "default" restores
the current default behavior, including the grep.extendedRegexp
behavior.
Signed-off-by: J Smith <dark.panda@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-03 16:53:50 +02:00
|
|
|
value 'default' will return to the default matching behavior.
|
|
|
|
|
2011-03-30 21:31:05 +02:00
|
|
|
grep.extendedRegexp::
|
2016-06-28 13:40:11 +02:00
|
|
|
If set to true, enable `--extended-regexp` option by default. This
|
2016-06-08 19:23:16 +02:00
|
|
|
option is ignored when the `grep.patternType` option is set to a value
|
grep: add a grep.patternType configuration setting
The grep.extendedRegexp configuration setting enables the -E flag on grep
by default but there are no equivalents for the -G, -F and -P flags.
Rather than adding an additional setting for grep.fooRegexp for current
and future pattern matching options, add a grep.patternType setting that
can accept appropriate values for modifying the default grep pattern
matching behavior. The current values are "basic", "extended", "fixed",
"perl" and "default" for setting -G, -E, -F, -P and the default behavior
respectively.
When grep.patternType is set to a value other than "default", the
grep.extendedRegexp setting is ignored. The value of "default" restores
the current default behavior, including the grep.extendedRegexp
behavior.
Signed-off-by: J Smith <dark.panda@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-03 16:53:50 +02:00
|
|
|
other than 'default'.
|
2011-03-30 21:31:05 +02:00
|
|
|
|
2015-12-15 16:31:39 +01:00
|
|
|
grep.threads::
|
|
|
|
Number of grep worker threads to use.
|
|
|
|
See `grep.threads` in linkgit:git-grep[1] for more information.
|
|
|
|
|
2016-01-12 11:40:26 +01:00
|
|
|
grep.fallbackToNoIndex::
|
|
|
|
If set to true, fall back to git grep --no-index if git grep
|
|
|
|
is executed outside of a git repository. Defaults to false.
|
|
|
|
|
2011-11-29 21:29:48 +01:00
|
|
|
gpg.program::
|
2016-05-04 21:24:48 +02:00
|
|
|
Use this custom program instead of "`gpg`" found on `$PATH` when
|
2011-11-29 21:29:48 +01:00
|
|
|
making or verifying a PGP signature. The program must support the
|
2014-05-21 20:52:26 +02:00
|
|
|
same command-line interface as GPG, namely, to verify a detached
|
2016-05-04 21:24:48 +02:00
|
|
|
signature, "`gpg --verify $file - <$signature`" is run, and the
|
2011-11-29 21:29:48 +01:00
|
|
|
program is expected to signal a good signature by exiting with
|
2014-11-03 21:37:07 +01:00
|
|
|
code 0, and to generate an ASCII-armored detached signature, the
|
2016-05-04 21:24:48 +02:00
|
|
|
standard input of "`gpg -bsau $key`" is fed with the contents to be
|
2011-11-29 21:29:48 +01:00
|
|
|
signed, and the program is expected to send the result to its
|
|
|
|
standard output.
|
|
|
|
|
2018-07-17 14:50:07 +02:00
|
|
|
gpg.format::
|
|
|
|
Specifies which key format to use when signing with `--gpg-sign`.
|
2018-07-17 14:50:12 +02:00
|
|
|
Default is "openpgp" and another possible value is "x509".
|
2018-07-17 14:50:07 +02:00
|
|
|
|
2018-07-17 14:50:11 +02:00
|
|
|
gpg.<format>.program::
|
|
|
|
Use this to customize the program used for the signing format you
|
|
|
|
chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
|
2018-07-17 14:50:12 +02:00
|
|
|
be used as a legacy synonym for `gpg.openpgp.program`. The default
|
|
|
|
value for `gpg.x509.program` is "gpgsm".
|
2018-07-17 14:50:11 +02:00
|
|
|
|
2018-08-22 18:05:59 +02:00
|
|
|
include::gui-config.txt[]
|
2008-11-13 18:28:49 +01:00
|
|
|
|
2008-12-14 20:44:32 +01:00
|
|
|
guitool.<name>.cmd::
|
|
|
|
Specifies the shell command line to execute when the corresponding item
|
|
|
|
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
|
2016-06-08 00:35:06 +02:00
|
|
|
the tool as `GIT_GUITOOL`, the name of the currently selected file as
|
2008-12-14 20:44:32 +01:00
|
|
|
'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
|
|
|
|
the head is detached, 'CUR_BRANCH' is empty).
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
guitool.<name>.needsFile::
|
2008-12-14 20:44:32 +01:00
|
|
|
Run the tool only if a diff is selected in the GUI. It guarantees
|
|
|
|
that 'FILENAME' is not empty.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
guitool.<name>.noConsole::
|
2008-12-14 20:44:32 +01:00
|
|
|
Run the command silently, without creating a window to display its
|
|
|
|
output.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
guitool.<name>.noRescan::
|
2008-12-14 20:44:32 +01:00
|
|
|
Don't rescan the working directory for changes after the tool
|
|
|
|
finishes execution.
|
|
|
|
|
|
|
|
guitool.<name>.confirm::
|
|
|
|
Show a confirmation dialog before actually running the tool.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
guitool.<name>.argPrompt::
|
2008-12-14 20:44:32 +01:00
|
|
|
Request a string argument from the user, and pass it to the tool
|
2016-06-08 00:35:07 +02:00
|
|
|
through the `ARGS` environment variable. Since requesting an
|
2008-12-14 20:44:32 +01:00
|
|
|
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
|
|
|
|
value of the variable is used.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
guitool.<name>.revPrompt::
|
2008-12-14 20:44:32 +01:00
|
|
|
Request a single valid revision from the user, and set the
|
2016-06-08 00:35:07 +02:00
|
|
|
`REVISION` environment variable. In other aspects this option
|
2015-03-11 21:32:45 +01:00
|
|
|
is similar to 'argPrompt', and can be used together with it.
|
2008-12-14 20:44:32 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
guitool.<name>.revUnmerged::
|
|
|
|
Show only unmerged branches in the 'revPrompt' subdialog.
|
2008-12-14 20:44:32 +01:00
|
|
|
This is useful for tools similar to merge or rebase, but not
|
|
|
|
for things like checkout or reset.
|
|
|
|
|
|
|
|
guitool.<name>.title::
|
|
|
|
Specifies the title to use for the prompt dialog. The default
|
|
|
|
is the tool name.
|
|
|
|
|
|
|
|
guitool.<name>.prompt::
|
|
|
|
Specifies the general prompt string to display at the top of
|
2015-03-11 21:32:45 +01:00
|
|
|
the dialog, before subsections for 'argPrompt' and 'revPrompt'.
|
2008-12-14 20:44:32 +01:00
|
|
|
The default value includes the actual command.
|
|
|
|
|
2008-01-08 04:55:14 +01:00
|
|
|
help.browser::
|
|
|
|
Specify the browser that will be used to display help in the
|
|
|
|
'web' format. See linkgit:git-help[1].
|
|
|
|
|
|
|
|
help.format::
|
|
|
|
Override the default help format used by linkgit:git-help[1].
|
|
|
|
Values 'man', 'info', 'web' and 'html' are supported. 'man' is
|
|
|
|
the default. 'web' and 'html' are the same.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
help.autoCorrect::
|
2008-08-31 15:54:58 +02:00
|
|
|
Automatically correct and execute mistyped commands after
|
|
|
|
waiting for the given number of deciseconds (0.1 sec). If more
|
|
|
|
than one command can be deduced from the entered text, nothing
|
|
|
|
will be executed. If the value of this option is negative,
|
|
|
|
the corrected command will be executed immediately. If the
|
|
|
|
value is 0 - the command will be just shown but not executed.
|
|
|
|
This is the default.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
help.htmlPath::
|
2013-01-15 21:56:21 +01:00
|
|
|
Specify the path where the HTML documentation resides. File system paths
|
|
|
|
and URLs are supported. HTML pages will be prefixed with this path when
|
|
|
|
help is displayed in the 'web' format. This defaults to the documentation
|
|
|
|
path of your Git installation.
|
|
|
|
|
2007-11-23 01:07:00 +01:00
|
|
|
http.proxy::
|
2012-03-04 17:50:43 +01:00
|
|
|
Override the HTTP proxy, normally configured using the 'http_proxy',
|
http: use credential API to handle proxy authentication
Currently, the only way to pass proxy credentials to curl is by including them
in the proxy URL. Usually, this means they will end up on disk unencrypted, one
way or another (by inclusion in ~/.gitconfig, shell profile or history). Since
proxy authentication often uses a domain user, credentials can be security
sensitive; therefore, a safer way of passing credentials is desirable.
If the configured proxy contains a username but not a password, query the
credential API for one. Also, make sure we approve/reject proxy credentials
properly.
For consistency reasons, add parsing of http_proxy/https_proxy/all_proxy
environment variables, which would otherwise be evaluated as a fallback by curl.
Without this, we would have different semantics for git configuration and
environment variables.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Helped-by: Elia Pinto <gitter.spiros@gmail.com>
Signed-off-by: Knut Franke <k.franke@science-computing.de>
Signed-off-by: Elia Pinto <gitter.spiros@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-01-26 14:02:48 +01:00
|
|
|
'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
|
|
|
|
addition to the syntax understood by curl, it is possible to specify a
|
|
|
|
proxy string with a user name but no password, in which case git will
|
|
|
|
attempt to acquire one in the same way it does for other credentials. See
|
|
|
|
linkgit:gitcredentials[7] for more information. The syntax thus is
|
|
|
|
'[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
|
|
|
|
on a per-remote basis; see remote.<name>.proxy
|
2007-11-23 01:07:00 +01:00
|
|
|
|
2016-01-26 14:02:47 +01:00
|
|
|
http.proxyAuthMethod::
|
|
|
|
Set the method with which to authenticate against the HTTP proxy. This
|
|
|
|
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`.
|
2016-06-08 00:35:06 +02:00
|
|
|
Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
|
2016-01-26 14:02:47 +01:00
|
|
|
variable. Possible values are:
|
|
|
|
+
|
|
|
|
--
|
|
|
|
* `anyauth` - Automatically pick a suitable authentication method. It is
|
|
|
|
assumed that the proxy answers an unauthenticated request with a 407
|
|
|
|
status code and one or more Proxy-authenticate headers with supported
|
|
|
|
authentication methods. This is the default.
|
|
|
|
* `basic` - HTTP Basic authentication
|
|
|
|
* `digest` - HTTP Digest authentication; this prevents the password from being
|
|
|
|
transmitted to the proxy in clear text
|
|
|
|
* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
|
|
|
|
of `curl(1)`)
|
|
|
|
* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
|
|
|
|
--
|
2007-11-23 01:07:00 +01:00
|
|
|
|
2016-02-15 19:44:46 +01:00
|
|
|
http.emptyAuth::
|
|
|
|
Attempt authentication without seeking a username or password. This
|
|
|
|
can be used to attempt GSS-Negotiate authentication without specifying
|
|
|
|
a username in the URL, as libcurl normally requires a username for
|
|
|
|
authentication.
|
|
|
|
|
2016-09-28 20:01:34 +02:00
|
|
|
http.delegation::
|
|
|
|
Control GSSAPI credential delegation. The delegation is disabled
|
|
|
|
by default in libcurl since version 7.21.7. Set parameter to tell
|
|
|
|
the server what it is allowed to delegate when it comes to user
|
|
|
|
credentials. Used with GSS/kerberos. Possible values are:
|
|
|
|
+
|
|
|
|
--
|
|
|
|
* `none` - Don't allow any delegation.
|
|
|
|
* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
|
|
|
|
Kerberos service ticket, which is a matter of realm policy.
|
|
|
|
* `always` - Unconditionally allow the server to delegate.
|
|
|
|
--
|
|
|
|
|
|
|
|
|
2016-04-27 14:20:37 +02:00
|
|
|
http.extraHeader::
|
|
|
|
Pass an additional HTTP header when communicating with a server. If
|
|
|
|
more than one such entry exists, all of them are added as extra
|
|
|
|
headers. To allow overriding the settings inherited from the system
|
|
|
|
config, an empty value will reset the extra headers to the empty list.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
http.cookieFile::
|
2016-05-04 20:42:15 +02:00
|
|
|
The pathname of a file containing previously stored cookie lines,
|
|
|
|
which should be used
|
2013-01-21 20:17:53 +01:00
|
|
|
in the Git http session, if they match the server. The file format
|
2011-06-02 22:31:25 +02:00
|
|
|
of the file to read cookies from should be plain HTTP headers or
|
2016-05-04 19:36:24 +02:00
|
|
|
the Netscape/Mozilla cookie file format (see `curl(1)`).
|
2016-05-04 20:42:14 +02:00
|
|
|
NOTE that the file specified with http.cookieFile is used only as
|
2013-07-24 00:40:17 +02:00
|
|
|
input unless http.saveCookies is set.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
http.saveCookies::
|
2013-07-24 00:40:17 +02:00
|
|
|
If set, store cookies received during requests to the file specified by
|
2015-03-11 21:32:45 +01:00
|
|
|
http.cookieFile. Has no effect if http.cookieFile is unset.
|
2011-06-02 22:31:25 +02:00
|
|
|
|
2015-08-14 21:37:43 +02:00
|
|
|
http.sslVersion::
|
|
|
|
The SSL version to use when negotiating an SSL connection, if you
|
|
|
|
want to force the default. The available and default version
|
|
|
|
depend on whether libcurl was built against NSS or OpenSSL and the
|
|
|
|
particular configuration of the crypto library in use. Internally
|
|
|
|
this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
|
|
|
|
documentation for more details on the format of this option and
|
|
|
|
for the ssl version supported. Actually the possible values of
|
|
|
|
this option are:
|
|
|
|
|
|
|
|
- sslv2
|
|
|
|
- sslv3
|
|
|
|
- tlsv1
|
|
|
|
- tlsv1.0
|
|
|
|
- tlsv1.1
|
|
|
|
- tlsv1.2
|
2018-03-29 12:14:18 +02:00
|
|
|
- tlsv1.3
|
2015-08-14 21:37:43 +02:00
|
|
|
|
|
|
|
+
|
2016-06-08 00:35:06 +02:00
|
|
|
Can be overridden by the `GIT_SSL_VERSION` environment variable.
|
2015-08-14 21:37:43 +02:00
|
|
|
To force git to use libcurl's default ssl version and ignore any
|
2016-06-08 00:35:06 +02:00
|
|
|
explicit http.sslversion option, set `GIT_SSL_VERSION` to the
|
2015-08-14 21:37:43 +02:00
|
|
|
empty string.
|
|
|
|
|
2015-05-08 15:22:15 +02:00
|
|
|
http.sslCipherList::
|
|
|
|
A list of SSL ciphers to use when negotiating an SSL connection.
|
|
|
|
The available ciphers depend on whether libcurl was built against
|
|
|
|
NSS or OpenSSL and the particular configuration of the crypto
|
|
|
|
library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
|
|
|
|
option; see the libcurl documentation for more details on the format
|
|
|
|
of this list.
|
|
|
|
+
|
2016-06-08 00:35:06 +02:00
|
|
|
Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
|
2015-05-08 15:22:15 +02:00
|
|
|
To force git to use libcurl's default cipher list and ignore any
|
2016-06-08 00:35:06 +02:00
|
|
|
explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
|
2015-05-08 15:22:15 +02:00
|
|
|
empty string.
|
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
http.sslVerify::
|
|
|
|
Whether to verify the SSL certificate when fetching or pushing
|
2017-12-16 13:32:02 +01:00
|
|
|
over HTTPS. Defaults to true. Can be overridden by the
|
|
|
|
`GIT_SSL_NO_VERIFY` environment variable.
|
2006-04-25 00:59:33 +02:00
|
|
|
|
|
|
|
http.sslCert::
|
|
|
|
File containing the SSL certificate when fetching or pushing
|
2016-06-08 00:35:06 +02:00
|
|
|
over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
|
2006-04-25 00:59:33 +02:00
|
|
|
variable.
|
|
|
|
|
|
|
|
http.sslKey::
|
|
|
|
File containing the SSL private key when fetching or pushing
|
2016-06-08 00:35:06 +02:00
|
|
|
over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
|
2006-04-25 00:59:33 +02:00
|
|
|
variable.
|
|
|
|
|
2009-05-28 05:16:03 +02:00
|
|
|
http.sslCertPasswordProtected::
|
2013-01-21 20:17:53 +01:00
|
|
|
Enable Git's password prompt for the SSL certificate. Otherwise
|
2009-05-28 05:16:03 +02:00
|
|
|
OpenSSL will prompt the user, possibly many times, if the
|
|
|
|
certificate or private key is encrypted. Can be overridden by the
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
|
2009-05-28 05:16:03 +02:00
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
http.sslCAInfo::
|
|
|
|
File containing the certificates to verify the peer with when
|
2006-06-03 22:27:26 +02:00
|
|
|
fetching or pushing over HTTPS. Can be overridden by the
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_SSL_CAINFO` environment variable.
|
2006-04-25 00:59:33 +02:00
|
|
|
|
|
|
|
http.sslCAPath::
|
|
|
|
Path containing files with the CA certificates to verify the peer
|
2006-06-07 14:56:45 +02:00
|
|
|
with when fetching or pushing over HTTPS. Can be overridden
|
2016-06-08 00:35:06 +02:00
|
|
|
by the `GIT_SSL_CAPATH` environment variable.
|
2006-04-25 00:59:33 +02:00
|
|
|
|
2018-10-15 12:14:43 +02:00
|
|
|
http.sslBackend::
|
|
|
|
Name of the SSL backend to use (e.g. "openssl" or "schannel").
|
|
|
|
This option is ignored if cURL lacks support for choosing the SSL
|
|
|
|
backend at runtime.
|
|
|
|
|
2018-10-25 20:53:55 +02:00
|
|
|
http.schannelCheckRevoke::
|
|
|
|
Used to enforce or disable certificate revocation checks in cURL
|
|
|
|
when http.sslBackend is set to "schannel". Defaults to `true` if
|
|
|
|
unset. Only necessary to disable this if Git consistently errors
|
|
|
|
and the message is about checking the revocation status of a
|
|
|
|
certificate. This option is ignored if cURL lacks support for
|
|
|
|
setting the relevant SSL option at runtime.
|
|
|
|
|
2018-10-25 20:53:56 +02:00
|
|
|
http.schannelUseSSLCAInfo::
|
|
|
|
As of cURL v7.60.0, the Secure Channel backend can use the
|
|
|
|
certificate bundle provided via `http.sslCAInfo`, but that would
|
|
|
|
override the Windows Certificate Store. Since this is not desirable
|
|
|
|
by default, Git will tell cURL not to use that bundle by default
|
|
|
|
when the `schannel` backend was configured via `http.sslBackend`,
|
|
|
|
unless `http.schannelUseSSLCAInfo` overrides this behavior.
|
|
|
|
|
2016-02-15 15:04:22 +01:00
|
|
|
http.pinnedpubkey::
|
|
|
|
Public key of the https service. It may either be the filename of
|
|
|
|
a PEM or DER encoded public key file or a string starting with
|
|
|
|
'sha256//' followed by the base64 encoded sha256 hash of the
|
|
|
|
public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
|
|
|
|
exit with an error if this option is set but not supported by
|
|
|
|
cURL.
|
|
|
|
|
2013-04-07 21:10:39 +02:00
|
|
|
http.sslTry::
|
|
|
|
Attempt to use AUTH SSL/TLS and encrypted data transfers
|
|
|
|
when connecting via regular FTP protocol. This might be needed
|
|
|
|
if the FTP server requires it for security reasons or you wish
|
|
|
|
to connect securely whenever remote FTP server supports it.
|
|
|
|
Default is false since it might trigger certificate verification
|
|
|
|
errors on misconfigured servers.
|
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
http.maxRequests::
|
2006-06-03 22:27:26 +02:00
|
|
|
How many HTTP requests to launch in parallel. Can be overridden
|
2016-06-08 00:35:06 +02:00
|
|
|
by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
|
2006-04-25 00:59:33 +02:00
|
|
|
|
2009-11-27 16:42:26 +01:00
|
|
|
http.minSessions::
|
|
|
|
The number of curl sessions (counted across slots) to be kept across
|
|
|
|
requests. They will not be ended with curl_easy_cleanup() until
|
|
|
|
http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
|
|
|
|
value will be capped at 1. Defaults to 1.
|
|
|
|
|
2009-10-31 01:47:41 +01:00
|
|
|
http.postBuffer::
|
|
|
|
Maximum size in bytes of the buffer used by smart HTTP
|
|
|
|
transports when POSTing data to the remote system.
|
|
|
|
For requests larger than this buffer size, HTTP/1.1 and
|
|
|
|
Transfer-Encoding: chunked is used to avoid creating a
|
|
|
|
massive pack file locally. Default is 1 MiB, which is
|
|
|
|
sufficient for most requests.
|
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
http.lowSpeedLimit, http.lowSpeedTime::
|
|
|
|
If the HTTP transfer speed is less than 'http.lowSpeedLimit'
|
|
|
|
for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
|
2016-06-08 00:35:06 +02:00
|
|
|
Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
|
|
|
|
`GIT_HTTP_LOW_SPEED_TIME` environment variables.
|
2006-04-25 00:59:33 +02:00
|
|
|
|
2006-09-29 02:10:44 +02:00
|
|
|
http.noEPSV::
|
|
|
|
A boolean which disables using of EPSV ftp command by curl.
|
2007-04-13 18:02:33 +02:00
|
|
|
This can helpful with some "poor" ftp servers which don't
|
2016-06-08 00:35:06 +02:00
|
|
|
support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
|
2006-09-29 02:10:44 +02:00
|
|
|
environment variable. Default is false (curl will use EPSV).
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
http.userAgent::
|
2010-08-11 22:40:38 +02:00
|
|
|
The HTTP USER_AGENT string presented to an HTTP server. The default
|
2013-01-21 20:17:53 +01:00
|
|
|
value represents the version of the client Git such as git/1.7.1.
|
2010-08-11 22:40:38 +02:00
|
|
|
This option allows you to override this value to a more common value
|
|
|
|
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).
|
2016-06-08 00:35:06 +02:00
|
|
|
Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
|
2010-08-11 22:40:38 +02:00
|
|
|
|
http: make redirects more obvious
We instruct curl to always follow HTTP redirects. This is
convenient, but it creates opportunities for malicious
servers to create confusing situations. For instance,
imagine Alice is a git user with access to a private
repository on Bob's server. Mallory runs her own server and
wants to access objects from Bob's repository.
Mallory may try a few tricks that involve asking Alice to
clone from her, build on top, and then push the result:
1. Mallory may simply redirect all fetch requests to Bob's
server. Git will transparently follow those redirects
and fetch Bob's history, which Alice may believe she
got from Mallory. The subsequent push seems like it is
just feeding Mallory back her own objects, but is
actually leaking Bob's objects. There is nothing in
git's output to indicate that Bob's repository was
involved at all.
The downside (for Mallory) of this attack is that Alice
will have received Bob's entire repository, and is
likely to notice that when building on top of it.
2. If Mallory happens to know the sha1 of some object X in
Bob's repository, she can instead build her own history
that references that object. She then runs a dumb http
server, and Alice's client will fetch each object
individually. When it asks for X, Mallory redirects her
to Bob's server. The end result is that Alice obtains
objects from Bob, but they may be buried deep in
history. Alice is less likely to notice.
Both of these attacks are fairly hard to pull off. There's a
social component in getting Mallory to convince Alice to
work with her. Alice may be prompted for credentials in
accessing Bob's repository (but not always, if she is using
a credential helper that caches). Attack (1) requires a
certain amount of obliviousness on Alice's part while making
a new commit. Attack (2) requires that Mallory knows a sha1
in Bob's repository, that Bob's server supports dumb http,
and that the object in question is loose on Bob's server.
But we can probably make things a bit more obvious without
any loss of functionality. This patch does two things to
that end.
First, when we encounter a whole-repo redirect during the
initial ref discovery, we now inform the user on stderr,
making attack (1) much more obvious.
Second, the decision to follow redirects is now
configurable. The truly paranoid can set the new
http.followRedirects to false to avoid any redirection
entirely. But for a more practical default, we will disallow
redirects only after the initial ref discovery. This is
enough to thwart attacks similar to (2), while still
allowing the common use of redirects at the repository
level. Since c93c92f30 (http: update base URLs when we see
redirects, 2013-09-28) we re-root all further requests from
the redirect destination, which should generally mean that
no further redirection is necessary.
As an escape hatch, in case there really is a server that
needs to redirect individual requests, the user can set
http.followRedirects to "true" (and this can be done on a
per-server basis via http.*.followRedirects config).
Reported-by: Jann Horn <jannh@google.com>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-12-06 19:24:41 +01:00
|
|
|
http.followRedirects::
|
|
|
|
Whether git should follow HTTP redirects. If set to `true`, git
|
|
|
|
will transparently follow any redirect issued by a server it
|
|
|
|
encounters. If set to `false`, git will treat all redirects as
|
|
|
|
errors. If set to `initial`, git will follow redirects only for
|
|
|
|
the initial request to a remote, but not for subsequent
|
|
|
|
follow-up HTTP requests. Since git uses the redirected URL as
|
|
|
|
the base for the follow-up requests, this is generally
|
|
|
|
sufficient. The default is `initial`.
|
|
|
|
|
2013-08-05 22:20:36 +02:00
|
|
|
http.<url>.*::
|
2014-11-03 21:37:07 +01:00
|
|
|
Any of the http.* options above can be applied selectively to some URLs.
|
2013-08-05 22:20:36 +02:00
|
|
|
For a config key to match a URL, each element of the config key is
|
|
|
|
compared to that of the URL, in the following order:
|
|
|
|
+
|
|
|
|
--
|
|
|
|
. Scheme (e.g., `https` in `https://example.com/`). This field
|
|
|
|
must match exactly between the config key and the URL.
|
|
|
|
|
|
|
|
. Host/domain name (e.g., `example.com` in `https://example.com/`).
|
2017-01-31 10:01:47 +01:00
|
|
|
This field must match between the config key and the URL. It is
|
|
|
|
possible to specify a `*` as part of the host name to match all subdomains
|
|
|
|
at this level. `https://*.example.com/` for example would match
|
|
|
|
`https://foo.example.com/`, but not `https://foo.bar.example.com/`.
|
2013-08-05 22:20:36 +02:00
|
|
|
|
|
|
|
. Port number (e.g., `8080` in `http://example.com:8080/`).
|
|
|
|
This field must match exactly between the config key and the URL.
|
|
|
|
Omitted port numbers are automatically converted to the correct
|
|
|
|
default for the scheme before matching.
|
|
|
|
|
|
|
|
. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
|
|
|
|
path field of the config key must match the path field of the URL
|
|
|
|
either exactly or as a prefix of slash-delimited path elements. This means
|
|
|
|
a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
|
|
|
|
match on a slash (`/`) boundary. Longer matches take precedence (so a config
|
|
|
|
key with path `foo/bar` is a better match to URL path `foo/bar` than a config
|
|
|
|
key with just path `foo/`).
|
|
|
|
|
|
|
|
. User name (e.g., `user` in `https://user@example.com/repo.git`). If
|
|
|
|
the config key has a user name it must match the user name in the
|
|
|
|
URL exactly. If the config key does not have a user name, that
|
|
|
|
config key will match a URL with any user name (including none),
|
|
|
|
but at a lower precedence than a config key with a user name.
|
|
|
|
--
|
|
|
|
+
|
|
|
|
The list above is ordered by decreasing precedence; a URL that matches
|
|
|
|
a config key's path is preferred to one that matches its user name. For example,
|
|
|
|
if the URL is `https://user@example.com/foo/bar` a config key match of
|
|
|
|
`https://example.com/foo` will be preferred over a config key match of
|
|
|
|
`https://user@example.com`.
|
|
|
|
+
|
|
|
|
All URLs are normalized before attempting any matching (the password part,
|
|
|
|
if embedded in the URL, is always ignored for matching purposes) so that
|
2014-11-03 21:37:07 +01:00
|
|
|
equivalent URLs that are simply spelled differently will match properly.
|
|
|
|
Environment variable settings always override any matches. The URLs that are
|
2013-08-05 22:20:36 +02:00
|
|
|
matched against are those given directly to Git commands. This means any URLs
|
|
|
|
visited as a result of a redirection do not participate in matching.
|
|
|
|
|
2017-02-01 13:01:16 +01:00
|
|
|
ssh.variant::
|
ssh: 'auto' variant to select between 'ssh' and 'simple'
Android's "repo" tool is a tool for managing a large codebase
consisting of multiple smaller repositories, similar to Git's
submodule feature. Starting with Git 94b8ae5a (ssh: introduce a
'simple' ssh variant, 2017-10-16), users noticed that it stopped
handling the port in ssh:// URLs.
The cause: when it encounters ssh:// URLs, repo pre-connects to the
server and sets GIT_SSH to a helper ".repo/repo/git_ssh" that reuses
that connection. Before 94b8ae5a, the helper was assumed to support
OpenSSH options for lack of a better guess and got passed a -p option
to set the port. After that patch, it uses the new default of a
simple helper that does not accept an option to set the port.
The next release of "repo" will set GIT_SSH_VARIANT to "ssh" to avoid
that. But users of old versions and of other similar GIT_SSH
implementations would not get the benefit of that fix.
So update the default to use OpenSSH options again, with a twist. As
observed in 94b8ae5a, we cannot assume that $GIT_SSH always handles
OpenSSH options: common helpers such as travis-ci's dpl[*] are
configured using GIT_SSH and do not accept OpenSSH options. So make
the default a new variant "auto", with the following behavior:
1. First, check for a recognized basename, like today.
2. If the basename is not recognized, check whether $GIT_SSH supports
OpenSSH options by running
$GIT_SSH -G <options> <host>
This returns status 0 and prints configuration in OpenSSH if it
recognizes all <options> and returns status 255 if it encounters
an unrecognized option. A wrapper script like
exec ssh -- "$@"
would fail with
ssh: Could not resolve hostname -g: Name or service not known
, correctly reflecting that it does not support OpenSSH options.
The command is run with stdin, stdout, and stderr redirected to
/dev/null so even a command that expects a terminal would exit
immediately.
3. Based on the result from step (2), behave like "ssh" (if it
succeeded) or "simple" (if it failed).
This way, the default ssh variant for unrecognized commands can handle
both the repo and dpl cases as intended.
This autodetection has been running on Google workstations since
2017-10-23 with no reported negative effects.
[*] https://github.com/travis-ci/dpl/blob/6c3fddfda1f2a85944c544446b068bac0a77c049/lib/dpl/provider.rb#L215
Reported-by: William Yan <wyan@google.com>
Improved-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-11-20 22:30:04 +01:00
|
|
|
By default, Git determines the command line arguments to use
|
|
|
|
based on the basename of the configured SSH command (configured
|
|
|
|
using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
|
|
|
|
the config setting `core.sshCommand`). If the basename is
|
|
|
|
unrecognized, Git will attempt to detect support of OpenSSH
|
|
|
|
options by first invoking the configured SSH command with the
|
|
|
|
`-G` (print configuration) option and will subsequently use
|
|
|
|
OpenSSH options (if that is successful) or no options besides
|
|
|
|
the host and remote command (if it fails).
|
|
|
|
+
|
|
|
|
The config variable `ssh.variant` can be set to override this detection.
|
|
|
|
Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
|
|
|
|
`tortoiseplink`, `simple` (no options except the host and remote command).
|
|
|
|
The default auto-detection can be explicitly requested using the value
|
|
|
|
`auto`. Any other value is treated as `ssh`. This setting can also be
|
|
|
|
overridden via the environment variable `GIT_SSH_VARIANT`.
|
2017-10-16 19:55:31 +02:00
|
|
|
+
|
|
|
|
The current command-line parameters used for each variant are as
|
|
|
|
follows:
|
|
|
|
+
|
|
|
|
--
|
|
|
|
|
|
|
|
* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
|
|
|
|
|
|
|
|
* `simple` - [username@]host command
|
|
|
|
|
|
|
|
* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
|
|
|
|
|
|
|
|
* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
|
|
|
|
|
|
|
|
--
|
|
|
|
+
|
|
|
|
Except for the `simple` variant, command-line parameters are likely to
|
|
|
|
change as git gains new features.
|
2017-02-01 13:01:16 +01:00
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
i18n.commitEncoding::
|
2013-01-21 20:17:53 +01:00
|
|
|
Character encoding the commit messages are stored in; Git itself
|
2006-04-25 00:59:33 +02:00
|
|
|
does not care per se, but this information is necessary e.g. when
|
|
|
|
importing commits from emails or in the gitk graphical history
|
|
|
|
browser (and possibly at other places in the future or in other
|
2007-12-29 07:20:38 +01:00
|
|
|
porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
|
2006-04-25 00:59:33 +02:00
|
|
|
|
2006-12-28 01:41:33 +01:00
|
|
|
i18n.logOutputEncoding::
|
|
|
|
Character encoding the commit messages are converted to when
|
2010-01-10 00:33:00 +01:00
|
|
|
running 'git log' and friends.
|
2006-12-28 01:41:33 +01:00
|
|
|
|
2008-11-26 09:26:50 +01:00
|
|
|
imap::
|
|
|
|
The configuration variables in the 'imap' section are described
|
|
|
|
in linkgit:git-imap-send[1].
|
|
|
|
|
2018-10-10 17:59:35 +02:00
|
|
|
index.threads::
|
|
|
|
Specifies the number of threads to spawn when loading the index.
|
|
|
|
This is meant to reduce index load time on multiprocessor machines.
|
|
|
|
Specifying 0 or 'true' will cause Git to auto-detect the number of
|
|
|
|
CPU's and set the number of threads accordingly. Specifying 1 or
|
|
|
|
'false' will disable multithreading. Defaults to 'true'.
|
|
|
|
|
2014-02-23 21:49:59 +01:00
|
|
|
index.version::
|
|
|
|
Specify the version with which new index files should be
|
|
|
|
initialized. This does not affect existing repositories.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
init.templateDir::
|
2010-02-17 00:44:46 +01:00
|
|
|
Specify the directory from which templates will be copied.
|
|
|
|
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
|
|
|
|
|
2008-01-08 04:55:14 +01:00
|
|
|
instaweb.browser::
|
|
|
|
Specify the program that will be used to browse your working
|
|
|
|
repository in gitweb. See linkgit:git-instaweb[1].
|
|
|
|
|
|
|
|
instaweb.httpd::
|
|
|
|
The HTTP daemon command-line to start gitweb on your working
|
|
|
|
repository. See linkgit:git-instaweb[1].
|
|
|
|
|
|
|
|
instaweb.local::
|
|
|
|
If true the web server started by linkgit:git-instaweb[1] will
|
|
|
|
be bound to the local IP (127.0.0.1).
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
instaweb.modulePath::
|
2010-07-19 23:17:17 +02:00
|
|
|
The default module path for linkgit:git-instaweb[1] to use
|
|
|
|
instead of /usr/lib/apache2/modules. Only used if httpd
|
|
|
|
is Apache.
|
2008-01-08 04:55:14 +01:00
|
|
|
|
|
|
|
instaweb.port::
|
|
|
|
The port number to bind the gitweb httpd to. See
|
|
|
|
linkgit:git-instaweb[1].
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
interactive.singleKey::
|
2009-08-07 16:24:21 +02:00
|
|
|
In interactive commands, allow the user to provide one-letter
|
2009-02-05 09:28:26 +01:00
|
|
|
input with a single key (i.e., without hitting enter).
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
Currently this is used by the `--patch` mode of
|
2011-05-07 19:59:04 +02:00
|
|
|
linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
|
|
|
|
linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
|
|
|
|
setting is silently ignored if portable keystroke input
|
2014-03-03 22:15:50 +01:00
|
|
|
is not available; requires the Perl module Term::ReadKey.
|
2009-02-05 09:28:26 +01:00
|
|
|
|
2016-02-27 06:37:06 +01:00
|
|
|
interactive.diffFilter::
|
|
|
|
When an interactive command (such as `git add --patch`) shows
|
|
|
|
a colorized diff, git will pipe the diff through the shell
|
|
|
|
command defined by this configuration variable. The command may
|
|
|
|
mark up the diff further for human consumption, provided that it
|
|
|
|
retains a one-to-one correspondence with the lines in the
|
|
|
|
original diff. Defaults to disabled (no filtering).
|
|
|
|
|
2011-05-18 19:56:04 +02:00
|
|
|
log.abbrevCommit::
|
|
|
|
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
|
|
|
|
override this option with `--no-abbrev-commit`.
|
2011-05-18 19:56:04 +02:00
|
|
|
|
2008-05-22 17:24:07 +02:00
|
|
|
log.date::
|
2010-08-20 12:20:36 +02:00
|
|
|
Set the default date-time mode for the 'log' command.
|
|
|
|
Setting a value for log.date is similar to using 'git log''s
|
2015-09-03 23:48:52 +02:00
|
|
|
`--date` option. See linkgit:git-log[1] for details.
|
2008-05-22 17:24:07 +02:00
|
|
|
|
2010-02-17 00:39:52 +01:00
|
|
|
log.decorate::
|
|
|
|
Print out the ref names of any commits that are shown by the log
|
|
|
|
command. If 'short' is specified, the ref name prefixes 'refs/heads/',
|
|
|
|
'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
|
|
|
|
specified, the full ref name (including prefix) will be printed.
|
2016-05-27 17:56:02 +02:00
|
|
|
If 'auto' is specified, then if the output is going to a terminal,
|
|
|
|
the ref names are shown as if 'short' were given, otherwise no ref
|
2016-07-13 20:24:14 +02:00
|
|
|
names are shown. This is the same as the `--decorate` option
|
2016-05-27 17:56:02 +02:00
|
|
|
of the `git log`.
|
2010-02-17 00:39:52 +01:00
|
|
|
|
2015-10-07 03:14:33 +02:00
|
|
|
log.follow::
|
|
|
|
If `true`, `git log` will act as if the `--follow` option was used when
|
|
|
|
a single <path> is given. This has the same limitations as `--follow`,
|
|
|
|
i.e. it cannot be used to follow multiple files and does not work well
|
|
|
|
on non-linear history.
|
|
|
|
|
2017-01-19 12:41:23 +01:00
|
|
|
log.graphColors::
|
|
|
|
A list of colors, separated by commas, that can be used to draw
|
|
|
|
history lines in `git log --graph`.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
log.showRoot::
|
2006-11-23 10:36:33 +01:00
|
|
|
If true, the initial commit will be shown as a big creation event.
|
|
|
|
This is equivalent to a diff against an empty tree.
|
2007-12-29 07:20:38 +01:00
|
|
|
Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
|
2006-11-23 10:36:33 +01:00
|
|
|
normally hide the root commit will now show it. True by default.
|
|
|
|
|
2017-05-19 04:44:51 +02:00
|
|
|
log.showSignature::
|
|
|
|
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
|
|
|
linkgit:git-whatchanged[1] assume `--show-signature`.
|
|
|
|
|
2013-01-05 22:26:46 +01:00
|
|
|
log.mailmap::
|
|
|
|
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
|
|
|
linkgit:git-whatchanged[1] assume `--use-mailmap`.
|
|
|
|
|
2015-02-20 20:32:20 +01:00
|
|
|
mailinfo.scissors::
|
|
|
|
If true, makes linkgit:git-mailinfo[1] (and therefore
|
|
|
|
linkgit:git-am[1]) act by default as if the --scissors option
|
|
|
|
was provided on the command-line. When active, this features
|
|
|
|
removes everything from the message body before a scissors
|
|
|
|
line (i.e. consisting mainly of ">8", "8<" and "-").
|
|
|
|
|
2009-02-08 15:34:27 +01:00
|
|
|
mailmap.file::
|
|
|
|
The location of an augmenting mailmap file. The default
|
|
|
|
mailmap, located in the root of the repository, is loaded
|
|
|
|
first, then the mailmap file pointed to by this variable.
|
|
|
|
The location of the mailmap file may be in a repository
|
|
|
|
subdirectory, or somewhere outside of the repository itself.
|
|
|
|
See linkgit:git-shortlog[1] and linkgit:git-blame[1].
|
|
|
|
|
2012-12-12 12:04:04 +01:00
|
|
|
mailmap.blob::
|
|
|
|
Like `mailmap.file`, but consider the value as a reference to a
|
mailmap: default mailmap.blob in bare repositories
The motivation for mailmap.blob is to let users of bare
repositories use the mailmap feature, as they would not have
a checkout containing the .mailmap file. We can make it even
easier for them by just looking in HEAD:.mailmap by default.
We can't know for sure that this is where they would keep a
mailmap, of course, but it is the best guess (and it matches
the non-bare behavior, which reads from HEAD:.mailmap in the
working tree). If it's missing, git will silently ignore the
setting.
We do not do the same magic in the non-bare case, because:
1. In the common case, HEAD:.mailmap will be the same as
the .mailmap in the working tree, which is a no-op.
2. In the uncommon case, the user has modified .mailmap
but not yet committed it, and would expect the working
tree version to take precedence.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-13 14:04:47 +01:00
|
|
|
blob in the repository. If both `mailmap.file` and
|
|
|
|
`mailmap.blob` are given, both are parsed, with entries from
|
|
|
|
`mailmap.file` taking precedence. In a bare repository, this
|
|
|
|
defaults to `HEAD:.mailmap`. In a non-bare repository, it
|
|
|
|
defaults to empty.
|
2012-12-12 12:04:04 +01:00
|
|
|
|
2008-03-07 08:46:55 +01:00
|
|
|
man.viewer::
|
2008-03-13 06:48:46 +01:00
|
|
|
Specify the programs that may be used to display help in the
|
2008-03-07 08:46:55 +01:00
|
|
|
'man' format. See linkgit:git-help[1].
|
|
|
|
|
2008-04-25 08:25:35 +02:00
|
|
|
man.<tool>.cmd::
|
|
|
|
Specify the command to invoke the specified man viewer. The
|
|
|
|
specified command is evaluated in shell with the man page
|
|
|
|
passed as argument. (See linkgit:git-help[1].)
|
|
|
|
|
2008-04-25 08:24:41 +02:00
|
|
|
man.<tool>.path::
|
|
|
|
Override the path for the given tool that may be used to
|
|
|
|
display help in the 'man' format. See linkgit:git-help[1].
|
|
|
|
|
2008-11-26 09:26:50 +01:00
|
|
|
include::merge-config.txt[]
|
2008-08-29 19:49:56 +02:00
|
|
|
|
2007-12-17 13:21:22 +01:00
|
|
|
mergetool.<tool>.path::
|
|
|
|
Override the path for the given tool. This is useful in case
|
|
|
|
your tool is not in the PATH.
|
|
|
|
|
2008-02-22 00:31:12 +01:00
|
|
|
mergetool.<tool>.cmd::
|
|
|
|
Specify the command to invoke the specified merge tool. The
|
|
|
|
specified command is evaluated in shell with the following
|
|
|
|
variables available: 'BASE' is the name of a temporary file
|
|
|
|
containing the common base of the files to be merged, if available;
|
|
|
|
'LOCAL' is the name of a temporary file containing the contents of
|
|
|
|
the file on the current branch; 'REMOTE' is the name of a temporary
|
|
|
|
file containing the contents of the file from the branch being
|
|
|
|
merged; 'MERGED' contains the name of the file to which the merge
|
|
|
|
tool should write the results of a successful merge.
|
|
|
|
|
|
|
|
mergetool.<tool>.trustExitCode::
|
|
|
|
For a custom merge command, specify whether the exit code of
|
|
|
|
the merge command can be used to determine whether the merge was
|
|
|
|
successful. If this is not set to true then the merge target file
|
|
|
|
timestamp is checked and the merge assumed to have been successful
|
|
|
|
if the file has been updated, otherwise the user is prompted to
|
|
|
|
indicate the success of the merge.
|
|
|
|
|
2014-10-16 06:45:14 +02:00
|
|
|
mergetool.meld.hasOutput::
|
|
|
|
Older versions of `meld` do not support the `--output` option.
|
|
|
|
Git will attempt to detect whether `meld` supports `--output`
|
|
|
|
by inspecting the output of `meld --help`. Configuring
|
|
|
|
`mergetool.meld.hasOutput` will make Git skip these checks and
|
|
|
|
use the configured value instead. Setting `mergetool.meld.hasOutput`
|
|
|
|
to `true` tells Git to unconditionally use the `--output` option,
|
|
|
|
and `false` avoids using `--output`.
|
|
|
|
|
2008-02-22 00:30:02 +01:00
|
|
|
mergetool.keepBackup::
|
|
|
|
After performing a merge, the original file with conflict markers
|
|
|
|
can be saved as a file with a `.orig` extension. If this variable
|
|
|
|
is set to `false` then this file is not preserved. Defaults to
|
|
|
|
`true` (i.e. keep the backup files).
|
|
|
|
|
2008-12-12 22:48:41 +01:00
|
|
|
mergetool.keepTemporaries::
|
2013-01-21 20:17:53 +01:00
|
|
|
When invoking a custom merge tool, Git uses a set of temporary
|
2008-12-12 22:48:41 +01:00
|
|
|
files to pass to the tool. If the tool returns an error and this
|
|
|
|
variable is set to `true`, then these temporary files will be
|
|
|
|
preserved, otherwise they will be removed after the tool has
|
|
|
|
exited. Defaults to `false`.
|
|
|
|
|
2014-10-11 19:04:45 +02:00
|
|
|
mergetool.writeToTemp::
|
|
|
|
Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
|
|
|
|
conflicting files in the worktree by default. Git will attempt
|
|
|
|
to use a temporary directory for these files when set `true`.
|
|
|
|
Defaults to `false`.
|
|
|
|
|
2008-11-13 13:41:14 +01:00
|
|
|
mergetool.prompt::
|
|
|
|
Prompt before each invocation of the merge resolution program.
|
|
|
|
|
2015-08-17 23:33:33 +02:00
|
|
|
notes.mergeStrategy::
|
|
|
|
Which merge strategy to choose by default when resolving notes
|
|
|
|
conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
|
|
|
|
`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
|
|
|
|
section of linkgit:git-notes[1] for more information on each strategy.
|
|
|
|
|
2015-08-17 23:33:34 +02:00
|
|
|
notes.<name>.mergeStrategy::
|
|
|
|
Which merge strategy to choose when doing a notes merge into
|
|
|
|
refs/notes/<name>. This overrides the more general
|
|
|
|
"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
|
|
|
|
linkgit:git-notes[1] for more information on the available strategies.
|
|
|
|
|
2010-03-12 18:04:26 +01:00
|
|
|
notes.displayRef::
|
|
|
|
The (fully qualified) refname from which to show notes when
|
|
|
|
showing commit messages. The value of this variable can be set
|
|
|
|
to a glob, in which case notes from all matching refs will be
|
|
|
|
shown. You may also specify this configuration variable
|
|
|
|
several 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 overridden with the `GIT_NOTES_DISPLAY_REF`
|
|
|
|
environment variable, which must be a colon separated list of refs or
|
|
|
|
globs.
|
|
|
|
+
|
|
|
|
The effective value of "core.notesRef" (possibly overridden by
|
|
|
|
GIT_NOTES_REF) is also implicitly added to the list of refs to be
|
|
|
|
displayed.
|
|
|
|
|
2010-03-12 18:04:32 +01:00
|
|
|
notes.rewrite.<command>::
|
|
|
|
When rewriting commits with <command> (currently `amend` or
|
2013-01-21 20:17:53 +01:00
|
|
|
`rebase`) and this variable is set to `true`, Git
|
2010-03-12 18:04:32 +01:00
|
|
|
automatically copies your notes from the original to the
|
|
|
|
rewritten commit. Defaults to `true`, but see
|
|
|
|
"notes.rewriteRef" below.
|
|
|
|
|
|
|
|
notes.rewriteMode::
|
|
|
|
When copying notes during a rewrite (see the
|
|
|
|
"notes.rewrite.<command>" option), determines what to do if
|
|
|
|
the target commit already has a note. Must be one of
|
2015-08-17 23:33:29 +02:00
|
|
|
`overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
|
|
|
|
Defaults to `concatenate`.
|
2010-03-12 18:04:32 +01:00
|
|
|
+
|
|
|
|
This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
|
|
|
|
environment variable.
|
|
|
|
|
|
|
|
notes.rewriteRef::
|
|
|
|
When copying notes during a rewrite, specifies the (fully
|
|
|
|
qualified) ref whose notes should be copied. The ref may be a
|
|
|
|
glob, in which case notes in all matching refs will be copied.
|
|
|
|
You may also specify this configuration several times.
|
|
|
|
+
|
|
|
|
Does not have a default value; you must configure this variable to
|
2011-09-13 09:32:42 +02:00
|
|
|
enable note rewriting. Set it to `refs/notes/commits` to enable
|
|
|
|
rewriting for the default commit notes.
|
2010-05-05 16:16:25 +02:00
|
|
|
+
|
|
|
|
This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
|
|
|
|
environment variable, which must be a colon separated list of refs or
|
|
|
|
globs.
|
2010-03-12 18:04:32 +01:00
|
|
|
|
2006-07-23 07:50:30 +02:00
|
|
|
pack.window::
|
2007-12-29 07:20:38 +01:00
|
|
|
The size of the window used by linkgit:git-pack-objects[1] when no
|
2006-07-23 07:50:30 +02:00
|
|
|
window size is given on the command line. Defaults to 10.
|
|
|
|
|
2007-05-08 15:28:26 +02:00
|
|
|
pack.depth::
|
2007-12-29 07:20:38 +01:00
|
|
|
The maximum delta depth used by linkgit:git-pack-objects[1] when no
|
2007-05-08 15:28:26 +02:00
|
|
|
maximum depth is given on the command line. Defaults to 50.
|
2018-04-14 17:35:03 +02:00
|
|
|
Maximum value is 4095.
|
2007-05-08 15:28:26 +02:00
|
|
|
|
2007-07-12 14:55:52 +02:00
|
|
|
pack.windowMemory::
|
2014-10-24 09:43:27 +02:00
|
|
|
The maximum size of memory that is consumed by each thread
|
|
|
|
in linkgit:git-pack-objects[1] for pack window memory when
|
|
|
|
no limit is given on the command line. The value can be
|
|
|
|
suffixed with "k", "m", or "g". When left unconfigured (or
|
|
|
|
set explicitly to 0), there will be no limit.
|
2007-07-12 14:55:52 +02:00
|
|
|
|
Custom compression levels for objects and packs
Add config variables pack.compression and core.loosecompression ,
and switch --compression=level to pack-objects.
Loose objects will be compressed using core.loosecompression if set,
else core.compression if set, else Z_BEST_SPEED.
Packed objects will be compressed using --compression=level if seen,
else pack.compression if set, else core.compression if set,
else Z_DEFAULT_COMPRESSION. This is the "pack compression level".
Loose objects added to a pack undeltified will be recompressed
to the pack compression level if it is unequal to the current
loose compression level by the preceding rules, or if the loose
object was written while core.legacyheaders = true. Newly
deltified loose objects are always compressed to the current
pack compression level.
Previously packed objects added to a pack are recompressed
to the current pack compression level exactly when their
deltification status changes, since the previous pack data
cannot be reused.
In either case, the --no-reuse-object switch from the first
patch below will always force recompression to the current pack
compression level, instead of assuming the pack compression level
hasn't changed and pack data can be reused when possible.
This applies on top of the following patches from Nicolas Pitre:
[PATCH] allow for undeltified objects not to be reused
[PATCH] make "repack -f" imply "pack-objects --no-reuse-object"
Signed-off-by: Dana L. How <danahow@gmail.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-09 22:56:50 +02:00
|
|
|
pack.compression::
|
|
|
|
An integer -1..9, indicating the compression level for objects
|
|
|
|
in a pack file. -1 is the zlib default. 0 means no
|
|
|
|
compression, and 1..9 are various speed/size tradeoffs, 9 being
|
|
|
|
slowest. If not set, defaults to core.compression. If that is
|
2007-11-19 17:58:51 +01:00
|
|
|
not set, defaults to -1, the zlib default, which is "a default
|
|
|
|
compromise between speed and compression (currently equivalent
|
|
|
|
to level 6)."
|
2010-09-27 14:21:58 +02:00
|
|
|
+
|
|
|
|
Note that changing the compression level will not automatically recompress
|
|
|
|
all existing objects. You can force recompression by passing the -F option
|
|
|
|
to linkgit:git-repack[1].
|
Custom compression levels for objects and packs
Add config variables pack.compression and core.loosecompression ,
and switch --compression=level to pack-objects.
Loose objects will be compressed using core.loosecompression if set,
else core.compression if set, else Z_BEST_SPEED.
Packed objects will be compressed using --compression=level if seen,
else pack.compression if set, else core.compression if set,
else Z_DEFAULT_COMPRESSION. This is the "pack compression level".
Loose objects added to a pack undeltified will be recompressed
to the pack compression level if it is unequal to the current
loose compression level by the preceding rules, or if the loose
object was written while core.legacyheaders = true. Newly
deltified loose objects are always compressed to the current
pack compression level.
Previously packed objects added to a pack are recompressed
to the current pack compression level exactly when their
deltification status changes, since the previous pack data
cannot be reused.
In either case, the --no-reuse-object switch from the first
patch below will always force recompression to the current pack
compression level, instead of assuming the pack compression level
hasn't changed and pack data can be reused when possible.
This applies on top of the following patches from Nicolas Pitre:
[PATCH] allow for undeltified objects not to be reused
[PATCH] make "repack -f" imply "pack-objects --no-reuse-object"
Signed-off-by: Dana L. How <danahow@gmail.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-09 22:56:50 +02:00
|
|
|
|
2018-08-16 08:13:09 +02:00
|
|
|
pack.island::
|
|
|
|
An extended regular expression configuring a set of delta
|
|
|
|
islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
|
|
|
|
for details.
|
|
|
|
|
|
|
|
pack.islandCore::
|
|
|
|
Specify an island name which gets to have its objects be
|
|
|
|
packed first. This creates a kind of pseudo-pack at the front
|
|
|
|
of one pack, so that the objects from the specified island are
|
|
|
|
hopefully faster to copy into any pack that should be served
|
|
|
|
to a user requesting these objects. In practice this means
|
|
|
|
that the island specified should likely correspond to what is
|
|
|
|
the most commonly cloned in the repo. See also "DELTA ISLANDS"
|
|
|
|
in linkgit:git-pack-objects[1].
|
|
|
|
|
2007-05-28 23:20:58 +02:00
|
|
|
pack.deltaCacheSize::
|
2007-08-24 02:44:13 +02:00
|
|
|
The maximum memory in bytes used for caching deltas in
|
2009-08-05 22:55:07 +02:00
|
|
|
linkgit:git-pack-objects[1] before writing them out to a pack.
|
|
|
|
This cache is used to speed up the writing object phase by not
|
|
|
|
having to recompute the final delta result once the best match
|
|
|
|
for all objects is found. Repacking large repositories on machines
|
|
|
|
which are tight with memory might be badly impacted by this though,
|
|
|
|
especially if this cache pushes the system into swapping.
|
|
|
|
A value of 0 means no limit. The smallest size of 1 byte may be
|
|
|
|
used to virtually disable this cache. Defaults to 256 MiB.
|
2007-05-28 23:20:58 +02:00
|
|
|
|
2007-05-28 23:20:59 +02:00
|
|
|
pack.deltaCacheLimit::
|
2007-09-10 17:51:34 +02:00
|
|
|
The maximum size of a delta, that is cached in
|
2009-08-05 22:55:07 +02:00
|
|
|
linkgit:git-pack-objects[1]. This cache is used to speed up the
|
|
|
|
writing object phase by not having to recompute the final delta
|
2018-04-14 17:35:07 +02:00
|
|
|
result once the best match for all objects is found.
|
|
|
|
Defaults to 1000. Maximum value is 65535.
|
2007-05-28 23:20:59 +02:00
|
|
|
|
2007-09-10 17:51:34 +02:00
|
|
|
pack.threads::
|
|
|
|
Specifies the number of threads to spawn when searching for best
|
2007-12-29 07:20:38 +01:00
|
|
|
delta matches. This requires that linkgit:git-pack-objects[1]
|
2007-09-10 17:51:34 +02:00
|
|
|
be compiled with pthreads otherwise this option is ignored with a
|
|
|
|
warning. This is meant to reduce packing time on multiprocessor
|
|
|
|
machines. The required amount of memory for the delta search window
|
|
|
|
is however multiplied by the number of threads.
|
2013-01-21 20:17:53 +01:00
|
|
|
Specifying 0 will cause Git to auto-detect the number of CPU's
|
2008-02-23 03:11:56 +01:00
|
|
|
and set the number of threads accordingly.
|
2007-09-10 17:51:34 +02:00
|
|
|
|
2007-11-02 04:26:04 +01:00
|
|
|
pack.indexVersion::
|
|
|
|
Specify the default pack index version. Valid values are 1 for
|
|
|
|
legacy pack index used by Git versions prior to 1.5.2, and 2 for
|
|
|
|
the new pack index with capabilities for packs larger than 4 GB
|
|
|
|
as well as proper protection against the repacking of corrupted
|
2008-06-25 06:25:53 +02:00
|
|
|
packs. Version 2 is the default. Note that version 2 is enforced
|
|
|
|
and this config option ignored whenever the corresponding pack is
|
|
|
|
larger than 2 GB.
|
|
|
|
+
|
2013-01-21 20:17:53 +01:00
|
|
|
If you have an old Git that does not understand the version 2 `*.idx` file,
|
transport: drop support for git-over-rsync
The git-over-rsync protocol is inefficient and broken, and
has been for a long time. It transfers way more objects than
it needs (grabbing all of the remote's "objects/",
regardless of which objects we need). It does its own ad-hoc
parsing of loose and packed refs from the remote, but
doesn't properly override packed refs with loose ones,
leading to garbage results (e.g., expecting the other side
to have an object pointed to by a stale packed-refs entry,
or complaining that the other side has two copies of the
refs[1]).
This latter breakage means that nobody could have
successfully pulled from a moderately active repository
since cd547b4 (fetch/push: readd rsync support, 2007-10-01).
We never made an official deprecation notice in the release
notes for git's rsync protocol, but the tutorial has marked
it as such since 914328a (Update tutorial., 2005-08-30).
And on the mailing list as far back as Oct 2005, we can find
Junio mentioning it as having "been deprecated for quite
some time."[2,3,4]. So it was old news then; cogito had
deprecated the transport in July of 2005[5] (though it did
come back briefly when Linus broke git-http-pull!).
Of course some people professed their love of rsync through
2006, but Linus clarified in his usual gentle manner[6]:
> Thanks! This is why I still use rsync, even though
> everybody and their mother tells me "Linus says rsync is
> deprecated."
No. You're using rsync because you're actively doing
something _wrong_.
The deprecation sentiment was reinforced in 2008, with a
mention that cloning via rsync is broken (with no fix)[7].
Even the commit porting rsync over to C from shell (cd547b4)
lists it as deprecated! So between the 10 years of informal
warnings, and the fact that it has been severely broken
since 2007, it's probably safe to simply remove it without
further deprecation warnings.
[1] http://article.gmane.org/gmane.comp.version-control.git/285101
[2] http://article.gmane.org/gmane.comp.version-control.git/10093
[3] http://article.gmane.org/gmane.comp.version-control.git/17734
[4] http://article.gmane.org/gmane.comp.version-control.git/18911
[5] http://article.gmane.org/gmane.comp.version-control.git/5617
[6] http://article.gmane.org/gmane.comp.version-control.git/19354
[7] http://article.gmane.org/gmane.comp.version-control.git/103635
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-01-30 08:21:26 +01:00
|
|
|
cloning or fetching over a non native protocol (e.g. "http")
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
that will copy both `*.pack` file and corresponding `*.idx` file from the
|
2008-06-25 06:25:53 +02:00
|
|
|
other side may give you a repository that cannot be accessed with your
|
2013-01-21 20:17:53 +01:00
|
|
|
older version of Git. If the `*.pack` file is smaller than 2 GB, however,
|
2008-06-25 06:25:53 +02:00
|
|
|
you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
the `*.idx` file.
|
2007-11-02 04:26:04 +01:00
|
|
|
|
2008-03-13 07:11:15 +01:00
|
|
|
pack.packSizeLimit::
|
2010-02-04 04:48:28 +01:00
|
|
|
The maximum size of a pack. This setting only affects
|
|
|
|
packing to a file when repacking, i.e. the git:// protocol
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
is unaffected. It can be overridden by the `--max-pack-size`
|
2016-04-28 09:28:55 +02:00
|
|
|
option of linkgit:git-repack[1]. Reaching this limit results
|
|
|
|
in the creation of multiple packfiles; which in turn prevents
|
|
|
|
bitmaps from being created.
|
|
|
|
The minimum size allowed is limited to 1 MiB.
|
|
|
|
The default is unlimited.
|
2010-02-04 04:48:28 +01:00
|
|
|
Common unit suffixes of 'k', 'm', or 'g' are
|
|
|
|
supported.
|
2008-02-05 15:25:04 +01:00
|
|
|
|
pack-objects: use bitmaps when packing objects
In this patch, we use the bitmap API to perform the `Counting Objects`
phase in pack-objects, rather than a traditional walk through the object
graph. For a reasonably-packed large repo, the time to fetch and clone
is often dominated by the full-object revision walk during the Counting
Objects phase. Using bitmaps can reduce the CPU time required on the
server (and therefore start sending the actual pack data with less
delay).
For bitmaps to be used, the following must be true:
1. We must be packing to stdout (as a normal `pack-objects` from
`upload-pack` would do).
2. There must be a .bitmap index containing at least one of the
"have" objects that the client is asking for.
3. Bitmaps must be enabled (they are enabled by default, but can be
disabled by setting `pack.usebitmaps` to false, or by using
`--no-use-bitmap-index` on the command-line).
If any of these is not true, we fall back to doing a normal walk of the
object graph.
Here are some sample timings from a full pack of `torvalds/linux` (i.e.
something very similar to what would be generated for a clone of the
repository) that show the speedup produced by various
methods:
[existing graph traversal]
$ time git pack-objects --all --stdout --no-use-bitmap-index \
</dev/null >/dev/null
Counting objects: 3237103, done.
Compressing objects: 100% (508752/508752), done.
Total 3237103 (delta 2699584), reused 3237103 (delta 2699584)
real 0m44.111s
user 0m42.396s
sys 0m3.544s
[bitmaps only, without partial pack reuse; note that
pack reuse is automatic, so timing this required a
patch to disable it]
$ time git pack-objects --all --stdout </dev/null >/dev/null
Counting objects: 3237103, done.
Compressing objects: 100% (508752/508752), done.
Total 3237103 (delta 2699584), reused 3237103 (delta 2699584)
real 0m5.413s
user 0m5.604s
sys 0m1.804s
[bitmaps with pack reuse (what you get with this patch)]
$ time git pack-objects --all --stdout </dev/null >/dev/null
Reusing existing pack: 3237103, done.
Total 3237103 (delta 0), reused 0 (delta 0)
real 0m1.636s
user 0m1.460s
sys 0m0.172s
Signed-off-by: Vicent Marti <tanoku@gmail.com>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-12-21 15:00:09 +01:00
|
|
|
pack.useBitmaps::
|
|
|
|
When true, git will use pack bitmaps (if available) when packing
|
|
|
|
to stdout (e.g., during the server side of a fetch). Defaults to
|
|
|
|
true. You should not generally need to turn this off unless
|
|
|
|
you are debugging pack bitmaps.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
pack.writeBitmaps (deprecated)::
|
2014-06-10 22:20:30 +02:00
|
|
|
This is a deprecated synonym for `repack.writeBitmaps`.
|
pack-objects: implement bitmap writing
This commit extends more the functionality of `pack-objects` by allowing
it to write out a `.bitmap` index next to any written packs, together
with the `.idx` index that currently gets written.
If bitmap writing is enabled for a given repository (either by calling
`pack-objects` with the `--write-bitmap-index` flag or by having
`pack.writebitmaps` set to `true` in the config) and pack-objects is
writing a packfile that would normally be indexed (i.e. not piping to
stdout), we will attempt to write the corresponding bitmap index for the
packfile.
Bitmap index writing happens after the packfile and its index has been
successfully written to disk (`finish_tmp_packfile`). The process is
performed in several steps:
1. `bitmap_writer_set_checksum`: this call stores the partial
checksum for the packfile being written; the checksum will be
written in the resulting bitmap index to verify its integrity
2. `bitmap_writer_build_type_index`: this call uses the array of
`struct object_entry` that has just been sorted when writing out
the actual packfile index to disk to generate 4 type-index bitmaps
(one for each object type).
These bitmaps have their nth bit set if the given object is of
the bitmap's type. E.g. the nth bit of the Commits bitmap will be
1 if the nth object in the packfile index is a commit.
This is a very cheap operation because the bitmap writing code has
access to the metadata stored in the `struct object_entry` array,
and hence the real type for each object in the packfile.
3. `bitmap_writer_reuse_bitmaps`: if there exists an existing bitmap
index for one of the packfiles we're trying to repack, this call
will efficiently rebuild the existing bitmaps so they can be
reused on the new index. All the existing bitmaps will be stored
in a `reuse` hash table, and the commit selection phase will
prioritize these when selecting, as they can be written directly
to the new index without having to perform a revision walk to
fill the bitmap. This can greatly speed up the repack of a
repository that already has bitmaps.
4. `bitmap_writer_select_commits`: if bitmap writing is enabled for
a given `pack-objects` run, the sequence of commits generated
during the Counting Objects phase will be stored in an array.
We then use that array to build up the list of selected commits.
Writing a bitmap in the index for each object in the repository
would be cost-prohibitive, so we use a simple heuristic to pick
the commits that will be indexed with bitmaps.
The current heuristics are a simplified version of JGit's
original implementation. We select a higher density of commits
depending on their age: the 100 most recent commits are always
selected, after that we pick 1 commit of each 100, and the gap
increases as the commits grow older. On top of that, we make sure
that every single branch that has not been merged (all the tips
that would be required from a clone) gets their own bitmap, and
when selecting commits between a gap, we tend to prioritize the
commit with the most parents.
Do note that there is no right/wrong way to perform commit
selection; different selection algorithms will result in
different commits being selected, but there's no such thing as
"missing a commit". The bitmap walker algorithm implemented in
`prepare_bitmap_walk` is able to adapt to missing bitmaps by
performing manual walks that complete the bitmap: the ideal
selection algorithm, however, would select the commits that are
more likely to be used as roots for a walk in the future (e.g.
the tips of each branch, and so on) to ensure a bitmap for them
is always available.
5. `bitmap_writer_build`: this is the computationally expensive part
of bitmap generation. Based on the list of commits that were
selected in the previous step, we perform several incremental
walks to generate the bitmap for each commit.
The walks begin from the oldest commit, and are built up
incrementally for each branch. E.g. consider this dag where A, B,
C, D, E, F are the selected commits, and a, b, c, e are a chunk
of simplified history that will not receive bitmaps.
A---a---B--b--C--c--D
\
E--e--F
We start by building the bitmap for A, using A as the root for a
revision walk and marking all the objects that are reachable
until the walk is over. Once this bitmap is stored, we reuse the
bitmap walker to perform the walk for B, assuming that once we
reach A again, the walk will be terminated because A has already
been SEEN on the previous walk.
This process is repeated for C, and D, but when we try to
generate the bitmaps for E, we can reuse neither the current walk
nor the bitmap we have generated so far.
What we do now is resetting both the walk and clearing the
bitmap, and performing the walk from scratch using E as the
origin. This new walk, however, does not need to be completed.
Once we hit B, we can lookup the bitmap we have already stored
for that commit and OR it with the existing bitmap we've composed
so far, allowing us to limit the walk early.
After all the bitmaps have been generated, another iteration
through the list of commits is performed to find the best XOR
offsets for compression before writing them to disk. Because of
the incremental nature of these bitmaps, XORing one of them with
its predecesor results in a minimal "bitmap delta" most of the
time. We can write this delta to the on-disk bitmap index, and
then re-compose the original bitmaps by XORing them again when
loaded.
This is a phase very similar to pack-object's `find_delta` (using
bitmaps instead of objects, of course), except the heuristics
have been greatly simplified: we only check the 10 bitmaps before
any given one to find best compressing one. This gives good
results in practice, because there is locality in the ordering of
the objects (and therefore bitmaps) in the packfile.
6. `bitmap_writer_finish`: the last step in the process is
serializing to disk all the bitmap data that has been generated
in the two previous steps.
The bitmap is written to a tmp file and then moved atomically to
its final destination, using the same process as
`pack-write.c:write_idx_file`.
Signed-off-by: Vicent Marti <tanoku@gmail.com>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-12-21 15:00:16 +01:00
|
|
|
|
pack-bitmap: implement optional name_hash cache
When we use pack bitmaps rather than walking the object
graph, we end up with the list of objects to include in the
packfile, but we do not know the path at which any tree or
blob objects would be found.
In a recently packed repository, this is fine. A fetch would
use the paths only as a heuristic in the delta compression
phase, and a fully packed repository should not need to do
much delta compression.
As time passes, though, we may acquire more objects on top
of our large bitmapped pack. If clients fetch frequently,
then they never even look at the bitmapped history, and all
works as usual. However, a client who has not fetched since
the last bitmap repack will have "have" tips in the
bitmapped history, but "want" newer objects.
The bitmaps themselves degrade gracefully in this
circumstance. We manually walk the more recent bits of
history, and then use bitmaps when we hit them.
But we would also like to perform delta compression between
the newer objects and the bitmapped objects (both to delta
against what we know the user already has, but also between
"new" and "old" objects that the user is fetching). The lack
of pathnames makes our delta heuristics much less effective.
This patch adds an optional cache of the 32-bit name_hash
values to the end of the bitmap file. If present, a reader
can use it to match bitmapped and non-bitmapped names during
delta compression.
Here are perf results for p5310:
Test origin/master HEAD^ HEAD
-------------------------------------------------------------------------------------------------
5310.2: repack to disk 36.81(37.82+1.43) 47.70(48.74+1.41) +29.6% 47.75(48.70+1.51) +29.7%
5310.3: simulated clone 30.78(29.70+2.14) 1.08(0.97+0.10) -96.5% 1.07(0.94+0.12) -96.5%
5310.4: simulated fetch 3.16(6.10+0.08) 3.54(10.65+0.06) +12.0% 1.70(3.07+0.06) -46.2%
5310.6: partial bitmap 36.76(43.19+1.81) 6.71(11.25+0.76) -81.7% 4.08(6.26+0.46) -88.9%
You can see that the time spent on an incremental fetch goes
down, as our delta heuristics are able to do their work.
And we save time on the partial bitmap clone for the same
reason.
Signed-off-by: Vicent Marti <tanoku@gmail.com>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-12-21 15:00:45 +01:00
|
|
|
pack.writeBitmapHashCache::
|
|
|
|
When true, git will include a "hash cache" section in the bitmap
|
|
|
|
index (if one is written). This cache can be used to feed git's
|
|
|
|
delta heuristics, potentially leading to better deltas between
|
|
|
|
bitmapped and non-bitmapped objects (e.g., when serving a fetch
|
|
|
|
between an older, bitmapped pack and objects that have been
|
|
|
|
pushed since the last gc). The downside is that it consumes 4
|
|
|
|
bytes per object of disk space, and that JGit's bitmap
|
|
|
|
implementation does not understand it, causing it to complain if
|
|
|
|
Git and JGit are used on the same repository. Defaults to false.
|
|
|
|
|
2008-08-16 04:14:33 +02:00
|
|
|
pager.<cmd>::
|
2010-11-17 18:04:12 +01:00
|
|
|
If the value is boolean, turns on or off pagination of the
|
2013-01-21 20:17:53 +01:00
|
|
|
output of a particular Git subcommand when writing to a tty.
|
2010-11-17 18:04:12 +01:00
|
|
|
Otherwise, turns on pagination for the subcommand using the
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
pager specified by the value of `pager.<cmd>`. If `--paginate`
|
|
|
|
or `--no-pager` is specified on the command line, it takes
|
2010-11-17 18:04:12 +01:00
|
|
|
precedence over this option. To disable pagination for all
|
|
|
|
commands, set `core.pager` or `GIT_PAGER` to `cat`.
|
2008-08-16 04:14:33 +02:00
|
|
|
|
2010-05-02 13:00:44 +02:00
|
|
|
pretty.<name>::
|
|
|
|
Alias for a --pretty= format string, as specified in
|
|
|
|
linkgit:git-log[1]. Any aliases defined here can be used just
|
|
|
|
as the built-in pretty formats could. For example,
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
running `git config pretty.changelog "format:* %H %s"`
|
2010-05-02 13:00:44 +02:00
|
|
|
would cause the invocation `git log --pretty=changelog`
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
to be equivalent to running `git log "--pretty=format:* %H %s"`.
|
2010-05-02 13:00:44 +02:00
|
|
|
Note that an alias with the same name as a built-in format
|
|
|
|
will be silently ignored.
|
|
|
|
|
2016-12-14 23:39:52 +01:00
|
|
|
protocol.allow::
|
|
|
|
If set, provide a user defined default policy for all protocols which
|
|
|
|
don't explicitly have a policy (`protocol.<name>.allow`). By default,
|
|
|
|
if unset, known-safe protocols (http, https, git, ssh, file) have a
|
|
|
|
default policy of `always`, known-dangerous protocols (ext) have a
|
|
|
|
default policy of `never`, and all other protocols have a default
|
|
|
|
policy of `user`. Supported policies:
|
|
|
|
+
|
|
|
|
--
|
|
|
|
|
|
|
|
* `always` - protocol is always able to be used.
|
|
|
|
|
|
|
|
* `never` - protocol is never able to be used.
|
|
|
|
|
|
|
|
* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
|
|
|
|
either unset or has a value of 1. This policy should be used when you want a
|
|
|
|
protocol to be directly usable by the user but don't want it used by commands which
|
|
|
|
execute clone/fetch/push commands without user input, e.g. recursive
|
|
|
|
submodule initialization.
|
|
|
|
|
|
|
|
--
|
|
|
|
|
|
|
|
protocol.<name>.allow::
|
|
|
|
Set a policy to be used by protocol `<name>` with clone/fetch/push
|
|
|
|
commands. See `protocol.allow` above for the available policies.
|
|
|
|
+
|
|
|
|
The protocol names currently used by git are:
|
|
|
|
+
|
|
|
|
--
|
|
|
|
- `file`: any local file-based path (including `file://` URLs,
|
|
|
|
or local paths)
|
|
|
|
|
|
|
|
- `git`: the anonymous git protocol over a direct TCP
|
|
|
|
connection (or proxy, if configured)
|
|
|
|
|
|
|
|
- `ssh`: git over ssh (including `host:path` syntax,
|
|
|
|
`ssh://`, etc).
|
|
|
|
|
|
|
|
- `http`: git over http, both "smart http" and "dumb http".
|
|
|
|
Note that this does _not_ include `https`; if you want to configure
|
|
|
|
both, you must do so individually.
|
|
|
|
|
|
|
|
- any external helpers are named by their protocol (e.g., use
|
|
|
|
`hg` to allow the `git-remote-hg` helper)
|
|
|
|
--
|
|
|
|
|
2017-10-16 19:55:24 +02:00
|
|
|
protocol.version::
|
|
|
|
Experimental. If set, clients will attempt to communicate with a
|
|
|
|
server using the specified protocol version. If unset, no
|
|
|
|
attempt will be made by the client to communicate using a
|
|
|
|
particular protocol version, this results in protocol version 0
|
|
|
|
being used.
|
|
|
|
Supported versions:
|
|
|
|
+
|
|
|
|
--
|
|
|
|
|
|
|
|
* `0` - the original wire protocol.
|
|
|
|
|
|
|
|
* `1` - the original wire protocol with the addition of a version string
|
|
|
|
in the initial response from the server.
|
|
|
|
|
2018-09-10 23:21:57 +02:00
|
|
|
* `2` - link:technical/protocol-v2.html[wire protocol version 2].
|
|
|
|
|
2017-10-16 19:55:24 +02:00
|
|
|
--
|
|
|
|
|
2018-08-22 18:06:00 +02:00
|
|
|
include::pull-config.txt[]
|
2017-10-23 13:44:49 +02:00
|
|
|
|
2018-08-22 18:06:01 +02:00
|
|
|
include::push-config.txt[]
|
2015-11-17 12:05:56 +01:00
|
|
|
|
2017-12-03 23:17:13 +01:00
|
|
|
include::rebase-config.txt[]
|
2015-06-13 18:26:58 +02:00
|
|
|
|
2018-08-22 18:06:02 +02:00
|
|
|
include::receive-config.txt[]
|
2013-12-05 14:02:47 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
remote.pushDefault::
|
2013-04-02 09:40:33 +02:00
|
|
|
The remote to push to by default. Overrides
|
2013-04-02 09:40:34 +02:00
|
|
|
`branch.<name>.remote` for all branches, and is overridden by
|
2015-03-11 21:32:45 +01:00
|
|
|
`branch.<name>.pushRemote` for specific branches.
|
2013-04-02 09:40:33 +02:00
|
|
|
|
2006-10-23 18:42:14 +02:00
|
|
|
remote.<name>.url::
|
2007-12-29 07:20:38 +01:00
|
|
|
The URL of a remote repository. See linkgit:git-fetch[1] or
|
|
|
|
linkgit:git-push[1].
|
2006-10-23 18:42:14 +02:00
|
|
|
|
2009-06-09 18:01:34 +02:00
|
|
|
remote.<name>.pushurl::
|
|
|
|
The push URL of a remote repository. See linkgit:git-push[1].
|
|
|
|
|
2007-12-03 22:48:54 +01:00
|
|
|
remote.<name>.proxy::
|
|
|
|
For remotes that require curl (http, https and ftp), the URL to
|
|
|
|
the proxy to use for that remote. Set to the empty string to
|
|
|
|
disable proxying for that remote.
|
|
|
|
|
2016-01-26 14:02:47 +01:00
|
|
|
remote.<name>.proxyAuthMethod::
|
|
|
|
For remotes that require curl (http, https and ftp), the method to use for
|
|
|
|
authenticating against the proxy in use (probably set in
|
|
|
|
`remote.<name>.proxy`). See `http.proxyAuthMethod`.
|
|
|
|
|
2006-10-23 18:42:14 +02:00
|
|
|
remote.<name>.fetch::
|
2007-12-29 07:20:38 +01:00
|
|
|
The default set of "refspec" for linkgit:git-fetch[1]. See
|
|
|
|
linkgit:git-fetch[1].
|
2006-10-23 18:42:14 +02:00
|
|
|
|
|
|
|
remote.<name>.push::
|
2007-12-29 07:20:38 +01:00
|
|
|
The default set of "refspec" for linkgit:git-push[1]. See
|
|
|
|
linkgit:git-push[1].
|
2006-10-23 18:42:14 +02:00
|
|
|
|
2008-04-17 13:17:20 +02:00
|
|
|
remote.<name>.mirror::
|
|
|
|
If true, pushing to this remote will automatically behave
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 10:51:57 +02:00
|
|
|
as if the `--mirror` option was given on the command line.
|
2008-04-17 13:17:20 +02:00
|
|
|
|
2007-02-20 21:13:43 +01:00
|
|
|
remote.<name>.skipDefaultUpdate::
|
|
|
|
If true, this remote will be skipped by default when updating
|
2009-11-09 21:11:06 +01:00
|
|
|
using linkgit:git-fetch[1] or the `update` subcommand of
|
|
|
|
linkgit:git-remote[1].
|
|
|
|
|
|
|
|
remote.<name>.skipFetchAll::
|
|
|
|
If true, this remote will be skipped by default when updating
|
|
|
|
using linkgit:git-fetch[1] or the `update` subcommand of
|
|
|
|
linkgit:git-remote[1].
|
2007-02-20 21:13:43 +01:00
|
|
|
|
2007-01-19 13:46:16 +01:00
|
|
|
remote.<name>.receivepack::
|
2007-01-25 05:45:39 +01:00
|
|
|
The default program to execute on the remote side when pushing. See
|
2015-05-13 07:01:38 +02:00
|
|
|
option --receive-pack of linkgit:git-push[1].
|
2007-01-19 13:46:16 +01:00
|
|
|
|
2007-01-25 05:45:39 +01:00
|
|
|
remote.<name>.uploadpack::
|
|
|
|
The default program to execute on the remote side when fetching. See
|
2015-05-13 07:01:38 +02:00
|
|
|
option --upload-pack of linkgit:git-fetch-pack[1].
|
2007-01-25 05:45:39 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
remote.<name>.tagOpt::
|
2015-05-13 07:01:38 +02:00
|
|
|
Setting this value to --no-tags disables automatic tag following when
|
|
|
|
fetching from remote <name>. Setting it to --tags will fetch every
|
2010-04-20 01:31:25 +02:00
|
|
|
tag from remote <name>, even if they are not reachable from remote
|
2010-08-12 00:57:20 +02:00
|
|
|
branch heads. Passing these flags directly to linkgit:git-fetch[1] can
|
2015-05-13 07:01:38 +02:00
|
|
|
override this setting. See options --tags and --no-tags of
|
2010-08-12 00:57:20 +02:00
|
|
|
linkgit:git-fetch[1].
|
2007-02-24 16:32:56 +01:00
|
|
|
|
2009-11-18 02:42:25 +01:00
|
|
|
remote.<name>.vcs::
|
2013-01-21 20:17:53 +01:00
|
|
|
Setting this to a value <vcs> will cause Git to interact with
|
2009-11-18 02:42:25 +01:00
|
|
|
the remote with the git-remote-<vcs> helper.
|
|
|
|
|
2013-07-13 11:36:24 +02:00
|
|
|
remote.<name>.prune::
|
|
|
|
When set to true, fetching from this remote by default will also
|
fetch --prune: prune only based on explicit refspecs
The old behavior of "fetch --prune" was to prune whatever was being
fetched. In particular, "fetch --prune --tags" caused tags not only
to be fetched, but also to be pruned. This is inappropriate because
there is only one tags namespace that is shared among the local
repository and all remotes. Therefore, if the user defines a local
tag and then runs "git fetch --prune --tags", then the local tag is
deleted. Moreover, "--prune" and "--tags" can also be configured via
fetch.prune / remote.<name>.prune and remote.<name>.tagopt, making it
even less obvious that an invocation of "git fetch" could result in
tag lossage.
Since the command "git remote update" invokes "git fetch", it had the
same problem.
The command "git remote prune", on the other hand, disregarded the
setting of remote.<name>.tagopt, and so its behavior was inconsistent
with that of the other commands.
So the old behavior made it too easy to lose tags. To fix this
problem, change "fetch --prune" to prune references based only on
refspecs specified explicitly by the user, either on the command line
or via remote.<name>.fetch. Thus, tags are no longer made subject to
pruning by the --tags option or the remote.<name>.tagopt setting.
However, tags *are* still subject to pruning if they are fetched as
part of a refspec, and that is good. For example:
* On the command line,
git fetch --prune 'refs/tags/*:refs/tags/*'
causes tags, and only tags, to be fetched and pruned, and is
therefore a simple way for the user to get the equivalent of the old
behavior of "--prune --tag".
* For a remote that was configured with the "--mirror" option, the
configuration is set to include
[remote "name"]
fetch = +refs/*:refs/*
, which causes tags to be subject to pruning along with all other
references. This is the behavior that will typically be desired for
a mirror.
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-10-30 06:33:00 +01:00
|
|
|
remove any remote-tracking references that no longer exist on the
|
|
|
|
remote (as if the `--prune` option was given on the command line).
|
2013-07-13 11:36:24 +02:00
|
|
|
Overrides `fetch.prune` settings, if any.
|
|
|
|
|
fetch: add a --prune-tags option and fetch.pruneTags config
Add a --prune-tags option to git-fetch, along with fetch.pruneTags
config option and a -P shorthand (-p is --prune). This allows for
doing any of:
git fetch -p -P
git fetch --prune --prune-tags
git fetch -p -P origin
git fetch --prune --prune-tags origin
Or simply:
git config fetch.prune true &&
git config fetch.pruneTags true &&
git fetch
Instead of the much more verbose:
git fetch --prune origin 'refs/tags/*:refs/tags/*' '+refs/heads/*:refs/remotes/origin/*'
Before this feature it was painful to support the use-case of pulling
from a repo which is having both its branches *and* tags deleted
regularly, and have our local references to reflect upstream.
At work we create deployment tags in the repo for each rollout, and
there's *lots* of those, so they're archived within weeks for
performance reasons.
Without this change it's hard to centrally configure such repos in
/etc/gitconfig (on servers that are only used for working with
them). You need to set fetch.prune=true globally, and then for each
repo:
git -C {} config --replace-all remote.origin.fetch "refs/tags/*:refs/tags/*" "^\+*refs/tags/\*:refs/tags/\*$"
Now I can simply set fetch.pruneTags=true in /etc/gitconfig as well,
and users running "git pull" will automatically get the pruning
semantics I want.
Even though "git remote" has corresponding "prune" and "update
--prune" subcommands I'm intentionally not adding a corresponding
prune-tags or "update --prune --prune-tags" mode to that command.
It's advertised (as noted in my recent "git remote doc: correct
dangerous lies about what prune does") as only modifying remote
tracking references, whereas any --prune-tags option is always going
to modify what from the user's perspective is a local copy of the tag,
since there's no such thing as a remote tracking tag.
Ideally add_prune_tags_to_fetch_refspec() would be something that
would use ALLOC_GROW() to grow the 'fetch` member of the 'remote'
struct. Instead I'm realloc-ing remote->fetch and adding the
tag_refspec to the end.
The reason is that parse_{fetch,push}_refspec which allocate the
refspec (ultimately remote->fetch) struct are called many places that
don't have access to a 'remote' struct. It would be hard to change all
their callsites to be amenable to carry around the bookkeeping
variables required for dynamic allocation.
All the other callers of the API first incrementally construct the
string version of the refspec in remote->fetch_refspec via
add_fetch_refspec(), before finally calling parse_fetch_refspec() via
some variation of remote_get().
It's less of a pain to deal with the one special case that needs to
modify already constructed refspecs than to chase down and change all
the other callsites. The API I'm adding is intentionally not
generalized because if we add more of these we'd probably want to
re-visit how this is done.
See my "Re: [BUG] git remote prune removes local tags, depending on
fetch config" (87po6ahx87.fsf@evledraar.gmail.com;
https://public-inbox.org/git/87po6ahx87.fsf@evledraar.gmail.com/) for
more background info.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-02-09 21:32:15 +01:00
|
|
|
remote.<name>.pruneTags::
|
|
|
|
When set to true, fetching from this remote by default will also
|
|
|
|
remove any local tags that no longer exist on the remote if pruning
|
|
|
|
is activated in general via `remote.<name>.prune`, `fetch.prune` or
|
|
|
|
`--prune`. Overrides `fetch.pruneTags` settings, if any.
|
2018-02-09 21:32:13 +01:00
|
|
|
+
|
|
|
|
See also `remote.<name>.prune` and the PRUNING section of
|
|
|
|
linkgit:git-fetch[1].
|
2013-07-13 11:36:24 +02:00
|
|
|
|
2007-02-20 21:13:43 +01:00
|
|
|
remotes.<group>::
|
|
|
|
The list of remotes which are fetched by "git remote update
|
2007-12-29 07:20:38 +01:00
|
|
|
<group>". See linkgit:git-remote[1].
|
2007-02-20 21:13:43 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
repack.useDeltaBaseOffset::
|
2008-06-25 06:24:53 +02:00
|
|
|
By default, linkgit:git-repack[1] creates packs that use
|
|
|
|
delta-base offset. If you need to share your repository with
|
2013-01-21 20:17:53 +01:00
|
|
|
Git older than version 1.4.4, either directly or via a dumb
|
2008-06-25 06:24:53 +02:00
|
|
|
protocol such as http, then you need to set this option to
|
2013-01-21 20:17:53 +01:00
|
|
|
"false" and repack. Access from old Git versions over the
|
2008-06-25 06:24:53 +02:00
|
|
|
native protocol are unaffected by this option.
|
2006-10-14 06:28:58 +02:00
|
|
|
|
repack: add `repack.packKeptObjects` config var
The git-repack command always passes `--honor-pack-keep`
to pack-objects. This has traditionally been a good thing,
as we do not want to duplicate those objects in a new pack,
and we are not going to delete the old pack.
However, when bitmaps are in use, it is important for a full
repack to include all reachable objects, even if they may be
duplicated in a .keep pack. Otherwise, we cannot generate
the bitmaps, as the on-disk format requires the set of
objects in the pack to be fully closed.
Even if the repository does not generally have .keep files,
a simultaneous push could cause a race condition in which a
.keep file exists at the moment of a repack. The repack may
try to include those objects in one of two situations:
1. The pushed .keep pack contains objects that were
already in the repository (e.g., blobs due to a revert of
an old commit).
2. Receive-pack updates the refs, making the objects
reachable, but before it removes the .keep file, the
repack runs.
In either case, we may prefer to duplicate some objects in
the new, full pack, and let the next repack (after the .keep
file is cleaned up) take care of removing them.
This patch introduces both a command-line and config option
to disable the `--honor-pack-keep` option. By default, it
is triggered when pack.writeBitmaps (or `--write-bitmap-index`
is turned on), but specifying it explicitly can override the
behavior (e.g., in cases where you prefer .keep files to
bitmaps, but only when they are present).
Note that this option just disables the pack-objects
behavior. We still leave packs with a .keep in place, as we
do not necessarily know that we have duplicated all of their
objects.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-03-03 21:04:20 +01:00
|
|
|
repack.packKeptObjects::
|
|
|
|
If set to true, makes `git repack` act as if
|
|
|
|
`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
|
|
|
|
details. Defaults to `false` normally, but `true` if a bitmap
|
|
|
|
index is being written (either via `--write-bitmap-index` or
|
2014-06-10 22:20:30 +02:00
|
|
|
`repack.writeBitmaps`).
|
|
|
|
|
2018-08-16 08:13:10 +02:00
|
|
|
repack.useDeltaIslands::
|
|
|
|
If set to true, makes `git repack` act as if `--delta-islands`
|
|
|
|
was passed. Defaults to `false`.
|
|
|
|
|
2014-06-10 22:20:30 +02:00
|
|
|
repack.writeBitmaps::
|
|
|
|
When true, git will write a bitmap index when packing all
|
|
|
|
objects to disk (e.g., when `git repack -a` is run). This
|
|
|
|
index can speed up the "counting objects" phase of subsequent
|
|
|
|
packs created for clones and fetches, at the cost of some disk
|
2016-04-28 09:28:55 +02:00
|
|
|
space and extra time spent on the initial repack. This has
|
|
|
|
no effect if multiple packfiles are created.
|
|
|
|
Defaults to false.
|
repack: add `repack.packKeptObjects` config var
The git-repack command always passes `--honor-pack-keep`
to pack-objects. This has traditionally been a good thing,
as we do not want to duplicate those objects in a new pack,
and we are not going to delete the old pack.
However, when bitmaps are in use, it is important for a full
repack to include all reachable objects, even if they may be
duplicated in a .keep pack. Otherwise, we cannot generate
the bitmaps, as the on-disk format requires the set of
objects in the pack to be fully closed.
Even if the repository does not generally have .keep files,
a simultaneous push could cause a race condition in which a
.keep file exists at the moment of a repack. The repack may
try to include those objects in one of two situations:
1. The pushed .keep pack contains objects that were
already in the repository (e.g., blobs due to a revert of
an old commit).
2. Receive-pack updates the refs, making the objects
reachable, but before it removes the .keep file, the
repack runs.
In either case, we may prefer to duplicate some objects in
the new, full pack, and let the next repack (after the .keep
file is cleaned up) take care of removing them.
This patch introduces both a command-line and config option
to disable the `--honor-pack-keep` option. By default, it
is triggered when pack.writeBitmaps (or `--write-bitmap-index`
is turned on), but specifying it explicitly can override the
behavior (e.g., in cases where you prefer .keep files to
bitmaps, but only when they are present).
Note that this option just disables the pack-objects
behavior. We still leave packs with a .keep in place, as we
do not necessarily know that we have duplicated all of their
objects.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-03-03 21:04:20 +01:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
rerere.autoUpdate::
|
2008-11-26 09:26:50 +01:00
|
|
|
When set to true, `git-rerere` updates the index with the
|
|
|
|
resulting contents after it cleanly resolves conflicts using
|
|
|
|
previously recorded resolution. Defaults to false.
|
|
|
|
|
|
|
|
rerere.enabled::
|
|
|
|
Activate recording of resolved conflicts, so that identical
|
2012-01-06 14:08:02 +01:00
|
|
|
conflict hunks can be resolved automatically, should they be
|
|
|
|
encountered again. By default, linkgit:git-rerere[1] is
|
|
|
|
enabled if there is an `rr-cache` directory under the
|
2012-01-10 15:57:27 +01:00
|
|
|
`$GIT_DIR`, e.g. if "rerere" was previously used in the
|
|
|
|
repository.
|
2008-11-26 09:26:50 +01:00
|
|
|
|
2018-10-23 21:04:22 +02:00
|
|
|
reset.quiet::
|
|
|
|
When set to true, 'git reset' will default to the '--quiet' option.
|
|
|
|
|
2018-08-22 18:06:03 +02:00
|
|
|
include::sendemail-config.txt[]
|
2017-05-21 14:59:50 +02:00
|
|
|
|
2018-08-22 18:06:04 +02:00
|
|
|
sequence.editor::
|
|
|
|
Text editor used by `git rebase -i` for editing the rebase instruction file.
|
|
|
|
The value is meant to be interpreted by the shell when it is used.
|
|
|
|
It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
|
|
|
|
When not configured the default commit message editor is used instead.
|
|
|
|
|
2018-08-22 18:05:55 +02:00
|
|
|
showBranch.default::
|
2007-12-29 07:20:38 +01:00
|
|
|
The default set of branches for linkgit:git-show-branch[1].
|
|
|
|
See linkgit:git-show-branch[1].
|
2006-04-25 00:59:33 +02:00
|
|
|
|
2017-02-27 19:00:10 +01:00
|
|
|
splitIndex.maxPercentChange::
|
|
|
|
When the split index feature is used, this specifies the
|
|
|
|
percent of entries the split index can contain compared to the
|
|
|
|
total number of entries in both the split index and the shared
|
|
|
|
index before a new shared index is written.
|
|
|
|
The value should be between 0 and 100. If the value is 0 then
|
|
|
|
a new shared index is always written, if it is 100 a new
|
|
|
|
shared index is never written.
|
|
|
|
By default the value is 20, so a new shared index is written
|
|
|
|
if the number of entries in the split index would be greater
|
|
|
|
than 20 percent of the total number of entries.
|
|
|
|
See linkgit:git-update-index[1].
|
|
|
|
|
2017-03-06 10:42:02 +01:00
|
|
|
splitIndex.sharedIndexExpire::
|
|
|
|
When the split index feature is used, shared index files that
|
|
|
|
were not modified since the time this variable specifies will
|
|
|
|
be removed when a new shared index file is created. The value
|
|
|
|
"now" expires all entries immediately, and "never" suppresses
|
|
|
|
expiration altogether.
|
|
|
|
The default value is "2.weeks.ago".
|
|
|
|
Note that a shared index file is considered modified (for the
|
|
|
|
purpose of expiration) each time a new split-index file is
|
2017-03-06 10:42:03 +01:00
|
|
|
either created based on it or read from it.
|
2017-03-06 10:42:02 +01:00
|
|
|
See linkgit:git-update-index[1].
|
|
|
|
|
2007-12-07 22:26:07 +01:00
|
|
|
status.relativePaths::
|
2007-12-29 07:20:38 +01:00
|
|
|
By default, linkgit:git-status[1] shows paths relative to the
|
2007-12-07 22:26:07 +01:00
|
|
|
current directory. Setting this variable to `false` shows paths
|
2013-01-21 20:17:53 +01:00
|
|
|
relative to the repository root (this was the default for Git
|
2007-12-07 22:26:07 +01:00
|
|
|
prior to v1.5.4).
|
|
|
|
|
2013-06-11 15:34:04 +02:00
|
|
|
status.short::
|
|
|
|
Set to true to enable --short by default in linkgit:git-status[1].
|
|
|
|
The option --no-short takes precedence over this variable.
|
|
|
|
|
2013-06-11 15:34:05 +02:00
|
|
|
status.branch::
|
|
|
|
Set to true to enable --branch by default in linkgit:git-status[1].
|
|
|
|
The option --no-branch takes precedence over this variable.
|
|
|
|
|
2013-09-06 19:43:07 +02:00
|
|
|
status.displayCommentPrefix::
|
|
|
|
If set to true, linkgit:git-status[1] will insert a comment
|
|
|
|
prefix before each output line (starting with
|
|
|
|
`core.commentChar`, i.e. `#` by default). This was the
|
|
|
|
behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
|
|
|
|
Defaults to false.
|
|
|
|
|
2018-05-11 17:38:58 +02:00
|
|
|
status.renameLimit::
|
|
|
|
The number of files to consider when performing rename detection
|
|
|
|
in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
|
|
|
|
the value of diff.renameLimit.
|
|
|
|
|
|
|
|
status.renames::
|
|
|
|
Whether and how Git detects renames in linkgit:git-status[1] and
|
|
|
|
linkgit:git-commit[1] . If set to "false", rename detection is
|
|
|
|
disabled. If set to "true", basic rename detection is enabled.
|
|
|
|
If set to "copies" or "copy", Git will detect copies, as well.
|
|
|
|
Defaults to the value of diff.renames.
|
|
|
|
|
2017-06-18 00:30:51 +02:00
|
|
|
status.showStash::
|
|
|
|
If set to true, linkgit:git-status[1] will display the number of
|
|
|
|
entries currently stashed away.
|
|
|
|
Defaults to false.
|
|
|
|
|
2008-06-05 14:47:50 +02:00
|
|
|
status.showUntrackedFiles::
|
|
|
|
By default, linkgit:git-status[1] and linkgit:git-commit[1] show
|
|
|
|
files which are not currently tracked by Git. Directories which
|
|
|
|
contain only untracked files, are shown with the directory name
|
|
|
|
only. Showing untracked files means that Git needs to lstat() all
|
2014-11-09 17:19:33 +01:00
|
|
|
the files in the whole repository, which might be slow on some
|
2008-06-05 14:47:50 +02:00
|
|
|
systems. So, this variable controls how the commands displays
|
|
|
|
the untracked files. Possible values are:
|
|
|
|
+
|
|
|
|
--
|
2010-10-18 05:10:45 +02:00
|
|
|
* `no` - Show no untracked files.
|
|
|
|
* `normal` - Show untracked files and directories.
|
|
|
|
* `all` - Show also individual files in untracked directories.
|
2008-06-05 14:47:50 +02:00
|
|
|
--
|
|
|
|
+
|
|
|
|
If this variable is not specified, it defaults to 'normal'.
|
|
|
|
This variable can be overridden with the -u|--untracked-files option
|
|
|
|
of linkgit:git-status[1] and linkgit:git-commit[1].
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
status.submoduleSummary::
|
2010-05-20 17:55:42 +02:00
|
|
|
Defaults to false.
|
|
|
|
If this is set to a non zero number or true (identical to -1 or an
|
|
|
|
unlimited number), the submodule summary will be enabled and a
|
|
|
|
summary of commits for modified submodules will be shown (see
|
2013-09-11 21:07:15 +02:00
|
|
|
--summary-limit option of linkgit:git-submodule[1]). Please note
|
|
|
|
that the summary output command will be suppressed for all
|
|
|
|
submodules when `diff.ignoreSubmodules` is set to 'all' or only
|
2014-04-05 18:59:03 +02:00
|
|
|
for those submodules where `submodule.<name>.ignore=all`. The only
|
|
|
|
exception to that rule is that status and commit will show staged
|
|
|
|
submodule changes. To
|
2013-09-11 21:07:15 +02:00
|
|
|
also view the summary for ignored submodules you can either use
|
2014-05-21 20:52:26 +02:00
|
|
|
the --ignore-submodules=dirty command-line option or the 'git
|
2013-09-11 21:07:15 +02:00
|
|
|
submodule summary' command, which shows a similar output but does
|
|
|
|
not honor these settings.
|
2010-05-20 17:55:42 +02:00
|
|
|
|
2015-08-29 17:25:57 +02:00
|
|
|
stash.showPatch::
|
|
|
|
If this is set to true, the `git stash show` command without an
|
2017-06-18 00:30:50 +02:00
|
|
|
option will show the stash entry in patch form. Defaults to false.
|
2015-08-29 17:25:57 +02:00
|
|
|
See description of 'show' command in linkgit:git-stash[1].
|
|
|
|
|
|
|
|
stash.showStat::
|
|
|
|
If this is set to true, the `git stash show` command without an
|
2017-06-18 00:30:50 +02:00
|
|
|
option will show diffstat of the stash entry. Defaults to true.
|
2015-08-29 17:25:57 +02:00
|
|
|
See description of 'show' command in linkgit:git-stash[1].
|
|
|
|
|
2018-08-22 18:06:05 +02:00
|
|
|
include::submodule-config.txt[]
|
2016-08-18 00:45:35 +02:00
|
|
|
|
2016-03-22 21:41:26 +01:00
|
|
|
tag.forceSignAnnotated::
|
|
|
|
A boolean to specify whether annotated tags created should be GPG signed.
|
|
|
|
If `--annotate` is specified on the command line, it takes
|
|
|
|
precedence over this option.
|
|
|
|
|
2014-07-16 23:48:02 +02:00
|
|
|
tag.sort::
|
|
|
|
This variable controls the sort ordering of tags when displayed by
|
|
|
|
linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
|
|
|
|
value of this variable will be used as the default.
|
|
|
|
|
2006-07-20 11:30:44 +02:00
|
|
|
tar.umask::
|
2007-08-21 20:01:16 +02:00
|
|
|
This variable can be used to restrict the permission bits of
|
|
|
|
tar archive entries. The default is 0002, which turns off the
|
|
|
|
world write bit. The special value "user" indicates that the
|
|
|
|
archiving user's umask will be used instead. See umask(2) and
|
2007-12-29 07:20:38 +01:00
|
|
|
linkgit:git-archive[1].
|
2006-07-20 11:30:44 +02:00
|
|
|
|
2011-09-04 21:37:45 +02:00
|
|
|
transfer.fsckObjects::
|
|
|
|
When `fetch.fsckObjects` or `receive.fsckObjects` are
|
|
|
|
not set, the value of this variable is used instead.
|
|
|
|
Defaults to false.
|
2018-07-27 16:37:12 +02:00
|
|
|
+
|
|
|
|
When set, the fetch or receive will abort in the case of a malformed
|
2018-07-27 16:37:14 +02:00
|
|
|
object or a link to a nonexistent object. In addition, various other
|
|
|
|
issues are checked for, including legacy issues (see `fsck.<msg-id>`),
|
|
|
|
and potential security issues like the existence of a `.GIT` directory
|
|
|
|
or a malicious `.gitmodules` file (see the release notes for v2.2.1
|
|
|
|
and v2.17.1 for details). Other sanity and security checks may be
|
|
|
|
added in future releases.
|
|
|
|
+
|
|
|
|
On the receiving side, failing fsckObjects will make those objects
|
|
|
|
unreachable, see "QUARANTINE ENVIRONMENT" in
|
|
|
|
linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
|
|
|
|
instead be left unreferenced in the repository.
|
2018-07-27 16:37:15 +02:00
|
|
|
+
|
|
|
|
Due to the non-quarantine nature of the `fetch.fsckObjects`
|
|
|
|
implementation it can not be relied upon to leave the object store
|
|
|
|
clean like `receive.fsckObjects` can.
|
|
|
|
+
|
|
|
|
As objects are unpacked they're written to the object store, so there
|
|
|
|
can be cases where malicious objects get introduced even though the
|
|
|
|
"fetch" failed, only to have a subsequent "fetch" succeed because only
|
|
|
|
new incoming objects are checked, not those that have already been
|
|
|
|
written to the object store. That difference in behavior should not be
|
|
|
|
relied upon. In the future, such objects may be quarantined for
|
|
|
|
"fetch" as well.
|
|
|
|
+
|
|
|
|
For now, the paranoid need to find some way to emulate the quarantine
|
|
|
|
environment if they'd like the same protection as "push". E.g. in the
|
|
|
|
case of an internal mirror do the mirroring in two steps, one to fetch
|
|
|
|
the untrusted objects, and then do a second "push" (which will use the
|
|
|
|
quarantine) to another internal repo, and have internal clients
|
|
|
|
consume this pushed-to repository, or embargo internal fetches and
|
|
|
|
only allow them once a full "fsck" has run (and no new fetches have
|
|
|
|
happened in the meantime).
|
2011-09-04 21:37:45 +02:00
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
transfer.hideRefs::
|
2015-07-28 21:59:11 +02:00
|
|
|
String(s) `receive-pack` and `upload-pack` use to decide which
|
|
|
|
refs to omit from their initial advertisements. Use more than
|
|
|
|
one definition to specify multiple prefix strings. A ref that is
|
|
|
|
under the hierarchies listed in the value of this variable is
|
|
|
|
excluded, and is hidden when responding to `git push` or `git
|
|
|
|
fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
|
|
|
|
program-specific versions of this config.
|
refs: support negative transfer.hideRefs
If you hide a hierarchy of refs using the transfer.hideRefs
config, there is no way to later override that config to
"unhide" it. This patch implements a "negative" hide which
causes matches to immediately be marked as unhidden, even if
another match would hide it. We take care to apply the
matches in reverse-order from how they are fed to us by the
config machinery, as that lets our usual "last one wins"
config precedence work (and entries in .git/config, for
example, will override /etc/gitconfig).
So you can now do:
$ git config --system transfer.hideRefs refs/secret
$ git config transfer.hideRefs '!refs/secret/not-so-secret'
to hide refs/secret in all repos, except for one public bit
in one specific repo. Or you can even do:
$ git clone \
-u "git -c transfer.hiderefs="!refs/foo" upload-pack" \
remote:repo.git
to clone remote:repo.git, overriding any hiding it has
configured.
There are two alternatives that were considered and
rejected:
1. A generic config mechanism for removing an item from a
list. E.g.: (e.g., "[transfer] hideRefs -= refs/foo").
This is nice because it could apply to other
multi-valued config, as well. But it is not nearly as
flexible. There is no way to say:
[transfer]
hideRefs = refs/secret
hideRefs = refs/secret/not-so-secret
Having explicit negative specifications means we can
override previous entries, even if they are not the
same literal string.
2. Adding another variable to override some parts of
hideRefs (e.g., "exposeRefs").
This solves the problem from alternative (1), but it
cannot easily obey the normal config precedence,
because it would use two separate lists. For example:
[transfer]
hideRefs = refs/secret
exposeRefs = refs/secret/not-so-secret
hideRefs = refs/secret/not-so-secret/no-really-its-secret
With two lists, we have to apply the "expose" rules
first, and only then apply the "hide" rules. But that
does not match what the above config intends.
Of course we could internally parse that to a single
list, respecting the ordering, which saves us having to
invent the new "!" syntax. But using a single name
communicates to the user that the ordering _is_
important. And "!" is well-known for negation, and
should not appear at the beginning of a ref (it is
actually valid in a ref-name, but all entries here
should be fully-qualified, starting with "refs/").
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2015-07-28 22:23:26 +02:00
|
|
|
+
|
|
|
|
You may also include a `!` in front of the ref name to negate the entry,
|
|
|
|
explicitly exposing it, even if an earlier entry marked it as hidden.
|
|
|
|
If you have multiple hideRefs values, later entries override earlier ones
|
|
|
|
(and entries in more-specific config files override less-specific ones).
|
2015-11-03 08:58:14 +01:00
|
|
|
+
|
|
|
|
If a namespace is in use, the namespace prefix is stripped from each
|
|
|
|
reference before it is matched against `transfer.hiderefs` patterns.
|
|
|
|
For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
|
|
|
|
the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
|
|
|
|
is omitted from the advertisements but `refs/heads/master` and
|
|
|
|
`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
|
2015-11-03 08:58:16 +01:00
|
|
|
"have" lines. In order to match refs before stripping, add a `^` in front of
|
|
|
|
the ref name. If you combine `!` and `^`, `!` must be specified first.
|
2016-11-14 19:20:24 +01:00
|
|
|
+
|
|
|
|
Even if you hide refs, a client may still be able to steal the target
|
|
|
|
objects via the techniques described in the "SECURITY" section of the
|
|
|
|
linkgit:gitnamespaces[7] man page; it's best to keep private data in a
|
|
|
|
separate repository.
|
upload/receive-pack: allow hiding ref hierarchies
A repository may have refs that are only used for its internal
bookkeeping purposes that should not be exposed to the others that
come over the network.
Teach upload-pack to omit some refs from its initial advertisement
by paying attention to the uploadpack.hiderefs multi-valued
configuration variable. Do the same to receive-pack via the
receive.hiderefs variable. As a convenient short-hand, allow using
transfer.hiderefs to set the value to both of these variables.
Any ref that is under the hierarchies listed on the value of these
variable is excluded from responses to requests made by "ls-remote",
"fetch", etc. (for upload-pack) and "push" (for receive-pack).
Because these hidden refs do not count as OUR_REF, an attempt to
fetch objects at the tip of them will be rejected, and because these
refs do not get advertised, "git push :" will not see local branches
that have the same name as them as "matching" ones to be sent.
An attempt to update/delete these hidden refs with an explicit
refspec, e.g. "git push origin :refs/hidden/22", is rejected. This
is not a new restriction. To the pusher, it would appear that there
is no such ref, so its push request will conclude with "Now that I
sent you all the data, it is time for you to update the refs. I saw
that the ref did not exist when I started pushing, and I want the
result to point at this commit". The receiving end will apply the
compare-and-swap rule to this request and rejects the push with
"Well, your update request conflicts with somebody else; I see there
is such a ref.", which is the right thing to do. Otherwise a push to
a hidden ref will always be "the last one wins", which is not a good
default.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-01-19 01:08:30 +01:00
|
|
|
|
2008-11-26 09:26:50 +01:00
|
|
|
transfer.unpackLimit::
|
|
|
|
When `fetch.unpackLimit` or `receive.unpackLimit` are
|
|
|
|
not set, the value of this variable is used instead.
|
|
|
|
The default value is 100.
|
|
|
|
|
add uploadarchive.allowUnreachable option
In commit ee27ca4, we started restricting remote git-archive
invocations to only accessing reachable commits. This
matches what upload-pack allows, but does restrict some
useful cases (e.g., HEAD:foo). We loosened this in 0f544ee,
which allows `foo:bar` as long as `foo` is a ref tip.
However, that still doesn't allow many useful things, like:
1. Commits accessible from a ref, like `foo^:bar`, which
are reachable
2. Arbitrary sha1s, even if they are reachable.
We can do a full object-reachability check for these cases,
but it can be quite expensive if the client has sent us the
sha1 of a tree; we have to visit every sub-tree of every
commit in the worst case.
Let's instead give site admins an escape hatch, in case they
prefer the more liberal behavior. For many sites, the full
object database is public anyway (e.g., if you allow dumb
walker access), or the site admin may simply decide the
security/convenience tradeoff is not worth it.
This patch adds a new config option to disable the
restrictions added in ee27ca4. It defaults to off, meaning
there is no change in behavior by default.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-02-28 11:04:19 +01:00
|
|
|
uploadarchive.allowUnreachable::
|
|
|
|
If true, allow clients to use `git archive --remote` to request
|
|
|
|
any tree, whether reachable from the ref tips or not. See the
|
2016-11-14 19:20:24 +01:00
|
|
|
discussion in the "SECURITY" section of
|
add uploadarchive.allowUnreachable option
In commit ee27ca4, we started restricting remote git-archive
invocations to only accessing reachable commits. This
matches what upload-pack allows, but does restrict some
useful cases (e.g., HEAD:foo). We loosened this in 0f544ee,
which allows `foo:bar` as long as `foo` is a ref tip.
However, that still doesn't allow many useful things, like:
1. Commits accessible from a ref, like `foo^:bar`, which
are reachable
2. Arbitrary sha1s, even if they are reachable.
We can do a full object-reachability check for these cases,
but it can be quite expensive if the client has sent us the
sha1 of a tree; we have to visit every sub-tree of every
commit in the worst case.
Let's instead give site admins an escape hatch, in case they
prefer the more liberal behavior. For many sites, the full
object database is public anyway (e.g., if you allow dumb
walker access), or the site admin may simply decide the
security/convenience tradeoff is not worth it.
This patch adds a new config option to disable the
restrictions added in ee27ca4. It defaults to off, meaning
there is no change in behavior by default.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-02-28 11:04:19 +01:00
|
|
|
linkgit:git-upload-archive[1] for more details. Defaults to
|
|
|
|
`false`.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
uploadpack.hideRefs::
|
2015-07-28 21:59:11 +02:00
|
|
|
This variable is the same as `transfer.hideRefs`, but applies
|
|
|
|
only to `upload-pack` (and so affects only fetches, not pushes).
|
|
|
|
An attempt to fetch a hidden ref by `git fetch` will fail. See
|
|
|
|
also `uploadpack.allowTipSHA1InWant`.
|
2013-01-29 06:49:57 +01:00
|
|
|
|
2015-05-21 22:23:37 +02:00
|
|
|
uploadpack.allowTipSHA1InWant::
|
2015-03-11 21:32:45 +01:00
|
|
|
When `uploadpack.hideRefs` is in effect, allow `upload-pack`
|
2013-01-29 06:49:57 +01:00
|
|
|
to accept a fetch request that asks for an object at the tip
|
|
|
|
of a hidden ref (by default, such a request is rejected).
|
2016-11-14 19:20:24 +01:00
|
|
|
See also `uploadpack.hideRefs`. Even if this is false, a client
|
|
|
|
may be able to steal objects via the techniques described in the
|
|
|
|
"SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
|
|
|
|
best to keep private data in a separate repository.
|
upload/receive-pack: allow hiding ref hierarchies
A repository may have refs that are only used for its internal
bookkeeping purposes that should not be exposed to the others that
come over the network.
Teach upload-pack to omit some refs from its initial advertisement
by paying attention to the uploadpack.hiderefs multi-valued
configuration variable. Do the same to receive-pack via the
receive.hiderefs variable. As a convenient short-hand, allow using
transfer.hiderefs to set the value to both of these variables.
Any ref that is under the hierarchies listed on the value of these
variable is excluded from responses to requests made by "ls-remote",
"fetch", etc. (for upload-pack) and "push" (for receive-pack).
Because these hidden refs do not count as OUR_REF, an attempt to
fetch objects at the tip of them will be rejected, and because these
refs do not get advertised, "git push :" will not see local branches
that have the same name as them as "matching" ones to be sent.
An attempt to update/delete these hidden refs with an explicit
refspec, e.g. "git push origin :refs/hidden/22", is rejected. This
is not a new restriction. To the pusher, it would appear that there
is no such ref, so its push request will conclude with "Now that I
sent you all the data, it is time for you to update the refs. I saw
that the ref did not exist when I started pushing, and I want the
result to point at this commit". The receiving end will apply the
compare-and-swap rule to this request and rejects the push with
"Well, your update request conflicts with somebody else; I see there
is such a ref.", which is the right thing to do. Otherwise a push to
a hidden ref will always be "the last one wins", which is not a good
default.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-01-19 01:08:30 +01:00
|
|
|
|
2015-05-21 22:23:39 +02:00
|
|
|
uploadpack.allowReachableSHA1InWant::
|
|
|
|
Allow `upload-pack` to accept a fetch request that asks for an
|
|
|
|
object that is reachable from any ref tip. However, note that
|
|
|
|
calculating object reachability is computationally expensive.
|
2016-11-14 19:20:24 +01:00
|
|
|
Defaults to `false`. Even if this is false, a client may be able
|
|
|
|
to steal objects via the techniques described in the "SECURITY"
|
|
|
|
section of the linkgit:gitnamespaces[7] man page; it's best to
|
|
|
|
keep private data in a separate repository.
|
2015-05-21 22:23:39 +02:00
|
|
|
|
2016-11-11 18:23:48 +01:00
|
|
|
uploadpack.allowAnySHA1InWant::
|
|
|
|
Allow `upload-pack` to accept a fetch request that asks for any
|
|
|
|
object at all.
|
|
|
|
Defaults to `false`.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
uploadpack.keepAlive::
|
2013-09-08 11:01:31 +02:00
|
|
|
When `upload-pack` has started `pack-objects`, there may be a
|
|
|
|
quiet period while `pack-objects` prepares the pack. Normally
|
|
|
|
it would output progress information, but if `--quiet` was used
|
|
|
|
for the fetch, `pack-objects` will output nothing at all until
|
|
|
|
the pack data begins. Some clients and networks may consider
|
|
|
|
the server to be hung and give up. Setting this option instructs
|
|
|
|
`upload-pack` to send an empty keepalive packet every
|
2015-03-11 21:32:45 +01:00
|
|
|
`uploadpack.keepAlive` seconds. Setting this option to 0
|
2013-09-08 11:02:06 +02:00
|
|
|
disables keepalive packets entirely. The default is 5 seconds.
|
2013-09-08 11:01:31 +02:00
|
|
|
|
upload-pack: provide a hook for running pack-objects
When upload-pack serves a client request, it turns to
pack-objects to do the heavy lifting of creating a
packfile. There's no easy way to intercept the call to
pack-objects, but there are a few good reasons to want to do
so:
1. If you're debugging a client or server issue with
fetching, you may want to store a copy of the generated
packfile.
2. If you're gathering data from real-world fetches for
performance analysis or debugging, storing a copy of
the arguments and stdin lets you replay the pack
generation at your leisure.
3. You may want to insert a caching layer around
pack-objects; it is the most CPU- and memory-intensive
part of serving a fetch, and its output is a pure
function[1] of its input, making it an ideal place to
consolidate identical requests.
This patch adds a simple "hook" interface to intercept calls
to pack-objects. The new test demonstrates how it can be
used for debugging (using it for caching is a
straightforward extension; the tricky part is writing the
actual caching layer).
This hook is unlike the normal hook scripts found in the
"hooks/" directory of a repository. Because we promise that
upload-pack is safe to run in an untrusted repository, we
cannot execute arbitrary code or commands found in the
repository (neither in hooks/, nor in the config). So
instead, this hook is triggered from a config variable that
is explicitly ignored in the per-repo config.
The config variable holds the actual shell command to run as
the hook. Another approach would be to simply treat it as a
boolean: "should I respect the upload-pack hooks in this
repo?", and then run the script from "hooks/" as we usually
do. However, that isn't as flexible; there's no way to run a
hook approved by the site administrator (e.g., in
"/etc/gitconfig") on a repository whose contents are not
trusted. The approach taken by this patch is more
fine-grained, if a little less conventional for git hooks
(it does behave similar to other configured commands like
diff.external, etc).
[1] Pack-objects isn't _actually_ a pure function. Its
output depends on the exact packing of the object
database, and if multi-threading is used for delta
compression, can even differ racily. But for the
purposes of caching, that's OK; of the many possible
outputs for a given input, it is sufficient only that we
output one of them.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-05-19 00:45:37 +02:00
|
|
|
uploadpack.packObjectsHook::
|
|
|
|
If this option is set, when `upload-pack` would run
|
|
|
|
`git pack-objects` to create a packfile for a client, it will
|
|
|
|
run this shell command instead. The `pack-objects` command and
|
|
|
|
arguments it _would_ have run (including the `git pack-objects`
|
|
|
|
at the beginning) are appended to the shell command. The stdin
|
|
|
|
and stdout of the hook are treated as if `pack-objects` itself
|
|
|
|
was run. I.e., `upload-pack` will feed input intended for
|
|
|
|
`pack-objects` to the hook, and expects a completed packfile on
|
|
|
|
stdout.
|
|
|
|
+
|
|
|
|
Note that this configuration variable is ignored if it is seen in the
|
|
|
|
repository-level config (this is a safety measure against fetching from
|
|
|
|
untrusted repositories).
|
|
|
|
|
2018-09-29 08:50:56 +02:00
|
|
|
uploadpack.allowFilter::
|
|
|
|
If this option is set, `upload-pack` will support partial
|
|
|
|
clone and partial fetch object filtering.
|
|
|
|
|
2018-06-28 00:30:17 +02:00
|
|
|
uploadpack.allowRefInWant::
|
|
|
|
If this option is set, `upload-pack` will support the `ref-in-want`
|
|
|
|
feature of the protocol version 2 `fetch` command. This feature
|
|
|
|
is intended for the benefit of load-balanced servers which may
|
|
|
|
not have the same view of what OIDs their refs point to due to
|
|
|
|
replication delay.
|
|
|
|
|
2008-02-20 19:43:53 +01:00
|
|
|
url.<base>.insteadOf::
|
|
|
|
Any URL that starts with this value will be rewritten to
|
|
|
|
start, instead, with <base>. In cases where some site serves a
|
|
|
|
large number of repositories, and serves them with multiple
|
|
|
|
access methods, and some users need to use different access
|
|
|
|
methods, this feature allows people to specify any of the
|
2013-01-21 20:17:53 +01:00
|
|
|
equivalent URLs and have Git automatically rewrite the URL to
|
2008-02-20 19:43:53 +01:00
|
|
|
the best alternative for the particular user, even for a
|
2008-02-25 07:25:04 +01:00
|
|
|
never-before-seen repository on the site. When more than one
|
|
|
|
insteadOf strings match a given URL, the longest match is used.
|
2017-05-31 07:18:04 +02:00
|
|
|
+
|
|
|
|
Note that any protocol restrictions will be applied to the rewritten
|
|
|
|
URL. If the rewrite changes the URL to use a custom protocol or remote
|
|
|
|
helper, you may need to adjust the `protocol.*.allow` config to permit
|
|
|
|
the request. In particular, protocols you expect to use for submodules
|
|
|
|
must be set to `always` rather than the default of `user`. See the
|
|
|
|
description of `protocol.allow` above.
|
2008-02-20 19:43:53 +01:00
|
|
|
|
2009-09-07 10:56:33 +02:00
|
|
|
url.<base>.pushInsteadOf::
|
|
|
|
Any URL that starts with this value will not be pushed to;
|
|
|
|
instead, it will be rewritten to start with <base>, and the
|
|
|
|
resulting URL will be pushed to. In cases where some site serves
|
|
|
|
a large number of repositories, and serves them with multiple
|
|
|
|
access methods, some of which do not allow push, this feature
|
2013-01-21 20:17:53 +01:00
|
|
|
allows people to specify a pull-only URL and have Git
|
2009-09-07 10:56:33 +02:00
|
|
|
automatically use an appropriate URL to push, even for a
|
|
|
|
never-before-seen repository on the site. When more than one
|
|
|
|
pushInsteadOf strings match a given URL, the longest match is
|
2013-01-21 20:17:53 +01:00
|
|
|
used. If a remote has an explicit pushurl, Git will ignore this
|
2009-09-07 10:56:33 +02:00
|
|
|
setting for that remote.
|
|
|
|
|
2006-04-25 00:59:33 +02:00
|
|
|
user.email::
|
|
|
|
Your email address to be recorded in any newly created commits.
|
2016-06-08 00:35:06 +02:00
|
|
|
Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
|
2016-06-08 00:35:07 +02:00
|
|
|
`EMAIL` environment variables. See linkgit:git-commit-tree[1].
|
2006-04-25 00:59:33 +02:00
|
|
|
|
|
|
|
user.name::
|
|
|
|
Your full name to be recorded in any newly created commits.
|
2016-06-08 00:35:06 +02:00
|
|
|
Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
|
2007-12-29 07:20:38 +01:00
|
|
|
environment variables. See linkgit:git-commit-tree[1].
|
2006-04-25 00:59:33 +02:00
|
|
|
|
2016-02-06 07:23:36 +01:00
|
|
|
user.useConfigOnly::
|
2016-06-08 19:23:16 +02:00
|
|
|
Instruct Git to avoid trying to guess defaults for `user.email`
|
|
|
|
and `user.name`, and instead retrieve the values only from the
|
2016-02-06 07:23:36 +01:00
|
|
|
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
|
|
|
|
along with a name, Git will prompt you to set up an email before
|
|
|
|
making new commits in a newly cloned repository.
|
|
|
|
Defaults to `false`.
|
|
|
|
|
2015-03-11 21:32:45 +01:00
|
|
|
user.signingKey::
|
2013-10-14 19:04:36 +02:00
|
|
|
If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
|
|
|
|
key you want it to automatically when creating a signed tag or
|
|
|
|
commit, you can override the default selection with this variable.
|
|
|
|
This option is passed unchanged to gpg's --local-user parameter,
|
|
|
|
so you may specify a key using any method that gpg supports.
|
2007-01-26 15:13:46 +01:00
|
|
|
|
versioncmp: generalize version sort suffix reordering
The 'versionsort.prereleaseSuffix' configuration variable, as its name
suggests, is supposed to only deal with tagnames with prerelease
suffixes, and allows sorting those prerelease tags in a user-defined
order before the suffixless main release tag, instead of sorting them
simply lexicographically.
However, the previous changes in this series resulted in an
interesting and useful property of version sort:
- The empty string as a configured suffix matches all tagnames,
including tagnames without any suffix, but
- tagnames containing a "real" configured suffix are still ordered
according to that real suffix, because any longer suffix takes
precedence over the empty string.
Exploiting this property we can easily generalize suffix reordering
and specify the order of tags with given suffixes not only before but
even after a main release tag by using the empty suffix to denote the
position of the main release tag, without any algorithm changes:
$ git -c versionsort.prereleaseSuffix=-alpha \
-c versionsort.prereleaseSuffix=-beta \
-c versionsort.prereleaseSuffix="" \
-c versionsort.prereleaseSuffix=-gamma \
-c versionsort.prereleaseSuffix=-delta \
tag -l --sort=version:refname 'v3.0*'
v3.0-alpha1
v3.0-beta1
v3.0
v3.0-gamma1
v3.0-delta1
Since 'versionsort.prereleaseSuffix' is not a fitting name for a
configuration variable to control this more general suffix reordering,
introduce the new variable 'versionsort.suffix'. Still keep the old
configuration variable name as a deprecated alias, though, to avoid
suddenly breaking setups already using it. Ignore the old variable if
both old and new configuration variables are set, but emit a warning
so users will be aware of it and can fix their configuration. Extend
the documentation to describe and add a test to check this more
general behavior.
Note: since the empty suffix matches all tagnames, tagnames with
suffixes not included in the configuration are listed together with
the suffixless main release tag, ordered lexicographically right after
that, i.e. before tags with suffixes listed in the configuration
following the empty suffix.
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-12-08 15:24:01 +01:00
|
|
|
versionsort.prereleaseSuffix (deprecated)::
|
|
|
|
Deprecated alias for `versionsort.suffix`. Ignored if
|
|
|
|
`versionsort.suffix` is set.
|
|
|
|
|
|
|
|
versionsort.suffix::
|
|
|
|
Even when version sort is used in linkgit:git-tag[1], tagnames
|
|
|
|
with the same base version but different suffixes are still sorted
|
|
|
|
lexicographically, resulting e.g. in prerelease tags appearing
|
|
|
|
after the main release (e.g. "1.0-rc1" after "1.0"). This
|
|
|
|
variable can be specified to determine the sorting order of tags
|
|
|
|
with different suffixes.
|
|
|
|
+
|
|
|
|
By specifying a single suffix in this variable, any tagname containing
|
|
|
|
that suffix will appear before the corresponding main release. E.g. if
|
|
|
|
the variable is set to "-rc", then all "1.0-rcX" tags will appear before
|
|
|
|
"1.0". If specified multiple times, once per suffix, then the order of
|
|
|
|
suffixes in the configuration will determine the sorting order of tagnames
|
|
|
|
with those suffixes. E.g. if "-pre" appears before "-rc" in the
|
|
|
|
configuration, then all "1.0-preX" tags will be listed before any
|
|
|
|
"1.0-rcX" tags. The placement of the main release tag relative to tags
|
|
|
|
with various suffixes can be determined by specifying the empty suffix
|
|
|
|
among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
|
|
|
|
"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
|
|
|
|
are listed first, followed by "v4.8", then "v4.8-ckX" and finally
|
|
|
|
"v4.8-bfsX".
|
|
|
|
+
|
versioncmp: cope with common part overlapping with prerelease suffix
Version sort with prerelease reordering sometimes puts tagnames in the
wrong order, when the common part of two compared tagnames overlaps
with the leading character(s) of one or more configured prerelease
suffixes. Note the position of "v2.1.0-beta-1":
$ git -c versionsort.prereleaseSuffix=-beta \
tag -l --sort=version:refname v2.1.*
v2.1.0-beta-2
v2.1.0-beta-3
v2.1.0
v2.1.0-RC1
v2.1.0-RC2
v2.1.0-beta-1
v2.1.1
v2.1.2
The reason is that when comparing a pair of tagnames, first
versioncmp() looks for the first different character in a pair of
tagnames, and then the swap_prereleases() helper function looks for a
configured prerelease suffix _starting at_ that character. Thus, when
in the above example the sorting algorithm happens to compare the
tagnames "v2.1.0-beta-1" and "v2.1.0-RC2", swap_prereleases() tries to
match the suffix "-beta" against "beta-1" to no avail, and the two
tagnames erroneously end up being ordered lexicographically.
To fix this issue change swap_prereleases() to look for configured
prerelease suffixes _containing_ the position of that first different
character.
Care must be taken, when a configured suffix is longer than the
tagnames' common part up to the first different character, to avoid
reading memory before the beginning of the tagnames. Add a test that
uses an exceptionally long prerelease suffix to check for this, in the
hope that in case of a regression the illegal memory access causes a
segfault in 'git tag' on one of the commonly used platforms (the test
happens to pass successfully on my Linux system with the safety check
removed), or at least makes valgrind complain.
Under some circumstances it's possible that more than one prerelease
suffixes can be found in the same tagname around that first different
character. With this simple bugfix patch such a tagname is sorted
according to the contained suffix that comes first in the
configuration for now. This is less than ideal in some cases, and the
following patch will take care of those.
Reported-by: Leho Kraav <leho@conversionready.com>
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-12-08 15:23:59 +01:00
|
|
|
If more than one suffixes match the same tagname, then that tagname will
|
versioncmp: use earliest-longest contained suffix to determine sorting order
When comparing tagnames, it is possible that a tagname contains more
than one of the configured prerelease suffixes around the first
different character. After fixing a bug in the previous commit such a
tagname is sorted according to the contained suffix which comes first
in the configuration. This is, however, not quite the right thing to
do in the following corner cases:
1. $ git -c versionsort.suffix=-bar
-c versionsort.suffix=-foo-baz
-c versionsort.suffix=-foo-bar
tag -l --sort=version:refname 'v1*'
v1.0-foo-bar
v1.0-foo-baz
The suffix of the tagname 'v1.0-foo-bar' is clearly '-foo-bar',
so it should be listed last. However, as it also contains '-bar'
around the first different character, it is listed first instead,
because that '-bar' suffix comes first the configuration.
2. One of the configured suffixes starts with the other:
$ git -c versionsort.prereleasesuffix=-pre \
-c versionsort.prereleasesuffix=-prerelease \
tag -l --sort=version:refname 'v2*'
v2.0-prerelease1
v2.0-pre1
v2.0-pre2
Here the tagname 'v2.0-prerelease1' should be the last. When
comparing 'v2.0-pre1' and 'v2.0-prerelease1' the first different
characters are '1' and 'r', respectively. Since this first
different character must be part of the configured suffix, the
'-pre' suffix is not recognized in the first tagname. OTOH, the
'-prerelease' suffix is properly recognized in
'v2.0-prerelease1', thus it is listed first.
Improve version sort in these corner cases, and
- look for a configured prerelease suffix containing the first
different character or ending right before it, so the '-pre'
suffixes are recognized in case (2). This also means that
when comparing tagnames 'v2.0-pre1' and 'v2.0-pre2',
swap_prereleases() would find the '-pre' suffix in both, but then
it will return "undecided" and the caller will do the right thing
by sorting based in '1' and '2'.
- If the tagname contains more than one suffix, then give precedence
to the contained suffix that starts at the earliest offset in the
tagname to address (1).
- If there are more than one suffixes starting at that earliest
position, then give precedence to the longest of those suffixes,
thus ensuring that in (2) the tagname 'v2.0-prerelease1' won't be
sorted based on the '-pre' suffix.
Add tests for these corner cases and adjust the documentation
accordingly.
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-12-08 15:24:00 +01:00
|
|
|
be sorted according to the suffix which starts at the earliest position in
|
|
|
|
the tagname. If more than one different matching suffixes start at
|
|
|
|
that earliest position, then that tagname will be sorted according to the
|
|
|
|
longest of those suffixes.
|
versioncmp: cope with common part overlapping with prerelease suffix
Version sort with prerelease reordering sometimes puts tagnames in the
wrong order, when the common part of two compared tagnames overlaps
with the leading character(s) of one or more configured prerelease
suffixes. Note the position of "v2.1.0-beta-1":
$ git -c versionsort.prereleaseSuffix=-beta \
tag -l --sort=version:refname v2.1.*
v2.1.0-beta-2
v2.1.0-beta-3
v2.1.0
v2.1.0-RC1
v2.1.0-RC2
v2.1.0-beta-1
v2.1.1
v2.1.2
The reason is that when comparing a pair of tagnames, first
versioncmp() looks for the first different character in a pair of
tagnames, and then the swap_prereleases() helper function looks for a
configured prerelease suffix _starting at_ that character. Thus, when
in the above example the sorting algorithm happens to compare the
tagnames "v2.1.0-beta-1" and "v2.1.0-RC2", swap_prereleases() tries to
match the suffix "-beta" against "beta-1" to no avail, and the two
tagnames erroneously end up being ordered lexicographically.
To fix this issue change swap_prereleases() to look for configured
prerelease suffixes _containing_ the position of that first different
character.
Care must be taken, when a configured suffix is longer than the
tagnames' common part up to the first different character, to avoid
reading memory before the beginning of the tagnames. Add a test that
uses an exceptionally long prerelease suffix to check for this, in the
hope that in case of a regression the illegal memory access causes a
segfault in 'git tag' on one of the commonly used platforms (the test
happens to pass successfully on my Linux system with the safety check
removed), or at least makes valgrind complain.
Under some circumstances it's possible that more than one prerelease
suffixes can be found in the same tagname around that first different
character. With this simple bugfix patch such a tagname is sorted
according to the contained suffix that comes first in the
configuration for now. This is less than ideal in some cases, and the
following patch will take care of those.
Reported-by: Leho Kraav <leho@conversionready.com>
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-12-08 15:23:59 +01:00
|
|
|
The sorting order between different suffixes is undefined if they are
|
|
|
|
in multiple config files.
|
2015-02-26 11:44:01 +01:00
|
|
|
|
2008-01-08 04:55:14 +01:00
|
|
|
web.browser::
|
|
|
|
Specify a web browser that may be used by some commands.
|
|
|
|
Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
|
|
|
|
may use it.
|
2017-11-29 21:04:51 +01:00
|
|
|
|
|
|
|
worktree.guessRemote::
|
|
|
|
With `add`, if no branch argument, and neither of `-b` nor
|
|
|
|
`-B` nor `--detach` are given, the command defaults to
|
|
|
|
creating a new branch from HEAD. If `worktree.guessRemote` is
|
|
|
|
set to true, `worktree add` tries to find a remote-tracking
|
|
|
|
branch whose name uniquely matches the new branch name. If
|
|
|
|
such a branch exists, it is checked out and set as "upstream"
|
|
|
|
for the new branch. If no such match can be found, it falls
|
|
|
|
back to creating a new branch from the current HEAD.
|