Setup and Config
Getting and Creating Projects
Basic Snapshotting
Branching and Merging
Sharing and Updating Projects
Inspection and Comparison
Patching
Debugging
External Systems
Server Admin
Guides
- gitattributes
- Command-line interface conventions
- Everyday Git
- Frequently Asked Questions (FAQ)
- Glossary
- Hooks
- gitignore
- gitmodules
- Revisions
- Submodules
- Tutorial
- Workflows
- All guides...
Administration
Plumbing Commands
-
2.52.0
2025-11-17
-
2.51.2
2025-10-27
-
2.51.1
2025-10-15
-
2.51.0
2025-08-18
- 2.50.1 no changes
-
2.50.0
2025-06-16
- 2.49.1 no changes
-
2.49.0
2025-03-14
- 2.48.2 no changes
-
2.48.1
2025-01-13
-
2.48.0
2025-01-10
- 2.47.3 no changes
-
2.47.2
2024-11-26
-
2.47.1
2024-11-25
-
2.47.0
2024-10-06
- 2.46.4 no changes
-
2.46.3
2024-11-26
-
2.46.2
2024-09-23
-
2.46.1
2024-09-13
-
2.46.0
2024-07-29
- 2.45.4 no changes
-
2.45.3
2024-11-26
- 2.45.1 → 2.45.2 no changes
-
2.45.0
2024-04-29
- 2.44.4 no changes
-
2.44.3
2024-11-26
- 2.44.1 → 2.44.2 no changes
-
2.44.0
2024-02-23
- 2.43.7 no changes
-
2.43.6
2024-11-26
- 2.43.2 → 2.43.5 no changes
-
2.43.1
2024-02-09
-
2.43.0
2023-11-20
-
2.42.4
2024-11-26
- 2.42.2 → 2.42.3 no changes
-
2.42.1
2023-11-02
-
2.42.0
2023-08-21
-
2.41.3
2024-11-26
- 2.41.1 → 2.41.2 no changes
-
2.41.0
2023-06-01
-
2.40.4
2024-11-26
- 2.40.1 → 2.40.3 no changes
-
2.40.0
2023-03-12
- 2.39.1 → 2.39.5 no changes
-
2.39.0
2022-12-12
- 2.38.3 → 2.38.5 no changes
-
2.38.2
2022-12-11
-
2.38.1
2022-10-07
-
2.38.0
2022-10-02
- 2.37.5 → 2.37.7 no changes
-
2.37.4
2022-10-06
- 2.37.3 no changes
-
2.37.2
2022-08-11
- 2.37.1 no changes
-
2.37.0
2022-06-27
- 2.36.4 → 2.36.6 no changes
-
2.36.3
2022-10-06
-
2.36.2
2022-06-23
- 2.36.1 no changes
-
2.36.0
2022-04-18
- 2.35.6 → 2.35.8 no changes
-
2.35.5
2022-10-06
-
2.35.4
2022-06-23
-
2.35.3
2022-04-13
-
2.35.2
2022-03-23
- 2.35.1 no changes
-
2.35.0
2022-01-24
- 2.34.6 → 2.34.8 no changes
-
2.34.5
2022-10-06
-
2.34.4
2022-06-23
-
2.34.3
2022-04-13
-
2.34.2
2022-03-23
- 2.34.1 no changes
-
2.34.0
2021-11-15
- 2.33.6 → 2.33.8 no changes
-
2.33.5
2022-10-06
-
2.33.4
2022-06-23
-
2.33.3
2022-04-13
-
2.33.2
2022-03-23
-
2.33.1
2021-10-12
-
2.33.0
2021-08-16
- 2.32.5 → 2.32.7 no changes
-
2.32.4
2022-10-06
-
2.32.3
2022-06-23
-
2.32.2
2022-04-13
-
2.32.1
2022-03-23
-
2.32.0
2021-06-06
- 2.31.6 → 2.31.8 no changes
-
2.31.5
2022-10-06
-
2.31.4
2022-06-23
-
2.31.3
2022-04-13
-
2.31.2
2022-03-23
-
2.31.1
2021-03-26
-
2.31.0
2021-03-15
- 2.30.7 → 2.30.9 no changes
-
2.30.6
2022-10-06
-
2.30.5
2022-06-23
-
2.30.4
2022-04-13
-
2.30.3
2022-03-23
- 2.30.2 no changes
-
2.30.1
2021-02-08
-
2.30.0
2020-12-27
- 2.29.1 → 2.29.3 no changes
-
2.29.0
2020-10-19
- 2.28.1 no changes
-
2.28.0
2020-07-27
- 2.27.1 no changes
-
2.27.0
2020-06-01
- 2.26.1 → 2.26.3 no changes
-
2.26.0
2020-03-22
- 2.25.3 → 2.25.5 no changes
-
2.25.2
2020-03-17
-
2.25.1
2020-02-17
-
2.25.0
2020-01-13
- 2.24.1 → 2.24.4 no changes
-
2.24.0
2019-11-04
- 2.23.1 → 2.23.4 no changes
-
2.23.0
2019-08-16
- 2.22.2 → 2.22.5 no changes
-
2.22.1
2019-08-11
-
2.22.0
2019-06-07
- 2.21.1 → 2.21.4 no changes
-
2.21.0
2019-02-24
- 2.20.1 → 2.20.5 no changes
-
2.20.0
2018-12-09
- 2.19.3 → 2.19.6 no changes
-
2.19.2
2018-11-21
- 2.19.1 no changes
-
2.19.0
2018-09-10
- 2.18.1 → 2.18.5 no changes
-
2.18.0
2018-06-21
- 2.17.1 → 2.17.6 no changes
-
2.17.0
2018-04-02
-
2.16.6
2019-12-06
-
2.15.4
2019-12-06
-
2.14.6
2019-12-06
-
2.13.7
2018-05-22
-
2.12.5
2017-09-22
-
2.11.4
2017-09-22
-
2.10.5
2017-09-22
-
2.9.5
2017-07-30
-
2.8.6
2017-07-30
-
2.7.6
2017-07-30
-
2.6.7
2017-05-05
-
2.5.6
2017-05-05
-
2.4.12
2017-05-05
-
2.3.10
2015-09-28
-
2.2.3
2015-09-04
-
2.1.4
2014-12-17
-
2.0.5
2014-12-17
SYNOPSIS
git config list [<file-option>] [<display-option>] [--includes] git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<pattern>] [--fixed-value] [--default=<default>] [--url=<url>] <name> git config set [<file-option>] [--type=<type>] [--all] [--value=<pattern>] [--fixed-value] <name> <value> git config unset [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name> git config rename-section [<file-option>] <old-name> <new-name> git config remove-section [<file-option>] <name> git config edit [<file-option>] git config [<file-option>] --get-colorbool <name> [<stdout-is-tty>]
DESCRIPTION
You can query/set/replace/unset options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped.
Multiple lines can be added to an option by using the --append option.
If you want to update or unset an option which can occur on multiple
lines, --value=<pattern> (which is an extended regular expression,
unless the --fixed-value option is given) needs to be given. Only the
existing values that match the pattern are updated or unset. If
you want to handle the lines that do not match the pattern, just
prepend a single exclamation mark in front (see also EXAMPLES),
but note that this only works when the --fixed-value option is not
in use.
The --type=<type> option instructs git config to ensure that incoming and
outgoing values are canonicalize-able under the given <type>. If no
--type=<type> is given, no canonicalization will be performed. Callers may
unset an existing --type specifier with --no-type.
When reading, the values are read from the system, global and
repository local configuration files by default, and options
--system, --global, --local, --worktree and
--file <filename> can be used to tell the command to read from only
that location (see FILES).
When writing, the new value is written to the repository local
configuration file by default, and options --system, --global,
--worktree, --file <filename> can be used to tell the command to
write to that location (you can say --local but that is the
default).
This command will fail with non-zero status upon error. Some exit codes are:
-
The section or key is invalid (ret=1),
-
no section or name was provided (ret=2),
-
the config file is invalid (ret=3),
-
the config file cannot be written (ret=4),
-
you try to unset an option which does not exist (ret=5),
-
you try to unset/set an option for which multiple lines match (ret=5), or
-
you try to use an invalid regexp (ret=6).
On success, the command returns the exit code 0.
A list of all available configuration variables can be obtained using the
git help --config command.
COMMANDS
- list
-
List all variables set in config file, along with their values.
- get
-
Emits the value of the specified key. If key is present multiple times in the configuration, emits the last value. If
--allis specified, emits all values associated with key. Returns error code 1 if key is not present. - set
-
Set value for one or more config options. By default, this command refuses to write multi-valued config options. Passing
--allwill replace all multi-valued config options with the new value, whereas--value=will replace all config options whose values match the given pattern. - unset
-
Unset value for one or more config options. By default, this command refuses to unset multi-valued keys. Passing
--allwill unset all multi-valued config options, whereas--valuewill unset all config options whose values match the given pattern. - rename-section
-
Rename the given section to a new name.
- remove-section
-
Remove the given section from the configuration file.
- edit
-
Opens an editor to modify the specified config file; either
--system,--global,--local(default),--worktree, or--file<config-file>.
OPTIONS
- --replace-all
-
Default behavior is to replace at most one line. This replaces all lines matching the key (and optionally
--value=<pattern>). - --append
-
Adds a new line to the option without altering any existing values. This is the same as providing --value=^$ in
set. - --comment <message>
-
Append a comment at the end of new or modified lines.
If <message> begins with one or more whitespaces followed by "", it is used as-is. If it begins with "", a space is prepended before it is used. Otherwise, a string " # " (a space followed by a hash followed by a space) is prepended to it. And the resulting string is placed immediately after the value defined for the variable. The <message> must not contain linefeed characters (no multi-line comments are permitted).
- --all
-
With
get, return all values for a multi-valued key. - --regexp
-
With
get, interpret the name as a regular expression. Regular expression matching is currently case-sensitive and done against a canonicalized version of the key in which section and variable names are lowercased, but subsection names are not. - --url=<URL>
-
When given a two-part <name> as <section>.<key>, the value for <section>.<URL>.<key> whose <URL> part matches the best to the given URL is returned (if no such key exists, the value for <section>.<key> is used as a fallback). When given just the <section> as name, do so for all the keys in the section and list them. Returns error code 1 if no value is found.
- --global
-
For writing options: write to global
~/.gitconfigfile rather than the repository.git/config, write to$XDG_CONFIG_HOME/git/configfile if this file exists and the~/.gitconfigfile doesn’t.For reading options: read only from global
~/.gitconfigand from$XDG_CONFIG_HOME/git/configrather than from all available files.See also FILES.
- --system
-
For writing options: write to system-wide
$(prefix)/etc/gitconfigrather than the repository.git/config.For reading options: read only from system-wide
$(prefix)/etc/gitconfigrather than from all available files.See also FILES.
- --local
-
For writing options: write to the repository
.git/configfile. This is the default behavior.For reading options: read only from the repository
.git/configrather than from all available files.See also FILES.
- --worktree
-
Similar to
--localexcept that$GIT_DIR/config.worktreeis read from or written to ifextensions.worktreeConfigis enabled. If not it’s the same as--local. Note that$GIT_DIRis equal to$GIT_COMMON_DIRfor the main working tree, but is of the form$GIT_DIR/worktrees/<id>/for other working trees. See git-worktree[1] to learn how to enableextensions.worktreeConfig. - -f <config-file>
- --file <config-file>
-
For writing options: write to the specified file rather than the repository
.git/config.For reading options: read only from the specified file rather than from all available files.
See also FILES.
- --blob <blob>
-
Similar to
--filebut use the given blob instead of a file. E.g. you can use master:.gitmodules to read values from the file .gitmodules in the master branch. See "SPECIFYING REVISIONS" section in gitrevisions[7] for a more complete list of ways to spell blob names. --value=<pattern>--no-value-
With
get,set, andunset, match only against <pattern>. The pattern is an extended regular expression unless--fixed-valueis given.Use
--no-valueto unset <pattern>. - --fixed-value
-
When used with
--value=<pattern>, treat <pattern> as an exact string instead of a regular expression. This will restrict the name/value pairs that are matched to only those where the value is exactly equal to <pattern>. - --type <type>
-
git config will ensure that any input or output is valid under the given type constraint(s), and will canonicalize outgoing values in <type>'s canonical form.
Valid <type>'s include:
-
bool: canonicalize values
true,yes,on, and positive numbers as "true", and valuesfalse,no,offand0as "false". -
int: canonicalize values as simple decimal numbers. An optional suffix of k, m, or g will cause the value to be multiplied by 1024, 1048576, or 1073741824 upon input.
-
bool-or-int: canonicalize according to either bool or int, as described above.
-
path: canonicalize by expanding a leading
~to the value of$HOMEand~userto the home directory for the specified user. This specifier has no effect when setting the value (but you can usegitconfigsection.variable~/from the command line to let your shell do the expansion.) -
expiry-date: canonicalize by converting from a fixed or relative date-string to a timestamp. This specifier has no effect when setting the value.
-
color: When getting a value, canonicalize by converting to an ANSI color escape sequence. When setting a value, a sanity-check is performed to ensure that the given value is canonicalize-able as an ANSI color, but it is written as-is.
-
- --bool
- --int
- --bool-or-int
- --path
- --expiry-date
-
Historical options for selecting a type specifier. Prefer instead
--type(see above). - --no-type
-
Un-sets the previously set type specifier (if one was previously set). This option requests that git config not canonicalize the retrieved variable.
--no-typehas no effect without--type=<type> or--<type>. - -z
- --null
-
For all options that output values and/or keys, always end values with the null character (instead of a newline). Use newline instead as a delimiter between key and value. This allows for secure parsing of the output without getting confused e.g. by values that contain line breaks.
- --name-only
-
Output only the names of config variables for
listorget. --show-names--no-show-names-
With
get, show config keys in addition to their values. The default is--no-show-namesunless--urlis given and there are no subsections in <name>. - --show-origin
-
Augment the output of all queried config options with the origin type (file, standard input, blob, command line) and the actual origin (config file path, ref, or blob id if applicable).
- --show-scope
-
Similar to
--show-originin that it augments the output of all queried config options with the scope of that value (worktree, local, global, system, command). - --get-colorbool <name> [<stdout-is-tty>]
-
Find the color setting for <name> (e.g.
color.diff) and output "true" or "false". <stdout-is-tty> should be either "true" or "false", and is taken into account when configuration says "auto". If <stdout-is-tty> is missing, then checks the standard output of the command itself, and exits with status 0 if color is to be used, or exits with status 1 otherwise. When the color setting fornameis undefined, the command usescolor.uias fallback. - --includes
- --no-includes
-
Respect
include.*directives in config files when looking up values. Defaults tooffwhen a specific file is given (e.g., using--file,--global, etc) andonwhen searching all config files. - --default <value>
-
When using
get, and the requested variable is not found, behave as if <value> were the value assigned to that variable.
DEPRECATED MODES
The following modes have been deprecated in favor of subcommands. It is recommended to migrate to the new syntax.
- git config <name>
-
Replaced by
gitconfigget<name>. - git config <name> <value> [<value-pattern>]
-
Replaced by
gitconfigset[--value=<pattern>] <name> <value>. - -l
- --list
-
Replaced by
gitconfiglist. - --get <name> [<value-pattern>]
-
Replaced by
gitconfigget[--value=<pattern>] <name>. - --get-all <name> [<value-pattern>]
-
Replaced by
gitconfigget[--value=<pattern>]--all<name>. - --get-regexp <name-regexp>
-
Replaced by
gitconfigget--all--show-names--regexp<name-regexp>. - --get-urlmatch <name> <URL>
-
Replaced by
gitconfigget--all--show-names--url=<URL> <name>. - --get-color <name> [<default>]
-
Replaced by
gitconfigget--type=color[--default=<default>] <name>. - --add <name> <value>
-
Replaced by
gitconfigset--append<name> <value>. - --unset <name> [<value-pattern>]
-
Replaced by
gitconfigunset[--value=<pattern>] <name>. - --unset-all <name> [<value-pattern>]
-
Replaced by
gitconfigunset[--value=<pattern>]--all<name>. - --rename-section <old-name> <new-name>
-
Replaced by
gitconfigrename-section<old-name> <new-name>. - --remove-section <name>
-
Replaced by
gitconfigremove-section<name>. - -e
- --edit
-
Replaced by
gitconfigedit.
CONFIGURATION
pager.config is only respected when listing configuration, i.e., when
using list or get which may return multiple results. The default is to use
a pager.
FILES
By default, git config will read configuration options from multiple files:
- $(prefix)/etc/gitconfig
-
System-wide configuration file.
- $XDG_CONFIG_HOME/git/config
- ~/.gitconfig
-
User-specific configuration files. When the XDG_CONFIG_HOME environment variable is not set or empty, $HOME/.config/ is used as $XDG_CONFIG_HOME.
These are also called "global" configuration files. If both files exist, both files are read in the order given above.
- $GIT_DIR/config
-
Repository specific configuration file.
- $GIT_DIR/config.worktree
-
This is optional and is only searched when
extensions.worktreeConfigis present in $GIT_DIR/config.
You may also provide additional configuration parameters when running any
git command by using the -c option. See git[1] for details.
Options will be read from all of these files that are available. If the global or the system-wide configuration files are missing or unreadable they will be ignored. If the repository configuration file is missing or unreadable, git config will exit with a non-zero error code. An error message is produced if the file is unreadable, but not if it is missing.
The files are read in the order given above, with last value found taking precedence over values read earlier. When multiple values are taken then all values of a key from all files will be used.
By default, options are only written to the repository specific
configuration file. Note that this also affects options like set
and unset. git config will only ever change one file at a time.
You can limit which configuration sources are read from or written to by
specifying the path of a file with the --file option, or by specifying a
configuration scope with --system, --global, --local, or --worktree.
For more, see OPTIONS above.
SCOPES
Each configuration source falls within a configuration scope. The scopes are:
- system
-
$(prefix)/etc/gitconfig
- global
-
$XDG_CONFIG_HOME/git/config
~/.gitconfig
- local
-
$GIT_DIR/config
- worktree
-
$GIT_DIR/config.worktree
- command
-
GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see ENVIRONMENT below)
the
-coption
With the exception of command, each scope corresponds to a command line
option: --system, --global, --local, --worktree.
When reading options, specifying a scope will only read options from the files within that scope. When writing options, specifying a scope will write to the files within that scope (instead of the repository specific configuration file). See OPTIONS above for a complete description.
Most configuration options are respected regardless of the scope it is defined in, but some options are only respected in certain scopes. See the respective option’s documentation for the full details.
Protected configuration
Protected configuration refers to the system, global, and command scopes. For security reasons, certain options are only respected when they are specified in protected configuration, and ignored otherwise.
Git treats these scopes as if they are controlled by the user or a trusted administrator. This is because an attacker who controls these scopes can do substantial harm without using Git, so it is assumed that the user’s environment protects these scopes against attackers.
ENVIRONMENT
See also FILES.
- GIT_CONFIG_COUNT
- GIT_CONFIG_KEY_<n>
- GIT_CONFIG_VALUE_<n>
-
If GIT_CONFIG_COUNT is set to a positive number, all environment pairs GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> up to that number will be added to the process’s runtime configuration. The config pairs are zero-indexed. Any missing key or value is treated as an error. An empty GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no pairs are processed. These environment variables will override values in configuration files, but will be overridden by any explicit options passed via
git-c.This is useful for cases where you want to spawn multiple git commands with a common configuration but cannot depend on a configuration file, for example when writing scripts.
- GIT_CONFIG
-
If no
--fileoption is provided togitconfig, use the file given byGIT_CONFIGas if it were provided via--file. This variable has no effect on other Git commands, and is mostly for historical compatibility; there is generally no reason to use it instead of the--fileoption.
EXAMPLES
Given a .git/config like this:
# # This is the config file, and # a '#' or ';' character indicates # a comment # ; core variables [core] ; Don't trust file modes filemode = false ; Our diff algorithm [diff] external = /usr/local/bin/diff-wrapper renames = true ; Proxy settings [core] gitproxy=proxy-command for kernel.org gitproxy=default-proxy ; for all the rest ; HTTP [http] sslVerify [http "https://weak.example.com"] sslVerify = false cookieFile = /tmp/cookie.txt
you can set the filemode to true with
% git config set core.filemode true
The hypothetical proxy command entries actually have a postfix to discern what URL they apply to. Here is how to change the entry for kernel.org to "ssh".
% git config set --value='for kernel.org$' core.gitproxy '"ssh" for kernel.org'
This makes sure that only the key/value pair for kernel.org is replaced.
To delete the entry for renames, do
% git config unset diff.renames
If you want to delete an entry for a multivar (like core.gitproxy above), you have to provide a regex matching the value of exactly one line.
To query the value for a given key, do
% git config get core.filemode
or, to query a multivar:
% git config get --value="for kernel.org$" core.gitproxy
If you want to know all the values for a multivar, do:
% git config get --all --show-names core.gitproxy
If you like to live dangerously, you can replace all core.gitproxy by a new one with
% git config set --all core.gitproxy ssh
However, if you really only want to replace the line for the default proxy, i.e. the one without a "for …" postfix, do something like this:
% git config set --value='! for ' core.gitproxy ssh
To actually match only values with an exclamation mark, you have to
% git config set --value='[!]' section.key value
To add a new proxy, without altering any of the existing ones, use
% git config set --append core.gitproxy '"proxy-command" for example.com'
An example to use customized color from the configuration in your script:
#!/bin/sh
WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace)
RESET=$(git config get --type=color --default="reset" "")
echo "${WS}your whitespace color or blue reverse${RESET}"
For URLs in https://weak.example.com, http.sslVerify is set to
false, while it is set to true for all others:
% git config get --type=bool --url=https://good.example.com http.sslverify true % git config get --type=bool --url=https://weak.example.com http.sslverify false % git config get --url=https://weak.example.com http http.cookieFile /tmp/cookie.txt http.sslverify false
CONFIGURATION FILE
The Git configuration file contains a number of variables that affect
the Git commands' behavior. The files .git/config and optionally
config.worktree (see the "CONFIGURATION FILE" section of
git-worktree[1]) in each repository are used to store the
configuration for that repository, and $HOME/.gitconfig is used to
store a per-user configuration as fallback values for the .git/config
file. The file /etc/gitconfig can be used to store a system-wide
default configuration.
The configuration variables are used by both the Git plumbing
and the porcelain commands. The variables are divided into sections, wherein
the fully qualified variable name of the variable itself is the last
dot-separated segment and the section name is everything before the last
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; we say then that the variable is
multivalued.
Syntax
The syntax is fairly flexible and permissive. Whitespace characters, which in this context are the space character (SP) and the horizontal tabulation (HT), are mostly 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 case-insensitive. Only alphanumeric
characters, - and . are allowed in section names. Each variable
must belong to some section, which means that there must be a section
header before the first setting of a variable.
Sections can be further divided into subsections. To begin a subsection put its name in double quotes, separated by space from the section name, in the section header, like in the example below:
[section "subsection"]
Subsection names are case sensitive and can contain any characters except
newline and the null byte. Doublequote " and backslash can be included
by escaping them as \" and \\, respectively. Backslashes preceding
other characters are dropped when reading; for example, \t is read as
t and \0 is read as 0. Section headers cannot span multiple lines.
Variables may belong directly to a section or to a given subsection. You
can have [section] if you have [section "subsection"], but you don’t
need to.
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.
All the other lines (and the remainder of the line after the section
header) are recognized as setting variables, in the form
name = value (or just name, which is a short-hand to say that
the variable is the boolean "true").
The variable names are case-insensitive, allow only alphanumeric characters
and -, and must start with an alphabetic character.
Whitespace characters surrounding name, = and value are discarded.
Internal whitespace characters within value are retained verbatim.
Comments starting with either # or ; and extending to the end of line
are discarded. A line that defines a value can be continued to the next
line by ending it with a backslash (\); the backslash and the end-of-line
characters are discarded.
If value needs to contain leading or trailing whitespace characters,
it must be enclosed in double quotation marks ("). Inside double quotation
marks, double quote (") and backslash (\) characters must be escaped:
use \" for " and \\ for \.
The following escape sequences (beside \" and \\) are recognized: \n for newline character (NL), \t for horizontal tabulation (HT, TAB) and \b for backspace (BS). Other char escape sequences (including octal escape sequences) are invalid.
Includes
The include and includeIf sections allow you to include config
directives from another source. These sections behave identically to
each other with the exception that includeIf sections may be ignored
if their condition does not evaluate to true; see "Conditional includes"
below.
You can include a config file from another by setting the special
include.path (or includeIf.*.path) variable to the name of the file
to be included. The variable takes a pathname as its value, and is
subject to tilde expansion. These variables can be given multiple times.
The contents of the included file are inserted immediately, as if they had been found at the location of the include directive. If the value of the variable is a relative path, the path is considered to be relative to the configuration file in which the include directive was found. See below for examples.
Conditional includes
You can conditionally include a config file from another by setting an
includeIf.<condition>.path variable to the name of the file to be
included.
The condition starts with a keyword followed by a colon and some data whose format and meaning depends on the keyword. Supported keywords are:
gitdir-
The data that follows the keyword
gitdirand a colon is used as a glob pattern. If the location of the .git directory matches the pattern, the include condition is met.The .git location may be auto-discovered, or come from
$GIT_DIRenvironment variable. If the repository is auto-discovered via a .git file (e.g. from submodules, or a linked worktree), the .git location would be the final location where the .git directory is, not where the .git file is.The pattern can contain standard globbing wildcards and two additional ones,
**/and/**, that can match multiple path components. Please refer to gitignore[5] for details. For convenience:-
If the pattern starts with
~/,~will be substituted with the content of the environment variableHOME. -
If the pattern starts with
./, it is replaced with the directory containing the current config file. -
If the pattern does not start with either
~/,./or/,**/will be automatically prepended. For example, the patternfoo/barbecomes**/foo/barand would match/any/path/to/foo/bar. -
If the pattern ends with
/,**will be automatically added. For example, the patternfoo/becomesfoo/**. In other words, it matches "foo" and everything inside, recursively.
-
gitdir/i-
This is the same as
gitdirexcept that matching is done case-insensitively (e.g. on case-insensitive file systems) onbranch-
The data that follows the keyword
onbranchand a colon is taken to be a pattern with standard globbing wildcards and two additional ones,**/and/**, that can match multiple path components. If we are in a worktree where the name of the branch that is currently checked out matches the pattern, the include condition is met.If the pattern ends with
/,**will be automatically added. For example, the patternfoo/becomesfoo/**. In other words, it matches all branches that begin withfoo/. This is useful if your branches are organized hierarchically and you would like to apply a configuration to all the branches in that hierarchy. hasconfig:remote.*.url-
The data that follows this keyword and a colon is taken to be a pattern with standard globbing wildcards and two additional ones,
**/and/**, that can match multiple components. The first time this keyword is seen, the rest of the config files will be scanned for remote URLs (without applying any values). If there exists at least one remote URL that matches this pattern, the include condition is met.Files included by this option (directly or indirectly) are not allowed to contain remote URLs.
Note that unlike other includeIf conditions, resolving this condition relies on information that is not yet known at the point of reading the condition. A typical use case is this option being present as a system-level or global-level config, and the remote URL being in a local-level config; hence the need to scan ahead when resolving this condition. In order to avoid the chicken-and-egg problem in which potentially-included files can affect whether such files are potentially included, Git breaks the cycle by prohibiting these files from affecting the resolution of these conditions (thus, prohibiting them from declaring remote URLs).
As for the naming of this keyword, it is for forwards compatibility with a naming scheme that supports more variable-based include conditions, but currently Git only supports the exact keyword described above.
A few more notes on matching via gitdir and gitdir/i:
-
Symlinks in
$GIT_DIRare not resolved before matching. -
Both the symlink & realpath versions of paths will be matched outside of
$GIT_DIR. E.g. if ~/git is a symlink to /mnt/storage/git, bothgitdir:~/gitandgitdir:/mnt/storage/gitwill match.This was not the case in the initial release of this feature in v2.13.0, which only matched the realpath version. Configuration that wants to be compatible with the initial release of this feature needs to either specify only the realpath version, or both versions.
-
Note that "../" is not special and will match literally, which is unlikely what you want.
Example
# Core variables [core] ; Don't trust file modes filemode = false # Our diff algorithm [diff] external = /usr/local/bin/diff-wrapper renames = true [branch "devel"] remote = origin merge = refs/heads/devel # Proxy settings [core] gitProxy="ssh" for "kernel.org" gitProxy=default-proxy ; for the rest [include] path = /path/to/foo.inc ; include by absolute path path = foo.inc ; find "foo.inc" relative to the current file path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory ; include if $GIT_DIR is /path/to/foo/.git [includeIf "gitdir:/path/to/foo/.git"] path = /path/to/foo.inc ; include for all repositories inside /path/to/group [includeIf "gitdir:/path/to/group/"] path = /path/to/foo.inc ; include for all repositories inside $HOME/to/group [includeIf "gitdir:~/to/group/"] path = /path/to/foo.inc ; relative paths are always relative to the including ; file (if the condition is true); their location is not ; affected by the condition [includeIf "gitdir:/path/to/group/"] path = foo.inc ; include only if we are in a worktree where foo-branch is ; currently checked out [includeIf "onbranch:foo-branch"] path = foo.inc ; include only if a remote with the given URL exists (note ; that such a URL may be provided later in a file or in a ; file read after this file is read, as seen in this example) [includeIf "hasconfig:remote.*.url:https://example.com/**"] path = foo.inc [remote "origin"] url = https://example.com/git
Values
Values of many variables are treated as a simple string, but there are variables that take values of specific types and there are rules as to how to spell them.
- boolean
-
When a variable is said to take a boolean value, many synonyms are accepted for true and false; these are all case-insensitive.
- true
-
Boolean true literals are
yes,on,true, and1. Also, a variable defined without=<value> is taken as true. - false
-
Boolean false literals are
no,off,false,0and the empty string.When converting a value to its canonical form using the
--type=booltype specifier, git config will ensure that the output is "true" or "false" (spelled in lowercase).
- integer
-
The value for many variables that specify various sizes can be suffixed with
k,M,… to mean "scale the number by 1024", "by 1024x1024", etc. - color
-
The value for a variable that takes a color is a list of colors (at most two, one for foreground and one for background) and attributes (as many as you want), separated by spaces.
The basic colors accepted are
normal,black,red,green,yellow,blue,magenta,cyan,whiteanddefault. The first color given is the foreground; the second is the background. All the basic colors exceptnormalanddefaulthave a bright variant that can be specified by prefixing the color withbright, likebrightred.The color
normalmakes no change to the color. It is the same as an empty string, but can be used as the foreground color when specifying a background color alone (for example, "normal red").The color
defaultexplicitly resets the color to the terminal default, for example to specify a cleared background. Although it varies between terminals, this is usually not the same as setting to "white black".Colors may also be given as numbers between 0 and 255; these use ANSI 256-color mode (but note that not all terminals may support this). If your terminal supports it, you may also specify 24-bit RGB values as hex, like
#ff0ab3, or 12-bit RGB values like#f1b, which is equivalent to the 24-bit color#ff11bb.The accepted attributes are
bold,dim,ul,blink,reverse,italic, andstrike(for crossed-out or "strikethrough" letters). The position of any attributes with respect to the colors (before, after, or in between), doesn’t matter. Specific attributes may be turned off by prefixing them withnoorno-(e.g.,noreverse,no-ul, etc).The pseudo-attribute
resetresets all colors and attributes before applying the specified coloring. For example,resetgreenwill result in a green foreground and default background without any active attributes.An empty color string produces no color effect at all. This can be used to avoid coloring specific elements without disabling color entirely.
For git’s pre-defined color slots, the attributes are meant to be reset at the beginning of each item in the colored output. So setting
color.decorate.branchtoblackwill paint that branch name in a plainblack, even if the previous thing on the same output line (e.g. opening parenthesis before the list of branch names inlog--decorateoutput) is set to be painted withboldor some other attribute. However, custom log formats may do more complicated and layered coloring, and the negated forms may be useful there. - pathname
-
A variable that takes a pathname value can be given a string that begins with "
~/" or "~user/", and the usual tilde expansion happens to such a string:~/is expanded to the value of$HOME, and~user/to the specified user’s home directory.If a path starts with
%(prefix)/, the remainder is interpreted as a path relative to Git’s "runtime prefix", i.e. relative to the location where Git itself was installed. For example,%(prefix)/bin/refers to the directory in which the Git executable itself lives. If Git was compiled without runtime prefix support, the compiled-in prefix will be substituted instead. In the unlikely event that a literal path needs to be specified that should not be expanded, it needs to be prefixed by./, like so:./%(prefix)/bin.If prefixed with
:(optional), the configuration variable is treated as if it does not exist, if the named path does not exist.
Variables
Note that this list is non-comprehensive and not necessarily complete. For command-specific variables, you will find a more detailed description 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.
add.ignoreErrorsadd.ignore-errors(deprecated)-
Tells
gitaddto continue adding files when some files cannot be added due to indexing errors. Equivalent to the--ignore-errorsoption of git-add[1].add.ignore-errorsis deprecated, as it does not follow the usual naming convention for configuration variables. - advice.*
-
These variables control various optional help messages designed to aid new users. When left unconfigured, Git will give the message alongside instructions on how to squelch it. You can tell Git that you have understood the issue and no longer need a specific help message by setting the corresponding variable to
false.As they are intended to help human users, these messages are output to the standard error. When tools that run Git as a subprocess find them disruptive, they can set
GIT_ADVICE=0in the environment to squelch all advice messages.- addEmbeddedRepo
-
Shown when the user accidentally adds one git repo inside of another.
- addEmptyPathspec
-
Shown when the user runs
gitaddwithout providing the pathspec parameter. - addIgnoredFile
-
Shown when the user attempts to add an ignored file to the index.
- amWorkDir
-
Shown when git-am[1] fails to apply a patch file, to tell the user the location of the file.
- ambiguousFetchRefspec
-
Shown when a fetch refspec for multiple remotes maps to the same remote-tracking branch namespace and causes branch tracking set-up to fail.
- checkoutAmbiguousRemoteBranchName
-
Shown when the argument to git-checkout[1] and git-switch[1] ambiguously resolves to a remote tracking branch on more than one remote in situations where an unambiguous argument would have otherwise caused a remote-tracking branch to be checked out. See the
checkout.defaultRemoteconfiguration variable for how to set a given remote to be used by default in some situations where this advice would be printed. - commitBeforeMerge
-
Shown when git-merge[1] refuses to merge to avoid overwriting local changes.
- detachedHead
-
Shown when the user uses git-switch[1] or git-checkout[1] to move to the detached HEAD state, to tell the user how to create a local branch after the fact.
- diverging
-
Shown when a fast-forward is not possible.
- fetchShowForcedUpdates
-
Shown when git-fetch[1] takes a long time to calculate forced updates after ref updates, or to warn that the check is disabled.
- forceDeleteBranch
-
Shown when the user tries to delete a not fully merged branch without the force option set.
- ignoredHook
-
Shown when a hook is ignored because the hook is not set as executable.
- implicitIdentity
-
Shown when the user’s information is guessed from the system username and domain name, to tell the user how to set their identity configuration.
- mergeConflict
-
Shown when various commands stop because of conflicts.
- nestedTag
-
Shown when a user attempts to recursively tag a tag object.
- pushAlreadyExists
-
Shown when git-push[1] rejects an update that does not qualify for fast-forwarding (e.g., a tag.)
- pushFetchFirst
-
Shown when 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 git-push[1] rejects an update that tries to overwrite a remote ref that points at an object that is not a commit-ish, or make the remote ref point at an object that is not a commit-ish.
- pushNonFFCurrent
-
Shown when git-push[1] fails due to a non-fast-forward update to the current branch.
- pushNonFFMatching
-
Shown when the user ran git-push[1] and pushed "matching refs" explicitly (i.e. used
:, or specified a refspec that isn’t the current branch) and it resulted in a non-fast-forward error. - pushRefNeedsUpdate
-
Shown when git-push[1] rejects a forced update of a branch when its remote-tracking ref has updates that we do not have locally.
- pushUnqualifiedRefname
-
Shown when git-push[1] gives up trying to guess based on the source and destination refs what remote ref namespace the source belongs in, but where we can still suggest that the user push to either
refs/heads/*orrefs/tags/*based on the type of the source object. - pushUpdateRejected
-
Set this variable to
falseif you want to disablepushNonFFCurrent,pushNonFFMatching,pushAlreadyExists,pushFetchFirst,pushNeedsForce, andpushRefNeedsUpdatesimultaneously. - rebaseTodoError
-
Shown when there is an error after editing the rebase todo list.
- refSyntax
-
Shown when the user provides an illegal ref name, to tell the user about the ref syntax documentation.
- resetNoRefresh
-
Shown when git-reset[1] takes more than 2 seconds to refresh the index after reset, to tell the user that they can use the
--no-refreshoption. - resolveConflict
-
Shown by various commands when conflicts prevent the operation from being performed.
- rmHints
-
Shown on failure in the output of git-rm[1], to give directions on how to proceed from the current state.
- sequencerInUse
-
Shown when a sequencer command is already in progress.
- skippedCherryPicks
-
Shown when git-rebase[1] skips a commit that has already been cherry-picked onto the upstream branch.
- sparseIndexExpanded
-
Shown when a sparse index is expanded to a full index, which is likely due to an unexpected set of files existing outside of the sparse-checkout.
- statusAheadBehind
-
Shown when git-status[1] computes the ahead/behind counts for a local ref compared to its remote tracking ref, and that calculation takes longer than expected. Will not appear if
status.aheadBehindis false or the option--no-ahead-behindis given. - statusHints
-
Show directions on how to proceed from the current state in the output of git-status[1], in the template shown when writing commit messages in git-commit[1], and in the help message shown by git-switch[1] or git-checkout[1] when switching branches.
- statusUoption
-
Shown when git-status[1] takes more than 2 seconds to enumerate untracked files, to tell the user that they can use the
-uoption. - submoduleAlternateErrorStrategyDie
-
Shown when a submodule.alternateErrorStrategy option configured to "die" causes a fatal error.
- submoduleMergeConflict
-
Advice shown when a non-trivial submodule merge conflict is encountered.
- submodulesNotUpdated
-
Shown when a user runs a submodule command that fails because
gitsubmoduleupdate--initwas not run. - suggestDetachingHead
-
Shown when git-switch[1] refuses to detach HEAD without the explicit
--detachoption. - updateSparsePath
-
Shown when either git-add[1] or git-rm[1] is asked to update index entries outside the current sparse checkout.
- waitingForEditor
-
Shown when Git is waiting for editor input. Relevant when e.g. the editor is not launched inside the terminal.
- worktreeAddOrphan
-
Shown when the user tries to create a worktree from an invalid reference, to tell the user how to create a new unborn branch instead.
- alias.*
-
Command aliases for the git[1] command wrapper - e.g. after defining
alias.last=cat-filecommitHEAD, the invocationgitlastis equivalent togitcat-filecommitHEAD. To avoid confusion and troubles with script usage, aliases that hide existing Git commands are ignored except for deprecated commands. Arguments are split by spaces, the usual shell quoting and escaping are supported. A quote pair or a backslash can be used to quote them.Note that the first word of an alias does not necessarily have to be a command. It can be a command-line option that will be passed into the invocation of
git. In particular, this is useful when used with-cto pass in one-time configurations or-pto force pagination. For example,loud-rebase=-ccommit.verbose=truerebasecan be defined such that runninggitloud-rebasewould be equivalent togit-ccommit.verbose=truerebase. Also,ps=-pstatuswould be a helpful alias sincegitpswould paginate the output ofgitstatuswhere the original command does not.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--notORIG_HEAD, the invocationgitnewis equivalent to running the shell commandgitk--all--notORIG_HEAD. Note:-
Shell commands will be executed from the top-level directory of a repository, which may not necessarily be the current directory.
-
GIT_PREFIXis set as returned by runninggitrev-parse--show-prefixfrom the original current directory. See git-rev-parse[1]. -
Shell command aliases always receive any extra arguments provided to the Git command-line as positional arguments.
-
Care should be taken if your shell alias is a "one-liner" script with multiple commands (e.g. in a pipeline), references multiple arguments, or is otherwise not able to handle positional arguments added at the end. For example:
alias.cmd="!echo$1|grep$2"called asgitcmd12will be executed as echo $1 | grep $2 1 2, which is not what you want. -
A convenient way to deal with this is to write your script operations in an inline function that is then called with any arguments from the command-line. For example alias.cmd = "!c() { echo $1 | grep $2 ; }; c" will correctly execute the prior example.
-
Setting
GIT_TRACE=1can help you debug the command being run for your alias.
-
-
- 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 not remove \r from lines ending with \r\n. Can be overridden by giving--no-keep-crfrom the command line. See git-am[1], git-mailsplit[1]. - am.threeWay
-
By default,
gitamwill fail if the patch does not apply cleanly. When set to true, this setting tellsgitamto fall back on 3-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally (equivalent to giving the--3wayoption from the command line). Defaults tofalse. See git-am[1]. - apply.ignoreWhitespace
-
When set to change, tells git apply to ignore changes in whitespace, in the same way as the
--ignore-space-changeoption. When set to one of: no, none, never, false, it tells git apply to respect all whitespace differences. See git-apply[1]. - apply.whitespace
-
Tells git apply how to handle whitespace, in the same way as the
--whitespaceoption. See git-apply[1]. - attr.tree
-
A reference to a tree in the repository from which to read attributes, instead of the
.gitattributesfile in the working tree. If the value does not resolve to a valid tree object, an empty tree is used instead. When theGIT_ATTR_SOURCEenvironment variable or--attr-sourcecommand line option are used, this configuration variable has no effect.
|
Note
|
The configuration options in bitmapPseudoMerge.* are considered
EXPERIMENTAL and may be subject to change or be removed entirely in the
future. For more information about the pseudo-merge bitmap feature, see
the "Pseudo-merge bitmaps" section of gitpacking[7].
|
- bitmapPseudoMerge.<name>.pattern
-
Regular expression used to match reference names. Commits pointed to by references matching this pattern (and meeting the below criteria, like
bitmapPseudoMerge.<name>.sampleRateandbitmapPseudoMerge.<name>.threshold) will be considered for inclusion in a pseudo-merge bitmap.Commits are grouped into pseudo-merge groups based on whether or not any reference(s) that point at a given commit match the pattern, which is an extended regular expression.
Within a pseudo-merge group, commits may be further grouped into sub-groups based on the capture groups in the pattern. These sub-groupings are formed from the regular expressions by concatenating any capture groups from the regular expression, with a - dash in between.
For example, if the pattern is
refs/tags/, then all tags (provided they meet the below criteria) will be considered candidates for the same pseudo-merge group. However, if the pattern is insteadrefs/remotes/([0-9])+/tags/, then tags from different remotes will be grouped into separate pseudo-merge groups, based on the remote number. - bitmapPseudoMerge.<name>.decay
-
Determines the rate at which consecutive pseudo-merge bitmap groups decrease in size. Must be non-negative. This parameter can be thought of as
kin the functionf(n)=C*n^-k, wheref(n) is the size of the `n`th group.Setting the decay rate equal to
0will cause all groups to be the same size. Setting the decay rate equal to1will cause thenthgrouptobe1/nthe size of the initial group. Higher values of the decay rate cause consecutive groups to shrink at an increasing rate. The default is1.If all groups are the same size, it is possible that groups containing newer commits will be able to be used less often than earlier groups, since it is more likely that the references pointing at newer commits will be updated more often than a reference pointing at an old commit.
- bitmapPseudoMerge.<name>.sampleRate
-
Determines the proportion of non-bitmapped commits (among reference tips) which are selected for inclusion in an unstable pseudo-merge bitmap. Must be between
0and1(inclusive). The default is1. - bitmapPseudoMerge.<name>.threshold
-
Determines the minimum age of non-bitmapped commits (among reference tips, as above) which are candidates for inclusion in an unstable pseudo-merge bitmap. The default is
1.week.ago. - bitmapPseudoMerge.<name>.maxMerges
-
Determines the maximum number of pseudo-merge commits among which commits may be distributed.
For pseudo-merge groups whose pattern does not contain any capture groups, this setting is applied for all commits matching the regular expression. For patterns that have one or more capture groups, this setting is applied for each distinct capture group.
For example, if your capture group is
refs/tags/, then this setting will distribute all tags into a maximum ofmaxMergespseudo-merge commits. However, if your capture group is, say,refs/remotes/([0-9]+)/tags/, then this setting will be applied to each remote’s set of tags individually.Must be non-negative. The default value is 64.
- bitmapPseudoMerge.<name>.stableThreshold
-
Determines the minimum age of commits (among reference tips, as above, however stable commits are still considered candidates even when they have been covered by a bitmap) which are candidates for a stable a pseudo-merge bitmap. The default is
1.month.ago.Setting this threshold to a smaller value (e.g., 1.week.ago) will cause more stable groups to be generated (which impose a one-time generation cost) but those groups will likely become stale over time. Using a larger value incurs the opposite penalty (fewer stable groups which are more useful).
- bitmapPseudoMerge.<name>.stableSize
-
Determines the size (in number of commits) of a stable psuedo-merge bitmap. The default is
512. - blame.blankBoundary
-
Show blank commit object name for boundary commits in git-blame[1]. This option defaults to false.
- blame.coloring
-
This determines the coloring scheme to be applied to blame output. It can be repeatedLines, highlightRecent, or none which is the default.
- blame.date
-
Specifies the format used to output dates in git-blame[1]. If unset the iso format is used. For supported values, see the discussion of the
--dateoption at git-log[1]. - blame.showEmail
-
Show the author email instead of author name in git-blame[1]. This option defaults to false.
- blame.showRoot
-
Do not treat root commits as boundaries in git-blame[1]. This option defaults to false.
- blame.ignoreRevsFile
-
Ignore revisions listed in the file, one unabbreviated object name per line, in git-blame[1]. Whitespace and comments beginning with
#are ignored. This option may be repeated multiple times. Empty file names will reset the list of ignored revisions. This option will be handled before the command line option--ignore-revs-file. - blame.markUnblamableLines
-
Mark lines that were changed by an ignored revision that we could not attribute to another commit with a * in the output of git-blame[1].
- blame.markIgnoredLines
-
Mark lines that were changed by an ignored revision that we attributed to another commit with a ? in the output of git-blame[1].
branch.autoSetupMerge-
Tells
gitbranch,gitswitchandgitcheckoutto set up new branches so that git-pull[1] will appropriately merge from the starting point branch. Note that even if this option is not set, this behavior can be chosen per-branch using the--trackand--no-trackoptions. This option defaults totrue. The valid settings are:false-
no automatic setup is done
true-
automatic setup is done when the starting point is a remote-tracking branch
always-
automatic setup is done when the starting point is either a local branch or remote-tracking branch
inherit-
if the starting point has a tracking configuration, it is copied to the new branch
simple-
automatic setup is done only when the starting point is a remote-tracking branch and the new branch has the same name as the remote branch.
branch.autoSetupRebase-
When a new branch is created with
gitbranch,gitswitchorgitcheckoutthat tracks another branch, this variable tells Git to set up pull to rebase instead of merge (seebranch.<name>.rebase). The valid settings are:See
branch.autoSetupMergefor details on how to set up a branch to track another branch. This option defaults tonever. branch.sort-
This variable controls the sort ordering of branches when displayed by git-branch[1]. Without the
--sort=<value> option provided, the value of this variable will be used as the default. See git-for-each-ref[1] field names for valid values. branch.<name>.remote-
When on branch <name>, it tells
gitfetchandgitpushwhich remote to fetch from or push to. The remote to push to may be overridden withremote.pushDefault(for all branches). The remote to push to, for the current branch, may be further overridden bybranch.<name>.pushRemote. If no remote is configured, or if you are not on any branch and there is more than one remote defined in the repository, it defaults tooriginfor fetching andremote.pushDefaultfor pushing. Additionally,.(a period) is the current local repository (a dot-repository), seebranch.<name>.merge's final note below. branch.<name>.pushRemote-
When on branch <name>, it overrides
branch.<name>.remotefor pushing. It also overridesremote.pushDefaultfor 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 setremote.pushDefaultto specify the remote to push to for all branches, and use this option to override it for a specific branch. branch.<name>.merge-
Defines, together with
branch.<name>.remote, the upstream branch for the given branch. It tellsgitfetch/gitpull/gitrebasewhich branch to merge and can also affectgitpush(seepush.default). When in branch <name>, it tellsgitfetchthe default refspec to be marked for merging inFETCH_HEAD. The value is handled like the remote part of a refspec, and must match a ref which is fetched from the remote given bybranch.<name>.remote. The merge information is used bygitpull(which first callsgitfetch) to lookup the default branch for merging. Without this option,gitpulldefaults to merge the first refspec fetched. Specify multiple values to get an octopus merge. If you wish to setupgitpullso that it merges into <name> from another branch in the local repository, you can pointbranch.<name>.mergeto the desired branch, and use the relative path setting.(a period) forbranch.<name>.remote. branch.<name>.mergeOptions-
Sets default options for merging into branch <name>. The syntax and supported options are the same as those of git-merge[1], but option values containing whitespace characters are currently not supported.
branch.<name>.rebase-
When true, rebase the branch <name> on top of the fetched branch, instead of merging the default branch from the default remote when
gitpullis run. Seepull.rebasefor doing this in a non branch-specific manner.When
merges(or justm), pass the--rebase-mergesoption togitrebaseso that the local merge commits are included in the rebase (see git-rebase[1] for details).When the value is
interactive(or justi), the rebase is run in interactive mode.NOTE: this is a possibly dangerous operation; do not use it unless you understand the implications (see git-rebase[1] for details).
branch.<name>.description-
Branch description, can be edited with
gitbranch--edit-description. Branch description is automatically added to theformat-patchcover letter orrequest-pullsummary. - browser.<tool>.cmd
-
Specify the command to invoke the specified browser. The specified command is evaluated in shell with the URLs passed as arguments. (See git-web--browse[1].)
- browser.<tool>.path
-
Override the path for the given tool that may be used to browse HTML help (see
-woption in git-help[1]) or a working repository in gitweb (see git-instaweb[1]). - bundle.*
-
The
bundle.*keys may appear in a bundle list file found via thegitclone--bundle-urioption. These keys currently have no effect if placed in a repository config file, though this will change in the future. See the bundle URI design document for more details. - bundle.version
-
This integer value advertises the version of the bundle list format used by the bundle list. Currently, the only accepted value is
1. - bundle.mode
-
This string value should be either
allorany. This value describes whether all of the advertised bundles are required to unbundle a complete understanding of the bundled information (all) or if any one of the listed bundle URIs is sufficient (any). - bundle.heuristic
-
If this string-valued key exists, then the bundle list is designed to work well with incremental
gitfetchcommands. The heuristic signals that there are additional keys available for each bundle that help determine which subset of bundles the client should download. The only value currently understood iscreationToken. - bundle.<id>.*
-
The
bundle.<id>.*keys are used to describe a single item in the bundle list, grouped under <id> for identification purposes. - bundle.<id>.uri
-
This string value defines the URI by which Git can reach the contents of this <id>. This URI may be a bundle file or another bundle list.
checkout.defaultRemote-
When you run
gitcheckout<something> orgitswitch<something> and only have one remote, it may implicitly fall back on checking out and tracking e.g.origin/<something>. This stops working as soon as you have more than one remote with a <something> reference. This setting allows for setting the name of a preferred remote that should always win when it comes to disambiguation. The typical use-case is to set this toorigin.Currently this is used by git-switch[1] and git-checkout[1] when
gitcheckout<something> orgitswitch<something> will checkout the <something> branch on another remote, and by git-worktree[1] whengitworktreeaddrefers to a remote branch. This setting might be used for other checkout-like commands or functionality in the future. checkout.guess-
Provides the default value for the
--guessor--no-guessoption ingitcheckoutandgitswitch. See git-switch[1] and git-checkout[1]. checkout.workers-
The number of parallel workers to use when updating the working tree. The default is one, i.e. sequential execution. If set to a value less than one, Git will use as many workers as the number of logical cores available. This setting and
checkout.thresholdForParallelismaffect all commands that perform checkout. E.g. checkout, clone, reset, sparse-checkout, etc.NoteParallel checkout usually delivers better performance for repositories located on SSDs or over NFS. For repositories on spinning disks and/or machines with a small number of cores, the default sequential checkout often performs better. The size and compression level of a repository might also influence how well the parallel version performs. checkout.thresholdForParallelism-
When running parallel checkout with a small number of files, the cost of subprocess spawning and inter-process communication might outweigh the parallelization gains. This setting allows you to define the minimum number of files for which parallel checkout should be attempted. The default is 100.
- clean.requireForce
-
A boolean to make git-clean refuse to delete files unless -f is given. Defaults to true.
clone.defaultRemoteName-
The name of the remote to create when cloning a repository. Defaults to
origin. It can be overridden by passing the--origincommand-line option to git-clone[1]. clone.rejectShallow-
Reject cloning a repository if it is a shallow one; this can be overridden by passing the
--reject-shallowoption on the command line. See git-clone[1]. clone.filterSubmodules-
If a partial clone filter is provided (see
--filterin git-rev-list[1]) and--recurse-submodulesis used, also apply the filter to submodules. - color.advice
-
A boolean to enable/disable color in hints (e.g. when a push failed, see
advice.*for a list). May be set toalways,false(ornever) orauto(ortrue), in which case colors are used only when the error output goes to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.advice.hint
-
Use customized color for hints.
- color.blame.highlightRecent
-
Specify the line annotation color for
gitblame--color-by-agedepending upon the age of the line.This setting should be set to a comma-separated list of color and date settings, starting and ending with a color, the dates should be set from oldest to newest. The metadata will be colored with the specified colors if the line was introduced before the given timestamp, overwriting older timestamped colors.
Instead of an absolute timestamp relative timestamps work as well, e.g.
2.weeks.agois valid to address anything older than 2 weeks.It defaults to
blue,12monthago,white,1monthago,red, which colors everything older than one year blue, recent changes between one month and one year old are kept white, and lines introduced within the last month are colored red. - color.blame.repeatedLines
-
Use the specified color to colorize line annotations for
gitblame--color-lines, if they come from the same commit as the preceding line. Defaults to cyan. - color.branch
-
A boolean to enable/disable color in the output of git-branch[1]. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the output is to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.branch.<slot>
-
Use customized color for branch coloration. <slot> is one of
current(the current branch),local(a local branch),remote(a remote-tracking branch in refs/remotes/),upstream(upstream tracking branch),plain(other refs). - color.diff
-
Whether to use ANSI escape sequences to add color to patches. If this is set to
always, git-diff[1], git-log[1], and git-show[1] will use color for all patches. If it is set totrueorauto, those commands will only use color when output is to the terminal. If unset, then the value ofcolor.uiis used (autoby default).This does not affect git-format-patch[1] or the git-diff-* plumbing commands. Can be overridden on the command line with the
--color[=<when>] option. - color.diff.<slot>
-
Use customized color for diff colorization. <slot> specifies which part of the patch to use the specified color, and is one of
context(context text -plainis a historical synonym),meta(metainformation),frag(hunk header), func (function in hunk header),old(removed lines),new(added lines),commit(commit headers),whitespace(highlighting whitespace errors),oldMoved(deleted lines),newMoved(added lines),oldMovedDimmed,oldMovedAlternative,oldMovedAlternativeDimmed,newMovedDimmed,newMovedAlternativenewMovedAlternativeDimmed(See the <mode> setting of --color-moved in git-diff[1] for details),contextDimmed,oldDimmed,newDimmed,contextBold,oldBold, andnewBold(see git-range-diff[1] for details). - color.decorate.<slot>
-
Use customized color for git log --decorate output. <slot> is one of
branch,remoteBranch,tag,stashorHEADfor local branches, remote-tracking branches, tags, stash and HEAD, respectively andgraftedfor grafted commits. - color.grep
-
When set to
always, always highlight matches. Whenfalse(ornever), never. When set totrueorauto, use color only when the output is written to the terminal. If unset, then the value ofcolor.uiis used (autoby default). - 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
context-
non-matching text in context lines (when using
-A,-B, or-C) filename-
filename prefix (when not using
-h) function-
function name lines (when using
-p) lineNumber-
line number prefix (when using
-n) column-
column number prefix (when using
--column) match-
matching text (same as setting
matchContextandmatchSelected) matchContext-
matching text in context lines
matchSelected-
matching text in selected lines. Also, used to customize the following git-log[1] subcommands:
--grep,--author, and--committer. selected-
non-matching text in selected lines. Also, used to customize the following git-log[1] subcommands:
--grep,--authorand--committer. separator-
separators between fields on a line (
:,-, and=) and between hunks (--)
- color.interactive
-
When set to
always, always use colors for interactive prompts and displays (such as those used by "git-add --interactive" and "git-clean --interactive"). When false (ornever), never. When set totrueorauto, use colors only when the output is to the terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.interactive.<slot>
-
Use customized color for git add --interactive and git clean --interactive output. <slot> may be
prompt,header,helporerror, for four distinct types of normal output from interactive commands. - color.pager
-
A boolean to specify whether
autocolor modes should colorize output going to the pager. Defaults to true; set this to false if your pager does not understand ANSI color codes. - color.push
-
A boolean to enable/disable color in push errors. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the error output goes to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.push.error
-
Use customized color for push errors.
- color.remote
-
If set, keywords at the start of the line are highlighted. The keywords are "error", "warning", "hint" and "success", and are matched case-insensitively. May be set to
always,false(ornever) orauto(ortrue). If unset, then the value ofcolor.uiis used (autoby default). - color.remote.<slot>
-
Use customized color for each remote keyword. <slot> may be
hint,warning,successorerrorwhich match the corresponding keyword. - color.showBranch
-
A boolean to enable/disable color in the output of git-show-branch[1]. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the output is to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.status
-
A boolean to enable/disable color in the output of git-status[1]. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the output is to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.status.<slot>
-
Use customized color for status colorization. <slot> is one of
header(the header text of the status message),addedorupdated(files which are added but not committed),changed(files which are changed but not added in the index),untracked(files which are not tracked by Git),branch(the current branch),nobranch(the color the no branch warning is shown in, defaulting to red),localBranchorremoteBranch(the local and remote branch names, respectively, when branch and tracking information is displayed in the status short-format), orunmerged(files which have unmerged changes). - color.transport
-
A boolean to enable/disable color when pushes are rejected. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the error output goes to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.transport.rejected
-
Use customized color when a push was rejected.
- color.ui
-
This variable determines the default value for variables such as
color.diffandcolor.grepthat control the use of color per command family. Its scope will expand as more commands learn configuration to set a default for the--coloroption. Set it tofalseorneverif you prefer Git commands not to use color unless enabled explicitly with some other configuration or the--coloroption. Set it toalwaysif you want all output not intended for machine consumption to use color, totrueorauto(this is the default since Git 1.8.4) if you want such output to use color when written to the terminal. - column.ui
-
Specify whether supported commands should output in columns. This variable consists of a list of tokens separated by spaces or commas:
These options control when the feature should be enabled (defaults to never):
These options control layout (defaults to column). Setting any of these implies always if none of always, never, or auto are specified.
Finally, these options can be combined with a layout option (defaults to nodense):
- column.branch
-
Specify whether to output branch listing in
gitbranchin columns. Seecolumn.uifor details. - column.clean
-
Specify the layout when listing items in
gitclean-i, which always shows files and directories in columns. Seecolumn.uifor details. - column.status
-
Specify whether to output untracked files in
gitstatusin columns. Seecolumn.uifor details. - column.tag
-
Specify whether to output tag listings in
gittagin columns. Seecolumn.uifor details.
commit.cleanup-
This setting overrides the default of the
--cleanupoption ingitcommit. See git-commit[1] for details. Changing the default can be useful when you always want to keep lines that begin with the comment character (core.commentChar, default#) in your log message, in which case you would dogitconfigcommit.cleanupwhitespace(note that you will have to remove the help lines that begin with the comment character in the commit log template yourself, if you do this). 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.
commit.status-
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. commit.template-
Specify the pathname of a file to use as the template for new commit messages.
commit.verbose-
A boolean or int to specify the level of verbosity with
gitcommit. See git-commit[1] for details. - commitGraph.generationVersion
-
Specifies the type of generation number version to use when writing or reading the commit-graph file. If version 1 is specified, then the corrected commit dates will not be written or read. Defaults to 2.
- commitGraph.maxNewFilters
-
Specifies the default value for the
--max-new-filtersoption ofgitcommit-graphwrite(c.f., git-commit-graph[1]). - commitGraph.changedPaths
-
If true, then
gitcommit-graphwritewill compute and write changed-path Bloom filters by default, equivalent to passing--changed-paths. If false or unset, changed-paths Bloom filters will be written duringgitcommit-graphwriteonly if the filters already exist in the current commit-graph file. This matches the default behavior ofgitcommit-graphwritewithout any--[no-]changed-pathsoption. To rewrite a commit-graph file without any filters, use the--no-changed-pathsoption. Command-line option--[no-]changed-pathsalways takes precedence over this configuration. Defaults to unset. - commitGraph.readChangedPaths
-
Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and commitGraph.changedPathsVersion=0 if false. (If commitGraph.changedPathVersion is also set, commitGraph.changedPathsVersion takes precedence.)
- commitGraph.changedPathsVersion
-
Specifies the version of the changed-path Bloom filters that Git will read and write. May be -1, 0, 1, or 2. Note that values greater than 1 may be incompatible with older versions of Git which do not yet understand those versions. Use caution when operating in a mixed-version environment.
Defaults to -1.
If -1, Git will use the version of the changed-path Bloom filters in the repository, defaulting to 1 if there are none.
If 0, Git will not read any Bloom filters, and will write version 1 Bloom filters when instructed to write.
If 1, Git will only read version 1 Bloom filters, and will write version 1 Bloom filters.
If 2, Git will only read version 2 Bloom filters, and will write version 2 Bloom filters.
See git-commit-graph[1] for more information.
- completion.commands
-
This is only used by git-completion.bash to add or remove commands from the list of completed commands. Normally only porcelain commands and a few select others are completed. You can add more commands, separated by space, in this variable. Prefixing the command with - will remove it from the existing list.
- core.fileMode
-
Tells Git if the executable bit of files in the working tree is to be honored.
Some filesystems lose the executable bit when a file that is marked as executable is checked out, or checks out a non-executable file with executable bit on. git-clone[1] or git-init[1] probe the filesystem to see if it handles the executable bit correctly and this variable is automatically set as necessary.
A repository, however, may be on a filesystem that handles the filemode correctly, and this variable is set to true when created, but later may be made accessible from another environment that loses the filemode (e.g. exporting ext4 via CIFS mount, visiting a Cygwin created repository with Git for Windows or Eclipse). In such a case it may be necessary to set this variable to false. See git-update-index[1].
The default is true (when core.filemode is not specified in the config file).
- core.hideDotFiles
-
(Windows-only) If true, mark newly-created directories and files whose name starts with a dot as hidden. If dotGitOnly, only the
.git/directory is hidden, but no other files starting with a dot. The default mode is dotGitOnly. - core.ignoreCase
-
Internal variable which enables various workarounds to enable Git to work better on filesystems that are not case sensitive, like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing finds "makefile" when Git expects "Makefile", Git will assume it is really the same file, and continue to remember it as "Makefile".
The default is false, except git-clone[1] or git-init[1] will probe and set core.ignoreCase true if appropriate when the repository is created.
Git relies on the proper configuration of this variable for your operating and file system. Modifying this value may result in unexpected behavior.
- core.precomposeUnicode
-
This option is only used by Mac OS implementation of Git. When core.precomposeUnicode=true, Git reverts the unicode decomposition of filenames done by Mac OS. This is useful when sharing a repository between Mac OS and Linux or Windows. (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.
- core.protectHFS
-
If set to true, do not allow checkout of paths that would be considered equivalent to
.giton an HFS+ filesystem. Defaults totrueon Mac OS, andfalseelsewhere. - core.protectNTFS
-
If set to true, do not allow checkout of paths that would cause problems with the NTFS filesystem, e.g. conflict with 8.3 "short" names. Defaults to
trueon Windows, andfalseelsewhere. - core.fsmonitor
-
If set to true, enable the built-in file system monitor daemon for this working directory (git-fsmonitor--daemon[1]).
Like hook-based file system monitors, the built-in file system monitor can speed up Git commands that need to refresh the Git index (e.g.
gitstatus) in a working directory with many files. The built-in monitor eliminates the need to install and maintain an external third-party tool.The built-in file system monitor is currently available only on a limited set of supported platforms. Currently, this includes Windows and MacOS.
Otherwise, this variable contains the pathname of the "fsmonitor" hook command.
This hook command is used to identify all files that may have changed since the requested date/time. This information is used to speed up git by avoiding unnecessary scanning of files that have not changed.
See the "fsmonitor-watchman" section of githooks[5].
Note that if you concurrently use multiple versions of Git, such as one version on the command line and another version in an IDE tool, that the definition of
core.fsmonitorwas extended to allow boolean values in addition to hook pathnames. Git versions 2.35.1 and prior will not understand the boolean values and will consider the "true" or "false" values as hook pathnames to be invoked. Git versions 2.26 thru 2.35.1 default to hook protocol V2 and will fall back to no fsmonitor (full scan). Git versions prior to 2.26 default to hook protocol V1 and will silently assume there were no changes to report (no scan), so status commands may report incomplete results. For this reason, it is best to upgrade all of your Git versions before using the built-in file system monitor. - core.fsmonitorHookVersion
-
Sets the protocol version to be used when invoking the "fsmonitor" hook.
There are currently versions 1 and 2. When this is not set, version 2 will be tried first and if it fails then version 1 will be tried. Version 1 uses a timestamp as input to determine which files have changes since that time but some monitors like Watchman have race conditions when used with a timestamp. Version 2 uses an opaque string so that the monitor can return something that can be used to determine what files have changed without race conditions.
- core.trustctime
-
If false, the ctime differences between the index and the working tree are ignored; useful when the inode change time is regularly modified by something outside Git (file system crawlers and some backup systems). See git-update-index[1]. True by default.
- core.splitIndex
-
If true, the split-index feature of the index will be used. See git-update-index[1]. False by default.
- core.untrackedCache
-
Determines what to do about the untracked cache feature of the index. It will be kept, if this variable is unset or set to
keep. It will automatically be added if set totrue. And it will automatically be removed, if set tofalse. Before setting it totrue, you should check that mtime is working properly on your system. See git-update-index[1].keepby default, unlessfeature.manyFilesis enabled which sets this setting totrueby default. - core.checkStat
-
When missing or is set to
default, many fields in the stat structure are checked to detect if a file has been modified since Git looked at it. When this configuration variable is set tominimal, sub-second part of mtime and ctime, the uid and gid of the owner of the file, the inode number (and the device number, if Git was compiled to use it), are excluded from the check among these fields, leaving only the whole-second part of mtime (and ctime, ifcore.trustCtimeis set) and the filesize to be checked.There are implementations of Git that do not leave usable values in some fields (e.g. JGit); by excluding these fields from the comparison, the
minimalmode may help interoperability when the same repository is used by these other systems at the same time. - core.quotePath
-
Commands that output paths (e.g. ls-files, diff), will quote "unusual" characters in the pathname by enclosing the pathname in double-quotes and escaping those characters with backslashes in the same way C escapes control characters (e.g. \t for TAB, \n for LF, \\ for backslash) or bytes with values larger than 0x80 (e.g. octal \302\265 for "micro" in UTF-8). If this variable is set to false, bytes higher than 0x80 are not considered "unusual" any more. Double-quotes, backslash and control characters are always escaped regardless of the setting of this variable. A simple space character is not considered "unusual". Many commands can output pathnames completely verbatim using the
-zoption. The default value is true. - core.eol
-
Sets the line ending type to use in the working directory for files that are marked as text (either by having the
textattribute set, or by havingtext=autoand Git auto-detecting the contents as text). Alternatives are lf, crlf and native, which uses the platform’s native line ending. The default value isnative. See gitattributes[5] for more information on end-of-line conversion. Note that this value is ignored ifcore.autocrlfis set totrueorinput. - core.safecrlf
-
If true, makes Git check if converting
CRLFis reversible when end-of-line conversion is active. Git will verify if a command 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 ofcore.autocrlf, Git will reject the file. The variable can be set to "warn", in which case Git will only warn about an irreversible conversion but continue the operation.CRLF conversion bears a slight chance of corrupting data. When it is enabled, Git 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.
Note, this safety check does not mean that a checkout will generate a file identical to the original file for a different setting of
core.eolandcore.autocrlf, but only for the current one. For example, a text file withLFwould be accepted withcore.eol=lfand could later be checked out withcore.eol=crlf, in which case the resulting file would containCRLF, although the original file containedLF. However, in both work trees the line endings would be consistent, that is either allLFor allCRLF, but never mixed. A file with mixed line endings would be reported by thecore.safecrlfmechanism. - core.autocrlf
-
Setting this variable to "true" is the same as setting the
textattribute to "auto" on all files and core.eol to "crlf". Set to true if you want to haveCRLFline endings in your working directory and the repository has LF line endings. This variable can be set to input, in which case no output conversion is performed. - core.checkRoundtripEncoding
-
A comma and/or whitespace separated list of encodings that Git performs UTF-8 round trip checks on if they are used in an
working-tree-encodingattribute (see gitattributes[5]). The default value isSHIFT-JIS. - core.symlinks
-
If false, symbolic links are checked out as small plain files that contain the link text. git-update-index[1] and git-add[1] will not change the recorded type to regular file. Useful on filesystems like FAT that do not support symbolic links.
The default is true, except git-clone[1] or git-init[1] will probe and set core.symlinks false if appropriate when the repository is created.
- core.gitProxy
-
A "proxy command" to execute (as command host port) instead of establishing direct connection to the remote server when using the Git protocol for fetching. If the variable value is 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.
Can be overridden by the
GIT_PROXY_COMMANDenvironment variable (which always applies universally, without the special "for" handling).The special string
nonecan 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. - core.sshCommand
-
If this variable is set,
gitfetchandgitpushwill use the specified command instead ofsshwhen they need to connect to a remote system. The command is in the same form as theGIT_SSH_COMMANDenvironment variable and is overridden when the environment variable is set. - core.ignoreStat
-
If true, Git will avoid using lstat() calls to detect if files have changed by setting the "assume-unchanged" bit for those tracked files which it has updated identically in both the index and working tree.
When files are modified outside of Git, the user will need to stage the modified files explicitly (e.g. see Examples section in git-update-index[1]). Git will not normally detect changes to those files.
This is useful on systems where lstat() calls are very slow, such as CIFS/Microsoft Windows.
False by default.
- 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.
This configuration is deprecated and will be removed in Git 3.0. Symbolic refs will always be written as textual symrefs.
- core.alternateRefsCommand
-
When advertising tips of available history from an alternate, use the shell to execute the specified command instead of git-for-each-ref[1]. The first argument is the absolute path of the alternate. Output must contain one hex object id per line (i.e., the same as produced by
gitfor-each-ref--format='%(objectname)).Note that you cannot generally put
gitfor-each-refdirectly into the config value, as it does not take a repository path as an argument (but you can wrap the command above in a shell script). - core.alternateRefsPrefixes
-
When listing references from an alternate, list only references that begin with the given prefix. Prefixes match as if they were given as arguments to git-for-each-ref[1]. To list multiple prefixes, separate them with whitespace. If
core.alternateRefsCommandis set, settingcore.alternateRefsPrefixeshas no effect. - 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 disabled, such as git-add[1] or git-merge[1].
This setting is automatically guessed by git-clone[1] or git-init[1] when the repository was created. By default a repository that ends in "/.git" is assumed to be not bare (bare = false), while all other repositories are assumed to be bare (bare = true).
- core.worktree
-
Set the path to the root of the working tree. If
GIT_COMMON_DIRenvironment variable is set, core.worktree is ignored and not used for determining the root of working tree. This can be overridden by theGIT_WORK_TREEenvironment variable and the--work-treecommand-line option. The value can be an absolute path or relative to the path to the .git directory, which is either specified by --git-dir or GIT_DIR, or automatically discovered. If --git-dir or GIT_DIR is specified but none of --work-tree, GIT_WORK_TREE and core.worktree is specified, the current working directory is regarded as the top level of your working tree.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 misconfiguration. Running Git commands in the "/path/to" directory will 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).
- core.logAllRefUpdates
-
Enable the reflog. Updates to a ref <ref> is logged to the file "
$GIT_DIR/logs/<ref>", by appending the new and old SHA-1, the date/time and the reason of the update, but only when the file exists. If this configuration variable is set totrue, missing "$GIT_DIR/logs/<ref>" file is automatically created for branch heads (i.e. underrefs/heads/), remote refs (i.e. underrefs/remotes/), note refs (i.e. underrefs/notes/), and the symbolic refHEAD. If it is set toalways, then a missing reflog is automatically created for any ref underrefs/.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.
- core.repositoryFormatVersion
-
Internal variable identifying the repository format and layout version. See gitrepository-layout[5].
-
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 group-shareable. When umask (or false), Git will use permissions reported by umask(2). When 0xxx, where 0xxx is an octal number, files in the repository will have this mode value. 0xxx will override 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 repository that is group-readable but not group-writable. See git-init[1]. False by default.
- core.warnAmbiguousRefs
-
If true, Git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the repository. True by default.
- core.compression
-
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. If set, this provides a default to other compression variables, such as
core.looseCompressionandpack.compression. - core.looseCompression
-
An integer -1..9, indicating the compression level for objects that are not 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 not set, defaults to 1 (best speed).
- 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 performance due to increased calls to the operating system’s memory manager, but may improve performance when accessing 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.
Common unit suffixes of k, m, or g are supported.
- 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.
Default is 256 MiB on 32 bit platforms and 32 TiB (effectively unlimited) 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.
Common unit suffixes of k, m, or g are supported.
- core.deltaBaseCacheLimit
-
Maximum number of bytes per thread to reserve for caching base objects that may be referenced by multiple deltified objects. By storing the entire decompressed base objects in a cache Git is able to avoid unpacking and decompressing frequently used base objects multiple times.
Default is 96 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.
- core.bigFileThreshold
-
The size of files considered "big", which as discussed below changes the behavior of numerous git commands, as well as how such files are stored within the repository. The default is 512 MiB. Common unit suffixes of k, m, or g are supported.
Files above the configured limit will be:
-
Stored deflated in packfiles, without attempting delta compression.
The default limit is primarily set with this use-case in mind. With it, most projects will have their source code and other text files delta compressed, but not larger binary media files.
Storing large files without delta compression avoids excessive memory usage, at the slight expense of increased disk usage.
-
Will be treated as if they were labeled "binary" (see gitattributes[5]). e.g. git-log[1] and git-diff[1] will not compute diffs for files above this limit.
-
Will generally be streamed when written, which avoids excessive memory usage, at the cost of some fixed overhead. Commands that make use of this include git-archive[1], git-fast-import[1], git-index-pack[1], git-unpack-objects[1] and git-fsck[1].
-
- core.excludesFile
-
Specifies the pathname to the file that contains patterns to describe paths that are not meant to be tracked, in addition to
.gitignore(per-directory) and.git/info/exclude. Defaults to$XDG_CONFIG_HOME/git/ignore. If$XDG_CONFIG_HOMEis either not set or empty,$HOME/.config/git/ignoreis used instead. See gitignore[5]. - core.askPass
-
Some commands (e.g. svn and http interfaces) that interactively ask for a password can be told to use an external program given via the value of this variable. Can be overridden by the
GIT_ASKPASSenvironment variable. If not set, fall back to the value of theSSH_ASKPASSenvironment 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. - core.attributesFile
-
In addition to
.gitattributes(per-directory) and.git/info/attributes, Git looks into this file for attributes (see gitattributes[5]). Path expansions are made the same way as forcore.excludesFile. Its default value is$XDG_CONFIG_HOME/git/attributes. If$XDG_CONFIG_HOMEis either not set or empty,$HOME/.config/git/attributesis used instead. - core.hooksPath
-
By default Git will look for your hooks in the
$GIT_DIR/hooksdirectory. Set this to different path, e.g./etc/git/hooks, and Git will try to find your hooks in that directory, e.g./etc/git/hooks/pre-receiveinstead of in$GIT_DIR/hooks/pre-receive.The path can be either absolute or relative. A relative path is taken as relative to the directory where the hooks are run (see the "DESCRIPTION" section of githooks[5]).
This configuration variable is useful in cases where you’d like to centrally configure your Git hooks instead of configuring them on a per-repository basis, or as a more flexible and centralized alternative to having an
init.templateDirwhere you’ve changed default hooks.You can also disable all hooks entirely by setting
core.hooksPathto/dev/null. This is usually only advisable for expert users and on a per-command basis using configuration parameters of the formgit-ccore.hooksPath=/dev/null.... - core.editor
-
Commands such as
commitandtagthat let you edit messages by launching an editor use the value of this variable when it is set, and the environment variableGIT_EDITORis not set. See git-var[1]. - core.commentChar
- core.commentString
-
Commands such as
commitandtagthat let you edit messages consider a line that begins with this character commented, and removes them after the editor returns (default #).If set to "auto",
git-commitwill select a character that is not the beginning character of any line in existing commit messages. Support for this value is deprecated and will be removed in Git 3.0 due to the following limitations:-
It is incompatible with adding comments in a commit message template. This includes the conflicts comments added to the commit message by
cherry-pick,merge,rebaseandrevert. -
It is incompatible with adding comments to the commit message in the
prepare-commit-msghook. -
It is incompatible with the
fixupandsquashcommands when rebasing, -
It is not respected by
gitnotes
Note that these two variables are aliases of each other, and in modern versions of Git you are free to use a string (e.g.,
//or ⁑⁕⁑) withcommentChar. Versions of Git prior to v2.45.0 will ignorecommentStringbut will reject a value ofcommentCharthat consists of more than a single ASCII byte. If you plan to use your config with older and newer versions of Git, you may want to specify both:[core] # single character for older versions commentChar = "#" # string for newer versions (which will override commentChar # because it comes later in the file) commentString = "//"
-
- core.filesRefLockTimeout
-
The length of time, in milliseconds, to retry when trying to lock an individual reference. Value 0 means not to retry at all; -1 means to try indefinitely. Default is 100 (i.e., retry for 100ms).
- core.packedRefsTimeout
-
The length of time, in milliseconds, to retry when trying to lock the
packed-refsfile. Value 0 means not to retry at all; -1 means to try indefinitely. Default is 1000 (i.e., retry for 1 second). - core.pager
-
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_PAGERenvironment variable, thencore.pagerconfiguration, then$PAGER, and then the default chosen at compile time (usually less).When the
LESSenvironment variable is unset, Git sets it toFRX(ifLESSenvironment variable is set, Git does not change it at all). If you want to selectively override Git’s default setting forLESS, you can setcore.pagerto e.g.less-S. This will be passed to the shell by Git, which will translate the final command toLESS=FRXless-S. The environment does not set theSoption but the command line does, instructing less to truncate long lines. Similarly, settingcore.pagertoless-+Fwill deactivate theFoption specified by the environment from the command-line, deactivating the "quit if one screen" behavior ofless. One can specifically activate some flags for particular commands: for example, settingpager.blametoless-Senables line truncation only forgitblame.Likewise, when the
LVenvironment variable is unset, Git sets it to-c. You can override this setting by exportingLVwith another value or settingcore.pagertolv+c. - core.whitespace
-
A comma separated list of common whitespace problems to notice. git diff will use
color.diff.whitespaceto highlight them, and git apply --whitespace=error will consider them as errors. You can prefix-to disable any of them (e.g.-trailing-space):-
blank-at-eoltreats trailing whitespaces at the end of the line as an error (enabled by default). -
space-before-tabtreats a space character that appears immediately before a tab character in the initial indent part of the line as an error (enabled by default). -
indent-with-non-tabtreats a line that is indented with space characters instead of the equivalent tabs as an error (not enabled by default). -
tab-in-indenttreats a tab character in the initial indent part of the line as an error (not enabled by default). -
blank-at-eoftreats blank lines added at the end of file as an error (enabled by default). -
trailing-spaceis a short-hand to cover bothblank-at-eolandblank-at-eof. -
cr-at-eoltreats a carriage-return at the end of line as part of the line terminator, i.e. with it,trailing-spacedoes not trigger if the character before such a carriage-return is not a whitespace (not enabled by default). -
tabwidth=<n> tells how many character positions a tab occupies; this is relevant forindent-with-non-taband when Git fixestab-in-indenterrors. The default tab width is 8. Allowed values are 1 to 63.
-
- core.fsync
-
A comma-separated list of components of the repository that should be hardened via the core.fsyncMethod when created or modified. You can disable hardening of any component by prefixing it with a -. Items that are not hardened may be lost in the event of an unclean system shutdown. Unless you have special requirements, it is recommended that you leave this option empty or pick one of
committed,added, orall.When this configuration is encountered, the set of components starts with the platform default value, disabled components are removed, and additional components are added.
noneresets the state so that the platform default is ignored.The empty string resets the fsync configuration to the platform default. The default on most platforms is equivalent to
core.fsync=committed,-loose-object, which has good performance, but risks losing recent work in the event of an unclean system shutdown.-
noneclears the set of fsynced components. -
loose-objecthardens objects added to the repo in loose-object form. -
packhardens objects added to the repo in packfile form. -
pack-metadatahardens packfile bitmaps and indexes. -
commit-graphhardens the commit-graph file. -
indexhardens the index when it is modified. -
objectsis an aggregate option that is equivalent toloose-object,pack. -
referencehardens references modified in the repo. -
derived-metadatais an aggregate option that is equivalent topack-metadata,commit-graph. -
committedis an aggregate option that is currently equivalent toobjects. This mode sacrifices some performance to ensure that work that is committed to the repository withgitcommitor similar commands is hardened. -
addedis an aggregate option that is currently equivalent tocommitted,index. This mode sacrifices additional performance to ensure that the results of commands likegitaddand similar operations are hardened. -
allis an aggregate option that syncs all individual components above.
-
- core.fsyncMethod
-
A value indicating the strategy Git will use to harden repository data using fsync and related primitives.
-
fsyncuses the fsync() system call or platform equivalents. -
writeout-onlyissues pagecache writeback requests, but depending on the filesystem and storage hardware, data added to the repository may not be durable in the event of a system crash. This is the default mode on macOS. -
batchenables a mode that uses writeout-only flushes to stage multiple updates in the disk writeback cache and then does a single full fsync of a dummy file to trigger the disk cache flush at the end of the operation.Currently
batchmode only applies to loose-object files. Other repository data is made durable as iffsyncwas specified. This mode is expected to be as safe asfsyncon macOS for repos stored on HFS+ or APFS filesystems and on Windows for repos stored on NTFS or ReFS filesystems.
-
- core.fsyncObjectFiles
-
This boolean will enable fsync() when writing object files. This setting is deprecated. Use core.fsync instead.
This setting affects data added to the Git repository in loose-object form. When set to true, Git will issue an fsync or similar system call to flush caches so that loose-objects remain consistent in the face of a unclean system shutdown.
- 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 relatively high IO latencies. When enabled, Git will do the index comparison to the filesystem data in parallel, allowing overlapping IO’s. Defaults to true.
- core.unsetenvvars
-
Windows-only: comma-separated list of environment variables' names that need to be unset before spawning any other process. Defaults to
PERL5LIBto account for the fact that Git for Windows insists on using its own Perl interpreter. - 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.
- core.notesRef
-
When showing commit messages, also show notes which are stored in 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.
This setting defaults to "refs/notes/commits", and it can be overridden by the
GIT_NOTES_REFenvironment variable. See git-notes[1]. - core.commitGraph
-
If true, then git will read the commit-graph file (if it exists) to parse the graph structure of commits. Defaults to true. See git-commit-graph[1] for more information.
- core.useReplaceRefs
-
If set to
false, behave as if the--no-replace-objectsoption was given on the command line. See git[1] and git-replace[1] for more information. - core.multiPackIndex
-
Use the multi-pack-index file to track multiple packfiles using a single index. See git-multi-pack-index[1] for more information. Defaults to true.
- core.sparseCheckout
-
Enable "sparse checkout" feature. See git-sparse-checkout[1] for more information.
- core.sparseCheckoutCone
-
Enables the "cone mode" of the sparse checkout feature. When the sparse-checkout file contains a limited set of patterns, this mode provides significant performance advantages. The "non-cone mode" can be requested to allow specifying more flexible patterns by setting this variable to false. See git-sparse-checkout[1] for more information.
- core.abbrev
-
Set the length object names are abbreviated to. If unspecified or set to "auto", an appropriate value is computed based on the approximate number of packed objects in your repository, which hopefully is enough for abbreviated object names to stay unique for some time. If set to "no", no abbreviation is made and the object names are shown in their full length. The minimum length is 4.
- core.maxTreeDepth
-
The maximum depth Git is willing to recurse while traversing a tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe to allow Git to abort cleanly, and should not generally need to be adjusted. When Git is compiled with MSVC, the default is 512. Otherwise, the default is 2048.
- 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. This is normally the name of a credential helper with possible arguments, but may also be an absolute path with arguments or, if preceded by
!, shell commands.Note that multiple helpers may be defined. See gitcredentials[7] for details and examples.
- credential.interactive
-
By default, Git and any configured credential helpers will ask for user input when new credentials are required. Many of these helpers will succeed based on stored credentials if those credentials are still valid. To avoid the possibility of user interactivity from Git, set
credential.interactive=false. Some credential helpers respect this option as well. - credential.useHttpPath
-
When acquiring credentials, consider the "path" component of an http or https URL to be important. Defaults to false. See gitcredentials[7] for more information.
- credential.sanitizePrompt
-
By default, user names and hosts that are shown as part of the password prompt are not allowed to contain control characters (they will be URL-encoded by default). Configure this setting to
falseto override that behavior. - credential.protectProtocol
-
By default, Carriage Return characters are not allowed in the protocol that is used when Git talks to a credential helper. This setting allows users to override this default.
- credential.username
-
If no username is set for a network authentication, use this username by default. See credential.<context>.* below, and 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 gitcredentials[7] for details on how URLs are matched.
- credentialCache.ignoreSIGHUP
-
Tell git-credential-cache—daemon to ignore SIGHUP, instead of quitting.
- credentialStore.lockTimeoutMS
-
The length of time, in milliseconds, for git-credential-store to retry when trying to lock the credentials file. A value of 0 means not to retry at all; -1 means to try indefinitely. Default is 1000 (i.e., retry for 1s).
diff.autoRefreshIndex-
When using
gitdiffto compare with work tree files, do not consider stat-only changes as changed. Instead, silently rungitupdate-index--refreshto update the cached stat information for paths whose contents in the work tree match the contents in the index. This option defaults totrue. Note that this affects onlygitdiffPorcelain, and not lower leveldiffcommands such asgitdiff-files. diff.dirstat-
A comma separated list of
--dirstatparameters specifying the default behavior of the--dirstatoption to git-diff[1] and friends. The defaults can be overridden on the command line (using--dirstat=<param>,...). The fallback defaults (when not changed bydiff.dirstat) arechanges,noncumulative,3. The following parameters are available:changes-
Compute the dirstat numbers by counting the lines that have been removed from the source, or added to the destination. This ignores the amount of pure code movements within a file. In other words, rearranging lines in a file is not counted as much as other changes. This is the default behavior when no parameter is given.
lines-
Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no natural concept of lines). This is a more expensive
--dirstatbehavior than thechangesbehavior, but it does count rearranged lines within a file as much as other changes. The resulting output is consistent with what you get from the other--*statoptions. files-
Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is the computationally cheapest
--dirstatbehavior, since it does not have to look at the file contents at all. cumulative-
Count changes in a child directory for the parent directory as well. Note that when using
cumulative, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can be specified with thenoncumulativeparameter. - <limit>
-
An integer parameter specifies a cut-off percent (3% by default). Directories contributing less than this percentage of the changes are not shown in the output.
Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories:
files,10,cumulative. diff.statNameWidth-
Limit the width of the filename part in
--statoutput. If set, applies to all commands generating--statoutput exceptformat-patch. diff.statGraphWidth-
Limit the width of the graph part in
--statoutput. If set, applies to all commands generating--statoutput exceptformat-patch. diff.context-
Generate diffs with <n> lines of context instead of the default of 3. This value is overridden by the
-Uoption. diff.interHunkContext-
Show the context between diff hunks, up to the specified number of lines, thereby fusing the hunks that are close to each other. This value serves as the default for the
--inter-hunk-contextcommand line option. diff.external-
If this config variable is set, diff generation is not performed using the internal diff machinery, but using the given command. Can be overridden with the
GIT_EXTERNAL_DIFFenvironment variable. The command is called with parameters as described under "git Diffs" in git[1]. Note: if you want to use an external diff program only on a subset of your files, you might want to use gitattributes[5] instead. diff.trustExitCode-
If this boolean value is set to
truethen thediff.externalcommand is expected to return exit code 0 if it considers the input files to be equal or 1 if it considers them to be different, likediff(1). If it is set tofalse, which is the default, then the command is expected to return exit code0regardless of equality. Any other exit code causes Git to report a fatal error. diff.ignoreSubmodules-
Sets the default value of
--ignore-submodules. Note that this affects onlygitdiffPorcelain, and not lower leveldiffcommands such asgitdiff-files.gitcheckoutandgitswitchalso honor this setting when reporting uncommitted changes. Setting it toalldisables the submodule summary normally shown bygitcommitandgitstatuswhenstatus.submoduleSummaryis set unless it is overridden by using the--ignore-submodulescommand-line option. Thegitsubmodulecommands are not affected by this setting. By default this is set to untracked so that any untracked submodules are ignored. diff.mnemonicPrefix-
If set,
gitdiffuses a prefix pair that is different from the standarda/andb/depending on what is being compared. When this configuration is in effect, reverse diff output also swaps the order of the prefixes:gitdiff-
compares the (i)ndex and the (w)ork tree;
gitdiffHEAD-
compares a (c)ommit and the (w)ork tree;
gitdiff--cached-
compares a (c)ommit and the (i)ndex;
gitdiffHEAD:<file1> <file2>-
compares an (o)bject and a (w)ork tree entity;
gitdiff--no-index<a> <b>-
compares two non-git things <a> and <b>.
diff.noPrefix-
If set,
gitdiffdoes not show any source or destination prefix. diff.srcPrefix-
If set,
gitdiffuses this source prefix. Defaults toa/. diff.dstPrefix-
If set,
gitdiffuses this destination prefix. Defaults tob/. diff.relative-
If set to
true,gitdiffdoes not show changes outside of the directory and show pathnames relative to the current directory. diff.orderFile-
File indicating how to order files within a diff. See the
-Ooption to git-diff[1] for details. Ifdiff.orderFileis a relative pathname, it is treated as relative to the top of the working tree. diff.renameLimit-
The number of files to consider in the exhaustive portion of copy/rename detection; equivalent to the
gitdiffoption-l. If not set, the default value is currently 1000. This setting has no effect if rename detection is turned off. diff.renames-
Whether and how Git detects renames. If set to
false, rename detection is disabled. If set totrue, basic rename detection is enabled. If set tocopiesorcopy, Git will detect copies, as well. Defaults totrue. Note that this affects onlygitdiffPorcelain like git-diff[1] and git-log[1], and not lower level commands such as git-diff-files[1].