2006-04-25 02:59:33 +04:00
|
|
|
CONFIGURATION FILE
|
|
|
|
------------------
|
|
|
|
|
2013-01-21 23:17:53 +04: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 13:38:02 +04: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 13:38:00 +04:00
|
|
|
fallback values for the `.git/config` file. The file `/etc/gitconfig`
|
2009-04-23 13:38:02 +04:00
|
|
|
can be used to store a system-wide default configuration.
|
2007-01-17 09:45:35 +03:00
|
|
|
|
2013-01-21 23:17:53 +04:00
|
|
|
The configuration variables are used by both the Git plumbing
|
2009-04-23 13:38:01 +04: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 02:59:33 +04:00
|
|
|
dot-separated segment and the section name is everything before the last
|
2012-03-01 14:59:45 +04:00
|
|
|
dot. The variable names are case-insensitive, allow only alphanumeric
|
|
|
|
characters and `-`, and must start with an alphabetic character. Some
|
|
|
|
variables may appear multiple times.
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2007-01-22 18:25:47 +03:00
|
|
|
Syntax
|
|
|
|
~~~~~~
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
The syntax is fairly flexible and permissive; whitespaces are mostly
|
2007-01-22 18:25:47 +03: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
|
|
|
|
section begins. Section names are not case sensitive. Only alphanumeric
|
2009-03-15 14:30:52 +03:00
|
|
|
characters, `-` and `.` are allowed in section names. Each variable
|
2009-04-23 13:38:00 +04: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 18:25:47 +03: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 13:38:00 +04:00
|
|
|
in the section header, like in the example below:
|
2007-01-22 18:25:47 +03:00
|
|
|
|
|
|
|
--------
|
|
|
|
[section "subsection"]
|
|
|
|
|
|
|
|
--------
|
|
|
|
|
2009-04-23 13:38:01 +04:00
|
|
|
Subsection names are case sensitive and can contain any characters except
|
|
|
|
newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
|
|
|
|
respectively). Section headers cannot span multiple
|
2007-01-22 18:25:47 +03:00
|
|
|
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.
|
|
|
|
|
2011-10-12 19:52:06 +04: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 18:25:47 +03:00
|
|
|
|
2009-07-25 04:28:50 +04:00
|
|
|
All the other lines (and the remainder of the line after the section
|
|
|
|
header) are recognized as setting variables, in the form
|
2007-01-22 18:25:47 +03:00
|
|
|
'name = value'. If there is no equal sign on the line, the entire line
|
|
|
|
is taken as 'name' and the variable is recognized as boolean "true".
|
2012-03-01 14:59:45 +04:00
|
|
|
The variable names are case-insensitive, allow only alphanumeric characters
|
|
|
|
and `-`, and must start with an alphabetic character. There can be more
|
|
|
|
than one value for a given variable; we say then that the variable is
|
|
|
|
multivalued.
|
2007-01-22 18:25:47 +03:00
|
|
|
|
|
|
|
Leading and trailing whitespace in a variable value is discarded.
|
|
|
|
Internal whitespace within a variable value is retained verbatim.
|
|
|
|
|
|
|
|
The values following the equals sign in variable assign are all either
|
|
|
|
a string, an integer, or a boolean. Boolean values may be given as yes/no,
|
2011-03-30 14:22:32 +04:00
|
|
|
1/0, true/false or on/off. Case is not significant in boolean values, when
|
2007-01-22 18:25:47 +03:00
|
|
|
converting value to the canonical form using '--bool' type specifier;
|
2010-01-10 02:33:00 +03:00
|
|
|
'git config' will ensure that the output is "true" or "false".
|
2007-01-22 18:25:47 +03:00
|
|
|
|
|
|
|
String values may be entirely or partially enclosed in double quotes.
|
2009-04-23 13:38:00 +04:00
|
|
|
You need to enclose variable values in double quotes if you want to
|
|
|
|
preserve leading or trailing whitespace, or if the variable value contains
|
|
|
|
comment characters (i.e. it contains '#' or ';').
|
|
|
|
Double quote `"` and backslash `\` characters in variable values must
|
2009-03-15 14:30:52 +03:00
|
|
|
be escaped: use `\"` for `"` and `\\` for `\`.
|
2007-01-22 18:25:47 +03:00
|
|
|
|
2009-03-15 14:30:52 +03:00
|
|
|
The following escape sequences (beside `\"` and `\\`) are recognized:
|
|
|
|
`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
|
2014-04-01 02:11:44 +04:00
|
|
|
and `\b` for backspace (BS). Other char escape sequences (including octal
|
|
|
|
escape sequences) are invalid.
|
2007-01-22 18:25:47 +03:00
|
|
|
|
2009-04-23 13:38:00 +04:00
|
|
|
Variable values ending in a `\` are continued on the next line in the
|
2007-01-22 18:25:47 +03:00
|
|
|
customary UNIX fashion.
|
|
|
|
|
2009-04-23 13:38:00 +04:00
|
|
|
Some variables may require a special value format.
|
2006-04-25 02:59:33 +04: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 13:54:04 +04:00
|
|
|
Includes
|
|
|
|
~~~~~~~~
|
|
|
|
|
|
|
|
You can include one config file from another by setting the special
|
|
|
|
`include.path` variable to the name of the file to be included. The
|
|
|
|
included file is expanded immediately, as if its contents had been
|
|
|
|
found at the location of the include directive. If the value of the
|
|
|
|
`include.path` variable is a relative path, the path is considered to be
|
|
|
|
relative to the configuration file in which the include directive was
|
2012-05-03 03:43:52 +04:00
|
|
|
found. The value of `include.path` is subject to tilde expansion: `~/`
|
|
|
|
is expanded to the value of `$HOME`, and `~user/` to the specified
|
2012-04-25 16:00:36 +04:00
|
|
|
user's home directory. See below for examples.
|
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 13:54:04 +04:00
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
Example
|
|
|
|
~~~~~~~
|
|
|
|
|
|
|
|
# Core variables
|
|
|
|
[core]
|
|
|
|
; Don't trust file modes
|
|
|
|
filemode = false
|
|
|
|
|
|
|
|
# Our diff algorithm
|
|
|
|
[diff]
|
2008-07-27 15:12:15 +04:00
|
|
|
external = /usr/local/bin/diff-wrapper
|
2006-04-25 02:59:33 +04:00
|
|
|
renames = true
|
|
|
|
|
2006-12-07 09:36:55 +03:00
|
|
|
[branch "devel"]
|
|
|
|
remote = origin
|
|
|
|
merge = refs/heads/devel
|
|
|
|
|
2007-01-22 18:25:47 +03:00
|
|
|
# Proxy settings
|
|
|
|
[core]
|
2007-08-03 02:45:56 +04:00
|
|
|
gitProxy="ssh" for "kernel.org"
|
2007-01-22 18:25:47 +03:00
|
|
|
gitProxy=default-proxy ; for the rest
|
2006-12-07 09:36:55 +03: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 13:54:04 +04:00
|
|
|
[include]
|
|
|
|
path = /path/to/foo.inc ; include by absolute path
|
|
|
|
path = foo ; expand "foo" relative to the current file
|
2012-04-25 16:00:36 +04:00
|
|
|
path = ~/foo ; expand "foo" 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 13:54:04 +04:00
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
Variables
|
|
|
|
~~~~~~~~~
|
|
|
|
|
|
|
|
Note that this list is non-comprehensive and not necessarily complete.
|
2006-06-08 03:15:05 +04:00
|
|
|
For command-specific variables, you will find a more detailed description
|
2014-03-21 08:07:08 +04: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.
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2009-09-09 15:38:58 +04:00
|
|
|
advice.*::
|
2011-12-19 09:35:01 +04:00
|
|
|
These variables control various optional help messages designed to
|
|
|
|
aid new users. All 'advice.*' variables default to 'true', and you
|
|
|
|
can tell Git that you do not need help by setting these to 'false':
|
2009-09-09 15:38:58 +04:00
|
|
|
+
|
|
|
|
--
|
2012-12-03 07:27:50 +04:00
|
|
|
pushUpdateRejected::
|
push: Provide situational hints for non-fast-forward errors
Pushing a non-fast-forward update to a remote repository will result in
an error, but the hint text doesn't provide the correct resolution in
every case. Give better resolution advice in three push scenarios:
1) If you push your current branch and it triggers a non-fast-forward
error, you should merge remote changes with 'git pull' before pushing
again.
2) If you push to a shared repository others push to, and your local
tracking branches are not kept up to date, the 'matching refs' default
will generate non-fast-forward errors on outdated branches. If this is
your workflow, the 'matching refs' default is not for you. Consider
setting the 'push.default' configuration variable to 'current' or
'upstream' to ensure only your current branch is pushed.
3) If you explicitly specify a ref that is not your current branch or
push matching branches with ':', you will generate a non-fast-forward
error if any pushed branch tip is out of date. You should checkout the
offending branch and merge remote changes before pushing again.
Teach transport.c to recognize these scenarios and configure push.c
to hint for them. If 'git push's default behavior changes or we
discover more scenarios, extension is easy. Standardize on the
advice API and add three new advice variables, 'pushNonFFCurrent',
'pushNonFFDefault', and 'pushNonFFMatching'. Setting any of these
to 'false' will disable their affiliated advice. Setting
'pushNonFastForward' to false will disable all three, thus preserving the
config option for users who already set it, but guaranteeing new
users won't disable push advice accidentally.
Based-on-patch-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Christopher Tiwald <christiwald@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-03-20 08:31:33 +04:00
|
|
|
Set this variable to 'false' if you want to disable
|
2014-03-08 03:13:15 +04:00
|
|
|
'pushNonFFCurrent',
|
push: introduce REJECT_FETCH_FIRST and REJECT_NEEDS_FORCE
When we push to update an existing ref, if:
* the object at the tip of the remote is not a commit; or
* the object we are pushing is not a commit,
it won't be correct to suggest to fetch, integrate and push again,
as the old and new objects will not "merge". We should explain that
the push must be forced when there is a non-committish object is
involved in such a case.
If we do not have the current object at the tip of the remote, we do
not even know that object, when fetched, is something that can be
merged. In such a case, suggesting to pull first just like
non-fast-forward case may not be technically correct, but in
practice, most such failures are seen when you try to push your work
to a branch without knowing that somebody else already pushed to
update the same branch since you forked, so "pull first" would work
as a suggestion most of the time. And if the object at the tip is
not a commit, "pull first" will fail, without making any permanent
damage. As a side effect, it also makes the error message the user
will get during the next "push" attempt easier to understand, now
the user is aware that a non-commit object is involved.
In these cases, the current code already rejects such a push on the
client end, but we used the same error and advice messages as the
ones used when rejecting a non-fast-forward push, i.e. pull from
there and integrate before pushing again.
Introduce new rejection reasons and reword the messages
appropriately.
[jc: with help by Peff on message details]
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-01-24 01:55:30 +04:00
|
|
|
'pushNonFFMatching', 'pushAlreadyExists',
|
|
|
|
'pushFetchFirst', and 'pushNeedsForce'
|
2012-12-03 07:27:51 +04:00
|
|
|
simultaneously.
|
push: Provide situational hints for non-fast-forward errors
Pushing a non-fast-forward update to a remote repository will result in
an error, but the hint text doesn't provide the correct resolution in
every case. Give better resolution advice in three push scenarios:
1) If you push your current branch and it triggers a non-fast-forward
error, you should merge remote changes with 'git pull' before pushing
again.
2) If you push to a shared repository others push to, and your local
tracking branches are not kept up to date, the 'matching refs' default
will generate non-fast-forward errors on outdated branches. If this is
your workflow, the 'matching refs' default is not for you. Consider
setting the 'push.default' configuration variable to 'current' or
'upstream' to ensure only your current branch is pushed.
3) If you explicitly specify a ref that is not your current branch or
push matching branches with ':', you will generate a non-fast-forward
error if any pushed branch tip is out of date. You should checkout the
offending branch and merge remote changes before pushing again.
Teach transport.c to recognize these scenarios and configure push.c
to hint for them. If 'git push's default behavior changes or we
discover more scenarios, extension is easy. Standardize on the
advice API and add three new advice variables, 'pushNonFFCurrent',
'pushNonFFDefault', and 'pushNonFFMatching'. Setting any of these
to 'false' will disable their affiliated advice. Setting
'pushNonFastForward' to false will disable all three, thus preserving the
config option for users who already set it, but guaranteeing new
users won't disable push advice accidentally.
Based-on-patch-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Christopher Tiwald <christiwald@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-03-20 08:31:33 +04:00
|
|
|
pushNonFFCurrent::
|
|
|
|
Advice shown when linkgit:git-push[1] fails due to a
|
|
|
|
non-fast-forward update to the current branch.
|
|
|
|
pushNonFFMatching::
|
|
|
|
Advice shown when you ran linkgit:git-push[1] and pushed
|
|
|
|
'matching refs' explicitly (i.e. you used ':', or
|
|
|
|
specified a refspec that isn't your current branch) and
|
|
|
|
it resulted in a non-fast-forward error.
|
2012-12-03 07:27:51 +04:00
|
|
|
pushAlreadyExists::
|
|
|
|
Shown when linkgit:git-push[1] rejects an update that
|
|
|
|
does not qualify for fast-forwarding (e.g., a tag.)
|
push: introduce REJECT_FETCH_FIRST and REJECT_NEEDS_FORCE
When we push to update an existing ref, if:
* the object at the tip of the remote is not a commit; or
* the object we are pushing is not a commit,
it won't be correct to suggest to fetch, integrate and push again,
as the old and new objects will not "merge". We should explain that
the push must be forced when there is a non-committish object is
involved in such a case.
If we do not have the current object at the tip of the remote, we do
not even know that object, when fetched, is something that can be
merged. In such a case, suggesting to pull first just like
non-fast-forward case may not be technically correct, but in
practice, most such failures are seen when you try to push your work
to a branch without knowing that somebody else already pushed to
update the same branch since you forked, so "pull first" would work
as a suggestion most of the time. And if the object at the tip is
not a commit, "pull first" will fail, without making any permanent
damage. As a side effect, it also makes the error message the user
will get during the next "push" attempt easier to understand, now
the user is aware that a non-commit object is involved.
In these cases, the current code already rejects such a push on the
client end, but we used the same error and advice messages as the
ones used when rejecting a non-fast-forward push, i.e. pull from
there and integrate before pushing again.
Introduce new rejection reasons and reword the messages
appropriately.
[jc: with help by Peff on message details]
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-01-24 01:55:30 +04:00
|
|
|
pushFetchFirst::
|
|
|
|
Shown when linkgit:git-push[1] rejects an update that
|
|
|
|
tries to overwrite a remote ref that points at an
|
|
|
|
object we do not have.
|
|
|
|
pushNeedsForce::
|
|
|
|
Shown when linkgit:git-push[1] rejects an update that
|
|
|
|
tries to overwrite a remote ref that points at an
|
2013-09-04 23:04:31 +04:00
|
|
|
object that is not a commit-ish, or make the remote
|
|
|
|
ref point at an object that is not a commit-ish.
|
2009-09-09 15:43:03 +04:00
|
|
|
statusHints::
|
2012-06-06 00:21:24 +04:00
|
|
|
Show directions on how to proceed from the current
|
2012-12-04 13:15:03 +04:00
|
|
|
state in the output of linkgit:git-status[1], in
|
2012-06-06 00:21:24 +04:00
|
|
|
the template shown when writing commit messages in
|
2012-12-04 13:15:03 +04:00
|
|
|
linkgit:git-commit[1], and in the help message shown
|
|
|
|
by linkgit:git-checkout[1] when switching branch.
|
2013-03-13 16:59:16 +04:00
|
|
|
statusUoption::
|
|
|
|
Advise to consider using the `-u` option to linkgit:git-status[1]
|
|
|
|
when the command takes more than 2 seconds to enumerate untracked
|
|
|
|
files.
|
2009-11-23 01:26:17 +03:00
|
|
|
commitBeforeMerge::
|
|
|
|
Advice shown when linkgit:git-merge[1] refuses to
|
2010-07-20 01:17:17 +04:00
|
|
|
merge to avoid overwriting local changes.
|
Be more user-friendly when refusing to do something because of conflict.
Various commands refuse to run in the presence of conflicts (commit,
merge, pull, cherry-pick/revert). They all used to provide rough, and
inconsistant error messages.
A new variable advice.resolveconflict is introduced, and allows more
verbose messages, pointing the user to the appropriate solution.
For commit, the error message used to look like this:
$ git commit
foo.txt: needs merge
foo.txt: unmerged (c34a92682e0394bc0d6f4d4a67a8e2d32395c169)
foo.txt: unmerged (3afcd75de8de0bb5076942fcb17446be50451030)
foo.txt: unmerged (c9785d77b76dfe4fb038bf927ee518f6ae45ede4)
error: Error building trees
The "need merge" line is given by refresh_cache. We add the IN_PORCELAIN
option to make the output more consistant with the other porcelain
commands, and catch the error in return, to stop with a clean error
message. The next lines were displayed by a call to cache_tree_update(),
which is not reached anymore if we noticed the conflict.
The new output looks like:
U foo.txt
fatal: 'commit' is not possible because you have unmerged files.
Please, fix them up in the work tree, and then use 'git add/rm <file>' as
appropriate to mark resolution and make a commit, or use 'git commit -a'.
Pull is slightly modified to abort immediately if $GIT_DIR/MERGE_HEAD
exists instead of waiting for merge to complain.
The behavior of merge and the test-case are slightly modified to reflect
the usual flow: start with conflicts, fix them, and afterwards get rid of
MERGE_HEAD, with different error messages at each stage.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-01-12 12:54:44 +03:00
|
|
|
resolveConflict::
|
2013-02-25 09:27:20 +04:00
|
|
|
Advice shown by various commands when conflicts
|
Be more user-friendly when refusing to do something because of conflict.
Various commands refuse to run in the presence of conflicts (commit,
merge, pull, cherry-pick/revert). They all used to provide rough, and
inconsistant error messages.
A new variable advice.resolveconflict is introduced, and allows more
verbose messages, pointing the user to the appropriate solution.
For commit, the error message used to look like this:
$ git commit
foo.txt: needs merge
foo.txt: unmerged (c34a92682e0394bc0d6f4d4a67a8e2d32395c169)
foo.txt: unmerged (3afcd75de8de0bb5076942fcb17446be50451030)
foo.txt: unmerged (c9785d77b76dfe4fb038bf927ee518f6ae45ede4)
error: Error building trees
The "need merge" line is given by refresh_cache. We add the IN_PORCELAIN
option to make the output more consistant with the other porcelain
commands, and catch the error in return, to stop with a clean error
message. The next lines were displayed by a call to cache_tree_update(),
which is not reached anymore if we noticed the conflict.
The new output looks like:
U foo.txt
fatal: 'commit' is not possible because you have unmerged files.
Please, fix them up in the work tree, and then use 'git add/rm <file>' as
appropriate to mark resolution and make a commit, or use 'git commit -a'.
Pull is slightly modified to abort immediately if $GIT_DIR/MERGE_HEAD
exists instead of waiting for merge to complain.
The behavior of merge and the test-case are slightly modified to reflect
the usual flow: start with conflicts, fix them, and afterwards get rid of
MERGE_HEAD, with different error messages at each stage.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-01-12 12:54:44 +03:00
|
|
|
prevent the operation from being performed.
|
2010-01-13 23:17:08 +03:00
|
|
|
implicitIdentity::
|
|
|
|
Advice on how to set your identity configuration when
|
|
|
|
your information is guessed from the system username and
|
2011-12-19 09:35:01 +04:00
|
|
|
domain name.
|
2010-01-30 09:03:24 +03:00
|
|
|
detachedHead::
|
2011-12-19 09:35:01 +04:00
|
|
|
Advice shown when you used linkgit:git-checkout[1] to
|
2010-01-30 09:03:24 +03:00
|
|
|
move to the detach HEAD state, to instruct how to create
|
2011-12-19 09:35:01 +04:00
|
|
|
a local branch after the fact.
|
2012-07-13 19:51:30 +04:00
|
|
|
amWorkDir::
|
|
|
|
Advice that shows the location of the patch file when
|
|
|
|
linkgit:git-am[1] fails to apply it.
|
2013-06-12 12:06:44 +04:00
|
|
|
rmHints::
|
|
|
|
In case of failure in the output of linkgit:git-rm[1],
|
|
|
|
show directions on how to proceed from the current state.
|
2009-09-09 15:38:58 +04:00
|
|
|
--
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
core.fileMode::
|
|
|
|
If false, the executable bit differences between the index and
|
2011-09-21 00:25:57 +04:00
|
|
|
the working tree are ignored; useful on broken filesystems like FAT.
|
2009-11-23 05:07:30 +03:00
|
|
|
See linkgit:git-update-index[1].
|
|
|
|
+
|
|
|
|
The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
|
|
|
|
will probe and set core.fileMode false if appropriate when the
|
|
|
|
repository is created.
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2009-11-23 05:07:30 +03:00
|
|
|
core.ignorecase::
|
|
|
|
If true, this option enables various workarounds to enable
|
2013-01-21 23:17:53 +04:00
|
|
|
Git to work better on filesystems that are not case sensitive,
|
2009-11-23 05:07:30 +03:00
|
|
|
like FAT. For example, if a directory listing finds
|
2013-01-21 23:17:53 +04:00
|
|
|
"makefile" when Git expects "Makefile", Git will assume
|
2009-11-23 05:07:30 +03:00
|
|
|
it is really the same file, and continue to remember it as
|
|
|
|
"Makefile".
|
|
|
|
+
|
|
|
|
The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
|
|
|
|
will probe and set core.ignorecase true if appropriate when the repository
|
|
|
|
is created.
|
|
|
|
|
git on Mac OS and precomposed unicode
Mac OS X mangles file names containing unicode on file systems HFS+,
VFAT or SAMBA. When a file using unicode code points outside ASCII
is created on a HFS+ drive, the file name is converted into
decomposed unicode and written to disk. No conversion is done if
the file name is already decomposed unicode.
Calling open("\xc3\x84", ...) with a precomposed "Ä" yields the same
result as open("\x41\xcc\x88",...) with a decomposed "Ä".
As a consequence, readdir() returns the file names in decomposed
unicode, even if the user expects precomposed unicode. Unlike on
HFS+, Mac OS X stores files on a VFAT drive (e.g. an USB drive) in
precomposed unicode, but readdir() still returns file names in
decomposed unicode. When a git repository is stored on a network
share using SAMBA, file names are send over the wire and written to
disk on the remote system in precomposed unicode, but Mac OS X
readdir() returns decomposed unicode to be compatible with its
behaviour on HFS+ and VFAT.
The unicode decomposition causes many problems:
- The names "git add" and other commands get from the end user may
often be precomposed form (the decomposed form is not easily input
from the keyboard), but when the commands read from the filesystem
to see what it is going to update the index with already is on the
filesystem, readdir() will give decomposed form, which is different.
- Similarly "git log", "git mv" and all other commands that need to
compare pathnames found on the command line (often but not always
precomposed form; a command line input resulting from globbing may
be in decomposed) with pathnames found in the tree objects (should
be precomposed form to be compatible with other systems and for
consistency in general).
- The same for names stored in the index, which should be
precomposed, that may need to be compared with the names read from
readdir().
NFS mounted from Linux is fully transparent and does not suffer from
the above.
As Mac OS X treats precomposed and decomposed file names as equal,
we can
- wrap readdir() on Mac OS X to return the precomposed form, and
- normalize decomposed form given from the command line also to the
precomposed form,
to ensure that all pathnames used in Git are always in the
precomposed form. This behaviour can be requested by setting
"core.precomposedunicode" configuration variable to true.
The code in compat/precomposed_utf8.c implements basically 4 new
functions: precomposed_utf8_opendir(), precomposed_utf8_readdir(),
precomposed_utf8_closedir() and precompose_argv(). The first three
are to wrap opendir(3), readdir(3), and closedir(3) functions.
The argv[] conversion allows to use the TAB filename completion done
by the shell on command line. It tolerates other tools which use
readdir() to feed decomposed file names into git.
When creating a new git repository with "git init" or "git clone",
"core.precomposedunicode" will be set "false".
The user needs to activate this feature manually. She typically
sets core.precomposedunicode to "true" on HFS and VFAT, or file
systems mounted via SAMBA.
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Torsten Bögershausen <tboegi@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-07-08 17:50:25 +04:00
|
|
|
core.precomposeunicode::
|
2013-01-21 23:17:53 +04:00
|
|
|
This option is only used by Mac OS implementation of Git.
|
|
|
|
When core.precomposeunicode=true, Git reverts the unicode decomposition
|
git on Mac OS and precomposed unicode
Mac OS X mangles file names containing unicode on file systems HFS+,
VFAT or SAMBA. When a file using unicode code points outside ASCII
is created on a HFS+ drive, the file name is converted into
decomposed unicode and written to disk. No conversion is done if
the file name is already decomposed unicode.
Calling open("\xc3\x84", ...) with a precomposed "Ä" yields the same
result as open("\x41\xcc\x88",...) with a decomposed "Ä".
As a consequence, readdir() returns the file names in decomposed
unicode, even if the user expects precomposed unicode. Unlike on
HFS+, Mac OS X stores files on a VFAT drive (e.g. an USB drive) in
precomposed unicode, but readdir() still returns file names in
decomposed unicode. When a git repository is stored on a network
share using SAMBA, file names are send over the wire and written to
disk on the remote system in precomposed unicode, but Mac OS X
readdir() returns decomposed unicode to be compatible with its
behaviour on HFS+ and VFAT.
The unicode decomposition causes many problems:
- The names "git add" and other commands get from the end user may
often be precomposed form (the decomposed form is not easily input
from the keyboard), but when the commands read from the filesystem
to see what it is going to update the index with already is on the
filesystem, readdir() will give decomposed form, which is different.
- Similarly "git log", "git mv" and all other commands that need to
compare pathnames found on the command line (often but not always
precomposed form; a command line input resulting from globbing may
be in decomposed) with pathnames found in the tree objects (should
be precomposed form to be compatible with other systems and for
consistency in general).
- The same for names stored in the index, which should be
precomposed, that may need to be compared with the names read from
readdir().
NFS mounted from Linux is fully transparent and does not suffer from
the above.
As Mac OS X treats precomposed and decomposed file names as equal,
we can
- wrap readdir() on Mac OS X to return the precomposed form, and
- normalize decomposed form given from the command line also to the
precomposed form,
to ensure that all pathnames used in Git are always in the
precomposed form. This behaviour can be requested by setting
"core.precomposedunicode" configuration variable to true.
The code in compat/precomposed_utf8.c implements basically 4 new
functions: precomposed_utf8_opendir(), precomposed_utf8_readdir(),
precomposed_utf8_closedir() and precompose_argv(). The first three
are to wrap opendir(3), readdir(3), and closedir(3) functions.
The argv[] conversion allows to use the TAB filename completion done
by the shell on command line. It tolerates other tools which use
readdir() to feed decomposed file names into git.
When creating a new git repository with "git init" or "git clone",
"core.precomposedunicode" will be set "false".
The user needs to activate this feature manually. She typically
sets core.precomposedunicode to "true" on HFS and VFAT, or file
systems mounted via SAMBA.
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Torsten Bögershausen <tboegi@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-07-08 17:50:25 +04:00
|
|
|
of filenames done by Mac OS. This is useful when sharing a repository
|
|
|
|
between Mac OS and Linux or Windows.
|
2013-01-21 23:17:53 +04:00
|
|
|
(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
|
|
|
|
When false, file names are handled fully transparent by Git,
|
|
|
|
which is backward compatible with older versions of Git.
|
git on Mac OS and precomposed unicode
Mac OS X mangles file names containing unicode on file systems HFS+,
VFAT or SAMBA. When a file using unicode code points outside ASCII
is created on a HFS+ drive, the file name is converted into
decomposed unicode and written to disk. No conversion is done if
the file name is already decomposed unicode.
Calling open("\xc3\x84", ...) with a precomposed "Ä" yields the same
result as open("\x41\xcc\x88",...) with a decomposed "Ä".
As a consequence, readdir() returns the file names in decomposed
unicode, even if the user expects precomposed unicode. Unlike on
HFS+, Mac OS X stores files on a VFAT drive (e.g. an USB drive) in
precomposed unicode, but readdir() still returns file names in
decomposed unicode. When a git repository is stored on a network
share using SAMBA, file names are send over the wire and written to
disk on the remote system in precomposed unicode, but Mac OS X
readdir() returns decomposed unicode to be compatible with its
behaviour on HFS+ and VFAT.
The unicode decomposition causes many problems:
- The names "git add" and other commands get from the end user may
often be precomposed form (the decomposed form is not easily input
from the keyboard), but when the commands read from the filesystem
to see what it is going to update the index with already is on the
filesystem, readdir() will give decomposed form, which is different.
- Similarly "git log", "git mv" and all other commands that need to
compare pathnames found on the command line (often but not always
precomposed form; a command line input resulting from globbing may
be in decomposed) with pathnames found in the tree objects (should
be precomposed form to be compatible with other systems and for
consistency in general).
- The same for names stored in the index, which should be
precomposed, that may need to be compared with the names read from
readdir().
NFS mounted from Linux is fully transparent and does not suffer from
the above.
As Mac OS X treats precomposed and decomposed file names as equal,
we can
- wrap readdir() on Mac OS X to return the precomposed form, and
- normalize decomposed form given from the command line also to the
precomposed form,
to ensure that all pathnames used in Git are always in the
precomposed form. This behaviour can be requested by setting
"core.precomposedunicode" configuration variable to true.
The code in compat/precomposed_utf8.c implements basically 4 new
functions: precomposed_utf8_opendir(), precomposed_utf8_readdir(),
precomposed_utf8_closedir() and precompose_argv(). The first three
are to wrap opendir(3), readdir(3), and closedir(3) functions.
The argv[] conversion allows to use the TAB filename completion done
by the shell on command line. It tolerates other tools which use
readdir() to feed decomposed file names into git.
When creating a new git repository with "git init" or "git clone",
"core.precomposedunicode" will be set "false".
The user needs to activate this feature manually. She typically
sets core.precomposedunicode to "true" on HFS and VFAT, or file
systems mounted via SAMBA.
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Torsten Bögershausen <tboegi@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-07-08 17:50:25 +04:00
|
|
|
|
2008-07-28 10:31:28 +04:00
|
|
|
core.trustctime::
|
|
|
|
If false, the ctime differences between the index and the
|
2011-09-21 00:25:57 +04:00
|
|
|
working tree are ignored; useful when the inode change time
|
2008-07-28 10:31:28 +04:00
|
|
|
is regularly modified by something outside Git (file system
|
|
|
|
crawlers and some backup systems).
|
|
|
|
See linkgit:git-update-index[1]. True by default.
|
|
|
|
|
2013-01-22 11:49:22 +04:00
|
|
|
core.checkstat::
|
|
|
|
Determines which stat fields to match between the index
|
|
|
|
and work tree. The user can set this to 'default' or
|
|
|
|
'minimal'. Default (or explicitly 'default'), is to check
|
|
|
|
all fields, including the sub-second part of mtime and ctime.
|
|
|
|
|
2007-06-25 02:11:24 +04:00
|
|
|
core.quotepath::
|
2008-07-03 09:59:09 +04:00
|
|
|
The commands that output paths (e.g. 'ls-files',
|
|
|
|
'diff'), when not given the `-z` option, will quote
|
2007-06-25 02:11:24 +04:00
|
|
|
"unusual" characters in the pathname by enclosing the
|
|
|
|
pathname in a double-quote pair and with backslashes the
|
|
|
|
same way strings in C source code are quoted. If this
|
|
|
|
variable is set to false, the bytes higher than 0x80 are
|
|
|
|
not quoted but output as verbatim. Note that double
|
|
|
|
quote, backslash and control characters are always
|
|
|
|
quoted without `-z` regardless of the setting of this
|
|
|
|
variable.
|
|
|
|
|
2010-06-04 23:29:08 +04:00
|
|
|
core.eol::
|
|
|
|
Sets the line ending type to use in the working directory for
|
|
|
|
files that have the `text` property set. Alternatives are
|
|
|
|
'lf', 'crlf' and 'native', which uses the platform's native
|
|
|
|
line ending. The default value is `native`. See
|
|
|
|
linkgit:gitattributes[5] for more information on end-of-line
|
|
|
|
conversion.
|
2007-04-13 20:02:31 +04:00
|
|
|
|
safecrlf: Add mechanism to warn about irreversible crlf conversions
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout. A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git. For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes. Right
after committing you still have the original file in your work
tree and this file is not yet corrupted. You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished. In both cases CRLFs are removed
in an irreversible way. For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
This patch adds a mechanism that can either warn the user about
an irreversible conversion or can even refuse to convert. The
mechanism is controlled by the variable core.safecrlf, with the
following values:
- false: disable safecrlf mechanism
- warn: warn about irreversible conversions
- true: refuse irreversible conversions
The default is to warn. Users are only affected by this default
if core.autocrlf is set. But the current default of git is to
leave core.autocrlf unset, so users will not see warnings unless
they deliberately chose to activate the autocrlf mechanism.
The safecrlf mechanism's details depend on the git command. The
general principles when safecrlf is active (not false) are:
- we warn/error out if files in the work tree can modified in an
irreversible way without giving the user a chance to backup the
original file.
- for read-only operations that do not modify files in the work tree
we do not not print annoying warnings.
There are exceptions. Even though...
- "git add" itself does not touch the files in the work tree, the
next checkout would, so the safety triggers;
- "git apply" to update a text file with a patch does touch the files
in the work tree, but the operation is about text files and CRLF
conversion is about fixing the line ending inconsistencies, so the
safety does not trigger;
- "git diff" itself does not touch the files in the work tree, it is
often run to inspect the changes you intend to next "git add". To
catch potential problems early, safety triggers.
The concept of a safety check was originally proposed in a similar
way by Linus Torvalds. Thanks to Dimitry Potapov for insisting
on getting the naked LF/autocrlf=true case right.
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
2008-02-06 14:25:58 +03:00
|
|
|
core.safecrlf::
|
2013-01-21 23:17:53 +04:00
|
|
|
If true, makes Git check if converting `CRLF` is reversible when
|
2010-05-20 00:43:10 +04:00
|
|
|
end-of-line conversion is active. Git will verify if a command
|
safecrlf: Add mechanism to warn about irreversible crlf conversions
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout. A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git. For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes. Right
after committing you still have the original file in your work
tree and this file is not yet corrupted. You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished. In both cases CRLFs are removed
in an irreversible way. For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
This patch adds a mechanism that can either warn the user about
an irreversible conversion or can even refuse to convert. The
mechanism is controlled by the variable core.safecrlf, with the
following values:
- false: disable safecrlf mechanism
- warn: warn about irreversible conversions
- true: refuse irreversible conversions
The default is to warn. Users are only affected by this default
if core.autocrlf is set. But the current default of git is to
leave core.autocrlf unset, so users will not see warnings unless
they deliberately chose to activate the autocrlf mechanism.
The safecrlf mechanism's details depend on the git command. The
general principles when safecrlf is active (not false) are:
- we warn/error out if files in the work tree can modified in an
irreversible way without giving the user a chance to backup the
original file.
- for read-only operations that do not modify files in the work tree
we do not not print annoying warnings.
There are exceptions. Even though...
- "git add" itself does not touch the files in the work tree, the
next checkout would, so the safety triggers;
- "git apply" to update a text file with a patch does touch the files
in the work tree, but the operation is about text files and CRLF
conversion is about fixing the line ending inconsistencies, so the
safety does not trigger;
- "git diff" itself does not touch the files in the work tree, it is
often run to inspect the changes you intend to next "git add". To
catch potential problems early, safety triggers.
The concept of a safety check was originally proposed in a similar
way by Linus Torvalds. Thanks to Dimitry Potapov for insisting
on getting the naked LF/autocrlf=true case right.
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
2008-02-06 14:25:58 +03:00
|
|
|
modifies a file in the work tree either directly or indirectly.
|
|
|
|
For example, committing a file followed by checking out the
|
|
|
|
same file should yield the original file in the work tree. If
|
|
|
|
this is not the case for the current setting of
|
2013-01-21 23:17:53 +04:00
|
|
|
`core.autocrlf`, Git will reject the file. The variable can
|
|
|
|
be set to "warn", in which case Git will only warn about an
|
safecrlf: Add mechanism to warn about irreversible crlf conversions
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout. A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git. For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes. Right
after committing you still have the original file in your work
tree and this file is not yet corrupted. You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished. In both cases CRLFs are removed
in an irreversible way. For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
This patch adds a mechanism that can either warn the user about
an irreversible conversion or can even refuse to convert. The
mechanism is controlled by the variable core.safecrlf, with the
following values:
- false: disable safecrlf mechanism
- warn: warn about irreversible conversions
- true: refuse irreversible conversions
The default is to warn. Users are only affected by this default
if core.autocrlf is set. But the current default of git is to
leave core.autocrlf unset, so users will not see warnings unless
they deliberately chose to activate the autocrlf mechanism.
The safecrlf mechanism's details depend on the git command. The
general principles when safecrlf is active (not false) are:
- we warn/error out if files in the work tree can modified in an
irreversible way without giving the user a chance to backup the
original file.
- for read-only operations that do not modify files in the work tree
we do not not print annoying warnings.
There are exceptions. Even though...
- "git add" itself does not touch the files in the work tree, the
next checkout would, so the safety triggers;
- "git apply" to update a text file with a patch does touch the files
in the work tree, but the operation is about text files and CRLF
conversion is about fixing the line ending inconsistencies, so the
safety does not trigger;
- "git diff" itself does not touch the files in the work tree, it is
often run to inspect the changes you intend to next "git add". To
catch potential problems early, safety triggers.
The concept of a safety check was originally proposed in a similar
way by Linus Torvalds. Thanks to Dimitry Potapov for insisting
on getting the naked LF/autocrlf=true case right.
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
2008-02-06 14:25:58 +03:00
|
|
|
irreversible conversion but continue the operation.
|
|
|
|
+
|
|
|
|
CRLF conversion bears a slight chance of corrupting data.
|
2013-01-21 23:17:53 +04:00
|
|
|
When it is enabled, Git will convert CRLF to LF during commit and LF to
|
safecrlf: Add mechanism to warn about irreversible crlf conversions
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout. A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git. For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes. Right
after committing you still have the original file in your work
tree and this file is not yet corrupted. You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished. In both cases CRLFs are removed
in an irreversible way. For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
This patch adds a mechanism that can either warn the user about
an irreversible conversion or can even refuse to convert. The
mechanism is controlled by the variable core.safecrlf, with the
following values:
- false: disable safecrlf mechanism
- warn: warn about irreversible conversions
- true: refuse irreversible conversions
The default is to warn. Users are only affected by this default
if core.autocrlf is set. But the current default of git is to
leave core.autocrlf unset, so users will not see warnings unless
they deliberately chose to activate the autocrlf mechanism.
The safecrlf mechanism's details depend on the git command. The
general principles when safecrlf is active (not false) are:
- we warn/error out if files in the work tree can modified in an
irreversible way without giving the user a chance to backup the
original file.
- for read-only operations that do not modify files in the work tree
we do not not print annoying warnings.
There are exceptions. Even though...
- "git add" itself does not touch the files in the work tree, the
next checkout would, so the safety triggers;
- "git apply" to update a text file with a patch does touch the files
in the work tree, but the operation is about text files and CRLF
conversion is about fixing the line ending inconsistencies, so the
safety does not trigger;
- "git diff" itself does not touch the files in the work tree, it is
often run to inspect the changes you intend to next "git add". To
catch potential problems early, safety triggers.
The concept of a safety check was originally proposed in a similar
way by Linus Torvalds. Thanks to Dimitry Potapov for insisting
on getting the naked LF/autocrlf=true case right.
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
2008-02-06 14:25:58 +03:00
|
|
|
CRLF during checkout. A file that contains a mixture of LF and
|
2013-01-21 23:17:53 +04:00
|
|
|
CRLF before the commit cannot be recreated by Git. For text
|
safecrlf: Add mechanism to warn about irreversible crlf conversions
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout. A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git. For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes. Right
after committing you still have the original file in your work
tree and this file is not yet corrupted. You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished. In both cases CRLFs are removed
in an irreversible way. For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
This patch adds a mechanism that can either warn the user about
an irreversible conversion or can even refuse to convert. The
mechanism is controlled by the variable core.safecrlf, with the
following values:
- false: disable safecrlf mechanism
- warn: warn about irreversible conversions
- true: refuse irreversible conversions
The default is to warn. Users are only affected by this default
if core.autocrlf is set. But the current default of git is to
leave core.autocrlf unset, so users will not see warnings unless
they deliberately chose to activate the autocrlf mechanism.
The safecrlf mechanism's details depend on the git command. The
general principles when safecrlf is active (not false) are:
- we warn/error out if files in the work tree can modified in an
irreversible way without giving the user a chance to backup the
original file.
- for read-only operations that do not modify files in the work tree
we do not not print annoying warnings.
There are exceptions. Even though...
- "git add" itself does not touch the files in the work tree, the
next checkout would, so the safety triggers;
- "git apply" to update a text file with a patch does touch the files
in the work tree, but the operation is about text files and CRLF
conversion is about fixing the line ending inconsistencies, so the
safety does not trigger;
- "git diff" itself does not touch the files in the work tree, it is
often run to inspect the changes you intend to next "git add". To
catch potential problems early, safety triggers.
The concept of a safety check was originally proposed in a similar
way by Linus Torvalds. Thanks to Dimitry Potapov for insisting
on getting the naked LF/autocrlf=true case right.
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
2008-02-06 14:25:58 +03:00
|
|
|
files this is the right thing to do: it corrects line endings
|
|
|
|
such that we have only LF line endings in the repository.
|
|
|
|
But for binary files that are accidentally classified as text the
|
|
|
|
conversion can corrupt data.
|
|
|
|
+
|
|
|
|
If you recognize such corruption early you can easily fix it by
|
|
|
|
setting the conversion type explicitly in .gitattributes. Right
|
|
|
|
after committing you still have the original file in your work
|
|
|
|
tree and this file is not yet corrupted. You can explicitly tell
|
2013-01-21 23:17:53 +04:00
|
|
|
Git that this file is binary and Git will handle the file
|
safecrlf: Add mechanism to warn about irreversible crlf conversions
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout. A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git. For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes. Right
after committing you still have the original file in your work
tree and this file is not yet corrupted. You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished. In both cases CRLFs are removed
in an irreversible way. For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
This patch adds a mechanism that can either warn the user about
an irreversible conversion or can even refuse to convert. The
mechanism is controlled by the variable core.safecrlf, with the
following values:
- false: disable safecrlf mechanism
- warn: warn about irreversible conversions
- true: refuse irreversible conversions
The default is to warn. Users are only affected by this default
if core.autocrlf is set. But the current default of git is to
leave core.autocrlf unset, so users will not see warnings unless
they deliberately chose to activate the autocrlf mechanism.
The safecrlf mechanism's details depend on the git command. The
general principles when safecrlf is active (not false) are:
- we warn/error out if files in the work tree can modified in an
irreversible way without giving the user a chance to backup the
original file.
- for read-only operations that do not modify files in the work tree
we do not not print annoying warnings.
There are exceptions. Even though...
- "git add" itself does not touch the files in the work tree, the
next checkout would, so the safety triggers;
- "git apply" to update a text file with a patch does touch the files
in the work tree, but the operation is about text files and CRLF
conversion is about fixing the line ending inconsistencies, so the
safety does not trigger;
- "git diff" itself does not touch the files in the work tree, it is
often run to inspect the changes you intend to next "git add". To
catch potential problems early, safety triggers.
The concept of a safety check was originally proposed in a similar
way by Linus Torvalds. Thanks to Dimitry Potapov for insisting
on getting the naked LF/autocrlf=true case right.
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
2008-02-06 14:25:58 +03:00
|
|
|
appropriately.
|
|
|
|
+
|
|
|
|
Unfortunately, the desired effect of cleaning up text files with
|
|
|
|
mixed line endings and the undesired effect of corrupting binary
|
|
|
|
files cannot be distinguished. In both cases CRLFs are removed
|
|
|
|
in an irreversible way. For text files this is the right thing
|
|
|
|
to do because CRLFs are line endings, while for binary files
|
|
|
|
converting CRLFs corrupts data.
|
|
|
|
+
|
|
|
|
Note, this safety check does not mean that a checkout will generate a
|
|
|
|
file identical to the original file for a different setting of
|
2010-06-04 23:29:08 +04:00
|
|
|
`core.eol` and `core.autocrlf`, but only for the current one. For
|
|
|
|
example, a text file with `LF` would be accepted with `core.eol=lf`
|
|
|
|
and could later be checked out with `core.eol=crlf`, in which case the
|
safecrlf: Add mechanism to warn about irreversible crlf conversions
CRLF conversion bears a slight chance of corrupting data.
autocrlf=true will convert CRLF to LF during commit and LF to
CRLF during checkout. A file that contains a mixture of LF and
CRLF before the commit cannot be recreated by git. For text
files this is the right thing to do: it corrects line endings
such that we have only LF line endings in the repository.
But for binary files that are accidentally classified as text the
conversion can corrupt data.
If you recognize such corruption early you can easily fix it by
setting the conversion type explicitly in .gitattributes. Right
after committing you still have the original file in your work
tree and this file is not yet corrupted. You can explicitly tell
git that this file is binary and git will handle the file
appropriately.
Unfortunately, the desired effect of cleaning up text files with
mixed line endings and the undesired effect of corrupting binary
files cannot be distinguished. In both cases CRLFs are removed
in an irreversible way. For text files this is the right thing
to do because CRLFs are line endings, while for binary files
converting CRLFs corrupts data.
This patch adds a mechanism that can either warn the user about
an irreversible conversion or can even refuse to convert. The
mechanism is controlled by the variable core.safecrlf, with the
following values:
- false: disable safecrlf mechanism
- warn: warn about irreversible conversions
- true: refuse irreversible conversions
The default is to warn. Users are only affected by this default
if core.autocrlf is set. But the current default of git is to
leave core.autocrlf unset, so users will not see warnings unless
they deliberately chose to activate the autocrlf mechanism.
The safecrlf mechanism's details depend on the git command. The
general principles when safecrlf is active (not false) are:
- we warn/error out if files in the work tree can modified in an
irreversible way without giving the user a chance to backup the
original file.
- for read-only operations that do not modify files in the work tree
we do not not print annoying warnings.
There are exceptions. Even though...
- "git add" itself does not touch the files in the work tree, the
next checkout would, so the safety triggers;
- "git apply" to update a text file with a patch does touch the files
in the work tree, but the operation is about text files and CRLF
conversion is about fixing the line ending inconsistencies, so the
safety does not trigger;
- "git diff" itself does not touch the files in the work tree, it is
often run to inspect the changes you intend to next "git add". To
catch potential problems early, safety triggers.
The concept of a safety check was originally proposed in a similar
way by Linus Torvalds. Thanks to Dimitry Potapov for insisting
on getting the naked LF/autocrlf=true case right.
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
2008-02-06 14:25:58 +03:00
|
|
|
resulting file would contain `CRLF`, although the original file
|
|
|
|
contained `LF`. However, in both work trees the line endings would be
|
|
|
|
consistent, that is either all `LF` or all `CRLF`, but never mixed. A
|
|
|
|
file with mixed line endings would be reported by the `core.safecrlf`
|
|
|
|
mechanism.
|
|
|
|
|
2010-06-04 23:29:08 +04:00
|
|
|
core.autocrlf::
|
|
|
|
Setting this variable to "true" is almost the same as setting
|
|
|
|
the `text` attribute to "auto" on all files except that text
|
|
|
|
files are not guaranteed to be normalized: files that contain
|
|
|
|
`CRLF` in the repository will not be touched. Use this
|
|
|
|
setting if you want to have `CRLF` line endings in your
|
|
|
|
working directory even though the repository does not have
|
|
|
|
normalized line endings. This variable can be set to 'input',
|
|
|
|
in which case no output conversion is performed.
|
|
|
|
|
2007-03-03 00:11:30 +03:00
|
|
|
core.symlinks::
|
|
|
|
If false, symbolic links are checked out as small plain files that
|
2007-12-29 09:20:38 +03:00
|
|
|
contain the link text. linkgit:git-update-index[1] and
|
|
|
|
linkgit:git-add[1] will not change the recorded type to regular
|
2007-03-03 00:11:30 +03:00
|
|
|
file. Useful on filesystems like FAT that do not support
|
2009-11-23 05:07:30 +03:00
|
|
|
symbolic links.
|
|
|
|
+
|
|
|
|
The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
|
|
|
|
will probe and set core.symlinks false if appropriate when the repository
|
|
|
|
is created.
|
2007-03-03 00:11:30 +03:00
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
core.gitProxy::
|
|
|
|
A "proxy command" to execute (as 'command host port') instead
|
|
|
|
of establishing direct connection to the remote server when
|
2013-01-21 23:17:53 +04:00
|
|
|
using the Git protocol for fetching. If the variable value is
|
2006-04-25 02:59:33 +04:00
|
|
|
in the "COMMAND for DOMAIN" format, the command is applied only
|
|
|
|
on hostnames ending with the specified domain string. This variable
|
|
|
|
may be set multiple times and is matched in the given order;
|
|
|
|
the first match wins.
|
2006-06-08 03:15:05 +04:00
|
|
|
+
|
|
|
|
Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
|
|
|
|
(which always applies universally, without the special "for"
|
|
|
|
handling).
|
2009-03-17 20:31:42 +03:00
|
|
|
+
|
|
|
|
The special string `none` can be used as the proxy command to
|
|
|
|
specify that no proxy be used for a given domain pattern.
|
|
|
|
This is useful for excluding servers inside a firewall from
|
|
|
|
proxy use, while defaulting to a common proxy for external domains.
|
2006-04-25 02:59:33 +04:00
|
|
|
|
|
|
|
core.ignoreStat::
|
2008-05-30 15:14:24 +04:00
|
|
|
If true, commands which modify both the working tree and the index
|
|
|
|
will mark the updated paths with the "assume unchanged" bit in the
|
|
|
|
index. These marked files are then assumed to stay unchanged in the
|
2011-09-21 00:25:57 +04:00
|
|
|
working tree, until you mark them otherwise manually - Git will not
|
2008-05-30 15:14:24 +04:00
|
|
|
detect the file changes by lstat() calls. This is useful on systems
|
|
|
|
where those are very slow, such as Microsoft Windows.
|
|
|
|
See linkgit:git-update-index[1].
|
2006-04-25 02:59:33 +04:00
|
|
|
False by default.
|
|
|
|
|
2006-05-02 11:40:24 +04:00
|
|
|
core.preferSymlinkRefs::
|
|
|
|
Instead of the default "symref" format for HEAD
|
|
|
|
and other symbolic reference files, use symbolic links.
|
|
|
|
This is sometimes needed to work with old scripts that
|
|
|
|
expect HEAD to be a symbolic link.
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2007-02-22 01:59:08 +03:00
|
|
|
core.bare::
|
|
|
|
If true this repository is assumed to be 'bare' and has no
|
|
|
|
working directory associated with it. If this is the case a
|
|
|
|
number of commands that require a working directory will be
|
2007-12-29 09:20:38 +03:00
|
|
|
disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
|
2007-02-22 01:59:08 +03:00
|
|
|
+
|
2007-12-29 09:20:38 +03:00
|
|
|
This setting is automatically guessed by linkgit:git-clone[1] or
|
|
|
|
linkgit:git-init[1] when the repository was created. By default a
|
2007-02-22 01:59:08 +03:00
|
|
|
repository that ends in "/.git" is assumed to be not bare (bare =
|
|
|
|
false), while all other repositories are assumed to be bare (bare
|
|
|
|
= true).
|
|
|
|
|
2007-06-06 11:10:42 +04:00
|
|
|
core.worktree::
|
2011-01-24 02:49:41 +03:00
|
|
|
Set the path to the root of the working tree.
|
2007-10-10 01:00:03 +04:00
|
|
|
This can be overridden by the GIT_WORK_TREE environment
|
2011-01-24 02:49:41 +03:00
|
|
|
variable and the '--work-tree' command line option.
|
2011-04-04 18:59:25 +04:00
|
|
|
The value can be an absolute path or relative to the path to
|
2011-01-24 02:49:41 +03:00
|
|
|
the .git directory, which is either specified by --git-dir
|
|
|
|
or GIT_DIR, or automatically discovered.
|
|
|
|
If --git-dir or GIT_DIR is specified but none of
|
2008-04-29 00:09:20 +04:00
|
|
|
--work-tree, GIT_WORK_TREE and core.worktree is specified,
|
2011-01-24 02:49:41 +03:00
|
|
|
the current working directory is regarded as the top level
|
2010-11-26 18:32:42 +03:00
|
|
|
of your working tree.
|
2011-01-24 02:49:41 +03:00
|
|
|
+
|
|
|
|
Note that this variable is honored even when set in a configuration
|
|
|
|
file in a ".git" subdirectory of a directory and its value differs
|
|
|
|
from the latter directory (e.g. "/path/to/.git/config" has
|
|
|
|
core.worktree set to "/different/path"), which is most likely a
|
2013-01-21 23:17:53 +04:00
|
|
|
misconfiguration. Running Git commands in the "/path/to" directory will
|
2011-01-24 02:49:41 +03:00
|
|
|
still use "/different/path" as the root of the work tree and can cause
|
|
|
|
confusion unless you know what you are doing (e.g. you are creating a
|
|
|
|
read-only snapshot of the same index to a location different from the
|
|
|
|
repository's usual working tree).
|
2007-06-06 11:10:42 +04:00
|
|
|
|
2006-05-17 13:55:40 +04:00
|
|
|
core.logAllRefUpdates::
|
2007-08-20 01:38:57 +04:00
|
|
|
Enable the reflog. Updates to a ref <ref> is logged to the file
|
2006-10-08 12:35:18 +04:00
|
|
|
"$GIT_DIR/logs/<ref>", by appending the new and old
|
2013-04-15 21:49:04 +04:00
|
|
|
SHA-1, the date/time and the reason of the update, but
|
2006-10-08 12:35:18 +04:00
|
|
|
only when the file exists. If this configuration
|
|
|
|
variable is set to true, missing "$GIT_DIR/logs/<ref>"
|
2011-07-11 13:14:18 +04:00
|
|
|
file is automatically created for branch heads (i.e. under
|
|
|
|
refs/heads/), remote refs (i.e. under refs/remotes/),
|
|
|
|
note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
|
2006-12-31 09:39:24 +03:00
|
|
|
+
|
|
|
|
This information can be used to determine what commit
|
|
|
|
was the tip of a branch "2 days ago".
|
|
|
|
+
|
|
|
|
This value is true by default in a repository that has
|
|
|
|
a working directory associated with it, and false by
|
|
|
|
default in a bare repository.
|
2006-05-17 13:55:40 +04:00
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
core.repositoryFormatVersion::
|
|
|
|
Internal variable identifying the repository format and layout
|
|
|
|
version.
|
|
|
|
|
|
|
|
core.sharedRepository::
|
2006-08-09 04:26:23 +04:00
|
|
|
When 'group' (or 'true'), the repository is made shareable between
|
|
|
|
several users in a group (making sure all the files and objects are
|
|
|
|
group-writable). When 'all' (or 'world' or 'everybody'), the
|
|
|
|
repository will be readable by all users, additionally to being
|
2013-01-21 23:17:53 +04:00
|
|
|
group-shareable. When 'umask' (or 'false'), Git will use permissions
|
2008-04-16 12:34:24 +04:00
|
|
|
reported by umask(2). When '0xxx', where '0xxx' is an octal number,
|
|
|
|
files in the repository will have this mode value. '0xxx' will override
|
2009-04-14 17:15:42 +04:00
|
|
|
user's umask value (whereas the other options will only override
|
|
|
|
requested parts of the user's umask value). Examples: '0660' will make
|
|
|
|
the repo read/write-able for the owner and group, but inaccessible to
|
|
|
|
others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
|
2008-04-16 12:34:24 +04:00
|
|
|
repository that is group-readable but not group-writable.
|
|
|
|
See linkgit:git-init[1]. False by default.
|
2006-04-25 02:59:33 +04:00
|
|
|
|
|
|
|
core.warnAmbiguousRefs::
|
2013-01-21 23:17:53 +04:00
|
|
|
If true, Git will warn you if the ref name you passed it is ambiguous
|
2013-02-25 09:34:14 +04:00
|
|
|
and might match multiple refs in the repository. True by default.
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2006-07-07 00:35:54 +04:00
|
|
|
core.compression::
|
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-10 00:56:50 +04:00
|
|
|
An integer -1..9, indicating a default compression level.
|
|
|
|
-1 is the zlib default. 0 means no compression,
|
|
|
|
and 1..9 are various speed/size tradeoffs, 9 being slowest.
|
2007-11-19 19:58:51 +03:00
|
|
|
If set, this provides a default to other compression variables,
|
|
|
|
such as 'core.loosecompression' and 'pack.compression'.
|
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-10 00:56:50 +04:00
|
|
|
|
|
|
|
core.loosecompression::
|
2006-07-04 00:11:47 +04:00
|
|
|
An integer -1..9, indicating the compression level for objects that
|
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-10 00:56:50 +04:00
|
|
|
are not in a pack file. -1 is the zlib default. 0 means no
|
2006-07-04 00:11:47 +04:00
|
|
|
compression, and 1..9 are various speed/size tradeoffs, 9 being
|
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-10 00:56:50 +04:00
|
|
|
slowest. If not set, defaults to core.compression. If that is
|
2007-11-19 19:58:50 +03:00
|
|
|
not set, defaults to 1 (best speed).
|
2006-07-04 00:11:47 +04:00
|
|
|
|
2006-12-23 10:34:28 +03:00
|
|
|
core.packedGitWindowSize::
|
|
|
|
Number of bytes of a pack file to map into memory in a
|
|
|
|
single mapping operation. Larger window sizes may allow
|
|
|
|
your system to process a smaller number of large pack files
|
|
|
|
more quickly. Smaller window sizes will negatively affect
|
2006-12-31 06:13:43 +03:00
|
|
|
performance due to increased calls to the operating system's
|
2006-12-23 10:34:28 +03:00
|
|
|
memory manager, but may improve performance when accessing
|
2007-01-05 06:28:08 +03:00
|
|
|
a large number of large pack files.
|
|
|
|
+
|
|
|
|
Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
|
|
|
|
MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
|
|
|
|
be reasonable for all users/operating systems. You probably do
|
|
|
|
not need to adjust this value.
|
2006-12-31 06:13:43 +03:00
|
|
|
+
|
|
|
|
Common unit suffixes of 'k', 'm', or 'g' are supported.
|
2006-12-23 10:34:28 +03:00
|
|
|
|
2006-12-23 10:33:35 +03:00
|
|
|
core.packedGitLimit::
|
|
|
|
Maximum number of bytes to map simultaneously into memory
|
|
|
|
from pack files. If Git needs to access more than this many
|
|
|
|
bytes at once to complete an operation it will unmap existing
|
|
|
|
regions to reclaim virtual address space within the process.
|
2007-01-05 06:28:08 +03:00
|
|
|
+
|
|
|
|
Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
|
|
|
|
This should be reasonable for all users/operating systems, except on
|
|
|
|
the largest projects. You probably do not need to adjust this value.
|
2006-12-31 06:13:43 +03:00
|
|
|
+
|
|
|
|
Common unit suffixes of 'k', 'm', or 'g' are supported.
|
2006-12-23 10:33:35 +03:00
|
|
|
|
2007-03-19 08:14:37 +03:00
|
|
|
core.deltaBaseCacheLimit::
|
|
|
|
Maximum number of bytes to reserve for caching base objects
|
2010-07-20 01:17:17 +04:00
|
|
|
that may be referenced by multiple deltified objects. By storing the
|
2007-03-19 08:14:37 +03:00
|
|
|
entire decompressed base objects in a cache Git is able
|
|
|
|
to avoid unpacking and decompressing frequently used base
|
|
|
|
objects multiple times.
|
|
|
|
+
|
|
|
|
Default is 16 MiB on all platforms. This should be reasonable
|
|
|
|
for all users/operating systems, except on the largest projects.
|
|
|
|
You probably do not need to adjust this value.
|
|
|
|
+
|
|
|
|
Common unit suffixes of 'k', 'm', or 'g' are supported.
|
|
|
|
|
2010-02-01 20:27:35 +03:00
|
|
|
core.bigFileThreshold::
|
|
|
|
Files larger than this size are stored deflated, without
|
|
|
|
attempting delta compression. Storing large files without
|
|
|
|
delta compression avoids excessive memory usage, at the
|
|
|
|
slight expense of increased disk usage.
|
|
|
|
+
|
|
|
|
Default is 512 MiB on all platforms. This should be reasonable
|
|
|
|
for most projects as source code and other text files can still
|
|
|
|
be delta compressed, but larger binary media files won't be.
|
|
|
|
+
|
|
|
|
Common unit suffixes of 'k', 'm', or 'g' are supported.
|
|
|
|
|
2007-07-02 20:48:34 +04:00
|
|
|
core.excludesfile::
|
2007-05-22 04:12:17 +04:00
|
|
|
In addition to '.gitignore' (per-directory) and
|
2013-01-21 23:17:53 +04:00
|
|
|
'.git/info/exclude', Git looks into this file for patterns
|
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 12:51:57 +04:00
|
|
|
of files which are not meant to be tracked. "`~/`" is expanded
|
|
|
|
to the value of `$HOME` and "`~user/`" to the specified user's
|
2012-06-22 13:03:24 +04:00
|
|
|
home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
|
|
|
|
If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
|
|
|
|
is used instead. See linkgit:gitignore[5].
|
2007-05-22 04:12:17 +04:00
|
|
|
|
2010-08-30 17:38:38 +04:00
|
|
|
core.askpass::
|
|
|
|
Some commands (e.g. svn and http interfaces) that interactively
|
|
|
|
ask for a password can be told to use an external program given
|
2010-08-30 17:40:29 +04:00
|
|
|
via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
|
|
|
|
environment variable. If not set, fall back to the value of the
|
|
|
|
'SSH_ASKPASS' environment variable or, failing that, a simple password
|
|
|
|
prompt. The external program shall be given a suitable prompt as
|
|
|
|
command line argument and write the password on its STDOUT.
|
2010-08-30 17:38:38 +04:00
|
|
|
|
2010-09-01 02:42:43 +04:00
|
|
|
core.attributesfile::
|
|
|
|
In addition to '.gitattributes' (per-directory) and
|
2013-01-21 23:17:53 +04:00
|
|
|
'.git/info/attributes', Git looks into this file for attributes
|
2010-09-01 02:42:43 +04:00
|
|
|
(see linkgit:gitattributes[5]). Path expansions are made the same
|
2012-06-22 13:03:25 +04:00
|
|
|
way as for `core.excludesfile`. Its default value is
|
|
|
|
$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
|
|
|
|
set or empty, $HOME/.config/git/attributes is used instead.
|
2010-09-01 02:42:43 +04:00
|
|
|
|
2007-07-20 09:09:35 +04:00
|
|
|
core.editor::
|
|
|
|
Commands such as `commit` and `tag` that lets you edit
|
2007-08-24 04:44:13 +04:00
|
|
|
messages by launching an editor uses the value of this
|
2007-07-20 09:09:35 +04:00
|
|
|
variable when it is set, and the environment variable
|
2009-10-31 04:42:34 +03:00
|
|
|
`GIT_EDITOR` is not set. See linkgit:git-var[1].
|
2007-07-20 09:09:35 +04:00
|
|
|
|
2013-01-16 23:18:48 +04:00
|
|
|
core.commentchar::
|
|
|
|
Commands such as `commit` and `tag` that lets you edit
|
|
|
|
messages consider a line that begins with this character
|
|
|
|
commented, and removes them after the editor returns
|
|
|
|
(default '#').
|
|
|
|
|
2011-10-18 00:26:23 +04:00
|
|
|
sequence.editor::
|
2013-03-28 02:53:50 +04:00
|
|
|
Text editor used by `git rebase -i` for editing the rebase instruction file.
|
2011-10-18 00:26:23 +04:00
|
|
|
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.
|
|
|
|
|
2007-07-03 22:18:11 +04:00
|
|
|
core.pager::
|
2013-08-29 00:26:12 +04:00
|
|
|
Text viewer for use by Git commands (e.g., 'less'). The value
|
|
|
|
is meant to be interpreted by the shell. The order of preference
|
|
|
|
is the `$GIT_PAGER` environment variable, then `core.pager`
|
|
|
|
configuration, then `$PAGER`, and then the default chosen at
|
|
|
|
compile time (usually 'less').
|
|
|
|
+
|
|
|
|
When the `LESS` environment variable is unset, Git sets it to `FRSX`
|
|
|
|
(if `LESS` environment variable is set, Git does not change it at
|
|
|
|
all). If you want to selectively override Git's default setting
|
|
|
|
for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
|
|
|
|
be passed to the shell by Git, which will translate the final
|
|
|
|
command to `LESS=FRSX less -+S`. The environment tells the command
|
|
|
|
to set the `S` option to chop long lines but the command line
|
|
|
|
resets it to the default to fold long lines.
|
2014-01-07 06:14:05 +04:00
|
|
|
+
|
|
|
|
Likewise, when the `LV` environment variable is unset, Git sets it
|
|
|
|
to `-c`. You can override this setting by exporting `LV` with
|
|
|
|
another value or setting `core.pager` to `lv +c`.
|
2007-07-03 22:18:11 +04:00
|
|
|
|
2007-11-24 22:57:41 +03:00
|
|
|
core.whitespace::
|
|
|
|
A comma separated list of common whitespace problems to
|
2010-01-10 02:33:00 +03:00
|
|
|
notice. 'git diff' will use `color.diff.whitespace` to
|
|
|
|
highlight them, and 'git apply --whitespace=error' will
|
2008-07-25 11:34:47 +04:00
|
|
|
consider them as errors. You can prefix `-` to disable
|
|
|
|
any of them (e.g. `-trailing-space`):
|
2007-11-24 22:57:41 +03:00
|
|
|
+
|
2009-09-06 09:21:17 +04:00
|
|
|
* `blank-at-eol` treats trailing whitespaces at the end of the line
|
2007-11-24 22:57:41 +03:00
|
|
|
as an error (enabled by default).
|
|
|
|
* `space-before-tab` treats a space character that appears immediately
|
|
|
|
before a tab character in the initial indent part of the line as an
|
|
|
|
error (enabled by default).
|
2012-09-17 18:22:15 +04:00
|
|
|
* `indent-with-non-tab` treats a line that is indented with space
|
|
|
|
characters instead of the equivalent tabs as an error (not enabled by
|
|
|
|
default).
|
2010-04-03 03:37:08 +04:00
|
|
|
* `tab-in-indent` treats a tab character in the initial indent part of
|
|
|
|
the line as an error (not enabled by default).
|
apply --whitespace=warn/error: diagnose blank at EOF
"git apply" strips new blank lines at EOF under --whitespace=fix option,
but neigher --whitespace=warn nor --whitespace=error paid any attention to
these errors.
Introduce a new whitespace error class, blank-at-eof, to make the
whitespace error handling more consistent.
The patch adds a new "linenr" field to the struct fragment in order to
record which line the hunk started in the input file, but this is needed
solely for reporting purposes. The detection of this class of whitespace
errors cannot be done while parsing a patch like we do for all the other
classes of whitespace errors. It instead has to wait until we find where
to apply the hunk, but at that point, we do not have an access to the
original line number in the input file anymore, hence the new field.
Depending on your point of view, this may be a bugfix that makes warn and
error in line with fix. Or you could call it a new feature. The line
between them is somewhat fuzzy in this case.
Strictly speaking, triggering more errors than before is a change in
behaviour that is not backward compatible, even though the reason for the
change is because the code was not checking for an error that it should
have. People who do not want added blank lines at EOF to trigger an error
can disable the new error class.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-09-04 03:02:32 +04:00
|
|
|
* `blank-at-eof` treats blank lines added at the end of file as an error
|
|
|
|
(enabled by default).
|
2009-09-06 09:21:17 +04:00
|
|
|
* `trailing-space` is a short-hand to cover both `blank-at-eol` and
|
|
|
|
`blank-at-eof`.
|
2008-01-15 11:59:05 +03:00
|
|
|
* `cr-at-eol` treats a carriage-return at the end of line as
|
|
|
|
part of the line terminator, i.e. with it, `trailing-space`
|
|
|
|
does not trigger if the character before such a carriage-return
|
|
|
|
is not a whitespace (not enabled by default).
|
2010-11-30 11:29:11 +03:00
|
|
|
* `tabwidth=<n>` tells how many character positions a tab occupies; this
|
2013-01-21 23:17:53 +04:00
|
|
|
is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
|
2010-11-30 11:29:11 +03:00
|
|
|
errors. The default tab width is 8. Allowed values are 1 to 63.
|
2007-11-24 22:57:41 +03:00
|
|
|
|
2008-06-19 02:18:44 +04:00
|
|
|
core.fsyncobjectfiles::
|
|
|
|
This boolean will enable 'fsync()' when writing object files.
|
|
|
|
+
|
|
|
|
This is a total waste of time and effort on a filesystem that orders
|
|
|
|
data writes properly, but can be useful for filesystems that do not use
|
|
|
|
journalling (traditional UNIX filesystems) or that only journal metadata
|
|
|
|
and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
|
|
|
|
|
2008-11-14 03:36:30 +03:00
|
|
|
core.preloadindex::
|
|
|
|
Enable parallel index preload for operations like 'git diff'
|
|
|
|
+
|
|
|
|
This can speed up operations like 'git diff' and 'git status' especially
|
|
|
|
on filesystems like NFS that have weak caching semantics and thus
|
2013-01-21 23:17:53 +04:00
|
|
|
relatively high IO latencies. With this set to 'true', Git will do the
|
2008-11-14 03:36:30 +03:00
|
|
|
index comparison to the filesystem data in parallel, allowing
|
|
|
|
overlapping IO's.
|
|
|
|
|
2009-04-28 02:32:25 +04:00
|
|
|
core.createObject::
|
|
|
|
You can set this to 'link', in which case a hardlink followed by
|
|
|
|
a delete of the source are used to make sure that object creation
|
|
|
|
will not overwrite existing objects.
|
|
|
|
+
|
|
|
|
On some file system/operating system combinations, this is unreliable.
|
|
|
|
Set this config setting to 'rename' there; However, This will remove the
|
|
|
|
check that makes sure that existing object files will not get overwritten.
|
2009-04-25 13:57:14 +04:00
|
|
|
|
2009-10-09 14:21:57 +04:00
|
|
|
core.notesRef::
|
|
|
|
When showing commit messages, also show notes which are stored in
|
2010-05-09 07:19:35 +04:00
|
|
|
the given ref. The ref must be fully qualified. If the given
|
|
|
|
ref does not exist, it is not an error but means that no
|
|
|
|
notes should be printed.
|
2009-10-09 14:21:57 +04:00
|
|
|
+
|
2010-05-09 07:19:35 +04:00
|
|
|
This setting defaults to "refs/notes/commits", and it can be overridden by
|
|
|
|
the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
|
2009-10-09 14:21:57 +04:00
|
|
|
|
2009-08-20 17:47:08 +04:00
|
|
|
core.sparseCheckout::
|
|
|
|
Enable "sparse checkout" feature. See section "Sparse checkout" in
|
|
|
|
linkgit:git-read-tree[1] for more information.
|
|
|
|
|
2011-03-21 08:26:24 +03:00
|
|
|
core.abbrev::
|
2010-10-28 22:28:04 +04:00
|
|
|
Set the length object names are abbreviated to. If unspecified,
|
|
|
|
many commands abbreviate to 7 hexdigits, which may not be enough
|
|
|
|
for abbreviated object names to stay unique for sufficiently long
|
|
|
|
time.
|
|
|
|
|
2009-05-31 09:08:02 +04:00
|
|
|
add.ignore-errors::
|
2010-12-01 21:36:15 +03:00
|
|
|
add.ignoreErrors::
|
2010-01-10 02:33:00 +03:00
|
|
|
Tells 'git add' to continue adding files when some files cannot be
|
2009-05-31 09:08:02 +04:00
|
|
|
added due to indexing errors. Equivalent to the '--ignore-errors'
|
2013-01-21 23:17:53 +04:00
|
|
|
option of linkgit:git-add[1]. Older versions of Git accept only
|
2010-12-01 21:36:15 +03:00
|
|
|
`add.ignore-errors`, which does not follow the usual naming
|
2013-01-21 23:17:53 +04:00
|
|
|
convention for configuration variables. Newer versions of Git
|
2010-12-01 21:36:15 +03:00
|
|
|
honor `add.ignoreErrors` as well.
|
2009-05-31 09:08:02 +04:00
|
|
|
|
2006-06-07 22:43:50 +04:00
|
|
|
alias.*::
|
2007-12-29 09:20:38 +03:00
|
|
|
Command aliases for the linkgit:git[1] command wrapper - e.g.
|
2006-06-07 22:43:50 +04:00
|
|
|
after defining "alias.last = cat-file commit HEAD", the invocation
|
|
|
|
"git last" is equivalent to "git cat-file commit HEAD". To avoid
|
2006-06-08 04:25:21 +04:00
|
|
|
confusion and troubles with script usage, aliases that
|
2013-01-21 23:17:53 +04:00
|
|
|
hide existing Git commands are ignored. Arguments are split by
|
2006-06-08 04:25:21 +04:00
|
|
|
spaces, the usual shell quoting and escaping is supported.
|
|
|
|
quote pair and a backslash can be used to quote them.
|
2007-09-01 15:01:54 +04:00
|
|
|
+
|
|
|
|
If the alias expansion is prefixed with an exclamation point,
|
|
|
|
it will be treated as a shell command. For example, defining
|
|
|
|
"alias.new = !gitk --all --not ORIG_HEAD", the invocation
|
|
|
|
"git new" is equivalent to running the shell command
|
2009-07-01 20:00:31 +04:00
|
|
|
"gitk --all --not ORIG_HEAD". Note that shell commands will be
|
|
|
|
executed from the top-level directory of a repository, which may
|
|
|
|
not necessarily be the current directory.
|
2011-04-27 12:36:27 +04:00
|
|
|
'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
|
|
|
|
from the original current directory. See linkgit:git-rev-parse[1].
|
2007-02-11 03:33:58 +03:00
|
|
|
|
2010-02-27 17:20:27 +03:00
|
|
|
am.keepcr::
|
|
|
|
If true, git-am will call git-mailsplit for patches in mbox format
|
|
|
|
with parameter '--keep-cr'. In this case git-mailsplit will
|
2010-07-20 01:17:17 +04:00
|
|
|
not remove `\r` from lines ending with `\r\n`. Can be overridden
|
2010-02-27 17:20:27 +03:00
|
|
|
by giving '--no-keep-cr' from the command line.
|
|
|
|
See linkgit:git-am[1], linkgit:git-mailsplit[1].
|
|
|
|
|
2009-08-04 15:16:49 +04:00
|
|
|
apply.ignorewhitespace::
|
2010-01-10 02:33:00 +03:00
|
|
|
When set to 'change', tells 'git apply' to ignore changes in
|
2009-08-04 15:16:49 +04:00
|
|
|
whitespace, in the same way as the '--ignore-space-change'
|
|
|
|
option.
|
2010-01-10 02:33:00 +03:00
|
|
|
When set to one of: no, none, never, false tells 'git apply' to
|
2009-08-04 15:16:49 +04:00
|
|
|
respect all whitespace differences.
|
|
|
|
See linkgit:git-apply[1].
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
apply.whitespace::
|
2010-01-10 02:33:00 +03:00
|
|
|
Tells 'git apply' how to handle whitespaces, in the same way
|
2007-12-29 09:20:38 +03:00
|
|
|
as the '--whitespace' option. See linkgit:git-apply[1].
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2007-05-23 09:07:54 +04:00
|
|
|
branch.autosetupmerge::
|
2010-01-21 07:28:49 +03:00
|
|
|
Tells 'git branch' and 'git checkout' to set up new branches
|
2008-02-19 19:24:38 +03:00
|
|
|
so that linkgit:git-pull[1] will appropriately merge from the
|
|
|
|
starting point branch. Note that even if this option is not set,
|
2007-05-23 09:07:54 +04:00
|
|
|
this behavior can be chosen per-branch using the `--track`
|
2008-02-19 19:24:38 +03:00
|
|
|
and `--no-track` options. The valid settings are: `false` -- no
|
|
|
|
automatic setup is done; `true` -- automatic setup is done when the
|
2010-11-02 18:31:24 +03:00
|
|
|
starting point is a remote-tracking branch; `always` --
|
|
|
|
automatic setup is done when the starting point is either a
|
|
|
|
local branch or remote-tracking
|
2008-02-19 19:24:38 +03:00
|
|
|
branch. This option defaults to true.
|
2007-05-23 09:07:54 +04:00
|
|
|
|
2008-05-11 02:36:29 +04:00
|
|
|
branch.autosetuprebase::
|
2010-01-10 02:33:00 +03:00
|
|
|
When a new branch is created with 'git branch' or 'git checkout'
|
2013-01-21 23:17:53 +04:00
|
|
|
that tracks another branch, this variable tells Git to set
|
2008-05-11 02:36:29 +04:00
|
|
|
up pull to rebase instead of merge (see "branch.<name>.rebase").
|
|
|
|
When `never`, rebase is never automatically set to true.
|
|
|
|
When `local`, rebase is set to true for tracked branches of
|
|
|
|
other local branches.
|
|
|
|
When `remote`, rebase is set to true for tracked branches of
|
2010-11-02 18:31:24 +03:00
|
|
|
remote-tracking branches.
|
2008-05-11 02:36:29 +04:00
|
|
|
When `always`, rebase will be set to true for all tracking
|
|
|
|
branches.
|
|
|
|
See "branch.autosetupmerge" for details on how to set up a
|
|
|
|
branch to track another branch.
|
|
|
|
This option defaults to never.
|
|
|
|
|
2006-09-23 14:05:43 +04:00
|
|
|
branch.<name>.remote::
|
2013-04-02 11:40:33 +04:00
|
|
|
When on branch <name>, it tells 'git fetch' and 'git push'
|
|
|
|
which remote to fetch from/push to. The remote to push to
|
|
|
|
may be overridden with `remote.pushdefault` (for all branches).
|
2013-04-02 11:40:34 +04:00
|
|
|
The remote to push to, for the current branch, may be further
|
|
|
|
overridden by `branch.<name>.pushremote`. If no remote is
|
|
|
|
configured, or if you are not on any branch, it defaults to
|
|
|
|
`origin` for fetching and `remote.pushdefault` for pushing.
|
2013-09-14 01:23:16 +04:00
|
|
|
Additionally, `.` (a period) is the current local repository
|
|
|
|
(a dot-repository), see `branch.<name>.merge`'s final note below.
|
2013-04-02 11:40:34 +04:00
|
|
|
|
|
|
|
branch.<name>.pushremote::
|
|
|
|
When on branch <name>, it overrides `branch.<name>.remote` for
|
|
|
|
pushing. It also overrides `remote.pushdefault` for pushing
|
|
|
|
from branch <name>. When you pull from one place (e.g. your
|
|
|
|
upstream) and push to another place (e.g. your own publishing
|
|
|
|
repository), you would want to set `remote.pushdefault` to
|
|
|
|
specify the remote to push to for all branches, and use this
|
|
|
|
option to override it for a specific branch.
|
2006-09-23 14:05:43 +04:00
|
|
|
|
2006-09-24 00:53:04 +04:00
|
|
|
branch.<name>.merge::
|
2009-03-30 14:11:40 +04:00
|
|
|
Defines, together with branch.<name>.remote, the upstream branch
|
2011-02-10 04:54:02 +03:00
|
|
|
for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
|
2010-01-10 02:33:00 +03:00
|
|
|
branch to merge and can also affect 'git push' (see push.default).
|
|
|
|
When in branch <name>, it tells 'git fetch' the default
|
2007-09-11 07:03:25 +04:00
|
|
|
refspec to be marked for merging in FETCH_HEAD. The value is
|
|
|
|
handled like the remote part of a refspec, and must match a
|
|
|
|
ref which is fetched from the remote given by
|
|
|
|
"branch.<name>.remote".
|
2010-01-10 02:33:00 +03:00
|
|
|
The merge information is used by 'git pull' (which at first calls
|
|
|
|
'git fetch') to lookup the default branch for merging. Without
|
|
|
|
this option, 'git pull' defaults to merge the first refspec fetched.
|
2006-12-09 04:28:26 +03:00
|
|
|
Specify multiple values to get an octopus merge.
|
2010-01-10 02:33:00 +03:00
|
|
|
If you wish to setup 'git pull' so that it merges into <name> from
|
git-fetch, git-branch: Support local --track via a special remote '.'
This patch adds support for a dummy remote '.' to avoid having
to declare a fake remote like
[remote "local"]
url = .
fetch = refs/heads/*:refs/heads/*
Such a builtin remote simplifies the operation of "git-fetch",
which will populate FETCH_HEAD but will not pretend that two
repositories are in use, will not create a thin pack, and will
not perform any useless remapping of names. The speed
improvement is around 20%, and it should improve more if
"git-fetch" is converted to a builtin.
To this end, git-parse-remote is grown with a new kind of
remote, 'builtin'. In git-fetch.sh, we treat the builtin remote
specially in that it needs no pack/store operations. In fact,
doing git-fetch on a builtin remote will simply populate
FETCH_HEAD appropriately.
The patch also improves of the --track/--no-track support,
extending it so that branch.<name>.remote items referring '.'
can be created. Finally, it fixes a typo in git-checkout.sh.
Signed-off-by: Paolo Bonzini <bonzini@gnu.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-15 11:23:20 +03:00
|
|
|
another branch in the local repository, you can point
|
2013-09-14 01:23:16 +04:00
|
|
|
branch.<name>.merge to the desired branch, and use the relative path
|
|
|
|
setting `.` (a period) for branch.<name>.remote.
|
2006-09-24 00:53:04 +04:00
|
|
|
|
2007-09-24 02:51:43 +04:00
|
|
|
branch.<name>.mergeoptions::
|
|
|
|
Sets default options for merging into branch <name>. The syntax and
|
2009-10-09 22:51:14 +04:00
|
|
|
supported options are the same as those of linkgit:git-merge[1], but
|
2007-09-24 02:51:43 +04:00
|
|
|
option values containing whitespace characters are currently not
|
|
|
|
supported.
|
|
|
|
|
2007-11-28 16:11:07 +03:00
|
|
|
branch.<name>.rebase::
|
|
|
|
When true, rebase the branch <name> on top of the fetched branch,
|
2008-05-08 22:28:07 +04:00
|
|
|
instead of merging the default branch from the default remote when
|
2011-11-06 13:50:10 +04:00
|
|
|
"git pull" is run. See "pull.rebase" for doing this in a non
|
|
|
|
branch-specific manner.
|
2013-08-13 07:43:42 +04:00
|
|
|
+
|
|
|
|
When preserve, also pass `--preserve-merges` along to 'git rebase'
|
|
|
|
so that locally committed merge commits will not be flattened
|
|
|
|
by running 'git pull'.
|
2011-11-06 13:50:10 +04:00
|
|
|
+
|
|
|
|
*NOTE*: this is a possibly dangerous operation; do *not* use
|
|
|
|
it unless you understand the implications (see linkgit:git-rebase[1]
|
|
|
|
for details).
|
2007-11-28 16:11:07 +03:00
|
|
|
|
2013-01-01 13:30:53 +04:00
|
|
|
branch.<name>.description::
|
|
|
|
Branch description, can be edited with
|
|
|
|
`git branch --edit-description`. Branch description is
|
|
|
|
automatically added in the format-patch cover letter or
|
|
|
|
request-pull summary.
|
|
|
|
|
2008-03-14 07:56:53 +03:00
|
|
|
browser.<tool>.cmd::
|
|
|
|
Specify the command to invoke the specified browser. The
|
|
|
|
specified command is evaluated in shell with the URLs passed
|
Documentation: quote double-dash for AsciiDoc
AsciiDoc versions since 5.0.6 treat a double-dash surrounded by spaces
(outside of verbatim environments) as a request to insert an em dash.
Such versions also treat the three-character sequence "\--", when not
followed by another dash, as a request to insert two literal minus
signs. Thus from time to time there have been patches to add
backslashes to AsciiDoc markup to escape double-dashes that are meant
to be represent '--' characters used literally on the command line;
see v1.4.0-rc1~174, Fix up docs where "--" isn't displayed correctly,
2006-05-05, for example.
AsciiDoc 6.0.3 (2005-04-20) made life harder by also treating
double-dashes without surrounding whitespace as markup for an em dash,
though only when formatting for backends other than the manpages
(e.g., HTML). Many pages needed to be changed to use a backslash
before the "--" in names of command-line flags like "--add" (see
v0.99.6~37, Update tutorial, 2005-08-30).
AsciiDoc 8.3.0 (2008-11-29) refined the em-dash rule to avoid that
requirement. Double-dashes without surrounding spaces are not
rendered as em dashes any more unless bordered on both sides by
alphanumeric characters. The unescaped markup for option names (e.g.,
"--add") works fine, and many instances of this style have leaked into
Documentation/; git's HTML documentation contains many spurious em
dashes when formatted by an older toolchain. (This patch will not
change that.)
The upshot: "--" as an isolated word and in phrases like "git
web--browse" must be escaped if it is not to be rendered as an em dash
by current asciidoc. Use "\--" to avoid such misformatting in
sentences in which "--" represents a literal double-minus command line
argument that separates options and revs from pathspecs, and use
"{litdd}" in cases where the double-dash is embedded in the command
name. The latter is just for consistency with v1.7.3-rc0~13^2 (Work
around em-dash handling in newer AsciiDoc, 2010-08-23).
List of lines to fix found by grepping manpages for "(em".
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Improved-by: Junio C Hamano <gitster@pobox.com>
Improved-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-06-29 09:35:10 +04:00
|
|
|
as arguments. (See linkgit:git-web{litdd}browse[1].)
|
2008-03-14 07:56:53 +03:00
|
|
|
|
2008-01-29 09:08:22 +03:00
|
|
|
browser.<tool>.path::
|
|
|
|
Override the path for the given tool that may be used to
|
2008-01-29 09:08:44 +03:00
|
|
|
browse HTML help (see '-w' option in linkgit:git-help[1]) or a
|
|
|
|
working repository in gitweb (see linkgit:git-instaweb[1]).
|
2008-01-29 09:08:22 +03:00
|
|
|
|
2007-04-24 04:18:16 +04:00
|
|
|
clean.requireForce::
|
2013-08-28 05:28:32 +04:00
|
|
|
A boolean to make git-clean do nothing unless given -f,
|
|
|
|
-i or -n. Defaults to true.
|
2007-04-24 04:18:16 +04:00
|
|
|
|
2007-01-03 18:36:29 +03:00
|
|
|
color.branch::
|
|
|
|
A boolean to enable/disable color in the output of
|
2007-12-29 09:20:38 +03:00
|
|
|
linkgit:git-branch[1]. May be set to `always`,
|
2007-12-06 04:05:17 +03:00
|
|
|
`false` (or `never`) or `auto` (or `true`), in which case colors are used
|
2007-01-03 18:36:29 +03:00
|
|
|
only when the output is to a terminal. Defaults to false.
|
|
|
|
|
|
|
|
color.branch.<slot>::
|
|
|
|
Use customized color for branch coloration. `<slot>` is one of
|
|
|
|
`current` (the current branch), `local` (a local branch),
|
2013-04-15 06:37:49 +04:00
|
|
|
`remote` (a remote-tracking branch in refs/remotes/),
|
|
|
|
`upstream` (upstream tracking branch), `plain` (other
|
2007-01-28 18:17:36 +03:00
|
|
|
refs).
|
|
|
|
+
|
|
|
|
The value for these configuration variables is a list of colors (at most
|
|
|
|
two) and attributes (at most one), separated by spaces. The colors
|
|
|
|
accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
|
|
|
|
`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
|
|
|
|
`blink` and `reverse`. The first color given is the foreground; the
|
|
|
|
second is the background. The position of the attribute, if any,
|
|
|
|
doesn't matter.
|
2007-01-03 18:36:29 +03:00
|
|
|
|
2006-12-13 12:13:28 +03:00
|
|
|
color.diff::
|
2011-04-27 11:38:27 +04:00
|
|
|
Whether to use ANSI escape sequences to add color to patches.
|
|
|
|
If this is set to `always`, linkgit:git-diff[1],
|
|
|
|
linkgit:git-log[1], and linkgit:git-show[1] will use color
|
|
|
|
for all patches. If it is set to `true` or `auto`, those
|
|
|
|
commands will only use color when output is to the terminal.
|
|
|
|
Defaults to false.
|
|
|
|
+
|
2014-04-01 02:11:44 +04:00
|
|
|
This does not affect linkgit:git-format-patch[1] or the
|
2011-04-27 11:38:27 +04:00
|
|
|
'git-diff-{asterisk}' plumbing commands. Can be overridden on the
|
|
|
|
command line with the `--color[=<when>]` option.
|
2006-07-07 16:28:05 +04:00
|
|
|
|
2006-12-13 12:13:28 +03:00
|
|
|
color.diff.<slot>::
|
2007-01-28 18:17:36 +03:00
|
|
|
Use customized color for diff colorization. `<slot>` specifies
|
|
|
|
which part of the patch to use the specified color, and is one
|
|
|
|
of `plain` (context text), `meta` (metainformation), `frag`
|
2009-11-27 09:55:18 +03:00
|
|
|
(hunk header), 'func' (function in hunk header), `old` (removed lines),
|
|
|
|
`new` (added lines), `commit` (commit headers), or `whitespace`
|
|
|
|
(highlighting whitespace errors). The values of these variables may be
|
|
|
|
specified as in color.branch.<slot>.
|
2006-07-07 16:28:05 +04:00
|
|
|
|
2010-06-24 04:21:16 +04:00
|
|
|
color.decorate.<slot>::
|
|
|
|
Use customized color for 'git log --decorate' output. `<slot>` is one
|
|
|
|
of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
|
2010-11-02 18:31:20 +03:00
|
|
|
branches, remote-tracking branches, tags, stash and HEAD, respectively.
|
2010-06-24 04:21:16 +04:00
|
|
|
|
2009-03-07 15:32:32 +03:00
|
|
|
color.grep::
|
|
|
|
When set to `always`, always highlight matches. When `false` (or
|
|
|
|
`never`), never. When set to `true` or `auto`, use color only
|
|
|
|
when the output is written to the terminal. Defaults to `false`.
|
|
|
|
|
grep: Colorize filename, line number, and separator
Colorize the filename, line number, and separator in git grep output, as
GNU grep does. The colors are customizable through color.grep.<slot>.
The default is to only color the separator (in cyan), since this gives
the biggest legibility increase without overwhelming the user with
colors. GNU grep also defaults cyan for the separator, but defaults to
magenta for the filename and to green for the line number, as well.
There is one difference from GNU grep: When a binary file matches
without -a, GNU grep does not color the <file> in "Binary file <file>
matches", but we do.
Like GNU grep, if --null is given, the null separators are not colored.
For config.txt, use a a sub-list to describe the slots, rather than
a single paragraph with parentheses, since this is much more readable.
Remove the cast to int for `rm_eo - rm_so` since it is not necessary.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-03-07 19:52:46 +03:00
|
|
|
color.grep.<slot>::
|
|
|
|
Use customized color for grep colorization. `<slot>` specifies which
|
|
|
|
part of the line to use the specified color, and is one of
|
|
|
|
+
|
|
|
|
--
|
2010-03-07 19:52:47 +03:00
|
|
|
`context`;;
|
|
|
|
non-matching text in context lines (when using `-A`, `-B`, or `-C`)
|
grep: Colorize filename, line number, and separator
Colorize the filename, line number, and separator in git grep output, as
GNU grep does. The colors are customizable through color.grep.<slot>.
The default is to only color the separator (in cyan), since this gives
the biggest legibility increase without overwhelming the user with
colors. GNU grep also defaults cyan for the separator, but defaults to
magenta for the filename and to green for the line number, as well.
There is one difference from GNU grep: When a binary file matches
without -a, GNU grep does not color the <file> in "Binary file <file>
matches", but we do.
Like GNU grep, if --null is given, the null separators are not colored.
For config.txt, use a a sub-list to describe the slots, rather than
a single paragraph with parentheses, since this is much more readable.
Remove the cast to int for `rm_eo - rm_so` since it is not necessary.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-03-07 19:52:46 +03:00
|
|
|
`filename`;;
|
|
|
|
filename prefix (when not using `-h`)
|
2010-03-07 19:52:47 +03:00
|
|
|
`function`;;
|
|
|
|
function name lines (when using `-p`)
|
grep: Colorize filename, line number, and separator
Colorize the filename, line number, and separator in git grep output, as
GNU grep does. The colors are customizable through color.grep.<slot>.
The default is to only color the separator (in cyan), since this gives
the biggest legibility increase without overwhelming the user with
colors. GNU grep also defaults cyan for the separator, but defaults to
magenta for the filename and to green for the line number, as well.
There is one difference from GNU grep: When a binary file matches
without -a, GNU grep does not color the <file> in "Binary file <file>
matches", but we do.
Like GNU grep, if --null is given, the null separators are not colored.
For config.txt, use a a sub-list to describe the slots, rather than
a single paragraph with parentheses, since this is much more readable.
Remove the cast to int for `rm_eo - rm_so` since it is not necessary.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-03-07 19:52:46 +03:00
|
|
|
`linenumber`;;
|
|
|
|
line number prefix (when using `-n`)
|
|
|
|
`match`;;
|
|
|
|
matching text
|
2010-03-07 19:52:47 +03:00
|
|
|
`selected`;;
|
|
|
|
non-matching text in selected lines
|
grep: Colorize filename, line number, and separator
Colorize the filename, line number, and separator in git grep output, as
GNU grep does. The colors are customizable through color.grep.<slot>.
The default is to only color the separator (in cyan), since this gives
the biggest legibility increase without overwhelming the user with
colors. GNU grep also defaults cyan for the separator, but defaults to
magenta for the filename and to green for the line number, as well.
There is one difference from GNU grep: When a binary file matches
without -a, GNU grep does not color the <file> in "Binary file <file>
matches", but we do.
Like GNU grep, if --null is given, the null separators are not colored.
For config.txt, use a a sub-list to describe the slots, rather than
a single paragraph with parentheses, since this is much more readable.
Remove the cast to int for `rm_eo - rm_so` since it is not necessary.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-03-07 19:52:46 +03:00
|
|
|
`separator`;;
|
|
|
|
separators between fields on a line (`:`, `-`, and `=`)
|
|
|
|
and between hunks (`--`)
|
|
|
|
--
|
|
|
|
+
|
|
|
|
The values of these variables may be specified as in color.branch.<slot>.
|
2009-03-07 15:32:32 +03:00
|
|
|
|
2007-12-05 11:50:23 +03:00
|
|
|
color.interactive::
|
2008-01-05 12:57:44 +03:00
|
|
|
When set to `always`, always use colors for interactive prompts
|
2013-06-25 19:53:50 +04:00
|
|
|
and displays (such as those used by "git-add --interactive" and
|
|
|
|
"git-clean --interactive"). When false (or `never`), never.
|
|
|
|
When set to `true` or `auto`, use colors only when the output is
|
|
|
|
to the terminal. Defaults to false.
|
2007-12-05 11:50:23 +03:00
|
|
|
|
|
|
|
color.interactive.<slot>::
|
2013-06-25 19:53:50 +04:00
|
|
|
Use customized color for 'git add --interactive' and 'git clean
|
|
|
|
--interactive' output. `<slot>` may be `prompt`, `header`, `help`
|
|
|
|
or `error`, for four distinct types of normal output from
|
|
|
|
interactive commands. The values of these variables may be
|
|
|
|
specified as in color.branch.<slot>.
|
2007-12-05 11:50:23 +03:00
|
|
|
|
2006-12-13 23:11:03 +03:00
|
|
|
color.pager::
|
|
|
|
A boolean to enable/disable colored output when the pager is in
|
|
|
|
use (default is true).
|
|
|
|
|
2009-04-23 01:41:25 +04:00
|
|
|
color.showbranch::
|
|
|
|
A boolean to enable/disable color in the output of
|
|
|
|
linkgit:git-show-branch[1]. May be set to `always`,
|
|
|
|
`false` (or `never`) or `auto` (or `true`), in which case colors are used
|
|
|
|
only when the output is to a terminal. Defaults to false.
|
|
|
|
|
2006-12-13 23:11:03 +03:00
|
|
|
color.status::
|
|
|
|
A boolean to enable/disable color in the output of
|
2007-12-29 09:20:38 +03:00
|
|
|
linkgit:git-status[1]. May be set to `always`,
|
2007-12-06 04:05:17 +03:00
|
|
|
`false` (or `never`) or `auto` (or `true`), in which case colors are used
|
2006-12-13 23:11:03 +03:00
|
|
|
only when the output is to a terminal. Defaults to false.
|
|
|
|
|
|
|
|
color.status.<slot>::
|
|
|
|
Use customized color for status colorization. `<slot>` is
|
|
|
|
one of `header` (the header text of the status message),
|
2006-12-16 05:53:13 +03:00
|
|
|
`added` or `updated` (files which are added but not committed),
|
|
|
|
`changed` (files which are changed but not added in the index),
|
2013-01-21 23:17:53 +04:00
|
|
|
`untracked` (files which are not tracked by Git),
|
2010-11-18 02:40:05 +03:00
|
|
|
`branch` (the current branch), or
|
2008-05-22 16:50:02 +04:00
|
|
|
`nobranch` (the color the 'no branch' warning is shown in, defaulting
|
|
|
|
to red). The values of these variables may be specified as in
|
|
|
|
color.branch.<slot>.
|
2006-12-13 23:11:03 +03:00
|
|
|
|
2008-02-18 10:26:03 +03:00
|
|
|
color.ui::
|
2011-04-27 11:38:27 +04:00
|
|
|
This variable determines the default value for variables such
|
|
|
|
as `color.diff` and `color.grep` that control the use of color
|
|
|
|
per command family. Its scope will expand as more commands learn
|
|
|
|
configuration to set a default for the `--color` option. Set it
|
make color.ui default to 'auto'
Most users seem to like having colors enabled, and colors can help
beginners to understand the output of some commands (e.g. notice
immediately the boundary between commits in the output of "git log").
Many tutorials tell the users to set color.ui=auto as a very first step,
which tend to indicate that color.ui=none is not the recommanded value,
hence should not be the default.
These tutorials would benefit from skipping this step and starting the
real Git manipulations earlier. Other beginners do not know about
color.ui=auto, and may not discover it by themselves, hence live with
black&white outputs while they may have preferred colors.
A few people (e.g. color-blind) prefer having no colors, but they can
easily set color.ui=never for this (and googling "disable colors in git"
already tells them how to do so), but this needs not occupy space in
beginner-oriented documentations.
A transition period with Git emitting a warning when color.ui is unset
would be possible, but the discomfort of having the warning seems
superior to the benefit: users may be surprised by the change, but not
harmed by it.
The default value is changed, and the documentation is reworded to
mention "color.ui=false" first, since the primary use of color.ui after
this change is to disable colors, not to enable it.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-06-10 18:26:09 +04:00
|
|
|
to `false` or `never` if you prefer Git commands not to use
|
|
|
|
color unless enabled explicitly with some other configuration
|
|
|
|
or the `--color` option. Set it to `always` if you want all
|
|
|
|
output not intended for machine consumption to use color, to
|
|
|
|
`true` or `auto` (this is the default since Git 1.8.4) if you
|
|
|
|
want such output to use color when written to the terminal.
|
2008-02-18 10:26:03 +03:00
|
|
|
|
2012-04-21 08:44:32 +04:00
|
|
|
column.ui::
|
|
|
|
Specify whether supported commands should output in columns.
|
|
|
|
This variable consists of a list of tokens separated by spaces
|
|
|
|
or commas:
|
|
|
|
+
|
2013-06-25 19:54:36 +04:00
|
|
|
These options control when the feature should be enabled
|
|
|
|
(defaults to 'never'):
|
|
|
|
+
|
2012-04-21 08:44:32 +04:00
|
|
|
--
|
|
|
|
`always`;;
|
|
|
|
always show in columns
|
|
|
|
`never`;;
|
|
|
|
never show in columns
|
|
|
|
`auto`;;
|
|
|
|
show in columns if the output is to the terminal
|
2013-06-25 19:54:36 +04:00
|
|
|
--
|
|
|
|
+
|
|
|
|
These options control layout (defaults to 'column'). Setting any
|
|
|
|
of these implies 'always' if none of 'always', 'never', or 'auto' are
|
|
|
|
specified.
|
|
|
|
+
|
|
|
|
--
|
2012-04-13 14:54:35 +04:00
|
|
|
`column`;;
|
2013-06-25 19:54:36 +04:00
|
|
|
fill columns before rows
|
2012-04-13 14:54:35 +04:00
|
|
|
`row`;;
|
|
|
|
fill rows before columns
|
2012-04-21 08:44:32 +04:00
|
|
|
`plain`;;
|
|
|
|
show in one column
|
2013-06-25 19:54:36 +04:00
|
|
|
--
|
|
|
|
+
|
|
|
|
Finally, these options can be combined with a layout option (defaults
|
|
|
|
to 'nodense'):
|
|
|
|
+
|
|
|
|
--
|
2012-04-13 14:54:36 +04:00
|
|
|
`dense`;;
|
|
|
|
make unequal size columns to utilize more space
|
|
|
|
`nodense`;;
|
|
|
|
make equal size columns
|
2012-04-21 08:44:32 +04:00
|
|
|
--
|
|
|
|
|
2012-04-13 14:54:38 +04:00
|
|
|
column.branch::
|
|
|
|
Specify whether to output branch listing in `git branch` in columns.
|
|
|
|
See `column.ui` for details.
|
|
|
|
|
2013-06-25 19:53:49 +04:00
|
|
|
column.clean::
|
|
|
|
Specify the layout when list items in `git clean -i`, which always
|
|
|
|
shows files and directories in columns. See `column.ui` for details.
|
|
|
|
|
2012-04-13 14:54:39 +04:00
|
|
|
column.status::
|
|
|
|
Specify whether to output untracked files in `git status` in columns.
|
|
|
|
See `column.ui` for details.
|
|
|
|
|
2012-04-13 14:54:41 +04:00
|
|
|
column.tag::
|
|
|
|
Specify whether to output tag listing in `git tag` in columns.
|
|
|
|
See `column.ui` for details.
|
|
|
|
|
2013-01-10 21:45:59 +04:00
|
|
|
commit.cleanup::
|
|
|
|
This setting overrides the default of the `--cleanup` option in
|
|
|
|
`git commit`. See linkgit:git-commit[1] for details. Changing the
|
|
|
|
default can be useful when you always want to keep lines that begin
|
|
|
|
with comment character `#` in your log message, in which case you
|
|
|
|
would do `git config commit.cleanup whitespace` (note that you will
|
|
|
|
have to remove the help lines that begin with `#` in the commit log
|
|
|
|
template yourself, if you do this).
|
|
|
|
|
2013-11-05 03:14:41 +04:00
|
|
|
commit.gpgsign::
|
|
|
|
|
|
|
|
A boolean to specify whether all commits should be GPG signed.
|
|
|
|
Use of this option when doing operations such as rebase can
|
|
|
|
result in a large number of commits being signed. It may be
|
|
|
|
convenient to use an agent to avoid typing your GPG passphrase
|
|
|
|
several times.
|
|
|
|
|
2010-01-24 01:13:17 +03:00
|
|
|
commit.status::
|
2009-12-08 01:45:27 +03:00
|
|
|
A boolean to enable/disable inclusion of status information in the
|
|
|
|
commit message template when using an editor to prepare the commit
|
|
|
|
message. Defaults to true.
|
|
|
|
|
2008-11-26 11:26:50 +03:00
|
|
|
commit.template::
|
|
|
|
Specify a file to use as the template for new commit messages.
|
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 12:51:57 +04:00
|
|
|
"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
|
2009-11-19 18:21:15 +03:00
|
|
|
specified user's home directory.
|
2008-11-26 11:26:50 +03:00
|
|
|
|
2011-12-10 14:31:38 +04:00
|
|
|
credential.helper::
|
|
|
|
Specify an external helper to be called when a username or
|
|
|
|
password credential is needed; the helper may consult external
|
|
|
|
storage to avoid prompting the user for the credentials. See
|
|
|
|
linkgit:gitcredentials[7] for details.
|
|
|
|
|
|
|
|
credential.useHttpPath::
|
|
|
|
When acquiring credentials, consider the "path" component of an http
|
|
|
|
or https URL to be important. Defaults to false. See
|
|
|
|
linkgit:gitcredentials[7] for more information.
|
|
|
|
|
|
|
|
credential.username::
|
|
|
|
If no username is set for a network authentication, use this username
|
|
|
|
by default. See credential.<context>.* below, and
|
|
|
|
linkgit:gitcredentials[7].
|
|
|
|
|
|
|
|
credential.<url>.*::
|
|
|
|
Any of the credential.* options above can be applied selectively to
|
|
|
|
some credentials. For example "credential.https://example.com.username"
|
|
|
|
would set the default username only for https connections to
|
|
|
|
example.com. See linkgit:gitcredentials[7] for details on how URLs are
|
|
|
|
matched.
|
|
|
|
|
2011-04-06 22:46:49 +04:00
|
|
|
include::diff-config.txt[]
|
2009-04-07 12:21:20 +04:00
|
|
|
|
|
|
|
difftool.<tool>.path::
|
|
|
|
Override the path for the given tool. This is useful in case
|
|
|
|
your tool is not in the PATH.
|
|
|
|
|
|
|
|
difftool.<tool>.cmd::
|
|
|
|
Specify the command to invoke the specified diff tool.
|
|
|
|
The specified command is evaluated in shell with the following
|
|
|
|
variables available: 'LOCAL' is set to the name of the temporary
|
|
|
|
file containing the contents of the diff pre-image and 'REMOTE'
|
|
|
|
is set to the name of the temporary file containing the contents
|
|
|
|
of the diff post-image.
|
|
|
|
|
2009-04-07 12:21:22 +04:00
|
|
|
difftool.prompt::
|
|
|
|
Prompt before each invocation of the diff tool.
|
|
|
|
|
2010-11-11 02:55:02 +03:00
|
|
|
fetch.recurseSubmodules::
|
2011-03-07 01:11:48 +03:00
|
|
|
This option can be either set to a boolean value or to 'on-demand'.
|
|
|
|
Setting it to a boolean changes the behavior of fetch and pull to
|
|
|
|
unconditionally recurse into submodules when set to true or to not
|
|
|
|
recurse at all when set to false. When set to 'on-demand' (the default
|
|
|
|
value), fetch and pull will only recurse into a populated submodule
|
|
|
|
when its superproject retrieves a commit that updates the submodule's
|
|
|
|
reference.
|
2010-11-11 02:55:02 +03:00
|
|
|
|
2011-09-04 23:26:14 +04:00
|
|
|
fetch.fsckObjects::
|
|
|
|
If it is set to true, git-fetch-pack will check all fetched
|
|
|
|
objects. It will abort in the case of a malformed object or a
|
|
|
|
broken link. The result of an abort are only dangling objects.
|
2011-09-04 23:37:45 +04:00
|
|
|
Defaults to false. If not set, the value of `transfer.fsckObjects`
|
|
|
|
is used instead.
|
2011-09-04 23:26:14 +04:00
|
|
|
|
2007-01-25 03:47:24 +03:00
|
|
|
fetch.unpackLimit::
|
2013-01-21 23:17:53 +04:00
|
|
|
If the number of objects fetched over the Git native
|
2007-01-25 03:47:24 +03:00
|
|
|
transfer is below this
|
|
|
|
limit, then the objects will be unpacked into loose object
|
|
|
|
files. However if the number of received objects equals or
|
|
|
|
exceeds this limit then the received pack will be stored as
|
|
|
|
a pack, after adding any missing delta bases. Storing the
|
|
|
|
pack from a push can make the push operation complete faster,
|
2008-01-12 00:11:13 +03:00
|
|
|
especially on slow filesystems. If not set, the value of
|
|
|
|
`transfer.unpackLimit` is used instead.
|
2007-01-25 03:47:24 +03:00
|
|
|
|
2013-07-13 13:36:24 +04:00
|
|
|
fetch.prune::
|
|
|
|
If true, fetch will automatically behave as if the `--prune`
|
|
|
|
option was given on the command line. See also `remote.<name>.prune`.
|
|
|
|
|
2009-04-23 13:37:56 +04:00
|
|
|
format.attach::
|
|
|
|
Enable multipart/mixed attachments as the default for
|
|
|
|
'format-patch'. The value can also be a double quoted string
|
|
|
|
which will enable attachments as the default and set the
|
|
|
|
value as the boundary. See the --attach option in
|
|
|
|
linkgit:git-format-patch[1].
|
|
|
|
|
2007-11-04 06:38:24 +03:00
|
|
|
format.numbered::
|
2008-10-03 00:55:39 +04:00
|
|
|
A boolean which can enable or disable sequence numbers in patch
|
|
|
|
subjects. It defaults to "auto" which enables it only if there
|
|
|
|
is more than one patch. It can be enabled or disabled for all
|
|
|
|
messages by setting it to "true" or "false". See --numbered
|
|
|
|
option in linkgit:git-format-patch[1].
|
2007-11-04 06:38:24 +03:00
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
format.headers::
|
|
|
|
Additional email headers to include in a patch to be submitted
|
2007-12-29 09:20:38 +03:00
|
|
|
by mail. See linkgit:git-format-patch[1].
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2010-07-12 22:58:38 +04:00
|
|
|
format.to::
|
2009-04-23 13:37:56 +04:00
|
|
|
format.cc::
|
2010-07-12 22:58:38 +04:00
|
|
|
Additional recipients to include in a patch to be submitted
|
|
|
|
by mail. See the --to and --cc options in
|
|
|
|
linkgit:git-format-patch[1].
|
2009-04-23 13:37:56 +04:00
|
|
|
|
|
|
|
format.subjectprefix::
|
|
|
|
The default for format-patch is to output files with the '[PATCH]'
|
|
|
|
subject prefix. Use this variable to change that prefix.
|
|
|
|
|
2010-06-16 09:59:25 +04:00
|
|
|
format.signature::
|
|
|
|
The default for format-patch is to output a signature containing
|
2013-01-21 23:17:53 +04:00
|
|
|
the Git version number. Use this variable to change that default.
|
2010-06-16 09:59:25 +04:00
|
|
|
Set this variable to the empty string ("") to suppress
|
|
|
|
signature generation.
|
|
|
|
|
2007-03-04 02:17:23 +03:00
|
|
|
format.suffix::
|
|
|
|
The default for format-patch is to output files with the suffix
|
|
|
|
`.patch`. Use this variable to change that suffix (make sure to
|
|
|
|
include the dot if you want it).
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2008-03-02 12:05:53 +03:00
|
|
|
format.pretty::
|
|
|
|
The default pretty format for log/show/whatchanged command,
|
|
|
|
See linkgit:git-log[1], linkgit:git-show[1],
|
|
|
|
linkgit:git-whatchanged[1].
|
|
|
|
|
2009-02-20 00:26:33 +03:00
|
|
|
format.thread::
|
2010-01-10 02:33:00 +03:00
|
|
|
The default threading style for 'git format-patch'. Can be
|
2010-01-10 06:01:21 +03:00
|
|
|
a boolean value, or `shallow` or `deep`. `shallow` threading
|
|
|
|
makes every mail a reply to the head of the series,
|
2009-02-20 00:26:33 +03:00
|
|
|
where the head is chosen from the cover letter, 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 12:51:57 +04:00
|
|
|
`--in-reply-to`, and the first patch mail, in this order.
|
2009-04-23 13:37:57 +04:00
|
|
|
`deep` threading makes every mail a reply to the previous one.
|
2009-02-20 00:26:33 +03:00
|
|
|
A true boolean value is the same as `shallow`, and a false
|
|
|
|
value disables threading.
|
|
|
|
|
2009-04-01 21:51:54 +04:00
|
|
|
format.signoff::
|
2013-04-28 02:00:07 +04:00
|
|
|
A boolean value which lets you enable the `-s/--signoff` option of
|
|
|
|
format-patch by default. *Note:* Adding the Signed-off-by: line to a
|
|
|
|
patch should be a conscious act and means that you certify you have
|
|
|
|
the rights to submit this work under the same open source license.
|
|
|
|
Please see the 'SubmittingPatches' document for further discussion.
|
2009-04-01 21:51:54 +04:00
|
|
|
|
2013-04-07 21:46:23 +04:00
|
|
|
format.coverLetter::
|
|
|
|
A boolean that controls whether to generate a cover-letter when
|
|
|
|
format-patch is invoked, but in addition can be set to "auto", to
|
|
|
|
generate a cover-letter only when there's more than one patch.
|
|
|
|
|
2011-04-06 22:46:48 +04: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.
|
|
|
|
|
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 17:35:03 +04:00
|
|
|
gc.aggressiveDepth::
|
|
|
|
The depth parameter used in the delta compression
|
|
|
|
algorithm used by 'git gc --aggressive'. This defaults
|
|
|
|
to 250.
|
|
|
|
|
2007-05-09 23:48:39 +04:00
|
|
|
gc.aggressiveWindow::
|
|
|
|
The window size parameter used in the delta compression
|
2010-01-10 02:33:00 +03:00
|
|
|
algorithm used by 'git gc --aggressive'. This defaults
|
2010-04-13 20:52:55 +04:00
|
|
|
to 250.
|
2007-05-09 23:48:39 +04:00
|
|
|
|
2007-09-17 11:39:52 +04: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-12 00:11:13 +03:00
|
|
|
light-weight garbage collection from time to time. The
|
|
|
|
default value is 6700. Setting this to 0 disables it.
|
2007-09-17 11:39:52 +04:00
|
|
|
|
2007-09-17 11:55:13 +04:00
|
|
|
gc.autopacklimit::
|
|
|
|
When there are more than this many packs that are not
|
|
|
|
marked with `*.keep` file in the repository, `git gc
|
2008-01-12 00:11:13 +03:00
|
|
|
--auto` consolidates them into one larger pack. The
|
2008-03-23 10:04:48 +03:00
|
|
|
default value is 50. Setting this to 0 disables it.
|
2007-09-17 11:55:13 +04:00
|
|
|
|
2014-02-08 11:08:52 +04:00
|
|
|
gc.autodetach::
|
|
|
|
Make `git gc --auto` return immediately andrun in background
|
|
|
|
if the system supports it. Default is true.
|
|
|
|
|
2007-02-13 16:01:42 +03:00
|
|
|
gc.packrefs::
|
2010-01-10 05:59:41 +03: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 10:16:49 +03:00
|
|
|
'git gc' runs `git pack-refs`. This can be set to `notbare`
|
2010-01-10 05:59:41 +03: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 16:01:42 +03:00
|
|
|
|
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 23:55:47 +03:00
|
|
|
gc.pruneexpire::
|
2010-01-10 02:33:00 +03:00
|
|
|
When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
|
2008-12-30 22:45:11 +03:00
|
|
|
Override the grace period with this config variable. The value
|
|
|
|
"now" may be used to disable this grace period and always prune
|
|
|
|
unreachable objects immediately.
|
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 23:55:47 +03:00
|
|
|
|
2006-12-27 12:47:57 +03:00
|
|
|
gc.reflogexpire::
|
2010-04-15 00:12:34 +04:00
|
|
|
gc.<pattern>.reflogexpire::
|
2010-01-10 02:33:00 +03:00
|
|
|
'git reflog expire' removes reflog entries older than
|
2010-04-15 00:12:34 +04:00
|
|
|
this time; defaults to 90 days. With "<pattern>" (e.g.
|
|
|
|
"refs/stash") in the middle the setting applies only to
|
|
|
|
the refs that match the <pattern>.
|
2006-12-27 12:47:57 +03:00
|
|
|
|
|
|
|
gc.reflogexpireunreachable::
|
2010-04-15 00:12:34 +04:00
|
|
|
gc.<ref>.reflogexpireunreachable::
|
2010-01-10 02:33:00 +03:00
|
|
|
'git reflog expire' removes reflog entries older than
|
2006-12-27 12:47:57 +03:00
|
|
|
this time and are not reachable from the current tip;
|
2010-04-15 00:12:34 +04:00
|
|
|
defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
|
|
|
|
in the middle, the setting applies only to the refs that
|
|
|
|
match the <pattern>.
|
2006-12-27 12:47:57 +03:00
|
|
|
|
2006-12-27 12:24:05 +03:00
|
|
|
gc.rerereresolved::
|
|
|
|
Records of conflicted merge you resolved earlier are
|
2010-01-10 02:33:00 +03:00
|
|
|
kept for this many days when 'git rerere gc' is run.
|
2007-12-29 09:20:38 +03:00
|
|
|
The default is 60 days. See linkgit:git-rerere[1].
|
2006-12-27 12:24:05 +03:00
|
|
|
|
|
|
|
gc.rerereunresolved::
|
|
|
|
Records of conflicted merge you have not resolved are
|
2010-01-10 02:33:00 +03:00
|
|
|
kept for this many days when 'git rerere gc' is run.
|
2007-12-29 09:20:38 +03:00
|
|
|
The default is 15 days. See linkgit:git-rerere[1].
|
2006-12-27 12:24:05 +03:00
|
|
|
|
2009-01-02 18:40:13 +03:00
|
|
|
gitcvs.commitmsgannotation::
|
|
|
|
Append this string to each commit message. Set to empty string
|
|
|
|
to disable this feature. Defaults to "via git-CVS emulator".
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
gitcvs.enabled::
|
2007-08-24 04:40:08 +04:00
|
|
|
Whether the CVS server interface is enabled for this repository.
|
2007-12-29 09:20:38 +03:00
|
|
|
See linkgit:git-cvsserver[1].
|
2006-04-25 02:59:33 +04:00
|
|
|
|
|
|
|
gitcvs.logfile::
|
2007-08-24 04:40:08 +04:00
|
|
|
Path to a log file where the CVS server interface well... logs
|
2007-12-29 09:20:38 +03:00
|
|
|
various stuff. See linkgit:git-cvsserver[1].
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2008-08-29 11:29:42 +04:00
|
|
|
gitcvs.usecrlfattr::
|
2010-05-20 00:43:11 +04:00
|
|
|
If true, the server will look up the end-of-line conversion
|
|
|
|
attributes for files to determine the '-k' modes to use. If
|
2013-01-21 23:17:53 +04:00
|
|
|
the attributes force Git to treat a file as text,
|
2010-07-20 01:17:17 +04:00
|
|
|
the '-k' mode will be left blank so CVS clients will
|
2010-05-20 00:43:11 +04:00
|
|
|
treat it as text. If they suppress text conversion, the file
|
2008-08-05 20:12:05 +04:00
|
|
|
will be set with '-kb' mode, which suppresses any newline munging
|
2010-05-20 00:43:11 +04:00
|
|
|
the client might otherwise do. If the attributes do not allow
|
|
|
|
the file type to be determined, then 'gitcvs.allbinary' is
|
|
|
|
used. See linkgit:gitattributes[5].
|
2008-05-15 08:35:47 +04:00
|
|
|
|
2007-04-13 20:02:30 +04:00
|
|
|
gitcvs.allbinary::
|
2008-05-15 08:35:48 +04:00
|
|
|
This is used if 'gitcvs.usecrlfattr' does not resolve
|
|
|
|
the correct '-kb' mode to use. If true, all
|
|
|
|
unresolved files are sent to the client in
|
|
|
|
mode '-kb'. This causes the client to treat them
|
|
|
|
as binary files, which suppresses any newline munging it
|
|
|
|
otherwise might do. Alternatively, if it is set to "guess",
|
|
|
|
then the contents of the file are examined to decide if
|
|
|
|
it is binary, similar to 'core.autocrlf'.
|
2007-04-18 09:17:46 +04:00
|
|
|
|
2007-04-13 20:13:42 +04:00
|
|
|
gitcvs.dbname::
|
|
|
|
Database used by git-cvsserver to cache revision information
|
2013-01-21 23:17:53 +04:00
|
|
|
derived from the Git repository. The exact meaning depends on the
|
2007-04-13 20:13:42 +04:00
|
|
|
used database driver, for SQLite (which is the default driver) this
|
|
|
|
is a filename. Supports variable substitution (see
|
2007-12-29 09:20:38 +03:00
|
|
|
linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
|
2007-04-13 20:13:42 +04:00
|
|
|
Default: '%Ggitcvs.%m.sqlite'
|
|
|
|
|
|
|
|
gitcvs.dbdriver::
|
|
|
|
Used Perl DBI driver. You can specify any available driver
|
2013-04-28 02:00:07 +04:00
|
|
|
for this here, but it might not work. git-cvsserver is tested
|
2007-04-13 20:13:42 +04:00
|
|
|
with 'DBD::SQLite', reported to work with 'DBD::Pg', and
|
|
|
|
reported *not* to work with 'DBD::mysql'. Experimental feature.
|
|
|
|
May not contain double colons (`:`). Default: 'SQLite'.
|
2007-12-29 09:20:38 +03:00
|
|
|
See linkgit:git-cvsserver[1].
|
2007-04-13 20:02:30 +04:00
|
|
|
|
2007-04-13 20:13:42 +04:00
|
|
|
gitcvs.dbuser, gitcvs.dbpass::
|
|
|
|
Database user and password. Only useful if setting 'gitcvs.dbdriver',
|
|
|
|
since SQLite has no concept of database users and/or passwords.
|
|
|
|
'gitcvs.dbuser' supports variable substitution (see
|
2007-12-29 09:20:38 +03:00
|
|
|
linkgit:git-cvsserver[1] for details).
|
2007-04-13 20:13:42 +04:00
|
|
|
|
2008-03-28 00:02:14 +03:00
|
|
|
gitcvs.dbTableNamePrefix::
|
|
|
|
Database table name prefix. Prepended to the names of any
|
|
|
|
database tables used, allowing a single database to be used
|
|
|
|
for several repositories. Supports variable substitution (see
|
|
|
|
linkgit:git-cvsserver[1] for details). Any non-alphabetic
|
|
|
|
characters will be replaced with underscores.
|
|
|
|
|
2008-05-15 08:35:47 +04:00
|
|
|
All gitcvs variables except for 'gitcvs.usecrlfattr' and
|
|
|
|
'gitcvs.allbinary' can also be specified as
|
|
|
|
'gitcvs.<access_method>.<varname>' (where 'access_method'
|
2007-08-24 04:44:13 +04:00
|
|
|
is one of "ext" and "pserver") to make them apply only for the given
|
|
|
|
access method.
|
2007-04-13 20:13:42 +04:00
|
|
|
|
2011-10-16 15:07:34 +04: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::
|
|
|
|
gitweb.showsizes::
|
|
|
|
gitweb.snapshot::
|
|
|
|
See linkgit:gitweb.conf[5] for description.
|
|
|
|
|
2011-03-30 23:31:05 +04:00
|
|
|
grep.lineNumber::
|
|
|
|
If set to true, enable '-n' 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 18:53:50 +04:00
|
|
|
grep.patternType::
|
|
|
|
Set the default matching behavior. Using a value of 'basic', 'extended',
|
|
|
|
'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
|
|
|
|
'--fixed-strings', or '--perl-regexp' option accordingly, while the
|
|
|
|
value 'default' will return to the default matching behavior.
|
|
|
|
|
2011-03-30 23:31:05 +04:00
|
|
|
grep.extendedRegexp::
|
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 18:53:50 +04:00
|
|
|
If set to true, enable '--extended-regexp' option by default. This
|
|
|
|
option is ignored when the 'grep.patternType' option is set to a value
|
|
|
|
other than 'default'.
|
2011-03-30 23:31:05 +04:00
|
|
|
|
2011-11-30 00:29:48 +04:00
|
|
|
gpg.program::
|
|
|
|
Use this custom program instead of "gpg" found on $PATH when
|
|
|
|
making or verifying a PGP signature. The program must support the
|
|
|
|
same command line interface as GPG, namely, to verify a detached
|
|
|
|
signature, "gpg --verify $file - <$signature" is run, and the
|
|
|
|
program is expected to signal a good signature by exiting with
|
|
|
|
code 0, and to generate an ascii-armored detached signature, the
|
|
|
|
standard input of "gpg -bsau $key" is fed with the contents to be
|
|
|
|
signed, and the program is expected to send the result to its
|
|
|
|
standard output.
|
|
|
|
|
2008-05-08 12:55:02 +04:00
|
|
|
gui.commitmsgwidth::
|
|
|
|
Defines how wide the commit message window is in the
|
|
|
|
linkgit:git-gui[1]. "75" is the default.
|
|
|
|
|
|
|
|
gui.diffcontext::
|
|
|
|
Specifies how many context lines should be used in calls to diff
|
|
|
|
made by the linkgit:git-gui[1]. The default is "5".
|
|
|
|
|
2014-04-20 01:47:14 +04:00
|
|
|
gui.displayuntracked::
|
|
|
|
Determines if linkgit::git-gui[1] shows untracked files
|
|
|
|
in the file list. The default is "true".
|
|
|
|
|
2008-11-13 20:28:49 +03:00
|
|
|
gui.encoding::
|
|
|
|
Specifies the default encoding to use for displaying of
|
|
|
|
file contents in linkgit:git-gui[1] and linkgit:gitk[1].
|
|
|
|
It can be overridden by setting the 'encoding' attribute
|
|
|
|
for relevant files (see linkgit:gitattributes[5]).
|
|
|
|
If this option is not set, the tools default to the
|
|
|
|
locale encoding.
|
|
|
|
|
2008-05-08 12:55:02 +04:00
|
|
|
gui.matchtrackingbranch::
|
|
|
|
Determines if new branches created with linkgit:git-gui[1] should
|
|
|
|
default to tracking remote branches with matching names or
|
|
|
|
not. Default: "false".
|
|
|
|
|
|
|
|
gui.newbranchtemplate::
|
|
|
|
Is used as suggested name when creating new branches using the
|
|
|
|
linkgit:git-gui[1].
|
|
|
|
|
|
|
|
gui.pruneduringfetch::
|
2010-11-02 18:31:23 +03:00
|
|
|
"true" if linkgit:git-gui[1] should prune remote-tracking branches when
|
2008-05-08 12:55:02 +04:00
|
|
|
performing a fetch. The default value is "false".
|
|
|
|
|
|
|
|
gui.trustmtime::
|
|
|
|
Determines if linkgit:git-gui[1] should trust the file modification
|
|
|
|
timestamp or not. By default the timestamps are not trusted.
|
|
|
|
|
|
|
|
gui.spellingdictionary::
|
|
|
|
Specifies the dictionary used for spell checking commit messages in
|
|
|
|
the linkgit:git-gui[1]. When set to "none" spell checking is turned
|
|
|
|
off.
|
|
|
|
|
2008-11-13 20:28:49 +03:00
|
|
|
gui.fastcopyblame::
|
2010-01-07 19:49:12 +03:00
|
|
|
If true, 'git gui blame' uses `-C` instead of `-C -C` for original
|
2008-11-13 20:28:49 +03:00
|
|
|
location detection. It makes blame significantly faster on huge
|
|
|
|
repositories at the expense of less thorough copy detection.
|
|
|
|
|
|
|
|
gui.copyblamethreshold::
|
2008-11-27 10:32:01 +03:00
|
|
|
Specifies the threshold to use in 'git gui blame' original location
|
2008-11-13 20:28:49 +03:00
|
|
|
detection, measured in alphanumeric characters. See the
|
|
|
|
linkgit:git-blame[1] manual for more information on copy detection.
|
|
|
|
|
|
|
|
gui.blamehistoryctx::
|
|
|
|
Specifies the radius of history context in days to show in
|
|
|
|
linkgit:gitk[1] for the selected commit, when the `Show History
|
|
|
|
Context` menu item is invoked from 'git gui blame'. If this
|
|
|
|
variable is set to zero, the whole history is shown.
|
|
|
|
|
2008-12-14 22:44:32 +03: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
|
|
|
|
the tool as 'GIT_GUITOOL', the name of the currently selected file as
|
|
|
|
'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
|
|
|
|
the head is detached, 'CUR_BRANCH' is empty).
|
|
|
|
|
|
|
|
guitool.<name>.needsfile::
|
|
|
|
Run the tool only if a diff is selected in the GUI. It guarantees
|
|
|
|
that 'FILENAME' is not empty.
|
|
|
|
|
|
|
|
guitool.<name>.noconsole::
|
|
|
|
Run the command silently, without creating a window to display its
|
|
|
|
output.
|
|
|
|
|
|
|
|
guitool.<name>.norescan::
|
|
|
|
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.
|
|
|
|
|
|
|
|
guitool.<name>.argprompt::
|
|
|
|
Request a string argument from the user, and pass it to the tool
|
|
|
|
through the 'ARGS' environment variable. Since requesting an
|
|
|
|
argument implies confirmation, the 'confirm' option has no effect
|
|
|
|
if this is enabled. If the option is set to 'true', 'yes', or '1',
|
|
|
|
the dialog uses a built-in generic prompt; otherwise the exact
|
|
|
|
value of the variable is used.
|
|
|
|
|
|
|
|
guitool.<name>.revprompt::
|
|
|
|
Request a single valid revision from the user, and set the
|
|
|
|
'REVISION' environment variable. In other aspects this option
|
|
|
|
is similar to 'argprompt', and can be used together with it.
|
|
|
|
|
|
|
|
guitool.<name>.revunmerged::
|
|
|
|
Show only unmerged branches in the 'revprompt' subdialog.
|
|
|
|
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
|
|
|
|
the dialog, before subsections for 'argprompt' and 'revprompt'.
|
|
|
|
The default value includes the actual command.
|
|
|
|
|
2008-01-08 06:55:14 +03: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.
|
|
|
|
|
2008-08-31 17:54:58 +04:00
|
|
|
help.autocorrect::
|
|
|
|
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.
|
|
|
|
|
2013-01-16 00:56:21 +04:00
|
|
|
help.htmlpath::
|
|
|
|
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 03:07:00 +03:00
|
|
|
http.proxy::
|
2012-03-04 20:50:43 +04:00
|
|
|
Override the HTTP proxy, normally configured using the 'http_proxy',
|
|
|
|
'https_proxy', and 'all_proxy' environment variables (see
|
|
|
|
`curl(1)`). This can be overridden on a per-remote basis; see
|
|
|
|
remote.<name>.proxy
|
2007-11-23 03:07:00 +03:00
|
|
|
|
2011-06-03 00:31:25 +04:00
|
|
|
http.cookiefile::
|
|
|
|
File containing previously stored cookie lines which should be used
|
2013-01-21 23:17:53 +04:00
|
|
|
in the Git http session, if they match the server. The file format
|
2011-06-03 00:31:25 +04:00
|
|
|
of the file to read cookies from should be plain HTTP headers or
|
|
|
|
the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
|
|
|
|
NOTE that the file specified with http.cookiefile is only used as
|
2013-07-24 02:40:17 +04:00
|
|
|
input unless http.saveCookies is set.
|
|
|
|
|
|
|
|
http.savecookies::
|
|
|
|
If set, store cookies received during requests to the file specified by
|
|
|
|
http.cookiefile. Has no effect if http.cookiefile is unset.
|
2011-06-03 00:31:25 +04:00
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
http.sslVerify::
|
|
|
|
Whether to verify the SSL certificate when fetching or pushing
|
2006-06-07 16:56:45 +04:00
|
|
|
over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
|
2006-04-25 02:59:33 +04:00
|
|
|
variable.
|
|
|
|
|
|
|
|
http.sslCert::
|
|
|
|
File containing the SSL certificate when fetching or pushing
|
2006-06-07 16:56:45 +04:00
|
|
|
over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
|
2006-04-25 02:59:33 +04:00
|
|
|
variable.
|
|
|
|
|
|
|
|
http.sslKey::
|
|
|
|
File containing the SSL private key when fetching or pushing
|
2006-06-04 00:27:26 +04:00
|
|
|
over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
|
2006-04-25 02:59:33 +04:00
|
|
|
variable.
|
|
|
|
|
2009-05-28 07:16:03 +04:00
|
|
|
http.sslCertPasswordProtected::
|
2013-01-21 23:17:53 +04:00
|
|
|
Enable Git's password prompt for the SSL certificate. Otherwise
|
2009-05-28 07:16:03 +04:00
|
|
|
OpenSSL will prompt the user, possibly many times, if the
|
|
|
|
certificate or private key is encrypted. Can be overridden by the
|
|
|
|
'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
http.sslCAInfo::
|
|
|
|
File containing the certificates to verify the peer with when
|
2006-06-04 00:27:26 +04:00
|
|
|
fetching or pushing over HTTPS. Can be overridden by the
|
2006-04-25 02:59:33 +04:00
|
|
|
'GIT_SSL_CAINFO' environment variable.
|
|
|
|
|
|
|
|
http.sslCAPath::
|
|
|
|
Path containing files with the CA certificates to verify the peer
|
2006-06-07 16:56:45 +04:00
|
|
|
with when fetching or pushing over HTTPS. Can be overridden
|
2006-04-25 02:59:33 +04:00
|
|
|
by the 'GIT_SSL_CAPATH' environment variable.
|
|
|
|
|
2013-04-07 23:10:39 +04: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 02:59:33 +04:00
|
|
|
http.maxRequests::
|
2006-06-04 00:27:26 +04:00
|
|
|
How many HTTP requests to launch in parallel. Can be overridden
|
2006-04-25 02:59:33 +04:00
|
|
|
by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
|
|
|
|
|
2009-11-27 18:42:26 +03: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 03:47:41 +03: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 02:59:33 +04: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.
|
2006-06-04 00:27:26 +04:00
|
|
|
Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
|
2006-04-25 02:59:33 +04:00
|
|
|
'GIT_HTTP_LOW_SPEED_TIME' environment variables.
|
|
|
|
|
2006-09-29 04:10:44 +04:00
|
|
|
http.noEPSV::
|
|
|
|
A boolean which disables using of EPSV ftp command by curl.
|
2007-04-13 20:02:33 +04:00
|
|
|
This can helpful with some "poor" ftp servers which don't
|
2006-09-29 04:10:44 +04:00
|
|
|
support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
|
|
|
|
environment variable. Default is false (curl will use EPSV).
|
|
|
|
|
2010-08-12 00:40:38 +04:00
|
|
|
http.useragent::
|
|
|
|
The HTTP USER_AGENT string presented to an HTTP server. The default
|
2013-01-21 23:17:53 +04:00
|
|
|
value represents the version of the client Git such as git/1.7.1.
|
2010-08-12 00:40:38 +04: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).
|
|
|
|
Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
|
|
|
|
|
2013-08-06 00:20:36 +04:00
|
|
|
http.<url>.*::
|
|
|
|
Any of the http.* options above can be applied selectively to some urls.
|
|
|
|
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/`).
|
|
|
|
This field must match exactly between the config key and the URL.
|
|
|
|
|
|
|
|
. 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
|
|
|
|
equivalent urls that are simply spelled differently will match properly.
|
|
|
|
Environment variable settings always override any matches. The urls that are
|
|
|
|
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.
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
i18n.commitEncoding::
|
2013-01-21 23:17:53 +04:00
|
|
|
Character encoding the commit messages are stored in; Git itself
|
2006-04-25 02:59:33 +04: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 09:20:38 +03:00
|
|
|
porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2006-12-28 03:41:33 +03:00
|
|
|
i18n.logOutputEncoding::
|
|
|
|
Character encoding the commit messages are converted to when
|
2010-01-10 02:33:00 +03:00
|
|
|
running 'git log' and friends.
|
2006-12-28 03:41:33 +03:00
|
|
|
|
2008-11-26 11:26:50 +03:00
|
|
|
imap::
|
|
|
|
The configuration variables in the 'imap' section are described
|
|
|
|
in linkgit:git-imap-send[1].
|
|
|
|
|
2014-02-24 00:49:59 +04:00
|
|
|
index.version::
|
|
|
|
Specify the version with which new index files should be
|
|
|
|
initialized. This does not affect existing repositories.
|
|
|
|
|
2010-02-17 02:44:46 +03:00
|
|
|
init.templatedir::
|
|
|
|
Specify the directory from which templates will be copied.
|
|
|
|
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
|
|
|
|
|
2008-01-08 06:55:14 +03: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).
|
|
|
|
|
|
|
|
instaweb.modulepath::
|
2010-07-20 01:17:17 +04: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 06:55:14 +03:00
|
|
|
|
|
|
|
instaweb.port::
|
|
|
|
The port number to bind the gitweb httpd to. See
|
|
|
|
linkgit:git-instaweb[1].
|
|
|
|
|
2009-02-05 11:28:26 +03:00
|
|
|
interactive.singlekey::
|
2009-08-07 18:24:21 +04:00
|
|
|
In interactive commands, allow the user to provide one-letter
|
2009-02-05 11:28:26 +03: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 12:51:57 +04:00
|
|
|
Currently this is used by the `--patch` mode of
|
2011-05-07 21:59:04 +04: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-04 01:15:50 +04:00
|
|
|
is not available; requires the Perl module Term::ReadKey.
|
2009-02-05 11:28:26 +03:00
|
|
|
|
2011-05-18 21:56:04 +04: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 12:51:57 +04:00
|
|
|
linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
|
|
|
|
override this option with `--no-abbrev-commit`.
|
2011-05-18 21:56:04 +04:00
|
|
|
|
2008-05-22 19:24:07 +04:00
|
|
|
log.date::
|
2010-08-20 14:20:36 +04:00
|
|
|
Set the default date-time mode for the 'log' command.
|
|
|
|
Setting a value for log.date is similar to using 'git log''s
|
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 12:51:57 +04:00
|
|
|
`--date` option. Possible values are `relative`, `local`,
|
2010-08-20 14:20:36 +04:00
|
|
|
`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
|
|
|
|
for details.
|
2008-05-22 19:24:07 +04:00
|
|
|
|
2010-02-17 02:39:52 +03: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.
|
|
|
|
This is the same as the log commands '--decorate' option.
|
|
|
|
|
2006-11-23 12:36:33 +03:00
|
|
|
log.showroot::
|
|
|
|
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 09:20:38 +03:00
|
|
|
Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
|
2006-11-23 12:36:33 +03:00
|
|
|
normally hide the root commit will now show it. True by default.
|
|
|
|
|
2013-01-06 01:26:46 +04:00
|
|
|
log.mailmap::
|
|
|
|
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
|
|
|
linkgit:git-whatchanged[1] assume `--use-mailmap`.
|
|
|
|
|
2009-02-08 17:34:27 +03: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 15:04:04 +04: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 17:04:47 +04: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 15:04:04 +04:00
|
|
|
|
2008-03-07 10:46:55 +03:00
|
|
|
man.viewer::
|
2008-03-13 08:48:46 +03:00
|
|
|
Specify the programs that may be used to display help in the
|
2008-03-07 10:46:55 +03:00
|
|
|
'man' format. See linkgit:git-help[1].
|
|
|
|
|
2008-04-25 10:25:35 +04: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 10:24:41 +04: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 11:26:50 +03:00
|
|
|
include::merge-config.txt[]
|
2008-08-29 21:49:56 +04:00
|
|
|
|
2007-12-17 15:21:22 +03: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 02:31:12 +03: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.
|
|
|
|
|
2008-02-22 02:30:02 +03: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-13 00:48:41 +03:00
|
|
|
mergetool.keepTemporaries::
|
2013-01-21 23:17:53 +04:00
|
|
|
When invoking a custom merge tool, Git uses a set of temporary
|
2008-12-13 00:48:41 +03: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`.
|
|
|
|
|
2008-11-13 15:41:14 +03:00
|
|
|
mergetool.prompt::
|
|
|
|
Prompt before each invocation of the merge resolution program.
|
|
|
|
|
2010-03-12 20:04:26 +03: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 20:04:32 +03:00
|
|
|
notes.rewrite.<command>::
|
|
|
|
When rewriting commits with <command> (currently `amend` or
|
2013-01-21 23:17:53 +04:00
|
|
|
`rebase`) and this variable is set to `true`, Git
|
2010-03-12 20:04:32 +03: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
|
|
|
|
`overwrite`, `concatenate`, or `ignore`. Defaults to
|
|
|
|
`concatenate`.
|
|
|
|
+
|
|
|
|
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 11:32:42 +04:00
|
|
|
enable note rewriting. Set it to `refs/notes/commits` to enable
|
|
|
|
rewriting for the default commit notes.
|
2010-05-05 18:16:25 +04: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 20:04:32 +03:00
|
|
|
|
2006-07-23 09:50:30 +04:00
|
|
|
pack.window::
|
2007-12-29 09:20:38 +03:00
|
|
|
The size of the window used by linkgit:git-pack-objects[1] when no
|
2006-07-23 09:50:30 +04:00
|
|
|
window size is given on the command line. Defaults to 10.
|
|
|
|
|
2007-05-08 17:28:26 +04:00
|
|
|
pack.depth::
|
2007-12-29 09:20:38 +03:00
|
|
|
The maximum delta depth used by linkgit:git-pack-objects[1] when no
|
2007-05-08 17:28:26 +04:00
|
|
|
maximum depth is given on the command line. Defaults to 50.
|
2007-05-08 17:28:26 +04:00
|
|
|
|
2007-07-12 16:55:52 +04:00
|
|
|
pack.windowMemory::
|
2007-12-29 09:20:38 +03:00
|
|
|
The window memory size limit used by linkgit:git-pack-objects[1]
|
2007-07-12 16:55:52 +04:00
|
|
|
when no limit is given on the command line. The value can be
|
|
|
|
suffixed with "k", "m", or "g". Defaults to 0, meaning no
|
|
|
|
limit.
|
|
|
|
|
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-10 00:56:50 +04: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 19:58:51 +03: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 16:21:58 +04: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-10 00:56:50 +04:00
|
|
|
|
2007-05-29 01:20:58 +04:00
|
|
|
pack.deltaCacheSize::
|
2007-08-24 04:44:13 +04:00
|
|
|
The maximum memory in bytes used for caching deltas in
|
2009-08-06 00:55:07 +04: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-29 01:20:58 +04:00
|
|
|
|
2007-05-29 01:20:59 +04:00
|
|
|
pack.deltaCacheLimit::
|
2007-09-10 19:51:34 +04:00
|
|
|
The maximum size of a delta, that is cached in
|
2009-08-06 00:55:07 +04: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
|
|
|
|
result once the best match for all objects is found. Defaults to 1000.
|
2007-05-29 01:20:59 +04:00
|
|
|
|
2007-09-10 19:51:34 +04:00
|
|
|
pack.threads::
|
|
|
|
Specifies the number of threads to spawn when searching for best
|
2007-12-29 09:20:38 +03:00
|
|
|
delta matches. This requires that linkgit:git-pack-objects[1]
|
2007-09-10 19:51:34 +04: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 23:17:53 +04:00
|
|
|
Specifying 0 will cause Git to auto-detect the number of CPU's
|
2008-02-23 05:11:56 +03:00
|
|
|
and set the number of threads accordingly.
|
2007-09-10 19:51:34 +04:00
|
|
|
|
2007-11-02 06:26:04 +03: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 08:25:53 +04: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 23:17:53 +04:00
|
|
|
If you have an old Git that does not understand the version 2 `*.idx` file,
|
2008-06-25 08:25:53 +04:00
|
|
|
cloning or fetching over a non native protocol (e.g. "http" and "rsync")
|
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 12:51:57 +04:00
|
|
|
that will copy both `*.pack` file and corresponding `*.idx` file from the
|
2008-06-25 08:25:53 +04:00
|
|
|
other side may give you a repository that cannot be accessed with your
|
2013-01-21 23:17:53 +04:00
|
|
|
older version of Git. If the `*.pack` file is smaller than 2 GB, however,
|
2008-06-25 08:25:53 +04: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 12:51:57 +04:00
|
|
|
the `*.idx` file.
|
2007-11-02 06:26:04 +03:00
|
|
|
|
2008-03-13 09:11:15 +03:00
|
|
|
pack.packSizeLimit::
|
2010-02-04 06:48:28 +03: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 12:51:57 +04:00
|
|
|
is unaffected. It can be overridden by the `--max-pack-size`
|
2010-02-04 06:48:28 +03:00
|
|
|
option of linkgit:git-repack[1]. The minimum size allowed is
|
|
|
|
limited to 1 MiB. The default is unlimited.
|
|
|
|
Common unit suffixes of 'k', 'm', or 'g' are
|
|
|
|
supported.
|
2008-02-05 17:25:04 +03: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 18:00:09 +04: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.
|
|
|
|
|
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 18:00:16 +04:00
|
|
|
pack.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
|
|
|
|
space and extra time spent on the initial repack. Defaults to
|
|
|
|
false.
|
|
|
|
|
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 18:00:45 +04: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 06:14:33 +04:00
|
|
|
pager.<cmd>::
|
2010-11-17 20:04:12 +03:00
|
|
|
If the value is boolean, turns on or off pagination of the
|
2013-01-21 23:17:53 +04:00
|
|
|
output of a particular Git subcommand when writing to a tty.
|
2010-11-17 20:04:12 +03: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 12:51:57 +04: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 20:04:12 +03:00
|
|
|
precedence over this option. To disable pagination for all
|
|
|
|
commands, set `core.pager` or `GIT_PAGER` to `cat`.
|
2008-08-16 06:14:33 +04:00
|
|
|
|
2010-05-02 15:00:44 +04: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 12:51:57 +04:00
|
|
|
running `git config pretty.changelog "format:* %H %s"`
|
2010-05-02 15:00:44 +04: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 12:51:57 +04:00
|
|
|
to be equivalent to running `git log "--pretty=format:* %H %s"`.
|
2010-05-02 15:00:44 +04:00
|
|
|
Note that an alias with the same name as a built-in format
|
|
|
|
will be silently ignored.
|
|
|
|
|
2014-01-16 03:18:38 +04:00
|
|
|
pull.ff::
|
|
|
|
By default, Git does not create an extra merge commit when merging
|
|
|
|
a commit that is a descendant of the current commit. Instead, the
|
|
|
|
tip of the current branch is fast-forwarded. When set to `false`,
|
|
|
|
this variable tells Git to create an extra merge commit in such
|
|
|
|
a case (equivalent to giving the `--no-ff` option from the command
|
|
|
|
line). When set to `only`, only such fast-forward merges are
|
|
|
|
allowed (equivalent to giving the `--ff-only` option from the
|
|
|
|
command line).
|
|
|
|
|
2011-11-06 13:50:10 +04:00
|
|
|
pull.rebase::
|
|
|
|
When true, rebase branches on top of the fetched branch, instead
|
|
|
|
of merging the default branch from the default remote when "git
|
|
|
|
pull" is run. See "branch.<name>.rebase" for setting this on a
|
|
|
|
per-branch basis.
|
2013-08-13 07:43:42 +04:00
|
|
|
+
|
|
|
|
When preserve, also pass `--preserve-merges` along to 'git rebase'
|
|
|
|
so that locally committed merge commits will not be flattened
|
|
|
|
by running 'git pull'.
|
2011-11-06 13:50:10 +04:00
|
|
|
+
|
|
|
|
*NOTE*: this is a possibly dangerous operation; do *not* use
|
|
|
|
it unless you understand the implications (see linkgit:git-rebase[1]
|
|
|
|
for details).
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
pull.octopus::
|
|
|
|
The default merge strategy to use when pulling multiple branches
|
|
|
|
at once.
|
|
|
|
|
|
|
|
pull.twohead::
|
|
|
|
The default merge strategy to use when pulling a single branch.
|
|
|
|
|
2009-03-16 18:42:51 +03:00
|
|
|
push.default::
|
2013-06-19 15:11:40 +04:00
|
|
|
Defines the action `git push` should take if no refspec is
|
|
|
|
explicitly given. Different values are well-suited for
|
|
|
|
specific workflows; for instance, in a purely central workflow
|
|
|
|
(i.e. the fetch source is equal to the push destination),
|
|
|
|
`upstream` is probably what you want. Possible values are:
|
2009-03-16 18:42:51 +03:00
|
|
|
+
|
2012-06-23 17:18:00 +04:00
|
|
|
--
|
2013-06-19 15:11:40 +04:00
|
|
|
|
|
|
|
* `nothing` - do not push anything (error out) unless a refspec is
|
|
|
|
explicitly given. This is primarily meant for people who want to
|
|
|
|
avoid mistakes by always being explicit.
|
|
|
|
|
|
|
|
* `current` - push the current branch to update a branch with the same
|
|
|
|
name on the receiving end. Works in both central and non-central
|
|
|
|
workflows.
|
|
|
|
|
|
|
|
* `upstream` - push the current branch back to the branch whose
|
|
|
|
changes are usually integrated into the current branch (which is
|
|
|
|
called `@{upstream}`). This mode only makes sense if you are
|
|
|
|
pushing to the same repository you would normally pull from
|
|
|
|
(i.e. central workflow).
|
|
|
|
|
2013-06-19 15:11:41 +04:00
|
|
|
* `simple` - in centralized workflow, work like `upstream` with an
|
|
|
|
added safety to refuse to push if the upstream branch's name is
|
|
|
|
different from the local one.
|
2012-06-23 17:18:00 +04:00
|
|
|
+
|
2013-06-19 15:11:41 +04:00
|
|
|
When pushing to a remote that is different from the remote you normally
|
|
|
|
pull from, work as `current`. This is the safest option and is suited
|
|
|
|
for beginners.
|
2012-06-23 17:18:00 +04:00
|
|
|
+
|
2014-03-08 03:13:15 +04:00
|
|
|
This mode has become the default in Git 2.0.
|
2013-06-19 15:11:40 +04:00
|
|
|
|
|
|
|
* `matching` - push all branches having the same name on both ends.
|
|
|
|
This makes the repository you are pushing to remember the set of
|
|
|
|
branches that will be pushed out (e.g. if you always push 'maint'
|
|
|
|
and 'master' there and no other branches, the repository you push
|
|
|
|
to will have these two branches, and your local 'maint' and
|
|
|
|
'master' will be pushed there).
|
|
|
|
+
|
|
|
|
To use this mode effectively, you have to make sure _all_ the
|
|
|
|
branches you would push out are ready to be pushed out before
|
|
|
|
running 'git push', as the whole point of this mode is to allow you
|
|
|
|
to push all of the branches in one go. If you usually finish work
|
|
|
|
on only one branch and push out the result, while other branches are
|
|
|
|
unfinished, this mode is not for you. Also this mode is not
|
|
|
|
suitable for pushing into a shared central repository, as other
|
|
|
|
people may add new branches there, or update the tip of existing
|
|
|
|
branches outside your control.
|
|
|
|
+
|
2014-03-08 03:13:15 +04:00
|
|
|
This used to be the default, but not since Git 2.0 (`simple` is the
|
|
|
|
new default).
|
2013-06-19 15:11:40 +04:00
|
|
|
|
|
|
|
--
|
2009-03-16 18:42:51 +03:00
|
|
|
|
2009-03-02 01:11:38 +03:00
|
|
|
rebase.stat::
|
|
|
|
Whether to show a diffstat of what changed upstream since the last
|
|
|
|
rebase. False by default.
|
|
|
|
|
2010-07-14 15:59:57 +04:00
|
|
|
rebase.autosquash::
|
|
|
|
If set to true enable '--autosquash' option by default.
|
|
|
|
|
2013-05-12 15:56:41 +04:00
|
|
|
rebase.autostash::
|
|
|
|
When set to true, automatically create a temporary stash
|
|
|
|
before the operation begins, and apply it after the operation
|
|
|
|
ends. This means that you can run rebase on a dirty worktree.
|
|
|
|
However, use with care: the final stash application after a
|
|
|
|
successful rebase might result in non-trivial conflicts.
|
|
|
|
Defaults to false.
|
|
|
|
|
2009-10-21 01:56:40 +04:00
|
|
|
receive.autogc::
|
|
|
|
By default, git-receive-pack will run "git-gc --auto" after
|
|
|
|
receiving data from git-push and updating refs. You can stop
|
|
|
|
it by setting this variable to false.
|
|
|
|
|
2008-11-26 11:26:50 +03:00
|
|
|
receive.fsckObjects::
|
|
|
|
If it is set to true, git-receive-pack will check all received
|
|
|
|
objects. It will abort in the case of a malformed object or a
|
|
|
|
broken link. The result of an abort are only dangling objects.
|
2011-09-04 23:37:45 +04:00
|
|
|
Defaults to false. If not set, the value of `transfer.fsckObjects`
|
|
|
|
is used instead.
|
2008-11-26 11:26:50 +03:00
|
|
|
|
|
|
|
receive.unpackLimit::
|
|
|
|
If the number of objects received in a push is below this
|
|
|
|
limit then the objects will be unpacked into loose object
|
|
|
|
files. However if the number of received objects equals or
|
|
|
|
exceeds this limit then the received pack will be stored as
|
|
|
|
a pack, after adding any missing delta bases. Storing the
|
|
|
|
pack from a push can make the push operation complete faster,
|
|
|
|
especially on slow filesystems. If not set, the value of
|
|
|
|
`transfer.unpackLimit` is used instead.
|
|
|
|
|
2008-11-26 22:11:18 +03:00
|
|
|
receive.denyDeletes::
|
|
|
|
If set to true, git-receive-pack will deny a ref update that deletes
|
|
|
|
the ref. Use this to prevent such a ref deletion via a push.
|
|
|
|
|
2010-07-24 20:07:53 +04:00
|
|
|
receive.denyDeleteCurrent::
|
|
|
|
If set to true, git-receive-pack will deny a ref update that
|
|
|
|
deletes the currently checked out branch of a non-bare repository.
|
|
|
|
|
2008-11-26 22:11:18 +03:00
|
|
|
receive.denyCurrentBranch::
|
2010-05-13 16:51:38 +04:00
|
|
|
If set to true or "refuse", git-receive-pack will deny a ref update
|
2008-11-26 22:11:18 +03:00
|
|
|
to the currently checked out branch of a non-bare repository.
|
|
|
|
Such a push is potentially dangerous because it brings the HEAD
|
|
|
|
out of sync with the index and working tree. If set to "warn",
|
|
|
|
print a warning of such a push to stderr, but allow the push to
|
|
|
|
proceed. If set to false or "ignore", allow such pushes with no
|
2010-03-17 14:14:57 +03:00
|
|
|
message. Defaults to "refuse".
|
2008-11-26 22:11:18 +03:00
|
|
|
|
2008-11-26 11:26:50 +03:00
|
|
|
receive.denyNonFastForwards::
|
|
|
|
If set to true, git-receive-pack will deny a ref update which is
|
2009-10-24 12:31:32 +04:00
|
|
|
not a fast-forward. Use this to prevent such an update via a push,
|
2008-11-26 11:26:50 +03:00
|
|
|
even if that push is forced. This configuration variable is
|
|
|
|
set when initializing a shared 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 04:08:30 +04:00
|
|
|
receive.hiderefs::
|
|
|
|
String(s) `receive-pack` uses to decide which refs to omit
|
|
|
|
from its initial advertisement. Use more than one
|
|
|
|
definitions to specify multiple prefix strings. A ref that
|
|
|
|
are under the hierarchies listed on the value of this
|
|
|
|
variable is excluded, and is hidden when responding to `git
|
|
|
|
push`, and an attempt to update or delete a hidden ref by
|
|
|
|
`git push` is rejected.
|
|
|
|
|
2009-10-21 01:56:40 +04:00
|
|
|
receive.updateserverinfo::
|
|
|
|
If set to true, git-receive-pack will run git-update-server-info
|
|
|
|
after receiving data from git-push and updating refs.
|
|
|
|
|
2013-12-05 17:02:47 +04:00
|
|
|
receive.shallowupdate::
|
|
|
|
If set to true, .git/shallow can be updated when new refs
|
|
|
|
require new shallow roots. Otherwise those refs are rejected.
|
|
|
|
|
2013-04-02 11:40:33 +04:00
|
|
|
remote.pushdefault::
|
|
|
|
The remote to push to by default. Overrides
|
2013-04-02 11:40:34 +04:00
|
|
|
`branch.<name>.remote` for all branches, and is overridden by
|
|
|
|
`branch.<name>.pushremote` for specific branches.
|
2013-04-02 11:40:33 +04:00
|
|
|
|
2006-10-23 20:42:14 +04:00
|
|
|
remote.<name>.url::
|
2007-12-29 09:20:38 +03:00
|
|
|
The URL of a remote repository. See linkgit:git-fetch[1] or
|
|
|
|
linkgit:git-push[1].
|
2006-10-23 20:42:14 +04:00
|
|
|
|
2009-06-09 20:01:34 +04:00
|
|
|
remote.<name>.pushurl::
|
|
|
|
The push URL of a remote repository. See linkgit:git-push[1].
|
|
|
|
|
2007-12-04 00:48:54 +03: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.
|
|
|
|
|
2006-10-23 20:42:14 +04:00
|
|
|
remote.<name>.fetch::
|
2007-12-29 09:20:38 +03:00
|
|
|
The default set of "refspec" for linkgit:git-fetch[1]. See
|
|
|
|
linkgit:git-fetch[1].
|
2006-10-23 20:42:14 +04:00
|
|
|
|
|
|
|
remote.<name>.push::
|
2007-12-29 09:20:38 +03:00
|
|
|
The default set of "refspec" for linkgit:git-push[1]. See
|
|
|
|
linkgit:git-push[1].
|
2006-10-23 20:42:14 +04:00
|
|
|
|
2008-04-17 15:17:20 +04: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 12:51:57 +04:00
|
|
|
as if the `--mirror` option was given on the command line.
|
2008-04-17 15:17:20 +04:00
|
|
|
|
2007-02-20 23:13:43 +03:00
|
|
|
remote.<name>.skipDefaultUpdate::
|
|
|
|
If true, this remote will be skipped by default when updating
|
2009-11-09 23:11:06 +03: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 23:13:43 +03:00
|
|
|
|
2007-01-19 15:46:16 +03:00
|
|
|
remote.<name>.receivepack::
|
2007-01-25 07:45:39 +03:00
|
|
|
The default program to execute on the remote side when pushing. See
|
2008-03-06 23:28:07 +03:00
|
|
|
option \--receive-pack of linkgit:git-push[1].
|
2007-01-19 15:46:16 +03:00
|
|
|
|
2007-01-25 07:45:39 +03:00
|
|
|
remote.<name>.uploadpack::
|
|
|
|
The default program to execute on the remote side when fetching. See
|
2008-03-06 23:28:07 +03:00
|
|
|
option \--upload-pack of linkgit:git-fetch-pack[1].
|
2007-01-25 07:45:39 +03:00
|
|
|
|
2007-02-24 18:32:56 +03:00
|
|
|
remote.<name>.tagopt::
|
2008-03-06 23:28:07 +03:00
|
|
|
Setting this value to \--no-tags disables automatic tag following when
|
2010-04-20 03:31:25 +04:00
|
|
|
fetching from remote <name>. Setting it to \--tags will fetch every
|
|
|
|
tag from remote <name>, even if they are not reachable from remote
|
2010-08-12 02:57:20 +04:00
|
|
|
branch heads. Passing these flags directly to linkgit:git-fetch[1] can
|
|
|
|
override this setting. See options \--tags and \--no-tags of
|
|
|
|
linkgit:git-fetch[1].
|
2007-02-24 18:32:56 +03:00
|
|
|
|
2009-11-18 04:42:25 +03:00
|
|
|
remote.<name>.vcs::
|
2013-01-21 23:17:53 +04:00
|
|
|
Setting this to a value <vcs> will cause Git to interact with
|
2009-11-18 04:42:25 +03:00
|
|
|
the remote with the git-remote-<vcs> helper.
|
|
|
|
|
2013-07-13 13:36:24 +04: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 09:33:00 +04: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 13:36:24 +04:00
|
|
|
Overrides `fetch.prune` settings, if any.
|
|
|
|
|
2007-02-20 23:13:43 +03:00
|
|
|
remotes.<group>::
|
|
|
|
The list of remotes which are fetched by "git remote update
|
2007-12-29 09:20:38 +03:00
|
|
|
<group>". See linkgit:git-remote[1].
|
2007-02-20 23:13:43 +03:00
|
|
|
|
2006-10-14 08:28:58 +04:00
|
|
|
repack.usedeltabaseoffset::
|
2008-06-25 08:24:53 +04: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 23:17:53 +04:00
|
|
|
Git older than version 1.4.4, either directly or via a dumb
|
2008-06-25 08:24:53 +04:00
|
|
|
protocol such as http, then you need to set this option to
|
2013-01-21 23:17:53 +04:00
|
|
|
"false" and repack. Access from old Git versions over the
|
2008-06-25 08:24:53 +04:00
|
|
|
native protocol are unaffected by this option.
|
2006-10-14 08:28:58 +04: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-04 00:04:20 +04: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
|
|
|
|
`pack.writeBitmaps`).
|
|
|
|
|
2008-11-26 11:26:50 +03:00
|
|
|
rerere.autoupdate::
|
|
|
|
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 17:08:02 +04: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 18:57:27 +04:00
|
|
|
`$GIT_DIR`, e.g. if "rerere" was previously used in the
|
|
|
|
repository.
|
2008-11-26 11:26:50 +03:00
|
|
|
|
2009-07-23 01:39:30 +04:00
|
|
|
sendemail.identity::
|
|
|
|
A configuration identity. When given, causes values in the
|
|
|
|
'sendemail.<identity>' subsection to take precedence over
|
|
|
|
values in the 'sendemail' section. The default identity is
|
|
|
|
the value of 'sendemail.identity'.
|
|
|
|
|
|
|
|
sendemail.smtpencryption::
|
|
|
|
See linkgit:git-send-email[1] for description. Note that this
|
|
|
|
setting is not subject to the 'identity' mechanism.
|
|
|
|
|
|
|
|
sendemail.smtpssl::
|
|
|
|
Deprecated alias for 'sendemail.smtpencryption = ssl'.
|
|
|
|
|
2013-07-18 20:53:11 +04:00
|
|
|
sendemail.smtpsslcertpath::
|
|
|
|
Path to ca-certificates (either a directory or a single file).
|
|
|
|
Set it to an empty string to disable certificate verification.
|
|
|
|
|
2009-07-23 01:39:30 +04:00
|
|
|
sendemail.<identity>.*::
|
|
|
|
Identity-specific versions of the 'sendemail.*' parameters
|
|
|
|
found below, taking precedence over those when the this
|
|
|
|
identity is selected, through command-line or
|
|
|
|
'sendemail.identity'.
|
|
|
|
|
|
|
|
sendemail.aliasesfile::
|
|
|
|
sendemail.aliasfiletype::
|
2013-04-07 11:10:27 +04:00
|
|
|
sendemail.annotate::
|
2009-07-23 01:39:30 +04:00
|
|
|
sendemail.bcc::
|
|
|
|
sendemail.cc::
|
|
|
|
sendemail.cccmd::
|
|
|
|
sendemail.chainreplyto::
|
|
|
|
sendemail.confirm::
|
|
|
|
sendemail.envelopesender::
|
|
|
|
sendemail.from::
|
|
|
|
sendemail.multiedit::
|
|
|
|
sendemail.signedoffbycc::
|
|
|
|
sendemail.smtppass::
|
|
|
|
sendemail.suppresscc::
|
|
|
|
sendemail.suppressfrom::
|
|
|
|
sendemail.to::
|
2010-04-10 18:53:56 +04:00
|
|
|
sendemail.smtpdomain::
|
2009-07-23 01:39:30 +04:00
|
|
|
sendemail.smtpserver::
|
|
|
|
sendemail.smtpserverport::
|
2010-09-06 22:12:11 +04:00
|
|
|
sendemail.smtpserveroption::
|
2009-07-23 01:39:30 +04:00
|
|
|
sendemail.smtpuser::
|
|
|
|
sendemail.thread::
|
|
|
|
sendemail.validate::
|
|
|
|
See linkgit:git-send-email[1] for description.
|
|
|
|
|
|
|
|
sendemail.signedoffcc::
|
|
|
|
Deprecated alias for 'sendemail.signedoffbycc'.
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
showbranch.default::
|
2007-12-29 09:20:38 +03:00
|
|
|
The default set of branches for linkgit:git-show-branch[1].
|
|
|
|
See linkgit:git-show-branch[1].
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2007-12-08 00:26:07 +03:00
|
|
|
status.relativePaths::
|
2007-12-29 09:20:38 +03:00
|
|
|
By default, linkgit:git-status[1] shows paths relative to the
|
2007-12-08 00:26:07 +03:00
|
|
|
current directory. Setting this variable to `false` shows paths
|
2013-01-21 23:17:53 +04:00
|
|
|
relative to the repository root (this was the default for Git
|
2007-12-08 00:26:07 +03:00
|
|
|
prior to v1.5.4).
|
|
|
|
|
2013-06-11 17:34:04 +04: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 17:34:05 +04: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 21:43:07 +04: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.
|
|
|
|
|
2008-06-05 16:47:50 +04: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
|
|
|
|
all the files in the whole repository, which might be slow on some
|
|
|
|
systems. So, this variable controls how the commands displays
|
|
|
|
the untracked files. Possible values are:
|
|
|
|
+
|
|
|
|
--
|
2010-10-18 07:10:45 +04:00
|
|
|
* `no` - Show no untracked files.
|
|
|
|
* `normal` - Show untracked files and directories.
|
|
|
|
* `all` - Show also individual files in untracked directories.
|
2008-06-05 16:47:50 +04: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].
|
|
|
|
|
2010-05-20 19:55:42 +04:00
|
|
|
status.submodulesummary::
|
|
|
|
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 23:07:15 +04: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 20:59:03 +04: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 23:07:15 +04:00
|
|
|
also view the summary for ignored submodules you can either use
|
|
|
|
the --ignore-submodules=dirty command line option or the 'git
|
|
|
|
submodule summary' command, which shows a similar output but does
|
|
|
|
not honor these settings.
|
2010-05-20 19:55:42 +04:00
|
|
|
|
2010-07-15 11:51:19 +04:00
|
|
|
submodule.<name>.path::
|
|
|
|
submodule.<name>.url::
|
|
|
|
submodule.<name>.update::
|
|
|
|
The path within this project, URL, and the updating strategy
|
|
|
|
for a submodule. These variables are initially populated
|
|
|
|
by 'git submodule init'; edit them to override the
|
|
|
|
URL and other values found in the `.gitmodules` file. See
|
|
|
|
linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
|
|
|
|
|
submodule update: add --remote for submodule's upstream changes
The current `update` command incorporates the superproject's gitlinked
SHA-1 ($sha1) into the submodule HEAD ($subsha1). Depending on the
options you use, it may checkout $sha1, rebase the $subsha1 onto
$sha1, or merge $sha1 into $subsha1. This helps you keep up with
changes in the upstream superproject.
However, it's also useful to stay up to date with changes in the
upstream subproject. Previous workflows for incorporating such
changes include the ungainly:
$ git submodule foreach 'git checkout $(git config --file $toplevel/.gitmodules submodule.$name.branch) && git pull'
With this patch, all of the useful functionality for incorporating
superproject changes can be reused to incorporate upstream subproject
updates. When you specify --remote, the target $sha1 is replaced with
a $sha1 of the submodule's origin/master tracking branch. If you want
to merge a different tracking branch, you can configure the
`submodule.<name>.branch` option in `.gitmodules`. You can override
the `.gitmodules` configuration setting for a particular superproject
by configuring the option in that superproject's default configuration
(using the usual configuration hierarchy, e.g. `.git/config`,
`~/.gitconfig`, etc.).
Previous use of submodule.<name>.branch
=======================================
Because we're adding a new configuration option, it's a good idea to
check if anyone else is already using the option. The foreach-pull
example above was described by Ævar in
commit f030c96d8643fa0a1a9b2bd9c2f36a77721fb61f
Author: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Fri May 21 16:10:10 2010 +0000
git-submodule foreach: Add $toplevel variable
Gerrit uses the same interpretation for the setting, but because
Gerrit has direct access to the subproject repositories, it updates
the superproject repositories automatically when a subproject changes.
Gerrit also accepts the special value '.', which it expands into the
superproject's branch name.
Although the --remote functionality is using `submodule.<name>.branch`
slightly differently, the effect is the same. The foreach-pull
example uses the option to record the name of the local branch to
checkout before pulls. The tracking branch to be pulled is recorded
in `.git/modules/<name>/config`, which was initialized by the module
clone during `submodule add` or `submodule init`. Because the branch
name stored in `submodule.<name>.branch` was likely the same as the
branch name used during the initial `submodule add`, the same branch
will be pulled in each workflow.
Implementation details
======================
In order to ensure a current tracking branch state, `update --remote`
fetches the submodule's remote repository before calculating the
SHA-1. However, I didn't change the logic guarding the existing fetch:
if test -z "$nofetch"
then
# Run fetch only if $sha1 isn't present or it
# is not reachable from a ref.
(clear_local_git_env; cd "$path" &&
( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
test -z "$rev") || git-fetch)) ||
die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
fi
There will not be a double-fetch, because the new $sha1 determined
after the `--remote` triggered fetch should always exist in the
repository. If it doesn't, it's because some racy process removed it
from the submodule's repository and we *should* be re-fetching.
Signed-off-by: W. Trevor King <wking@tremily.us>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19 20:03:32 +04:00
|
|
|
submodule.<name>.branch::
|
|
|
|
The remote branch name for a submodule, used by `git submodule
|
|
|
|
update --remote`. Set this option to override the value found in
|
|
|
|
the `.gitmodules` file. See linkgit:git-submodule[1] and
|
|
|
|
linkgit:gitmodules[5] for details.
|
|
|
|
|
2010-11-11 02:55:41 +03:00
|
|
|
submodule.<name>.fetchRecurseSubmodules::
|
2011-03-07 01:12:19 +03:00
|
|
|
This option can be used to control recursive fetching of this
|
2011-01-03 22:03:34 +03:00
|
|
|
submodule. It can be overridden by using the --[no-]recurse-submodules
|
2010-11-11 02:55:41 +03:00
|
|
|
command line option to "git fetch" and "git pull".
|
|
|
|
This setting will override that from in the linkgit:gitmodules[5]
|
|
|
|
file.
|
|
|
|
|
2010-08-06 02:39:25 +04:00
|
|
|
submodule.<name>.ignore::
|
|
|
|
Defines under what circumstances "git status" and the diff family show
|
|
|
|
a submodule as modified. When set to "all", it will never be considered
|
2014-04-05 20:59:03 +04:00
|
|
|
modified (but it will nonetheless show up in the output of status and
|
|
|
|
commit when it has been staged), "dirty" will ignore all changes
|
|
|
|
to the submodules work tree and
|
2010-08-06 02:39:25 +04:00
|
|
|
takes only differences between the HEAD of the submodule and the commit
|
|
|
|
recorded in the superproject into account. "untracked" will additionally
|
|
|
|
let submodules with modified tracked files in their work tree show up.
|
|
|
|
Using "none" (the default when this option is not set) also shows
|
|
|
|
submodules that have untracked files in their work tree as changed.
|
2010-08-06 02:40:48 +04:00
|
|
|
This setting overrides any setting made in .gitmodules for this submodule,
|
2010-08-22 15:12:12 +04:00
|
|
|
both settings can be overridden on the command line by using the
|
2013-09-11 23:07:15 +04:00
|
|
|
"--ignore-submodules" option. The 'git submodule' commands are not
|
|
|
|
affected by this setting.
|
2010-08-06 02:39:25 +04:00
|
|
|
|
2006-07-20 13:30:44 +04:00
|
|
|
tar.umask::
|
2007-08-21 22:01:16 +04: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 09:20:38 +03:00
|
|
|
linkgit:git-archive[1].
|
2006-07-20 13:30:44 +04:00
|
|
|
|
2011-09-04 23:37:45 +04:00
|
|
|
transfer.fsckObjects::
|
|
|
|
When `fetch.fsckObjects` or `receive.fsckObjects` are
|
|
|
|
not set, the value of this variable is used instead.
|
|
|
|
Defaults to false.
|
|
|
|
|
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 04:08:30 +04:00
|
|
|
transfer.hiderefs::
|
|
|
|
This variable can be used to set both `receive.hiderefs`
|
|
|
|
and `uploadpack.hiderefs` at the same time to the same
|
|
|
|
values. See entries for these other variables.
|
|
|
|
|
2008-11-26 11:26:50 +03: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 14:04:19 +04: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
|
|
|
|
discussion in the `SECURITY` section of
|
|
|
|
linkgit:git-upload-archive[1] for more details. Defaults to
|
|
|
|
`false`.
|
|
|
|
|
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 04:08:30 +04:00
|
|
|
uploadpack.hiderefs::
|
|
|
|
String(s) `upload-pack` uses to decide which refs to omit
|
|
|
|
from its initial advertisement. Use more than one
|
|
|
|
definitions to specify multiple prefix strings. A ref that
|
|
|
|
are under the hierarchies listed on the value of this
|
|
|
|
variable is excluded, and is hidden from `git ls-remote`,
|
|
|
|
`git fetch`, etc. An attempt to fetch a hidden ref by `git
|
2013-01-29 09:49:57 +04:00
|
|
|
fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
|
|
|
|
|
|
|
|
uploadpack.allowtipsha1inwant::
|
|
|
|
When `uploadpack.hiderefs` is in effect, allow `upload-pack`
|
|
|
|
to accept a fetch request that asks for an object at the tip
|
|
|
|
of a hidden ref (by default, such a request is rejected).
|
|
|
|
see also `uploadpack.hiderefs`.
|
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 04:08:30 +04:00
|
|
|
|
2013-09-08 13:01:31 +04:00
|
|
|
uploadpack.keepalive::
|
|
|
|
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
|
|
|
|
`uploadpack.keepalive` seconds. Setting this option to 0
|
2013-09-08 13:02:06 +04:00
|
|
|
disables keepalive packets entirely. The default is 5 seconds.
|
2013-09-08 13:01:31 +04:00
|
|
|
|
2008-02-20 21:43:53 +03: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 23:17:53 +04:00
|
|
|
equivalent URLs and have Git automatically rewrite the URL to
|
2008-02-20 21:43:53 +03:00
|
|
|
the best alternative for the particular user, even for a
|
2008-02-25 09:25:04 +03:00
|
|
|
never-before-seen repository on the site. When more than one
|
|
|
|
insteadOf strings match a given URL, the longest match is used.
|
2008-02-20 21:43:53 +03:00
|
|
|
|
2009-09-07 12:56:33 +04: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 23:17:53 +04:00
|
|
|
allows people to specify a pull-only URL and have Git
|
2009-09-07 12:56:33 +04: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 23:17:53 +04:00
|
|
|
used. If a remote has an explicit pushurl, Git will ignore this
|
2009-09-07 12:56:33 +04:00
|
|
|
setting for that remote.
|
|
|
|
|
2006-04-25 02:59:33 +04:00
|
|
|
user.email::
|
|
|
|
Your email address to be recorded in any newly created commits.
|
2007-04-29 05:40:28 +04:00
|
|
|
Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
|
2007-12-29 09:20:38 +03:00
|
|
|
'EMAIL' environment variables. See linkgit:git-commit-tree[1].
|
2006-04-25 02:59:33 +04:00
|
|
|
|
|
|
|
user.name::
|
|
|
|
Your full name to be recorded in any newly created commits.
|
2006-06-04 00:27:26 +04:00
|
|
|
Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
|
2007-12-29 09:20:38 +03:00
|
|
|
environment variables. See linkgit:git-commit-tree[1].
|
2006-04-25 02:59:33 +04:00
|
|
|
|
2007-01-26 17:13:46 +03:00
|
|
|
user.signingkey::
|
2013-10-14 21:04:36 +04: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 17:13:46 +03:00
|
|
|
|
2008-01-08 06:55:14 +03: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.
|