1GIT-CONFIG(1) Git Manual GIT-CONFIG(1)
2
6 git-config - Get and set repository or global options
7
9 git config [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]]
10 git config [<file-option>] [--type=<type>] --add <name> <value>
11 git config [<file-option>] [--type=<type>] [--fixed-value] --replace-all <name> <value> [<value-pattern>]
12 git config [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get <name> [<value-pattern>]
13 git config [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all <name> [<value-pattern>]
14 git config [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp <name-regex> [<value-pattern>]
15 git config [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch <name> <URL>
16 git config [<file-option>] [--fixed-value] --unset <name> [<value-pattern>]
17 git config [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>]
18 git config [<file-option>] --rename-section <old-name> <new-name>
19 git config [<file-option>] --remove-section <name>
20 git config [<file-option>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
21 git config [<file-option>] --get-color <name> [<default>]
22 git config [<file-option>] --get-colorbool <name> [<stdout-is-tty>]
23 git config [<file-option>] -e | --edit
24
26 You can query/set/replace/unset options with this command. The name is
27 actually the section and the key separated by a dot, and the value will
28 be escaped.
29 Multiple lines can be added to an option by using the --add option. If
31 you want to update or unset an option which can occur on multiple
32 lines, a value-pattern (which is an extended regular expression, unless
33 the --fixed-value option is given) needs to be given. Only the existing
34 values that match the pattern are updated or unset. If you want to
35 handle the lines that do not match the pattern, just prepend a single
36 exclamation mark in front (see also the section called “EXAMPLES”), but
37 note that this only works when the --fixed-value option is not in use.
38 The --type=<type> option instructs git config to ensure that incoming
40 and outgoing values are canonicalize-able under the given <type>. If no
41 --type=<type> is given, no canonicalization will be performed. Callers
42 may unset an existing --type specifier with --no-type.
43 When reading, the values are read from the system, global and
45 repository local configuration files by default, and options --system,
46 --global, --local, --worktree and --file <filename> can be used to tell
47 the command to read from only that location (see the section called
48 “FILES”).
49 When writing, the new value is written to the repository local
51 configuration file by default, and options --system, --global,
52 --worktree, --file <filename> can be used to tell the command to write
53 to that location (you can say --local but that is the default).
54 This command will fail with non-zero status upon error. Some exit codes
56 are:
57 • The section or key is invalid (ret=1),
59 • no section or name was provided (ret=2),
61 • the config file is invalid (ret=3),
63 • the config file cannot be written (ret=4),
65 • you try to unset an option which does not exist (ret=5),
67 • you try to unset/set an option for which multiple lines match
69 (ret=5), or
70 • you try to use an invalid regexp (ret=6).
72 On success, the command returns the exit code 0.
74 A list of all available configuration variables can be obtained using
76 the git help --config command.
77
79 --replace-all
80 Default behavior is to replace at most one line. This replaces all
81 lines matching the key (and optionally the value-pattern).
82 --add
84 Adds a new line to the option without altering any existing values.
85 This is the same as providing ^$ as the value-pattern in
86 --replace-all.
87 --get
89 Get the value for a given key (optionally filtered by a regex
90 matching the value). Returns error code 1 if the key was not found
91 and the last value if multiple key values were found.
92 --get-all
94 Like get, but returns all values for a multi-valued key.
95 --get-regexp
97 Like --get-all, but interprets the name as a regular expression and
98 writes out the key names. Regular expression matching is currently
99 case-sensitive and done against a canonicalized version of the key
100 in which section and variable names are lowercased, but subsection
101 names are not.
102 --get-urlmatch <name> <URL>
104 When given a two-part name section.key, the value for
105 section.<URL>.key whose <URL> part matches the best to the given
106 URL is returned (if no such key exists, the value for section.key
107 is used as a fallback). When given just the section as name, do so
108 for all the keys in the section and list them. Returns error code 1
109 if no value is found.
110 --global
112 For writing options: write to global ~/.gitconfig file rather than
113 the repository .git/config, write to $XDG_CONFIG_HOME/git/config
114 file if this file exists and the ~/.gitconfig file doesn’t.
115 For reading options: read only from global ~/.gitconfig and from
117 $XDG_CONFIG_HOME/git/config rather than from all available files.
118 See also the section called “FILES”.
120 --system
122 For writing options: write to system-wide $(prefix)/etc/gitconfig
123 rather than the repository .git/config.
124 For reading options: read only from system-wide
126 $(prefix)/etc/gitconfig rather than from all available files.
127 See also the section called “FILES”.
129 --local
131 For writing options: write to the repository .git/config file. This
132 is the default behavior.
133 For reading options: read only from the repository .git/config
135 rather than from all available files.
136 See also the section called “FILES”.
138 --worktree
140 Similar to --local except that $GIT_DIR/config.worktree is read
141 from or written to if extensions.worktreeConfig is enabled. If not
142 it’s the same as --local. Note that $GIT_DIR is equal to
143 $GIT_COMMON_DIR for the main working tree, but is of the form
144 $GIT_DIR/worktrees/<id>/ for other working trees. See git-
145 worktree(1) to learn how to enable extensions.worktreeConfig.
146 -f <config-file>, --file <config-file>
148 For writing options: write to the specified file rather than the
149 repository .git/config.
150 For reading options: read only from the specified file rather than
152 from all available files.
153 See also the section called “FILES”.
155 --blob <blob>
157 Similar to --file but use the given blob instead of a file. E.g.
158 you can use master:.gitmodules to read values from the file
159 .gitmodules in the master branch. See "SPECIFYING REVISIONS"
160 section in gitrevisions(7) for a more complete list of ways to
161 spell blob names.
162 --remove-section
164 Remove the given section from the configuration file.
165 --rename-section
167 Rename the given section to a new name.
168 --unset
170 Remove the line matching the key from config file.
171 --unset-all
173 Remove all lines matching the key from config file.
174 -l, --list
176 List all variables set in config file, along with their values.
177 --fixed-value
179 When used with the value-pattern argument, treat value-pattern as
180 an exact string instead of a regular expression. This will restrict
181 the name/value pairs that are matched to only those where the value
182 is exactly equal to the value-pattern.
183 --type <type>
185 git config will ensure that any input or output is valid under the
186 given type constraint(s), and will canonicalize outgoing values in
187 <type>'s canonical form.
188 Valid <type>'s include:
190 • bool: canonicalize values as either "true" or "false".
192 • int: canonicalize values as simple decimal numbers. An optional
194 suffix of k, m, or g will cause the value to be multiplied by
195 1024, 1048576, or 1073741824 upon input.
196 • bool-or-int: canonicalize according to either bool or int, as
198 described above.
199 • path: canonicalize by adding a leading ~ to the value of $HOME
201 and ~user to the home directory for the specified user. This
202 specifier has no effect when setting the value (but you can use
203 git config section.variable ~/ from the command line to let
204 your shell do the expansion.)
205 • expiry-date: canonicalize by converting from a fixed or
207 relative date-string to a timestamp. This specifier has no
208 effect when setting the value.
209 • color: When getting a value, canonicalize by converting to an
211 ANSI color escape sequence. When setting a value, a
212 sanity-check is performed to ensure that the given value is
213 canonicalize-able as an ANSI color, but it is written as-is.
214 --bool, --int, --bool-or-int, --path, --expiry-date
216 Historical options for selecting a type specifier. Prefer instead
217 --type (see above).
218 --no-type
220 Un-sets the previously set type specifier (if one was previously
221 set). This option requests that git config not canonicalize the
222 retrieved variable. --no-type has no effect without --type=<type>
223 or --<type>.
224 -z, --null
226 For all options that output values and/or keys, always end values
227 with the null character (instead of a newline). Use newline instead
228 as a delimiter between key and value. This allows for secure
229 parsing of the output without getting confused e.g. by values that
230 contain line breaks.
231 --name-only
233 Output only the names of config variables for --list or
234 --get-regexp.
235 --show-origin
237 Augment the output of all queried config options with the origin
238 type (file, standard input, blob, command line) and the actual
239 origin (config file path, ref, or blob id if applicable).
240 --show-scope
242 Similar to --show-origin in that it augments the output of all
243 queried config options with the scope of that value (worktree,
244 local, global, system, command).
245 --get-colorbool <name> [<stdout-is-tty>]
247 Find the color setting for <name> (e.g. color.diff) and output
248 "true" or "false". <stdout-is-tty> should be either "true" or
249 "false", and is taken into account when configuration says "auto".
250 If <stdout-is-tty> is missing, then checks the standard output of
251 the command itself, and exits with status 0 if color is to be used,
252 or exits with status 1 otherwise. When the color setting for name
253 is undefined, the command uses color.ui as fallback.
254 --get-color <name> [<default>]
256 Find the color configured for name (e.g. color.diff.new) and
257 output it as the ANSI color escape sequence to the standard output.
258 The optional default parameter is used instead, if there is no
259 color configured for name.
260 --type=color [--default=<default>] is preferred over --get-color
262 (but note that --get-color will omit the trailing newline printed
263 by --type=color).
264 -e, --edit
266 Opens an editor to modify the specified config file; either
267 --system, --global, or repository (default).
268 --[no-]includes
270 Respect include.* directives in config files when looking up
271 values. Defaults to off when a specific file is given (e.g., using
272 --file, --global, etc) and on when searching all config files.
273 --default <value>
275 When using --get, and the requested variable is not found, behave
276 as if <value> were the value assigned to the that variable.
277
279 pager.config is only respected when listing configuration, i.e., when
280 using --list or any of the --get-* which may return multiple results.
281 The default is to use a pager.
282
284 By default, git config will read configuration options from multiple
285 files:
286 $(prefix)/etc/gitconfig
288 System-wide configuration file.
289 $XDG_CONFIG_HOME/git/config, ~/.gitconfig
291 User-specific configuration files. When the XDG_CONFIG_HOME
292 environment variable is not set or empty, $HOME/.config/ is used as
293 $XDG_CONFIG_HOME.
294 These are also called "global" configuration files. If both files
296 exist, both files are read in the order given above.
297 $GIT_DIR/config
299 Repository specific configuration file.
300 $GIT_DIR/config.worktree
302 This is optional and is only searched when
303 extensions.worktreeConfig is present in $GIT_DIR/config.
304 You may also provide additional configuration parameters when running
306 any git command by using the -c option. See git(1) for details.
307 Options will be read from all of these files that are available. If the
309 global or the system-wide configuration files are missing or unreadable
310 they will be ignored. If the repository configuration file is missing
311 or unreadable, git config will exit with a non-zero error code. An
312 error message is produced if the file is unreadable, but not if it is
313 missing.
314 The files are read in the order given above, with last value found
316 taking precedence over values read earlier. When multiple values are
317 taken then all values of a key from all files will be used.
318 By default, options are only written to the repository specific
320 configuration file. Note that this also affects options like
321 --replace-all and --unset. git config will only ever change one file at
322 a time.
323 You can limit which configuration sources are read from or written to
325 by specifying the path of a file with the --file option, or by
326 specifying a configuration scope with --system, --global, --local, or
327 --worktree. For more, see the section called “OPTIONS” above.
328
330 Each configuration source falls within a configuration scope. The
331 scopes are:
332 system
334 $(prefix)/etc/gitconfig
335 global
337 $XDG_CONFIG_HOME/git/config
338 ~/.gitconfig
340 local
342 $GIT_DIR/config
343 worktree
345 $GIT_DIR/config.worktree
346 command
348 GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see the section
349 called “ENVIRONMENT” below)
350 the -c option
352 With the exception of command, each scope corresponds to a command line
354 option: --system, --global, --local, --worktree.
355 When reading options, specifying a scope will only read options from
357 the files within that scope. When writing options, specifying a scope
358 will write to the files within that scope (instead of the repository
359 specific configuration file). See the section called “OPTIONS” above
360 for a complete description.
361 Most configuration options are respected regardless of the scope it is
363 defined in, but some options are only respected in certain scopes. See
364 the respective option’s documentation for the full details.
365 Protected configuration
367 Protected configuration refers to the system, global, and command
368 scopes. For security reasons, certain options are only respected when
369 they are specified in protected configuration, and ignored otherwise.
370 Git treats these scopes as if they are controlled by the user or a
372 trusted administrator. This is because an attacker who controls these
373 scopes can do substantial harm without using Git, so it is assumed that
374 the user’s environment protects these scopes against attackers.
375
377 GIT_CONFIG_GLOBAL, GIT_CONFIG_SYSTEM
378 Take the configuration from the given files instead from global or
379 system-level configuration. See git(1) for details.
380 GIT_CONFIG_NOSYSTEM
382 Whether to skip reading settings from the system-wide
383 $(prefix)/etc/gitconfig file. See git(1) for details.
384 See also the section called “FILES”.
386 GIT_CONFIG_COUNT, GIT_CONFIG_KEY_<n>, GIT_CONFIG_VALUE_<n>
388 If GIT_CONFIG_COUNT is set to a positive number, all environment
389 pairs GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> up to that number
390 will be added to the process’s runtime configuration. The config
391 pairs are zero-indexed. Any missing key or value is treated as an
392 error. An empty GIT_CONFIG_COUNT is treated the same as
393 GIT_CONFIG_COUNT=0, namely no pairs are processed. These
394 environment variables will override values in configuration files,
395 but will be overridden by any explicit options passed via git -c.
396 This is useful for cases where you want to spawn multiple git
398 commands with a common configuration but cannot depend on a
399 configuration file, for example when writing scripts.
400 GIT_CONFIG
402 If no --file option is provided to git config, use the file given
403 by GIT_CONFIG as if it were provided via --file. This variable has
404 no effect on other Git commands, and is mostly for historical
405 compatibility; there is generally no reason to use it instead of
406 the --file option.
407
409 Given a .git/config like this:
410 #
412 # This is the config file, and
413 # a '#' or ';' character indicates
414 # a comment
415 #
416 ; core variables
418 [core]
419 ; Don't trust file modes
420 filemode = false
421 ; Our diff algorithm
423 [diff]
424 external = /usr/local/bin/diff-wrapper
425 renames = true
426 ; Proxy settings
428 [core]
429 gitproxy=proxy-command for kernel.org
430 gitproxy=default-proxy ; for all the rest
431 ; HTTP
433 [http]
434 sslVerify
435 [http "https://weak.example.com"]
436 sslVerify = false
437 cookieFile = /tmp/cookie.txt
438 you can set the filemode to true with
440 % git config core.filemode true
442 The hypothetical proxy command entries actually have a postfix to
444 discern what URL they apply to. Here is how to change the entry for
445 kernel.org to "ssh".
446 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
448 This makes sure that only the key/value pair for kernel.org is
450 replaced.
451 To delete the entry for renames, do
453 % git config --unset diff.renames
455 If you want to delete an entry for a multivar (like core.gitproxy
457 above), you have to provide a regex matching the value of exactly one
458 line.
459 To query the value for a given key, do
461 % git config --get core.filemode
463 or
465 % git config core.filemode
467 or, to query a multivar:
469 % git config --get core.gitproxy "for kernel.org$"
471 If you want to know all the values for a multivar, do:
473 % git config --get-all core.gitproxy
475 If you like to live dangerously, you can replace all core.gitproxy by a
477 new one with
478 % git config --replace-all core.gitproxy ssh
480 However, if you really only want to replace the line for the default
482 proxy, i.e. the one without a "for ..." postfix, do something like
483 this:
484 % git config core.gitproxy ssh '! for '
486 To actually match only values with an exclamation mark, you have to
488 % git config section.key value '[!]'
490 To add a new proxy, without altering any of the existing ones, use
492 % git config --add core.gitproxy '"proxy-command" for example.com'
494 An example to use customized color from the configuration in your
496 script:
497 #!/bin/sh
499 WS=$(git config --get-color color.diff.whitespace "blue reverse")
500 RESET=$(git config --get-color "" "reset")
501 echo "${WS}your whitespace color or blue reverse${RESET}"
502 For URLs in https://weak.example.com, http.sslVerify is set to false,
504 while it is set to true for all others:
505 % git config --type=bool --get-urlmatch http.sslverify https://good.example.com
507 true
508 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
509 false
510 % git config --get-urlmatch http https://weak.example.com
511 http.cookieFile /tmp/cookie.txt
512 http.sslverify false
513
515 The Git configuration file contains a number of variables that affect
516 the Git commands' behavior. The files .git/config and optionally
517 config.worktree (see the "CONFIGURATION FILE" section of git-
518 worktree(1)) in each repository are used to store the configuration for
519 that repository, and $HOME/.gitconfig is used to store a per-user
520 configuration as fallback values for the .git/config file. The file
521 /etc/gitconfig can be used to store a system-wide default
522 configuration.
523 The configuration variables are used by both the Git plumbing and the
525 porcelains. The variables are divided into sections, wherein the fully
526 qualified variable name of the variable itself is the last
527 dot-separated segment and the section name is everything before the
528 last dot. The variable names are case-insensitive, allow only
529 alphanumeric characters and -, and must start with an alphabetic
530 character. Some variables may appear multiple times; we say then that
531 the variable is multivalued.
532 Syntax
534 The syntax is fairly flexible and permissive; whitespaces are mostly
535 ignored. The # and ; characters begin comments to the end of line,
536 blank lines are ignored.
537 The file consists of sections and variables. A section begins with the
539 name of the section in square brackets and continues until the next
540 section begins. Section names are case-insensitive. Only alphanumeric
541 characters, - and . are allowed in section names. Each variable must
542 belong to some section, which means that there must be a section header
543 before the first setting of a variable.
544 Sections can be further divided into subsections. To begin a subsection
546 put its name in double quotes, separated by space from the section
547 name, in the section header, like in the example below:
548 [section "subsection"]
550 Subsection names are case sensitive and can contain any characters
552 except newline and the null byte. Doublequote " and backslash can be
553 included by escaping them as \" and \\, respectively. Backslashes
554 preceding other characters are dropped when reading; for example, \t is
555 read as t and \0 is read as 0. Section headers cannot span multiple
556 lines. Variables may belong directly to a section or to a given
557 subsection. You can have [section] if you have [section "subsection"],
558 but you don’t need to.
559 There is also a deprecated [section.subsection] syntax. With this
561 syntax, the subsection name is converted to lower-case and is also
562 compared case sensitively. These subsection names follow the same
563 restrictions as section names.
564 All the other lines (and the remainder of the line after the section
566 header) are recognized as setting variables, in the form name = value
567 (or just name, which is a short-hand to say that the variable is the
568 boolean "true"). The variable names are case-insensitive, allow only
569 alphanumeric characters and -, and must start with an alphabetic
570 character.
571 A line that defines a value can be continued to the next line by ending
573 it with a \; the backslash and the end-of-line are stripped. Leading
574 whitespaces after name =, the remainder of the line after the first
575 comment character # or ;, and trailing whitespaces of the line are
576 discarded unless they are enclosed in double quotes. Internal
577 whitespaces within the value are retained verbatim.
578 Inside double quotes, double quote " and backslash \ characters must be
580 escaped: use \" for " and \\ for \.
581 The following escape sequences (beside \" and \\) are recognized: \n
583 for newline character (NL), \t for horizontal tabulation (HT, TAB) and
584 \b for backspace (BS). Other char escape sequences (including octal
585 escape sequences) are invalid.
586 Includes
588 The include and includeIf sections allow you to include config
589 directives from another source. These sections behave identically to
590 each other with the exception that includeIf sections may be ignored if
591 their condition does not evaluate to true; see "Conditional includes"
592 below.
593 You can include a config file from another by setting the special
595 include.path (or includeIf.*.path) variable to the name of the file to
596 be included. The variable takes a pathname as its value, and is subject
597 to tilde expansion. These variables can be given multiple times.
598 The contents of the included file are inserted immediately, as if they
600 had been found at the location of the include directive. If the value
601 of the variable is a relative path, the path is considered to be
602 relative to the configuration file in which the include directive was
603 found. See below for examples.
604 Conditional includes
606 You can include a config file from another conditionally by setting a
607 includeIf.<condition>.path variable to the name of the file to be
608 included.
609 The condition starts with a keyword followed by a colon and some data
611 whose format and meaning depends on the keyword. Supported keywords
612 are:
613 gitdir
615 The data that follows the keyword gitdir: is used as a glob
616 pattern. If the location of the .git directory matches the pattern,
617 the include condition is met.
618 The .git location may be auto-discovered, or come from $GIT_DIR
620 environment variable. If the repository is auto discovered via a
621 .git file (e.g. from submodules, or a linked worktree), the .git
622 location would be the final location where the .git directory is,
623 not where the .git file is.
624 The pattern can contain standard globbing wildcards and two
626 additional ones, **/ and /**, that can match multiple path
627 components. Please refer to gitignore(5) for details. For
628 convenience:
629 • If the pattern starts with ~/, ~ will be substituted with the
631 content of the environment variable HOME.
632 • If the pattern starts with ./, it is replaced with the
634 directory containing the current config file.
635 • If the pattern does not start with either ~/, ./ or /, **/ will
637 be automatically prepended. For example, the pattern foo/bar
638 becomes **/foo/bar and would match /any/path/to/foo/bar.
639 • If the pattern ends with /, ** will be automatically added. For
641 example, the pattern foo/ becomes foo/**. In other words, it
642 matches "foo" and everything inside, recursively.
643 gitdir/i
645 This is the same as gitdir except that matching is done
646 case-insensitively (e.g. on case-insensitive file systems)
647 onbranch
649 The data that follows the keyword onbranch: is taken to be a
650 pattern with standard globbing wildcards and two additional ones,
651 **/ and /**, that can match multiple path components. If we are in
652 a worktree where the name of the branch that is currently checked
653 out matches the pattern, the include condition is met.
654 If the pattern ends with /, ** will be automatically added. For
656 example, the pattern foo/ becomes foo/**. In other words, it
657 matches all branches that begin with foo/. This is useful if your
658 branches are organized hierarchically and you would like to apply a
659 configuration to all the branches in that hierarchy.
660 hasconfig:remote.*.url:
662 The data that follows this keyword is taken to be a pattern with
663 standard globbing wildcards and two additional ones, **/ and /**,
664 that can match multiple components. The first time this keyword is
665 seen, the rest of the config files will be scanned for remote URLs
666 (without applying any values). If there exists at least one remote
667 URL that matches this pattern, the include condition is met.
668 Files included by this option (directly or indirectly) are not
670 allowed to contain remote URLs.
671 Note that unlike other includeIf conditions, resolving this
673 condition relies on information that is not yet known at the point
674 of reading the condition. A typical use case is this option being
675 present as a system-level or global-level config, and the remote
676 URL being in a local-level config; hence the need to scan ahead
677 when resolving this condition. In order to avoid the
678 chicken-and-egg problem in which potentially-included files can
679 affect whether such files are potentially included, Git breaks the
680 cycle by prohibiting these files from affecting the resolution of
681 these conditions (thus, prohibiting them from declaring remote
682 URLs).
683 As for the naming of this keyword, it is for forwards compatibiliy
685 with a naming scheme that supports more variable-based include
686 conditions, but currently Git only supports the exact keyword
687 described above.
688 A few more notes on matching via gitdir and gitdir/i:
690 • Symlinks in $GIT_DIR are not resolved before matching.
692 • Both the symlink & realpath versions of paths will be matched
694 outside of $GIT_DIR. E.g. if ~/git is a symlink to
695 /mnt/storage/git, both gitdir:~/git and gitdir:/mnt/storage/git
696 will match.
697 This was not the case in the initial release of this feature in
699 v2.13.0, which only matched the realpath version. Configuration
700 that wants to be compatible with the initial release of this
701 feature needs to either specify only the realpath version, or both
702 versions.
703 • Note that "../" is not special and will match literally, which is
705 unlikely what you want.
706 Example
708 # Core variables
709 [core]
710 ; Don't trust file modes
711 filemode = false
712 # Our diff algorithm
714 [diff]
715 external = /usr/local/bin/diff-wrapper
716 renames = true
717 [branch "devel"]
719 remote = origin
720 merge = refs/heads/devel
721 # Proxy settings
723 [core]
724 gitProxy="ssh" for "kernel.org"
725 gitProxy=default-proxy ; for the rest
726 [include]
728 path = /path/to/foo.inc ; include by absolute path
729 path = foo.inc ; find "foo.inc" relative to the current file
730 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
731 ; include if $GIT_DIR is /path/to/foo/.git
733 [includeIf "gitdir:/path/to/foo/.git"]
734 path = /path/to/foo.inc
735 ; include for all repositories inside /path/to/group
737 [includeIf "gitdir:/path/to/group/"]
738 path = /path/to/foo.inc
739 ; include for all repositories inside $HOME/to/group
741 [includeIf "gitdir:~/to/group/"]
742 path = /path/to/foo.inc
743 ; relative paths are always relative to the including
745 ; file (if the condition is true); their location is not
746 ; affected by the condition
747 [includeIf "gitdir:/path/to/group/"]
748 path = foo.inc
749 ; include only if we are in a worktree where foo-branch is
751 ; currently checked out
752 [includeIf "onbranch:foo-branch"]
753 path = foo.inc
754 ; include only if a remote with the given URL exists (note
756 ; that such a URL may be provided later in a file or in a
757 ; file read after this file is read, as seen in this example)
758 [includeIf "hasconfig:remote.*.url:https://example.com/**"]
759 path = foo.inc
760 [remote "origin"]
761 url = https://example.com/git
762 Values
764 Values of many variables are treated as a simple string, but there are
765 variables that take values of specific types and there are rules as to
766 how to spell them.
767 boolean
769 When a variable is said to take a boolean value, many synonyms are
770 accepted for true and false; these are all case-insensitive.
771 true
773 Boolean true literals are yes, on, true, and 1. Also, a
774 variable defined without = <value> is taken as true.
775 false
777 Boolean false literals are no, off, false, 0 and the empty
778 string.
779 When converting a value to its canonical form using the
781 --type=bool type specifier, git config will ensure that the
782 output is "true" or "false" (spelled in lowercase).
783 integer
785 The value for many variables that specify various sizes can be
786 suffixed with k, M,... to mean "scale the number by 1024", "by
787 1024x1024", etc.
788 color
790 The value for a variable that takes a color is a list of colors (at
791 most two, one for foreground and one for background) and attributes
792 (as many as you want), separated by spaces.
793 The basic colors accepted are normal, black, red, green, yellow,
795 blue, magenta, cyan, white and default. The first color given is
796 the foreground; the second is the background. All the basic colors
797 except normal and default have a bright variant that can be
798 specified by prefixing the color with bright, like brightred.
799 The color normal makes no change to the color. It is the same as an
801 empty string, but can be used as the foreground color when
802 specifying a background color alone (for example, "normal red").
803 The color default explicitly resets the color to the terminal
805 default, for example to specify a cleared background. Although it
806 varies between terminals, this is usually not the same as setting
807 to "white black".
808 Colors may also be given as numbers between 0 and 255; these use
810 ANSI 256-color mode (but note that not all terminals may support
811 this). If your terminal supports it, you may also specify 24-bit
812 RGB values as hex, like #ff0ab3.
813 The accepted attributes are bold, dim, ul, blink, reverse, italic,
815 and strike (for crossed-out or "strikethrough" letters). The
816 position of any attributes with respect to the colors (before,
817 after, or in between), doesn’t matter. Specific attributes may be
818 turned off by prefixing them with no or no- (e.g., noreverse,
819 no-ul, etc).
820 The pseudo-attribute reset resets all colors and attributes before
822 applying the specified coloring. For example, reset green will
823 result in a green foreground and default background without any
824 active attributes.
825 An empty color string produces no color effect at all. This can be
827 used to avoid coloring specific elements without disabling color
828 entirely.
829 For git’s pre-defined color slots, the attributes are meant to be
831 reset at the beginning of each item in the colored output. So
832 setting color.decorate.branch to black will paint that branch name
833 in a plain black, even if the previous thing on the same output
834 line (e.g. opening parenthesis before the list of branch names in
835 log --decorate output) is set to be painted with bold or some other
836 attribute. However, custom log formats may do more complicated and
837 layered coloring, and the negated forms may be useful there.
838 pathname
840 A variable that takes a pathname value can be given a string that
841 begins with "~/" or "~user/", and the usual tilde expansion happens
842 to such a string: ~/ is expanded to the value of $HOME, and ~user/
843 to the specified user’s home directory.
844 If a path starts with %(prefix)/, the remainder is interpreted as a
846 path relative to Git’s "runtime prefix", i.e. relative to the
847 location where Git itself was installed. For example,
848 %(prefix)/bin/ refers to the directory in which the Git executable
849 itself lives. If Git was compiled without runtime prefix support,
850 the compiled-in prefix will be substituted instead. In the unlikely
851 event that a literal path needs to be specified that should not be
852 expanded, it needs to be prefixed by ./, like so: ./%(prefix)/bin.
853 Variables
855 Note that this list is non-comprehensive and not necessarily complete.
856 For command-specific variables, you will find a more detailed
857 description in the appropriate manual page.
858 Other git-related tools may and do use their own variables. When
860 inventing new variables for use in your own tool, make sure their names
861 do not conflict with those that are used by Git itself and other
862 popular tools, and describe them in your documentation.
863 advice.*
865 These variables control various optional help messages designed to
866 aid new users. All advice.* variables default to true, and you can
867 tell Git that you do not need help by setting these to false:
868 ambiguousFetchRefspec
870 Advice shown when fetch refspec for multiple remotes map to the
871 same remote-tracking branch namespace and causes branch
872 tracking set-up to fail.
873 fetchShowForcedUpdates
875 Advice shown when git-fetch(1) takes a long time to calculate
876 forced updates after ref updates, or to warn that the check is
877 disabled.
878 pushUpdateRejected
880 Set this variable to false if you want to disable
881 pushNonFFCurrent, pushNonFFMatching, pushAlreadyExists,
882 pushFetchFirst, pushNeedsForce, and pushRefNeedsUpdate
883 simultaneously.
884 pushNonFFCurrent
886 Advice shown when git-push(1) fails due to a non-fast-forward
887 update to the current branch.
888 pushNonFFMatching
890 Advice shown when you ran git-push(1) and pushed matching refs
891 explicitly (i.e. you used :, or specified a refspec that isn’t
892 your current branch) and it resulted in a non-fast-forward
893 error.
894 pushAlreadyExists
896 Shown when git-push(1) rejects an update that does not qualify
897 for fast-forwarding (e.g., a tag.)
898 pushFetchFirst
900 Shown when git-push(1) rejects an update that tries to
901 overwrite a remote ref that points at an object we do not have.
902 pushNeedsForce
904 Shown when git-push(1) rejects an update that tries to
905 overwrite a remote ref that points at an object that is not a
906 commit-ish, or make the remote ref point at an object that is
907 not a commit-ish.
908 pushUnqualifiedRefname
910 Shown when git-push(1) gives up trying to guess based on the
911 source and destination refs what remote ref namespace the
912 source belongs in, but where we can still suggest that the user
913 push to either refs/heads/* or refs/tags/* based on the type of
914 the source object.
915 pushRefNeedsUpdate
917 Shown when git-push(1) rejects a forced update of a branch when
918 its remote-tracking ref has updates that we do not have
919 locally.
920 skippedCherryPicks
922 Shown when git-rebase(1) skips a commit that has already been
923 cherry-picked onto the upstream branch.
924 statusAheadBehind
926 Shown when git-status(1) computes the ahead/behind counts for a
927 local ref compared to its remote tracking ref, and that
928 calculation takes longer than expected. Will not appear if
929 status.aheadBehind is false or the option --no-ahead-behind is
930 given.
931 statusHints
933 Show directions on how to proceed from the current state in the
934 output of git-status(1), in the template shown when writing
935 commit messages in git-commit(1), and in the help message shown
936 by git-switch(1) or git-checkout(1) when switching branch.
937 statusUoption
939 Advise to consider using the -u option to git-status(1) when
940 the command takes more than 2 seconds to enumerate untracked
941 files.
942 commitBeforeMerge
944 Advice shown when git-merge(1) refuses to merge to avoid
945 overwriting local changes.
946 resetNoRefresh
948 Advice to consider using the --no-refresh option to git-
949 reset(1) when the command takes more than 2 seconds to refresh
950 the index after reset.
951 resolveConflict
953 Advice shown by various commands when conflicts prevent the
954 operation from being performed.
955 sequencerInUse
957 Advice shown when a sequencer command is already in progress.
958 implicitIdentity
960 Advice on how to set your identity configuration when your
961 information is guessed from the system username and domain
962 name.
963 detachedHead
965 Advice shown when you used git-switch(1) or git-checkout(1) to
966 move to the detach HEAD state, to instruct how to create a
967 local branch after the fact.
968 suggestDetachingHead
970 Advice shown when git-switch(1) refuses to detach HEAD without
971 the explicit --detach option.
972 checkoutAmbiguousRemoteBranchName
974 Advice shown when the argument to git-checkout(1) and git-
975 switch(1) ambiguously resolves to a remote tracking branch on
976 more than one remote in situations where an unambiguous
977 argument would have otherwise caused a remote-tracking branch
978 to be checked out. See the checkout.defaultRemote configuration
979 variable for how to set a given remote to used by default in
980 some situations where this advice would be printed.
981 amWorkDir
983 Advice that shows the location of the patch file when git-am(1)
984 fails to apply it.
985 rmHints
987 In case of failure in the output of git-rm(1), show directions
988 on how to proceed from the current state.
989 addEmbeddedRepo
991 Advice on what to do when you’ve accidentally added one git
992 repo inside of another.
993 ignoredHook
995 Advice shown if a hook is ignored because the hook is not set
996 as executable.
997 waitingForEditor
999 Print a message to the terminal whenever Git is waiting for
1000 editor input from the user.
1001 nestedTag
1003 Advice shown if a user attempts to recursively tag a tag
1004 object.
1005 submoduleAlternateErrorStrategyDie
1007 Advice shown when a submodule.alternateErrorStrategy option
1008 configured to "die" causes a fatal error.
1009 submodulesNotUpdated
1011 Advice shown when a user runs a submodule command that fails
1012 because git submodule update --init was not run.
1013 addIgnoredFile
1015 Advice shown if a user attempts to add an ignored file to the
1016 index.
1017 addEmptyPathspec
1019 Advice shown if a user runs the add command without providing
1020 the pathspec parameter.
1021 updateSparsePath
1023 Advice shown when either git-add(1) or git-rm(1) is asked to
1024 update index entries outside the current sparse checkout.
1025 core.fileMode
1027 Tells Git if the executable bit of files in the working tree is to
1028 be honored.
1029 Some filesystems lose the executable bit when a file that is marked
1031 as executable is checked out, or checks out a non-executable file
1032 with executable bit on. git-clone(1) or git-init(1) probe the
1033 filesystem to see if it handles the executable bit correctly and
1034 this variable is automatically set as necessary.
1035 A repository, however, may be on a filesystem that handles the
1037 filemode correctly, and this variable is set to true when created,
1038 but later may be made accessible from another environment that
1039 loses the filemode (e.g. exporting ext4 via CIFS mount, visiting a
1040 Cygwin created repository with Git for Windows or Eclipse). In such
1041 a case it may be necessary to set this variable to false. See git-
1042 update-index(1).
1043 The default is true (when core.filemode is not specified in the
1045 config file).
1046 core.hideDotFiles
1048 (Windows-only) If true, mark newly-created directories and files
1049 whose name starts with a dot as hidden. If dotGitOnly, only the
1050 .git/ directory is hidden, but no other files starting with a dot.
1051 The default mode is dotGitOnly.
1052 core.ignoreCase
1054 Internal variable which enables various workarounds to enable Git
1055 to work better on filesystems that are not case sensitive, like
1056 APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
1057 finds "makefile" when Git expects "Makefile", Git will assume it is
1058 really the same file, and continue to remember it as "Makefile".
1059 The default is false, except git-clone(1) or git-init(1) will probe
1061 and set core.ignoreCase true if appropriate when the repository is
1062 created.
1063 Git relies on the proper configuration of this variable for your
1065 operating and file system. Modifying this value may result in
1066 unexpected behavior.
1067 core.precomposeUnicode
1069 This option is only used by Mac OS implementation of Git. When
1070 core.precomposeUnicode=true, Git reverts the unicode decomposition
1071 of filenames done by Mac OS. This is useful when sharing a
1072 repository between Mac OS and Linux or Windows. (Git for Windows
1073 1.7.10 or higher is needed, or Git under cygwin 1.7). When false,
1074 file names are handled fully transparent by Git, which is backward
1075 compatible with older versions of Git.
1076 core.protectHFS
1078 If set to true, do not allow checkout of paths that would be
1079 considered equivalent to .git on an HFS+ filesystem. Defaults to
1080 true on Mac OS, and false elsewhere.
1081 core.protectNTFS
1083 If set to true, do not allow checkout of paths that would cause
1084 problems with the NTFS filesystem, e.g. conflict with 8.3 "short"
1085 names. Defaults to true on Windows, and false elsewhere.
1086 core.fsmonitor
1088 If set to true, enable the built-in file system monitor daemon for
1089 this working directory (git-fsmonitor--daemon(1)).
1090 Like hook-based file system monitors, the built-in file system
1092 monitor can speed up Git commands that need to refresh the Git
1093 index (e.g. git status) in a working directory with many files.
1094 The built-in monitor eliminates the need to install and maintain an
1095 external third-party tool.
1096 The built-in file system monitor is currently available only on a
1098 limited set of supported platforms. Currently, this includes
1099 Windows and MacOS.
1100 Otherwise, this variable contains the pathname of the "fsmonitor"
1102 hook command.
1103 This hook command is used to identify all files that may have
1105 changed since the requested date/time. This information is used to
1106 speed up git by avoiding unnecessary scanning of files that have
1107 not changed.
1108 See the "fsmonitor-watchman" section of githooks(5).
1110 Note that if you concurrently use multiple versions of Git, such as
1112 one version on the command line and another version in an IDE tool,
1113 that the definition of core.fsmonitor was extended to allow boolean
1114 values in addition to hook pathnames. Git versions 2.35.1 and prior
1115 will not understand the boolean values and will consider the "true"
1116 or "false" values as hook pathnames to be invoked. Git versions
1117 2.26 thru 2.35.1 default to hook protocol V2 and will fall back to
1118 no fsmonitor (full scan). Git versions prior to 2.26 default to
1119 hook protocol V1 and will silently assume there were no changes to
1120 report (no scan), so status commands may report incomplete results.
1121 For this reason, it is best to upgrade all of your Git versions
1122 before using the built-in file system monitor.
1123 core.fsmonitorHookVersion
1125 Sets the protocol version to be used when invoking the "fsmonitor"
1126 hook.
1127 There are currently versions 1 and 2. When this is not set, version
1129 2 will be tried first and if it fails then version 1 will be tried.
1130 Version 1 uses a timestamp as input to determine which files have
1131 changes since that time but some monitors like Watchman have race
1132 conditions when used with a timestamp. Version 2 uses an opaque
1133 string so that the monitor can return something that can be used to
1134 determine what files have changed without race conditions.
1135 core.trustctime
1137 If false, the ctime differences between the index and the working
1138 tree are ignored; useful when the inode change time is regularly
1139 modified by something outside Git (file system crawlers and some
1140 backup systems). See git-update-index(1). True by default.
1141 core.splitIndex
1143 If true, the split-index feature of the index will be used. See
1144 git-update-index(1). False by default.
1145 core.untrackedCache
1147 Determines what to do about the untracked cache feature of the
1148 index. It will be kept, if this variable is unset or set to keep.
1149 It will automatically be added if set to true. And it will
1150 automatically be removed, if set to false. Before setting it to
1151 true, you should check that mtime is working properly on your
1152 system. See git-update-index(1). keep by default, unless
1153 feature.manyFiles is enabled which sets this setting to true by
1154 default.
1155 core.checkStat
1157 When missing or is set to default, many fields in the stat
1158 structure are checked to detect if a file has been modified since
1159 Git looked at it. When this configuration variable is set to
1160 minimal, sub-second part of mtime and ctime, the uid and gid of the
1161 owner of the file, the inode number (and the device number, if Git
1162 was compiled to use it), are excluded from the check among these
1163 fields, leaving only the whole-second part of mtime (and ctime, if
1164 core.trustCtime is set) and the filesize to be checked.
1165 There are implementations of Git that do not leave usable values in
1167 some fields (e.g. JGit); by excluding these fields from the
1168 comparison, the minimal mode may help interoperability when the
1169 same repository is used by these other systems at the same time.
1170 core.quotePath
1172 Commands that output paths (e.g. ls-files, diff), will quote
1173 "unusual" characters in the pathname by enclosing the pathname in
1174 double-quotes and escaping those characters with backslashes in the
1175 same way C escapes control characters (e.g. \t for TAB, \n for LF,
1176 \\ for backslash) or bytes with values larger than 0x80 (e.g. octal
1177 \302\265 for "micro" in UTF-8). If this variable is set to false,
1178 bytes higher than 0x80 are not considered "unusual" any more.
1179 Double-quotes, backslash and control characters are always escaped
1180 regardless of the setting of this variable. A simple space
1181 character is not considered "unusual". Many commands can output
1182 pathnames completely verbatim using the -z option. The default
1183 value is true.
1184 core.eol
1186 Sets the line ending type to use in the working directory for files
1187 that are marked as text (either by having the text attribute set,
1188 or by having text=auto and Git auto-detecting the contents as
1189 text). Alternatives are lf, crlf and native, which uses the
1190 platform’s native line ending. The default value is native. See
1191 gitattributes(5) for more information on end-of-line conversion.
1192 Note that this value is ignored if core.autocrlf is set to true or
1193 input.
1194 core.safecrlf
1196 If true, makes Git check if converting CRLF is reversible when
1197 end-of-line conversion is active. Git will verify if a command
1198 modifies a file in the work tree either directly or indirectly. For
1199 example, committing a file followed by checking out the same file
1200 should yield the original file in the work tree. If this is not the
1201 case for the current setting of core.autocrlf, Git will reject the
1202 file. The variable can be set to "warn", in which case Git will
1203 only warn about an irreversible conversion but continue the
1204 operation.
1205 CRLF conversion bears a slight chance of corrupting data. When it
1207 is enabled, Git will convert CRLF to LF during commit and LF to
1208 CRLF during checkout. A file that contains a mixture of LF and CRLF
1209 before the commit cannot be recreated by Git. For text files this
1210 is the right thing to do: it corrects line endings such that we
1211 have only LF line endings in the repository. But for binary files
1212 that are accidentally classified as text the conversion can corrupt
1213 data.
1214 If you recognize such corruption early you can easily fix it by
1216 setting the conversion type explicitly in .gitattributes. Right
1217 after committing you still have the original file in your work tree
1218 and this file is not yet corrupted. You can explicitly tell Git
1219 that this file is binary and Git will handle the file
1220 appropriately.
1221 Unfortunately, the desired effect of cleaning up text files with
1223 mixed line endings and the undesired effect of corrupting binary
1224 files cannot be distinguished. In both cases CRLFs are removed in
1225 an irreversible way. For text files this is the right thing to do
1226 because CRLFs are line endings, while for binary files converting
1227 CRLFs corrupts data.
1228 Note, this safety check does not mean that a checkout will generate
1230 a file identical to the original file for a different setting of
1231 core.eol and core.autocrlf, but only for the current one. For
1232 example, a text file with LF would be accepted with core.eol=lf and
1233 could later be checked out with core.eol=crlf, in which case the
1234 resulting file would contain CRLF, although the original file
1235 contained LF. However, in both work trees the line endings would be
1236 consistent, that is either all LF or all CRLF, but never mixed. A
1237 file with mixed line endings would be reported by the core.safecrlf
1238 mechanism.
1239 core.autocrlf
1241 Setting this variable to "true" is the same as setting the text
1242 attribute to "auto" on all files and core.eol to "crlf". Set to
1243 true if you want to have CRLF line endings in your working
1244 directory and the repository has LF line endings. This variable can
1245 be set to input, in which case no output conversion is performed.
1246 core.checkRoundtripEncoding
1248 A comma and/or whitespace separated list of encodings that Git
1249 performs UTF-8 round trip checks on if they are used in an
1250 working-tree-encoding attribute (see gitattributes(5)). The default
1251 value is SHIFT-JIS.
1252 core.symlinks
1254 If false, symbolic links are checked out as small plain files that
1255 contain the link text. git-update-index(1) and git-add(1) will not
1256 change the recorded type to regular file. Useful on filesystems
1257 like FAT that do not support symbolic links.
1258 The default is true, except git-clone(1) or git-init(1) will probe
1260 and set core.symlinks false if appropriate when the repository is
1261 created.
1262 core.gitProxy
1264 A "proxy command" to execute (as command host port) instead of
1265 establishing direct connection to the remote server when using the
1266 Git protocol for fetching. If the variable value is in the "COMMAND
1267 for DOMAIN" format, the command is applied only on hostnames ending
1268 with the specified domain string. This variable may be set multiple
1269 times and is matched in the given order; the first match wins.
1270 Can be overridden by the GIT_PROXY_COMMAND environment variable
1272 (which always applies universally, without the special "for"
1273 handling).
1274 The special string none can be used as the proxy command to specify
1276 that no proxy be used for a given domain pattern. This is useful
1277 for excluding servers inside a firewall from proxy use, while
1278 defaulting to a common proxy for external domains.
1279 core.sshCommand
1281 If this variable is set, git fetch and git push will use the
1282 specified command instead of ssh when they need to connect to a
1283 remote system. The command is in the same form as the
1284 GIT_SSH_COMMAND environment variable and is overridden when the
1285 environment variable is set.
1286 core.ignoreStat
1288 If true, Git will avoid using lstat() calls to detect if files have
1289 changed by setting the "assume-unchanged" bit for those tracked
1290 files which it has updated identically in both the index and
1291 working tree.
1292 When files are modified outside of Git, the user will need to stage
1294 the modified files explicitly (e.g. see Examples section in git-
1295 update-index(1)). Git will not normally detect changes to those
1296 files.
1297 This is useful on systems where lstat() calls are very slow, such
1299 as CIFS/Microsoft Windows.
1300 False by default.
1302 core.preferSymlinkRefs
1304 Instead of the default "symref" format for HEAD and other symbolic
1305 reference files, use symbolic links. This is sometimes needed to
1306 work with old scripts that expect HEAD to be a symbolic link.
1307 core.alternateRefsCommand
1309 When advertising tips of available history from an alternate, use
1310 the shell to execute the specified command instead of git-for-each-
1311 ref(1). The first argument is the absolute path of the alternate.
1312 Output must contain one hex object id per line (i.e., the same as
1313 produced by git for-each-ref --format='%(objectname)').
1314 Note that you cannot generally put git for-each-ref directly into
1316 the config value, as it does not take a repository path as an
1317 argument (but you can wrap the command above in a shell script).
1318 core.alternateRefsPrefixes
1320 When listing references from an alternate, list only references
1321 that begin with the given prefix. Prefixes match as if they were
1322 given as arguments to git-for-each-ref(1). To list multiple
1323 prefixes, separate them with whitespace. If
1324 core.alternateRefsCommand is set, setting
1325 core.alternateRefsPrefixes has no effect.
1326 core.bare
1328 If true this repository is assumed to be bare and has no working
1329 directory associated with it. If this is the case a number of
1330 commands that require a working directory will be disabled, such as
1331 git-add(1) or git-merge(1).
1332 This setting is automatically guessed by git-clone(1) or git-
1334 init(1) when the repository was created. By default a repository
1335 that ends in "/.git" is assumed to be not bare (bare = false),
1336 while all other repositories are assumed to be bare (bare = true).
1337 core.worktree
1339 Set the path to the root of the working tree. If GIT_COMMON_DIR
1340 environment variable is set, core.worktree is ignored and not used
1341 for determining the root of working tree. This can be overridden by
1342 the GIT_WORK_TREE environment variable and the --work-tree
1343 command-line option. The value can be an absolute path or relative
1344 to the path to the .git directory, which is either specified by
1345 --git-dir or GIT_DIR, or automatically discovered. If --git-dir or
1346 GIT_DIR is specified but none of --work-tree, GIT_WORK_TREE and
1347 core.worktree is specified, the current working directory is
1348 regarded as the top level of your working tree.
1349 Note that this variable is honored even when set in a configuration
1351 file in a ".git" subdirectory of a directory and its value differs
1352 from the latter directory (e.g. "/path/to/.git/config" has
1353 core.worktree set to "/different/path"), which is most likely a
1354 misconfiguration. Running Git commands in the "/path/to" directory
1355 will still use "/different/path" as the root of the work tree and
1356 can cause confusion unless you know what you are doing (e.g. you
1357 are creating a read-only snapshot of the same index to a location
1358 different from the repository’s usual working tree).
1359 core.logAllRefUpdates
1361 Enable the reflog. Updates to a ref <ref> is logged to the file
1362 "$GIT_DIR/logs/<ref>", by appending the new and old SHA-1, the
1363 date/time and the reason of the update, but only when the file
1364 exists. If this configuration variable is set to true, missing
1365 "$GIT_DIR/logs/<ref>" file is automatically created for branch
1366 heads (i.e. under refs/heads/), remote refs (i.e. under
1367 refs/remotes/), note refs (i.e. under refs/notes/), and the
1368 symbolic ref HEAD. If it is set to always, then a missing reflog is
1369 automatically created for any ref under refs/.
1370 This information can be used to determine what commit was the tip
1372 of a branch "2 days ago".
1373 This value is true by default in a repository that has a working
1375 directory associated with it, and false by default in a bare
1376 repository.
1377 core.repositoryFormatVersion
1379 Internal variable identifying the repository format and layout
1380 version.
1381 core.sharedRepository
1383 When group (or true), the repository is made shareable between
1384 several users in a group (making sure all the files and objects are
1385 group-writable). When all (or world or everybody), the repository
1386 will be readable by all users, additionally to being
1387 group-shareable. When umask (or false), Git will use permissions
1388 reported by umask(2). When 0xxx, where 0xxx is an octal number,
1389 files in the repository will have this mode value. 0xxx will
1390 override user’s umask value (whereas the other options will only
1391 override requested parts of the user’s umask value). Examples: 0660
1392 will make the repo read/write-able for the owner and group, but
1393 inaccessible to others (equivalent to group unless umask is e.g.
1394 0022). 0640 is a repository that is group-readable but not
1395 group-writable. See git-init(1). False by default.
1396 core.warnAmbiguousRefs
1398 If true, Git will warn you if the ref name you passed it is
1399 ambiguous and might match multiple refs in the repository. True by
1400 default.
1401 core.compression
1403 An integer -1..9, indicating a default compression level. -1 is the
1404 zlib default. 0 means no compression, and 1..9 are various
1405 speed/size tradeoffs, 9 being slowest. If set, this provides a
1406 default to other compression variables, such as
1407 core.looseCompression and pack.compression.
1408 core.looseCompression
1410 An integer -1..9, indicating the compression level for objects that
1411 are not in a pack file. -1 is the zlib default. 0 means no
1412 compression, and 1..9 are various speed/size tradeoffs, 9 being
1413 slowest. If not set, defaults to core.compression. If that is not
1414 set, defaults to 1 (best speed).
1415 core.packedGitWindowSize
1417 Number of bytes of a pack file to map into memory in a single
1418 mapping operation. Larger window sizes may allow your system to
1419 process a smaller number of large pack files more quickly. Smaller
1420 window sizes will negatively affect performance due to increased
1421 calls to the operating system’s memory manager, but may improve
1422 performance when accessing a large number of large pack files.
1423 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
1425 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
1426 be reasonable for all users/operating systems. You probably do not
1427 need to adjust this value.
1428 Common unit suffixes of k, m, or g are supported.
1430 core.packedGitLimit
1432 Maximum number of bytes to map simultaneously into memory from pack
1433 files. If Git needs to access more than this many bytes at once to
1434 complete an operation it will unmap existing regions to reclaim
1435 virtual address space within the process.
1436 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
1438 unlimited) on 64 bit platforms. This should be reasonable for all
1439 users/operating systems, except on the largest projects. You
1440 probably do not need to adjust this value.
1441 Common unit suffixes of k, m, or g are supported.
1443 core.deltaBaseCacheLimit
1445 Maximum number of bytes per thread to reserve for caching base
1446 objects that may be referenced by multiple deltified objects. By
1447 storing the entire decompressed base objects in a cache Git is able
1448 to avoid unpacking and decompressing frequently used base objects
1449 multiple times.
1450 Default is 96 MiB on all platforms. This should be reasonable for
1452 all users/operating systems, except on the largest projects. You
1453 probably do not need to adjust this value.
1454 Common unit suffixes of k, m, or g are supported.
1456 core.bigFileThreshold
1458 The size of files considered "big", which as discussed below
1459 changes the behavior of numerous git commands, as well as how such
1460 files are stored within the repository. The default is 512 MiB.
1461 Common unit suffixes of k, m, or g are supported.
1462 Files above the configured limit will be:
1464 • Stored deflated in packfiles, without attempting delta
1466 compression.
1467 The default limit is primarily set with this use-case in mind.
1469 With it, most projects will have their source code and other
1470 text files delta compressed, but not larger binary media files.
1471 Storing large files without delta compression avoids excessive
1473 memory usage, at the slight expense of increased disk usage.
1474 • Will be treated as if they were labeled "binary" (see
1476 gitattributes(5)). e.g. git-log(1) and git-diff(1) will not
1477 compute diffs for files above this limit.
1478 • Will generally be streamed when written, which avoids excessive
1480 memory usage, at the cost of some fixed overhead. Commands that
1481 make use of this include git-archive(1), git-fast-import(1),
1482 git-index-pack(1), git-unpack-objects(1) and git-fsck(1).
1483 core.excludesFile
1485 Specifies the pathname to the file that contains patterns to
1486 describe paths that are not meant to be tracked, in addition to
1487 .gitignore (per-directory) and .git/info/exclude. Defaults to
1488 $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set
1489 or empty, $HOME/.config/git/ignore is used instead. See
1490 gitignore(5).
1491 core.askPass
1493 Some commands (e.g. svn and http interfaces) that interactively ask
1494 for a password can be told to use an external program given via the
1495 value of this variable. Can be overridden by the GIT_ASKPASS
1496 environment variable. If not set, fall back to the value of the
1497 SSH_ASKPASS environment variable or, failing that, a simple
1498 password prompt. The external program shall be given a suitable
1499 prompt as command-line argument and write the password on its
1500 STDOUT.
1501 core.attributesFile
1503 In addition to .gitattributes (per-directory) and
1504 .git/info/attributes, Git looks into this file for attributes (see
1505 gitattributes(5)). Path expansions are made the same way as for
1506 core.excludesFile. Its default value is
1507 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
1508 set or empty, $HOME/.config/git/attributes is used instead.
1509 core.hooksPath
1511 By default Git will look for your hooks in the $GIT_DIR/hooks
1512 directory. Set this to different path, e.g. /etc/git/hooks, and
1513 Git will try to find your hooks in that directory, e.g.
1514 /etc/git/hooks/pre-receive instead of in
1515 $GIT_DIR/hooks/pre-receive.
1516 The path can be either absolute or relative. A relative path is
1518 taken as relative to the directory where the hooks are run (see the
1519 "DESCRIPTION" section of githooks(5)).
1520 This configuration variable is useful in cases where you’d like to
1522 centrally configure your Git hooks instead of configuring them on a
1523 per-repository basis, or as a more flexible and centralized
1524 alternative to having an init.templateDir where you’ve changed
1525 default hooks.
1526 core.editor
1528 Commands such as commit and tag that let you edit messages by
1529 launching an editor use the value of this variable when it is set,
1530 and the environment variable GIT_EDITOR is not set. See git-var(1).
1531 core.commentChar
1533 Commands such as commit and tag that let you edit messages consider
1534 a line that begins with this character commented, and removes them
1535 after the editor returns (default #).
1536 If set to "auto", git-commit would select a character that is not
1538 the beginning character of any line in existing commit messages.
1539 core.filesRefLockTimeout
1541 The length of time, in milliseconds, to retry when trying to lock
1542 an individual reference. Value 0 means not to retry at all; -1
1543 means to try indefinitely. Default is 100 (i.e., retry for 100ms).
1544 core.packedRefsTimeout
1546 The length of time, in milliseconds, to retry when trying to lock
1547 the packed-refs file. Value 0 means not to retry at all; -1 means
1548 to try indefinitely. Default is 1000 (i.e., retry for 1 second).
1549 core.pager
1551 Text viewer for use by Git commands (e.g., less). The value is
1552 meant to be interpreted by the shell. The order of preference is
1553 the $GIT_PAGER environment variable, then core.pager configuration,
1554 then $PAGER, and then the default chosen at compile time (usually
1555 less).
1556 When the LESS environment variable is unset, Git sets it to FRX (if
1558 LESS environment variable is set, Git does not change it at all).
1559 If you want to selectively override Git’s default setting for LESS,
1560 you can set core.pager to e.g. less -S. This will be passed to the
1561 shell by Git, which will translate the final command to LESS=FRX
1562 less -S. The environment does not set the S option but the command
1563 line does, instructing less to truncate long lines. Similarly,
1564 setting core.pager to less -+F will deactivate the F option
1565 specified by the environment from the command-line, deactivating
1566 the "quit if one screen" behavior of less. One can specifically
1567 activate some flags for particular commands: for example, setting
1568 pager.blame to less -S enables line truncation only for git blame.
1569 Likewise, when the LV environment variable is unset, Git sets it to
1571 -c. You can override this setting by exporting LV with another
1572 value or setting core.pager to lv +c.
1573 core.whitespace
1575 A comma separated list of common whitespace problems to notice.
1576 git diff will use color.diff.whitespace to highlight them, and git
1577 apply --whitespace=error will consider them as errors. You can
1578 prefix - to disable any of them (e.g. -trailing-space):
1579 • blank-at-eol treats trailing whitespaces at the end of the line
1581 as an error (enabled by default).
1582 • space-before-tab treats a space character that appears
1584 immediately before a tab character in the initial indent part
1585 of the line as an error (enabled by default).
1586 • indent-with-non-tab treats a line that is indented with space
1588 characters instead of the equivalent tabs as an error (not
1589 enabled by default).
1590 • tab-in-indent treats a tab character in the initial indent part
1592 of the line as an error (not enabled by default).
1593 • blank-at-eof treats blank lines added at the end of file as an
1595 error (enabled by default).
1596 • trailing-space is a short-hand to cover both blank-at-eol and
1598 blank-at-eof.
1599 • cr-at-eol treats a carriage-return at the end of line as part
1601 of the line terminator, i.e. with it, trailing-space does not
1602 trigger if the character before such a carriage-return is not a
1603 whitespace (not enabled by default).
1604 • tabwidth=<n> tells how many character positions a tab occupies;
1606 this is relevant for indent-with-non-tab and when Git fixes
1607 tab-in-indent errors. The default tab width is 8. Allowed
1608 values are 1 to 63.
1609 core.fsync
1611 A comma-separated list of components of the repository that should
1612 be hardened via the core.fsyncMethod when created or modified. You
1613 can disable hardening of any component by prefixing it with a -.
1614 Items that are not hardened may be lost in the event of an unclean
1615 system shutdown. Unless you have special requirements, it is
1616 recommended that you leave this option empty or pick one of
1617 committed, added, or all.
1618 When this configuration is encountered, the set of components
1620 starts with the platform default value, disabled components are
1621 removed, and additional components are added. none resets the
1622 state so that the platform default is ignored.
1623 The empty string resets the fsync configuration to the platform
1625 default. The default on most platforms is equivalent to
1626 core.fsync=committed,-loose-object, which has good performance, but
1627 risks losing recent work in the event of an unclean system
1628 shutdown.
1629 • none clears the set of fsynced components.
1631 • loose-object hardens objects added to the repo in loose-object
1633 form.
1634 • pack hardens objects added to the repo in packfile form.
1636 • pack-metadata hardens packfile bitmaps and indexes.
1638 • commit-graph hardens the commit-graph file.
1640 • index hardens the index when it is modified.
1642 • objects is an aggregate option that is equivalent to
1644 loose-object,pack.
1645 • reference hardens references modified in the repo.
1647 • derived-metadata is an aggregate option that is equivalent to
1649 pack-metadata,commit-graph.
1650 • committed is an aggregate option that is currently equivalent
1652 to objects. This mode sacrifices some performance to ensure
1653 that work that is committed to the repository with git commit
1654 or similar commands is hardened.
1655 • added is an aggregate option that is currently equivalent to
1657 committed,index. This mode sacrifices additional performance to
1658 ensure that the results of commands like git add and similar
1659 operations are hardened.
1660 • all is an aggregate option that syncs all individual components
1662 above.
1663 core.fsyncMethod
1665 A value indicating the strategy Git will use to harden repository
1666 data using fsync and related primitives.
1667 • fsync uses the fsync() system call or platform equivalents.
1669 • writeout-only issues pagecache writeback requests, but
1671 depending on the filesystem and storage hardware, data added to
1672 the repository may not be durable in the event of a system
1673 crash. This is the default mode on macOS.
1674 • batch enables a mode that uses writeout-only flushes to stage
1676 multiple updates in the disk writeback cache and then does a
1677 single full fsync of a dummy file to trigger the disk cache
1678 flush at the end of the operation.
1679 Currently batch mode only applies to loose-object files. Other
1681 repository data is made durable as if fsync was specified. This
1682 mode is expected to be as safe as fsync on macOS for repos
1683 stored on HFS+ or APFS filesystems and on Windows for repos
1684 stored on NTFS or ReFS filesystems.
1685 core.fsyncObjectFiles
1687 This boolean will enable fsync() when writing object files. This
1688 setting is deprecated. Use core.fsync instead.
1689 This setting affects data added to the Git repository in
1691 loose-object form. When set to true, Git will issue an fsync or
1692 similar system call to flush caches so that loose-objects remain
1693 consistent in the face of a unclean system shutdown.
1694 core.preloadIndex
1696 Enable parallel index preload for operations like git diff
1697 This can speed up operations like git diff and git status
1699 especially on filesystems like NFS that have weak caching semantics
1700 and thus relatively high IO latencies. When enabled, Git will do
1701 the index comparison to the filesystem data in parallel, allowing
1702 overlapping IO’s. Defaults to true.
1703 core.unsetenvvars
1705 Windows-only: comma-separated list of environment variables' names
1706 that need to be unset before spawning any other process. Defaults
1707 to PERL5LIB to account for the fact that Git for Windows insists on
1708 using its own Perl interpreter.
1709 core.restrictinheritedhandles
1711 Windows-only: override whether spawned processes inherit only
1712 standard file handles (stdin, stdout and stderr) or all handles.
1713 Can be auto, true or false. Defaults to auto, which means true on
1714 Windows 7 and later, and false on older Windows versions.
1715 core.createObject
1717 You can set this to link, in which case a hardlink followed by a
1718 delete of the source are used to make sure that object creation
1719 will not overwrite existing objects.
1720 On some file system/operating system combinations, this is
1722 unreliable. Set this config setting to rename there; However, This
1723 will remove the check that makes sure that existing object files
1724 will not get overwritten.
1725 core.notesRef
1727 When showing commit messages, also show notes which are stored in
1728 the given ref. The ref must be fully qualified. If the given ref
1729 does not exist, it is not an error but means that no notes should
1730 be printed.
1731 This setting defaults to "refs/notes/commits", and it can be
1733 overridden by the GIT_NOTES_REF environment variable. See git-
1734 notes(1).
1735 core.commitGraph
1737 If true, then git will read the commit-graph file (if it exists) to
1738 parse the graph structure of commits. Defaults to true. See git-
1739 commit-graph(1) for more information.
1740 core.useReplaceRefs
1742 If set to false, behave as if the --no-replace-objects option was
1743 given on the command line. See git(1) and git-replace(1) for more
1744 information.
1745 core.multiPackIndex
1747 Use the multi-pack-index file to track multiple packfiles using a
1748 single index. See git-multi-pack-index(1) for more information.
1749 Defaults to true.
1750 core.sparseCheckout
1752 Enable "sparse checkout" feature. See git-sparse-checkout(1) for
1753 more information.
1754 core.sparseCheckoutCone
1756 Enables the "cone mode" of the sparse checkout feature. When the
1757 sparse-checkout file contains a limited set of patterns, this mode
1758 provides significant performance advantages. The "non-cone mode"
1759 can be requested to allow specifying more flexible patterns by
1760 setting this variable to false. See git-sparse-checkout(1) for more
1761 information.
1762 core.abbrev
1764 Set the length object names are abbreviated to. If unspecified or
1765 set to "auto", an appropriate value is computed based on the
1766 approximate number of packed objects in your repository, which
1767 hopefully is enough for abbreviated object names to stay unique for
1768 some time. If set to "no", no abbreviation is made and the object
1769 names are shown in their full length. The minimum length is 4.
1770 add.ignoreErrors, add.ignore-errors (deprecated)
1772 Tells git add to continue adding files when some files cannot be
1773 added due to indexing errors. Equivalent to the --ignore-errors
1774 option of git-add(1). add.ignore-errors is deprecated, as it does
1775 not follow the usual naming convention for configuration variables.
1776 add.interactive.useBuiltin
1778 Set to false to fall back to the original Perl implementation of
1779 the interactive version of git-add(1) instead of the built-in
1780 version. Is true by default.
1781 alias.*
1783 Command aliases for the git(1) command wrapper - e.g. after
1784 defining alias.last = cat-file commit HEAD, the invocation git last
1785 is equivalent to git cat-file commit HEAD. To avoid confusion and
1786 troubles with script usage, aliases that hide existing Git commands
1787 are ignored. Arguments are split by spaces, the usual shell quoting
1788 and escaping is supported. A quote pair or a backslash can be used
1789 to quote them.
1790 Note that the first word of an alias does not necessarily have to
1792 be a command. It can be a command-line option that will be passed
1793 into the invocation of git. In particular, this is useful when used
1794 with -c to pass in one-time configurations or -p to force
1795 pagination. For example, loud-rebase = -c commit.verbose=true
1796 rebase can be defined such that running git loud-rebase would be
1797 equivalent to git -c commit.verbose=true rebase. Also, ps = -p
1798 status would be a helpful alias since git ps would paginate the
1799 output of git status where the original command does not.
1800 If the alias expansion is prefixed with an exclamation point, it
1802 will be treated as a shell command. For example, defining alias.new
1803 = !gitk --all --not ORIG_HEAD, the invocation git new is equivalent
1804 to running the shell command gitk --all --not ORIG_HEAD. Note that
1805 shell commands will be executed from the top-level directory of a
1806 repository, which may not necessarily be the current directory.
1807 GIT_PREFIX is set as returned by running git rev-parse
1808 --show-prefix from the original current directory. See git-rev-
1809 parse(1).
1810 am.keepcr
1812 If true, git-am will call git-mailsplit for patches in mbox format
1813 with parameter --keep-cr. In this case git-mailsplit will not
1814 remove \r from lines ending with \r\n. Can be overridden by giving
1815 --no-keep-cr from the command line. See git-am(1), git-
1816 mailsplit(1).
1817 am.threeWay
1819 By default, git am will fail if the patch does not apply cleanly.
1820 When set to true, this setting tells git am to fall back on 3-way
1821 merge if the patch records the identity of blobs it is supposed to
1822 apply to and we have those blobs available locally (equivalent to
1823 giving the --3way option from the command line). Defaults to false.
1824 See git-am(1).
1825 apply.ignoreWhitespace
1827 When set to change, tells git apply to ignore changes in
1828 whitespace, in the same way as the --ignore-space-change option.
1829 When set to one of: no, none, never, false tells git apply to
1830 respect all whitespace differences. See git-apply(1).
1831 apply.whitespace
1833 Tells git apply how to handle whitespaces, in the same way as the
1834 --whitespace option. See git-apply(1).
1835 blame.blankBoundary
1837 Show blank commit object name for boundary commits in git-blame(1).
1838 This option defaults to false.
1839 blame.coloring
1841 This determines the coloring scheme to be applied to blame output.
1842 It can be repeatedLines, highlightRecent, or none which is the
1843 default.
1844 blame.date
1846 Specifies the format used to output dates in git-blame(1). If unset
1847 the iso format is used. For supported values, see the discussion of
1848 the --date option at git-log(1).
1849 blame.showEmail
1851 Show the author email instead of author name in git-blame(1). This
1852 option defaults to false.
1853 blame.showRoot
1855 Do not treat root commits as boundaries in git-blame(1). This
1856 option defaults to false.
1857 blame.ignoreRevsFile
1859 Ignore revisions listed in the file, one unabbreviated object name
1860 per line, in git-blame(1). Whitespace and comments beginning with #
1861 are ignored. This option may be repeated multiple times. Empty file
1862 names will reset the list of ignored revisions. This option will be
1863 handled before the command line option --ignore-revs-file.
1864 blame.markUnblamableLines
1866 Mark lines that were changed by an ignored revision that we could
1867 not attribute to another commit with a * in the output of git-
1868 blame(1).
1869 blame.markIgnoredLines
1871 Mark lines that were changed by an ignored revision that we
1872 attributed to another commit with a ? in the output of git-
1873 blame(1).
1874 branch.autoSetupMerge
1876 Tells git branch, git switch and git checkout to set up new
1877 branches so that git-pull(1) will appropriately merge from the
1878 starting point branch. Note that even if this option is not set,
1879 this behavior can be chosen per-branch using the --track and
1880 --no-track options. The valid settings are: false — no automatic
1881 setup is done; true — automatic setup is done when the starting
1882 point is a remote-tracking branch; always — automatic setup is done
1883 when the starting point is either a local branch or remote-tracking
1884 branch; inherit — if the starting point has a tracking
1885 configuration, it is copied to the new branch; simple — automatic
1886 setup is done only when the starting point is a remote-tracking
1887 branch and the new branch has the same name as the remote branch.
1888 This option defaults to true.
1889 branch.autoSetupRebase
1891 When a new branch is created with git branch, git switch or git
1892 checkout that tracks another branch, this variable tells Git to set
1893 up pull to rebase instead of merge (see "branch.<name>.rebase").
1894 When never, rebase is never automatically set to true. When local,
1895 rebase is set to true for tracked branches of other local branches.
1896 When remote, rebase is set to true for tracked branches of
1897 remote-tracking branches. When always, rebase will be set to true
1898 for all tracking branches. See "branch.autoSetupMerge" for details
1899 on how to set up a branch to track another branch. This option
1900 defaults to never.
1901 branch.sort
1903 This variable controls the sort ordering of branches when displayed
1904 by git-branch(1). Without the "--sort=<value>" option provided, the
1905 value of this variable will be used as the default. See git-for-
1906 each-ref(1) field names for valid values.
1907 branch.<name>.remote
1909 When on branch <name>, it tells git fetch and git push which remote
1910 to fetch from/push to. The remote to push to may be overridden with
1911 remote.pushDefault (for all branches). The remote to push to, for
1912 the current branch, may be further overridden by
1913 branch.<name>.pushRemote. If no remote is configured, or if you are
1914 not on any branch and there is more than one remote defined in the
1915 repository, it defaults to origin for fetching and
1916 remote.pushDefault for pushing. Additionally, . (a period) is the
1917 current local repository (a dot-repository), see
1918 branch.<name>.merge's final note below.
1919 branch.<name>.pushRemote
1921 When on branch <name>, it overrides branch.<name>.remote for
1922 pushing. It also overrides remote.pushDefault for pushing from
1923 branch <name>. When you pull from one place (e.g. your upstream)
1924 and push to another place (e.g. your own publishing repository),
1925 you would want to set remote.pushDefault to specify the remote to
1926 push to for all branches, and use this option to override it for a
1927 specific branch.
1928 branch.<name>.merge
1930 Defines, together with branch.<name>.remote, the upstream branch
1931 for the given branch. It tells git fetch/git pull/git rebase which
1932 branch to merge and can also affect git push (see push.default).
1933 When in branch <name>, it tells git fetch the default refspec to be
1934 marked for merging in FETCH_HEAD. The value is handled like the
1935 remote part of a refspec, and must match a ref which is fetched
1936 from the remote given by "branch.<name>.remote". The merge
1937 information is used by git pull (which at first calls git fetch) to
1938 lookup the default branch for merging. Without this option, git
1939 pull defaults to merge the first refspec fetched. Specify multiple
1940 values to get an octopus merge. If you wish to setup git pull so
1941 that it merges into <name> from another branch in the local
1942 repository, you can point branch.<name>.merge to the desired
1943 branch, and use the relative path setting . (a period) for
1944 branch.<name>.remote.
1945 branch.<name>.mergeOptions
1947 Sets default options for merging into branch <name>. The syntax and
1948 supported options are the same as those of git-merge(1), but option
1949 values containing whitespace characters are currently not
1950 supported.
1951 branch.<name>.rebase
1953 When true, rebase the branch <name> on top of the fetched branch,
1954 instead of merging the default branch from the default remote when
1955 "git pull" is run. See "pull.rebase" for doing this in a non
1956 branch-specific manner.
1957 When merges (or just m), pass the --rebase-merges option to git
1959 rebase so that the local merge commits are included in the rebase
1960 (see git-rebase(1) for details).
1961 When the value is interactive (or just i), the rebase is run in
1963 interactive mode.
1964 NOTE: this is a possibly dangerous operation; do not use it unless
1966 you understand the implications (see git-rebase(1) for details).
1967 branch.<name>.description
1969 Branch description, can be edited with git branch
1970 --edit-description. Branch description is automatically added in
1971 the format-patch cover letter or request-pull summary.
1972 browser.<tool>.cmd
1974 Specify the command to invoke the specified browser. The specified
1975 command is evaluated in shell with the URLs passed as arguments.
1976 (See git-web--browse(1).)
1977 browser.<tool>.path
1979 Override the path for the given tool that may be used to browse
1980 HTML help (see -w option in git-help(1)) or a working repository in
1981 gitweb (see git-instaweb(1)).
1982 bundle.*
1984 The bundle.* keys may appear in a bundle list file found via the
1985 git clone --bundle-uri option. These keys currently have no effect
1986 if placed in a repository config file, though this will change in
1987 the future. See the bundle URI design document[1] for more details.
1988 bundle.version
1990 This integer value advertises the version of the bundle list format
1991 used by the bundle list. Currently, the only accepted value is 1.
1992 bundle.mode
1994 This string value should be either all or any. This value describes
1995 whether all of the advertised bundles are required to unbundle a
1996 complete understanding of the bundled information (all) or if any
1997 one of the listed bundle URIs is sufficient (any).
1998 bundle.<id>.*
2000 The bundle.<id>.* keys are used to describe a single item in the
2001 bundle list, grouped under <id> for identification purposes.
2002 bundle.<id>.uri
2004 This string value defines the URI by which Git can reach the
2005 contents of this <id>. This URI may be a bundle file or another
2006 bundle list.
2007 checkout.defaultRemote
2009 When you run git checkout <something> or git switch <something> and
2010 only have one remote, it may implicitly fall back on checking out
2011 and tracking e.g. origin/<something>. This stops working as soon
2012 as you have more than one remote with a <something> reference. This
2013 setting allows for setting the name of a preferred remote that
2014 should always win when it comes to disambiguation. The typical
2015 use-case is to set this to origin.
2016 Currently this is used by git-switch(1) and git-checkout(1) when
2018 git checkout <something> or git switch <something> will checkout
2019 the <something> branch on another remote, and by git-worktree(1)
2020 when git worktree add refers to a remote branch. This setting might
2021 be used for other checkout-like commands or functionality in the
2022 future.
2023 checkout.guess
2025 Provides the default value for the --guess or --no-guess option in
2026 git checkout and git switch. See git-switch(1) and git-checkout(1).
2027 checkout.workers
2029 The number of parallel workers to use when updating the working
2030 tree. The default is one, i.e. sequential execution. If set to a
2031 value less than one, Git will use as many workers as the number of
2032 logical cores available. This setting and
2033 checkout.thresholdForParallelism affect all commands that perform
2034 checkout. E.g. checkout, clone, reset, sparse-checkout, etc.
2035 Note: parallel checkout usually delivers better performance for
2037 repositories located on SSDs or over NFS. For repositories on
2038 spinning disks and/or machines with a small number of cores, the
2039 default sequential checkout often performs better. The size and
2040 compression level of a repository might also influence how well the
2041 parallel version performs.
2042 checkout.thresholdForParallelism
2044 When running parallel checkout with a small number of files, the
2045 cost of subprocess spawning and inter-process communication might
2046 outweigh the parallelization gains. This setting allows to define
2047 the minimum number of files for which parallel checkout should be
2048 attempted. The default is 100.
2049 clean.requireForce
2051 A boolean to make git-clean do nothing unless given -f, -i or -n.
2052 Defaults to true.
2053 clone.defaultRemoteName
2055 The name of the remote to create when cloning a repository.
2056 Defaults to origin, and can be overridden by passing the --origin
2057 command-line option to git-clone(1).
2058 clone.rejectShallow
2060 Reject to clone a repository if it is a shallow one, can be
2061 overridden by passing option --reject-shallow in command line. See
2062 git-clone(1)
2063 clone.filterSubmodules
2065 If a partial clone filter is provided (see --filter in git-rev-
2066 list(1)) and --recurse-submodules is used, also apply the filter to
2067 submodules.
2068 color.advice
2070 A boolean to enable/disable color in hints (e.g. when a push
2071 failed, see advice.* for a list). May be set to always, false (or
2072 never) or auto (or true), in which case colors are used only when
2073 the error output goes to a terminal. If unset, then the value of
2074 color.ui is used (auto by default).
2075 color.advice.hint
2077 Use customized color for hints.
2078 color.blame.highlightRecent
2080 Specify the line annotation color for git blame --color-by-age
2081 depending upon the age of the line.
2082 This setting should be set to a comma-separated list of color and
2084 date settings, starting and ending with a color, the dates should
2085 be set from oldest to newest. The metadata will be colored with the
2086 specified colors if the line was introduced before the given
2087 timestamp, overwriting older timestamped colors.
2088 Instead of an absolute timestamp relative timestamps work as well,
2090 e.g. 2.weeks.ago is valid to address anything older than 2 weeks.
2091 It defaults to blue,12 month ago,white,1 month ago,red, which
2093 colors everything older than one year blue, recent changes between
2094 one month and one year old are kept white, and lines introduced
2095 within the last month are colored red.
2096 color.blame.repeatedLines
2098 Use the specified color to colorize line annotations for git blame
2099 --color-lines, if they come from the same commit as the preceding
2100 line. Defaults to cyan.
2101 color.branch
2103 A boolean to enable/disable color in the output of git-branch(1).
2104 May be set to always, false (or never) or auto (or true), in which
2105 case colors are used only when the output is to a terminal. If
2106 unset, then the value of color.ui is used (auto by default).
2107 color.branch.<slot>
2109 Use customized color for branch coloration. <slot> is one of
2110 current (the current branch), local (a local branch), remote (a
2111 remote-tracking branch in refs/remotes/), upstream (upstream
2112 tracking branch), plain (other refs).
2113 color.diff
2115 Whether to use ANSI escape sequences to add color to patches. If
2116 this is set to always, git-diff(1), git-log(1), and git-show(1)
2117 will use color for all patches. If it is set to true or auto, those
2118 commands will only use color when output is to the terminal. If
2119 unset, then the value of color.ui is used (auto by default).
2120 This does not affect git-format-patch(1) or the git-diff-* plumbing
2122 commands. Can be overridden on the command line with the
2123 --color[=<when>] option.
2124 color.diff.<slot>
2126 Use customized color for diff colorization. <slot> specifies which
2127 part of the patch to use the specified color, and is one of context
2128 (context text - plain is a historical synonym), meta
2129 (metainformation), frag (hunk header), func (function in hunk
2130 header), old (removed lines), new (added lines), commit (commit
2131 headers), whitespace (highlighting whitespace errors), oldMoved
2132 (deleted lines), newMoved (added lines), oldMovedDimmed,
2133 oldMovedAlternative, oldMovedAlternativeDimmed, newMovedDimmed,
2134 newMovedAlternative newMovedAlternativeDimmed (See the <mode>
2135 setting of --color-moved in git-diff(1) for details),
2136 contextDimmed, oldDimmed, newDimmed, contextBold, oldBold, and
2137 newBold (see git-range-diff(1) for details).
2138 color.decorate.<slot>
2140 Use customized color for git log --decorate output. <slot> is one
2141 of branch, remoteBranch, tag, stash or HEAD for local branches,
2142 remote-tracking branches, tags, stash and HEAD, respectively and
2143 grafted for grafted commits.
2144 color.grep
2146 When set to always, always highlight matches. When false (or
2147 never), never. When set to true or auto, use color only when the
2148 output is written to the terminal. If unset, then the value of
2149 color.ui is used (auto by default).
2150 color.grep.<slot>
2152 Use customized color for grep colorization. <slot> specifies which
2153 part of the line to use the specified color, and is one of
2154 context
2156 non-matching text in context lines (when using -A, -B, or -C)
2157 filename
2159 filename prefix (when not using -h)
2160 function
2162 function name lines (when using -p)
2163 lineNumber
2165 line number prefix (when using -n)
2166 column
2168 column number prefix (when using --column)
2169 match
2171 matching text (same as setting matchContext and matchSelected)
2172 matchContext
2174 matching text in context lines
2175 matchSelected
2177 matching text in selected lines. Also, used to customize the
2178 following git-log(1) subcommands: --grep, --author and
2179 --committer.
2180 selected
2182 non-matching text in selected lines. Also, used to customize
2183 the following git-log(1) subcommands: --grep, --author and
2184 --committer.
2185 separator
2187 separators between fields on a line (:, -, and =) and between
2188 hunks (--)
2189 color.interactive
2191 When set to always, always use colors for interactive prompts and
2192 displays (such as those used by "git-add --interactive" and
2193 "git-clean --interactive"). When false (or never), never. When set
2194 to true or auto, use colors only when the output is to the
2195 terminal. If unset, then the value of color.ui is used (auto by
2196 default).
2197 color.interactive.<slot>
2199 Use customized color for git add --interactive and git clean
2200 --interactive output. <slot> may be prompt, header, help or error,
2201 for four distinct types of normal output from interactive commands.
2202 color.pager
2204 A boolean to specify whether auto color modes should colorize
2205 output going to the pager. Defaults to true; set this to false if
2206 your pager does not understand ANSI color codes.
2207 color.push
2209 A boolean to enable/disable color in push errors. May be set to
2210 always, false (or never) or auto (or true), in which case colors
2211 are used only when the error output goes to a terminal. If unset,
2212 then the value of color.ui is used (auto by default).
2213 color.push.error
2215 Use customized color for push errors.
2216 color.remote
2218 If set, keywords at the start of the line are highlighted. The
2219 keywords are "error", "warning", "hint" and "success", and are
2220 matched case-insensitively. May be set to always, false (or never)
2221 or auto (or true). If unset, then the value of color.ui is used
2222 (auto by default).
2223 color.remote.<slot>
2225 Use customized color for each remote keyword. <slot> may be hint,
2226 warning, success or error which match the corresponding keyword.
2227 color.showBranch
2229 A boolean to enable/disable color in the output of git-show-
2230 branch(1). May be set to always, false (or never) or auto (or
2231 true), in which case colors are used only when the output is to a
2232 terminal. If unset, then the value of color.ui is used (auto by
2233 default).
2234 color.status
2236 A boolean to enable/disable color in the output of git-status(1).
2237 May be set to always, false (or never) or auto (or true), in which
2238 case colors are used only when the output is to a terminal. If
2239 unset, then the value of color.ui is used (auto by default).
2240 color.status.<slot>
2242 Use customized color for status colorization. <slot> is one of
2243 header (the header text of the status message), added or updated
2244 (files which are added but not committed), changed (files which are
2245 changed but not added in the index), untracked (files which are not
2246 tracked by Git), branch (the current branch), nobranch (the color
2247 the no branch warning is shown in, defaulting to red), localBranch
2248 or remoteBranch (the local and remote branch names, respectively,
2249 when branch and tracking information is displayed in the status
2250 short-format), or unmerged (files which have unmerged changes).
2251 color.transport
2253 A boolean to enable/disable color when pushes are rejected. May be
2254 set to always, false (or never) or auto (or true), in which case
2255 colors are used only when the error output goes to a terminal. If
2256 unset, then the value of color.ui is used (auto by default).
2257 color.transport.rejected
2259 Use customized color when a push was rejected.
2260 color.ui
2262 This variable determines the default value for variables such as
2263 color.diff and color.grep that control the use of color per command
2264 family. Its scope will expand as more commands learn configuration
2265 to set a default for the --color option. Set it to false or never
2266 if you prefer Git commands not to use color unless enabled
2267 explicitly with some other configuration or the --color option. Set
2268 it to always if you want all output not intended for machine
2269 consumption to use color, to true or auto (this is the default
2270 since Git 1.8.4) if you want such output to use color when written
2271 to the terminal.
2272 column.ui
2274 Specify whether supported commands should output in columns. This
2275 variable consists of a list of tokens separated by spaces or
2276 commas:
2277 These options control when the feature should be enabled (defaults
2279 to never):
2280 always
2282 always show in columns
2283 never
2285 never show in columns
2286 auto
2288 show in columns if the output is to the terminal
2289 These options control layout (defaults to column). Setting any of
2291 these implies always if none of always, never, or auto are
2292 specified.
2293 column
2295 fill columns before rows
2296 row
2298 fill rows before columns
2299 plain
2301 show in one column
2302 Finally, these options can be combined with a layout option
2304 (defaults to nodense):
2305 dense
2307 make unequal size columns to utilize more space
2308 nodense
2310 make equal size columns
2311 column.branch
2313 Specify whether to output branch listing in git branch in columns.
2314 See column.ui for details.
2315 column.clean
2317 Specify the layout when list items in git clean -i, which always
2318 shows files and directories in columns. See column.ui for details.
2319 column.status
2321 Specify whether to output untracked files in git status in columns.
2322 See column.ui for details.
2323 column.tag
2325 Specify whether to output tag listing in git tag in columns. See
2326 column.ui for details.
2327 commit.cleanup
2329 This setting overrides the default of the --cleanup option in git
2330 commit. See git-commit(1) for details. Changing the default can be
2331 useful when you always want to keep lines that begin with comment
2332 character # in your log message, in which case you would do git
2333 config commit.cleanup whitespace (note that you will have to remove
2334 the help lines that begin with # in the commit log template
2335 yourself, if you do this).
2336 commit.gpgSign
2338 A boolean to specify whether all commits should be GPG signed. Use
2339 of this option when doing operations such as rebase can result in a
2340 large number of commits being signed. It may be convenient to use
2341 an agent to avoid typing your GPG passphrase several times.
2342 commit.status
2344 A boolean to enable/disable inclusion of status information in the
2345 commit message template when using an editor to prepare the commit
2346 message. Defaults to true.
2347 commit.template
2349 Specify the pathname of a file to use as the template for new
2350 commit messages.
2351 commit.verbose
2353 A boolean or int to specify the level of verbose with git commit.
2354 See git-commit(1).
2355 commitGraph.generationVersion
2357 Specifies the type of generation number version to use when writing
2358 or reading the commit-graph file. If version 1 is specified, then
2359 the corrected commit dates will not be written or read. Defaults to
2360 2.
2361 commitGraph.maxNewFilters
2363 Specifies the default value for the --max-new-filters option of git
2364 commit-graph write (c.f., git-commit-graph(1)).
2365 commitGraph.readChangedPaths
2367 If true, then git will use the changed-path Bloom filters in the
2368 commit-graph file (if it exists, and they are present). Defaults to
2369 true. See git-commit-graph(1) for more information.
2370 credential.helper
2372 Specify an external helper to be called when a username or password
2373 credential is needed; the helper may consult external storage to
2374 avoid prompting the user for the credentials. This is normally the
2375 name of a credential helper with possible arguments, but may also
2376 be an absolute path with arguments or, if preceded by !, shell
2377 commands.
2378 Note that multiple helpers may be defined. See gitcredentials(7)
2380 for details and examples.
2381 credential.useHttpPath
2383 When acquiring credentials, consider the "path" component of an
2384 http or https URL to be important. Defaults to false. See
2385 gitcredentials(7) for more information.
2386 credential.username
2388 If no username is set for a network authentication, use this
2389 username by default. See credential.<context>.* below, and
2390 gitcredentials(7).
2391 credential.<url>.*
2393 Any of the credential.* options above can be applied selectively to
2394 some credentials. For example
2395 "credential.https://example.com.username" would set the default
2396 username only for https connections to example.com. See
2397 gitcredentials(7) for details on how URLs are matched.
2398 credentialCache.ignoreSIGHUP
2400 Tell git-credential-cache—daemon to ignore SIGHUP, instead of
2401 quitting.
2402 credentialStore.lockTimeoutMS
2404 The length of time, in milliseconds, for git-credential-store to
2405 retry when trying to lock the credentials file. Value 0 means not
2406 to retry at all; -1 means to try indefinitely. Default is 1000
2407 (i.e., retry for 1s).
2408 completion.commands
2410 This is only used by git-completion.bash to add or remove commands
2411 from the list of completed commands. Normally only porcelain
2412 commands and a few select others are completed. You can add more
2413 commands, separated by space, in this variable. Prefixing the
2414 command with - will remove it from the existing list.
2415 diff.autoRefreshIndex
2417 When using git diff to compare with work tree files, do not
2418 consider stat-only change as changed. Instead, silently run git
2419 update-index --refresh to update the cached stat information for
2420 paths whose contents in the work tree match the contents in the
2421 index. This option defaults to true. Note that this affects only
2422 git diff Porcelain, and not lower level diff commands such as git
2423 diff-files.
2424 diff.dirstat
2426 A comma separated list of --dirstat parameters specifying the
2427 default behavior of the --dirstat option to git-diff(1) and
2428 friends. The defaults can be overridden on the command line (using
2429 --dirstat=<param1,param2,...>). The fallback defaults (when not
2430 changed by diff.dirstat) are changes,noncumulative,3. The following
2431 parameters are available:
2432 changes
2434 Compute the dirstat numbers by counting the lines that have
2435 been removed from the source, or added to the destination. This
2436 ignores the amount of pure code movements within a file. In
2437 other words, rearranging lines in a file is not counted as much
2438 as other changes. This is the default behavior when no
2439 parameter is given.
2440 lines
2442 Compute the dirstat numbers by doing the regular line-based
2443 diff analysis, and summing the removed/added line counts. (For
2444 binary files, count 64-byte chunks instead, since binary files
2445 have no natural concept of lines). This is a more expensive
2446 --dirstat behavior than the changes behavior, but it does count
2447 rearranged lines within a file as much as other changes. The
2448 resulting output is consistent with what you get from the other
2449 --*stat options.
2450 files
2452 Compute the dirstat numbers by counting the number of files
2453 changed. Each changed file counts equally in the dirstat
2454 analysis. This is the computationally cheapest --dirstat
2455 behavior, since it does not have to look at the file contents
2456 at all.
2457 cumulative
2459 Count changes in a child directory for the parent directory as
2460 well. Note that when using cumulative, the sum of the
2461 percentages reported may exceed 100%. The default
2462 (non-cumulative) behavior can be specified with the
2463 noncumulative parameter.
2464 <limit>
2466 An integer parameter specifies a cut-off percent (3% by
2467 default). Directories contributing less than this percentage of
2468 the changes are not shown in the output.
2469 Example: The following will count changed files, while ignoring
2471 directories with less than 10% of the total amount of changed
2472 files, and accumulating child directory counts in the parent
2473 directories: files,10,cumulative.
2474 diff.statGraphWidth
2476 Limit the width of the graph part in --stat output. If set, applies
2477 to all commands generating --stat output except format-patch.
2478 diff.context
2480 Generate diffs with <n> lines of context instead of the default of
2481 3. This value is overridden by the -U option.
2482 diff.interHunkContext
2484 Show the context between diff hunks, up to the specified number of
2485 lines, thereby fusing the hunks that are close to each other. This
2486 value serves as the default for the --inter-hunk-context command
2487 line option.
2488 diff.external
2490 If this config variable is set, diff generation is not performed
2491 using the internal diff machinery, but using the given command. Can
2492 be overridden with the “GIT_EXTERNAL_DIFF” environment variable.
2493 The command is called with parameters as described under "git
2494 Diffs" in git(1). Note: if you want to use an external diff program
2495 only on a subset of your files, you might want to use
2496 gitattributes(5) instead.
2497 diff.ignoreSubmodules
2499 Sets the default value of --ignore-submodules. Note that this
2500 affects only git diff Porcelain, and not lower level diff commands
2501 such as git diff-files. git checkout and git switch also honor
2502 this setting when reporting uncommitted changes. Setting it to all
2503 disables the submodule summary normally shown by git commit and git
2504 status when status.submoduleSummary is set unless it is overridden
2505 by using the --ignore-submodules command-line option. The git
2506 submodule commands are not affected by this setting. By default
2507 this is set to untracked so that any untracked submodules are
2508 ignored.
2509 diff.mnemonicPrefix
2511 If set, git diff uses a prefix pair that is different from the
2512 standard "a/" and "b/" depending on what is being compared. When
2513 this configuration is in effect, reverse diff output also swaps the
2514 order of the prefixes:
2515 git diff
2517 compares the (i)ndex and the (w)ork tree;
2518 git diff HEAD
2520 compares a (c)ommit and the (w)ork tree;
2521 git diff --cached
2523 compares a (c)ommit and the (i)ndex;
2524 git diff HEAD:file1 file2
2526 compares an (o)bject and a (w)ork tree entity;
2527 git diff --no-index a b
2529 compares two non-git things (1) and (2).
2530 diff.noprefix
2532 If set, git diff does not show any source or destination prefix.
2533 diff.relative
2535 If set to true, git diff does not show changes outside of the
2536 directory and show pathnames relative to the current directory.
2537 diff.orderFile
2539 File indicating how to order files within a diff. See the -O option
2540 to git-diff(1) for details. If diff.orderFile is a relative
2541 pathname, it is treated as relative to the top of the working tree.
2542 diff.renameLimit
2544 The number of files to consider in the exhaustive portion of
2545 copy/rename detection; equivalent to the git diff option -l. If not
2546 set, the default value is currently 1000. This setting has no
2547 effect if rename detection is turned off.
2548 diff.renames
2550 Whether and how Git detects renames. If set to "false", rename
2551 detection is disabled. If set to "true", basic rename detection is
2552 enabled. If set to "copies" or "copy", Git will detect copies, as
2553 well. Defaults to true. Note that this affects only git diff
2554 Porcelain like git-diff(1) and git-log(1), and not lower level
2555 commands such as git-diff-files(1).
2556 diff.suppressBlankEmpty
2558 A boolean to inhibit the standard behavior of printing a space
2559 before each empty output line. Defaults to false.
2560 diff.submodule
2562 Specify the format in which differences in submodules are shown.
2563 The "short" format just shows the names of the commits at the
2564 beginning and end of the range. The "log" format lists the commits
2565 in the range like git-submodule(1) summary does. The "diff" format
2566 shows an inline diff of the changed contents of the submodule.
2567 Defaults to "short".
2568 diff.wordRegex
2570 A POSIX Extended Regular Expression used to determine what is a
2571 "word" when performing word-by-word difference calculations.
2572 Character sequences that match the regular expression are "words",
2573 all other characters are ignorable whitespace.
2574 diff.<driver>.command
2576 The custom diff driver command. See gitattributes(5) for details.
2577 diff.<driver>.xfuncname
2579 The regular expression that the diff driver should use to recognize
2580 the hunk header. A built-in pattern may also be used. See
2581 gitattributes(5) for details.
2582 diff.<driver>.binary
2584 Set this option to true to make the diff driver treat files as
2585 binary. See gitattributes(5) for details.
2586 diff.<driver>.textconv
2588 The command that the diff driver should call to generate the
2589 text-converted version of a file. The result of the conversion is
2590 used to generate a human-readable diff. See gitattributes(5) for
2591 details.
2592 diff.<driver>.wordRegex
2594 The regular expression that the diff driver should use to split
2595 words in a line. See gitattributes(5) for details.
2596 diff.<driver>.cachetextconv
2598 Set this option to true to make the diff driver cache the text
2599 conversion outputs. See gitattributes(5) for details.
2600 araxis
2602 Use Araxis Merge (requires a graphical session)
2603 bc
2605 Use Beyond Compare (requires a graphical session)
2606 bc3
2608 Use Beyond Compare (requires a graphical session)
2609 bc4
2611 Use Beyond Compare (requires a graphical session)
2612 codecompare
2614 Use Code Compare (requires a graphical session)
2615 deltawalker
2617 Use DeltaWalker (requires a graphical session)
2618 diffmerge
2620 Use DiffMerge (requires a graphical session)
2621 diffuse
2623 Use Diffuse (requires a graphical session)
2624 ecmerge
2626 Use ECMerge (requires a graphical session)
2627 emerge
2629 Use Emacs' Emerge
2630 examdiff
2632 Use ExamDiff Pro (requires a graphical session)
2633 guiffy
2635 Use Guiffy’s Diff Tool (requires a graphical session)
2636 gvimdiff
2638 Use gVim (requires a graphical session)
2639 kdiff3
2641 Use KDiff3 (requires a graphical session)
2642 kompare
2644 Use Kompare (requires a graphical session)
2645 meld
2647 Use Meld (requires a graphical session)
2648 nvimdiff
2650 Use Neovim
2651 opendiff
2653 Use FileMerge (requires a graphical session)
2654 p4merge
2656 Use HelixCore P4Merge (requires a graphical session)
2657 smerge
2659 Use Sublime Merge (requires a graphical session)
2660 tkdiff
2662 Use TkDiff (requires a graphical session)
2663 vimdiff
2665 Use Vim
2666 winmerge
2668 Use WinMerge (requires a graphical session)
2669 xxdiff
2671 Use xxdiff (requires a graphical session)
2672 diff.indentHeuristic
2674 Set this option to false to disable the default heuristics that
2675 shift diff hunk boundaries to make patches easier to read.
2676 diff.algorithm
2678 Choose a diff algorithm. The variants are as follows:
2679 default, myers
2681 The basic greedy diff algorithm. Currently, this is the
2682 default.
2683 minimal
2685 Spend extra time to make sure the smallest possible diff is
2686 produced.
2687 patience
2689 Use "patience diff" algorithm when generating patches.
2690 histogram
2692 This algorithm extends the patience algorithm to "support
2693 low-occurrence common elements".
2694 diff.wsErrorHighlight
2696 Highlight whitespace errors in the context, old or new lines of the
2697 diff. Multiple values are separated by comma, none resets previous
2698 values, default reset the list to new and all is a shorthand for
2699 old,new,context. The whitespace errors are colored with
2700 color.diff.whitespace. The command line option
2701 --ws-error-highlight=<kind> overrides this setting.
2702 diff.colorMoved
2704 If set to either a valid <mode> or a true value, moved lines in a
2705 diff are colored differently, for details of valid modes see
2706 --color-moved in git-diff(1). If simply set to true the default
2707 color mode will be used. When set to false, moved lines are not
2708 colored.
2709 diff.colorMovedWS
2711 When moved lines are colored using e.g. the diff.colorMoved
2712 setting, this option controls the <mode> how spaces are treated for
2713 details of valid modes see --color-moved-ws in git-diff(1).
2714 diff.tool
2716 Controls which diff tool is used by git-difftool(1). This variable
2717 overrides the value configured in merge.tool. The list below shows
2718 the valid built-in values. Any other value is treated as a custom
2719 diff tool and requires that a corresponding difftool.<tool>.cmd
2720 variable is defined.
2721 diff.guitool
2723 Controls which diff tool is used by git-difftool(1) when the
2724 -g/--gui flag is specified. This variable overrides the value
2725 configured in merge.guitool. The list below shows the valid
2726 built-in values. Any other value is treated as a custom diff tool
2727 and requires that a corresponding difftool.<guitool>.cmd variable
2728 is defined.
2729 difftool.<tool>.cmd
2731 Specify the command to invoke the specified diff tool. The
2732 specified command is evaluated in shell with the following
2733 variables available: LOCAL is set to the name of the temporary file
2734 containing the contents of the diff pre-image and REMOTE is set to
2735 the name of the temporary file containing the contents of the diff
2736 post-image.
2737 See the --tool=<tool> option in git-difftool(1) for more details.
2739 difftool.<tool>.path
2741 Override the path for the given tool. This is useful in case your
2742 tool is not in the PATH.
2743 difftool.trustExitCode
2745 Exit difftool if the invoked diff tool returns a non-zero exit
2746 status.
2747 See the --trust-exit-code option in git-difftool(1) for more
2749 details.
2750 difftool.prompt
2752 Prompt before each invocation of the diff tool.
2753 extensions.objectFormat
2755 Specify the hash algorithm to use. The acceptable values are sha1
2756 and sha256. If not specified, sha1 is assumed. It is an error to
2757 specify this key unless core.repositoryFormatVersion is 1.
2758 Note that this setting should only be set by git-init(1) or git-
2760 clone(1). Trying to change it after initialization will not work
2761 and will produce hard-to-diagnose issues.
2762 extensions.worktreeConfig
2764 If enabled, then worktrees will load config settings from the
2765 $GIT_DIR/config.worktree file in addition to the
2766 $GIT_COMMON_DIR/config file. Note that $GIT_COMMON_DIR and $GIT_DIR
2767 are the same for the main working tree, while other working trees
2768 have $GIT_DIR equal to $GIT_COMMON_DIR/worktrees/<id>/. The
2769 settings in the config.worktree file will override settings from
2770 any other config files.
2771 When enabling extensions.worktreeConfig, you must be careful to
2773 move certain values from the common config file to the main working
2774 tree’s config.worktree file, if present:
2775 • core.worktree must be moved from $GIT_COMMON_DIR/config to
2777 $GIT_COMMON_DIR/config.worktree.
2778 • If core.bare is true, then it must be moved from
2780 $GIT_COMMON_DIR/config to $GIT_COMMON_DIR/config.worktree.
2781 It may also be beneficial to adjust the locations of
2783 core.sparseCheckout and core.sparseCheckoutCone depending on
2784 your desire for customizable sparse-checkout settings for each
2785 worktree. By default, the git sparse-checkout builtin enables
2786 extensions.worktreeConfig, assigns these config values on a
2787 per-worktree basis, and uses the $GIT_DIR/info/sparse-checkout
2788 file to specify the sparsity for each worktree independently.
2789 See git-sparse-checkout(1) for more details.
2790 For historical reasons, extensions.worktreeConfig is respected
2792 regardless of the core.repositoryFormatVersion setting.
2793 fastimport.unpackLimit
2795 If the number of objects imported by git-fast-import(1) is below
2796 this limit, then the objects will be unpacked into loose object
2797 files. However if the number of imported objects equals or exceeds
2798 this limit then the pack will be stored as a pack. Storing the pack
2799 from a fast-import can make the import operation complete faster,
2800 especially on slow filesystems. If not set, the value of
2801 transfer.unpackLimit is used instead.
2802 feature.*
2804 The config settings that start with feature. modify the defaults
2805 of a group of other config settings. These groups are created by
2806 the Git developer community as recommended defaults and are subject
2807 to change. In particular, new config options may be added with
2808 different defaults.
2809 feature.experimental
2811 Enable config options that are new to Git, and are being considered
2812 for future defaults. Config settings included here may be added or
2813 removed with each release, including minor version updates. These
2814 settings may have unintended interactions since they are so new.
2815 Please enable this setting if you are interested in providing
2816 feedback on experimental features. The new default values are:
2817 • fetch.negotiationAlgorithm=skipping may improve fetch
2819 negotiation times by skipping more commits at a time, reducing
2820 the number of round trips.
2821 • gc.cruftPacks=true reduces disk space used by unreachable
2823 objects during garbage collection, preventing loose object
2824 explosions.
2825 feature.manyFiles
2827 Enable config options that optimize for repos with many files in
2828 the working directory. With many files, commands such as git status
2829 and git checkout may be slow and these new defaults improve
2830 performance:
2831 • index.version=4 enables path-prefix compression in the index.
2833 • core.untrackedCache=true enables the untracked cache. This
2835 setting assumes that mtime is working on your machine.
2836 fetch.recurseSubmodules
2838 This option controls whether git fetch (and the underlying fetch in
2839 git pull) will recursively fetch into populated submodules. This
2840 option can be set either to a boolean value or to on-demand.
2841 Setting it to a boolean changes the behavior of fetch and pull to
2842 recurse unconditionally into submodules when set to true or to not
2843 recurse at all when set to false. When set to on-demand, fetch and
2844 pull will only recurse into a populated submodule when its
2845 superproject retrieves a commit that updates the submodule’s
2846 reference. Defaults to on-demand, or to the value of
2847 submodule.recurse if set.
2848 fetch.fsckObjects
2850 If it is set to true, git-fetch-pack will check all fetched
2851 objects. See transfer.fsckObjects for what’s checked. Defaults to
2852 false. If not set, the value of transfer.fsckObjects is used
2853 instead.
2854 fetch.fsck.<msg-id>
2856 Acts like fsck.<msg-id>, but is used by git-fetch-pack(1) instead
2857 of git-fsck(1). See the fsck.<msg-id> documentation for details.
2858 fetch.fsck.skipList
2860 Acts like fsck.skipList, but is used by git-fetch-pack(1) instead
2861 of git-fsck(1). See the fsck.skipList documentation for details.
2862 fetch.unpackLimit
2864 If the number of objects fetched over the Git native transfer is
2865 below this limit, then the objects will be unpacked into loose
2866 object files. However if the number of received objects equals or
2867 exceeds this limit then the received pack will be stored as a pack,
2868 after adding any missing delta bases. Storing the pack from a push
2869 can make the push operation complete faster, especially on slow
2870 filesystems. If not set, the value of transfer.unpackLimit is used
2871 instead.
2872 fetch.prune
2874 If true, fetch will automatically behave as if the --prune option
2875 was given on the command line. See also remote.<name>.prune and the
2876 PRUNING section of git-fetch(1).
2877 fetch.pruneTags
2879 If true, fetch will automatically behave as if the
2880 refs/tags/*:refs/tags/* refspec was provided when pruning, if not
2881 set already. This allows for setting both this option and
2882 fetch.prune to maintain a 1=1 mapping to upstream refs. See also
2883 remote.<name>.pruneTags and the PRUNING section of git-fetch(1).
2884 fetch.output
2886 Control how ref update status is printed. Valid values are full and
2887 compact. Default value is full. See section OUTPUT in git-fetch(1)
2888 for detail.
2889 fetch.negotiationAlgorithm
2891 Control how information about the commits in the local repository
2892 is sent when negotiating the contents of the packfile to be sent by
2893 the server. Set to "consecutive" to use an algorithm that walks
2894 over consecutive commits checking each one. Set to "skipping" to
2895 use an algorithm that skips commits in an effort to converge
2896 faster, but may result in a larger-than-necessary packfile; or set
2897 to "noop" to not send any information at all, which will almost
2898 certainly result in a larger-than-necessary packfile, but will skip
2899 the negotiation step. Set to "default" to override settings made
2900 previously and use the default behaviour. The default is normally
2901 "consecutive", but if feature.experimental is true, then the
2902 default is "skipping". Unknown values will cause git fetch to error
2903 out.
2904 See also the --negotiate-only and --negotiation-tip options to git-
2906 fetch(1).
2907 fetch.showForcedUpdates
2909 Set to false to enable --no-show-forced-updates in git-fetch(1) and
2910 git-pull(1) commands. Defaults to true.
2911 fetch.parallel
2913 Specifies the maximal number of fetch operations to be run in
2914 parallel at a time (submodules, or remotes when the --multiple
2915 option of git-fetch(1) is in effect).
2916 A value of 0 will give some reasonable default. If unset, it
2918 defaults to 1.
2919 For submodules, this setting can be overridden using the
2921 submodule.fetchJobs config setting.
2922 fetch.writeCommitGraph
2924 Set to true to write a commit-graph after every git fetch command
2925 that downloads a pack-file from a remote. Using the --split option,
2926 most executions will create a very small commit-graph file on top
2927 of the existing commit-graph file(s). Occasionally, these files
2928 will merge and the write may take longer. Having an updated
2929 commit-graph file helps performance of many Git commands, including
2930 git merge-base, git push -f, and git log --graph. Defaults to
2931 false.
2932 format.attach
2934 Enable multipart/mixed attachments as the default for format-patch.
2935 The value can also be a double quoted string which will enable
2936 attachments as the default and set the value as the boundary. See
2937 the --attach option in git-format-patch(1).
2938 format.from
2940 Provides the default value for the --from option to format-patch.
2941 Accepts a boolean value, or a name and email address. If false,
2942 format-patch defaults to --no-from, using commit authors directly
2943 in the "From:" field of patch mails. If true, format-patch defaults
2944 to --from, using your committer identity in the "From:" field of
2945 patch mails and including a "From:" field in the body of the patch
2946 mail if different. If set to a non-boolean value, format-patch uses
2947 that value instead of your committer identity. Defaults to false.
2948 format.forceInBodyFrom
2950 Provides the default value for the --[no-]force-in-body-from option
2951 to format-patch. Defaults to false.
2952 format.numbered
2954 A boolean which can enable or disable sequence numbers in patch
2955 subjects. It defaults to "auto" which enables it only if there is
2956 more than one patch. It can be enabled or disabled for all messages
2957 by setting it to "true" or "false". See --numbered option in git-
2958 format-patch(1).
2959 format.headers
2961 Additional email headers to include in a patch to be submitted by
2962 mail. See git-format-patch(1).
2963 format.to, format.cc
2965 Additional recipients to include in a patch to be submitted by
2966 mail. See the --to and --cc options in git-format-patch(1).
2967 format.subjectPrefix
2969 The default for format-patch is to output files with the [PATCH]
2970 subject prefix. Use this variable to change that prefix.
2971 format.coverFromDescription
2973 The default mode for format-patch to determine which parts of the
2974 cover letter will be populated using the branch’s description. See
2975 the --cover-from-description option in git-format-patch(1).
2976 format.signature
2978 The default for format-patch is to output a signature containing
2979 the Git version number. Use this variable to change that default.
2980 Set this variable to the empty string ("") to suppress signature
2981 generation.
2982 format.signatureFile
2984 Works just like format.signature except the contents of the file
2985 specified by this variable will be used as the signature.
2986 format.suffix
2988 The default for format-patch is to output files with the suffix
2989 .patch. Use this variable to change that suffix (make sure to
2990 include the dot if you want it).
2991 format.encodeEmailHeaders
2993 Encode email headers that have non-ASCII characters with
2994 "Q-encoding" (described in RFC 2047) for email transmission.
2995 Defaults to true.
2996 format.pretty
2998 The default pretty format for log/show/whatchanged command, See
2999 git-log(1), git-show(1), git-whatchanged(1).
3000 format.thread
3002 The default threading style for git format-patch. Can be a boolean
3003 value, or shallow or deep. shallow threading makes every mail a
3004 reply to the head of the series, where the head is chosen from the
3005 cover letter, the --in-reply-to, and the first patch mail, in this
3006 order. deep threading makes every mail a reply to the previous
3007 one. A true boolean value is the same as shallow, and a false value
3008 disables threading.
3009 format.signOff
3011 A boolean value which lets you enable the -s/--signoff option of
3012 format-patch by default. Note: Adding the Signed-off-by trailer to
3013 a patch should be a conscious act and means that you certify you
3014 have the rights to submit this work under the same open source
3015 license. Please see the SubmittingPatches document for further
3016 discussion.
3017 format.coverLetter
3019 A boolean that controls whether to generate a cover-letter when
3020 format-patch is invoked, but in addition can be set to "auto", to
3021 generate a cover-letter only when there’s more than one patch.
3022 Default is false.
3023 format.outputDirectory
3025 Set a custom directory to store the resulting files instead of the
3026 current working directory. All directory components will be
3027 created.
3028 format.filenameMaxLength
3030 The maximum length of the output filenames generated by the
3031 format-patch command; defaults to 64. Can be overridden by the
3032 --filename-max-length=<n> command line option.
3033 format.useAutoBase
3035 A boolean value which lets you enable the --base=auto option of
3036 format-patch by default. Can also be set to "whenAble" to allow
3037 enabling --base=auto if a suitable base is available, but to skip
3038 adding base info otherwise without the format dying.
3039 format.notes
3041 Provides the default value for the --notes option to format-patch.
3042 Accepts a boolean value, or a ref which specifies where to get
3043 notes. If false, format-patch defaults to --no-notes. If true,
3044 format-patch defaults to --notes. If set to a non-boolean value,
3045 format-patch defaults to --notes=<ref>, where ref is the
3046 non-boolean value. Defaults to false.
3047 If one wishes to use the ref ref/notes/true, please use that
3049 literal instead.
3050 This configuration can be specified multiple times in order to
3052 allow multiple notes refs to be included. In that case, it will
3053 behave similarly to multiple --[no-]notes[=] options passed in.
3054 That is, a value of true will show the default notes, a value of
3055 <ref> will also show notes from that notes ref and a value of false
3056 will negate previous configurations and not show notes.
3057 For example,
3059 [format]
3061 notes = true
3062 notes = foo
3063 notes = false
3064 notes = bar
3065 will only show notes from refs/notes/bar.
3067 filter.<driver>.clean
3069 The command which is used to convert the content of a worktree file
3070 to a blob upon checkin. See gitattributes(5) for details.
3071 filter.<driver>.smudge
3073 The command which is used to convert the content of a blob object
3074 to a worktree file upon checkout. See gitattributes(5) for details.
3075 fsck.<msg-id>
3077 During fsck git may find issues with legacy data which wouldn’t be
3078 generated by current versions of git, and which wouldn’t be sent
3079 over the wire if transfer.fsckObjects was set. This feature is
3080 intended to support working with legacy repositories containing
3081 such data.
3082 Setting fsck.<msg-id> will be picked up by git-fsck(1), but to
3084 accept pushes of such data set receive.fsck.<msg-id> instead, or to
3085 clone or fetch it set fetch.fsck.<msg-id>.
3086 The rest of the documentation discusses fsck.* for brevity, but
3088 the same applies for the corresponding receive.fsck.* and
3089 fetch.<msg-id>.*. variables.
3090 Unlike variables like color.ui and core.editor the
3092 receive.fsck.<msg-id> and fetch.fsck.<msg-id> variables will not
3093 fall back on the fsck.<msg-id> configuration if they aren’t set. To
3094 uniformly configure the same fsck settings in different
3095 circumstances all three of them they must all set to the same
3096 values.
3097 When fsck.<msg-id> is set, errors can be switched to warnings and
3099 vice versa by configuring the fsck.<msg-id> setting where the
3100 <msg-id> is the fsck message ID and the value is one of error, warn
3101 or ignore. For convenience, fsck prefixes the error/warning with
3102 the message ID, e.g. "missingEmail: invalid author/committer line -
3103 missing email" means that setting fsck.missingEmail = ignore will
3104 hide that issue.
3105 In general, it is better to enumerate existing objects with
3107 problems with fsck.skipList, instead of listing the kind of
3108 breakages these problematic objects share to be ignored, as doing
3109 the latter will allow new instances of the same breakages go
3110 unnoticed.
3111 Setting an unknown fsck.<msg-id> value will cause fsck to die, but
3113 doing the same for receive.fsck.<msg-id> and fetch.fsck.<msg-id>
3114 will only cause git to warn.
3115 See Fsck Messages section of git-fsck(1) for supported values of
3117 <msg-id>.
3118 fsck.skipList
3120 The path to a list of object names (i.e. one unabbreviated SHA-1
3121 per line) that are known to be broken in a non-fatal way and should
3122 be ignored. On versions of Git 2.20 and later comments (#), empty
3123 lines, and any leading and trailing whitespace is ignored.
3124 Everything but a SHA-1 per line will error out on older versions.
3125 This feature is useful when an established project should be
3127 accepted despite early commits containing errors that can be safely
3128 ignored such as invalid committer email addresses. Note: corrupt
3129 objects cannot be skipped with this setting.
3130 Like fsck.<msg-id> this variable has corresponding
3132 receive.fsck.skipList and fetch.fsck.skipList variants.
3133 Unlike variables like color.ui and core.editor the
3135 receive.fsck.skipList and fetch.fsck.skipList variables will not
3136 fall back on the fsck.skipList configuration if they aren’t set. To
3137 uniformly configure the same fsck settings in different
3138 circumstances all three of them they must all set to the same
3139 values.
3140 Older versions of Git (before 2.20) documented that the object
3142 names list should be sorted. This was never a requirement, the
3143 object names could appear in any order, but when reading the list
3144 we tracked whether the list was sorted for the purposes of an
3145 internal binary search implementation, which could save itself some
3146 work with an already sorted list. Unless you had a humongous list
3147 there was no reason to go out of your way to pre-sort the list.
3148 After Git version 2.20 a hash implementation is used instead, so
3149 there’s now no reason to pre-sort the list.
3150 fsmonitor.allowRemote
3152 By default, the fsmonitor daemon refuses to work against
3153 network-mounted repositories. Setting fsmonitor.allowRemote to true
3154 overrides this behavior. Only respected when core.fsmonitor is set
3155 to true.
3156 fsmonitor.socketDir
3158 This Mac OS-specific option, if set, specifies the directory in
3159 which to create the Unix domain socket used for communication
3160 between the fsmonitor daemon and various Git commands. The
3161 directory must reside on a native Mac OS filesystem. Only respected
3162 when core.fsmonitor is set to true.
3163 gc.aggressiveDepth
3165 The depth parameter used in the delta compression algorithm used by
3166 git gc --aggressive. This defaults to 50, which is the default for
3167 the --depth option when --aggressive isn’t in use.
3168 See the documentation for the --depth option in git-repack(1) for
3170 more details.
3171 gc.aggressiveWindow
3173 The window size parameter used in the delta compression algorithm
3174 used by git gc --aggressive. This defaults to 250, which is a much
3175 more aggressive window size than the default --window of 10.
3176 See the documentation for the --window option in git-repack(1) for
3178 more details.
3179 gc.auto
3181 When there are approximately more than this many loose objects in
3182 the repository, git gc --auto will pack them. Some Porcelain
3183 commands use this command to perform a light-weight garbage
3184 collection from time to time. The default value is 6700.
3185 Setting this to 0 disables not only automatic packing based on the
3187 number of loose objects, but any other heuristic git gc --auto will
3188 otherwise use to determine if there’s work to do, such as
3189 gc.autoPackLimit.
3190 gc.autoPackLimit
3192 When there are more than this many packs that are not marked with
3193 *.keep file in the repository, git gc --auto consolidates them into
3194 one larger pack. The default value is 50. Setting this to 0
3195 disables it. Setting gc.auto to 0 will also disable this.
3196 See the gc.bigPackThreshold configuration variable below. When in
3198 use, it’ll affect how the auto pack limit works.
3199 gc.autoDetach
3201 Make git gc --auto return immediately and run in background if the
3202 system supports it. Default is true.
3203 gc.bigPackThreshold
3205 If non-zero, all packs larger than this limit are kept when git gc
3206 is run. This is very similar to --keep-largest-pack except that all
3207 packs that meet the threshold are kept, not just the largest pack.
3208 Defaults to zero. Common unit suffixes of k, m, or g are supported.
3209 Note that if the number of kept packs is more than
3211 gc.autoPackLimit, this configuration variable is ignored, all packs
3212 except the base pack will be repacked. After this the number of
3213 packs should go below gc.autoPackLimit and gc.bigPackThreshold
3214 should be respected again.
3215 If the amount of memory estimated for git repack to run smoothly is
3217 not available and gc.bigPackThreshold is not set, the largest pack
3218 will also be excluded (this is the equivalent of running git gc
3219 with --keep-largest-pack).
3220 gc.writeCommitGraph
3222 If true, then gc will rewrite the commit-graph file when git-gc(1)
3223 is run. When using git gc --auto the commit-graph will be updated
3224 if housekeeping is required. Default is true. See git-commit-
3225 graph(1) for details.
3226 gc.logExpiry
3228 If the file gc.log exists, then git gc --auto will print its
3229 content and exit with status zero instead of running unless that
3230 file is more than gc.logExpiry old. Default is "1.day". See
3231 gc.pruneExpire for more ways to specify its value.
3232 gc.packRefs
3234 Running git pack-refs in a repository renders it unclonable by Git
3235 versions prior to 1.5.1.2 over dumb transports such as HTTP. This
3236 variable determines whether git gc runs git pack-refs. This can be
3237 set to notbare to enable it within all non-bare repos or it can be
3238 set to a boolean value. The default is true.
3239 gc.cruftPacks
3241 Store unreachable objects in a cruft pack (see git-repack(1))
3242 instead of as loose objects. The default is false.
3243 gc.pruneExpire
3245 When git gc is run, it will call prune --expire 2.weeks.ago (and
3246 repack --cruft --cruft-expiration 2.weeks.ago if using cruft packs
3247 via gc.cruftPacks or --cruft). Override the grace period with this
3248 config variable. The value "now" may be used to disable this grace
3249 period and always prune unreachable objects immediately, or "never"
3250 may be used to suppress pruning. This feature helps prevent
3251 corruption when git gc runs concurrently with another process
3252 writing to the repository; see the "NOTES" section of git-gc(1).
3253 gc.worktreePruneExpire
3255 When git gc is run, it calls git worktree prune --expire
3256 3.months.ago. This config variable can be used to set a different
3257 grace period. The value "now" may be used to disable the grace
3258 period and prune $GIT_DIR/worktrees immediately, or "never" may be
3259 used to suppress pruning.
3260 gc.reflogExpire, gc.<pattern>.reflogExpire
3262 git reflog expire removes reflog entries older than this time;
3263 defaults to 90 days. The value "now" expires all entries
3264 immediately, and "never" suppresses expiration altogether. With
3265 "<pattern>" (e.g. "refs/stash") in the middle the setting applies
3266 only to the refs that match the <pattern>.
3267 gc.reflogExpireUnreachable, gc.<pattern>.reflogExpireUnreachable
3269 git reflog expire removes reflog entries older than this time and
3270 are not reachable from the current tip; defaults to 30 days. The
3271 value "now" expires all entries immediately, and "never" suppresses
3272 expiration altogether. With "<pattern>" (e.g. "refs/stash") in the
3273 middle, the setting applies only to the refs that match the
3274 <pattern>.
3275 These types of entries are generally created as a result of using
3277 git commit --amend or git rebase and are the commits prior to the
3278 amend or rebase occurring. Since these changes are not part of the
3279 current project most users will want to expire them sooner, which
3280 is why the default is more aggressive than gc.reflogExpire.
3281 gc.rerereResolved
3283 Records of conflicted merge you resolved earlier are kept for this
3284 many days when git rerere gc is run. You can also use more
3285 human-readable "1.month.ago", etc. The default is 60 days. See git-
3286 rerere(1).
3287 gc.rerereUnresolved
3289 Records of conflicted merge you have not resolved are kept for this
3290 many days when git rerere gc is run. You can also use more
3291 human-readable "1.month.ago", etc. The default is 15 days. See git-
3292 rerere(1).
3293 gitcvs.commitMsgAnnotation
3295 Append this string to each commit message. Set to empty string to
3296 disable this feature. Defaults to "via git-CVS emulator".
3297 gitcvs.enabled
3299 Whether the CVS server interface is enabled for this repository.
3300 See git-cvsserver(1).
3301 gitcvs.logFile
3303 Path to a log file where the CVS server interface well... logs
3304 various stuff. See git-cvsserver(1).
3305 gitcvs.usecrlfattr
3307 If true, the server will look up the end-of-line conversion
3308 attributes for files to determine the -k modes to use. If the
3309 attributes force Git to treat a file as text, the -k mode will be
3310 left blank so CVS clients will treat it as text. If they suppress
3311 text conversion, the file will be set with -kb mode, which
3312 suppresses any newline munging the client might otherwise do. If
3313 the attributes do not allow the file type to be determined, then
3314 gitcvs.allBinary is used. See gitattributes(5).
3315 gitcvs.allBinary
3317 This is used if gitcvs.usecrlfattr does not resolve the correct -kb
3318 mode to use. If true, all unresolved files are sent to the client
3319 in mode -kb. This causes the client to treat them as binary files,
3320 which suppresses any newline munging it otherwise might do.
3321 Alternatively, if it is set to "guess", then the contents of the
3322 file are examined to decide if it is binary, similar to
3323 core.autocrlf.
3324 gitcvs.dbName
3326 Database used by git-cvsserver to cache revision information
3327 derived from the Git repository. The exact meaning depends on the
3328 used database driver, for SQLite (which is the default driver) this
3329 is a filename. Supports variable substitution (see git-cvsserver(1)
3330 for details). May not contain semicolons (;). Default:
3331 %Ggitcvs.%m.sqlite
3332 gitcvs.dbDriver
3334 Used Perl DBI driver. You can specify any available driver for this
3335 here, but it might not work. git-cvsserver is tested with
3336 DBD::SQLite, reported to work with DBD::Pg, and reported not to
3337 work with DBD::mysql. Experimental feature. May not contain double
3338 colons (:). Default: SQLite. See git-cvsserver(1).
3339 gitcvs.dbUser, gitcvs.dbPass
3341 Database user and password. Only useful if setting gitcvs.dbDriver,
3342 since SQLite has no concept of database users and/or passwords.
3343 gitcvs.dbUser supports variable substitution (see git-cvsserver(1)
3344 for details).
3345 gitcvs.dbTableNamePrefix
3347 Database table name prefix. Prepended to the names of any database
3348 tables used, allowing a single database to be used for several
3349 repositories. Supports variable substitution (see git-cvsserver(1)
3350 for details). Any non-alphabetic characters will be replaced with
3351 underscores.
3352 All gitcvs variables except for gitcvs.usecrlfattr and gitcvs.allBinary
3354 can also be specified as gitcvs.<access_method>.<varname> (where
3355 access_method is one of "ext" and "pserver") to make them apply only
3356 for the given access method.
3357 gitweb.category, gitweb.description, gitweb.owner, gitweb.url
3359 See gitweb(1) for description.
3360 gitweb.avatar, gitweb.blame, gitweb.grep, gitweb.highlight,
3362 gitweb.patches, gitweb.pickaxe, gitweb.remote_heads, gitweb.showSizes,
3363 gitweb.snapshot
3364 See gitweb.conf(5) for description.
3365 grep.lineNumber
3367 If set to true, enable -n option by default.
3368 grep.column
3370 If set to true, enable the --column option by default.
3371 grep.patternType
3373 Set the default matching behavior. Using a value of basic,
3374 extended, fixed, or perl will enable the --basic-regexp,
3375 --extended-regexp, --fixed-strings, or --perl-regexp option
3376 accordingly, while the value default will use the
3377 grep.extendedRegexp option to choose between basic and extended.
3378 grep.extendedRegexp
3380 If set to true, enable --extended-regexp option by default. This
3381 option is ignored when the grep.patternType option is set to a
3382 value other than default.
3383 grep.threads
3385 Number of grep worker threads to use. If unset (or set to 0), Git
3386 will use as many threads as the number of logical cores available.
3387 grep.fullName
3389 If set to true, enable --full-name option by default.
3390 grep.fallbackToNoIndex
3392 If set to true, fall back to git grep --no-index if git grep is
3393 executed outside of a git repository. Defaults to false.
3394 gpg.program
3396 Use this custom program instead of "gpg" found on $PATH when making
3397 or verifying a PGP signature. The program must support the same
3398 command-line interface as GPG, namely, to verify a detached
3399 signature, "gpg --verify $signature - <$file" is run, and the
3400 program is expected to signal a good signature by exiting with code
3401 0, and to generate an ASCII-armored detached signature, the
3402 standard input of "gpg -bsau $key" is fed with the contents to be
3403 signed, and the program is expected to send the result to its
3404 standard output.
3405 gpg.format
3407 Specifies which key format to use when signing with --gpg-sign.
3408 Default is "openpgp". Other possible values are "x509", "ssh".
3409 gpg.<format>.program
3411 Use this to customize the program used for the signing format you
3412 chose. (see gpg.program and gpg.format) gpg.program can still be
3413 used as a legacy synonym for gpg.openpgp.program. The default value
3414 for gpg.x509.program is "gpgsm" and gpg.ssh.program is
3415 "ssh-keygen".
3416 gpg.minTrustLevel
3418 Specifies a minimum trust level for signature verification. If this
3419 option is unset, then signature verification for merge operations
3420 require a key with at least marginal trust. Other operations that
3421 perform signature verification require a key with at least
3422 undefined trust. Setting this option overrides the required
3423 trust-level for all operations. Supported values, in increasing
3424 order of significance:
3425 • undefined
3427 • never
3429 • marginal
3431 • fully
3433 • ultimate
3435 gpg.ssh.defaultKeyCommand
3437 This command that will be run when user.signingkey is not set and a
3438 ssh signature is requested. On successful exit a valid ssh public
3439 key prefixed with key:: is expected in the first line of its
3440 output. This allows for a script doing a dynamic lookup of the
3441 correct public key when it is impractical to statically configure
3442 user.signingKey. For example when keys or SSH Certificates are
3443 rotated frequently or selection of the right key depends on
3444 external factors unknown to git.
3445 gpg.ssh.allowedSignersFile
3447 A file containing ssh public keys which you are willing to trust.
3448 The file consists of one or more lines of principals followed by an
3449 ssh public key. e.g.: user1@example.com,user2@example.com ssh-rsa
3450 AAAAX1... See ssh-keygen(1) "ALLOWED SIGNERS" for details. The
3451 principal is only used to identify the key and is available when
3452 verifying a signature.
3453 SSH has no concept of trust levels like gpg does. To be able to
3455 differentiate between valid signatures and trusted signatures the
3456 trust level of a signature verification is set to fully when the
3457 public key is present in the allowedSignersFile. Otherwise the
3458 trust level is undefined and git verify-commit/tag will fail.
3459 This file can be set to a location outside of the repository and
3461 every developer maintains their own trust store. A central
3462 repository server could generate this file automatically from ssh
3463 keys with push access to verify the code against. In a corporate
3464 setting this file is probably generated at a global location from
3465 automation that already handles developer ssh keys.
3466 A repository that only allows signed commits can store the file in
3468 the repository itself using a path relative to the top-level of the
3469 working tree. This way only committers with an already valid key
3470 can add or change keys in the keyring.
3471 Since OpensSSH 8.8 this file allows specifying a key lifetime using
3473 valid-after & valid-before options. Git will mark signatures as
3474 valid if the signing key was valid at the time of the signature’s
3475 creation. This allows users to change a signing key without
3476 invalidating all previously made signatures.
3477 Using a SSH CA key with the cert-authority option (see
3479 ssh-keygen(1) "CERTIFICATES") is also valid.
3480 gpg.ssh.revocationFile
3482 Either a SSH KRL or a list of revoked public keys (without the
3483 principal prefix). See ssh-keygen(1) for details. If a public key
3484 is found in this file then it will always be treated as having
3485 trust level "never" and signatures will show as invalid.
3486 gui.commitMsgWidth
3488 Defines how wide the commit message window is in the git-gui(1).
3489 "75" is the default.
3490 gui.diffContext
3492 Specifies how many context lines should be used in calls to diff
3493 made by the git-gui(1). The default is "5".
3494 gui.displayUntracked
3496 Determines if git-gui(1) shows untracked files in the file list.
3497 The default is "true".
3498 gui.encoding
3500 Specifies the default character encoding to use for displaying of
3501 file contents in git-gui(1) and gitk(1). It can be overridden by
3502 setting the encoding attribute for relevant files (see
3503 gitattributes(5)). If this option is not set, the tools default to
3504 the locale encoding.
3505 gui.matchTrackingBranch
3507 Determines if new branches created with git-gui(1) should default
3508 to tracking remote branches with matching names or not. Default:
3509 "false".
3510 gui.newBranchTemplate
3512 Is used as suggested name when creating new branches using the git-
3513 gui(1).
3514 gui.pruneDuringFetch
3516 "true" if git-gui(1) should prune remote-tracking branches when
3517 performing a fetch. The default value is "false".
3518 gui.trustmtime
3520 Determines if git-gui(1) should trust the file modification
3521 timestamp or not. By default the timestamps are not trusted.
3522 gui.spellingDictionary
3524 Specifies the dictionary used for spell checking commit messages in
3525 the git-gui(1). When set to "none" spell checking is turned off.
3526 gui.fastCopyBlame
3528 If true, git gui blame uses -C instead of -C -C for original
3529 location detection. It makes blame significantly faster on huge
3530 repositories at the expense of less thorough copy detection.
3531 gui.copyBlameThreshold
3533 Specifies the threshold to use in git gui blame original location
3534 detection, measured in alphanumeric characters. See the git-
3535 blame(1) manual for more information on copy detection.
3536 gui.blamehistoryctx
3538 Specifies the radius of history context in days to show in gitk(1)
3539 for the selected commit, when the Show History Context menu item is
3540 invoked from git gui blame. If this variable is set to zero, the
3541 whole history is shown.
3542 guitool.<name>.cmd
3544 Specifies the shell command line to execute when the corresponding
3545 item of the git-gui(1) Tools menu is invoked. This option is
3546 mandatory for every tool. The command is executed from the root of
3547 the working directory, and in the environment it receives the name
3548 of the tool as GIT_GUITOOL, the name of the currently selected file
3549 as FILENAME, and the name of the current branch as CUR_BRANCH (if
3550 the head is detached, CUR_BRANCH is empty).
3551 guitool.<name>.needsFile
3553 Run the tool only if a diff is selected in the GUI. It guarantees
3554 that FILENAME is not empty.
3555 guitool.<name>.noConsole
3557 Run the command silently, without creating a window to display its
3558 output.
3559 guitool.<name>.noRescan
3561 Don’t rescan the working directory for changes after the tool
3562 finishes execution.
3563 guitool.<name>.confirm
3565 Show a confirmation dialog before actually running the tool.
3566 guitool.<name>.argPrompt
3568 Request a string argument from the user, and pass it to the tool
3569 through the ARGS environment variable. Since requesting an argument
3570 implies confirmation, the confirm option has no effect if this is
3571 enabled. If the option is set to true, yes, or 1, the dialog uses a
3572 built-in generic prompt; otherwise the exact value of the variable
3573 is used.
3574 guitool.<name>.revPrompt
3576 Request a single valid revision from the user, and set the REVISION
3577 environment variable. In other aspects this option is similar to
3578 argPrompt, and can be used together with it.
3579 guitool.<name>.revUnmerged
3581 Show only unmerged branches in the revPrompt subdialog. This is
3582 useful for tools similar to merge or rebase, but not for things
3583 like checkout or reset.
3584 guitool.<name>.title
3586 Specifies the title to use for the prompt dialog. The default is
3587 the tool name.
3588 guitool.<name>.prompt
3590 Specifies the general prompt string to display at the top of the
3591 dialog, before subsections for argPrompt and revPrompt. The default
3592 value includes the actual command.
3593 help.browser
3595 Specify the browser that will be used to display help in the web
3596 format. See git-help(1).
3597 help.format
3599 Override the default help format used by git-help(1). Values man,
3600 info, web and html are supported. man is the default. web and
3601 html are the same.
3602 help.autoCorrect
3604 If git detects typos and can identify exactly one valid command
3605 similar to the error, git will try to suggest the correct command
3606 or even run the suggestion automatically. Possible config values
3607 are:
3608 • 0 (default): show the suggested command.
3610 • positive number: run the suggested command after specified
3612 deciseconds (0.1 sec).
3613 • "immediate": run the suggested command immediately.
3615 • "prompt": show the suggestion and prompt for confirmation to
3617 run the command.
3618 • "never": don’t run or show any suggested command.
3620 help.htmlPath
3622 Specify the path where the HTML documentation resides. File system
3623 paths and URLs are supported. HTML pages will be prefixed with this
3624 path when help is displayed in the web format. This defaults to the
3625 documentation path of your Git installation.
3626 http.proxy
3628 Override the HTTP proxy, normally configured using the http_proxy,
3629 https_proxy, and all_proxy environment variables (see curl(1)). In
3630 addition to the syntax understood by curl, it is possible to
3631 specify a proxy string with a user name but no password, in which
3632 case git will attempt to acquire one in the same way it does for
3633 other credentials. See gitcredentials(7) for more information. The
3634 syntax thus is [protocol://][user[:password]@]proxyhost[:port].
3635 This can be overridden on a per-remote basis; see
3636 remote.<name>.proxy
3637 http.proxyAuthMethod
3639 Set the method with which to authenticate against the HTTP proxy.
3640 This only takes effect if the configured proxy string contains a
3641 user name part (i.e. is of the form user@host or user@host:port).
3642 This can be overridden on a per-remote basis; see
3643 remote.<name>.proxyAuthMethod. Both can be overridden by the
3644 GIT_HTTP_PROXY_AUTHMETHOD environment variable. Possible values
3645 are:
3646 • anyauth - Automatically pick a suitable authentication method.
3648 It is assumed that the proxy answers an unauthenticated request
3649 with a 407 status code and one or more Proxy-authenticate
3650 headers with supported authentication methods. This is the
3651 default.
3652 • basic - HTTP Basic authentication
3654 • digest - HTTP Digest authentication; this prevents the password
3656 from being transmitted to the proxy in clear text
3657 • negotiate - GSS-Negotiate authentication (compare the
3659 --negotiate option of curl(1))
3660 • ntlm - NTLM authentication (compare the --ntlm option of
3662 curl(1))
3663 http.proxySSLCert
3665 The pathname of a file that stores a client certificate to use to
3666 authenticate with an HTTPS proxy. Can be overridden by the
3667 GIT_PROXY_SSL_CERT environment variable.
3668 http.proxySSLKey
3670 The pathname of a file that stores a private key to use to
3671 authenticate with an HTTPS proxy. Can be overridden by the
3672 GIT_PROXY_SSL_KEY environment variable.
3673 http.proxySSLCertPasswordProtected
3675 Enable Git’s password prompt for the proxy SSL certificate.
3676 Otherwise OpenSSL will prompt the user, possibly many times, if the
3677 certificate or private key is encrypted. Can be overridden by the
3678 GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED environment variable.
3679 http.proxySSLCAInfo
3681 Pathname to the file containing the certificate bundle that should
3682 be used to verify the proxy with when using an HTTPS proxy. Can be
3683 overridden by the GIT_PROXY_SSL_CAINFO environment variable.
3684 http.emptyAuth
3686 Attempt authentication without seeking a username or password. This
3687 can be used to attempt GSS-Negotiate authentication without
3688 specifying a username in the URL, as libcurl normally requires a
3689 username for authentication.
3690 http.delegation
3692 Control GSSAPI credential delegation. The delegation is disabled by
3693 default in libcurl since version 7.21.7. Set parameter to tell the
3694 server what it is allowed to delegate when it comes to user
3695 credentials. Used with GSS/kerberos. Possible values are:
3696 • none - Don’t allow any delegation.
3698 • policy - Delegates if and only if the OK-AS-DELEGATE flag is
3700 set in the Kerberos service ticket, which is a matter of realm
3701 policy.
3702 • always - Unconditionally allow the server to delegate.
3704 http.extraHeader
3706 Pass an additional HTTP header when communicating with a server. If
3707 more than one such entry exists, all of them are added as extra
3708 headers. To allow overriding the settings inherited from the system
3709 config, an empty value will reset the extra headers to the empty
3710 list.
3711 http.cookieFile
3713 The pathname of a file containing previously stored cookie lines,
3714 which should be used in the Git http session, if they match the
3715 server. The file format of the file to read cookies from should be
3716 plain HTTP headers or the Netscape/Mozilla cookie file format (see
3717 curl(1)). NOTE that the file specified with http.cookieFile is used
3718 only as input unless http.saveCookies is set.
3719 http.saveCookies
3721 If set, store cookies received during requests to the file
3722 specified by http.cookieFile. Has no effect if http.cookieFile is
3723 unset.
3724 http.version
3726 Use the specified HTTP protocol version when communicating with a
3727 server. If you want to force the default. The available and default
3728 version depend on libcurl. Currently the possible values of this
3729 option are:
3730 • HTTP/2
3732 • HTTP/1.1
3734 http.curloptResolve
3736 Hostname resolution information that will be used first by libcurl
3737 when sending HTTP requests. This information should be in one of
3738 the following formats:
3739 • [+]HOST:PORT:ADDRESS[,ADDRESS]
3741 • -HOST:PORT
3743 The first format redirects all requests to the given HOST:PORT to
3745 the provided ADDRESS(s). The second format clears all previous
3746 config values for that HOST:PORT combination. To allow easy
3747 overriding of all the settings inherited from the system config, an
3748 empty value will reset all resolution information to the empty
3749 list.
3750 http.sslVersion
3752 The SSL version to use when negotiating an SSL connection, if you
3753 want to force the default. The available and default version depend
3754 on whether libcurl was built against NSS or OpenSSL and the
3755 particular configuration of the crypto library in use. Internally
3756 this sets the CURLOPT_SSL_VERSION option; see the libcurl
3757 documentation for more details on the format of this option and for
3758 the ssl version supported. Currently the possible values of this
3759 option are:
3760 • sslv2
3762 • sslv3
3764 • tlsv1
3766 • tlsv1.0
3768 • tlsv1.1
3770 • tlsv1.2
3772 • tlsv1.3
3774 Can be overridden by the GIT_SSL_VERSION environment variable. To
3776 force git to use libcurl’s default ssl version and ignore any
3777 explicit http.sslversion option, set GIT_SSL_VERSION to the empty
3778 string.
3779 http.sslCipherList
3781 A list of SSL ciphers to use when negotiating an SSL connection.
3782 The available ciphers depend on whether libcurl was built against
3783 NSS or OpenSSL and the particular configuration of the crypto
3784 library in use. Internally this sets the CURLOPT_SSL_CIPHER_LIST
3785 option; see the libcurl documentation for more details on the
3786 format of this list.
3787 Can be overridden by the GIT_SSL_CIPHER_LIST environment variable.
3789 To force git to use libcurl’s default cipher list and ignore any
3790 explicit http.sslCipherList option, set GIT_SSL_CIPHER_LIST to the
3791 empty string.
3792 http.sslVerify
3794 Whether to verify the SSL certificate when fetching or pushing over
3795 HTTPS. Defaults to true. Can be overridden by the GIT_SSL_NO_VERIFY
3796 environment variable.
3797 http.sslCert
3799 File containing the SSL certificate when fetching or pushing over
3800 HTTPS. Can be overridden by the GIT_SSL_CERT environment variable.
3801 http.sslKey
3803 File containing the SSL private key when fetching or pushing over
3804 HTTPS. Can be overridden by the GIT_SSL_KEY environment variable.
3805 http.sslCertPasswordProtected
3807 Enable Git’s password prompt for the SSL certificate. Otherwise
3808 OpenSSL will prompt the user, possibly many times, if the
3809 certificate or private key is encrypted. Can be overridden by the
3810 GIT_SSL_CERT_PASSWORD_PROTECTED environment variable.
3811 http.sslCAInfo
3813 File containing the certificates to verify the peer with when
3814 fetching or pushing over HTTPS. Can be overridden by the
3815 GIT_SSL_CAINFO environment variable.
3816 http.sslCAPath
3818 Path containing files with the CA certificates to verify the peer
3819 with when fetching or pushing over HTTPS. Can be overridden by the
3820 GIT_SSL_CAPATH environment variable.
3821 http.sslBackend
3823 Name of the SSL backend to use (e.g. "openssl" or "schannel"). This
3824 option is ignored if cURL lacks support for choosing the SSL
3825 backend at runtime.
3826 http.schannelCheckRevoke
3828 Used to enforce or disable certificate revocation checks in cURL
3829 when http.sslBackend is set to "schannel". Defaults to true if
3830 unset. Only necessary to disable this if Git consistently errors
3831 and the message is about checking the revocation status of a
3832 certificate. This option is ignored if cURL lacks support for
3833 setting the relevant SSL option at runtime.
3834 http.schannelUseSSLCAInfo
3836 As of cURL v7.60.0, the Secure Channel backend can use the
3837 certificate bundle provided via http.sslCAInfo, but that would
3838 override the Windows Certificate Store. Since this is not desirable
3839 by default, Git will tell cURL not to use that bundle by default
3840 when the schannel backend was configured via http.sslBackend,
3841 unless http.schannelUseSSLCAInfo overrides this behavior.
3842 http.pinnedPubkey
3844 Public key of the https service. It may either be the filename of a
3845 PEM or DER encoded public key file or a string starting with
3846 sha256// followed by the base64 encoded sha256 hash of the public
3847 key. See also libcurl CURLOPT_PINNEDPUBLICKEY. git will exit with
3848 an error if this option is set but not supported by cURL.
3849 http.sslTry
3851 Attempt to use AUTH SSL/TLS and encrypted data transfers when
3852 connecting via regular FTP protocol. This might be needed if the
3853 FTP server requires it for security reasons or you wish to connect
3854 securely whenever remote FTP server supports it. Default is false
3855 since it might trigger certificate verification errors on
3856 misconfigured servers.
3857 http.maxRequests
3859 How many HTTP requests to launch in parallel. Can be overridden by
3860 the GIT_HTTP_MAX_REQUESTS environment variable. Default is 5.
3861 http.minSessions
3863 The number of curl sessions (counted across slots) to be kept
3864 across requests. They will not be ended with curl_easy_cleanup()
3865 until http_cleanup() is invoked. If USE_CURL_MULTI is not defined,
3866 this value will be capped at 1. Defaults to 1.
3867 http.postBuffer
3869 Maximum size in bytes of the buffer used by smart HTTP transports
3870 when POSTing data to the remote system. For requests larger than
3871 this buffer size, HTTP/1.1 and Transfer-Encoding: chunked is used
3872 to avoid creating a massive pack file locally. Default is 1 MiB,
3873 which is sufficient for most requests.
3874 Note that raising this limit is only effective for disabling
3876 chunked transfer encoding and therefore should be used only where
3877 the remote server or a proxy only supports HTTP/1.0 or is
3878 noncompliant with the HTTP standard. Raising this is not, in
3879 general, an effective solution for most push problems, but can
3880 increase memory consumption significantly since the entire buffer
3881 is allocated even for small pushes.
3882 http.lowSpeedLimit, http.lowSpeedTime
3884 If the HTTP transfer speed is less than http.lowSpeedLimit for
3885 longer than http.lowSpeedTime seconds, the transfer is aborted. Can
3886 be overridden by the GIT_HTTP_LOW_SPEED_LIMIT and
3887 GIT_HTTP_LOW_SPEED_TIME environment variables.
3888 http.noEPSV
3890 A boolean which disables using of EPSV ftp command by curl. This
3891 can helpful with some "poor" ftp servers which don’t support EPSV
3892 mode. Can be overridden by the GIT_CURL_FTP_NO_EPSV environment
3893 variable. Default is false (curl will use EPSV).
3894 http.userAgent
3896 The HTTP USER_AGENT string presented to an HTTP server. The default
3897 value represents the version of the client Git such as git/1.7.1.
3898 This option allows you to override this value to a more common
3899 value such as Mozilla/4.0. This may be necessary, for instance, if
3900 connecting through a firewall that restricts HTTP connections to a
3901 set of common USER_AGENT strings (but not including those like
3902 git/1.7.1). Can be overridden by the GIT_HTTP_USER_AGENT
3903 environment variable.
3904 http.followRedirects
3906 Whether git should follow HTTP redirects. If set to true, git will
3907 transparently follow any redirect issued by a server it encounters.
3908 If set to false, git will treat all redirects as errors. If set to
3909 initial, git will follow redirects only for the initial request to
3910 a remote, but not for subsequent follow-up HTTP requests. Since git
3911 uses the redirected URL as the base for the follow-up requests,
3912 this is generally sufficient. The default is initial.
3913 http.<url>.*
3915 Any of the http.* options above can be applied selectively to some
3916 URLs. For a config key to match a URL, each element of the config
3917 key is compared to that of the URL, in the following order:
3918 1. Scheme (e.g., https in https://example.com/). This field must
3920 match exactly between the config key and the URL.
3921 2. Host/domain name (e.g., example.com in https://example.com/).
3923 This field must match between the config key and the URL. It is
3924 possible to specify a * as part of the host name to match all
3925 subdomains at this level. https://*.example.com/ for example
3926 would match https://foo.example.com/, but not
3927 https://foo.bar.example.com/.
3928 3. Port number (e.g., 8080 in http://example.com:8080/). This
3930 field must match exactly between the config key and the URL.
3931 Omitted port numbers are automatically converted to the correct
3932 default for the scheme before matching.
3933 4. Path (e.g., repo.git in https://example.com/repo.git). The path
3935 field of the config key must match the path field of the URL
3936 either exactly or as a prefix of slash-delimited path elements.
3937 This means a config key with path foo/ matches URL path
3938 foo/bar. A prefix can only match on a slash (/) boundary.
3939 Longer matches take precedence (so a config key with path
3940 foo/bar is a better match to URL path foo/bar than a config key
3941 with just path foo/).
3942 5. User name (e.g., user in https://user@example.com/repo.git). If
3944 the config key has a user name it must match the user name in
3945 the URL exactly. If the config key does not have a user name,
3946 that config key will match a URL with any user name (including
3947 none), but at a lower precedence than a config key with a user
3948 name.
3949 The list above is ordered by decreasing precedence; a URL that
3951 matches a config key’s path is preferred to one that matches its
3952 user name. For example, if the URL is
3953 https://user@example.com/foo/bar a config key match of
3954 https://example.com/foo will be preferred over a config key match
3955 of https://user@example.com.
3956 All URLs are normalized before attempting any matching (the
3958 password part, if embedded in the URL, is always ignored for
3959 matching purposes) so that equivalent URLs that are simply spelled
3960 differently will match properly. Environment variable settings
3961 always override any matches. The URLs that are matched against are
3962 those given directly to Git commands. This means any URLs visited
3963 as a result of a redirection do not participate in matching.
3964 i18n.commitEncoding
3966 Character encoding the commit messages are stored in; Git itself
3967 does not care per se, but this information is necessary e.g. when
3968 importing commits from emails or in the gitk graphical history
3969 browser (and possibly at other places in the future or in other
3970 porcelains). See e.g. git-mailinfo(1). Defaults to utf-8.
3971 i18n.logOutputEncoding
3973 Character encoding the commit messages are converted to when
3974 running git log and friends.
3975 imap.folder
3977 The folder to drop the mails into, which is typically the Drafts
3978 folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
3979 "[Gmail]/Drafts". Required.
3980 imap.tunnel
3982 Command used to setup a tunnel to the IMAP server through which
3983 commands will be piped instead of using a direct network connection
3984 to the server. Required when imap.host is not set.
3985 imap.host
3987 A URL identifying the server. Use an imap:// prefix for non-secure
3988 connections and an imaps:// prefix for secure connections. Ignored
3989 when imap.tunnel is set, but required otherwise.
3990 imap.user
3992 The username to use when logging in to the server.
3993 imap.pass
3995 The password to use when logging in to the server.
3996 imap.port
3998 An integer port number to connect to on the server. Defaults to 143
3999 for imap:// hosts and 993 for imaps:// hosts. Ignored when
4000 imap.tunnel is set.
4001 imap.sslverify
4003 A boolean to enable/disable verification of the server certificate
4004 used by the SSL/TLS connection. Default is true. Ignored when
4005 imap.tunnel is set.
4006 imap.preformattedHTML
4008 A boolean to enable/disable the use of html encoding when sending a
4009 patch. An html encoded patch will be bracketed with <pre> and have
4010 a content type of text/html. Ironically, enabling this option
4011 causes Thunderbird to send the patch as a plain/text, format=fixed
4012 email. Default is false.
4013 imap.authMethod
4015 Specify authenticate method for authentication with IMAP server. If
4016 Git was built with the NO_CURL option, or if your curl version is
4017 older than 7.34.0, or if you’re running git-imap-send with the
4018 --no-curl option, the only supported method is CRAM-MD5. If this is
4019 not set then git imap-send uses the basic IMAP plaintext LOGIN
4020 command.
4021 include.path, includeIf.<condition>.path
4023 Special variables to include other configuration files. See the
4024 "CONFIGURATION FILE" section in the main git-config(1)
4025 documentation, specifically the "Includes" and "Conditional
4026 Includes" subsections.
4027 index.recordEndOfIndexEntries
4029 Specifies whether the index file should include an "End Of Index
4030 Entry" section. This reduces index load time on multiprocessor
4031 machines but produces a message "ignoring EOIE extension" when
4032 reading the index using Git versions before 2.20. Defaults to true
4033 if index.threads has been explicitly enabled, false otherwise.
4034 index.recordOffsetTable
4036 Specifies whether the index file should include an "Index Entry
4037 Offset Table" section. This reduces index load time on
4038 multiprocessor machines but produces a message "ignoring IEOT
4039 extension" when reading the index using Git versions before 2.20.
4040 Defaults to true if index.threads has been explicitly enabled,
4041 false otherwise.
4042 index.sparse
4044 When enabled, write the index using sparse-directory entries. This
4045 has no effect unless core.sparseCheckout and
4046 core.sparseCheckoutCone are both enabled. Defaults to false.
4047 index.threads
4049 Specifies the number of threads to spawn when loading the index.
4050 This is meant to reduce index load time on multiprocessor machines.
4051 Specifying 0 or true will cause Git to auto-detect the number of
4052 CPU’s and set the number of threads accordingly. Specifying 1 or
4053 false will disable multithreading. Defaults to true.
4054 index.version
4056 Specify the version with which new index files should be
4057 initialized. This does not affect existing repositories. If
4058 feature.manyFiles is enabled, then the default is 4.
4059 init.templateDir
4061 Specify the directory from which templates will be copied. (See the
4062 "TEMPLATE DIRECTORY" section of git-init(1).)
4063 init.defaultBranch
4065 Allows overriding the default branch name e.g. when initializing a
4066 new repository.
4067 instaweb.browser
4069 Specify the program that will be used to browse your working
4070 repository in gitweb. See git-instaweb(1).
4071 instaweb.httpd
4073 The HTTP daemon command-line to start gitweb on your working
4074 repository. See git-instaweb(1).
4075 instaweb.local
4077 If true the web server started by git-instaweb(1) will be bound to
4078 the local IP (127.0.0.1).
4079 instaweb.modulePath
4081 The default module path for git-instaweb(1) to use instead of
4082 /usr/lib/apache2/modules. Only used if httpd is Apache.
4083 instaweb.port
4085 The port number to bind the gitweb httpd to. See git-instaweb(1).
4086 interactive.singleKey
4088 In interactive commands, allow the user to provide one-letter input
4089 with a single key (i.e., without hitting enter). Currently this is
4090 used by the --patch mode of git-add(1), git-checkout(1), git-
4091 restore(1), git-commit(1), git-reset(1), and git-stash(1). Note
4092 that this setting is silently ignored if portable keystroke input
4093 is not available; requires the Perl module Term::ReadKey.
4094 interactive.diffFilter
4096 When an interactive command (such as git add --patch) shows a
4097 colorized diff, git will pipe the diff through the shell command
4098 defined by this configuration variable. The command may mark up the
4099 diff further for human consumption, provided that it retains a
4100 one-to-one correspondence with the lines in the original diff.
4101 Defaults to disabled (no filtering).
4102 log.abbrevCommit
4104 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
4105 assume --abbrev-commit. You may override this option with
4106 --no-abbrev-commit.
4107 log.date
4109 Set the default date-time mode for the log command. Setting a value
4110 for log.date is similar to using git log's --date option. See git-
4111 log(1) for details.
4112 If the format is set to "auto:foo" and the pager is in use, format
4114 "foo" will be the used for the date format. Otherwise "default"
4115 will be used.
4116 log.decorate
4118 Print out the ref names of any commits that are shown by the log
4119 command. If short is specified, the ref name prefixes refs/heads/,
4120 refs/tags/ and refs/remotes/ will not be printed. If full is
4121 specified, the full ref name (including prefix) will be printed. If
4122 auto is specified, then if the output is going to a terminal, the
4123 ref names are shown as if short were given, otherwise no ref names
4124 are shown. This is the same as the --decorate option of the git
4125 log.
4126 log.initialDecorationSet
4128 By default, git log only shows decorations for certain known ref
4129 namespaces. If all is specified, then show all refs as decorations.
4130 log.excludeDecoration
4132 Exclude the specified patterns from the log decorations. This is
4133 similar to the --decorate-refs-exclude command-line option, but the
4134 config option can be overridden by the --decorate-refs option.
4135 log.diffMerges
4137 Set diff format to be used when --diff-merges=on is specified, see
4138 --diff-merges in git-log(1) for details. Defaults to separate.
4139 log.follow
4141 If true, git log will act as if the --follow option was used when a
4142 single <path> is given. This has the same limitations as --follow,
4143 i.e. it cannot be used to follow multiple files and does not work
4144 well on non-linear history.
4145 log.graphColors
4147 A list of colors, separated by commas, that can be used to draw
4148 history lines in git log --graph.
4149 log.showRoot
4151 If true, the initial commit will be shown as a big creation event.
4152 This is equivalent to a diff against an empty tree. Tools like git-
4153 log(1) or git-whatchanged(1), which normally hide the root commit
4154 will now show it. True by default.
4155 log.showSignature
4157 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
4158 assume --show-signature.
4159 log.mailmap
4161 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
4162 assume --use-mailmap, otherwise assume --no-use-mailmap. True by
4163 default.
4164 lsrefs.unborn
4166 May be "advertise" (the default), "allow", or "ignore". If
4167 "advertise", the server will respond to the client sending "unborn"
4168 (as described in gitprotocol-v2(5)) and will advertise support for
4169 this feature during the protocol v2 capability advertisement.
4170 "allow" is the same as "advertise" except that the server will not
4171 advertise support for this feature; this is useful for
4172 load-balanced servers that cannot be updated atomically (for
4173 example), since the administrator could configure "allow", then
4174 after a delay, configure "advertise".
4175 mailinfo.scissors
4177 If true, makes git-mailinfo(1) (and therefore git-am(1)) act by
4178 default as if the --scissors option was provided on the
4179 command-line. When active, this features removes everything from
4180 the message body before a scissors line (i.e. consisting mainly of
4181 ">8", "8<" and "-").
4182 mailmap.file
4184 The location of an augmenting mailmap file. The default mailmap,
4185 located in the root of the repository, is loaded first, then the
4186 mailmap file pointed to by this variable. The location of the
4187 mailmap file may be in a repository subdirectory, or somewhere
4188 outside of the repository itself. See git-shortlog(1) and git-
4189 blame(1).
4190 mailmap.blob
4192 Like mailmap.file, but consider the value as a reference to a blob
4193 in the repository. If both mailmap.file and mailmap.blob are given,
4194 both are parsed, with entries from mailmap.file taking precedence.
4195 In a bare repository, this defaults to HEAD:.mailmap. In a non-bare
4196 repository, it defaults to empty.
4197 maintenance.auto
4199 This boolean config option controls whether some commands run git
4200 maintenance run --auto after doing their normal work. Defaults to
4201 true.
4202 maintenance.strategy
4204 This string config option provides a way to specify one of a few
4205 recommended schedules for background maintenance. This only affects
4206 which tasks are run during git maintenance run --schedule=X
4207 commands, provided no --task=<task> arguments are provided.
4208 Further, if a maintenance.<task>.schedule config value is set, then
4209 that value is used instead of the one provided by
4210 maintenance.strategy. The possible strategy strings are:
4211 • none: This default setting implies no task are run at any
4213 schedule.
4214 • incremental: This setting optimizes for performing small
4216 maintenance activities that do not delete any data. This does
4217 not schedule the gc task, but runs the prefetch and
4218 commit-graph tasks hourly, the loose-objects and
4219 incremental-repack tasks daily, and the pack-refs task weekly.
4220 maintenance.<task>.enabled
4222 This boolean config option controls whether the maintenance task
4223 with name <task> is run when no --task option is specified to git
4224 maintenance run. These config values are ignored if a --task option
4225 exists. By default, only maintenance.gc.enabled is true.
4226 maintenance.<task>.schedule
4228 This config option controls whether or not the given <task> runs
4229 during a git maintenance run --schedule=<frequency> command. The
4230 value must be one of "hourly", "daily", or "weekly".
4231 maintenance.commit-graph.auto
4233 This integer config option controls how often the commit-graph task
4234 should be run as part of git maintenance run --auto. If zero, then
4235 the commit-graph task will not run with the --auto option. A
4236 negative value will force the task to run every time. Otherwise, a
4237 positive value implies the command should run when the number of
4238 reachable commits that are not in the commit-graph file is at least
4239 the value of maintenance.commit-graph.auto. The default value is
4240 100.
4241 maintenance.loose-objects.auto
4243 This integer config option controls how often the loose-objects
4244 task should be run as part of git maintenance run --auto. If zero,
4245 then the loose-objects task will not run with the --auto option. A
4246 negative value will force the task to run every time. Otherwise, a
4247 positive value implies the command should run when the number of
4248 loose objects is at least the value of
4249 maintenance.loose-objects.auto. The default value is 100.
4250 maintenance.incremental-repack.auto
4252 This integer config option controls how often the
4253 incremental-repack task should be run as part of git maintenance
4254 run --auto. If zero, then the incremental-repack task will not run
4255 with the --auto option. A negative value will force the task to run
4256 every time. Otherwise, a positive value implies the command should
4257 run when the number of pack-files not in the multi-pack-index is at
4258 least the value of maintenance.incremental-repack.auto. The default
4259 value is 10.
4260 man.viewer
4262 Specify the programs that may be used to display help in the man
4263 format. See git-help(1).
4264 man.<tool>.cmd
4266 Specify the command to invoke the specified man viewer. The
4267 specified command is evaluated in shell with the man page passed as
4268 argument. (See git-help(1).)
4269 man.<tool>.path
4271 Override the path for the given tool that may be used to display
4272 help in the man format. See git-help(1).
4273 merge.conflictStyle
4275 Specify the style in which conflicted hunks are written out to
4276 working tree files upon merge. The default is "merge", which shows
4277 a <<<<<<< conflict marker, changes made by one side, a =======
4278 marker, changes made by the other side, and then a >>>>>>> marker.
4279 An alternate style, "diff3", adds a ||||||| marker and the original
4280 text before the ======= marker. The "merge" style tends to produce
4281 smaller conflict regions than diff3, both because of the exclusion
4282 of the original text, and because when a subset of lines match on
4283 the two sides they are just pulled out of the conflict region.
4284 Another alternate style, "zdiff3", is similar to diff3 but removes
4285 matching lines on the two sides from the conflict region when those
4286 matching lines appear near either the beginning or end of a
4287 conflict region.
4288 merge.defaultToUpstream
4290 If merge is called without any commit argument, merge the upstream
4291 branches configured for the current branch by using their last
4292 observed values stored in their remote-tracking branches. The
4293 values of the branch.<current branch>.merge that name the branches
4294 at the remote named by branch.<current branch>.remote are
4295 consulted, and then they are mapped via remote.<remote>.fetch to
4296 their corresponding remote-tracking branches, and the tips of these
4297 tracking branches are merged. Defaults to true.
4298 merge.ff
4300 By default, Git does not create an extra merge commit when merging
4301 a commit that is a descendant of the current commit. Instead, the
4302 tip of the current branch is fast-forwarded. When set to false,
4303 this variable tells Git to create an extra merge commit in such a
4304 case (equivalent to giving the --no-ff option from the command
4305 line). When set to only, only such fast-forward merges are allowed
4306 (equivalent to giving the --ff-only option from the command line).
4307 merge.verifySignatures
4309 If true, this is equivalent to the --verify-signatures command line
4310 option. See git-merge(1) for details.
4311 merge.branchdesc
4313 In addition to branch names, populate the log message with the
4314 branch description text associated with them. Defaults to false.
4315 merge.log
4317 In addition to branch names, populate the log message with at most
4318 the specified number of one-line descriptions from the actual
4319 commits that are being merged. Defaults to false, and true is a
4320 synonym for 20.
4321 merge.suppressDest
4323 By adding a glob that matches the names of integration branches to
4324 this multi-valued configuration variable, the default merge message
4325 computed for merges into these integration branches will omit "into
4326 <branch name>" from its title.
4327 An element with an empty value can be used to clear the list of
4329 globs accumulated from previous configuration entries. When there
4330 is no merge.suppressDest variable defined, the default value of
4331 master is used for backward compatibility.
4332 merge.renameLimit
4334 The number of files to consider in the exhaustive portion of rename
4335 detection during a merge. If not specified, defaults to the value
4336 of diff.renameLimit. If neither merge.renameLimit nor
4337 diff.renameLimit are specified, currently defaults to 7000. This
4338 setting has no effect if rename detection is turned off.
4339 merge.renames
4341 Whether Git detects renames. If set to "false", rename detection is
4342 disabled. If set to "true", basic rename detection is enabled.
4343 Defaults to the value of diff.renames.
4344 merge.directoryRenames
4346 Whether Git detects directory renames, affecting what happens at
4347 merge time to new files added to a directory on one side of history
4348 when that directory was renamed on the other side of history. If
4349 merge.directoryRenames is set to "false", directory rename
4350 detection is disabled, meaning that such new files will be left
4351 behind in the old directory. If set to "true", directory rename
4352 detection is enabled, meaning that such new files will be moved
4353 into the new directory. If set to "conflict", a conflict will be
4354 reported for such paths. If merge.renames is false,
4355 merge.directoryRenames is ignored and treated as false. Defaults to
4356 "conflict".
4357 merge.renormalize
4359 Tell Git that canonical representation of files in the repository
4360 has changed over time (e.g. earlier commits record text files with
4361 CRLF line endings, but recent ones use LF line endings). In such a
4362 repository, Git can convert the data recorded in commits to a
4363 canonical form before performing a merge to reduce unnecessary
4364 conflicts. For more information, see section "Merging branches with
4365 differing checkin/checkout attributes" in gitattributes(5).
4366 merge.stat
4368 Whether to print the diffstat between ORIG_HEAD and the merge
4369 result at the end of the merge. True by default.
4370 merge.autoStash
4372 When set to true, automatically create a temporary stash entry
4373 before the operation begins, and apply it after the operation ends.
4374 This means that you can run merge on a dirty worktree. However, use
4375 with care: the final stash application after a successful merge
4376 might result in non-trivial conflicts. This option can be
4377 overridden by the --no-autostash and --autostash options of git-
4378 merge(1). Defaults to false.
4379 merge.tool
4381 Controls which merge tool is used by git-mergetool(1). The list
4382 below shows the valid built-in values. Any other value is treated
4383 as a custom merge tool and requires that a corresponding
4384 mergetool.<tool>.cmd variable is defined.
4385 merge.guitool
4387 Controls which merge tool is used by git-mergetool(1) when the
4388 -g/--gui flag is specified. The list below shows the valid built-in
4389 values. Any other value is treated as a custom merge tool and
4390 requires that a corresponding mergetool.<guitool>.cmd variable is
4391 defined.
4392 araxis
4394 Use Araxis Merge (requires a graphical session)
4395 bc
4397 Use Beyond Compare (requires a graphical session)
4398 bc3
4400 Use Beyond Compare (requires a graphical session)
4401 bc4
4403 Use Beyond Compare (requires a graphical session)
4404 codecompare
4406 Use Code Compare (requires a graphical session)
4407 deltawalker
4409 Use DeltaWalker (requires a graphical session)
4410 diffmerge
4412 Use DiffMerge (requires a graphical session)
4413 diffuse
4415 Use Diffuse (requires a graphical session)
4416 ecmerge
4418 Use ECMerge (requires a graphical session)
4419 emerge
4421 Use Emacs' Emerge
4422 examdiff
4424 Use ExamDiff Pro (requires a graphical session)
4425 guiffy
4427 Use Guiffy’s Diff Tool (requires a graphical session)
4428 gvimdiff
4430 Use gVim (requires a graphical session) with a custom layout
4431 (see git help mergetool's BACKEND SPECIFIC HINTS section)
4432 gvimdiff1
4434 Use gVim (requires a graphical session) with a 2 panes layout
4435 (LOCAL and REMOTE)
4436 gvimdiff2
4438 Use gVim (requires a graphical session) with a 3 panes layout
4439 (LOCAL, MERGED and REMOTE)
4440 gvimdiff3
4442 Use gVim (requires a graphical session) where only the MERGED
4443 file is shown
4444 kdiff3
4446 Use KDiff3 (requires a graphical session)
4447 meld
4449 Use Meld (requires a graphical session) with optional auto
4450 merge (see git help mergetool's CONFIGURATION section)
4451 nvimdiff
4453 Use Neovim with a custom layout (see git help mergetool's
4454 BACKEND SPECIFIC HINTS section)
4455 nvimdiff1
4457 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
4458 nvimdiff2
4460 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
4461 nvimdiff3
4463 Use Neovim where only the MERGED file is shown
4464 opendiff
4466 Use FileMerge (requires a graphical session)
4467 p4merge
4469 Use HelixCore P4Merge (requires a graphical session)
4470 smerge
4472 Use Sublime Merge (requires a graphical session)
4473 tkdiff
4475 Use TkDiff (requires a graphical session)
4476 tortoisemerge
4478 Use TortoiseMerge (requires a graphical session)
4479 vimdiff
4481 Use Vim with a custom layout (see git help mergetool's BACKEND
4482 SPECIFIC HINTS section)
4483 vimdiff1
4485 Use Vim with a 2 panes layout (LOCAL and REMOTE)
4486 vimdiff2
4488 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
4489 vimdiff3
4491 Use Vim where only the MERGED file is shown
4492 winmerge
4494 Use WinMerge (requires a graphical session)
4495 xxdiff
4497 Use xxdiff (requires a graphical session)
4498 merge.verbosity
4500 Controls the amount of output shown by the recursive merge
4501 strategy. Level 0 outputs nothing except a final error message if
4502 conflicts were detected. Level 1 outputs only conflicts, 2 outputs
4503 conflicts and file changes. Level 5 and above outputs debugging
4504 information. The default is level 2. Can be overridden by the
4505 GIT_MERGE_VERBOSITY environment variable.
4506 merge.<driver>.name
4508 Defines a human-readable name for a custom low-level merge driver.
4509 See gitattributes(5) for details.
4510 merge.<driver>.driver
4512 Defines the command that implements a custom low-level merge
4513 driver. See gitattributes(5) for details.
4514 merge.<driver>.recursive
4516 Names a low-level merge driver to be used when performing an
4517 internal merge between common ancestors. See gitattributes(5) for
4518 details.
4519 mergetool.<tool>.path
4521 Override the path for the given tool. This is useful in case your
4522 tool is not in the PATH.
4523 mergetool.<tool>.cmd
4525 Specify the command to invoke the specified merge tool. The
4526 specified command is evaluated in shell with the following
4527 variables available: BASE is the name of a temporary file
4528 containing the common base of the files to be merged, if available;
4529 LOCAL is the name of a temporary file containing the contents of
4530 the file on the current branch; REMOTE is the name of a temporary
4531 file containing the contents of the file from the branch being
4532 merged; MERGED contains the name of the file to which the merge
4533 tool should write the results of a successful merge.
4534 mergetool.<tool>.hideResolved
4536 Allows the user to override the global mergetool.hideResolved value
4537 for a specific tool. See mergetool.hideResolved for the full
4538 description.
4539 mergetool.<tool>.trustExitCode
4541 For a custom merge command, specify whether the exit code of the
4542 merge command can be used to determine whether the merge was
4543 successful. If this is not set to true then the merge target file
4544 timestamp is checked and the merge assumed to have been successful
4545 if the file has been updated, otherwise the user is prompted to
4546 indicate the success of the merge.
4547 mergetool.meld.hasOutput
4549 Older versions of meld do not support the --output option. Git will
4550 attempt to detect whether meld supports --output by inspecting the
4551 output of meld --help. Configuring mergetool.meld.hasOutput will
4552 make Git skip these checks and use the configured value instead.
4553 Setting mergetool.meld.hasOutput to true tells Git to
4554 unconditionally use the --output option, and false avoids using
4555 --output.
4556 mergetool.meld.useAutoMerge
4558 When the --auto-merge is given, meld will merge all non-conflicting
4559 parts automatically, highlight the conflicting parts and wait for
4560 user decision. Setting mergetool.meld.useAutoMerge to true tells
4561 Git to unconditionally use the --auto-merge option with meld.
4562 Setting this value to auto makes git detect whether --auto-merge is
4563 supported and will only use --auto-merge when available. A value of
4564 false avoids using --auto-merge altogether, and is the default
4565 value.
4566 mergetool.vimdiff.layout
4568 The vimdiff backend uses this variable to control how its split
4569 windows look like. Applies even if you are using Neovim (nvim) or
4570 gVim (gvim) as the merge tool. See BACKEND SPECIFIC HINTS section
4571 in git-mergetool(1). for details.
4572 mergetool.hideResolved
4574 During a merge Git will automatically resolve as many conflicts as
4575 possible and write the MERGED file containing conflict markers
4576 around any conflicts that it cannot resolve; LOCAL and REMOTE
4577 normally represent the versions of the file from before Git’s
4578 conflict resolution. This flag causes LOCAL and REMOTE to be
4579 overwritten so that only the unresolved conflicts are presented to
4580 the merge tool. Can be configured per-tool via the
4581 mergetool.<tool>.hideResolved configuration variable. Defaults to
4582 false.
4583 mergetool.keepBackup
4585 After performing a merge, the original file with conflict markers
4586 can be saved as a file with a .orig extension. If this variable is
4587 set to false then this file is not preserved. Defaults to true
4588 (i.e. keep the backup files).
4589 mergetool.keepTemporaries
4591 When invoking a custom merge tool, Git uses a set of temporary
4592 files to pass to the tool. If the tool returns an error and this
4593 variable is set to true, then these temporary files will be
4594 preserved, otherwise they will be removed after the tool has
4595 exited. Defaults to false.
4596 mergetool.writeToTemp
4598 Git writes temporary BASE, LOCAL, and REMOTE versions of
4599 conflicting files in the worktree by default. Git will attempt to
4600 use a temporary directory for these files when set true. Defaults
4601 to false.
4602 mergetool.prompt
4604 Prompt before each invocation of the merge resolution program.
4605 notes.mergeStrategy
4607 Which merge strategy to choose by default when resolving notes
4608 conflicts. Must be one of manual, ours, theirs, union, or
4609 cat_sort_uniq. Defaults to manual. See "NOTES MERGE STRATEGIES"
4610 section of git-notes(1) for more information on each strategy.
4611 This setting can be overridden by passing the --strategy option to
4613 git-notes(1).
4614 notes.<name>.mergeStrategy
4616 Which merge strategy to choose when doing a notes merge into
4617 refs/notes/<name>. This overrides the more general
4618 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
4619 git-notes(1) for more information on the available strategies.
4620 notes.displayRef
4622 Which ref (or refs, if a glob or specified more than once), in
4623 addition to the default set by core.notesRef or GIT_NOTES_REF, to
4624 read notes from when showing commit messages with the git log
4625 family of commands.
4626 This setting can be overridden with the GIT_NOTES_DISPLAY_REF
4628 environment variable, which must be a colon separated list of refs
4629 or globs.
4630 A warning will be issued for refs that do not exist, but a glob
4632 that does not match any refs is silently ignored.
4633 This setting can be disabled by the --no-notes option to the git
4635 log family of commands, or by the --notes=<ref> option accepted by
4636 those commands.
4637 The effective value of "core.notesRef" (possibly overridden by
4639 GIT_NOTES_REF) is also implicitly added to the list of refs to be
4640 displayed.
4641 notes.rewrite.<command>
4643 When rewriting commits with <command> (currently amend or rebase),
4644 if this variable is false, git will not copy notes from the
4645 original to the rewritten commit. Defaults to true. See also
4646 "notes.rewriteRef" below.
4647 This setting can be overridden with the GIT_NOTES_REWRITE_REF
4649 environment variable, which must be a colon separated list of refs
4650 or globs.
4651 notes.rewriteMode
4653 When copying notes during a rewrite (see the
4654 "notes.rewrite.<command>" option), determines what to do if the
4655 target commit already has a note. Must be one of overwrite,
4656 concatenate, cat_sort_uniq, or ignore. Defaults to concatenate.
4657 This setting can be overridden with the GIT_NOTES_REWRITE_MODE
4659 environment variable.
4660 notes.rewriteRef
4662 When copying notes during a rewrite, specifies the (fully
4663 qualified) ref whose notes should be copied. May be a glob, in
4664 which case notes in all matching refs will be copied. You may also
4665 specify this configuration several times.
4666 Does not have a default value; you must configure this variable to
4668 enable note rewriting. Set it to refs/notes/commits to enable
4669 rewriting for the default commit notes.
4670 Can be overridden with the GIT_NOTES_REWRITE_REF environment
4672 variable. See notes.rewrite.<command> above for a further
4673 description of its format.
4674 pack.window
4676 The size of the window used by git-pack-objects(1) when no window
4677 size is given on the command line. Defaults to 10.
4678 pack.depth
4680 The maximum delta depth used by git-pack-objects(1) when no maximum
4681 depth is given on the command line. Defaults to 50. Maximum value
4682 is 4095.
4683 pack.windowMemory
4685 The maximum size of memory that is consumed by each thread in git-
4686 pack-objects(1) for pack window memory when no limit is given on
4687 the command line. The value can be suffixed with "k", "m", or "g".
4688 When left unconfigured (or set explicitly to 0), there will be no
4689 limit.
4690 pack.compression
4692 An integer -1..9, indicating the compression level for objects in a
4693 pack file. -1 is the zlib default. 0 means no compression, and 1..9
4694 are various speed/size tradeoffs, 9 being slowest. If not set,
4695 defaults to core.compression. If that is not set, defaults to -1,
4696 the zlib default, which is "a default compromise between speed and
4697 compression (currently equivalent to level 6)."
4698 Note that changing the compression level will not automatically
4700 recompress all existing objects. You can force recompression by
4701 passing the -F option to git-repack(1).
4702 pack.allowPackReuse
4704 When true, and when reachability bitmaps are enabled, pack-objects
4705 will try to send parts of the bitmapped packfile verbatim. This can
4706 reduce memory and CPU usage to serve fetches, but might result in
4707 sending a slightly larger pack. Defaults to true.
4708 pack.island
4710 An extended regular expression configuring a set of delta islands.
4711 See "DELTA ISLANDS" in git-pack-objects(1) for details.
4712 pack.islandCore
4714 Specify an island name which gets to have its objects be packed
4715 first. This creates a kind of pseudo-pack at the front of one pack,
4716 so that the objects from the specified island are hopefully faster
4717 to copy into any pack that should be served to a user requesting
4718 these objects. In practice this means that the island specified
4719 should likely correspond to what is the most commonly cloned in the
4720 repo. See also "DELTA ISLANDS" in git-pack-objects(1).
4721 pack.deltaCacheSize
4723 The maximum memory in bytes used for caching deltas in git-pack-
4724 objects(1) before writing them out to a pack. This cache is used to
4725 speed up the writing object phase by not having to recompute the
4726 final delta result once the best match for all objects is found.
4727 Repacking large repositories on machines which are tight with
4728 memory might be badly impacted by this though, especially if this
4729 cache pushes the system into swapping. A value of 0 means no limit.
4730 The smallest size of 1 byte may be used to virtually disable this
4731 cache. Defaults to 256 MiB.
4732 pack.deltaCacheLimit
4734 The maximum size of a delta, that is cached in git-pack-objects(1).
4735 This cache is used to speed up the writing object phase by not
4736 having to recompute the final delta result once the best match for
4737 all objects is found. Defaults to 1000. Maximum value is 65535.
4738 pack.threads
4740 Specifies the number of threads to spawn when searching for best
4741 delta matches. This requires that git-pack-objects(1) be compiled
4742 with pthreads otherwise this option is ignored with a warning. This
4743 is meant to reduce packing time on multiprocessor machines. The
4744 required amount of memory for the delta search window is however
4745 multiplied by the number of threads. Specifying 0 will cause Git to
4746 auto-detect the number of CPU’s and set the number of threads
4747 accordingly.
4748 pack.indexVersion
4750 Specify the default pack index version. Valid values are 1 for
4751 legacy pack index used by Git versions prior to 1.5.2, and 2 for
4752 the new pack index with capabilities for packs larger than 4 GB as
4753 well as proper protection against the repacking of corrupted packs.
4754 Version 2 is the default. Note that version 2 is enforced and this
4755 config option ignored whenever the corresponding pack is larger
4756 than 2 GB.
4757 If you have an old Git that does not understand the version 2 *.idx
4759 file, cloning or fetching over a non native protocol (e.g. "http")
4760 that will copy both *.pack file and corresponding *.idx file from
4761 the other side may give you a repository that cannot be accessed
4762 with your older version of Git. If the *.pack file is smaller than
4763 2 GB, however, you can use git-index-pack(1) on the *.pack file to
4764 regenerate the *.idx file.
4765 pack.packSizeLimit
4767 The maximum size of a pack. This setting only affects packing to a
4768 file when repacking, i.e. the git:// protocol is unaffected. It can
4769 be overridden by the --max-pack-size option of git-repack(1).
4770 Reaching this limit results in the creation of multiple packfiles.
4771 Note that this option is rarely useful, and may result in a larger
4773 total on-disk size (because Git will not store deltas between
4774 packs), as well as worse runtime performance (object lookup within
4775 multiple packs is slower than a single pack, and optimizations like
4776 reachability bitmaps cannot cope with multiple packs).
4777 If you need to actively run Git using smaller packfiles (e.g.,
4779 because your filesystem does not support large files), this option
4780 may help. But if your goal is to transmit a packfile over a medium
4781 that supports limited sizes (e.g., removable media that cannot
4782 store the whole repository), you are likely better off creating a
4783 single large packfile and splitting it using a generic multi-volume
4784 archive tool (e.g., Unix split).
4785 The minimum size allowed is limited to 1 MiB. The default is
4787 unlimited. Common unit suffixes of k, m, or g are supported.
4788 pack.useBitmaps
4790 When true, git will use pack bitmaps (if available) when packing to
4791 stdout (e.g., during the server side of a fetch). Defaults to true.
4792 You should not generally need to turn this off unless you are
4793 debugging pack bitmaps.
4794 pack.useSparse
4796 When true, git will default to using the --sparse option in git
4797 pack-objects when the --revs option is present. This algorithm only
4798 walks trees that appear in paths that introduce new objects. This
4799 can have significant performance benefits when computing a pack to
4800 send a small change. However, it is possible that extra objects are
4801 added to the pack-file if the included commits contain certain
4802 types of direct renames. Default is true.
4803 pack.preferBitmapTips
4805 When selecting which commits will receive bitmaps, prefer a commit
4806 at the tip of any reference that is a suffix of any value of this
4807 configuration over any other commits in the "selection window".
4808 Note that setting this configuration to refs/foo does not mean that
4810 the commits at the tips of refs/foo/bar and refs/foo/baz will
4811 necessarily be selected. This is because commits are selected for
4812 bitmaps from within a series of windows of variable length.
4813 If a commit at the tip of any reference which is a suffix of any
4815 value of this configuration is seen in a window, it is immediately
4816 given preference over any other commit in that window.
4817 pack.writeBitmaps (deprecated)
4819 This is a deprecated synonym for repack.writeBitmaps.
4820 pack.writeBitmapHashCache
4822 When true, git will include a "hash cache" section in the bitmap
4823 index (if one is written). This cache can be used to feed git’s
4824 delta heuristics, potentially leading to better deltas between
4825 bitmapped and non-bitmapped objects (e.g., when serving a fetch
4826 between an older, bitmapped pack and objects that have been pushed
4827 since the last gc). The downside is that it consumes 4 bytes per
4828 object of disk space. Defaults to true.
4829 When writing a multi-pack reachability bitmap, no new namehashes
4831 are computed; instead, any namehashes stored in an existing bitmap
4832 are permuted into their appropriate location when writing a new
4833 bitmap.
4834 pack.writeBitmapLookupTable
4836 When true, Git will include a "lookup table" section in the bitmap
4837 index (if one is written). This table is used to defer loading
4838 individual bitmaps as late as possible. This can be beneficial in
4839 repositories that have relatively large bitmap indexes. Defaults to
4840 false.
4841 pack.writeReverseIndex
4843 When true, git will write a corresponding .rev file (see:
4844 gitformat-pack(5)) for each new packfile that it writes in all
4845 places except for git-fast-import(1) and in the bulk checkin
4846 mechanism. Defaults to false.
4847 pager.<cmd>
4849 If the value is boolean, turns on or off pagination of the output
4850 of a particular Git subcommand when writing to a tty. Otherwise,
4851 turns on pagination for the subcommand using the pager specified by
4852 the value of pager.<cmd>. If --paginate or --no-pager is specified
4853 on the command line, it takes precedence over this option. To
4854 disable pagination for all commands, set core.pager or GIT_PAGER to
4855 cat.
4856 pretty.<name>
4858 Alias for a --pretty= format string, as specified in git-log(1).
4859 Any aliases defined here can be used just as the built-in pretty
4860 formats could. For example, running git config pretty.changelog
4861 "format:* %H %s" would cause the invocation git log
4862 --pretty=changelog to be equivalent to running git log
4863 "--pretty=format:* %H %s". Note that an alias with the same name as
4864 a built-in format will be silently ignored.
4865 protocol.allow
4867 If set, provide a user defined default policy for all protocols
4868 which don’t explicitly have a policy (protocol.<name>.allow). By
4869 default, if unset, known-safe protocols (http, https, git, ssh)
4870 have a default policy of always, known-dangerous protocols (ext)
4871 have a default policy of never, and all other protocols (including
4872 file) have a default policy of user. Supported policies:
4873 • always - protocol is always able to be used.
4875 • never - protocol is never able to be used.
4877 • user - protocol is only able to be used when
4879 GIT_PROTOCOL_FROM_USER is either unset or has a value of 1.
4880 This policy should be used when you want a protocol to be
4881 directly usable by the user but don’t want it used by commands
4882 which execute clone/fetch/push commands without user input,
4883 e.g. recursive submodule initialization.
4884 protocol.<name>.allow
4886 Set a policy to be used by protocol <name> with clone/fetch/push
4887 commands. See protocol.allow above for the available policies.
4888 The protocol names currently used by git are:
4890 • file: any local file-based path (including file:// URLs, or
4892 local paths)
4893 • git: the anonymous git protocol over a direct TCP connection
4895 (or proxy, if configured)
4896 • ssh: git over ssh (including host:path syntax, ssh://, etc).
4898 • http: git over http, both "smart http" and "dumb http". Note
4900 that this does not include https; if you want to configure
4901 both, you must do so individually.
4902 • any external helpers are named by their protocol (e.g., use hg
4904 to allow the git-remote-hg helper)
4905 protocol.version
4907 If set, clients will attempt to communicate with a server using the
4908 specified protocol version. If the server does not support it,
4909 communication falls back to version 0. If unset, the default is 2.
4910 Supported versions:
4911 • 0 - the original wire protocol.
4913 • 1 - the original wire protocol with the addition of a version
4915 string in the initial response from the server.
4916 • 2 - Wire protocol version 2, see gitprotocol-v2(5).
4918 pull.ff
4920 By default, Git does not create an extra merge commit when merging
4921 a commit that is a descendant of the current commit. Instead, the
4922 tip of the current branch is fast-forwarded. When set to false,
4923 this variable tells Git to create an extra merge commit in such a
4924 case (equivalent to giving the --no-ff option from the command
4925 line). When set to only, only such fast-forward merges are allowed
4926 (equivalent to giving the --ff-only option from the command line).
4927 This setting overrides merge.ff when pulling.
4928 pull.rebase
4930 When true, rebase branches on top of the fetched branch, instead of
4931 merging the default branch from the default remote when "git pull"
4932 is run. See "branch.<name>.rebase" for setting this on a per-branch
4933 basis.
4934 When merges (or just m), pass the --rebase-merges option to git
4936 rebase so that the local merge commits are included in the rebase
4937 (see git-rebase(1) for details).
4938 When the value is interactive (or just i), the rebase is run in
4940 interactive mode.
4941 NOTE: this is a possibly dangerous operation; do not use it unless
4943 you understand the implications (see git-rebase(1) for details).
4944 pull.octopus
4946 The default merge strategy to use when pulling multiple branches at
4947 once.
4948 pull.twohead
4950 The default merge strategy to use when pulling a single branch.
4951 push.autoSetupRemote
4953 If set to "true" assume --set-upstream on default push when no
4954 upstream tracking exists for the current branch; this option takes
4955 effect with push.default options simple, upstream, and current. It
4956 is useful if by default you want new branches to be pushed to the
4957 default remote (like the behavior of push.default=current) and you
4958 also want the upstream tracking to be set. Workflows most likely to
4959 benefit from this option are simple central workflows where all
4960 branches are expected to have the same name on the remote.
4961 push.default
4963 Defines the action git push should take if no refspec is given
4964 (whether from the command-line, config, or elsewhere). Different
4965 values are well-suited for specific workflows; for instance, in a
4966 purely central workflow (i.e. the fetch source is equal to the push
4967 destination), upstream is probably what you want. Possible values
4968 are:
4969 • nothing - do not push anything (error out) unless a refspec is
4971 given. This is primarily meant for people who want to avoid
4972 mistakes by always being explicit.
4973 • current - push the current branch to update a branch with the
4975 same name on the receiving end. Works in both central and
4976 non-central workflows.
4977 • upstream - push the current branch back to the branch whose
4979 changes are usually integrated into the current branch (which
4980 is called @{upstream}). This mode only makes sense if you are
4981 pushing to the same repository you would normally pull from
4982 (i.e. central workflow).
4983 • tracking - This is a deprecated synonym for upstream.
4985 • simple - pushes the current branch with the same name on the
4987 remote.
4988 If you are working on a centralized workflow (pushing to the
4990 same repository you pull from, which is typically origin), then
4991 you need to configure an upstream branch with the same name.
4992 This mode is the default since Git 2.0, and is the safest
4994 option suited for beginners.
4995 • matching - push all branches having the same name on both ends.
4997 This makes the repository you are pushing to remember the set
4998 of branches that will be pushed out (e.g. if you always push
4999 maint and master there and no other branches, the repository
5000 you push to will have these two branches, and your local maint
5001 and master will be pushed there).
5002 To use this mode effectively, you have to make sure all the
5004 branches you would push out are ready to be pushed out before
5005 running git push, as the whole point of this mode is to allow
5006 you to push all of the branches in one go. If you usually
5007 finish work on only one branch and push out the result, while
5008 other branches are unfinished, this mode is not for you. Also
5009 this mode is not suitable for pushing into a shared central
5010 repository, as other people may add new branches there, or
5011 update the tip of existing branches outside your control.
5012 This used to be the default, but not since Git 2.0 (simple is
5014 the new default).
5015 push.followTags
5017 If set to true enable --follow-tags option by default. You may
5018 override this configuration at time of push by specifying
5019 --no-follow-tags.
5020 push.gpgSign
5022 May be set to a boolean value, or the string if-asked. A true value
5023 causes all pushes to be GPG signed, as if --signed is passed to
5024 git-push(1). The string if-asked causes pushes to be signed if the
5025 server supports it, as if --signed=if-asked is passed to git push.
5026 A false value may override a value from a lower-priority config
5027 file. An explicit command-line flag always overrides this config
5028 option.
5029 push.pushOption
5031 When no --push-option=<option> argument is given from the command
5032 line, git push behaves as if each <value> of this variable is given
5033 as --push-option=<value>.
5034 This is a multi-valued variable, and an empty value can be used in
5036 a higher priority configuration file (e.g. .git/config in a
5037 repository) to clear the values inherited from a lower priority
5038 configuration files (e.g. $HOME/.gitconfig).
5039 Example:
5041 /etc/gitconfig
5043 push.pushoption = a
5044 push.pushoption = b
5045 ~/.gitconfig
5047 push.pushoption = c
5048 repo/.git/config
5050 push.pushoption =
5051 push.pushoption = b
5052 This will result in only b (a and c are cleared).
5054 push.recurseSubmodules
5056 May be "check", "on-demand", "only", or "no", with the same
5057 behavior as that of "push --recurse-submodules". If not set, no is
5058 used by default, unless submodule.recurse is set (in which case a
5059 true value means on-demand).
5060 push.useForceIfIncludes
5062 If set to "true", it is equivalent to specifying
5063 --force-if-includes as an option to git-push(1) in the command
5064 line. Adding --no-force-if-includes at the time of push overrides
5065 this configuration setting.
5066 push.negotiate
5068 If set to "true", attempt to reduce the size of the packfile sent
5069 by rounds of negotiation in which the client and the server attempt
5070 to find commits in common. If "false", Git will rely solely on the
5071 server’s ref advertisement to find commits in common.
5072 push.useBitmaps
5074 If set to "false", disable use of bitmaps for "git push" even if
5075 pack.useBitmaps is "true", without preventing other git operations
5076 from using bitmaps. Default is true.
5077 rebase.backend
5079 Default backend to use for rebasing. Possible choices are apply or
5080 merge. In the future, if the merge backend gains all remaining
5081 capabilities of the apply backend, this setting may become unused.
5082 rebase.stat
5084 Whether to show a diffstat of what changed upstream since the last
5085 rebase. False by default.
5086 rebase.autoSquash
5088 If set to true enable --autosquash option by default.
5089 rebase.autoStash
5091 When set to true, automatically create a temporary stash entry
5092 before the operation begins, and apply it after the operation ends.
5093 This means that you can run rebase on a dirty worktree. However,
5094 use with care: the final stash application after a successful
5095 rebase might result in non-trivial conflicts. This option can be
5096 overridden by the --no-autostash and --autostash options of git-
5097 rebase(1). Defaults to false.
5098 rebase.updateRefs
5100 If set to true enable --update-refs option by default.
5101 rebase.missingCommitsCheck
5103 If set to "warn", git rebase -i will print a warning if some
5104 commits are removed (e.g. a line was deleted), however the rebase
5105 will still proceed. If set to "error", it will print the previous
5106 warning and stop the rebase, git rebase --edit-todo can then be
5107 used to correct the error. If set to "ignore", no checking is done.
5108 To drop a commit without warning or error, use the drop command in
5109 the todo list. Defaults to "ignore".
5110 rebase.instructionFormat
5112 A format string, as specified in git-log(1), to be used for the
5113 todo list during an interactive rebase. The format will
5114 automatically have the long commit hash prepended to the format.
5115 rebase.abbreviateCommands
5117 If set to true, git rebase will use abbreviated command names in
5118 the todo list resulting in something like this:
5119 p deadbee The oneline of the commit
5121 p fa1afe1 The oneline of the next commit
5122 ...
5123 instead of:
5125 pick deadbee The oneline of the commit
5127 pick fa1afe1 The oneline of the next commit
5128 ...
5129 Defaults to false.
5131 rebase.rescheduleFailedExec
5133 Automatically reschedule exec commands that failed. This only makes
5134 sense in interactive mode (or when an --exec option was provided).
5135 This is the same as specifying the --reschedule-failed-exec option.
5136 rebase.forkPoint
5138 If set to false set --no-fork-point option by default.
5139 receive.advertiseAtomic
5141 By default, git-receive-pack will advertise the atomic push
5142 capability to its clients. If you don’t want to advertise this
5143 capability, set this variable to false.
5144 receive.advertisePushOptions
5146 When set to true, git-receive-pack will advertise the push options
5147 capability to its clients. False by default.
5148 receive.autogc
5150 By default, git-receive-pack will run "git-gc --auto" after
5151 receiving data from git-push and updating refs. You can stop it by
5152 setting this variable to false.
5153 receive.certNonceSeed
5155 By setting this variable to a string, git receive-pack will accept
5156 a git push --signed and verifies it by using a "nonce" protected by
5157 HMAC using this string as a secret key.
5158 receive.certNonceSlop
5160 When a git push --signed sent a push certificate with a "nonce"
5161 that was issued by a receive-pack serving the same repository
5162 within this many seconds, export the "nonce" found in the
5163 certificate to GIT_PUSH_CERT_NONCE to the hooks (instead of what
5164 the receive-pack asked the sending side to include). This may allow
5165 writing checks in pre-receive and post-receive a bit easier.
5166 Instead of checking GIT_PUSH_CERT_NONCE_SLOP environment variable
5167 that records by how many seconds the nonce is stale to decide if
5168 they want to accept the certificate, they only can check
5169 GIT_PUSH_CERT_NONCE_STATUS is OK.
5170 receive.fsckObjects
5172 If it is set to true, git-receive-pack will check all received
5173 objects. See transfer.fsckObjects for what’s checked. Defaults to
5174 false. If not set, the value of transfer.fsckObjects is used
5175 instead.
5176 receive.fsck.<msg-id>
5178 Acts like fsck.<msg-id>, but is used by git-receive-pack(1) instead
5179 of git-fsck(1). See the fsck.<msg-id> documentation for details.
5180 receive.fsck.skipList
5182 Acts like fsck.skipList, but is used by git-receive-pack(1) instead
5183 of git-fsck(1). See the fsck.skipList documentation for details.
5184 receive.keepAlive
5186 After receiving the pack from the client, receive-pack may produce
5187 no output (if --quiet was specified) while processing the pack,
5188 causing some networks to drop the TCP connection. With this option
5189 set, if receive-pack does not transmit any data in this phase for
5190 receive.keepAlive seconds, it will send a short keepalive packet.
5191 The default is 5 seconds; set to 0 to disable keepalives entirely.
5192 receive.unpackLimit
5194 If the number of objects received in a push is below this limit
5195 then the objects will be unpacked into loose object files. However
5196 if the number of received objects equals or exceeds this limit then
5197 the received pack will be stored as a pack, after adding any
5198 missing delta bases. Storing the pack from a push can make the push
5199 operation complete faster, especially on slow filesystems. If not
5200 set, the value of transfer.unpackLimit is used instead.
5201 receive.maxInputSize
5203 If the size of the incoming pack stream is larger than this limit,
5204 then git-receive-pack will error out, instead of accepting the pack
5205 file. If not set or set to 0, then the size is unlimited.
5206 receive.denyDeletes
5208 If set to true, git-receive-pack will deny a ref update that
5209 deletes the ref. Use this to prevent such a ref deletion via a
5210 push.
5211 receive.denyDeleteCurrent
5213 If set to true, git-receive-pack will deny a ref update that
5214 deletes the currently checked out branch of a non-bare repository.
5215 receive.denyCurrentBranch
5217 If set to true or "refuse", git-receive-pack will deny a ref update
5218 to the currently checked out branch of a non-bare repository. Such
5219 a push is potentially dangerous because it brings the HEAD out of
5220 sync with the index and working tree. If set to "warn", print a
5221 warning of such a push to stderr, but allow the push to proceed. If
5222 set to false or "ignore", allow such pushes with no message.
5223 Defaults to "refuse".
5224 Another option is "updateInstead" which will update the working
5226 tree if pushing into the current branch. This option is intended
5227 for synchronizing working directories when one side is not easily
5228 accessible via interactive ssh (e.g. a live web site, hence the
5229 requirement that the working directory be clean). This mode also
5230 comes in handy when developing inside a VM to test and fix code on
5231 different Operating Systems.
5232 By default, "updateInstead" will refuse the push if the working
5234 tree or the index have any difference from the HEAD, but the
5235 push-to-checkout hook can be used to customize this. See
5236 githooks(5).
5237 receive.denyNonFastForwards
5239 If set to true, git-receive-pack will deny a ref update which is
5240 not a fast-forward. Use this to prevent such an update via a push,
5241 even if that push is forced. This configuration variable is set
5242 when initializing a shared repository.
5243 receive.hideRefs
5245 This variable is the same as transfer.hideRefs, but applies only to
5246 receive-pack (and so affects pushes, but not fetches). An attempt
5247 to update or delete a hidden ref by git push is rejected.
5248 receive.procReceiveRefs
5250 This is a multi-valued variable that defines reference prefixes to
5251 match the commands in receive-pack. Commands matching the prefixes
5252 will be executed by an external hook "proc-receive", instead of the
5253 internal execute_commands function. If this variable is not
5254 defined, the "proc-receive" hook will never be used, and all
5255 commands will be executed by the internal execute_commands
5256 function.
5257 For example, if this variable is set to "refs/for", pushing to
5259 reference such as "refs/for/master" will not create or update a
5260 reference named "refs/for/master", but may create or update a pull
5261 request directly by running the hook "proc-receive".
5262 Optional modifiers can be provided in the beginning of the value to
5264 filter commands for specific actions: create (a), modify (m),
5265 delete (d). A ! can be included in the modifiers to negate the
5266 reference prefix entry. E.g.:
5267 git config --system --add receive.procReceiveRefs ad:refs/heads
5269 git config --system --add receive.procReceiveRefs !:refs/heads
5270 receive.updateServerInfo
5272 If set to true, git-receive-pack will run git-update-server-info
5273 after receiving data from git-push and updating refs.
5274 receive.shallowUpdate
5276 If set to true, .git/shallow can be updated when new refs require
5277 new shallow roots. Otherwise those refs are rejected.
5278 remote.pushDefault
5280 The remote to push to by default. Overrides branch.<name>.remote
5281 for all branches, and is overridden by branch.<name>.pushRemote for
5282 specific branches.
5283 remote.<name>.url
5285 The URL of a remote repository. See git-fetch(1) or git-push(1).
5286 remote.<name>.pushurl
5288 The push URL of a remote repository. See git-push(1).
5289 remote.<name>.proxy
5291 For remotes that require curl (http, https and ftp), the URL to the
5292 proxy to use for that remote. Set to the empty string to disable
5293 proxying for that remote.
5294 remote.<name>.proxyAuthMethod
5296 For remotes that require curl (http, https and ftp), the method to
5297 use for authenticating against the proxy in use (probably set in
5298 remote.<name>.proxy). See http.proxyAuthMethod.
5299 remote.<name>.fetch
5301 The default set of "refspec" for git-fetch(1). See git-fetch(1).
5302 remote.<name>.push
5304 The default set of "refspec" for git-push(1). See git-push(1).
5305 remote.<name>.mirror
5307 If true, pushing to this remote will automatically behave as if the
5308 --mirror option was given on the command line.
5309 remote.<name>.skipDefaultUpdate
5311 If true, this remote will be skipped by default when updating using
5312 git-fetch(1) or the update subcommand of git-remote(1).
5313 remote.<name>.skipFetchAll
5315 If true, this remote will be skipped by default when updating using
5316 git-fetch(1) or the update subcommand of git-remote(1).
5317 remote.<name>.receivepack
5319 The default program to execute on the remote side when pushing. See
5320 option --receive-pack of git-push(1).
5321 remote.<name>.uploadpack
5323 The default program to execute on the remote side when fetching.
5324 See option --upload-pack of git-fetch-pack(1).
5325 remote.<name>.tagOpt
5327 Setting this value to --no-tags disables automatic tag following
5328 when fetching from remote <name>. Setting it to --tags will fetch
5329 every tag from remote <name>, even if they are not reachable from
5330 remote branch heads. Passing these flags directly to git-fetch(1)
5331 can override this setting. See options --tags and --no-tags of git-
5332 fetch(1).
5333 remote.<name>.vcs
5335 Setting this to a value <vcs> will cause Git to interact with the
5336 remote with the git-remote-<vcs> helper.
5337 remote.<name>.prune
5339 When set to true, fetching from this remote by default will also
5340 remove any remote-tracking references that no longer exist on the
5341 remote (as if the --prune option was given on the command line).
5342 Overrides fetch.prune settings, if any.
5343 remote.<name>.pruneTags
5345 When set to true, fetching from this remote by default will also
5346 remove any local tags that no longer exist on the remote if pruning
5347 is activated in general via remote.<name>.prune, fetch.prune or
5348 --prune. Overrides fetch.pruneTags settings, if any.
5349 See also remote.<name>.prune and the PRUNING section of git-
5351 fetch(1).
5352 remote.<name>.promisor
5354 When set to true, this remote will be used to fetch promisor
5355 objects.
5356 remote.<name>.partialclonefilter
5358 The filter that will be applied when fetching from this promisor
5359 remote. Changing or clearing this value will only affect fetches
5360 for new commits. To fetch associated objects for commits already
5361 present in the local object database, use the --refetch option of
5362 git-fetch(1).
5363 remotes.<group>
5365 The list of remotes which are fetched by "git remote update
5366 <group>". See git-remote(1).
5367 repack.useDeltaBaseOffset
5369 By default, git-repack(1) creates packs that use delta-base offset.
5370 If you need to share your repository with Git older than version
5371 1.4.4, either directly or via a dumb protocol such as http, then
5372 you need to set this option to "false" and repack. Access from old
5373 Git versions over the native protocol are unaffected by this
5374 option.
5375 repack.packKeptObjects
5377 If set to true, makes git repack act as if --pack-kept-objects was
5378 passed. See git-repack(1) for details. Defaults to false normally,
5379 but true if a bitmap index is being written (either via
5380 --write-bitmap-index or repack.writeBitmaps).
5381 repack.useDeltaIslands
5383 If set to true, makes git repack act as if --delta-islands was
5384 passed. Defaults to false.
5385 repack.writeBitmaps
5387 When true, git will write a bitmap index when packing all objects
5388 to disk (e.g., when git repack -a is run). This index can speed up
5389 the "counting objects" phase of subsequent packs created for clones
5390 and fetches, at the cost of some disk space and extra time spent on
5391 the initial repack. This has no effect if multiple packfiles are
5392 created. Defaults to true on bare repos, false otherwise.
5393 repack.updateServerInfo
5395 If set to false, git-repack(1) will not run git-update-server-
5396 info(1). Defaults to true. Can be overridden when true by the -n
5397 option of git-repack(1).
5398 repack.cruftWindow, repack.cruftWindowMemory, repack.cruftDepth,
5400 repack.cruftThreads
5401 Parameters used by git-pack-objects(1) when generating a cruft pack
5402 and the respective parameters are not given over the command line.
5403 See similarly named pack.* configuration variables for defaults
5404 and meaning.
5405 rerere.autoUpdate
5407 When set to true, git-rerere updates the index with the resulting
5408 contents after it cleanly resolves conflicts using previously
5409 recorded resolution. Defaults to false.
5410 rerere.enabled
5412 Activate recording of resolved conflicts, so that identical
5413 conflict hunks can be resolved automatically, should they be
5414 encountered again. By default, git-rerere(1) is enabled if there is
5415 an rr-cache directory under the $GIT_DIR, e.g. if "rerere" was
5416 previously used in the repository.
5417 revert.reference
5419 Setting this variable to true makes git revert behave as if the
5420 --reference option is given.
5421 safe.bareRepository
5423 Specifies which bare repositories Git will work with. The currently
5424 supported values are:
5425 • all: Git works with all bare repositories. This is the default.
5427 • explicit: Git only works with bare repositories specified via
5429 the top-level --git-dir command-line option, or the GIT_DIR
5430 environment variable (see git(1)).
5431 If you do not use bare repositories in your workflow, then it
5433 may be beneficial to set safe.bareRepository to explicit in
5434 your global config. This will protect you from attacks that
5435 involve cloning a repository that contains a bare repository
5436 and running a Git command within that directory.
5437 This config setting is only respected in protected
5439 configuration (see the section called “SCOPES”). This prevents
5440 the untrusted repository from tampering with this value.
5441 safe.directory
5443 These config entries specify Git-tracked directories that are
5444 considered safe even if they are owned by someone other than the
5445 current user. By default, Git will refuse to even parse a Git
5446 config of a repository owned by someone else, let alone run its
5447 hooks, and this config setting allows users to specify exceptions,
5448 e.g. for intentionally shared repositories (see the --shared option
5449 in git-init(1)).
5450 This is a multi-valued setting, i.e. you can add more than one
5452 directory via git config --add. To reset the list of safe
5453 directories (e.g. to override any such directories specified in the
5454 system config), add a safe.directory entry with an empty value.
5455 This config setting is only respected in protected configuration
5457 (see the section called “SCOPES”). This prevents the untrusted
5458 repository from tampering with this value.
5459 The value of this setting is interpolated, i.e. ~/<path> expands
5461 to a path relative to the home directory and %(prefix)/<path>
5462 expands to a path relative to Git’s (runtime) prefix.
5463 To completely opt-out of this security check, set safe.directory to
5465 the string *. This will allow all repositories to be treated as if
5466 their directory was listed in the safe.directory list. If
5467 safe.directory=* is set in system config and you want to re-enable
5468 this protection, then initialize your list with an empty value
5469 before listing the repositories that you deem safe.
5470 As explained, Git only allows you to access repositories owned by
5472 yourself, i.e. the user who is running Git, by default. When Git is
5473 running as root in a non Windows platform that provides sudo,
5474 however, git checks the SUDO_UID environment variable that sudo
5475 creates and will allow access to the uid recorded as its value in
5476 addition to the id from root. This is to make it easy to perform a
5477 common sequence during installation "make && sudo make install". A
5478 git process running under sudo runs as root but the sudo command
5479 exports the environment variable to record which id the original
5480 user has. If that is not what you would prefer and want git to only
5481 trust repositories that are owned by root instead, then you can
5482 remove the SUDO_UID variable from root’s environment before
5483 invoking git.
5484 sendemail.identity
5486 A configuration identity. When given, causes values in the
5487 sendemail.<identity> subsection to take precedence over values in
5488 the sendemail section. The default identity is the value of
5489 sendemail.identity.
5490 sendemail.smtpEncryption
5492 See git-send-email(1) for description. Note that this setting is
5493 not subject to the identity mechanism.
5494 sendemail.smtpsslcertpath
5496 Path to ca-certificates (either a directory or a single file). Set
5497 it to an empty string to disable certificate verification.
5498 sendemail.<identity>.*
5500 Identity-specific versions of the sendemail.* parameters found
5501 below, taking precedence over those when this identity is selected,
5502 through either the command-line or sendemail.identity.
5503 sendemail.multiEdit
5505 If true (default), a single editor instance will be spawned to edit
5506 files you have to edit (patches when --annotate is used, and the
5507 summary when --compose is used). If false, files will be edited one
5508 after the other, spawning a new editor each time.
5509 sendemail.confirm
5511 Sets the default for whether to confirm before sending. Must be one
5512 of always, never, cc, compose, or auto. See --confirm in the git-
5513 send-email(1) documentation for the meaning of these values.
5514 sendemail.aliasesFile
5516 To avoid typing long email addresses, point this to one or more
5517 email aliases files. You must also supply sendemail.aliasFileType.
5518 sendemail.aliasFileType
5520 Format of the file(s) specified in sendemail.aliasesFile. Must be
5521 one of mutt, mailrc, pine, elm, or gnus, or sendmail.
5522 What an alias file in each format looks like can be found in the
5524 documentation of the email program of the same name. The
5525 differences and limitations from the standard formats are described
5526 below:
5527 sendmail
5529 • Quoted aliases and quoted addresses are not supported:
5531 lines that contain a " symbol are ignored.
5532 • Redirection to a file (/path/name) or pipe (|command) is
5534 not supported.
5535 • File inclusion (:include: /path/name) is not supported.
5537 • Warnings are printed on the standard error output for any
5539 explicitly unsupported constructs, and any other lines that
5540 are not recognized by the parser.
5541 sendemail.annotate, sendemail.bcc, sendemail.cc, sendemail.ccCmd,
5543 sendemail.chainReplyTo, sendemail.envelopeSender, sendemail.from,
5544 sendemail.signedoffbycc, sendemail.smtpPass, sendemail.suppresscc,
5545 sendemail.suppressFrom, sendemail.to, sendemail.tocmd,
5546 sendemail.smtpDomain, sendemail.smtpServer, sendemail.smtpServerPort,
5547 sendemail.smtpServerOption, sendemail.smtpUser, sendemail.thread,
5548 sendemail.transferEncoding, sendemail.validate, sendemail.xmailer
5549 These configuration variables all provide a default for git-send-
5550 email(1) command-line options. See its documentation for details.
5551 sendemail.signedoffcc (deprecated)
5553 Deprecated alias for sendemail.signedoffbycc.
5554 sendemail.smtpBatchSize
5556 Number of messages to be sent per connection, after that a relogin
5557 will happen. If the value is 0 or undefined, send all messages in
5558 one connection. See also the --batch-size option of git-send-
5559 email(1).
5560 sendemail.smtpReloginDelay
5562 Seconds wait before reconnecting to smtp server. See also the
5563 --relogin-delay option of git-send-email(1).
5564 sendemail.forbidSendmailVariables
5566 To avoid common misconfiguration mistakes, git-send-email(1) will
5567 abort with a warning if any configuration options for "sendmail"
5568 exist. Set this variable to bypass the check.
5569 sequence.editor
5571 Text editor used by git rebase -i for editing the rebase
5572 instruction file. The value is meant to be interpreted by the shell
5573 when it is used. It can be overridden by the GIT_SEQUENCE_EDITOR
5574 environment variable. When not configured the default commit
5575 message editor is used instead.
5576 showBranch.default
5578 The default set of branches for git-show-branch(1). See git-show-
5579 branch(1).
5580 sparse.expectFilesOutsideOfPatterns
5582 Typically with sparse checkouts, files not matching any sparsity
5583 patterns are marked with a SKIP_WORKTREE bit in the index and are
5584 missing from the working tree. Accordingly, Git will ordinarily
5585 check whether files with the SKIP_WORKTREE bit are in fact present
5586 in the working tree contrary to expectations. If Git finds any, it
5587 marks those paths as present by clearing the relevant SKIP_WORKTREE
5588 bits. This option can be used to tell Git that such
5589 present-despite-skipped files are expected and to stop checking for
5590 them.
5591 The default is false, which allows Git to automatically recover
5593 from the list of files in the index and working tree falling out of
5594 sync.
5595 Set this to true if you are in a setup where some external factor
5597 relieves Git of the responsibility for maintaining the consistency
5598 between the presence of working tree files and sparsity patterns.
5599 For example, if you have a Git-aware virtual file system that has a
5600 robust mechanism for keeping the working tree and the sparsity
5601 patterns up to date based on access patterns.
5602 Regardless of this setting, Git does not check for
5604 present-despite-skipped files unless sparse checkout is enabled, so
5605 this config option has no effect unless core.sparseCheckout is
5606 true.
5607 splitIndex.maxPercentChange
5609 When the split index feature is used, this specifies the percent of
5610 entries the split index can contain compared to the total number of
5611 entries in both the split index and the shared index before a new
5612 shared index is written. The value should be between 0 and 100. If
5613 the value is 0 then a new shared index is always written, if it is
5614 100 a new shared index is never written. By default the value is
5615 20, so a new shared index is written if the number of entries in
5616 the split index would be greater than 20 percent of the total
5617 number of entries. See git-update-index(1).
5618 splitIndex.sharedIndexExpire
5620 When the split index feature is used, shared index files that were
5621 not modified since the time this variable specifies will be removed
5622 when a new shared index file is created. The value "now" expires
5623 all entries immediately, and "never" suppresses expiration
5624 altogether. The default value is "2.weeks.ago". Note that a shared
5625 index file is considered modified (for the purpose of expiration)
5626 each time a new split-index file is either created based on it or
5627 read from it. See git-update-index(1).
5628 ssh.variant
5630 By default, Git determines the command line arguments to use based
5631 on the basename of the configured SSH command (configured using the
5632 environment variable GIT_SSH or GIT_SSH_COMMAND or the config
5633 setting core.sshCommand). If the basename is unrecognized, Git will
5634 attempt to detect support of OpenSSH options by first invoking the
5635 configured SSH command with the -G (print configuration) option and
5636 will subsequently use OpenSSH options (if that is successful) or no
5637 options besides the host and remote command (if it fails).
5638 The config variable ssh.variant can be set to override this
5640 detection. Valid values are ssh (to use OpenSSH options), plink,
5641 putty, tortoiseplink, simple (no options except the host and remote
5642 command). The default auto-detection can be explicitly requested
5643 using the value auto. Any other value is treated as ssh. This
5644 setting can also be overridden via the environment variable
5645 GIT_SSH_VARIANT.
5646 The current command-line parameters used for each variant are as
5648 follows:
5649 • ssh - [-p port] [-4] [-6] [-o option] [username@]host command
5651 • simple - [username@]host command
5653 • plink or putty - [-P port] [-4] [-6] [username@]host command
5655 • tortoiseplink - [-P port] [-4] [-6] -batch [username@]host
5657 command
5658 Except for the simple variant, command-line parameters are likely
5660 to change as git gains new features.
5661 status.relativePaths
5663 By default, git-status(1) shows paths relative to the current
5664 directory. Setting this variable to false shows paths relative to
5665 the repository root (this was the default for Git prior to v1.5.4).
5666 status.short
5668 Set to true to enable --short by default in git-status(1). The
5669 option --no-short takes precedence over this variable.
5670 status.branch
5672 Set to true to enable --branch by default in git-status(1). The
5673 option --no-branch takes precedence over this variable.
5674 status.aheadBehind
5676 Set to true to enable --ahead-behind and false to enable
5677 --no-ahead-behind by default in git-status(1) for non-porcelain
5678 status formats. Defaults to true.
5679 status.displayCommentPrefix
5681 If set to true, git-status(1) will insert a comment prefix before
5682 each output line (starting with core.commentChar, i.e. # by
5683 default). This was the behavior of git-status(1) in Git 1.8.4 and
5684 previous. Defaults to false.
5685 status.renameLimit
5687 The number of files to consider when performing rename detection in
5688 git-status(1) and git-commit(1). Defaults to the value of
5689 diff.renameLimit.
5690 status.renames
5692 Whether and how Git detects renames in git-status(1) and git-
5693 commit(1) . If set to "false", rename detection is disabled. If set
5694 to "true", basic rename detection is enabled. If set to "copies" or
5695 "copy", Git will detect copies, as well. Defaults to the value of
5696 diff.renames.
5697 status.showStash
5699 If set to true, git-status(1) will display the number of entries
5700 currently stashed away. Defaults to false.
5701 status.showUntrackedFiles
5703 By default, git-status(1) and git-commit(1) show files which are
5704 not currently tracked by Git. Directories which contain only
5705 untracked files, are shown with the directory name only. Showing
5706 untracked files means that Git needs to lstat() all the files in
5707 the whole repository, which might be slow on some systems. So, this
5708 variable controls how the commands displays the untracked files.
5709 Possible values are:
5710 • no - Show no untracked files.
5712 • normal - Show untracked files and directories.
5714 • all - Show also individual files in untracked directories.
5716 If this variable is not specified, it defaults to normal. This
5718 variable can be overridden with the -u|--untracked-files option of
5719 git-status(1) and git-commit(1).
5720 status.submoduleSummary
5722 Defaults to false. If this is set to a non zero number or true
5723 (identical to -1 or an unlimited number), the submodule summary
5724 will be enabled and a summary of commits for modified submodules
5725 will be shown (see --summary-limit option of git-submodule(1)).
5726 Please note that the summary output command will be suppressed for
5727 all submodules when diff.ignoreSubmodules is set to all or only for
5728 those submodules where submodule.<name>.ignore=all. The only
5729 exception to that rule is that status and commit will show staged
5730 submodule changes. To also view the summary for ignored submodules
5731 you can either use the --ignore-submodules=dirty command-line
5732 option or the git submodule summary command, which shows a similar
5733 output but does not honor these settings.
5734 stash.showIncludeUntracked
5736 If this is set to true, the git stash show command will show the
5737 untracked files of a stash entry. Defaults to false. See
5738 description of show command in git-stash(1).
5739 stash.showPatch
5741 If this is set to true, the git stash show command without an
5742 option will show the stash entry in patch form. Defaults to false.
5743 See description of show command in git-stash(1).
5744 stash.showStat
5746 If this is set to true, the git stash show command without an
5747 option will show diffstat of the stash entry. Defaults to true. See
5748 description of show command in git-stash(1).
5749 submodule.<name>.url
5751 The URL for a submodule. This variable is copied from the
5752 .gitmodules file to the git config via git submodule init. The user
5753 can change the configured URL before obtaining the submodule via
5754 git submodule update. If neither submodule.<name>.active or
5755 submodule.active are set, the presence of this variable is used as
5756 a fallback to indicate whether the submodule is of interest to git
5757 commands. See git-submodule(1) and gitmodules(5) for details.
5758 submodule.<name>.update
5760 The method by which a submodule is updated by git submodule update,
5761 which is the only affected command, others such as git checkout
5762 --recurse-submodules are unaffected. It exists for historical
5763 reasons, when git submodule was the only command to interact with
5764 submodules; settings like submodule.active and pull.rebase are more
5765 specific. It is populated by git submodule init from the
5766 gitmodules(5) file. See description of update command in git-
5767 submodule(1).
5768 submodule.<name>.branch
5770 The remote branch name for a submodule, used by git submodule
5771 update --remote. Set this option to override the value found in the
5772 .gitmodules file. See git-submodule(1) and gitmodules(5) for
5773 details.
5774 submodule.<name>.fetchRecurseSubmodules
5776 This option can be used to control recursive fetching of this
5777 submodule. It can be overridden by using the
5778 --[no-]recurse-submodules command-line option to "git fetch" and
5779 "git pull". This setting will override that from in the
5780 gitmodules(5) file.
5781 submodule.<name>.ignore
5783 Defines under what circumstances "git status" and the diff family
5784 show a submodule as modified. When set to "all", it will never be
5785 considered modified (but it will nonetheless show up in the output
5786 of status and commit when it has been staged), "dirty" will ignore
5787 all changes to the submodules work tree and takes only differences
5788 between the HEAD of the submodule and the commit recorded in the
5789 superproject into account. "untracked" will additionally let
5790 submodules with modified tracked files in their work tree show up.
5791 Using "none" (the default when this option is not set) also shows
5792 submodules that have untracked files in their work tree as changed.
5793 This setting overrides any setting made in .gitmodules for this
5794 submodule, both settings can be overridden on the command line by
5795 using the "--ignore-submodules" option. The git submodule commands
5796 are not affected by this setting.
5797 submodule.<name>.active
5799 Boolean value indicating if the submodule is of interest to git
5800 commands. This config option takes precedence over the
5801 submodule.active config option. See gitsubmodules(7) for details.
5802 submodule.active
5804 A repeated field which contains a pathspec used to match against a
5805 submodule’s path to determine if the submodule is of interest to
5806 git commands. See gitsubmodules(7) for details.
5807 submodule.recurse
5809 A boolean indicating if commands should enable the
5810 --recurse-submodules option by default. Defaults to false.
5811 When set to true, it can be deactivated via the
5813 --no-recurse-submodules option. Note that some Git commands lacking
5814 this option may call some of the above commands affected by
5815 submodule.recurse; for instance git remote update will call git
5816 fetch but does not have a --no-recurse-submodules option. For these
5817 commands a workaround is to temporarily change the configuration
5818 value by using git -c submodule.recurse=0.
5819 The following list shows the commands that accept
5821 --recurse-submodules and whether they are supported by this
5822 setting.
5823 • checkout, fetch, grep, pull, push, read-tree, reset, restore
5825 and switch are always supported.
5826 • clone and ls-files are not supported.
5828 • branch is supported only if submodule.propagateBranches is
5830 enabled
5831 submodule.propagateBranches
5833 [EXPERIMENTAL] A boolean that enables branching support when using
5834 --recurse-submodules or submodule.recurse=true. Enabling this will
5835 allow certain commands to accept --recurse-submodules and certain
5836 commands that already accept --recurse-submodules will now consider
5837 branches. Defaults to false.
5838 submodule.fetchJobs
5840 Specifies how many submodules are fetched/cloned at the same time.
5841 A positive integer allows up to that number of submodules fetched
5842 in parallel. A value of 0 will give some reasonable default. If
5843 unset, it defaults to 1.
5844 submodule.alternateLocation
5846 Specifies how the submodules obtain alternates when submodules are
5847 cloned. Possible values are no, superproject. By default no is
5848 assumed, which doesn’t add references. When the value is set to
5849 superproject the submodule to be cloned computes its alternates
5850 location relative to the superprojects alternate.
5851 submodule.alternateErrorStrategy
5853 Specifies how to treat errors with the alternates for a submodule
5854 as computed via submodule.alternateLocation. Possible values are
5855 ignore, info, die. Default is die. Note that if set to ignore or
5856 info, and if there is an error with the computed alternate, the
5857 clone proceeds as if no alternate was specified.
5858 tag.forceSignAnnotated
5860 A boolean to specify whether annotated tags created should be GPG
5861 signed. If --annotate is specified on the command line, it takes
5862 precedence over this option.
5863 tag.sort
5865 This variable controls the sort ordering of tags when displayed by
5866 git-tag(1). Without the "--sort=<value>" option provided, the value
5867 of this variable will be used as the default.
5868 tag.gpgSign
5870 A boolean to specify whether all tags should be GPG signed. Use of
5871 this option when running in an automated script can result in a
5872 large number of tags being signed. It is therefore convenient to
5873 use an agent to avoid typing your gpg passphrase several times.
5874 Note that this option doesn’t affect tag signing behavior enabled
5875 by "-u <keyid>" or "--local-user=<keyid>" options.
5876 tar.umask
5878 This variable can be used to restrict the permission bits of tar
5879 archive entries. The default is 0002, which turns off the world
5880 write bit. The special value "user" indicates that the archiving
5881 user’s umask will be used instead. See umask(2) and git-archive(1).
5882 Trace2 config settings are only read from the system and global config
5884 files; repository local and worktree config files and -c command line
5885 arguments are not respected.
5886 trace2.normalTarget
5888 This variable controls the normal target destination. It may be
5889 overridden by the GIT_TRACE2 environment variable. The following
5890 table shows possible values.
5891 trace2.perfTarget
5893 This variable controls the performance target destination. It may
5894 be overridden by the GIT_TRACE2_PERF environment variable. The
5895 following table shows possible values.
5896 trace2.eventTarget
5898 This variable controls the event target destination. It may be
5899 overridden by the GIT_TRACE2_EVENT environment variable. The
5900 following table shows possible values.
5901 • 0 or false - Disables the target.
5903 • 1 or true - Writes to STDERR.
5905 • [2-9] - Writes to the already opened file descriptor.
5907 • <absolute-pathname> - Writes to the file in append mode. If the
5909 target already exists and is a directory, the traces will be
5910 written to files (one per process) underneath the given
5911 directory.
5912 • af_unix:[<socket_type>:]<absolute-pathname> - Write to a Unix
5914 DomainSocket (on platforms that support them). Socket type can
5915 be either stream or dgram; if omitted Git will try both.
5916 trace2.normalBrief
5918 Boolean. When true time, filename, and line fields are omitted from
5919 normal output. May be overridden by the GIT_TRACE2_BRIEF
5920 environment variable. Defaults to false.
5921 trace2.perfBrief
5923 Boolean. When true time, filename, and line fields are omitted from
5924 PERF output. May be overridden by the GIT_TRACE2_PERF_BRIEF
5925 environment variable. Defaults to false.
5926 trace2.eventBrief
5928 Boolean. When true time, filename, and line fields are omitted from
5929 event output. May be overridden by the GIT_TRACE2_EVENT_BRIEF
5930 environment variable. Defaults to false.
5931 trace2.eventNesting
5933 Integer. Specifies desired depth of nested regions in the event
5934 output. Regions deeper than this value will be omitted. May be
5935 overridden by the GIT_TRACE2_EVENT_NESTING environment variable.
5936 Defaults to 2.
5937 trace2.configParams
5939 A comma-separated list of patterns of "important" config settings
5940 that should be recorded in the trace2 output. For example,
5941 core.*,remote.*.url would cause the trace2 output to contain events
5942 listing each configured remote. May be overridden by the
5943 GIT_TRACE2_CONFIG_PARAMS environment variable. Unset by default.
5944 trace2.envVars
5946 A comma-separated list of "important" environment variables that
5947 should be recorded in the trace2 output. For example,
5948 GIT_HTTP_USER_AGENT,GIT_CONFIG would cause the trace2 output to
5949 contain events listing the overrides for HTTP user agent and the
5950 location of the Git configuration file (assuming any are set). May
5951 be overridden by the GIT_TRACE2_ENV_VARS environment variable.
5952 Unset by default.
5953 trace2.destinationDebug
5955 Boolean. When true Git will print error messages when a trace
5956 target destination cannot be opened for writing. By default, these
5957 errors are suppressed and tracing is silently disabled. May be
5958 overridden by the GIT_TRACE2_DST_DEBUG environment variable.
5959 trace2.maxFiles
5961 Integer. When writing trace files to a target directory, do not
5962 write additional traces if we would exceed this many files.
5963 Instead, write a sentinel file that will block further tracing to
5964 this directory. Defaults to 0, which disables this check.
5965 transfer.credentialsInUrl
5967 A configured URL can contain plaintext credentials in the form
5968 <protocol>://<user>:<password>@<domain>/<path>. You may want to
5969 warn or forbid the use of such configuration (in favor of using
5970 git-credential(1)). This will be used on git-clone(1), git-
5971 fetch(1), git-push(1), and any other direct use of the configured
5972 URL.
5973 Note that this is currently limited to detecting credentials in
5975 remote.<name>.url configuration, it won’t detect credentials in
5976 remote.<name>.pushurl configuration.
5977 You might want to enable this to prevent inadvertent credentials
5979 exposure, e.g. because:
5980 • The OS or system where you’re running git may not provide a way
5982 or otherwise allow you to configure the permissions of the
5983 configuration file where the username and/or password are
5984 stored.
5985 • Even if it does, having such data stored "at rest" might expose
5987 you in other ways, e.g. a backup process might copy the data to
5988 another system.
5989 • The git programs will pass the full URL to one another as
5991 arguments on the command-line, meaning the credentials will be
5992 exposed to other users on OS’s or systems that allow other
5993 users to see the full process list of other users. On linux the
5994 "hidepid" setting documented in procfs(5) allows for
5995 configuring this behavior.
5996 If such concerns don’t apply to you then you probably don’t
5998 need to be concerned about credentials exposure due to storing
5999 that sensitive data in git’s configuration files. If you do
6000 want to use this, set transfer.credentialsInUrl to one of these
6001 values:
6002 • allow (default): Git will proceed with its activity without
6004 warning.
6005 • warn: Git will write a warning message to stderr when parsing a
6007 URL with a plaintext credential.
6008 • die: Git will write a failure message to stderr when parsing a
6010 URL with a plaintext credential.
6011 transfer.fsckObjects
6013 When fetch.fsckObjects or receive.fsckObjects are not set, the
6014 value of this variable is used instead. Defaults to false.
6015 When set, the fetch or receive will abort in the case of a
6017 malformed object or a link to a nonexistent object. In addition,
6018 various other issues are checked for, including legacy issues (see
6019 fsck.<msg-id>), and potential security issues like the existence of
6020 a .GIT directory or a malicious .gitmodules file (see the release
6021 notes for v2.2.1 and v2.17.1 for details). Other sanity and
6022 security checks may be added in future releases.
6023 On the receiving side, failing fsckObjects will make those objects
6025 unreachable, see "QUARANTINE ENVIRONMENT" in git-receive-pack(1).
6026 On the fetch side, malformed objects will instead be left
6027 unreferenced in the repository.
6028 Due to the non-quarantine nature of the fetch.fsckObjects
6030 implementation it cannot be relied upon to leave the object store
6031 clean like receive.fsckObjects can.
6032 As objects are unpacked they’re written to the object store, so
6034 there can be cases where malicious objects get introduced even
6035 though the "fetch" failed, only to have a subsequent "fetch"
6036 succeed because only new incoming objects are checked, not those
6037 that have already been written to the object store. That difference
6038 in behavior should not be relied upon. In the future, such objects
6039 may be quarantined for "fetch" as well.
6040 For now, the paranoid need to find some way to emulate the
6042 quarantine environment if they’d like the same protection as
6043 "push". E.g. in the case of an internal mirror do the mirroring in
6044 two steps, one to fetch the untrusted objects, and then do a second
6045 "push" (which will use the quarantine) to another internal repo,
6046 and have internal clients consume this pushed-to repository, or
6047 embargo internal fetches and only allow them once a full "fsck" has
6048 run (and no new fetches have happened in the meantime).
6049 transfer.hideRefs
6051 String(s) receive-pack and upload-pack use to decide which refs to
6052 omit from their initial advertisements. Use more than one
6053 definition to specify multiple prefix strings. A ref that is under
6054 the hierarchies listed in the value of this variable is excluded,
6055 and is hidden when responding to git push or git fetch. See
6056 receive.hideRefs and uploadpack.hideRefs for program-specific
6057 versions of this config.
6058 You may also include a ! in front of the ref name to negate the
6060 entry, explicitly exposing it, even if an earlier entry marked it
6061 as hidden. If you have multiple hideRefs values, later entries
6062 override earlier ones (and entries in more-specific config files
6063 override less-specific ones).
6064 If a namespace is in use, the namespace prefix is stripped from
6066 each reference before it is matched against transfer.hiderefs
6067 patterns. In order to match refs before stripping, add a ^ in front
6068 of the ref name. If you combine ! and ^, ! must be specified
6069 first.
6070 For example, if refs/heads/master is specified in transfer.hideRefs
6072 and the current namespace is foo, then
6073 refs/namespaces/foo/refs/heads/master is omitted from the
6074 advertisements. If uploadpack.allowRefInWant is set, upload-pack
6075 will treat want-ref refs/heads/master in a protocol v2 fetch
6076 command as if refs/namespaces/foo/refs/heads/master did not exist.
6077 receive-pack, on the other hand, will still advertise the object id
6078 the ref is pointing to without mentioning its name (a so-called
6079 ".have" line).
6080 Even if you hide refs, a client may still be able to steal the
6082 target objects via the techniques described in the "SECURITY"
6083 section of the gitnamespaces(7) man page; it’s best to keep private
6084 data in a separate repository.
6085 transfer.unpackLimit
6087 When fetch.unpackLimit or receive.unpackLimit are not set, the
6088 value of this variable is used instead. The default value is 100.
6089 transfer.advertiseSID
6091 Boolean. When true, client and server processes will advertise
6092 their unique session IDs to their remote counterpart. Defaults to
6093 false.
6094 uploadarchive.allowUnreachable
6096 If true, allow clients to use git archive --remote to request any
6097 tree, whether reachable from the ref tips or not. See the
6098 discussion in the "SECURITY" section of git-upload-archive(1) for
6099 more details. Defaults to false.
6100 uploadpack.hideRefs
6102 This variable is the same as transfer.hideRefs, but applies only to
6103 upload-pack (and so affects only fetches, not pushes). An attempt
6104 to fetch a hidden ref by git fetch will fail. See also
6105 uploadpack.allowTipSHA1InWant.
6106 uploadpack.allowTipSHA1InWant
6108 When uploadpack.hideRefs is in effect, allow upload-pack to accept
6109 a fetch request that asks for an object at the tip of a hidden ref
6110 (by default, such a request is rejected). See also
6111 uploadpack.hideRefs. Even if this is false, a client may be able to
6112 steal objects via the techniques described in the "SECURITY"
6113 section of the gitnamespaces(7) man page; it’s best to keep private
6114 data in a separate repository.
6115 uploadpack.allowReachableSHA1InWant
6117 Allow upload-pack to accept a fetch request that asks for an object
6118 that is reachable from any ref tip. However, note that calculating
6119 object reachability is computationally expensive. Defaults to
6120 false. Even if this is false, a client may be able to steal objects
6121 via the techniques described in the "SECURITY" section of the
6122 gitnamespaces(7) man page; it’s best to keep private data in a
6123 separate repository.
6124 uploadpack.allowAnySHA1InWant
6126 Allow upload-pack to accept a fetch request that asks for any
6127 object at all. Defaults to false.
6128 uploadpack.keepAlive
6130 When upload-pack has started pack-objects, there may be a quiet
6131 period while pack-objects prepares the pack. Normally it would
6132 output progress information, but if --quiet was used for the fetch,
6133 pack-objects will output nothing at all until the pack data begins.
6134 Some clients and networks may consider the server to be hung and
6135 give up. Setting this option instructs upload-pack to send an empty
6136 keepalive packet every uploadpack.keepAlive seconds. Setting this
6137 option to 0 disables keepalive packets entirely. The default is 5
6138 seconds.
6139 uploadpack.packObjectsHook
6141 If this option is set, when upload-pack would run git pack-objects
6142 to create a packfile for a client, it will run this shell command
6143 instead. The pack-objects command and arguments it would have run
6144 (including the git pack-objects at the beginning) are appended to
6145 the shell command. The stdin and stdout of the hook are treated as
6146 if pack-objects itself was run. I.e., upload-pack will feed input
6147 intended for pack-objects to the hook, and expects a completed
6148 packfile on stdout.
6149 Note that this configuration variable is only respected when it is
6151 specified in protected configuration (see the section called
6152 “SCOPES”). This is a safety measure against fetching from untrusted
6153 repositories.
6154 uploadpack.allowFilter
6156 If this option is set, upload-pack will support partial clone and
6157 partial fetch object filtering.
6158 uploadpackfilter.allow
6160 Provides a default value for unspecified object filters (see: the
6161 below configuration variable). If set to true, this will also
6162 enable all filters which get added in the future. Defaults to true.
6163 uploadpackfilter.<filter>.allow
6165 Explicitly allow or ban the object filter corresponding to
6166 <filter>, where <filter> may be one of: blob:none, blob:limit,
6167 object:type, tree, sparse:oid, or combine. If using combined
6168 filters, both combine and all of the nested filter kinds must be
6169 allowed. Defaults to uploadpackfilter.allow.
6170 uploadpackfilter.tree.maxDepth
6172 Only allow --filter=tree:<n> when <n> is no more than the value of
6173 uploadpackfilter.tree.maxDepth. If set, this also implies
6174 uploadpackfilter.tree.allow=true, unless this configuration
6175 variable had already been set. Has no effect if unset.
6176 uploadpack.allowRefInWant
6178 If this option is set, upload-pack will support the ref-in-want
6179 feature of the protocol version 2 fetch command. This feature is
6180 intended for the benefit of load-balanced servers which may not
6181 have the same view of what OIDs their refs point to due to
6182 replication delay.
6183 url.<base>.insteadOf
6185 Any URL that starts with this value will be rewritten to start,
6186 instead, with <base>. In cases where some site serves a large
6187 number of repositories, and serves them with multiple access
6188 methods, and some users need to use different access methods, this
6189 feature allows people to specify any of the equivalent URLs and
6190 have Git automatically rewrite the URL to the best alternative for
6191 the particular user, even for a never-before-seen repository on the
6192 site. When more than one insteadOf strings match a given URL, the
6193 longest match is used.
6194 Note that any protocol restrictions will be applied to the
6196 rewritten URL. If the rewrite changes the URL to use a custom
6197 protocol or remote helper, you may need to adjust the
6198 protocol.*.allow config to permit the request. In particular,
6199 protocols you expect to use for submodules must be set to always
6200 rather than the default of user. See the description of
6201 protocol.allow above.
6202 url.<base>.pushInsteadOf
6204 Any URL that starts with this value will not be pushed to; instead,
6205 it will be rewritten to start with <base>, and the resulting URL
6206 will be pushed to. In cases where some site serves a large number
6207 of repositories, and serves them with multiple access methods, some
6208 of which do not allow push, this feature allows people to specify a
6209 pull-only URL and have Git automatically use an appropriate URL to
6210 push, even for a never-before-seen repository on the site. When
6211 more than one pushInsteadOf strings match a given URL, the longest
6212 match is used. If a remote has an explicit pushurl, Git will ignore
6213 this setting for that remote.
6214 user.name, user.email, author.name, author.email, committer.name,
6216 committer.email
6217 The user.name and user.email variables determine what ends up in
6218 the author and committer field of commit objects. If you need the
6219 author or committer to be different, the author.name, author.email,
6220 committer.name or committer.email variables can be set. Also, all
6221 of these can be overridden by the GIT_AUTHOR_NAME,
6222 GIT_AUTHOR_EMAIL, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL and EMAIL
6223 environment variables.
6224 Note that the name forms of these variables conventionally refer to
6226 some form of a personal name. See git-commit(1) and the environment
6227 variables section of git(1) for more information on these settings
6228 and the credential.username option if you’re looking for
6229 authentication credentials instead.
6230 user.useConfigOnly
6232 Instruct Git to avoid trying to guess defaults for user.email and
6233 user.name, and instead retrieve the values only from the
6234 configuration. For example, if you have multiple email addresses
6235 and would like to use a different one for each repository, then
6236 with this configuration option set to true in the global config
6237 along with a name, Git will prompt you to set up an email before
6238 making new commits in a newly cloned repository. Defaults to false.
6239 user.signingKey
6241 If git-tag(1) or git-commit(1) is not selecting the key you want it
6242 to automatically when creating a signed tag or commit, you can
6243 override the default selection with this variable. This option is
6244 passed unchanged to gpg’s --local-user parameter, so you may
6245 specify a key using any method that gpg supports. If gpg.format is
6246 set to ssh this can contain the path to either your private ssh key
6247 or the public key when ssh-agent is used. Alternatively it can
6248 contain a public key prefixed with key:: directly (e.g.:
6249 "key::ssh-rsa XXXXXX identifier"). The private key needs to be
6250 available via ssh-agent. If not set git will call
6251 gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
6252 first key available. For backward compatibility, a raw key which
6253 begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
6254 as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
6255 use the key:: form instead.
6256 versionsort.prereleaseSuffix (deprecated)
6258 Deprecated alias for versionsort.suffix. Ignored if
6259 versionsort.suffix is set.
6260 versionsort.suffix
6262 Even when version sort is used in git-tag(1), tagnames with the
6263 same base version but different suffixes are still sorted
6264 lexicographically, resulting e.g. in prerelease tags appearing
6265 after the main release (e.g. "1.0-rc1" after "1.0"). This variable
6266 can be specified to determine the sorting order of tags with
6267 different suffixes.
6268 By specifying a single suffix in this variable, any tagname
6270 containing that suffix will appear before the corresponding main
6271 release. E.g. if the variable is set to "-rc", then all "1.0-rcX"
6272 tags will appear before "1.0". If specified multiple times, once
6273 per suffix, then the order of suffixes in the configuration will
6274 determine the sorting order of tagnames with those suffixes. E.g.
6275 if "-pre" appears before "-rc" in the configuration, then all
6276 "1.0-preX" tags will be listed before any "1.0-rcX" tags. The
6277 placement of the main release tag relative to tags with various
6278 suffixes can be determined by specifying the empty suffix among
6279 those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
6280 "-bfs" appear in the configuration in this order, then all
6281 "v4.8-rcX" tags are listed first, followed by "v4.8", then
6282 "v4.8-ckX" and finally "v4.8-bfsX".
6283 If more than one suffixes match the same tagname, then that tagname
6285 will be sorted according to the suffix which starts at the earliest
6286 position in the tagname. If more than one different matching
6287 suffixes start at that earliest position, then that tagname will be
6288 sorted according to the longest of those suffixes. The sorting
6289 order between different suffixes is undefined if they are in
6290 multiple config files.
6291 web.browser
6293 Specify a web browser that may be used by some commands. Currently
6294 only git-instaweb(1) and git-help(1) may use it.
6295 worktree.guessRemote
6297 If no branch is specified and neither -b nor -B nor --detach is
6298 used, then git worktree add defaults to creating a new branch from
6299 HEAD. If worktree.guessRemote is set to true, worktree add tries to
6300 find a remote-tracking branch whose name uniquely matches the new
6301 branch name. If such a branch exists, it is checked out and set as
6302 "upstream" for the new branch. If no such match can be found, it
6303 falls back to creating a new branch from the current HEAD.
6304
6306 When using the deprecated [section.subsection] syntax, changing a value
6307 will result in adding a multi-line key instead of a change, if the
6308 subsection is given with at least one uppercase character. For example
6309 when the config looks like
6310 [section.subsection]
6312 key = value1
6313 and running git config section.Subsection.key value2 will result in
6315 [section.subsection]
6317 key = value1
6318 key = value2
6319
6321 Part of the git(1) suite
6322
6324 1. the bundle URI design document
6325 file:///usr/share/doc/git/technical/bundle-uri.html
6326Git 2.39.1 2023-01-13 GIT-CONFIG(1)