2006-04-24 22:59:33 +00:00
|
|
|
CONFIGURATION FILE
|
|
|
|
|
------------------
|
|
|
|
|
|
2013-01-21 19:17:53 +00: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 09:38:02 +00: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 09:38:00 +00:00
|
|
|
fallback values for the `.git/config` file. The file `/etc/gitconfig`
|
2009-04-23 09:38:02 +00:00
|
|
|
can be used to store a system-wide default configuration.
|
2007-01-17 06:45:35 +00:00
|
|
|
|
2013-01-21 19:17:53 +00:00
|
|
|
The configuration variables are used by both the Git plumbing
|
2009-04-23 09:38:01 +00: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-24 22:59:33 +00:00
|
|
|
dot-separated segment and the section name is everything before the last
|
2012-03-01 10:59:45 +00:00
|
|
|
dot. The variable names are case-insensitive, allow only alphanumeric
|
|
|
|
|
characters and `-`, and must start with an alphabetic character. Some
|
2015-03-04 18:26:17 +00:00
|
|
|
variables may appear multiple times; we say then that the variable is
|
|
|
|
|
multivalued.
|
2006-04-24 22:59:33 +00:00
|
|
|
|
2007-01-22 15:25:47 +00:00
|
|
|
Syntax
|
|
|
|
|
~~~~~~
|
|
|
|
|
|
2006-04-24 22:59:33 +00:00
|
|
|
The syntax is fairly flexible and permissive; whitespaces are mostly
|
2007-01-22 15:25:47 +00: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 04:03:50 +00:00
|
|
|
section begins. Section names are case-insensitive. Only alphanumeric
|
2009-03-15 11:30:52 +00:00
|
|
|
characters, `-` and `.` are allowed in section names. Each variable
|
2009-04-23 09:38:00 +00: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 15:25:47 +00: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 09:38:00 +00:00
|
|
|
in the section header, like in the example below:
|
2007-01-22 15:25:47 +00:00
|
|
|
|
|
|
|
|
--------
|
|
|
|
|
[section "subsection"]
|
|
|
|
|
|
|
|
|
|
--------
|
|
|
|
|
|
2009-04-23 09:38:01 +00:00
|
|
|
Subsection names are case sensitive and can contain any characters except
|
2017-12-21 13:10:42 +00: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 15:25:47 +00:00
|
|
|
|
2011-10-12 15:52:06 +00: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 15:25:47 +00:00
|
|
|
|
2009-07-25 00:28:50 +00: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 19:08:34 +00:00
|
|
|
'name = value' (or just 'name', which is a short-hand to say that
|
|
|
|
|
the variable is the boolean "true").
|
2012-03-01 10:59:45 +00:00
|
|
|
The variable names are case-insensitive, allow only alphanumeric characters
|
2015-03-04 18:26:17 +00:00
|
|
|
and `-`, and must start with an alphabetic character.
|
2007-01-22 15:25:47 +00:00
|
|
|
|
2015-03-04 18:33:38 +00: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 15:25:47 +00:00
|
|
|
|
2015-03-04 18:33:38 +00:00
|
|
|
Inside double quotes, double quote `"` and backslash `\` characters
|
|
|
|
|
must be escaped: use `\"` for `"` and `\\` for `\`.
|
2007-01-22 15:25:47 +00:00
|
|
|
|
2009-03-15 11:30:52 +00:00
|
|
|
The following escape sequences (beside `\"` and `\\`) are recognized:
|
|
|
|
|
`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
|
2014-03-31 22:11:44 +00:00
|
|
|
and `\b` for backspace (BS). Other char escape sequences (including octal
|
|
|
|
|
escape sequences) are invalid.
|
2007-01-22 15:25:47 +00:00
|
|
|
|
2006-04-24 22:59:33 +00: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 09:54:04 +00:00
|
|
|
Includes
|
|
|
|
|
~~~~~~~~
|
|
|
|
|
|
2017-05-11 09:10:47 +00: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 11:26:29 +00:00
|
|
|
You can include a config file from another by setting the special
|
2017-05-11 09:10:47 +00: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 17:43:55 +00:00
|
|
|
|
2017-05-11 09:13:04 +00: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 09:10:47 +00:00
|
|
|
variable is a relative path, the path is considered to
|
2017-03-01 11:26:30 +00:00
|
|
|
be relative to the configuration file in which the include directive
|
|
|
|
|
was found. See below for examples.
|
2016-04-29 17:43:55 +00: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 11:26:31 +00: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 09:10:47 +00: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 11:26:31 +00: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 08:28:46 +00: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 11:26:31 +00: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 09:54:04 +00:00
|
|
|
|
2006-04-24 22:59:33 +00:00
|
|
|
Example
|
|
|
|
|
~~~~~~~
|
|
|
|
|
|
|
|
|
|
# Core variables
|
|
|
|
|
[core]
|
|
|
|
|
; Don't trust file modes
|
|
|
|
|
filemode = false
|
|
|
|
|
|
|
|
|
|
# Our diff algorithm
|
|
|
|
|
[diff]
|
2008-07-27 11:12:15 +00:00
|
|
|
external = /usr/local/bin/diff-wrapper
|
2006-04-24 22:59:33 +00:00
|
|
|
renames = true
|
|
|
|
|
|
2006-12-07 06:36:55 +00:00
|
|
|
[branch "devel"]
|
|
|
|
|
remote = origin
|
|
|
|
|
merge = refs/heads/devel
|
|
|
|
|
|
2007-01-22 15:25:47 +00:00
|
|
|
# Proxy settings
|
|
|
|
|
[core]
|
2007-08-02 22:45:56 +00:00
|
|
|
gitProxy="ssh" for "kernel.org"
|
2007-01-22 15:25:47 +00:00
|
|
|
gitProxy=default-proxy ; for the rest
|
2006-12-07 06:36:55 +00: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 09:54:04 +00:00
|
|
|
[include]
|
|
|
|
|
path = /path/to/foo.inc ; include by absolute path
|
2017-05-11 09:14:30 +00: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 09:54:04 +00: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 11:26:31 +00: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 18:57:43 +00:00
|
|
|
|
2017-05-11 09:11:06 +00: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 18:57:43 +00: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-14 22:12:18 +00:00
|
|
|
true;; Boolean true literals are `yes`, `on`, `true`,
|
|
|
|
|
and `1`. Also, a variable defined without `= <value>`
|
2015-03-04 18:57:43 +00:00
|
|
|
is taken as true.
|
|
|
|
|
|
2017-08-14 22:12:18 +00:00
|
|
|
false;; Boolean false literals are `no`, `off`, `false`,
|
|
|
|
|
`0` and the empty string.
|
2015-03-04 18:57:43 +00:00
|
|
|
+
|
2018-09-19 16:38:18 +00:00
|
|
|
When converting a value to its canonical form using the `--type=bool` type
|
2017-08-14 22:12:18 +00:00
|
|
|
specifier, 'git config' will ensure that the output is "true" or
|
2015-03-04 18:57:43 +00: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 07:07:13 +00:00
|
|
|
color::
|
2016-06-23 17:32:30 +00: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 20:50:51 +00:00
|
|
|
+
|
2016-06-23 17:32:30 +00: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 19:07:12 +00:00
|
|
|
+
|
2016-06-23 17:32:30 +00: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 17:40:16 +00: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 17:39:07 +00: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 17:32:30 +00:00
|
|
|
+
|
2017-02-02 12:42:44 +00: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 17:32:30 +00: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 07:07:13 +00:00
|
|
|
|
2016-04-29 17:43:55 +00: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 18:57:43 +00:00
|
|
|
|
2006-04-24 22:59:33 +00:00
|
|
|
Variables
|
|
|
|
|
~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Note that this list is non-comprehensive and not necessarily complete.
|
2006-06-07 23:15:05 +00:00
|
|
|
For command-specific variables, you will find a more detailed description
|
2014-03-21 04:07:08 +00: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 06:22:35 +00:00
|
|
|
include::config/advice.txt[]
|
2009-09-09 11:38:58 +00:00
|
|
|
|
2018-10-27 06:22:36 +00:00
|
|
|
include::config/core.txt[]
|
2010-10-28 18:28:04 +00:00
|
|
|
|
2018-10-27 06:22:37 +00:00
|
|
|
include::config/add.txt[]
|
2009-05-31 05:08:02 +00:00
|
|
|
|
2018-10-27 06:22:38 +00:00
|
|
|
include::config/alias.txt[]
|
2007-02-11 00:33:58 +00:00
|
|
|
|
2018-10-27 06:22:39 +00:00
|
|
|
include::config/am.txt[]
|
2015-08-04 14:19:26 +00:00
|
|
|
|
2018-10-27 06:22:40 +00:00
|
|
|
include::config/apply.txt[]
|
2006-04-24 22:59:33 +00:00
|
|
|
|
2018-10-27 06:22:41 +00:00
|
|
|
include::config/blame.txt[]
|
2018-08-04 06:25:00 +00:00
|
|
|
|
2018-10-27 06:22:42 +00:00
|
|
|
include::config/branch.txt[]
|
2013-01-01 09:30:53 +00:00
|
|
|
|
2018-10-27 06:22:43 +00:00
|
|
|
include::config/browser.txt[]
|
2008-01-29 06:08:22 +00:00
|
|
|
|
2018-10-27 06:22:44 +00:00
|
|
|
include::config/checkout.txt[]
|
2018-08-16 18:27:11 +00:00
|
|
|
|
2018-10-27 06:22:45 +00:00
|
|
|
include::config/clean.txt[]
|
2007-04-24 00:18:16 +00:00
|
|
|
|
2018-10-27 06:22:46 +00:00
|
|
|
include::config/color.txt[]
|
2008-02-18 07:26:03 +00:00
|
|
|
|
2018-10-27 06:22:47 +00:00
|
|
|
include::config/column.txt[]
|
2012-04-13 10:54:41 +00:00
|
|
|
|
2018-10-27 06:22:48 +00:00
|
|
|
include::config/commit.txt[]
|
2016-05-05 09:50:02 +00:00
|
|
|
|
2018-10-27 06:22:49 +00:00
|
|
|
include::config/credential.txt[]
|
2015-11-10 00:26:29 +00:00
|
|
|
|
2018-10-27 06:22:50 +00:00
|
|
|
include::config/completion.txt[]
|
2018-05-20 18:40:09 +00:00
|
|
|
|
2018-10-27 06:22:51 +00:00
|
|
|
include::config/diff.txt[]
|
2009-04-07 08:21:20 +00:00
|
|
|
|
2018-10-27 06:22:52 +00:00
|
|
|
include::config/difftool.txt[]
|
2009-04-07 08:21:22 +00:00
|
|
|
|
2018-10-27 06:22:53 +00:00
|
|
|
include::config/fastimport.txt[]
|
2016-04-25 21:17:28 +00:00
|
|
|
|
2018-10-27 06:22:54 +00:00
|
|
|
include::config/fetch.txt[]
|
2018-07-16 18:44:01 +00:00
|
|
|
|
2018-10-27 06:22:56 +00:00
|
|
|
include::config/format.txt[]
|
2016-04-26 07:51:24 +00:00
|
|
|
|
2018-10-27 06:22:55 +00:00
|
|
|
include::config/filter.txt[]
|
2011-04-06 18:46:48 +00:00
|
|
|
|
2018-10-27 06:22:58 +00:00
|
|
|
include::config/fsck.txt[]
|
2015-06-22 15:27:23 +00:00
|
|
|
|
2018-10-27 06:22:59 +00:00
|
|
|
include::config/gc.txt[]
|
2006-12-27 09:24:05 +00:00
|
|
|
|
2018-10-27 06:23:00 +00:00
|
|
|
include::config/gitcvs.txt[]
|
2007-04-13 16:13:42 +00:00
|
|
|
|
2018-10-27 06:23:01 +00:00
|
|
|
include::config/gitweb.txt[]
|
2011-10-16 11:07:34 +00:00
|
|
|
|
2018-10-27 06:23:02 +00:00
|
|
|
include::config/grep.txt[]
|
2016-01-12 10:40:26 +00:00
|
|
|
|
2018-10-27 06:23:03 +00:00
|
|
|
include::config/gpg.txt[]
|
2018-07-17 12:50:11 +00:00
|
|
|
|
2018-10-27 06:23:04 +00:00
|
|
|
include::config/gui.txt[]
|
2008-11-13 17:28:49 +00:00
|
|
|
|
2018-10-27 06:23:05 +00:00
|
|
|
include::config/guitool.txt[]
|
2008-12-14 19:44:32 +00:00
|
|
|
|
2018-10-27 06:23:06 +00:00
|
|
|
include::config/help.txt[]
|
2013-01-15 20:56:21 +00:00
|
|
|
|
2018-10-27 06:23:08 +00:00
|
|
|
include::config/http.txt[]
|
2013-08-05 20:20:36 +00:00
|
|
|
|
2018-10-27 06:23:09 +00:00
|
|
|
include::config/i18n.txt[]
|
2006-12-28 00:41:33 +00:00
|
|
|
|
2018-10-27 06:23:10 +00:00
|
|
|
include::config/imap.txt[]
|
2008-11-26 08:26:50 +00:00
|
|
|
|
2018-10-27 06:23:11 +00:00
|
|
|
include::config/index.txt[]
|
2014-02-23 20:49:59 +00:00
|
|
|
|
2018-10-27 06:23:12 +00:00
|
|
|
include::config/init.txt[]
|
2010-02-16 23:44:46 +00:00
|
|
|
|
2018-10-27 06:23:13 +00:00
|
|
|
include::config/instaweb.txt[]
|
2008-01-08 03:55:14 +00:00
|
|
|
|
2018-10-27 06:23:14 +00:00
|
|
|
include::config/interactive.txt[]
|
2016-02-27 05:37:06 +00:00
|
|
|
|
2018-10-27 06:23:15 +00:00
|
|
|
include::config/log.txt[]
|
2013-01-05 21:26:46 +00:00
|
|
|
|
2018-10-27 06:23:16 +00:00
|
|
|
include::config/mailinfo.txt[]
|
2015-02-20 19:32:20 +00:00
|
|
|
|
2018-10-27 06:23:17 +00:00
|
|
|
include::config/mailmap.txt[]
|
2012-12-12 11:04:04 +00:00
|
|
|
|
2018-10-27 06:23:18 +00:00
|
|
|
include::config/man.txt[]
|
2008-04-25 06:24:41 +00:00
|
|
|
|
2018-10-27 06:23:19 +00:00
|
|
|
include::config/merge.txt[]
|
2008-08-29 17:49:56 +00:00
|
|
|
|
2018-10-27 06:23:20 +00:00
|
|
|
include::config/mergetool.txt[]
|
2008-11-13 12:41:14 +00:00
|
|
|
|
2018-10-27 06:23:21 +00:00
|
|
|
include::config/notes.txt[]
|
2010-03-12 17:04:32 +00:00
|
|
|
|
2018-10-27 06:23:22 +00:00
|
|
|
include::config/pack.txt[]
|
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 14:00:45 +00:00
|
|
|
|
2018-10-27 06:23:23 +00:00
|
|
|
include::config/pager.txt[]
|
2008-08-16 02:14:33 +00:00
|
|
|
|
2018-10-27 06:23:24 +00:00
|
|
|
include::config/pretty.txt[]
|
2010-05-02 11:00:44 +00:00
|
|
|
|
2018-10-27 06:23:25 +00:00
|
|
|
include::config/protocol.txt[]
|
2017-10-16 17:55:24 +00:00
|
|
|
|
2018-10-27 06:23:26 +00:00
|
|
|
include::config/pull.txt[]
|
2017-10-23 11:44:49 +00:00
|
|
|
|
2018-10-27 06:23:27 +00:00
|
|
|
include::config/push.txt[]
|
2015-11-17 11:05:56 +00:00
|
|
|
|
2018-10-27 06:23:28 +00:00
|
|
|
include::config/rebase.txt[]
|
2015-06-13 16:26:58 +00:00
|
|
|
|
2018-10-27 06:23:29 +00:00
|
|
|
include::config/receive.txt[]
|
2013-12-05 13:02:47 +00:00
|
|
|
|
2018-10-27 06:23:30 +00:00
|
|
|
include::config/remote.txt[]
|
2013-07-13 09:36:24 +00:00
|
|
|
|
2018-10-27 06:23:31 +00:00
|
|
|
include::config/remotes.txt[]
|
2007-02-20 20:13:43 +00:00
|
|
|
|
2018-10-27 06:23:32 +00:00
|
|
|
include::config/repack.txt[]
|
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 20:04:20 +00:00
|
|
|
|
2018-10-27 06:23:33 +00:00
|
|
|
include::config/rerere.txt[]
|
2008-11-26 08:26:50 +00:00
|
|
|
|
2018-10-27 06:23:34 +00:00
|
|
|
include::config/reset.txt[]
|
2018-10-23 19:04:22 +00:00
|
|
|
|
2018-10-27 06:23:35 +00:00
|
|
|
include::config/sendemail.txt[]
|
2017-05-21 12:59:50 +00:00
|
|
|
|
2018-10-27 06:23:36 +00:00
|
|
|
include::config/sequencer.txt[]
|
2018-08-22 16:06:04 +00:00
|
|
|
|
2018-10-27 06:23:37 +00:00
|
|
|
include::config/showbranch.txt[]
|
2006-04-24 22:59:33 +00:00
|
|
|
|
2018-10-27 06:23:38 +00:00
|
|
|
include::config/splitindex.txt[]
|
2017-03-06 09:42:02 +00:00
|
|
|
|
2018-10-27 06:23:07 +00:00
|
|
|
include::config/ssh.txt[]
|
|
|
|
|
|
2018-10-27 06:23:39 +00:00
|
|
|
include::config/status.txt[]
|
2010-05-20 15:55:42 +00:00
|
|
|
|
2018-10-27 06:23:40 +00:00
|
|
|
include::config/stash.txt[]
|
2015-08-29 15:25:57 +00:00
|
|
|
|
2018-10-27 06:23:41 +00:00
|
|
|
include::config/submodule.txt[]
|
2016-08-17 22:45:35 +00:00
|
|
|
|
2018-10-27 06:23:42 +00:00
|
|
|
include::config/tag.txt[]
|
2006-07-20 09:30:44 +00:00
|
|
|
|
2018-10-27 06:23:43 +00:00
|
|
|
include::config/transfer.txt[]
|
2008-11-26 08:26:50 +00:00
|
|
|
|
2018-10-27 06:23:44 +00:00
|
|
|
include::config/uploadarchive.txt[]
|
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 10:04:19 +00:00
|
|
|
|
2015-03-11 20:32:45 +00:00
|
|
|
uploadpack.hideRefs::
|
2015-07-28 19:59:11 +00: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 05:49:57 +00:00
|
|
|
|
2015-05-21 20:23:37 +00:00
|
|
|
uploadpack.allowTipSHA1InWant::
|
2015-03-11 20:32:45 +00:00
|
|
|
When `uploadpack.hideRefs` is in effect, allow `upload-pack`
|
2013-01-29 05:49:57 +00: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 18:20:24 +00: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 00:08:30 +00:00
|
|
|
|
2015-05-21 20:23:39 +00: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 18:20:24 +00: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 20:23:39 +00:00
|
|
|
|
2016-11-11 17:23:48 +00:00
|
|
|
uploadpack.allowAnySHA1InWant::
|
|
|
|
|
Allow `upload-pack` to accept a fetch request that asks for any
|
|
|
|
|
object at all.
|
|
|
|
|
Defaults to `false`.
|
|
|
|
|
|
2015-03-11 20:32:45 +00:00
|
|
|
uploadpack.keepAlive::
|
2013-09-08 09:01:31 +00: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 20:32:45 +00:00
|
|
|
`uploadpack.keepAlive` seconds. Setting this option to 0
|
2013-09-08 09:02:06 +00:00
|
|
|
disables keepalive packets entirely. The default is 5 seconds.
|
2013-09-08 09:01:31 +00: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-18 22:45:37 +00: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 06:50:56 +00:00
|
|
|
uploadpack.allowFilter::
|
|
|
|
|
If this option is set, `upload-pack` will support partial
|
|
|
|
|
clone and partial fetch object filtering.
|
|
|
|
|
|
2018-06-27 22:30:17 +00: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 18:43:53 +00: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 19:17:53 +00:00
|
|
|
equivalent URLs and have Git automatically rewrite the URL to
|
2008-02-20 18:43:53 +00:00
|
|
|
the best alternative for the particular user, even for a
|
2008-02-25 06:25:04 +00: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 05:18:04 +00: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 18:43:53 +00:00
|
|
|
|
2009-09-07 08:56:33 +00: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 19:17:53 +00:00
|
|
|
allows people to specify a pull-only URL and have Git
|
2009-09-07 08:56:33 +00: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 19:17:53 +00:00
|
|
|
used. If a remote has an explicit pushurl, Git will ignore this
|
2009-09-07 08:56:33 +00:00
|
|
|
setting for that remote.
|
|
|
|
|
|
2006-04-24 22:59:33 +00:00
|
|
|
user.email::
|
|
|
|
|
Your email address to be recorded in any newly created commits.
|
2016-06-07 22:35:06 +00:00
|
|
|
Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
|
2016-06-07 22:35:07 +00:00
|
|
|
`EMAIL` environment variables. See linkgit:git-commit-tree[1].
|
2006-04-24 22:59:33 +00:00
|
|
|
|
|
|
|
|
user.name::
|
|
|
|
|
Your full name to be recorded in any newly created commits.
|
2016-06-07 22:35:06 +00:00
|
|
|
Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
|
2007-12-29 06:20:38 +00:00
|
|
|
environment variables. See linkgit:git-commit-tree[1].
|
2006-04-24 22:59:33 +00:00
|
|
|
|
2016-02-06 06:23:36 +00:00
|
|
|
user.useConfigOnly::
|
2016-06-08 17:23:16 +00: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 06:23:36 +00: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 20:32:45 +00:00
|
|
|
user.signingKey::
|
2013-10-14 17:04:36 +00: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 14:13:46 +00: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 14:24:01 +00: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 14:23:59 +00: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 14:24:00 +00: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 14:23:59 +00:00
|
|
|
The sorting order between different suffixes is undefined if they are
|
|
|
|
|
in multiple config files.
|
2015-02-26 10:44:01 +00:00
|
|
|
|
2008-01-08 03:55:14 +00: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 20:04:51 +00: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.
|