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 expanding a leading ~ to the value of
201 $HOME and ~user to the home directory for the specified user.
202 This specifier has no effect when setting the value (but you
203 can use git config section.variable ~/ from the command line to
204 let 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 porcelain commands. The variables are divided into sections, wherein
526 the fully 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 conditionally include a config file from another by setting an
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 compatibility
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 a fetch refspec for multiple remotes maps to
871 the 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 branches.
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 detached 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 be 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 diverging
1027 Advice shown when a fast-forward is not possible.
1028 worktreeAddOrphan
1030 Advice shown when a user tries to create a worktree from an
1031 invalid reference, to instruct how to create a new orphan
1032 branch instead.
1033 attr.tree
1035 A reference to a tree in the repository from which to read
1036 attributes, instead of the .gitattributes file in the working tree.
1037 In a bare repository, this defaults to HEAD:.gitattributes. If the
1038 value does not resolve to a valid tree object, an empty tree is
1039 used instead. When the GIT_ATTR_SOURCE environment variable or
1040 --attr-source command line option are used, this configuration
1041 variable has no effect.
1042 core.fileMode
1044 Tells Git if the executable bit of files in the working tree is to
1045 be honored.
1046 Some filesystems lose the executable bit when a file that is marked
1048 as executable is checked out, or checks out a non-executable file
1049 with executable bit on. git-clone(1) or git-init(1) probe the
1050 filesystem to see if it handles the executable bit correctly and
1051 this variable is automatically set as necessary.
1052 A repository, however, may be on a filesystem that handles the
1054 filemode correctly, and this variable is set to true when created,
1055 but later may be made accessible from another environment that
1056 loses the filemode (e.g. exporting ext4 via CIFS mount, visiting a
1057 Cygwin created repository with Git for Windows or Eclipse). In such
1058 a case it may be necessary to set this variable to false. See git-
1059 update-index(1).
1060 The default is true (when core.filemode is not specified in the
1062 config file).
1063 core.hideDotFiles
1065 (Windows-only) If true, mark newly-created directories and files
1066 whose name starts with a dot as hidden. If dotGitOnly, only the
1067 .git/ directory is hidden, but no other files starting with a dot.
1068 The default mode is dotGitOnly.
1069 core.ignoreCase
1071 Internal variable which enables various workarounds to enable Git
1072 to work better on filesystems that are not case sensitive, like
1073 APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
1074 finds "makefile" when Git expects "Makefile", Git will assume it is
1075 really the same file, and continue to remember it as "Makefile".
1076 The default is false, except git-clone(1) or git-init(1) will probe
1078 and set core.ignoreCase true if appropriate when the repository is
1079 created.
1080 Git relies on the proper configuration of this variable for your
1082 operating and file system. Modifying this value may result in
1083 unexpected behavior.
1084 core.precomposeUnicode
1086 This option is only used by Mac OS implementation of Git. When
1087 core.precomposeUnicode=true, Git reverts the unicode decomposition
1088 of filenames done by Mac OS. This is useful when sharing a
1089 repository between Mac OS and Linux or Windows. (Git for Windows
1090 1.7.10 or higher is needed, or Git under cygwin 1.7). When false,
1091 file names are handled fully transparent by Git, which is backward
1092 compatible with older versions of Git.
1093 core.protectHFS
1095 If set to true, do not allow checkout of paths that would be
1096 considered equivalent to .git on an HFS+ filesystem. Defaults to
1097 true on Mac OS, and false elsewhere.
1098 core.protectNTFS
1100 If set to true, do not allow checkout of paths that would cause
1101 problems with the NTFS filesystem, e.g. conflict with 8.3 "short"
1102 names. Defaults to true on Windows, and false elsewhere.
1103 core.fsmonitor
1105 If set to true, enable the built-in file system monitor daemon for
1106 this working directory (git-fsmonitor--daemon(1)).
1107 Like hook-based file system monitors, the built-in file system
1109 monitor can speed up Git commands that need to refresh the Git
1110 index (e.g. git status) in a working directory with many files.
1111 The built-in monitor eliminates the need to install and maintain an
1112 external third-party tool.
1113 The built-in file system monitor is currently available only on a
1115 limited set of supported platforms. Currently, this includes
1116 Windows and MacOS.
1117 Otherwise, this variable contains the pathname of the "fsmonitor"
1119 hook command.
1120 This hook command is used to identify all files that may have
1122 changed since the requested date/time. This information is used to
1123 speed up git by avoiding unnecessary scanning of files that have
1124 not changed.
1125 See the "fsmonitor-watchman" section of githooks(5).
1127 Note that if you concurrently use multiple versions of Git, such as
1129 one version on the command line and another version in an IDE tool,
1130 that the definition of core.fsmonitor was extended to allow boolean
1131 values in addition to hook pathnames. Git versions 2.35.1 and prior
1132 will not understand the boolean values and will consider the "true"
1133 or "false" values as hook pathnames to be invoked. Git versions
1134 2.26 thru 2.35.1 default to hook protocol V2 and will fall back to
1135 no fsmonitor (full scan). Git versions prior to 2.26 default to
1136 hook protocol V1 and will silently assume there were no changes to
1137 report (no scan), so status commands may report incomplete results.
1138 For this reason, it is best to upgrade all of your Git versions
1139 before using the built-in file system monitor.
1140 core.fsmonitorHookVersion
1142 Sets the protocol version to be used when invoking the "fsmonitor"
1143 hook.
1144 There are currently versions 1 and 2. When this is not set, version
1146 2 will be tried first and if it fails then version 1 will be tried.
1147 Version 1 uses a timestamp as input to determine which files have
1148 changes since that time but some monitors like Watchman have race
1149 conditions when used with a timestamp. Version 2 uses an opaque
1150 string so that the monitor can return something that can be used to
1151 determine what files have changed without race conditions.
1152 core.trustctime
1154 If false, the ctime differences between the index and the working
1155 tree are ignored; useful when the inode change time is regularly
1156 modified by something outside Git (file system crawlers and some
1157 backup systems). See git-update-index(1). True by default.
1158 core.splitIndex
1160 If true, the split-index feature of the index will be used. See
1161 git-update-index(1). False by default.
1162 core.untrackedCache
1164 Determines what to do about the untracked cache feature of the
1165 index. It will be kept, if this variable is unset or set to keep.
1166 It will automatically be added if set to true. And it will
1167 automatically be removed, if set to false. Before setting it to
1168 true, you should check that mtime is working properly on your
1169 system. See git-update-index(1). keep by default, unless
1170 feature.manyFiles is enabled which sets this setting to true by
1171 default.
1172 core.checkStat
1174 When missing or is set to default, many fields in the stat
1175 structure are checked to detect if a file has been modified since
1176 Git looked at it. When this configuration variable is set to
1177 minimal, sub-second part of mtime and ctime, the uid and gid of the
1178 owner of the file, the inode number (and the device number, if Git
1179 was compiled to use it), are excluded from the check among these
1180 fields, leaving only the whole-second part of mtime (and ctime, if
1181 core.trustCtime is set) and the filesize to be checked.
1182 There are implementations of Git that do not leave usable values in
1184 some fields (e.g. JGit); by excluding these fields from the
1185 comparison, the minimal mode may help interoperability when the
1186 same repository is used by these other systems at the same time.
1187 core.quotePath
1189 Commands that output paths (e.g. ls-files, diff), will quote
1190 "unusual" characters in the pathname by enclosing the pathname in
1191 double-quotes and escaping those characters with backslashes in the
1192 same way C escapes control characters (e.g. \t for TAB, \n for LF,
1193 \\ for backslash) or bytes with values larger than 0x80 (e.g. octal
1194 \302\265 for "micro" in UTF-8). If this variable is set to false,
1195 bytes higher than 0x80 are not considered "unusual" any more.
1196 Double-quotes, backslash and control characters are always escaped
1197 regardless of the setting of this variable. A simple space
1198 character is not considered "unusual". Many commands can output
1199 pathnames completely verbatim using the -z option. The default
1200 value is true.
1201 core.eol
1203 Sets the line ending type to use in the working directory for files
1204 that are marked as text (either by having the text attribute set,
1205 or by having text=auto and Git auto-detecting the contents as
1206 text). Alternatives are lf, crlf and native, which uses the
1207 platform’s native line ending. The default value is native. See
1208 gitattributes(5) for more information on end-of-line conversion.
1209 Note that this value is ignored if core.autocrlf is set to true or
1210 input.
1211 core.safecrlf
1213 If true, makes Git check if converting CRLF is reversible when
1214 end-of-line conversion is active. Git will verify if a command
1215 modifies a file in the work tree either directly or indirectly. For
1216 example, committing a file followed by checking out the same file
1217 should yield the original file in the work tree. If this is not the
1218 case for the current setting of core.autocrlf, Git will reject the
1219 file. The variable can be set to "warn", in which case Git will
1220 only warn about an irreversible conversion but continue the
1221 operation.
1222 CRLF conversion bears a slight chance of corrupting data. When it
1224 is enabled, Git will convert CRLF to LF during commit and LF to
1225 CRLF during checkout. A file that contains a mixture of LF and CRLF
1226 before the commit cannot be recreated by Git. For text files this
1227 is the right thing to do: it corrects line endings such that we
1228 have only LF line endings in the repository. But for binary files
1229 that are accidentally classified as text the conversion can corrupt
1230 data.
1231 If you recognize such corruption early you can easily fix it by
1233 setting the conversion type explicitly in .gitattributes. Right
1234 after committing you still have the original file in your work tree
1235 and this file is not yet corrupted. You can explicitly tell Git
1236 that this file is binary and Git will handle the file
1237 appropriately.
1238 Unfortunately, the desired effect of cleaning up text files with
1240 mixed line endings and the undesired effect of corrupting binary
1241 files cannot be distinguished. In both cases CRLFs are removed in
1242 an irreversible way. For text files this is the right thing to do
1243 because CRLFs are line endings, while for binary files converting
1244 CRLFs corrupts data.
1245 Note, this safety check does not mean that a checkout will generate
1247 a file identical to the original file for a different setting of
1248 core.eol and core.autocrlf, but only for the current one. For
1249 example, a text file with LF would be accepted with core.eol=lf and
1250 could later be checked out with core.eol=crlf, in which case the
1251 resulting file would contain CRLF, although the original file
1252 contained LF. However, in both work trees the line endings would be
1253 consistent, that is either all LF or all CRLF, but never mixed. A
1254 file with mixed line endings would be reported by the core.safecrlf
1255 mechanism.
1256 core.autocrlf
1258 Setting this variable to "true" is the same as setting the text
1259 attribute to "auto" on all files and core.eol to "crlf". Set to
1260 true if you want to have CRLF line endings in your working
1261 directory and the repository has LF line endings. This variable can
1262 be set to input, in which case no output conversion is performed.
1263 core.checkRoundtripEncoding
1265 A comma and/or whitespace separated list of encodings that Git
1266 performs UTF-8 round trip checks on if they are used in an
1267 working-tree-encoding attribute (see gitattributes(5)). The default
1268 value is SHIFT-JIS.
1269 core.symlinks
1271 If false, symbolic links are checked out as small plain files that
1272 contain the link text. git-update-index(1) and git-add(1) will not
1273 change the recorded type to regular file. Useful on filesystems
1274 like FAT that do not support symbolic links.
1275 The default is true, except git-clone(1) or git-init(1) will probe
1277 and set core.symlinks false if appropriate when the repository is
1278 created.
1279 core.gitProxy
1281 A "proxy command" to execute (as command host port) instead of
1282 establishing direct connection to the remote server when using the
1283 Git protocol for fetching. If the variable value is in the "COMMAND
1284 for DOMAIN" format, the command is applied only on hostnames ending
1285 with the specified domain string. This variable may be set multiple
1286 times and is matched in the given order; the first match wins.
1287 Can be overridden by the GIT_PROXY_COMMAND environment variable
1289 (which always applies universally, without the special "for"
1290 handling).
1291 The special string none can be used as the proxy command to specify
1293 that no proxy be used for a given domain pattern. This is useful
1294 for excluding servers inside a firewall from proxy use, while
1295 defaulting to a common proxy for external domains.
1296 core.sshCommand
1298 If this variable is set, git fetch and git push will use the
1299 specified command instead of ssh when they need to connect to a
1300 remote system. The command is in the same form as the
1301 GIT_SSH_COMMAND environment variable and is overridden when the
1302 environment variable is set.
1303 core.ignoreStat
1305 If true, Git will avoid using lstat() calls to detect if files have
1306 changed by setting the "assume-unchanged" bit for those tracked
1307 files which it has updated identically in both the index and
1308 working tree.
1309 When files are modified outside of Git, the user will need to stage
1311 the modified files explicitly (e.g. see Examples section in git-
1312 update-index(1)). Git will not normally detect changes to those
1313 files.
1314 This is useful on systems where lstat() calls are very slow, such
1316 as CIFS/Microsoft Windows.
1317 False by default.
1319 core.preferSymlinkRefs
1321 Instead of the default "symref" format for HEAD and other symbolic
1322 reference files, use symbolic links. This is sometimes needed to
1323 work with old scripts that expect HEAD to be a symbolic link.
1324 core.alternateRefsCommand
1326 When advertising tips of available history from an alternate, use
1327 the shell to execute the specified command instead of git-for-each-
1328 ref(1). The first argument is the absolute path of the alternate.
1329 Output must contain one hex object id per line (i.e., the same as
1330 produced by git for-each-ref --format='%(objectname)').
1331 Note that you cannot generally put git for-each-ref directly into
1333 the config value, as it does not take a repository path as an
1334 argument (but you can wrap the command above in a shell script).
1335 core.alternateRefsPrefixes
1337 When listing references from an alternate, list only references
1338 that begin with the given prefix. Prefixes match as if they were
1339 given as arguments to git-for-each-ref(1). To list multiple
1340 prefixes, separate them with whitespace. If
1341 core.alternateRefsCommand is set, setting
1342 core.alternateRefsPrefixes has no effect.
1343 core.bare
1345 If true this repository is assumed to be bare and has no working
1346 directory associated with it. If this is the case a number of
1347 commands that require a working directory will be disabled, such as
1348 git-add(1) or git-merge(1).
1349 This setting is automatically guessed by git-clone(1) or git-
1351 init(1) when the repository was created. By default a repository
1352 that ends in "/.git" is assumed to be not bare (bare = false),
1353 while all other repositories are assumed to be bare (bare = true).
1354 core.worktree
1356 Set the path to the root of the working tree. If GIT_COMMON_DIR
1357 environment variable is set, core.worktree is ignored and not used
1358 for determining the root of working tree. This can be overridden by
1359 the GIT_WORK_TREE environment variable and the --work-tree
1360 command-line option. The value can be an absolute path or relative
1361 to the path to the .git directory, which is either specified by
1362 --git-dir or GIT_DIR, or automatically discovered. If --git-dir or
1363 GIT_DIR is specified but none of --work-tree, GIT_WORK_TREE and
1364 core.worktree is specified, the current working directory is
1365 regarded as the top level of your working tree.
1366 Note that this variable is honored even when set in a configuration
1368 file in a ".git" subdirectory of a directory and its value differs
1369 from the latter directory (e.g. "/path/to/.git/config" has
1370 core.worktree set to "/different/path"), which is most likely a
1371 misconfiguration. Running Git commands in the "/path/to" directory
1372 will still use "/different/path" as the root of the work tree and
1373 can cause confusion unless you know what you are doing (e.g. you
1374 are creating a read-only snapshot of the same index to a location
1375 different from the repository’s usual working tree).
1376 core.logAllRefUpdates
1378 Enable the reflog. Updates to a ref <ref> is logged to the file
1379 "$GIT_DIR/logs/<ref>", by appending the new and old SHA-1, the
1380 date/time and the reason of the update, but only when the file
1381 exists. If this configuration variable is set to true, missing
1382 "$GIT_DIR/logs/<ref>" file is automatically created for branch
1383 heads (i.e. under refs/heads/), remote refs (i.e. under
1384 refs/remotes/), note refs (i.e. under refs/notes/), and the
1385 symbolic ref HEAD. If it is set to always, then a missing reflog is
1386 automatically created for any ref under refs/.
1387 This information can be used to determine what commit was the tip
1389 of a branch "2 days ago".
1390 This value is true by default in a repository that has a working
1392 directory associated with it, and false by default in a bare
1393 repository.
1394 core.repositoryFormatVersion
1396 Internal variable identifying the repository format and layout
1397 version.
1398 core.sharedRepository
1400 When group (or true), the repository is made shareable between
1401 several users in a group (making sure all the files and objects are
1402 group-writable). When all (or world or everybody), the repository
1403 will be readable by all users, additionally to being
1404 group-shareable. When umask (or false), Git will use permissions
1405 reported by umask(2). When 0xxx, where 0xxx is an octal number,
1406 files in the repository will have this mode value. 0xxx will
1407 override user’s umask value (whereas the other options will only
1408 override requested parts of the user’s umask value). Examples: 0660
1409 will make the repo read/write-able for the owner and group, but
1410 inaccessible to others (equivalent to group unless umask is e.g.
1411 0022). 0640 is a repository that is group-readable but not
1412 group-writable. See git-init(1). False by default.
1413 core.warnAmbiguousRefs
1415 If true, Git will warn you if the ref name you passed it is
1416 ambiguous and might match multiple refs in the repository. True by
1417 default.
1418 core.compression
1420 An integer -1..9, indicating a default compression level. -1 is the
1421 zlib default. 0 means no compression, and 1..9 are various
1422 speed/size tradeoffs, 9 being slowest. If set, this provides a
1423 default to other compression variables, such as
1424 core.looseCompression and pack.compression.
1425 core.looseCompression
1427 An integer -1..9, indicating the compression level for objects that
1428 are not in a pack file. -1 is the zlib default. 0 means no
1429 compression, and 1..9 are various speed/size tradeoffs, 9 being
1430 slowest. If not set, defaults to core.compression. If that is not
1431 set, defaults to 1 (best speed).
1432 core.packedGitWindowSize
1434 Number of bytes of a pack file to map into memory in a single
1435 mapping operation. Larger window sizes may allow your system to
1436 process a smaller number of large pack files more quickly. Smaller
1437 window sizes will negatively affect performance due to increased
1438 calls to the operating system’s memory manager, but may improve
1439 performance when accessing a large number of large pack files.
1440 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
1442 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
1443 be reasonable for all users/operating systems. You probably do not
1444 need to adjust this value.
1445 Common unit suffixes of k, m, or g are supported.
1447 core.packedGitLimit
1449 Maximum number of bytes to map simultaneously into memory from pack
1450 files. If Git needs to access more than this many bytes at once to
1451 complete an operation it will unmap existing regions to reclaim
1452 virtual address space within the process.
1453 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
1455 unlimited) on 64 bit platforms. This should be reasonable for all
1456 users/operating systems, except on the largest projects. You
1457 probably do not need to adjust this value.
1458 Common unit suffixes of k, m, or g are supported.
1460 core.deltaBaseCacheLimit
1462 Maximum number of bytes per thread to reserve for caching base
1463 objects that may be referenced by multiple deltified objects. By
1464 storing the entire decompressed base objects in a cache Git is able
1465 to avoid unpacking and decompressing frequently used base objects
1466 multiple times.
1467 Default is 96 MiB on all platforms. This should be reasonable for
1469 all users/operating systems, except on the largest projects. You
1470 probably do not need to adjust this value.
1471 Common unit suffixes of k, m, or g are supported.
1473 core.bigFileThreshold
1475 The size of files considered "big", which as discussed below
1476 changes the behavior of numerous git commands, as well as how such
1477 files are stored within the repository. The default is 512 MiB.
1478 Common unit suffixes of k, m, or g are supported.
1479 Files above the configured limit will be:
1481 • Stored deflated in packfiles, without attempting delta
1483 compression.
1484 The default limit is primarily set with this use-case in mind.
1486 With it, most projects will have their source code and other
1487 text files delta compressed, but not larger binary media files.
1488 Storing large files without delta compression avoids excessive
1490 memory usage, at the slight expense of increased disk usage.
1491 • Will be treated as if they were labeled "binary" (see
1493 gitattributes(5)). e.g. git-log(1) and git-diff(1) will not
1494 compute diffs for files above this limit.
1495 • Will generally be streamed when written, which avoids excessive
1497 memory usage, at the cost of some fixed overhead. Commands that
1498 make use of this include git-archive(1), git-fast-import(1),
1499 git-index-pack(1), git-unpack-objects(1) and git-fsck(1).
1500 core.excludesFile
1502 Specifies the pathname to the file that contains patterns to
1503 describe paths that are not meant to be tracked, in addition to
1504 .gitignore (per-directory) and .git/info/exclude. Defaults to
1505 $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set
1506 or empty, $HOME/.config/git/ignore is used instead. See
1507 gitignore(5).
1508 core.askPass
1510 Some commands (e.g. svn and http interfaces) that interactively ask
1511 for a password can be told to use an external program given via the
1512 value of this variable. Can be overridden by the GIT_ASKPASS
1513 environment variable. If not set, fall back to the value of the
1514 SSH_ASKPASS environment variable or, failing that, a simple
1515 password prompt. The external program shall be given a suitable
1516 prompt as command-line argument and write the password on its
1517 STDOUT.
1518 core.attributesFile
1520 In addition to .gitattributes (per-directory) and
1521 .git/info/attributes, Git looks into this file for attributes (see
1522 gitattributes(5)). Path expansions are made the same way as for
1523 core.excludesFile. Its default value is
1524 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
1525 set or empty, $HOME/.config/git/attributes is used instead.
1526 core.hooksPath
1528 By default Git will look for your hooks in the $GIT_DIR/hooks
1529 directory. Set this to different path, e.g. /etc/git/hooks, and
1530 Git will try to find your hooks in that directory, e.g.
1531 /etc/git/hooks/pre-receive instead of in
1532 $GIT_DIR/hooks/pre-receive.
1533 The path can be either absolute or relative. A relative path is
1535 taken as relative to the directory where the hooks are run (see the
1536 "DESCRIPTION" section of githooks(5)).
1537 This configuration variable is useful in cases where you’d like to
1539 centrally configure your Git hooks instead of configuring them on a
1540 per-repository basis, or as a more flexible and centralized
1541 alternative to having an init.templateDir where you’ve changed
1542 default hooks.
1543 core.editor
1545 Commands such as commit and tag that let you edit messages by
1546 launching an editor use the value of this variable when it is set,
1547 and the environment variable GIT_EDITOR is not set. See git-var(1).
1548 core.commentChar
1550 Commands such as commit and tag that let you edit messages consider
1551 a line that begins with this character commented, and removes them
1552 after the editor returns (default #).
1553 If set to "auto", git-commit would select a character that is not
1555 the beginning character of any line in existing commit messages.
1556 core.filesRefLockTimeout
1558 The length of time, in milliseconds, to retry when trying to lock
1559 an individual reference. Value 0 means not to retry at all; -1
1560 means to try indefinitely. Default is 100 (i.e., retry for 100ms).
1561 core.packedRefsTimeout
1563 The length of time, in milliseconds, to retry when trying to lock
1564 the packed-refs file. Value 0 means not to retry at all; -1 means
1565 to try indefinitely. Default is 1000 (i.e., retry for 1 second).
1566 core.pager
1568 Text viewer for use by Git commands (e.g., less). The value is
1569 meant to be interpreted by the shell. The order of preference is
1570 the $GIT_PAGER environment variable, then core.pager configuration,
1571 then $PAGER, and then the default chosen at compile time (usually
1572 less).
1573 When the LESS environment variable is unset, Git sets it to FRX (if
1575 LESS environment variable is set, Git does not change it at all).
1576 If you want to selectively override Git’s default setting for LESS,
1577 you can set core.pager to e.g. less -S. This will be passed to the
1578 shell by Git, which will translate the final command to LESS=FRX
1579 less -S. The environment does not set the S option but the command
1580 line does, instructing less to truncate long lines. Similarly,
1581 setting core.pager to less -+F will deactivate the F option
1582 specified by the environment from the command-line, deactivating
1583 the "quit if one screen" behavior of less. One can specifically
1584 activate some flags for particular commands: for example, setting
1585 pager.blame to less -S enables line truncation only for git blame.
1586 Likewise, when the LV environment variable is unset, Git sets it to
1588 -c. You can override this setting by exporting LV with another
1589 value or setting core.pager to lv +c.
1590 core.whitespace
1592 A comma separated list of common whitespace problems to notice.
1593 git diff will use color.diff.whitespace to highlight them, and git
1594 apply --whitespace=error will consider them as errors. You can
1595 prefix - to disable any of them (e.g. -trailing-space):
1596 • blank-at-eol treats trailing whitespaces at the end of the line
1598 as an error (enabled by default).
1599 • space-before-tab treats a space character that appears
1601 immediately before a tab character in the initial indent part
1602 of the line as an error (enabled by default).
1603 • indent-with-non-tab treats a line that is indented with space
1605 characters instead of the equivalent tabs as an error (not
1606 enabled by default).
1607 • tab-in-indent treats a tab character in the initial indent part
1609 of the line as an error (not enabled by default).
1610 • blank-at-eof treats blank lines added at the end of file as an
1612 error (enabled by default).
1613 • trailing-space is a short-hand to cover both blank-at-eol and
1615 blank-at-eof.
1616 • cr-at-eol treats a carriage-return at the end of line as part
1618 of the line terminator, i.e. with it, trailing-space does not
1619 trigger if the character before such a carriage-return is not a
1620 whitespace (not enabled by default).
1621 • tabwidth=<n> tells how many character positions a tab occupies;
1623 this is relevant for indent-with-non-tab and when Git fixes
1624 tab-in-indent errors. The default tab width is 8. Allowed
1625 values are 1 to 63.
1626 core.fsync
1628 A comma-separated list of components of the repository that should
1629 be hardened via the core.fsyncMethod when created or modified. You
1630 can disable hardening of any component by prefixing it with a -.
1631 Items that are not hardened may be lost in the event of an unclean
1632 system shutdown. Unless you have special requirements, it is
1633 recommended that you leave this option empty or pick one of
1634 committed, added, or all.
1635 When this configuration is encountered, the set of components
1637 starts with the platform default value, disabled components are
1638 removed, and additional components are added. none resets the
1639 state so that the platform default is ignored.
1640 The empty string resets the fsync configuration to the platform
1642 default. The default on most platforms is equivalent to
1643 core.fsync=committed,-loose-object, which has good performance, but
1644 risks losing recent work in the event of an unclean system
1645 shutdown.
1646 • none clears the set of fsynced components.
1648 • loose-object hardens objects added to the repo in loose-object
1650 form.
1651 • pack hardens objects added to the repo in packfile form.
1653 • pack-metadata hardens packfile bitmaps and indexes.
1655 • commit-graph hardens the commit-graph file.
1657 • index hardens the index when it is modified.
1659 • objects is an aggregate option that is equivalent to
1661 loose-object,pack.
1662 • reference hardens references modified in the repo.
1664 • derived-metadata is an aggregate option that is equivalent to
1666 pack-metadata,commit-graph.
1667 • committed is an aggregate option that is currently equivalent
1669 to objects. This mode sacrifices some performance to ensure
1670 that work that is committed to the repository with git commit
1671 or similar commands is hardened.
1672 • added is an aggregate option that is currently equivalent to
1674 committed,index. This mode sacrifices additional performance to
1675 ensure that the results of commands like git add and similar
1676 operations are hardened.
1677 • all is an aggregate option that syncs all individual components
1679 above.
1680 core.fsyncMethod
1682 A value indicating the strategy Git will use to harden repository
1683 data using fsync and related primitives.
1684 • fsync uses the fsync() system call or platform equivalents.
1686 • writeout-only issues pagecache writeback requests, but
1688 depending on the filesystem and storage hardware, data added to
1689 the repository may not be durable in the event of a system
1690 crash. This is the default mode on macOS.
1691 • batch enables a mode that uses writeout-only flushes to stage
1693 multiple updates in the disk writeback cache and then does a
1694 single full fsync of a dummy file to trigger the disk cache
1695 flush at the end of the operation.
1696 Currently batch mode only applies to loose-object files. Other
1698 repository data is made durable as if fsync was specified. This
1699 mode is expected to be as safe as fsync on macOS for repos
1700 stored on HFS+ or APFS filesystems and on Windows for repos
1701 stored on NTFS or ReFS filesystems.
1702 core.fsyncObjectFiles
1704 This boolean will enable fsync() when writing object files. This
1705 setting is deprecated. Use core.fsync instead.
1706 This setting affects data added to the Git repository in
1708 loose-object form. When set to true, Git will issue an fsync or
1709 similar system call to flush caches so that loose-objects remain
1710 consistent in the face of a unclean system shutdown.
1711 core.preloadIndex
1713 Enable parallel index preload for operations like git diff
1714 This can speed up operations like git diff and git status
1716 especially on filesystems like NFS that have weak caching semantics
1717 and thus relatively high IO latencies. When enabled, Git will do
1718 the index comparison to the filesystem data in parallel, allowing
1719 overlapping IO’s. Defaults to true.
1720 core.unsetenvvars
1722 Windows-only: comma-separated list of environment variables' names
1723 that need to be unset before spawning any other process. Defaults
1724 to PERL5LIB to account for the fact that Git for Windows insists on
1725 using its own Perl interpreter.
1726 core.restrictinheritedhandles
1728 Windows-only: override whether spawned processes inherit only
1729 standard file handles (stdin, stdout and stderr) or all handles.
1730 Can be auto, true or false. Defaults to auto, which means true on
1731 Windows 7 and later, and false on older Windows versions.
1732 core.createObject
1734 You can set this to link, in which case a hardlink followed by a
1735 delete of the source are used to make sure that object creation
1736 will not overwrite existing objects.
1737 On some file system/operating system combinations, this is
1739 unreliable. Set this config setting to rename there; However, This
1740 will remove the check that makes sure that existing object files
1741 will not get overwritten.
1742 core.notesRef
1744 When showing commit messages, also show notes which are stored in
1745 the given ref. The ref must be fully qualified. If the given ref
1746 does not exist, it is not an error but means that no notes should
1747 be printed.
1748 This setting defaults to "refs/notes/commits", and it can be
1750 overridden by the GIT_NOTES_REF environment variable. See git-
1751 notes(1).
1752 core.commitGraph
1754 If true, then git will read the commit-graph file (if it exists) to
1755 parse the graph structure of commits. Defaults to true. See git-
1756 commit-graph(1) for more information.
1757 core.useReplaceRefs
1759 If set to false, behave as if the --no-replace-objects option was
1760 given on the command line. See git(1) and git-replace(1) for more
1761 information.
1762 core.multiPackIndex
1764 Use the multi-pack-index file to track multiple packfiles using a
1765 single index. See git-multi-pack-index(1) for more information.
1766 Defaults to true.
1767 core.sparseCheckout
1769 Enable "sparse checkout" feature. See git-sparse-checkout(1) for
1770 more information.
1771 core.sparseCheckoutCone
1773 Enables the "cone mode" of the sparse checkout feature. When the
1774 sparse-checkout file contains a limited set of patterns, this mode
1775 provides significant performance advantages. The "non-cone mode"
1776 can be requested to allow specifying more flexible patterns by
1777 setting this variable to false. See git-sparse-checkout(1) for more
1778 information.
1779 core.abbrev
1781 Set the length object names are abbreviated to. If unspecified or
1782 set to "auto", an appropriate value is computed based on the
1783 approximate number of packed objects in your repository, which
1784 hopefully is enough for abbreviated object names to stay unique for
1785 some time. If set to "no", no abbreviation is made and the object
1786 names are shown in their full length. The minimum length is 4.
1787 core.maxTreeDepth
1789 The maximum depth Git is willing to recurse while traversing a tree
1790 (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe to allow
1791 Git to abort cleanly, and should not generally need to be adjusted.
1792 The default is 4096.
1793 add.ignoreErrors, add.ignore-errors (deprecated)
1795 Tells git add to continue adding files when some files cannot be
1796 added due to indexing errors. Equivalent to the --ignore-errors
1797 option of git-add(1). add.ignore-errors is deprecated, as it does
1798 not follow the usual naming convention for configuration variables.
1799 add.interactive.useBuiltin
1801 Unused configuration variable. Used in Git versions v2.25.0 to
1802 v2.36.0 to enable the built-in version of git-add(1)'s interactive
1803 mode, which then became the default in Git versions v2.37.0 to
1804 v2.39.0.
1805 alias.*
1807 Command aliases for the git(1) command wrapper - e.g. after
1808 defining alias.last = cat-file commit HEAD, the invocation git last
1809 is equivalent to git cat-file commit HEAD. To avoid confusion and
1810 troubles with script usage, aliases that hide existing Git commands
1811 are ignored. Arguments are split by spaces, the usual shell quoting
1812 and escaping are supported. A quote pair or a backslash can be used
1813 to quote them.
1814 Note that the first word of an alias does not necessarily have to
1816 be a command. It can be a command-line option that will be passed
1817 into the invocation of git. In particular, this is useful when used
1818 with -c to pass in one-time configurations or -p to force
1819 pagination. For example, loud-rebase = -c commit.verbose=true
1820 rebase can be defined such that running git loud-rebase would be
1821 equivalent to git -c commit.verbose=true rebase. Also, ps = -p
1822 status would be a helpful alias since git ps would paginate the
1823 output of git status where the original command does not.
1824 If the alias expansion is prefixed with an exclamation point, it
1826 will be treated as a shell command. For example, defining alias.new
1827 = !gitk --all --not ORIG_HEAD, the invocation git new is equivalent
1828 to running the shell command gitk --all --not ORIG_HEAD. Note that
1829 shell commands will be executed from the top-level directory of a
1830 repository, which may not necessarily be the current directory.
1831 GIT_PREFIX is set as returned by running git rev-parse
1832 --show-prefix from the original current directory. See git-rev-
1833 parse(1).
1834 am.keepcr
1836 If true, git-am will call git-mailsplit for patches in mbox format
1837 with parameter --keep-cr. In this case git-mailsplit will not
1838 remove \r from lines ending with \r\n. Can be overridden by giving
1839 --no-keep-cr from the command line. See git-am(1), git-
1840 mailsplit(1).
1841 am.threeWay
1843 By default, git am will fail if the patch does not apply cleanly.
1844 When set to true, this setting tells git am to fall back on 3-way
1845 merge if the patch records the identity of blobs it is supposed to
1846 apply to and we have those blobs available locally (equivalent to
1847 giving the --3way option from the command line). Defaults to false.
1848 See git-am(1).
1849 apply.ignoreWhitespace
1851 When set to change, tells git apply to ignore changes in
1852 whitespace, in the same way as the --ignore-space-change option.
1853 When set to one of: no, none, never, false, it tells git apply to
1854 respect all whitespace differences. See git-apply(1).
1855 apply.whitespace
1857 Tells git apply how to handle whitespace, in the same way as the
1858 --whitespace option. See git-apply(1).
1859 blame.blankBoundary
1861 Show blank commit object name for boundary commits in git-blame(1).
1862 This option defaults to false.
1863 blame.coloring
1865 This determines the coloring scheme to be applied to blame output.
1866 It can be repeatedLines, highlightRecent, or none which is the
1867 default.
1868 blame.date
1870 Specifies the format used to output dates in git-blame(1). If unset
1871 the iso format is used. For supported values, see the discussion of
1872 the --date option at git-log(1).
1873 blame.showEmail
1875 Show the author email instead of author name in git-blame(1). This
1876 option defaults to false.
1877 blame.showRoot
1879 Do not treat root commits as boundaries in git-blame(1). This
1880 option defaults to false.
1881 blame.ignoreRevsFile
1883 Ignore revisions listed in the file, one unabbreviated object name
1884 per line, in git-blame(1). Whitespace and comments beginning with #
1885 are ignored. This option may be repeated multiple times. Empty file
1886 names will reset the list of ignored revisions. This option will be
1887 handled before the command line option --ignore-revs-file.
1888 blame.markUnblamableLines
1890 Mark lines that were changed by an ignored revision that we could
1891 not attribute to another commit with a * in the output of git-
1892 blame(1).
1893 blame.markIgnoredLines
1895 Mark lines that were changed by an ignored revision that we
1896 attributed to another commit with a ? in the output of git-
1897 blame(1).
1898 branch.autoSetupMerge
1900 Tells git branch, git switch and git checkout to set up new
1901 branches so that git-pull(1) will appropriately merge from the
1902 starting point branch. Note that even if this option is not set,
1903 this behavior can be chosen per-branch using the --track and
1904 --no-track options. The valid settings are: false — no automatic
1905 setup is done; true — automatic setup is done when the starting
1906 point is a remote-tracking branch; always — automatic setup is done
1907 when the starting point is either a local branch or remote-tracking
1908 branch; inherit — if the starting point has a tracking
1909 configuration, it is copied to the new branch; simple — automatic
1910 setup is done only when the starting point is a remote-tracking
1911 branch and the new branch has the same name as the remote branch.
1912 This option defaults to true.
1913 branch.autoSetupRebase
1915 When a new branch is created with git branch, git switch or git
1916 checkout that tracks another branch, this variable tells Git to set
1917 up pull to rebase instead of merge (see "branch.<name>.rebase").
1918 When never, rebase is never automatically set to true. When local,
1919 rebase is set to true for tracked branches of other local branches.
1920 When remote, rebase is set to true for tracked branches of
1921 remote-tracking branches. When always, rebase will be set to true
1922 for all tracking branches. See "branch.autoSetupMerge" for details
1923 on how to set up a branch to track another branch. This option
1924 defaults to never.
1925 branch.sort
1927 This variable controls the sort ordering of branches when displayed
1928 by git-branch(1). Without the "--sort=<value>" option provided, the
1929 value of this variable will be used as the default. See git-for-
1930 each-ref(1) field names for valid values.
1931 branch.<name>.remote
1933 When on branch <name>, it tells git fetch and git push which remote
1934 to fetch from or push to. The remote to push to may be overridden
1935 with remote.pushDefault (for all branches). The remote to push to,
1936 for the current branch, may be further overridden by
1937 branch.<name>.pushRemote. If no remote is configured, or if you are
1938 not on any branch and there is more than one remote defined in the
1939 repository, it defaults to origin for fetching and
1940 remote.pushDefault for pushing. Additionally, . (a period) is the
1941 current local repository (a dot-repository), see
1942 branch.<name>.merge's final note below.
1943 branch.<name>.pushRemote
1945 When on branch <name>, it overrides branch.<name>.remote for
1946 pushing. It also overrides remote.pushDefault for pushing from
1947 branch <name>. When you pull from one place (e.g. your upstream)
1948 and push to another place (e.g. your own publishing repository),
1949 you would want to set remote.pushDefault to specify the remote to
1950 push to for all branches, and use this option to override it for a
1951 specific branch.
1952 branch.<name>.merge
1954 Defines, together with branch.<name>.remote, the upstream branch
1955 for the given branch. It tells git fetch/git pull/git rebase which
1956 branch to merge and can also affect git push (see push.default).
1957 When in branch <name>, it tells git fetch the default refspec to be
1958 marked for merging in FETCH_HEAD. The value is handled like the
1959 remote part of a refspec, and must match a ref which is fetched
1960 from the remote given by "branch.<name>.remote". The merge
1961 information is used by git pull (which first calls git fetch) to
1962 lookup the default branch for merging. Without this option, git
1963 pull defaults to merge the first refspec fetched. Specify multiple
1964 values to get an octopus merge. If you wish to setup git pull so
1965 that it merges into <name> from another branch in the local
1966 repository, you can point branch.<name>.merge to the desired
1967 branch, and use the relative path setting . (a period) for
1968 branch.<name>.remote.
1969 branch.<name>.mergeOptions
1971 Sets default options for merging into branch <name>. The syntax and
1972 supported options are the same as those of git-merge(1), but option
1973 values containing whitespace characters are currently not
1974 supported.
1975 branch.<name>.rebase
1977 When true, rebase the branch <name> on top of the fetched branch,
1978 instead of merging the default branch from the default remote when
1979 "git pull" is run. See "pull.rebase" for doing this in a non
1980 branch-specific manner.
1981 When merges (or just m), pass the --rebase-merges option to git
1983 rebase so that the local merge commits are included in the rebase
1984 (see git-rebase(1) for details).
1985 When the value is interactive (or just i), the rebase is run in
1987 interactive mode.
1988 NOTE: this is a possibly dangerous operation; do not use it unless
1990 you understand the implications (see git-rebase(1) for details).
1991 branch.<name>.description
1993 Branch description, can be edited with git branch
1994 --edit-description. Branch description is automatically added to
1995 the format-patch cover letter or request-pull summary.
1996 browser.<tool>.cmd
1998 Specify the command to invoke the specified browser. The specified
1999 command is evaluated in shell with the URLs passed as arguments.
2000 (See git-web--browse(1).)
2001 browser.<tool>.path
2003 Override the path for the given tool that may be used to browse
2004 HTML help (see -w option in git-help(1)) or a working repository in
2005 gitweb (see git-instaweb(1)).
2006 bundle.*
2008 The bundle.* keys may appear in a bundle list file found via the
2009 git clone --bundle-uri option. These keys currently have no effect
2010 if placed in a repository config file, though this will change in
2011 the future. See the bundle URI design document[1] for more details.
2012 bundle.version
2014 This integer value advertises the version of the bundle list format
2015 used by the bundle list. Currently, the only accepted value is 1.
2016 bundle.mode
2018 This string value should be either all or any. This value describes
2019 whether all of the advertised bundles are required to unbundle a
2020 complete understanding of the bundled information (all) or if any
2021 one of the listed bundle URIs is sufficient (any).
2022 bundle.heuristic
2024 If this string-valued key exists, then the bundle list is designed
2025 to work well with incremental git fetch commands. The heuristic
2026 signals that there are additional keys available for each bundle
2027 that help determine which subset of bundles the client should
2028 download. The only value currently understood is creationToken.
2029 bundle.<id>.*
2031 The bundle.<id>.* keys are used to describe a single item in the
2032 bundle list, grouped under <id> for identification purposes.
2033 bundle.<id>.uri
2035 This string value defines the URI by which Git can reach the
2036 contents of this <id>. This URI may be a bundle file or another
2037 bundle list.
2038 checkout.defaultRemote
2040 When you run git checkout <something> or git switch <something> and
2041 only have one remote, it may implicitly fall back on checking out
2042 and tracking e.g. origin/<something>. This stops working as soon
2043 as you have more than one remote with a <something> reference. This
2044 setting allows for setting the name of a preferred remote that
2045 should always win when it comes to disambiguation. The typical
2046 use-case is to set this to origin.
2047 Currently this is used by git-switch(1) and git-checkout(1) when
2049 git checkout <something> or git switch <something> will checkout
2050 the <something> branch on another remote, and by git-worktree(1)
2051 when git worktree add refers to a remote branch. This setting might
2052 be used for other checkout-like commands or functionality in the
2053 future.
2054 checkout.guess
2056 Provides the default value for the --guess or --no-guess option in
2057 git checkout and git switch. See git-switch(1) and git-checkout(1).
2058 checkout.workers
2060 The number of parallel workers to use when updating the working
2061 tree. The default is one, i.e. sequential execution. If set to a
2062 value less than one, Git will use as many workers as the number of
2063 logical cores available. This setting and
2064 checkout.thresholdForParallelism affect all commands that perform
2065 checkout. E.g. checkout, clone, reset, sparse-checkout, etc.
2066 Note: Parallel checkout usually delivers better performance for
2068 repositories located on SSDs or over NFS. For repositories on
2069 spinning disks and/or machines with a small number of cores, the
2070 default sequential checkout often performs better. The size and
2071 compression level of a repository might also influence how well the
2072 parallel version performs.
2073 checkout.thresholdForParallelism
2075 When running parallel checkout with a small number of files, the
2076 cost of subprocess spawning and inter-process communication might
2077 outweigh the parallelization gains. This setting allows you to
2078 define the minimum number of files for which parallel checkout
2079 should be attempted. The default is 100.
2080 clean.requireForce
2082 A boolean to make git-clean do nothing unless given -f, -i, or -n.
2083 Defaults to true.
2084 clone.defaultRemoteName
2086 The name of the remote to create when cloning a repository.
2087 Defaults to origin, and can be overridden by passing the --origin
2088 command-line option to git-clone(1).
2089 clone.rejectShallow
2091 Reject cloning a repository if it is a shallow one; this can be
2092 overridden by passing the --reject-shallow option on the command
2093 line. See git-clone(1)
2094 clone.filterSubmodules
2096 If a partial clone filter is provided (see --filter in git-rev-
2097 list(1)) and --recurse-submodules is used, also apply the filter to
2098 submodules.
2099 color.advice
2101 A boolean to enable/disable color in hints (e.g. when a push
2102 failed, see advice.* for a list). May be set to always, false (or
2103 never) or auto (or true), in which case colors are used only when
2104 the error output goes to a terminal. If unset, then the value of
2105 color.ui is used (auto by default).
2106 color.advice.hint
2108 Use customized color for hints.
2109 color.blame.highlightRecent
2111 Specify the line annotation color for git blame --color-by-age
2112 depending upon the age of the line.
2113 This setting should be set to a comma-separated list of color and
2115 date settings, starting and ending with a color, the dates should
2116 be set from oldest to newest. The metadata will be colored with the
2117 specified colors if the line was introduced before the given
2118 timestamp, overwriting older timestamped colors.
2119 Instead of an absolute timestamp relative timestamps work as well,
2121 e.g. 2.weeks.ago is valid to address anything older than 2 weeks.
2122 It defaults to blue,12 month ago,white,1 month ago,red, which
2124 colors everything older than one year blue, recent changes between
2125 one month and one year old are kept white, and lines introduced
2126 within the last month are colored red.
2127 color.blame.repeatedLines
2129 Use the specified color to colorize line annotations for git blame
2130 --color-lines, if they come from the same commit as the preceding
2131 line. Defaults to cyan.
2132 color.branch
2134 A boolean to enable/disable color in the output of git-branch(1).
2135 May be set to always, false (or never) or auto (or true), in which
2136 case colors are used only when the output is to a terminal. If
2137 unset, then the value of color.ui is used (auto by default).
2138 color.branch.<slot>
2140 Use customized color for branch coloration. <slot> is one of
2141 current (the current branch), local (a local branch), remote (a
2142 remote-tracking branch in refs/remotes/), upstream (upstream
2143 tracking branch), plain (other refs).
2144 color.diff
2146 Whether to use ANSI escape sequences to add color to patches. If
2147 this is set to always, git-diff(1), git-log(1), and git-show(1)
2148 will use color for all patches. If it is set to true or auto, those
2149 commands will only use color when output is to the terminal. If
2150 unset, then the value of color.ui is used (auto by default).
2151 This does not affect git-format-patch(1) or the git-diff-* plumbing
2153 commands. Can be overridden on the command line with the
2154 --color[=<when>] option.
2155 color.diff.<slot>
2157 Use customized color for diff colorization. <slot> specifies which
2158 part of the patch to use the specified color, and is one of context
2159 (context text - plain is a historical synonym), meta
2160 (metainformation), frag (hunk header), func (function in hunk
2161 header), old (removed lines), new (added lines), commit (commit
2162 headers), whitespace (highlighting whitespace errors), oldMoved
2163 (deleted lines), newMoved (added lines), oldMovedDimmed,
2164 oldMovedAlternative, oldMovedAlternativeDimmed, newMovedDimmed,
2165 newMovedAlternative newMovedAlternativeDimmed (See the <mode>
2166 setting of --color-moved in git-diff(1) for details),
2167 contextDimmed, oldDimmed, newDimmed, contextBold, oldBold, and
2168 newBold (see git-range-diff(1) for details).
2169 color.decorate.<slot>
2171 Use customized color for git log --decorate output. <slot> is one
2172 of branch, remoteBranch, tag, stash or HEAD for local branches,
2173 remote-tracking branches, tags, stash and HEAD, respectively and
2174 grafted for grafted commits.
2175 color.grep
2177 When set to always, always highlight matches. When false (or
2178 never), never. When set to true or auto, use color only when the
2179 output is written to the terminal. If unset, then the value of
2180 color.ui is used (auto by default).
2181 color.grep.<slot>
2183 Use customized color for grep colorization. <slot> specifies which
2184 part of the line to use the specified color, and is one of
2185 context
2187 non-matching text in context lines (when using -A, -B, or -C)
2188 filename
2190 filename prefix (when not using -h)
2191 function
2193 function name lines (when using -p)
2194 lineNumber
2196 line number prefix (when using -n)
2197 column
2199 column number prefix (when using --column)
2200 match
2202 matching text (same as setting matchContext and matchSelected)
2203 matchContext
2205 matching text in context lines
2206 matchSelected
2208 matching text in selected lines. Also, used to customize the
2209 following git-log(1) subcommands: --grep, --author, and
2210 --committer.
2211 selected
2213 non-matching text in selected lines. Also, used to customize
2214 the following git-log(1) subcommands: --grep, --author and
2215 --committer.
2216 separator
2218 separators between fields on a line (:, -, and =) and between
2219 hunks (--)
2220 color.interactive
2222 When set to always, always use colors for interactive prompts and
2223 displays (such as those used by "git-add --interactive" and
2224 "git-clean --interactive"). When false (or never), never. When set
2225 to true or auto, use colors only when the output is to the
2226 terminal. If unset, then the value of color.ui is used (auto by
2227 default).
2228 color.interactive.<slot>
2230 Use customized color for git add --interactive and git clean
2231 --interactive output. <slot> may be prompt, header, help or error,
2232 for four distinct types of normal output from interactive commands.
2233 color.pager
2235 A boolean to specify whether auto color modes should colorize
2236 output going to the pager. Defaults to true; set this to false if
2237 your pager does not understand ANSI color codes.
2238 color.push
2240 A boolean to enable/disable color in push errors. May be set to
2241 always, false (or never) or auto (or true), in which case colors
2242 are used only when the error output goes to a terminal. If unset,
2243 then the value of color.ui is used (auto by default).
2244 color.push.error
2246 Use customized color for push errors.
2247 color.remote
2249 If set, keywords at the start of the line are highlighted. The
2250 keywords are "error", "warning", "hint" and "success", and are
2251 matched case-insensitively. May be set to always, false (or never)
2252 or auto (or true). If unset, then the value of color.ui is used
2253 (auto by default).
2254 color.remote.<slot>
2256 Use customized color for each remote keyword. <slot> may be hint,
2257 warning, success or error which match the corresponding keyword.
2258 color.showBranch
2260 A boolean to enable/disable color in the output of git-show-
2261 branch(1). May be set to always, false (or never) or auto (or
2262 true), in which case colors are used only when the output is to a
2263 terminal. If unset, then the value of color.ui is used (auto by
2264 default).
2265 color.status
2267 A boolean to enable/disable color in the output of git-status(1).
2268 May be set to always, false (or never) or auto (or true), in which
2269 case colors are used only when the output is to a terminal. If
2270 unset, then the value of color.ui is used (auto by default).
2271 color.status.<slot>
2273 Use customized color for status colorization. <slot> is one of
2274 header (the header text of the status message), added or updated
2275 (files which are added but not committed), changed (files which are
2276 changed but not added in the index), untracked (files which are not
2277 tracked by Git), branch (the current branch), nobranch (the color
2278 the no branch warning is shown in, defaulting to red), localBranch
2279 or remoteBranch (the local and remote branch names, respectively,
2280 when branch and tracking information is displayed in the status
2281 short-format), or unmerged (files which have unmerged changes).
2282 color.transport
2284 A boolean to enable/disable color when pushes are rejected. May be
2285 set to always, false (or never) or auto (or true), in which case
2286 colors are used only when the error output goes to a terminal. If
2287 unset, then the value of color.ui is used (auto by default).
2288 color.transport.rejected
2290 Use customized color when a push was rejected.
2291 color.ui
2293 This variable determines the default value for variables such as
2294 color.diff and color.grep that control the use of color per command
2295 family. Its scope will expand as more commands learn configuration
2296 to set a default for the --color option. Set it to false or never
2297 if you prefer Git commands not to use color unless enabled
2298 explicitly with some other configuration or the --color option. Set
2299 it to always if you want all output not intended for machine
2300 consumption to use color, to true or auto (this is the default
2301 since Git 1.8.4) if you want such output to use color when written
2302 to the terminal.
2303 column.ui
2305 Specify whether supported commands should output in columns. This
2306 variable consists of a list of tokens separated by spaces or
2307 commas:
2308 These options control when the feature should be enabled (defaults
2310 to never):
2311 always
2313 always show in columns
2314 never
2316 never show in columns
2317 auto
2319 show in columns if the output is to the terminal
2320 These options control layout (defaults to column). Setting any of
2322 these implies always if none of always, never, or auto are
2323 specified.
2324 column
2326 fill columns before rows
2327 row
2329 fill rows before columns
2330 plain
2332 show in one column
2333 Finally, these options can be combined with a layout option
2335 (defaults to nodense):
2336 dense
2338 make unequal size columns to utilize more space
2339 nodense
2341 make equal size columns
2342 column.branch
2344 Specify whether to output branch listing in git branch in columns.
2345 See column.ui for details.
2346 column.clean
2348 Specify the layout when listing items in git clean -i, which always
2349 shows files and directories in columns. See column.ui for details.
2350 column.status
2352 Specify whether to output untracked files in git status in columns.
2353 See column.ui for details.
2354 column.tag
2356 Specify whether to output tag listings in git tag in columns. See
2357 column.ui for details.
2358 commit.cleanup
2360 This setting overrides the default of the --cleanup option in git
2361 commit. See git-commit(1) for details. Changing the default can be
2362 useful when you always want to keep lines that begin with the
2363 comment character # in your log message, in which case you would do
2364 git config commit.cleanup whitespace (note that you will have to
2365 remove the help lines that begin with # in the commit log template
2366 yourself, if you do this).
2367 commit.gpgSign
2369 A boolean to specify whether all commits should be GPG signed. Use
2370 of this option when doing operations such as rebase can result in a
2371 large number of commits being signed. It may be convenient to use
2372 an agent to avoid typing your GPG passphrase several times.
2373 commit.status
2375 A boolean to enable/disable inclusion of status information in the
2376 commit message template when using an editor to prepare the commit
2377 message. Defaults to true.
2378 commit.template
2380 Specify the pathname of a file to use as the template for new
2381 commit messages.
2382 commit.verbose
2384 A boolean or int to specify the level of verbosity with git commit.
2385 See git-commit(1).
2386 commitGraph.generationVersion
2388 Specifies the type of generation number version to use when writing
2389 or reading the commit-graph file. If version 1 is specified, then
2390 the corrected commit dates will not be written or read. Defaults to
2391 2.
2392 commitGraph.maxNewFilters
2394 Specifies the default value for the --max-new-filters option of git
2395 commit-graph write (c.f., git-commit-graph(1)).
2396 commitGraph.readChangedPaths
2398 If true, then git will use the changed-path Bloom filters in the
2399 commit-graph file (if it exists, and they are present). Defaults to
2400 true. See git-commit-graph(1) for more information.
2401 credential.helper
2403 Specify an external helper to be called when a username or password
2404 credential is needed; the helper may consult external storage to
2405 avoid prompting the user for the credentials. This is normally the
2406 name of a credential helper with possible arguments, but may also
2407 be an absolute path with arguments or, if preceded by !, shell
2408 commands.
2409 Note that multiple helpers may be defined. See gitcredentials(7)
2411 for details and examples.
2412 credential.useHttpPath
2414 When acquiring credentials, consider the "path" component of an
2415 http or https URL to be important. Defaults to false. See
2416 gitcredentials(7) for more information.
2417 credential.username
2419 If no username is set for a network authentication, use this
2420 username by default. See credential.<context>.* below, and
2421 gitcredentials(7).
2422 credential.<url>.*
2424 Any of the credential.* options above can be applied selectively to
2425 some credentials. For example,
2426 "credential.https://example.com.username" would set the default
2427 username only for https connections to example.com. See
2428 gitcredentials(7) for details on how URLs are matched.
2429 credentialCache.ignoreSIGHUP
2431 Tell git-credential-cache—daemon to ignore SIGHUP, instead of
2432 quitting.
2433 credentialStore.lockTimeoutMS
2435 The length of time, in milliseconds, for git-credential-store to
2436 retry when trying to lock the credentials file. A value of 0 means
2437 not to retry at all; -1 means to try indefinitely. Default is 1000
2438 (i.e., retry for 1s).
2439 completion.commands
2441 This is only used by git-completion.bash to add or remove commands
2442 from the list of completed commands. Normally only porcelain
2443 commands and a few select others are completed. You can add more
2444 commands, separated by space, in this variable. Prefixing the
2445 command with - will remove it from the existing list.
2446 diff.autoRefreshIndex
2448 When using git diff to compare with work tree files, do not
2449 consider stat-only changes as changed. Instead, silently run git
2450 update-index --refresh to update the cached stat information for
2451 paths whose contents in the work tree match the contents in the
2452 index. This option defaults to true. Note that this affects only
2453 git diff Porcelain, and not lower level diff commands such as git
2454 diff-files.
2455 diff.dirstat
2457 A comma separated list of --dirstat parameters specifying the
2458 default behavior of the --dirstat option to git-diff(1) and
2459 friends. The defaults can be overridden on the command line (using
2460 --dirstat=<param1,param2,...>). The fallback defaults (when not
2461 changed by diff.dirstat) are changes,noncumulative,3. The following
2462 parameters are available:
2463 changes
2465 Compute the dirstat numbers by counting the lines that have
2466 been removed from the source, or added to the destination. This
2467 ignores the amount of pure code movements within a file. In
2468 other words, rearranging lines in a file is not counted as much
2469 as other changes. This is the default behavior when no
2470 parameter is given.
2471 lines
2473 Compute the dirstat numbers by doing the regular line-based
2474 diff analysis, and summing the removed/added line counts. (For
2475 binary files, count 64-byte chunks instead, since binary files
2476 have no natural concept of lines). This is a more expensive
2477 --dirstat behavior than the changes behavior, but it does count
2478 rearranged lines within a file as much as other changes. The
2479 resulting output is consistent with what you get from the other
2480 --*stat options.
2481 files
2483 Compute the dirstat numbers by counting the number of files
2484 changed. Each changed file counts equally in the dirstat
2485 analysis. This is the computationally cheapest --dirstat
2486 behavior, since it does not have to look at the file contents
2487 at all.
2488 cumulative
2490 Count changes in a child directory for the parent directory as
2491 well. Note that when using cumulative, the sum of the
2492 percentages reported may exceed 100%. The default
2493 (non-cumulative) behavior can be specified with the
2494 noncumulative parameter.
2495 <limit>
2497 An integer parameter specifies a cut-off percent (3% by
2498 default). Directories contributing less than this percentage of
2499 the changes are not shown in the output.
2500 Example: The following will count changed files, while ignoring
2502 directories with less than 10% of the total amount of changed
2503 files, and accumulating child directory counts in the parent
2504 directories: files,10,cumulative.
2505 diff.statNameWidth
2507 Limit the width of the filename part in --stat output. If set,
2508 applies to all commands generating --stat output except
2509 format-patch.
2510 diff.statGraphWidth
2512 Limit the width of the graph part in --stat output. If set, applies
2513 to all commands generating --stat output except format-patch.
2514 diff.context
2516 Generate diffs with <n> lines of context instead of the default of
2517 3. This value is overridden by the -U option.
2518 diff.interHunkContext
2520 Show the context between diff hunks, up to the specified number of
2521 lines, thereby fusing the hunks that are close to each other. This
2522 value serves as the default for the --inter-hunk-context command
2523 line option.
2524 diff.external
2526 If this config variable is set, diff generation is not performed
2527 using the internal diff machinery, but using the given command. Can
2528 be overridden with the “GIT_EXTERNAL_DIFF” environment variable.
2529 The command is called with parameters as described under "git
2530 Diffs" in git(1). Note: if you want to use an external diff program
2531 only on a subset of your files, you might want to use
2532 gitattributes(5) instead.
2533 diff.ignoreSubmodules
2535 Sets the default value of --ignore-submodules. Note that this
2536 affects only git diff Porcelain, and not lower level diff commands
2537 such as git diff-files. git checkout and git switch also honor
2538 this setting when reporting uncommitted changes. Setting it to all
2539 disables the submodule summary normally shown by git commit and git
2540 status when status.submoduleSummary is set unless it is overridden
2541 by using the --ignore-submodules command-line option. The git
2542 submodule commands are not affected by this setting. By default
2543 this is set to untracked so that any untracked submodules are
2544 ignored.
2545 diff.mnemonicPrefix
2547 If set, git diff uses a prefix pair that is different from the
2548 standard "a/" and "b/" depending on what is being compared. When
2549 this configuration is in effect, reverse diff output also swaps the
2550 order of the prefixes:
2551 git diff
2553 compares the (i)ndex and the (w)ork tree;
2554 git diff HEAD
2556 compares a (c)ommit and the (w)ork tree;
2557 git diff --cached
2559 compares a (c)ommit and the (i)ndex;
2560 git diff HEAD:file1 file2
2562 compares an (o)bject and a (w)ork tree entity;
2563 git diff --no-index a b
2565 compares two non-git things (1) and (2).
2566 diff.noprefix
2568 If set, git diff does not show any source or destination prefix.
2569 diff.relative
2571 If set to true, git diff does not show changes outside of the
2572 directory and show pathnames relative to the current directory.
2573 diff.orderFile
2575 File indicating how to order files within a diff. See the -O option
2576 to git-diff(1) for details. If diff.orderFile is a relative
2577 pathname, it is treated as relative to the top of the working tree.
2578 diff.renameLimit
2580 The number of files to consider in the exhaustive portion of
2581 copy/rename detection; equivalent to the git diff option -l. If not
2582 set, the default value is currently 1000. This setting has no
2583 effect if rename detection is turned off.
2584 diff.renames
2586 Whether and how Git detects renames. If set to "false", rename
2587 detection is disabled. If set to "true", basic rename detection is
2588 enabled. If set to "copies" or "copy", Git will detect copies, as
2589 well. Defaults to true. Note that this affects only git diff
2590 Porcelain like git-diff(1) and git-log(1), and not lower level
2591 commands such as git-diff-files(1).
2592 diff.suppressBlankEmpty
2594 A boolean to inhibit the standard behavior of printing a space
2595 before each empty output line. Defaults to false.
2596 diff.submodule
2598 Specify the format in which differences in submodules are shown.
2599 The "short" format just shows the names of the commits at the
2600 beginning and end of the range. The "log" format lists the commits
2601 in the range like git-submodule(1) summary does. The "diff" format
2602 shows an inline diff of the changed contents of the submodule.
2603 Defaults to "short".
2604 diff.wordRegex
2606 A POSIX Extended Regular Expression used to determine what is a
2607 "word" when performing word-by-word difference calculations.
2608 Character sequences that match the regular expression are "words",
2609 all other characters are ignorable whitespace.
2610 diff.<driver>.command
2612 The custom diff driver command. See gitattributes(5) for details.
2613 diff.<driver>.xfuncname
2615 The regular expression that the diff driver should use to recognize
2616 the hunk header. A built-in pattern may also be used. See
2617 gitattributes(5) for details.
2618 diff.<driver>.binary
2620 Set this option to true to make the diff driver treat files as
2621 binary. See gitattributes(5) for details.
2622 diff.<driver>.textconv
2624 The command that the diff driver should call to generate the
2625 text-converted version of a file. The result of the conversion is
2626 used to generate a human-readable diff. See gitattributes(5) for
2627 details.
2628 diff.<driver>.wordRegex
2630 The regular expression that the diff driver should use to split
2631 words in a line. See gitattributes(5) for details.
2632 diff.<driver>.cachetextconv
2634 Set this option to true to make the diff driver cache the text
2635 conversion outputs. See gitattributes(5) for details.
2636 araxis
2638 Use Araxis Merge (requires a graphical session)
2639 bc
2641 Use Beyond Compare (requires a graphical session)
2642 bc3
2644 Use Beyond Compare (requires a graphical session)
2645 bc4
2647 Use Beyond Compare (requires a graphical session)
2648 codecompare
2650 Use Code Compare (requires a graphical session)
2651 deltawalker
2653 Use DeltaWalker (requires a graphical session)
2654 diffmerge
2656 Use DiffMerge (requires a graphical session)
2657 diffuse
2659 Use Diffuse (requires a graphical session)
2660 ecmerge
2662 Use ECMerge (requires a graphical session)
2663 emerge
2665 Use Emacs' Emerge
2666 examdiff
2668 Use ExamDiff Pro (requires a graphical session)
2669 guiffy
2671 Use Guiffy’s Diff Tool (requires a graphical session)
2672 gvimdiff
2674 Use gVim (requires a graphical session)
2675 kdiff3
2677 Use KDiff3 (requires a graphical session)
2678 kompare
2680 Use Kompare (requires a graphical session)
2681 meld
2683 Use Meld (requires a graphical session)
2684 nvimdiff
2686 Use Neovim
2687 opendiff
2689 Use FileMerge (requires a graphical session)
2690 p4merge
2692 Use HelixCore P4Merge (requires a graphical session)
2693 smerge
2695 Use Sublime Merge (requires a graphical session)
2696 tkdiff
2698 Use TkDiff (requires a graphical session)
2699 vimdiff
2701 Use Vim
2702 winmerge
2704 Use WinMerge (requires a graphical session)
2705 xxdiff
2707 Use xxdiff (requires a graphical session)
2708 diff.indentHeuristic
2710 Set this option to false to disable the default heuristics that
2711 shift diff hunk boundaries to make patches easier to read.
2712 diff.algorithm
2714 Choose a diff algorithm. The variants are as follows:
2715 default, myers
2717 The basic greedy diff algorithm. Currently, this is the
2718 default.
2719 minimal
2721 Spend extra time to make sure the smallest possible diff is
2722 produced.
2723 patience
2725 Use "patience diff" algorithm when generating patches.
2726 histogram
2728 This algorithm extends the patience algorithm to "support
2729 low-occurrence common elements".
2730 diff.wsErrorHighlight
2732 Highlight whitespace errors in the context, old or new lines of the
2733 diff. Multiple values are separated by comma, none resets previous
2734 values, default reset the list to new and all is a shorthand for
2735 old,new,context. The whitespace errors are colored with
2736 color.diff.whitespace. The command line option
2737 --ws-error-highlight=<kind> overrides this setting.
2738 diff.colorMoved
2740 If set to either a valid <mode> or a true value, moved lines in a
2741 diff are colored differently, for details of valid modes see
2742 --color-moved in git-diff(1). If simply set to true the default
2743 color mode will be used. When set to false, moved lines are not
2744 colored.
2745 diff.colorMovedWS
2747 When moved lines are colored using e.g. the diff.colorMoved
2748 setting, this option controls the <mode> how spaces are treated for
2749 details of valid modes see --color-moved-ws in git-diff(1).
2750 diff.tool
2752 Controls which diff tool is used by git-difftool(1). This variable
2753 overrides the value configured in merge.tool. The list below shows
2754 the valid built-in values. Any other value is treated as a custom
2755 diff tool and requires that a corresponding difftool.<tool>.cmd
2756 variable is defined.
2757 diff.guitool
2759 Controls which diff tool is used by git-difftool(1) when the
2760 -g/--gui flag is specified. This variable overrides the value
2761 configured in merge.guitool. The list below shows the valid
2762 built-in values. Any other value is treated as a custom diff tool
2763 and requires that a corresponding difftool.<guitool>.cmd variable
2764 is defined.
2765 difftool.<tool>.cmd
2767 Specify the command to invoke the specified diff tool. The
2768 specified command is evaluated in shell with the following
2769 variables available: LOCAL is set to the name of the temporary file
2770 containing the contents of the diff pre-image and REMOTE is set to
2771 the name of the temporary file containing the contents of the diff
2772 post-image.
2773 See the --tool=<tool> option in git-difftool(1) for more details.
2775 difftool.<tool>.path
2777 Override the path for the given tool. This is useful in case your
2778 tool is not in the PATH.
2779 difftool.trustExitCode
2781 Exit difftool if the invoked diff tool returns a non-zero exit
2782 status.
2783 See the --trust-exit-code option in git-difftool(1) for more
2785 details.
2786 difftool.prompt
2788 Prompt before each invocation of the diff tool.
2789 difftool.guiDefault
2791 Set true to use the diff.guitool by default (equivalent to
2792 specifying the --gui argument), or auto to select diff.guitool or
2793 diff.tool depending on the presence of a DISPLAY environment
2794 variable value. The default is false, where the --gui argument must
2795 be provided explicitly for the diff.guitool to be used.
2796 extensions.objectFormat
2798 Specify the hash algorithm to use. The acceptable values are sha1
2799 and sha256. If not specified, sha1 is assumed. It is an error to
2800 specify this key unless core.repositoryFormatVersion is 1.
2801 Note that this setting should only be set by git-init(1) or git-
2803 clone(1). Trying to change it after initialization will not work
2804 and will produce hard-to-diagnose issues.
2805 extensions.worktreeConfig
2807 If enabled, then worktrees will load config settings from the
2808 $GIT_DIR/config.worktree file in addition to the
2809 $GIT_COMMON_DIR/config file. Note that $GIT_COMMON_DIR and $GIT_DIR
2810 are the same for the main working tree, while other working trees
2811 have $GIT_DIR equal to $GIT_COMMON_DIR/worktrees/<id>/. The
2812 settings in the config.worktree file will override settings from
2813 any other config files.
2814 When enabling extensions.worktreeConfig, you must be careful to
2816 move certain values from the common config file to the main working
2817 tree’s config.worktree file, if present:
2818 • core.worktree must be moved from $GIT_COMMON_DIR/config to
2820 $GIT_COMMON_DIR/config.worktree.
2821 • If core.bare is true, then it must be moved from
2823 $GIT_COMMON_DIR/config to $GIT_COMMON_DIR/config.worktree.
2824 It may also be beneficial to adjust the locations of
2826 core.sparseCheckout and core.sparseCheckoutCone depending on
2827 your desire for customizable sparse-checkout settings for each
2828 worktree. By default, the git sparse-checkout builtin enables
2829 extensions.worktreeConfig, assigns these config values on a
2830 per-worktree basis, and uses the $GIT_DIR/info/sparse-checkout
2831 file to specify the sparsity for each worktree independently.
2832 See git-sparse-checkout(1) for more details.
2833 For historical reasons, extensions.worktreeConfig is respected
2835 regardless of the core.repositoryFormatVersion setting.
2836 fastimport.unpackLimit
2838 If the number of objects imported by git-fast-import(1) is below
2839 this limit, then the objects will be unpacked into loose object
2840 files. However, if the number of imported objects equals or exceeds
2841 this limit, then the pack will be stored as a pack. Storing the
2842 pack from a fast-import can make the import operation complete
2843 faster, especially on slow filesystems. If not set, the value of
2844 transfer.unpackLimit is used instead.
2845 feature.*
2847 The config settings that start with feature. modify the defaults
2848 of a group of other config settings. These groups are created by
2849 the Git developer community as recommended defaults and are subject
2850 to change. In particular, new config options may be added with
2851 different defaults.
2852 feature.experimental
2854 Enable config options that are new to Git, and are being considered
2855 for future defaults. Config settings included here may be added or
2856 removed with each release, including minor version updates. These
2857 settings may have unintended interactions since they are so new.
2858 Please enable this setting if you are interested in providing
2859 feedback on experimental features. The new default values are:
2860 • fetch.negotiationAlgorithm=skipping may improve fetch
2862 negotiation times by skipping more commits at a time, reducing
2863 the number of round trips.
2864 • pack.useBitmapBoundaryTraversal=true may improve bitmap
2866 traversal times by walking fewer objects.
2867 feature.manyFiles
2869 Enable config options that optimize for repos with many files in
2870 the working directory. With many files, commands such as git status
2871 and git checkout may be slow and these new defaults improve
2872 performance:
2873 • index.skipHash=true speeds up index writes by not computing a
2875 trailing checksum. Note that this will cause Git versions
2876 earlier than 2.13.0 to refuse to parse the index and Git
2877 versions earlier than 2.40.0 will report a corrupted index
2878 during git fsck.
2879 • index.version=4 enables path-prefix compression in the index.
2881 • core.untrackedCache=true enables the untracked cache. This
2883 setting assumes that mtime is working on your machine.
2884 fetch.recurseSubmodules
2886 This option controls whether git fetch (and the underlying fetch in
2887 git pull) will recursively fetch into populated submodules. This
2888 option can be set either to a boolean value or to on-demand.
2889 Setting it to a boolean changes the behavior of fetch and pull to
2890 recurse unconditionally into submodules when set to true or to not
2891 recurse at all when set to false. When set to on-demand, fetch and
2892 pull will only recurse into a populated submodule when its
2893 superproject retrieves a commit that updates the submodule’s
2894 reference. Defaults to on-demand, or to the value of
2895 submodule.recurse if set.
2896 fetch.fsckObjects
2898 If it is set to true, git-fetch-pack will check all fetched
2899 objects. See transfer.fsckObjects for what’s checked. Defaults to
2900 false. If not set, the value of transfer.fsckObjects is used
2901 instead.
2902 fetch.fsck.<msg-id>
2904 Acts like fsck.<msg-id>, but is used by git-fetch-pack(1) instead
2905 of git-fsck(1). See the fsck.<msg-id> documentation for details.
2906 fetch.fsck.skipList
2908 Acts like fsck.skipList, but is used by git-fetch-pack(1) instead
2909 of git-fsck(1). See the fsck.skipList documentation for details.
2910 fetch.unpackLimit
2912 If the number of objects fetched over the Git native transfer is
2913 below this limit, then the objects will be unpacked into loose
2914 object files. However if the number of received objects equals or
2915 exceeds this limit then the received pack will be stored as a pack,
2916 after adding any missing delta bases. Storing the pack from a push
2917 can make the push operation complete faster, especially on slow
2918 filesystems. If not set, the value of transfer.unpackLimit is used
2919 instead.
2920 fetch.prune
2922 If true, fetch will automatically behave as if the --prune option
2923 was given on the command line. See also remote.<name>.prune and the
2924 PRUNING section of git-fetch(1).
2925 fetch.pruneTags
2927 If true, fetch will automatically behave as if the
2928 refs/tags/*:refs/tags/* refspec was provided when pruning, if not
2929 set already. This allows for setting both this option and
2930 fetch.prune to maintain a 1=1 mapping to upstream refs. See also
2931 remote.<name>.pruneTags and the PRUNING section of git-fetch(1).
2932 fetch.output
2934 Control how ref update status is printed. Valid values are full and
2935 compact. Default value is full. See the OUTPUT section in git-
2936 fetch(1) for details.
2937 fetch.negotiationAlgorithm
2939 Control how information about the commits in the local repository
2940 is sent when negotiating the contents of the packfile to be sent by
2941 the server. Set to "consecutive" to use an algorithm that walks
2942 over consecutive commits checking each one. Set to "skipping" to
2943 use an algorithm that skips commits in an effort to converge
2944 faster, but may result in a larger-than-necessary packfile; or set
2945 to "noop" to not send any information at all, which will almost
2946 certainly result in a larger-than-necessary packfile, but will skip
2947 the negotiation step. Set to "default" to override settings made
2948 previously and use the default behaviour. The default is normally
2949 "consecutive", but if feature.experimental is true, then the
2950 default is "skipping". Unknown values will cause git fetch to error
2951 out.
2952 See also the --negotiate-only and --negotiation-tip options to git-
2954 fetch(1).
2955 fetch.showForcedUpdates
2957 Set to false to enable --no-show-forced-updates in git-fetch(1) and
2958 git-pull(1) commands. Defaults to true.
2959 fetch.parallel
2961 Specifies the maximal number of fetch operations to be run in
2962 parallel at a time (submodules, or remotes when the --multiple
2963 option of git-fetch(1) is in effect).
2964 A value of 0 will give some reasonable default. If unset, it
2966 defaults to 1.
2967 For submodules, this setting can be overridden using the
2969 submodule.fetchJobs config setting.
2970 fetch.writeCommitGraph
2972 Set to true to write a commit-graph after every git fetch command
2973 that downloads a pack-file from a remote. Using the --split option,
2974 most executions will create a very small commit-graph file on top
2975 of the existing commit-graph file(s). Occasionally, these files
2976 will merge and the write may take longer. Having an updated
2977 commit-graph file helps performance of many Git commands, including
2978 git merge-base, git push -f, and git log --graph. Defaults to
2979 false.
2980 fetch.bundleURI
2982 This value stores a URI for downloading Git object data from a
2983 bundle URI before performing an incremental fetch from the origin
2984 Git server. This is similar to how the --bundle-uri option behaves
2985 in git-clone(1). git clone --bundle-uri will set the
2986 fetch.bundleURI value if the supplied bundle URI contains a bundle
2987 list that is organized for incremental fetches.
2988 If you modify this value and your repository has a
2990 fetch.bundleCreationToken value, then remove that
2991 fetch.bundleCreationToken value before fetching from the new bundle
2992 URI.
2993 fetch.bundleCreationToken
2995 When using fetch.bundleURI to fetch incrementally from a bundle
2996 list that uses the "creationToken" heuristic, this config value
2997 stores the maximum creationToken value of the downloaded bundles.
2998 This value is used to prevent downloading bundles in the future if
2999 the advertised creationToken is not strictly larger than this
3000 value.
3001 The creation token values are chosen by the provider serving the
3003 specific bundle URI. If you modify the URI at fetch.bundleURI, then
3004 be sure to remove the value for the fetch.bundleCreationToken value
3005 before fetching.
3006 format.attach
3008 Enable multipart/mixed attachments as the default for format-patch.
3009 The value can also be a double quoted string which will enable
3010 attachments as the default and set the value as the boundary. See
3011 the --attach option in git-format-patch(1). To countermand an
3012 earlier value, set it to an empty string.
3013 format.from
3015 Provides the default value for the --from option to format-patch.
3016 Accepts a boolean value, or a name and email address. If false,
3017 format-patch defaults to --no-from, using commit authors directly
3018 in the "From:" field of patch mails. If true, format-patch defaults
3019 to --from, using your committer identity in the "From:" field of
3020 patch mails and including a "From:" field in the body of the patch
3021 mail if different. If set to a non-boolean value, format-patch uses
3022 that value instead of your committer identity. Defaults to false.
3023 format.forceInBodyFrom
3025 Provides the default value for the --[no-]force-in-body-from option
3026 to format-patch. Defaults to false.
3027 format.numbered
3029 A boolean which can enable or disable sequence numbers in patch
3030 subjects. It defaults to "auto" which enables it only if there is
3031 more than one patch. It can be enabled or disabled for all messages
3032 by setting it to "true" or "false". See --numbered option in git-
3033 format-patch(1).
3034 format.headers
3036 Additional email headers to include in a patch to be submitted by
3037 mail. See git-format-patch(1).
3038 format.to, format.cc
3040 Additional recipients to include in a patch to be submitted by
3041 mail. See the --to and --cc options in git-format-patch(1).
3042 format.subjectPrefix
3044 The default for format-patch is to output files with the [PATCH]
3045 subject prefix. Use this variable to change that prefix.
3046 format.coverFromDescription
3048 The default mode for format-patch to determine which parts of the
3049 cover letter will be populated using the branch’s description. See
3050 the --cover-from-description option in git-format-patch(1).
3051 format.signature
3053 The default for format-patch is to output a signature containing
3054 the Git version number. Use this variable to change that default.
3055 Set this variable to the empty string ("") to suppress signature
3056 generation.
3057 format.signatureFile
3059 Works just like format.signature except the contents of the file
3060 specified by this variable will be used as the signature.
3061 format.suffix
3063 The default for format-patch is to output files with the suffix
3064 .patch. Use this variable to change that suffix (make sure to
3065 include the dot if you want it).
3066 format.encodeEmailHeaders
3068 Encode email headers that have non-ASCII characters with
3069 "Q-encoding" (described in RFC 2047) for email transmission.
3070 Defaults to true.
3071 format.pretty
3073 The default pretty format for log/show/whatchanged command. See
3074 git-log(1), git-show(1), git-whatchanged(1).
3075 format.thread
3077 The default threading style for git format-patch. Can be a boolean
3078 value, or shallow or deep. shallow threading makes every mail a
3079 reply to the head of the series, where the head is chosen from the
3080 cover letter, the --in-reply-to, and the first patch mail, in this
3081 order. deep threading makes every mail a reply to the previous
3082 one. A true boolean value is the same as shallow, and a false value
3083 disables threading.
3084 format.signOff
3086 A boolean value which lets you enable the -s/--signoff option of
3087 format-patch by default. Note: Adding the Signed-off-by trailer to
3088 a patch should be a conscious act and means that you certify you
3089 have the rights to submit this work under the same open source
3090 license. Please see the SubmittingPatches document for further
3091 discussion.
3092 format.coverLetter
3094 A boolean that controls whether to generate a cover-letter when
3095 format-patch is invoked, but in addition can be set to "auto", to
3096 generate a cover-letter only when there’s more than one patch.
3097 Default is false.
3098 format.outputDirectory
3100 Set a custom directory to store the resulting files instead of the
3101 current working directory. All directory components will be
3102 created.
3103 format.filenameMaxLength
3105 The maximum length of the output filenames generated by the
3106 format-patch command; defaults to 64. Can be overridden by the
3107 --filename-max-length=<n> command line option.
3108 format.useAutoBase
3110 A boolean value which lets you enable the --base=auto option of
3111 format-patch by default. Can also be set to "whenAble" to allow
3112 enabling --base=auto if a suitable base is available, but to skip
3113 adding base info otherwise without the format dying.
3114 format.notes
3116 Provides the default value for the --notes option to format-patch.
3117 Accepts a boolean value, or a ref which specifies where to get
3118 notes. If false, format-patch defaults to --no-notes. If true,
3119 format-patch defaults to --notes. If set to a non-boolean value,
3120 format-patch defaults to --notes=<ref>, where ref is the
3121 non-boolean value. Defaults to false.
3122 If one wishes to use the ref ref/notes/true, please use that
3124 literal instead.
3125 This configuration can be specified multiple times in order to
3127 allow multiple notes refs to be included. In that case, it will
3128 behave similarly to multiple --[no-]notes[=] options passed in.
3129 That is, a value of true will show the default notes, a value of
3130 <ref> will also show notes from that notes ref and a value of false
3131 will negate previous configurations and not show notes.
3132 For example,
3134 [format]
3136 notes = true
3137 notes = foo
3138 notes = false
3139 notes = bar
3140 will only show notes from refs/notes/bar.
3142 format.mboxrd
3144 A boolean value which enables the robust "mboxrd" format when
3145 --stdout is in use to escape "^>+From " lines.
3146 format.noprefix
3148 If set, do not show any source or destination prefix in patches.
3149 This is equivalent to the diff.noprefix option used by git diff
3150 (but which is not respected by format-patch). Note that by setting
3151 this, the receiver of any patches you generate will have to apply
3152 them using the -p0 option.
3153 filter.<driver>.clean
3155 The command which is used to convert the content of a worktree file
3156 to a blob upon checkin. See gitattributes(5) for details.
3157 filter.<driver>.smudge
3159 The command which is used to convert the content of a blob object
3160 to a worktree file upon checkout. See gitattributes(5) for details.
3161 fsck.<msg-id>
3163 During fsck git may find issues with legacy data which wouldn’t be
3164 generated by current versions of git, and which wouldn’t be sent
3165 over the wire if transfer.fsckObjects was set. This feature is
3166 intended to support working with legacy repositories containing
3167 such data.
3168 Setting fsck.<msg-id> will be picked up by git-fsck(1), but to
3170 accept pushes of such data set receive.fsck.<msg-id> instead, or to
3171 clone or fetch it set fetch.fsck.<msg-id>.
3172 The rest of the documentation discusses fsck.* for brevity, but
3174 the same applies for the corresponding receive.fsck.* and
3175 fetch.fsck.*. variables.
3176 Unlike variables like color.ui and core.editor, the
3178 receive.fsck.<msg-id> and fetch.fsck.<msg-id> variables will not
3179 fall back on the fsck.<msg-id> configuration if they aren’t set. To
3180 uniformly configure the same fsck settings in different
3181 circumstances, all three of them must be set to the same values.
3182 When fsck.<msg-id> is set, errors can be switched to warnings and
3184 vice versa by configuring the fsck.<msg-id> setting where the
3185 <msg-id> is the fsck message ID and the value is one of error, warn
3186 or ignore. For convenience, fsck prefixes the error/warning with
3187 the message ID, e.g. "missingEmail: invalid author/committer line -
3188 missing email" means that setting fsck.missingEmail = ignore will
3189 hide that issue.
3190 In general, it is better to enumerate existing objects with
3192 problems with fsck.skipList, instead of listing the kind of
3193 breakages these problematic objects share to be ignored, as doing
3194 the latter will allow new instances of the same breakages go
3195 unnoticed.
3196 Setting an unknown fsck.<msg-id> value will cause fsck to die, but
3198 doing the same for receive.fsck.<msg-id> and fetch.fsck.<msg-id>
3199 will only cause git to warn.
3200 See the Fsck Messages section of git-fsck(1) for supported values
3202 of <msg-id>.
3203 fsck.skipList
3205 The path to a list of object names (i.e. one unabbreviated SHA-1
3206 per line) that are known to be broken in a non-fatal way and should
3207 be ignored. On versions of Git 2.20 and later, comments (#), empty
3208 lines, and any leading and trailing whitespace are ignored.
3209 Everything but a SHA-1 per line will error out on older versions.
3210 This feature is useful when an established project should be
3212 accepted despite early commits containing errors that can be safely
3213 ignored, such as invalid committer email addresses. Note: corrupt
3214 objects cannot be skipped with this setting.
3215 Like fsck.<msg-id> this variable has corresponding
3217 receive.fsck.skipList and fetch.fsck.skipList variants.
3218 Unlike variables like color.ui and core.editor the
3220 receive.fsck.skipList and fetch.fsck.skipList variables will not
3221 fall back on the fsck.skipList configuration if they aren’t set. To
3222 uniformly configure the same fsck settings in different
3223 circumstances, all three of them must be set to the same values.
3224 Older versions of Git (before 2.20) documented that the object
3226 names list should be sorted. This was never a requirement; the
3227 object names could appear in any order, but when reading the list
3228 we tracked whether the list was sorted for the purposes of an
3229 internal binary search implementation, which could save itself some
3230 work with an already sorted list. Unless you had a humongous list
3231 there was no reason to go out of your way to pre-sort the list.
3232 After Git version 2.20 a hash implementation is used instead, so
3233 there’s now no reason to pre-sort the list.
3234 fsmonitor.allowRemote
3236 By default, the fsmonitor daemon refuses to work with
3237 network-mounted repositories. Setting fsmonitor.allowRemote to true
3238 overrides this behavior. Only respected when core.fsmonitor is set
3239 to true.
3240 fsmonitor.socketDir
3242 This Mac OS-specific option, if set, specifies the directory in
3243 which to create the Unix domain socket used for communication
3244 between the fsmonitor daemon and various Git commands. The
3245 directory must reside on a native Mac OS filesystem. Only respected
3246 when core.fsmonitor is set to true.
3247 gc.aggressiveDepth
3249 The depth parameter used in the delta compression algorithm used by
3250 git gc --aggressive. This defaults to 50, which is the default for
3251 the --depth option when --aggressive isn’t in use.
3252 See the documentation for the --depth option in git-repack(1) for
3254 more details.
3255 gc.aggressiveWindow
3257 The window size parameter used in the delta compression algorithm
3258 used by git gc --aggressive. This defaults to 250, which is a much
3259 more aggressive window size than the default --window of 10.
3260 See the documentation for the --window option in git-repack(1) for
3262 more details.
3263 gc.auto
3265 When there are approximately more than this many loose objects in
3266 the repository, git gc --auto will pack them. Some Porcelain
3267 commands use this command to perform a light-weight garbage
3268 collection from time to time. The default value is 6700.
3269 Setting this to 0 disables not only automatic packing based on the
3271 number of loose objects, but also any other heuristic git gc --auto
3272 will otherwise use to determine if there’s work to do, such as
3273 gc.autoPackLimit.
3274 gc.autoPackLimit
3276 When there are more than this many packs that are not marked with
3277 *.keep file in the repository, git gc --auto consolidates them into
3278 one larger pack. The default value is 50. Setting this to 0
3279 disables it. Setting gc.auto to 0 will also disable this.
3280 See the gc.bigPackThreshold configuration variable below. When in
3282 use, it’ll affect how the auto pack limit works.
3283 gc.autoDetach
3285 Make git gc --auto return immediately and run in the background if
3286 the system supports it. Default is true.
3287 gc.bigPackThreshold
3289 If non-zero, all non-cruft packs larger than this limit are kept
3290 when git gc is run. This is very similar to --keep-largest-pack
3291 except that all non-cruft packs that meet the threshold are kept,
3292 not just the largest pack. Defaults to zero. Common unit suffixes
3293 of k, m, or g are supported.
3294 Note that if the number of kept packs is more than
3296 gc.autoPackLimit, this configuration variable is ignored, all packs
3297 except the base pack will be repacked. After this the number of
3298 packs should go below gc.autoPackLimit and gc.bigPackThreshold
3299 should be respected again.
3300 If the amount of memory estimated for git repack to run smoothly is
3302 not available and gc.bigPackThreshold is not set, the largest pack
3303 will also be excluded (this is the equivalent of running git gc
3304 with --keep-largest-pack).
3305 gc.writeCommitGraph
3307 If true, then gc will rewrite the commit-graph file when git-gc(1)
3308 is run. When using git gc --auto the commit-graph will be updated
3309 if housekeeping is required. Default is true. See git-commit-
3310 graph(1) for details.
3311 gc.logExpiry
3313 If the file gc.log exists, then git gc --auto will print its
3314 content and exit with status zero instead of running unless that
3315 file is more than gc.logExpiry old. Default is "1.day". See
3316 gc.pruneExpire for more ways to specify its value.
3317 gc.packRefs
3319 Running git pack-refs in a repository renders it unclonable by Git
3320 versions prior to 1.5.1.2 over dumb transports such as HTTP. This
3321 variable determines whether git gc runs git pack-refs. This can be
3322 set to notbare to enable it within all non-bare repos or it can be
3323 set to a boolean value. The default is true.
3324 gc.cruftPacks
3326 Store unreachable objects in a cruft pack (see git-repack(1))
3327 instead of as loose objects. The default is true.
3328 gc.maxCruftSize
3330 Limit the size of new cruft packs when repacking. When specified in
3331 addition to --max-cruft-size, the command line option takes
3332 priority. See the --max-cruft-size option of git-repack(1).
3333 gc.pruneExpire
3335 When git gc is run, it will call prune --expire 2.weeks.ago (and
3336 repack --cruft --cruft-expiration 2.weeks.ago if using cruft packs
3337 via gc.cruftPacks or --cruft). Override the grace period with this
3338 config variable. The value "now" may be used to disable this grace
3339 period and always prune unreachable objects immediately, or "never"
3340 may be used to suppress pruning. This feature helps prevent
3341 corruption when git gc runs concurrently with another process
3342 writing to the repository; see the "NOTES" section of git-gc(1).
3343 gc.worktreePruneExpire
3345 When git gc is run, it calls git worktree prune --expire
3346 3.months.ago. This config variable can be used to set a different
3347 grace period. The value "now" may be used to disable the grace
3348 period and prune $GIT_DIR/worktrees immediately, or "never" may be
3349 used to suppress pruning.
3350 gc.reflogExpire, gc.<pattern>.reflogExpire
3352 git reflog expire removes reflog entries older than this time;
3353 defaults to 90 days. The value "now" expires all entries
3354 immediately, and "never" suppresses expiration altogether. With
3355 "<pattern>" (e.g. "refs/stash") in the middle the setting applies
3356 only to the refs that match the <pattern>.
3357 gc.reflogExpireUnreachable, gc.<pattern>.reflogExpireUnreachable
3359 git reflog expire removes reflog entries older than this time and
3360 are not reachable from the current tip; defaults to 30 days. The
3361 value "now" expires all entries immediately, and "never" suppresses
3362 expiration altogether. With "<pattern>" (e.g. "refs/stash") in the
3363 middle, the setting applies only to the refs that match the
3364 <pattern>.
3365 These types of entries are generally created as a result of using
3367 git commit --amend or git rebase and are the commits prior to the
3368 amend or rebase occurring. Since these changes are not part of the
3369 current project most users will want to expire them sooner, which
3370 is why the default is more aggressive than gc.reflogExpire.
3371 gc.recentObjectsHook
3373 When considering whether or not to remove an object (either when
3374 generating a cruft pack or storing unreachable objects as loose),
3375 use the shell to execute the specified command(s). Interpret their
3376 output as object IDs which Git will consider as "recent",
3377 regardless of their age. By treating their mtimes as "now", any
3378 objects (and their descendants) mentioned in the output will be
3379 kept regardless of their true age.
3380 Output must contain exactly one hex object ID per line, and nothing
3382 else. Objects which cannot be found in the repository are ignored.
3383 Multiple hooks are supported, but all must exit successfully, else
3384 the operation (either generating a cruft pack or unpacking
3385 unreachable objects) will be halted.
3386 gc.repackFilter
3388 When repacking, use the specified filter to move certain objects
3389 into a separate packfile. See the --filter=<filter-spec> option of
3390 git-repack(1).
3391 gc.repackFilterTo
3393 When repacking and using a filter, see gc.repackFilter, the
3394 specified location will be used to create the packfile containing
3395 the filtered out objects. WARNING: The specified location should
3396 be accessible, using for example the Git alternates mechanism,
3397 otherwise the repo could be considered corrupt by Git as it migh
3398 not be able to access the objects in that packfile. See the
3399 --filter-to=<dir> option of git-repack(1) and the
3400 objects/info/alternates section of gitrepository-layout(5).
3401 gc.rerereResolved
3403 Records of conflicted merge you resolved earlier are kept for this
3404 many days when git rerere gc is run. You can also use more
3405 human-readable "1.month.ago", etc. The default is 60 days. See git-
3406 rerere(1).
3407 gc.rerereUnresolved
3409 Records of conflicted merge you have not resolved are kept for this
3410 many days when git rerere gc is run. You can also use more
3411 human-readable "1.month.ago", etc. The default is 15 days. See git-
3412 rerere(1).
3413 gitcvs.commitMsgAnnotation
3415 Append this string to each commit message. Set to empty string to
3416 disable this feature. Defaults to "via git-CVS emulator".
3417 gitcvs.enabled
3419 Whether the CVS server interface is enabled for this repository.
3420 See git-cvsserver(1).
3421 gitcvs.logFile
3423 Path to a log file where the CVS server interface well... logs
3424 various stuff. See git-cvsserver(1).
3425 gitcvs.usecrlfattr
3427 If true, the server will look up the end-of-line conversion
3428 attributes for files to determine the -k modes to use. If the
3429 attributes force Git to treat a file as text, the -k mode will be
3430 left blank so CVS clients will treat it as text. If they suppress
3431 text conversion, the file will be set with -kb mode, which
3432 suppresses any newline munging the client might otherwise do. If
3433 the attributes do not allow the file type to be determined, then
3434 gitcvs.allBinary is used. See gitattributes(5).
3435 gitcvs.allBinary
3437 This is used if gitcvs.usecrlfattr does not resolve the correct -kb
3438 mode to use. If true, all unresolved files are sent to the client
3439 in mode -kb. This causes the client to treat them as binary files,
3440 which suppresses any newline munging it otherwise might do.
3441 Alternatively, if it is set to "guess", then the contents of the
3442 file are examined to decide if it is binary, similar to
3443 core.autocrlf.
3444 gitcvs.dbName
3446 Database used by git-cvsserver to cache revision information
3447 derived from the Git repository. The exact meaning depends on the
3448 used database driver, for SQLite (which is the default driver) this
3449 is a filename. Supports variable substitution (see git-cvsserver(1)
3450 for details). May not contain semicolons (;). Default:
3451 %Ggitcvs.%m.sqlite
3452 gitcvs.dbDriver
3454 Used Perl DBI driver. You can specify any available driver for this
3455 here, but it might not work. git-cvsserver is tested with
3456 DBD::SQLite, reported to work with DBD::Pg, and reported not to
3457 work with DBD::mysql. Experimental feature. May not contain double
3458 colons (:). Default: SQLite. See git-cvsserver(1).
3459 gitcvs.dbUser, gitcvs.dbPass
3461 Database user and password. Only useful if setting gitcvs.dbDriver,
3462 since SQLite has no concept of database users and/or passwords.
3463 gitcvs.dbUser supports variable substitution (see git-cvsserver(1)
3464 for details).
3465 gitcvs.dbTableNamePrefix
3467 Database table name prefix. Prepended to the names of any database
3468 tables used, allowing a single database to be used for several
3469 repositories. Supports variable substitution (see git-cvsserver(1)
3470 for details). Any non-alphabetic characters will be replaced with
3471 underscores.
3472 All gitcvs variables except for gitcvs.usecrlfattr and gitcvs.allBinary
3474 can also be specified as gitcvs.<access_method>.<varname> (where
3475 access_method is one of "ext" and "pserver") to make them apply only
3476 for the given access method.
3477 gitweb.category, gitweb.description, gitweb.owner, gitweb.url
3479 See gitweb(1) for description.
3480 gitweb.avatar, gitweb.blame, gitweb.grep, gitweb.highlight,
3482 gitweb.patches, gitweb.pickaxe, gitweb.remote_heads, gitweb.showSizes,
3483 gitweb.snapshot
3484 See gitweb.conf(5) for description.
3485 grep.lineNumber
3487 If set to true, enable -n option by default.
3488 grep.column
3490 If set to true, enable the --column option by default.
3491 grep.patternType
3493 Set the default matching behavior. Using a value of basic,
3494 extended, fixed, or perl will enable the --basic-regexp,
3495 --extended-regexp, --fixed-strings, or --perl-regexp option
3496 accordingly, while the value default will use the
3497 grep.extendedRegexp option to choose between basic and extended.
3498 grep.extendedRegexp
3500 If set to true, enable --extended-regexp option by default. This
3501 option is ignored when the grep.patternType option is set to a
3502 value other than default.
3503 grep.threads
3505 Number of grep worker threads to use. If unset (or set to 0), Git
3506 will use as many threads as the number of logical cores available.
3507 grep.fullName
3509 If set to true, enable --full-name option by default.
3510 grep.fallbackToNoIndex
3512 If set to true, fall back to git grep --no-index if git grep is
3513 executed outside of a git repository. Defaults to false.
3514 gpg.program
3516 Use this custom program instead of "gpg" found on $PATH when making
3517 or verifying a PGP signature. The program must support the same
3518 command-line interface as GPG, namely, to verify a detached
3519 signature, "gpg --verify $signature - <$file" is run, and the
3520 program is expected to signal a good signature by exiting with code
3521 0. To generate an ASCII-armored detached signature, the standard
3522 input of "gpg -bsau $key" is fed with the contents to be signed,
3523 and the program is expected to send the result to its standard
3524 output.
3525 gpg.format
3527 Specifies which key format to use when signing with --gpg-sign.
3528 Default is "openpgp". Other possible values are "x509", "ssh".
3529 See gitformat-signature(5) for the signature format, which differs
3531 based on the selected gpg.format.
3532 gpg.<format>.program
3534 Use this to customize the program used for the signing format you
3535 chose. (see gpg.program and gpg.format) gpg.program can still be
3536 used as a legacy synonym for gpg.openpgp.program. The default value
3537 for gpg.x509.program is "gpgsm" and gpg.ssh.program is
3538 "ssh-keygen".
3539 gpg.minTrustLevel
3541 Specifies a minimum trust level for signature verification. If this
3542 option is unset, then signature verification for merge operations
3543 requires a key with at least marginal trust. Other operations that
3544 perform signature verification require a key with at least
3545 undefined trust. Setting this option overrides the required
3546 trust-level for all operations. Supported values, in increasing
3547 order of significance:
3548 • undefined
3550 • never
3552 • marginal
3554 • fully
3556 • ultimate
3558 gpg.ssh.defaultKeyCommand
3560 This command will be run when user.signingkey is not set and a ssh
3561 signature is requested. On successful exit a valid ssh public key
3562 prefixed with key:: is expected in the first line of its output.
3563 This allows for a script doing a dynamic lookup of the correct
3564 public key when it is impractical to statically configure
3565 user.signingKey. For example when keys or SSH Certificates are
3566 rotated frequently or selection of the right key depends on
3567 external factors unknown to git.
3568 gpg.ssh.allowedSignersFile
3570 A file containing ssh public keys which you are willing to trust.
3571 The file consists of one or more lines of principals followed by an
3572 ssh public key. e.g.: user1@example.com,user2@example.com ssh-rsa
3573 AAAAX1... See ssh-keygen(1) "ALLOWED SIGNERS" for details. The
3574 principal is only used to identify the key and is available when
3575 verifying a signature.
3576 SSH has no concept of trust levels like gpg does. To be able to
3578 differentiate between valid signatures and trusted signatures the
3579 trust level of a signature verification is set to fully when the
3580 public key is present in the allowedSignersFile. Otherwise the
3581 trust level is undefined and git verify-commit/tag will fail.
3582 This file can be set to a location outside of the repository and
3584 every developer maintains their own trust store. A central
3585 repository server could generate this file automatically from ssh
3586 keys with push access to verify the code against. In a corporate
3587 setting this file is probably generated at a global location from
3588 automation that already handles developer ssh keys.
3589 A repository that only allows signed commits can store the file in
3591 the repository itself using a path relative to the top-level of the
3592 working tree. This way only committers with an already valid key
3593 can add or change keys in the keyring.
3594 Since OpensSSH 8.8 this file allows specifying a key lifetime using
3596 valid-after & valid-before options. Git will mark signatures as
3597 valid if the signing key was valid at the time of the signature’s
3598 creation. This allows users to change a signing key without
3599 invalidating all previously made signatures.
3600 Using a SSH CA key with the cert-authority option (see
3602 ssh-keygen(1) "CERTIFICATES") is also valid.
3603 gpg.ssh.revocationFile
3605 Either a SSH KRL or a list of revoked public keys (without the
3606 principal prefix). See ssh-keygen(1) for details. If a public key
3607 is found in this file then it will always be treated as having
3608 trust level "never" and signatures will show as invalid.
3609 gui.commitMsgWidth
3611 Defines how wide the commit message window is in the git-gui(1).
3612 "75" is the default.
3613 gui.diffContext
3615 Specifies how many context lines should be used in calls to diff
3616 made by the git-gui(1). The default is "5".
3617 gui.displayUntracked
3619 Determines if git-gui(1) shows untracked files in the file list.
3620 The default is "true".
3621 gui.encoding
3623 Specifies the default character encoding to use for displaying of
3624 file contents in git-gui(1) and gitk(1). It can be overridden by
3625 setting the encoding attribute for relevant files (see
3626 gitattributes(5)). If this option is not set, the tools default to
3627 the locale encoding.
3628 gui.matchTrackingBranch
3630 Determines if new branches created with git-gui(1) should default
3631 to tracking remote branches with matching names or not. Default:
3632 "false".
3633 gui.newBranchTemplate
3635 Is used as a suggested name when creating new branches using the
3636 git-gui(1).
3637 gui.pruneDuringFetch
3639 "true" if git-gui(1) should prune remote-tracking branches when
3640 performing a fetch. The default value is "false".
3641 gui.trustmtime
3643 Determines if git-gui(1) should trust the file modification
3644 timestamp or not. By default the timestamps are not trusted.
3645 gui.spellingDictionary
3647 Specifies the dictionary used for spell checking commit messages in
3648 the git-gui(1). When set to "none" spell checking is turned off.
3649 gui.fastCopyBlame
3651 If true, git gui blame uses -C instead of -C -C for original
3652 location detection. It makes blame significantly faster on huge
3653 repositories at the expense of less thorough copy detection.
3654 gui.copyBlameThreshold
3656 Specifies the threshold to use in git gui blame original location
3657 detection, measured in alphanumeric characters. See the git-
3658 blame(1) manual for more information on copy detection.
3659 gui.blamehistoryctx
3661 Specifies the radius of history context in days to show in gitk(1)
3662 for the selected commit, when the Show History Context menu item is
3663 invoked from git gui blame. If this variable is set to zero, the
3664 whole history is shown.
3665 guitool.<name>.cmd
3667 Specifies the shell command line to execute when the corresponding
3668 item of the git-gui(1) Tools menu is invoked. This option is
3669 mandatory for every tool. The command is executed from the root of
3670 the working directory, and in the environment it receives the name
3671 of the tool as GIT_GUITOOL, the name of the currently selected file
3672 as FILENAME, and the name of the current branch as CUR_BRANCH (if
3673 the head is detached, CUR_BRANCH is empty).
3674 guitool.<name>.needsFile
3676 Run the tool only if a diff is selected in the GUI. It guarantees
3677 that FILENAME is not empty.
3678 guitool.<name>.noConsole
3680 Run the command silently, without creating a window to display its
3681 output.
3682 guitool.<name>.noRescan
3684 Don’t rescan the working directory for changes after the tool
3685 finishes execution.
3686 guitool.<name>.confirm
3688 Show a confirmation dialog before actually running the tool.
3689 guitool.<name>.argPrompt
3691 Request a string argument from the user, and pass it to the tool
3692 through the ARGS environment variable. Since requesting an argument
3693 implies confirmation, the confirm option has no effect if this is
3694 enabled. If the option is set to true, yes, or 1, the dialog uses a
3695 built-in generic prompt; otherwise the exact value of the variable
3696 is used.
3697 guitool.<name>.revPrompt
3699 Request a single valid revision from the user, and set the REVISION
3700 environment variable. In other aspects this option is similar to
3701 argPrompt, and can be used together with it.
3702 guitool.<name>.revUnmerged
3704 Show only unmerged branches in the revPrompt subdialog. This is
3705 useful for tools similar to merge or rebase, but not for things
3706 like checkout or reset.
3707 guitool.<name>.title
3709 Specifies the title to use for the prompt dialog. The default is
3710 the tool name.
3711 guitool.<name>.prompt
3713 Specifies the general prompt string to display at the top of the
3714 dialog, before subsections for argPrompt and revPrompt. The default
3715 value includes the actual command.
3716 help.browser
3718 Specify the browser that will be used to display help in the web
3719 format. See git-help(1).
3720 help.format
3722 Override the default help format used by git-help(1). Values man,
3723 info, web and html are supported. man is the default. web and
3724 html are the same.
3725 help.autoCorrect
3727 If git detects typos and can identify exactly one valid command
3728 similar to the error, git will try to suggest the correct command
3729 or even run the suggestion automatically. Possible config values
3730 are:
3731 • 0 (default): show the suggested command.
3733 • positive number: run the suggested command after specified
3735 deciseconds (0.1 sec).
3736 • "immediate": run the suggested command immediately.
3738 • "prompt": show the suggestion and prompt for confirmation to
3740 run the command.
3741 • "never": don’t run or show any suggested command.
3743 help.htmlPath
3745 Specify the path where the HTML documentation resides. File system
3746 paths and URLs are supported. HTML pages will be prefixed with this
3747 path when help is displayed in the web format. This defaults to the
3748 documentation path of your Git installation.
3749 http.proxy
3751 Override the HTTP proxy, normally configured using the http_proxy,
3752 https_proxy, and all_proxy environment variables (see curl(1)). In
3753 addition to the syntax understood by curl, it is possible to
3754 specify a proxy string with a user name but no password, in which
3755 case git will attempt to acquire one in the same way it does for
3756 other credentials. See gitcredentials(7) for more information. The
3757 syntax thus is [protocol://][user[:password]@]proxyhost[:port].
3758 This can be overridden on a per-remote basis; see
3759 remote.<name>.proxy
3760 http.proxyAuthMethod
3762 Set the method with which to authenticate against the HTTP proxy.
3763 This only takes effect if the configured proxy string contains a
3764 user name part (i.e. is of the form user@host or user@host:port).
3765 This can be overridden on a per-remote basis; see
3766 remote.<name>.proxyAuthMethod. Both can be overridden by the
3767 GIT_HTTP_PROXY_AUTHMETHOD environment variable. Possible values
3768 are:
3769 • anyauth - Automatically pick a suitable authentication method.
3771 It is assumed that the proxy answers an unauthenticated request
3772 with a 407 status code and one or more Proxy-authenticate
3773 headers with supported authentication methods. This is the
3774 default.
3775 • basic - HTTP Basic authentication
3777 • digest - HTTP Digest authentication; this prevents the password
3779 from being transmitted to the proxy in clear text
3780 • negotiate - GSS-Negotiate authentication (compare the
3782 --negotiate option of curl(1))
3783 • ntlm - NTLM authentication (compare the --ntlm option of
3785 curl(1))
3786 http.proxySSLCert
3788 The pathname of a file that stores a client certificate to use to
3789 authenticate with an HTTPS proxy. Can be overridden by the
3790 GIT_PROXY_SSL_CERT environment variable.
3791 http.proxySSLKey
3793 The pathname of a file that stores a private key to use to
3794 authenticate with an HTTPS proxy. Can be overridden by the
3795 GIT_PROXY_SSL_KEY environment variable.
3796 http.proxySSLCertPasswordProtected
3798 Enable Git’s password prompt for the proxy SSL certificate.
3799 Otherwise OpenSSL will prompt the user, possibly many times, if the
3800 certificate or private key is encrypted. Can be overridden by the
3801 GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED environment variable.
3802 http.proxySSLCAInfo
3804 Pathname to the file containing the certificate bundle that should
3805 be used to verify the proxy with when using an HTTPS proxy. Can be
3806 overridden by the GIT_PROXY_SSL_CAINFO environment variable.
3807 http.emptyAuth
3809 Attempt authentication without seeking a username or password. This
3810 can be used to attempt GSS-Negotiate authentication without
3811 specifying a username in the URL, as libcurl normally requires a
3812 username for authentication.
3813 http.delegation
3815 Control GSSAPI credential delegation. The delegation is disabled by
3816 default in libcurl since version 7.21.7. Set parameter to tell the
3817 server what it is allowed to delegate when it comes to user
3818 credentials. Used with GSS/kerberos. Possible values are:
3819 • none - Don’t allow any delegation.
3821 • policy - Delegates if and only if the OK-AS-DELEGATE flag is
3823 set in the Kerberos service ticket, which is a matter of realm
3824 policy.
3825 • always - Unconditionally allow the server to delegate.
3827 http.extraHeader
3829 Pass an additional HTTP header when communicating with a server. If
3830 more than one such entry exists, all of them are added as extra
3831 headers. To allow overriding the settings inherited from the system
3832 config, an empty value will reset the extra headers to the empty
3833 list.
3834 http.cookieFile
3836 The pathname of a file containing previously stored cookie lines,
3837 which should be used in the Git http session, if they match the
3838 server. The file format of the file to read cookies from should be
3839 plain HTTP headers or the Netscape/Mozilla cookie file format (see
3840 curl(1)). NOTE that the file specified with http.cookieFile is used
3841 only as input unless http.saveCookies is set.
3842 http.saveCookies
3844 If set, store cookies received during requests to the file
3845 specified by http.cookieFile. Has no effect if http.cookieFile is
3846 unset.
3847 http.version
3849 Use the specified HTTP protocol version when communicating with a
3850 server. If you want to force the default. The available and default
3851 version depend on libcurl. Currently the possible values of this
3852 option are:
3853 • HTTP/2
3855 • HTTP/1.1
3857 http.curloptResolve
3859 Hostname resolution information that will be used first by libcurl
3860 when sending HTTP requests. This information should be in one of
3861 the following formats:
3862 • [+]HOST:PORT:ADDRESS[,ADDRESS]
3864 • -HOST:PORT
3866 The first format redirects all requests to the given HOST:PORT to
3868 the provided ADDRESS(s). The second format clears all previous
3869 config values for that HOST:PORT combination. To allow easy
3870 overriding of all the settings inherited from the system config, an
3871 empty value will reset all resolution information to the empty
3872 list.
3873 http.sslVersion
3875 The SSL version to use when negotiating an SSL connection, if you
3876 want to force the default. The available and default version depend
3877 on whether libcurl was built against NSS or OpenSSL and the
3878 particular configuration of the crypto library in use. Internally
3879 this sets the CURLOPT_SSL_VERSION option; see the libcurl
3880 documentation for more details on the format of this option and for
3881 the ssl version supported. Currently the possible values of this
3882 option are:
3883 • sslv2
3885 • sslv3
3887 • tlsv1
3889 • tlsv1.0
3891 • tlsv1.1
3893 • tlsv1.2
3895 • tlsv1.3
3897 Can be overridden by the GIT_SSL_VERSION environment variable. To
3899 force git to use libcurl’s default ssl version and ignore any
3900 explicit http.sslversion option, set GIT_SSL_VERSION to the empty
3901 string.
3902 http.sslCipherList
3904 A list of SSL ciphers to use when negotiating an SSL connection.
3905 The available ciphers depend on whether libcurl was built against
3906 NSS or OpenSSL and the particular configuration of the crypto
3907 library in use. Internally this sets the CURLOPT_SSL_CIPHER_LIST
3908 option; see the libcurl documentation for more details on the
3909 format of this list.
3910 Can be overridden by the GIT_SSL_CIPHER_LIST environment variable.
3912 To force git to use libcurl’s default cipher list and ignore any
3913 explicit http.sslCipherList option, set GIT_SSL_CIPHER_LIST to the
3914 empty string.
3915 http.sslVerify
3917 Whether to verify the SSL certificate when fetching or pushing over
3918 HTTPS. Defaults to true. Can be overridden by the GIT_SSL_NO_VERIFY
3919 environment variable.
3920 http.sslCert
3922 File containing the SSL certificate when fetching or pushing over
3923 HTTPS. Can be overridden by the GIT_SSL_CERT environment variable.
3924 http.sslKey
3926 File containing the SSL private key when fetching or pushing over
3927 HTTPS. Can be overridden by the GIT_SSL_KEY environment variable.
3928 http.sslCertPasswordProtected
3930 Enable Git’s password prompt for the SSL certificate. Otherwise
3931 OpenSSL will prompt the user, possibly many times, if the
3932 certificate or private key is encrypted. Can be overridden by the
3933 GIT_SSL_CERT_PASSWORD_PROTECTED environment variable.
3934 http.sslCAInfo
3936 File containing the certificates to verify the peer with when
3937 fetching or pushing over HTTPS. Can be overridden by the
3938 GIT_SSL_CAINFO environment variable.
3939 http.sslCAPath
3941 Path containing files with the CA certificates to verify the peer
3942 with when fetching or pushing over HTTPS. Can be overridden by the
3943 GIT_SSL_CAPATH environment variable.
3944 http.sslBackend
3946 Name of the SSL backend to use (e.g. "openssl" or "schannel"). This
3947 option is ignored if cURL lacks support for choosing the SSL
3948 backend at runtime.
3949 http.schannelCheckRevoke
3951 Used to enforce or disable certificate revocation checks in cURL
3952 when http.sslBackend is set to "schannel". Defaults to true if
3953 unset. Only necessary to disable this if Git consistently errors
3954 and the message is about checking the revocation status of a
3955 certificate. This option is ignored if cURL lacks support for
3956 setting the relevant SSL option at runtime.
3957 http.schannelUseSSLCAInfo
3959 As of cURL v7.60.0, the Secure Channel backend can use the
3960 certificate bundle provided via http.sslCAInfo, but that would
3961 override the Windows Certificate Store. Since this is not desirable
3962 by default, Git will tell cURL not to use that bundle by default
3963 when the schannel backend was configured via http.sslBackend,
3964 unless http.schannelUseSSLCAInfo overrides this behavior.
3965 http.pinnedPubkey
3967 Public key of the https service. It may either be the filename of a
3968 PEM or DER encoded public key file or a string starting with
3969 sha256// followed by the base64 encoded sha256 hash of the public
3970 key. See also libcurl CURLOPT_PINNEDPUBLICKEY. git will exit with
3971 an error if this option is set but not supported by cURL.
3972 http.sslTry
3974 Attempt to use AUTH SSL/TLS and encrypted data transfers when
3975 connecting via regular FTP protocol. This might be needed if the
3976 FTP server requires it for security reasons or you wish to connect
3977 securely whenever remote FTP server supports it. Default is false
3978 since it might trigger certificate verification errors on
3979 misconfigured servers.
3980 http.maxRequests
3982 How many HTTP requests to launch in parallel. Can be overridden by
3983 the GIT_HTTP_MAX_REQUESTS environment variable. Default is 5.
3984 http.minSessions
3986 The number of curl sessions (counted across slots) to be kept
3987 across requests. They will not be ended with curl_easy_cleanup()
3988 until http_cleanup() is invoked. If USE_CURL_MULTI is not defined,
3989 this value will be capped at 1. Defaults to 1.
3990 http.postBuffer
3992 Maximum size in bytes of the buffer used by smart HTTP transports
3993 when POSTing data to the remote system. For requests larger than
3994 this buffer size, HTTP/1.1 and Transfer-Encoding: chunked is used
3995 to avoid creating a massive pack file locally. Default is 1 MiB,
3996 which is sufficient for most requests.
3997 Note that raising this limit is only effective for disabling
3999 chunked transfer encoding and therefore should be used only where
4000 the remote server or a proxy only supports HTTP/1.0 or is
4001 noncompliant with the HTTP standard. Raising this is not, in
4002 general, an effective solution for most push problems, but can
4003 increase memory consumption significantly since the entire buffer
4004 is allocated even for small pushes.
4005 http.lowSpeedLimit, http.lowSpeedTime
4007 If the HTTP transfer speed, in bytes per second, is less than
4008 http.lowSpeedLimit for longer than http.lowSpeedTime seconds, the
4009 transfer is aborted. Can be overridden by the
4010 GIT_HTTP_LOW_SPEED_LIMIT and GIT_HTTP_LOW_SPEED_TIME environment
4011 variables.
4012 http.noEPSV
4014 A boolean which disables using of EPSV ftp command by curl. This
4015 can be helpful with some "poor" ftp servers which don’t support
4016 EPSV mode. Can be overridden by the GIT_CURL_FTP_NO_EPSV
4017 environment variable. Default is false (curl will use EPSV).
4018 http.userAgent
4020 The HTTP USER_AGENT string presented to an HTTP server. The default
4021 value represents the version of the Git client such as git/1.7.1.
4022 This option allows you to override this value to a more common
4023 value such as Mozilla/4.0. This may be necessary, for instance, if
4024 connecting through a firewall that restricts HTTP connections to a
4025 set of common USER_AGENT strings (but not including those like
4026 git/1.7.1). Can be overridden by the GIT_HTTP_USER_AGENT
4027 environment variable.
4028 http.followRedirects
4030 Whether git should follow HTTP redirects. If set to true, git will
4031 transparently follow any redirect issued by a server it encounters.
4032 If set to false, git will treat all redirects as errors. If set to
4033 initial, git will follow redirects only for the initial request to
4034 a remote, but not for subsequent follow-up HTTP requests. Since git
4035 uses the redirected URL as the base for the follow-up requests,
4036 this is generally sufficient. The default is initial.
4037 http.<url>.*
4039 Any of the http.* options above can be applied selectively to some
4040 URLs. For a config key to match a URL, each element of the config
4041 key is compared to that of the URL, in the following order:
4042 1. Scheme (e.g., https in https://example.com/). This field must
4044 match exactly between the config key and the URL.
4045 2. Host/domain name (e.g., example.com in https://example.com/).
4047 This field must match between the config key and the URL. It is
4048 possible to specify a * as part of the host name to match all
4049 subdomains at this level. https://*.example.com/ for example
4050 would match https://foo.example.com/, but not
4051 https://foo.bar.example.com/.
4052 3. Port number (e.g., 8080 in http://example.com:8080/). This
4054 field must match exactly between the config key and the URL.
4055 Omitted port numbers are automatically converted to the correct
4056 default for the scheme before matching.
4057 4. Path (e.g., repo.git in https://example.com/repo.git). The path
4059 field of the config key must match the path field of the URL
4060 either exactly or as a prefix of slash-delimited path elements.
4061 This means a config key with path foo/ matches URL path
4062 foo/bar. A prefix can only match on a slash (/) boundary.
4063 Longer matches take precedence (so a config key with path
4064 foo/bar is a better match to URL path foo/bar than a config key
4065 with just path foo/).
4066 5. User name (e.g., user in https://user@example.com/repo.git). If
4068 the config key has a user name it must match the user name in
4069 the URL exactly. If the config key does not have a user name,
4070 that config key will match a URL with any user name (including
4071 none), but at a lower precedence than a config key with a user
4072 name.
4073 The list above is ordered by decreasing precedence; a URL that
4075 matches a config key’s path is preferred to one that matches its
4076 user name. For example, if the URL is
4077 https://user@example.com/foo/bar a config key match of
4078 https://example.com/foo will be preferred over a config key match
4079 of https://user@example.com.
4080 All URLs are normalized before attempting any matching (the
4082 password part, if embedded in the URL, is always ignored for
4083 matching purposes) so that equivalent URLs that are simply spelled
4084 differently will match properly. Environment variable settings
4085 always override any matches. The URLs that are matched against are
4086 those given directly to Git commands. This means any URLs visited
4087 as a result of a redirection do not participate in matching.
4088 i18n.commitEncoding
4090 Character encoding the commit messages are stored in; Git itself
4091 does not care per se, but this information is necessary e.g. when
4092 importing commits from emails or in the gitk graphical history
4093 browser (and possibly in other places in the future or in other
4094 porcelains). See e.g. git-mailinfo(1). Defaults to utf-8.
4095 i18n.logOutputEncoding
4097 Character encoding the commit messages are converted to when
4098 running git log and friends.
4099 imap.folder
4101 The folder to drop the mails into, which is typically the Drafts
4102 folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
4103 "[Gmail]/Drafts". Required.
4104 imap.tunnel
4106 Command used to set up a tunnel to the IMAP server through which
4107 commands will be piped instead of using a direct network connection
4108 to the server. Required when imap.host is not set.
4109 imap.host
4111 A URL identifying the server. Use an imap:// prefix for non-secure
4112 connections and an imaps:// prefix for secure connections. Ignored
4113 when imap.tunnel is set, but required otherwise.
4114 imap.user
4116 The username to use when logging in to the server.
4117 imap.pass
4119 The password to use when logging in to the server.
4120 imap.port
4122 An integer port number to connect to on the server. Defaults to 143
4123 for imap:// hosts and 993 for imaps:// hosts. Ignored when
4124 imap.tunnel is set.
4125 imap.sslverify
4127 A boolean to enable/disable verification of the server certificate
4128 used by the SSL/TLS connection. Default is true. Ignored when
4129 imap.tunnel is set.
4130 imap.preformattedHTML
4132 A boolean to enable/disable the use of html encoding when sending a
4133 patch. An html encoded patch will be bracketed with <pre> and have
4134 a content type of text/html. Ironically, enabling this option
4135 causes Thunderbird to send the patch as a plain/text, format=fixed
4136 email. Default is false.
4137 imap.authMethod
4139 Specify the authentication method for authenticating with the IMAP
4140 server. If Git was built with the NO_CURL option, or if your curl
4141 version is older than 7.34.0, or if you’re running git-imap-send
4142 with the --no-curl option, the only supported method is CRAM-MD5.
4143 If this is not set then git imap-send uses the basic IMAP plaintext
4144 LOGIN command.
4145 include.path, includeIf.<condition>.path
4147 Special variables to include other configuration files. See the
4148 "CONFIGURATION FILE" section in the main git-config(1)
4149 documentation, specifically the "Includes" and "Conditional
4150 Includes" subsections.
4151 index.recordEndOfIndexEntries
4153 Specifies whether the index file should include an "End Of Index
4154 Entry" section. This reduces index load time on multiprocessor
4155 machines but produces a message "ignoring EOIE extension" when
4156 reading the index using Git versions before 2.20. Defaults to true
4157 if index.threads has been explicitly enabled, false otherwise.
4158 index.recordOffsetTable
4160 Specifies whether the index file should include an "Index Entry
4161 Offset Table" section. This reduces index load time on
4162 multiprocessor machines but produces a message "ignoring IEOT
4163 extension" when reading the index using Git versions before 2.20.
4164 Defaults to true if index.threads has been explicitly enabled,
4165 false otherwise.
4166 index.sparse
4168 When enabled, write the index using sparse-directory entries. This
4169 has no effect unless core.sparseCheckout and
4170 core.sparseCheckoutCone are both enabled. Defaults to false.
4171 index.threads
4173 Specifies the number of threads to spawn when loading the index.
4174 This is meant to reduce index load time on multiprocessor machines.
4175 Specifying 0 or true will cause Git to auto-detect the number of
4176 CPUs and set the number of threads accordingly. Specifying 1 or
4177 false will disable multithreading. Defaults to true.
4178 index.version
4180 Specify the version with which new index files should be
4181 initialized. This does not affect existing repositories. If
4182 feature.manyFiles is enabled, then the default is 4.
4183 index.skipHash
4185 When enabled, do not compute the trailing hash for the index file.
4186 This accelerates Git commands that manipulate the index, such as
4187 git add, git commit, or git status. Instead of storing the
4188 checksum, write a trailing set of bytes with value zero, indicating
4189 that the computation was skipped.
4190 If you enable index.skipHash, then Git clients older than 2.13.0
4192 will refuse to parse the index and Git clients older than 2.40.0
4193 will report an error during git fsck.
4194 init.templateDir
4196 Specify the directory from which templates will be copied. (See the
4197 "TEMPLATE DIRECTORY" section of git-init(1).)
4198 init.defaultBranch
4200 Allows overriding the default branch name e.g. when initializing a
4201 new repository.
4202 instaweb.browser
4204 Specify the program that will be used to browse your working
4205 repository in gitweb. See git-instaweb(1).
4206 instaweb.httpd
4208 The HTTP daemon command-line to start gitweb on your working
4209 repository. See git-instaweb(1).
4210 instaweb.local
4212 If true the web server started by git-instaweb(1) will be bound to
4213 the local IP (127.0.0.1).
4214 instaweb.modulePath
4216 The default module path for git-instaweb(1) to use instead of
4217 /usr/lib/apache2/modules. Only used if httpd is Apache.
4218 instaweb.port
4220 The port number to bind the gitweb httpd to. See git-instaweb(1).
4221 interactive.singleKey
4223 In interactive commands, allow the user to provide one-letter input
4224 with a single key (i.e., without hitting enter). Currently this is
4225 used by the --patch mode of git-add(1), git-checkout(1), git-
4226 restore(1), git-commit(1), git-reset(1), and git-stash(1). Note
4227 that this setting is silently ignored if portable keystroke input
4228 is not available; requires the Perl module Term::ReadKey.
4229 interactive.diffFilter
4231 When an interactive command (such as git add --patch) shows a
4232 colorized diff, git will pipe the diff through the shell command
4233 defined by this configuration variable. The command may mark up the
4234 diff further for human consumption, provided that it retains a
4235 one-to-one correspondence with the lines in the original diff.
4236 Defaults to disabled (no filtering).
4237 log.abbrevCommit
4239 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
4240 assume --abbrev-commit. You may override this option with
4241 --no-abbrev-commit.
4242 log.date
4244 Set the default date-time mode for the log command. Setting a value
4245 for log.date is similar to using git log's --date option. See git-
4246 log(1) for details.
4247 If the format is set to "auto:foo" and the pager is in use, format
4249 "foo" will be used for the date format. Otherwise, "default" will
4250 be used.
4251 log.decorate
4253 Print out the ref names of any commits that are shown by the log
4254 command. If short is specified, the ref name prefixes refs/heads/,
4255 refs/tags/ and refs/remotes/ will not be printed. If full is
4256 specified, the full ref name (including prefix) will be printed. If
4257 auto is specified, then if the output is going to a terminal, the
4258 ref names are shown as if short were given, otherwise no ref names
4259 are shown. This is the same as the --decorate option of the git
4260 log.
4261 log.initialDecorationSet
4263 By default, git log only shows decorations for certain known ref
4264 namespaces. If all is specified, then show all refs as decorations.
4265 log.excludeDecoration
4267 Exclude the specified patterns from the log decorations. This is
4268 similar to the --decorate-refs-exclude command-line option, but the
4269 config option can be overridden by the --decorate-refs option.
4270 log.diffMerges
4272 Set diff format to be used when --diff-merges=on is specified, see
4273 --diff-merges in git-log(1) for details. Defaults to separate.
4274 log.follow
4276 If true, git log will act as if the --follow option was used when a
4277 single <path> is given. This has the same limitations as --follow,
4278 i.e. it cannot be used to follow multiple files and does not work
4279 well on non-linear history.
4280 log.graphColors
4282 A list of colors, separated by commas, that can be used to draw
4283 history lines in git log --graph.
4284 log.showRoot
4286 If true, the initial commit will be shown as a big creation event.
4287 This is equivalent to a diff against an empty tree. Tools like git-
4288 log(1) or git-whatchanged(1), which normally hide the root commit
4289 will now show it. True by default.
4290 log.showSignature
4292 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
4293 assume --show-signature.
4294 log.mailmap
4296 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
4297 assume --use-mailmap, otherwise assume --no-use-mailmap. True by
4298 default.
4299 lsrefs.unborn
4301 May be "advertise" (the default), "allow", or "ignore". If
4302 "advertise", the server will respond to the client sending "unborn"
4303 (as described in gitprotocol-v2(5)) and will advertise support for
4304 this feature during the protocol v2 capability advertisement.
4305 "allow" is the same as "advertise" except that the server will not
4306 advertise support for this feature; this is useful for
4307 load-balanced servers that cannot be updated atomically (for
4308 example), since the administrator could configure "allow", then
4309 after a delay, configure "advertise".
4310 mailinfo.scissors
4312 If true, makes git-mailinfo(1) (and therefore git-am(1)) act by
4313 default as if the --scissors option was provided on the
4314 command-line. When active, this feature removes everything from the
4315 message body before a scissors line (i.e. consisting mainly of
4316 ">8", "8<" and "-").
4317 mailmap.file
4319 The location of an augmenting mailmap file. The default mailmap,
4320 located in the root of the repository, is loaded first, then the
4321 mailmap file pointed to by this variable. The location of the
4322 mailmap file may be in a repository subdirectory, or somewhere
4323 outside of the repository itself. See git-shortlog(1) and git-
4324 blame(1).
4325 mailmap.blob
4327 Like mailmap.file, but consider the value as a reference to a blob
4328 in the repository. If both mailmap.file and mailmap.blob are given,
4329 both are parsed, with entries from mailmap.file taking precedence.
4330 In a bare repository, this defaults to HEAD:.mailmap. In a non-bare
4331 repository, it defaults to empty.
4332 maintenance.auto
4334 This boolean config option controls whether some commands run git
4335 maintenance run --auto after doing their normal work. Defaults to
4336 true.
4337 maintenance.strategy
4339 This string config option provides a way to specify one of a few
4340 recommended schedules for background maintenance. This only affects
4341 which tasks are run during git maintenance run --schedule=X
4342 commands, provided no --task=<task> arguments are provided.
4343 Further, if a maintenance.<task>.schedule config value is set, then
4344 that value is used instead of the one provided by
4345 maintenance.strategy. The possible strategy strings are:
4346 • none: This default setting implies no tasks are run at any
4348 schedule.
4349 • incremental: This setting optimizes for performing small
4351 maintenance activities that do not delete any data. This does
4352 not schedule the gc task, but runs the prefetch and
4353 commit-graph tasks hourly, the loose-objects and
4354 incremental-repack tasks daily, and the pack-refs task weekly.
4355 maintenance.<task>.enabled
4357 This boolean config option controls whether the maintenance task
4358 with name <task> is run when no --task option is specified to git
4359 maintenance run. These config values are ignored if a --task option
4360 exists. By default, only maintenance.gc.enabled is true.
4361 maintenance.<task>.schedule
4363 This config option controls whether or not the given <task> runs
4364 during a git maintenance run --schedule=<frequency> command. The
4365 value must be one of "hourly", "daily", or "weekly".
4366 maintenance.commit-graph.auto
4368 This integer config option controls how often the commit-graph task
4369 should be run as part of git maintenance run --auto. If zero, then
4370 the commit-graph task will not run with the --auto option. A
4371 negative value will force the task to run every time. Otherwise, a
4372 positive value implies the command should run when the number of
4373 reachable commits that are not in the commit-graph file is at least
4374 the value of maintenance.commit-graph.auto. The default value is
4375 100.
4376 maintenance.loose-objects.auto
4378 This integer config option controls how often the loose-objects
4379 task should be run as part of git maintenance run --auto. If zero,
4380 then the loose-objects task will not run with the --auto option. A
4381 negative value will force the task to run every time. Otherwise, a
4382 positive value implies the command should run when the number of
4383 loose objects is at least the value of
4384 maintenance.loose-objects.auto. The default value is 100.
4385 maintenance.incremental-repack.auto
4387 This integer config option controls how often the
4388 incremental-repack task should be run as part of git maintenance
4389 run --auto. If zero, then the incremental-repack task will not run
4390 with the --auto option. A negative value will force the task to run
4391 every time. Otherwise, a positive value implies the command should
4392 run when the number of pack-files not in the multi-pack-index is at
4393 least the value of maintenance.incremental-repack.auto. The default
4394 value is 10.
4395 man.viewer
4397 Specify the programs that may be used to display help in the man
4398 format. See git-help(1).
4399 man.<tool>.cmd
4401 Specify the command to invoke the specified man viewer. The
4402 specified command is evaluated in shell with the man page passed as
4403 an argument. (See git-help(1).)
4404 man.<tool>.path
4406 Override the path for the given tool that may be used to display
4407 help in the man format. See git-help(1).
4408 merge.conflictStyle
4410 Specify the style in which conflicted hunks are written out to
4411 working tree files upon merge. The default is "merge", which shows
4412 a <<<<<<< conflict marker, changes made by one side, a =======
4413 marker, changes made by the other side, and then a >>>>>>> marker.
4414 An alternate style, "diff3", adds a ||||||| marker and the original
4415 text before the ======= marker. The "merge" style tends to produce
4416 smaller conflict regions than diff3, both because of the exclusion
4417 of the original text, and because when a subset of lines match on
4418 the two sides, they are just pulled out of the conflict region.
4419 Another alternate style, "zdiff3", is similar to diff3 but removes
4420 matching lines on the two sides from the conflict region when those
4421 matching lines appear near either the beginning or end of a
4422 conflict region.
4423 merge.defaultToUpstream
4425 If merge is called without any commit argument, merge the upstream
4426 branches configured for the current branch by using their last
4427 observed values stored in their remote-tracking branches. The
4428 values of the branch.<current branch>.merge that name the branches
4429 at the remote named by branch.<current branch>.remote are
4430 consulted, and then they are mapped via remote.<remote>.fetch to
4431 their corresponding remote-tracking branches, and the tips of these
4432 tracking branches are merged. Defaults to true.
4433 merge.ff
4435 By default, Git does not create an extra merge commit when merging
4436 a commit that is a descendant of the current commit. Instead, the
4437 tip of the current branch is fast-forwarded. When set to false,
4438 this variable tells Git to create an extra merge commit in such a
4439 case (equivalent to giving the --no-ff option from the command
4440 line). When set to only, only such fast-forward merges are allowed
4441 (equivalent to giving the --ff-only option from the command line).
4442 merge.verifySignatures
4444 If true, this is equivalent to the --verify-signatures command line
4445 option. See git-merge(1) for details.
4446 merge.branchdesc
4448 In addition to branch names, populate the log message with the
4449 branch description text associated with them. Defaults to false.
4450 merge.log
4452 In addition to branch names, populate the log message with at most
4453 the specified number of one-line descriptions from the actual
4454 commits that are being merged. Defaults to false, and true is a
4455 synonym for 20.
4456 merge.suppressDest
4458 By adding a glob that matches the names of integration branches to
4459 this multi-valued configuration variable, the default merge message
4460 computed for merges into these integration branches will omit "into
4461 <branch name>" from its title.
4462 An element with an empty value can be used to clear the list of
4464 globs accumulated from previous configuration entries. When there
4465 is no merge.suppressDest variable defined, the default value of
4466 master is used for backward compatibility.
4467 merge.renameLimit
4469 The number of files to consider in the exhaustive portion of rename
4470 detection during a merge. If not specified, defaults to the value
4471 of diff.renameLimit. If neither merge.renameLimit nor
4472 diff.renameLimit are specified, currently defaults to 7000. This
4473 setting has no effect if rename detection is turned off.
4474 merge.renames
4476 Whether Git detects renames. If set to "false", rename detection is
4477 disabled. If set to "true", basic rename detection is enabled.
4478 Defaults to the value of diff.renames.
4479 merge.directoryRenames
4481 Whether Git detects directory renames, affecting what happens at
4482 merge time to new files added to a directory on one side of history
4483 when that directory was renamed on the other side of history. If
4484 merge.directoryRenames is set to "false", directory rename
4485 detection is disabled, meaning that such new files will be left
4486 behind in the old directory. If set to "true", directory rename
4487 detection is enabled, meaning that such new files will be moved
4488 into the new directory. If set to "conflict", a conflict will be
4489 reported for such paths. If merge.renames is false,
4490 merge.directoryRenames is ignored and treated as false. Defaults to
4491 "conflict".
4492 merge.renormalize
4494 Tell Git that canonical representation of files in the repository
4495 has changed over time (e.g. earlier commits record text files with
4496 CRLF line endings, but recent ones use LF line endings). In such a
4497 repository, Git can convert the data recorded in commits to a
4498 canonical form before performing a merge to reduce unnecessary
4499 conflicts. For more information, see section "Merging branches with
4500 differing checkin/checkout attributes" in gitattributes(5).
4501 merge.stat
4503 Whether to print the diffstat between ORIG_HEAD and the merge
4504 result at the end of the merge. True by default.
4505 merge.autoStash
4507 When set to true, automatically create a temporary stash entry
4508 before the operation begins, and apply it after the operation ends.
4509 This means that you can run merge on a dirty worktree. However, use
4510 with care: the final stash application after a successful merge
4511 might result in non-trivial conflicts. This option can be
4512 overridden by the --no-autostash and --autostash options of git-
4513 merge(1). Defaults to false.
4514 merge.tool
4516 Controls which merge tool is used by git-mergetool(1). The list
4517 below shows the valid built-in values. Any other value is treated
4518 as a custom merge tool and requires that a corresponding
4519 mergetool.<tool>.cmd variable is defined.
4520 merge.guitool
4522 Controls which merge tool is used by git-mergetool(1) when the
4523 -g/--gui flag is specified. The list below shows the valid built-in
4524 values. Any other value is treated as a custom merge tool and
4525 requires that a corresponding mergetool.<guitool>.cmd variable is
4526 defined.
4527 araxis
4529 Use Araxis Merge (requires a graphical session)
4530 bc
4532 Use Beyond Compare (requires a graphical session)
4533 bc3
4535 Use Beyond Compare (requires a graphical session)
4536 bc4
4538 Use Beyond Compare (requires a graphical session)
4539 codecompare
4541 Use Code Compare (requires a graphical session)
4542 deltawalker
4544 Use DeltaWalker (requires a graphical session)
4545 diffmerge
4547 Use DiffMerge (requires a graphical session)
4548 diffuse
4550 Use Diffuse (requires a graphical session)
4551 ecmerge
4553 Use ECMerge (requires a graphical session)
4554 emerge
4556 Use Emacs' Emerge
4557 examdiff
4559 Use ExamDiff Pro (requires a graphical session)
4560 guiffy
4562 Use Guiffy’s Diff Tool (requires a graphical session)
4563 gvimdiff
4565 Use gVim (requires a graphical session) with a custom layout
4566 (see git help mergetool's BACKEND SPECIFIC HINTS section)
4567 gvimdiff1
4569 Use gVim (requires a graphical session) with a 2 panes layout
4570 (LOCAL and REMOTE)
4571 gvimdiff2
4573 Use gVim (requires a graphical session) with a 3 panes layout
4574 (LOCAL, MERGED and REMOTE)
4575 gvimdiff3
4577 Use gVim (requires a graphical session) where only the MERGED
4578 file is shown
4579 kdiff3
4581 Use KDiff3 (requires a graphical session)
4582 meld
4584 Use Meld (requires a graphical session) with optional auto
4585 merge (see git help mergetool's CONFIGURATION section)
4586 nvimdiff
4588 Use Neovim with a custom layout (see git help mergetool's
4589 BACKEND SPECIFIC HINTS section)
4590 nvimdiff1
4592 Use Neovim with a 2 panes layout (LOCAL and REMOTE)
4593 nvimdiff2
4595 Use Neovim with a 3 panes layout (LOCAL, MERGED and REMOTE)
4596 nvimdiff3
4598 Use Neovim where only the MERGED file is shown
4599 opendiff
4601 Use FileMerge (requires a graphical session)
4602 p4merge
4604 Use HelixCore P4Merge (requires a graphical session)
4605 smerge
4607 Use Sublime Merge (requires a graphical session)
4608 tkdiff
4610 Use TkDiff (requires a graphical session)
4611 tortoisemerge
4613 Use TortoiseMerge (requires a graphical session)
4614 vimdiff
4616 Use Vim with a custom layout (see git help mergetool's BACKEND
4617 SPECIFIC HINTS section)
4618 vimdiff1
4620 Use Vim with a 2 panes layout (LOCAL and REMOTE)
4621 vimdiff2
4623 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
4624 vimdiff3
4626 Use Vim where only the MERGED file is shown
4627 winmerge
4629 Use WinMerge (requires a graphical session)
4630 xxdiff
4632 Use xxdiff (requires a graphical session)
4633 merge.verbosity
4635 Controls the amount of output shown by the recursive merge
4636 strategy. Level 0 outputs nothing except a final error message if
4637 conflicts were detected. Level 1 outputs only conflicts, 2 outputs
4638 conflicts and file changes. Level 5 and above outputs debugging
4639 information. The default is level 2. Can be overridden by the
4640 GIT_MERGE_VERBOSITY environment variable.
4641 merge.<driver>.name
4643 Defines a human-readable name for a custom low-level merge driver.
4644 See gitattributes(5) for details.
4645 merge.<driver>.driver
4647 Defines the command that implements a custom low-level merge
4648 driver. See gitattributes(5) for details.
4649 merge.<driver>.recursive
4651 Names a low-level merge driver to be used when performing an
4652 internal merge between common ancestors. See gitattributes(5) for
4653 details.
4654 mergetool.<tool>.path
4656 Override the path for the given tool. This is useful in case your
4657 tool is not in the PATH.
4658 mergetool.<tool>.cmd
4660 Specify the command to invoke the specified merge tool. The
4661 specified command is evaluated in shell with the following
4662 variables available: BASE is the name of a temporary file
4663 containing the common base of the files to be merged, if available;
4664 LOCAL is the name of a temporary file containing the contents of
4665 the file on the current branch; REMOTE is the name of a temporary
4666 file containing the contents of the file from the branch being
4667 merged; MERGED contains the name of the file to which the merge
4668 tool should write the results of a successful merge.
4669 mergetool.<tool>.hideResolved
4671 Allows the user to override the global mergetool.hideResolved value
4672 for a specific tool. See mergetool.hideResolved for the full
4673 description.
4674 mergetool.<tool>.trustExitCode
4676 For a custom merge command, specify whether the exit code of the
4677 merge command can be used to determine whether the merge was
4678 successful. If this is not set to true then the merge target file
4679 timestamp is checked, and the merge is assumed to have been
4680 successful if the file has been updated; otherwise, the user is
4681 prompted to indicate the success of the merge.
4682 mergetool.meld.hasOutput
4684 Older versions of meld do not support the --output option. Git will
4685 attempt to detect whether meld supports --output by inspecting the
4686 output of meld --help. Configuring mergetool.meld.hasOutput will
4687 make Git skip these checks and use the configured value instead.
4688 Setting mergetool.meld.hasOutput to true tells Git to
4689 unconditionally use the --output option, and false avoids using
4690 --output.
4691 mergetool.meld.useAutoMerge
4693 When the --auto-merge is given, meld will merge all non-conflicting
4694 parts automatically, highlight the conflicting parts, and wait for
4695 user decision. Setting mergetool.meld.useAutoMerge to true tells
4696 Git to unconditionally use the --auto-merge option with meld.
4697 Setting this value to auto makes git detect whether --auto-merge is
4698 supported and will only use --auto-merge when available. A value of
4699 false avoids using --auto-merge altogether, and is the default
4700 value.
4701 mergetool.vimdiff.layout
4703 The vimdiff backend uses this variable to control how its split
4704 windows appear. Applies even if you are using Neovim (nvim) or gVim
4705 (gvim) as the merge tool. See BACKEND SPECIFIC HINTS section in
4706 git-mergetool(1). for details.
4707 mergetool.hideResolved
4709 During a merge, Git will automatically resolve as many conflicts as
4710 possible and write the MERGED file containing conflict markers
4711 around any conflicts that it cannot resolve; LOCAL and REMOTE
4712 normally represent the versions of the file from before Git’s
4713 conflict resolution. This flag causes LOCAL and REMOTE to be
4714 overwritten so that only the unresolved conflicts are presented to
4715 the merge tool. Can be configured per-tool via the
4716 mergetool.<tool>.hideResolved configuration variable. Defaults to
4717 false.
4718 mergetool.keepBackup
4720 After performing a merge, the original file with conflict markers
4721 can be saved as a file with a .orig extension. If this variable is
4722 set to false then this file is not preserved. Defaults to true
4723 (i.e. keep the backup files).
4724 mergetool.keepTemporaries
4726 When invoking a custom merge tool, Git uses a set of temporary
4727 files to pass to the tool. If the tool returns an error and this
4728 variable is set to true, then these temporary files will be
4729 preserved; otherwise, they will be removed after the tool has
4730 exited. Defaults to false.
4731 mergetool.writeToTemp
4733 Git writes temporary BASE, LOCAL, and REMOTE versions of
4734 conflicting files in the worktree by default. Git will attempt to
4735 use a temporary directory for these files when set true. Defaults
4736 to false.
4737 mergetool.prompt
4739 Prompt before each invocation of the merge resolution program.
4740 mergetool.guiDefault
4742 Set true to use the merge.guitool by default (equivalent to
4743 specifying the --gui argument), or auto to select merge.guitool or
4744 merge.tool depending on the presence of a DISPLAY environment
4745 variable value. The default is false, where the --gui argument must
4746 be provided explicitly for the merge.guitool to be used.
4747 notes.mergeStrategy
4749 Which merge strategy to choose by default when resolving notes
4750 conflicts. Must be one of manual, ours, theirs, union, or
4751 cat_sort_uniq. Defaults to manual. See the "NOTES MERGE STRATEGIES"
4752 section of git-notes(1) for more information on each strategy.
4753 This setting can be overridden by passing the --strategy option to
4755 git-notes(1).
4756 notes.<name>.mergeStrategy
4758 Which merge strategy to choose when doing a notes merge into
4759 refs/notes/<name>. This overrides the more general
4760 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
4761 git-notes(1) for more information on the available strategies.
4762 notes.displayRef
4764 Which ref (or refs, if a glob or specified more than once), in
4765 addition to the default set by core.notesRef or GIT_NOTES_REF, to
4766 read notes from when showing commit messages with the git log
4767 family of commands.
4768 This setting can be overridden with the GIT_NOTES_DISPLAY_REF
4770 environment variable, which must be a colon separated list of refs
4771 or globs.
4772 A warning will be issued for refs that do not exist, but a glob
4774 that does not match any refs is silently ignored.
4775 This setting can be disabled by the --no-notes option to the git
4777 log family of commands, or by the --notes=<ref> option accepted by
4778 those commands.
4779 The effective value of "core.notesRef" (possibly overridden by
4781 GIT_NOTES_REF) is also implicitly added to the list of refs to be
4782 displayed.
4783 notes.rewrite.<command>
4785 When rewriting commits with <command> (currently amend or rebase),
4786 if this variable is false, git will not copy notes from the
4787 original to the rewritten commit. Defaults to true. See also
4788 "notes.rewriteRef" below.
4789 This setting can be overridden with the GIT_NOTES_REWRITE_REF
4791 environment variable, which must be a colon separated list of refs
4792 or globs.
4793 notes.rewriteMode
4795 When copying notes during a rewrite (see the
4796 "notes.rewrite.<command>" option), determines what to do if the
4797 target commit already has a note. Must be one of overwrite,
4798 concatenate, cat_sort_uniq, or ignore. Defaults to concatenate.
4799 This setting can be overridden with the GIT_NOTES_REWRITE_MODE
4801 environment variable.
4802 notes.rewriteRef
4804 When copying notes during a rewrite, specifies the (fully
4805 qualified) ref whose notes should be copied. May be a glob, in
4806 which case notes in all matching refs will be copied. You may also
4807 specify this configuration several times.
4808 Does not have a default value; you must configure this variable to
4810 enable note rewriting. Set it to refs/notes/commits to enable
4811 rewriting for the default commit notes.
4812 Can be overridden with the GIT_NOTES_REWRITE_REF environment
4814 variable. See notes.rewrite.<command> above for a further
4815 description of its format.
4816 pack.window
4818 The size of the window used by git-pack-objects(1) when no window
4819 size is given on the command line. Defaults to 10.
4820 pack.depth
4822 The maximum delta depth used by git-pack-objects(1) when no maximum
4823 depth is given on the command line. Defaults to 50. Maximum value
4824 is 4095.
4825 pack.windowMemory
4827 The maximum size of memory that is consumed by each thread in git-
4828 pack-objects(1) for pack window memory when no limit is given on
4829 the command line. The value can be suffixed with "k", "m", or "g".
4830 When left unconfigured (or set explicitly to 0), there will be no
4831 limit.
4832 pack.compression
4834 An integer -1..9, indicating the compression level for objects in a
4835 pack file. -1 is the zlib default. 0 means no compression, and 1..9
4836 are various speed/size tradeoffs, 9 being slowest. If not set,
4837 defaults to core.compression. If that is not set, defaults to -1,
4838 the zlib default, which is "a default compromise between speed and
4839 compression (currently equivalent to level 6)."
4840 Note that changing the compression level will not automatically
4842 recompress all existing objects. You can force recompression by
4843 passing the -F option to git-repack(1).
4844 pack.allowPackReuse
4846 When true, and when reachability bitmaps are enabled, pack-objects
4847 will try to send parts of the bitmapped packfile verbatim. This can
4848 reduce memory and CPU usage to serve fetches, but might result in
4849 sending a slightly larger pack. Defaults to true.
4850 pack.island
4852 An extended regular expression configuring a set of delta islands.
4853 See "DELTA ISLANDS" in git-pack-objects(1) for details.
4854 pack.islandCore
4856 Specify an island name which gets to have its objects be packed
4857 first. This creates a kind of pseudo-pack at the front of one pack,
4858 so that the objects from the specified island are hopefully faster
4859 to copy into any pack that should be served to a user requesting
4860 these objects. In practice this means that the island specified
4861 should likely correspond to what is the most commonly cloned in the
4862 repo. See also "DELTA ISLANDS" in git-pack-objects(1).
4863 pack.deltaCacheSize
4865 The maximum memory in bytes used for caching deltas in git-pack-
4866 objects(1) before writing them out to a pack. This cache is used to
4867 speed up the writing object phase by not having to recompute the
4868 final delta result once the best match for all objects is found.
4869 Repacking large repositories on machines which are tight with
4870 memory might be badly impacted by this though, especially if this
4871 cache pushes the system into swapping. A value of 0 means no limit.
4872 The smallest size of 1 byte may be used to virtually disable this
4873 cache. Defaults to 256 MiB.
4874 pack.deltaCacheLimit
4876 The maximum size of a delta, that is cached in git-pack-objects(1).
4877 This cache is used to speed up the writing object phase by not
4878 having to recompute the final delta result once the best match for
4879 all objects is found. Defaults to 1000. Maximum value is 65535.
4880 pack.threads
4882 Specifies the number of threads to spawn when searching for best
4883 delta matches. This requires that git-pack-objects(1) be compiled
4884 with pthreads otherwise this option is ignored with a warning. This
4885 is meant to reduce packing time on multiprocessor machines. The
4886 required amount of memory for the delta search window is however
4887 multiplied by the number of threads. Specifying 0 will cause Git to
4888 auto-detect the number of CPUs and set the number of threads
4889 accordingly.
4890 pack.indexVersion
4892 Specify the default pack index version. Valid values are 1 for
4893 legacy pack index used by Git versions prior to 1.5.2, and 2 for
4894 the new pack index with capabilities for packs larger than 4 GB as
4895 well as proper protection against the repacking of corrupted packs.
4896 Version 2 is the default. Note that version 2 is enforced and this
4897 config option is ignored whenever the corresponding pack is larger
4898 than 2 GB.
4899 If you have an old Git that does not understand the version 2 *.idx
4901 file, cloning or fetching over a non-native protocol (e.g. "http")
4902 that will copy both *.pack file and corresponding *.idx file from
4903 the other side may give you a repository that cannot be accessed
4904 with your older version of Git. If the *.pack file is smaller than
4905 2 GB, however, you can use git-index-pack(1) on the *.pack file to
4906 regenerate the *.idx file.
4907 pack.packSizeLimit
4909 The maximum size of a pack. This setting only affects packing to a
4910 file when repacking, i.e. the git:// protocol is unaffected. It can
4911 be overridden by the --max-pack-size option of git-repack(1).
4912 Reaching this limit results in the creation of multiple packfiles.
4913 Note that this option is rarely useful, and may result in a larger
4915 total on-disk size (because Git will not store deltas between
4916 packs) and worse runtime performance (object lookup within multiple
4917 packs is slower than a single pack, and optimizations like
4918 reachability bitmaps cannot cope with multiple packs).
4919 If you need to actively run Git using smaller packfiles (e.g.,
4921 because your filesystem does not support large files), this option
4922 may help. But if your goal is to transmit a packfile over a medium
4923 that supports limited sizes (e.g., removable media that cannot
4924 store the whole repository), you are likely better off creating a
4925 single large packfile and splitting it using a generic multi-volume
4926 archive tool (e.g., Unix split).
4927 The minimum size allowed is limited to 1 MiB. The default is
4929 unlimited. Common unit suffixes of k, m, or g are supported.
4930 pack.useBitmaps
4932 When true, git will use pack bitmaps (if available) when packing to
4933 stdout (e.g., during the server side of a fetch). Defaults to true.
4934 You should not generally need to turn this off unless you are
4935 debugging pack bitmaps.
4936 pack.useBitmapBoundaryTraversal
4938 When true, Git will use an experimental algorithm for computing
4939 reachability queries with bitmaps. Instead of building up complete
4940 bitmaps for all of the negated tips and then OR-ing them together,
4941 consider negated tips with existing bitmaps as additive (i.e.
4942 OR-ing them into the result if they exist, ignoring them
4943 otherwise), and build up a bitmap at the boundary instead.
4944 When using this algorithm, Git may include too many objects as a
4946 result of not opening up trees belonging to certain UNINTERESTING
4947 commits. This inexactness matches the non-bitmap traversal
4948 algorithm.
4949 In many cases, this can provide a speed-up over the exact
4951 algorithm, particularly when there is poor bitmap coverage of the
4952 negated side of the query.
4953 pack.useSparse
4955 When true, git will default to using the --sparse option in git
4956 pack-objects when the --revs option is present. This algorithm only
4957 walks trees that appear in paths that introduce new objects. This
4958 can have significant performance benefits when computing a pack to
4959 send a small change. However, it is possible that extra objects are
4960 added to the pack-file if the included commits contain certain
4961 types of direct renames. Default is true.
4962 pack.preferBitmapTips
4964 When selecting which commits will receive bitmaps, prefer a commit
4965 at the tip of any reference that is a suffix of any value of this
4966 configuration over any other commits in the "selection window".
4967 Note that setting this configuration to refs/foo does not mean that
4969 the commits at the tips of refs/foo/bar and refs/foo/baz will
4970 necessarily be selected. This is because commits are selected for
4971 bitmaps from within a series of windows of variable length.
4972 If a commit at the tip of any reference which is a suffix of any
4974 value of this configuration is seen in a window, it is immediately
4975 given preference over any other commit in that window.
4976 pack.writeBitmaps (deprecated)
4978 This is a deprecated synonym for repack.writeBitmaps.
4979 pack.writeBitmapHashCache
4981 When true, git will include a "hash cache" section in the bitmap
4982 index (if one is written). This cache can be used to feed git’s
4983 delta heuristics, potentially leading to better deltas between
4984 bitmapped and non-bitmapped objects (e.g., when serving a fetch
4985 between an older, bitmapped pack and objects that have been pushed
4986 since the last gc). The downside is that it consumes 4 bytes per
4987 object of disk space. Defaults to true.
4988 When writing a multi-pack reachability bitmap, no new namehashes
4990 are computed; instead, any namehashes stored in an existing bitmap
4991 are permuted into their appropriate location when writing a new
4992 bitmap.
4993 pack.writeBitmapLookupTable
4995 When true, Git will include a "lookup table" section in the bitmap
4996 index (if one is written). This table is used to defer loading
4997 individual bitmaps as late as possible. This can be beneficial in
4998 repositories that have relatively large bitmap indexes. Defaults to
4999 false.
5000 pack.readReverseIndex
5002 When true, git will read any .rev file(s) that may be available
5003 (see: gitformat-pack(5)). When false, the reverse index will be
5004 generated from scratch and stored in memory. Defaults to true.
5005 pack.writeReverseIndex
5007 When true, git will write a corresponding .rev file (see:
5008 gitformat-pack(5)) for each new packfile that it writes in all
5009 places except for git-fast-import(1) and in the bulk checkin
5010 mechanism. Defaults to true.
5011 pager.<cmd>
5013 If the value is boolean, turns on or off pagination of the output
5014 of a particular Git subcommand when writing to a tty. Otherwise,
5015 turns on pagination for the subcommand using the pager specified by
5016 the value of pager.<cmd>. If --paginate or --no-pager is specified
5017 on the command line, it takes precedence over this option. To
5018 disable pagination for all commands, set core.pager or GIT_PAGER to
5019 cat.
5020 pretty.<name>
5022 Alias for a --pretty= format string, as specified in git-log(1).
5023 Any aliases defined here can be used just as the built-in pretty
5024 formats could. For example, running git config pretty.changelog
5025 "format:* %H %s" would cause the invocation git log
5026 --pretty=changelog to be equivalent to running git log
5027 "--pretty=format:* %H %s". Note that an alias with the same name as
5028 a built-in format will be silently ignored.
5029 protocol.allow
5031 If set, provide a user defined default policy for all protocols
5032 which don’t explicitly have a policy (protocol.<name>.allow). By
5033 default, if unset, known-safe protocols (http, https, git, ssh)
5034 have a default policy of always, known-dangerous protocols (ext)
5035 have a default policy of never, and all other protocols (including
5036 file) have a default policy of user. Supported policies:
5037 • always - protocol is always able to be used.
5039 • never - protocol is never able to be used.
5041 • user - protocol is only able to be used when
5043 GIT_PROTOCOL_FROM_USER is either unset or has a value of 1.
5044 This policy should be used when you want a protocol to be
5045 directly usable by the user but don’t want it used by commands
5046 which execute clone/fetch/push commands without user input,
5047 e.g. recursive submodule initialization.
5048 protocol.<name>.allow
5050 Set a policy to be used by protocol <name> with clone/fetch/push
5051 commands. See protocol.allow above for the available policies.
5052 The protocol names currently used by git are:
5054 • file: any local file-based path (including file:// URLs, or
5056 local paths)
5057 • git: the anonymous git protocol over a direct TCP connection
5059 (or proxy, if configured)
5060 • ssh: git over ssh (including host:path syntax, ssh://, etc).
5062 • http: git over http, both "smart http" and "dumb http". Note
5064 that this does not include https; if you want to configure
5065 both, you must do so individually.
5066 • any external helpers are named by their protocol (e.g., use hg
5068 to allow the git-remote-hg helper)
5069 protocol.version
5071 If set, clients will attempt to communicate with a server using the
5072 specified protocol version. If the server does not support it,
5073 communication falls back to version 0. If unset, the default is 2.
5074 Supported versions:
5075 • 0 - the original wire protocol.
5077 • 1 - the original wire protocol with the addition of a version
5079 string in the initial response from the server.
5080 • 2 - Wire protocol version 2, see gitprotocol-v2(5).
5082 pull.ff
5084 By default, Git does not create an extra merge commit when merging
5085 a commit that is a descendant of the current commit. Instead, the
5086 tip of the current branch is fast-forwarded. When set to false,
5087 this variable tells Git to create an extra merge commit in such a
5088 case (equivalent to giving the --no-ff option from the command
5089 line). When set to only, only such fast-forward merges are allowed
5090 (equivalent to giving the --ff-only option from the command line).
5091 This setting overrides merge.ff when pulling.
5092 pull.rebase
5094 When true, rebase branches on top of the fetched branch, instead of
5095 merging the default branch from the default remote when "git pull"
5096 is run. See "branch.<name>.rebase" for setting this on a per-branch
5097 basis.
5098 When merges (or just m), pass the --rebase-merges option to git
5100 rebase so that the local merge commits are included in the rebase
5101 (see git-rebase(1) for details).
5102 When the value is interactive (or just i), the rebase is run in
5104 interactive mode.
5105 NOTE: this is a possibly dangerous operation; do not use it unless
5107 you understand the implications (see git-rebase(1) for details).
5108 pull.octopus
5110 The default merge strategy to use when pulling multiple branches at
5111 once.
5112 pull.twohead
5114 The default merge strategy to use when pulling a single branch.
5115 push.autoSetupRemote
5117 If set to "true" assume --set-upstream on default push when no
5118 upstream tracking exists for the current branch; this option takes
5119 effect with push.default options simple, upstream, and current. It
5120 is useful if by default you want new branches to be pushed to the
5121 default remote (like the behavior of push.default=current) and you
5122 also want the upstream tracking to be set. Workflows most likely to
5123 benefit from this option are simple central workflows where all
5124 branches are expected to have the same name on the remote.
5125 push.default
5127 Defines the action git push should take if no refspec is given
5128 (whether from the command-line, config, or elsewhere). Different
5129 values are well-suited for specific workflows; for instance, in a
5130 purely central workflow (i.e. the fetch source is equal to the push
5131 destination), upstream is probably what you want. Possible values
5132 are:
5133 • nothing - do not push anything (error out) unless a refspec is
5135 given. This is primarily meant for people who want to avoid
5136 mistakes by always being explicit.
5137 • current - push the current branch to update a branch with the
5139 same name on the receiving end. Works in both central and
5140 non-central workflows.
5141 • upstream - push the current branch back to the branch whose
5143 changes are usually integrated into the current branch (which
5144 is called @{upstream}). This mode only makes sense if you are
5145 pushing to the same repository you would normally pull from
5146 (i.e. central workflow).
5147 • tracking - This is a deprecated synonym for upstream.
5149 • simple - push the current branch with the same name on the
5151 remote.
5152 If you are working on a centralized workflow (pushing to the
5154 same repository you pull from, which is typically origin), then
5155 you need to configure an upstream branch with the same name.
5156 This mode is the default since Git 2.0, and is the safest
5158 option suited for beginners.
5159 • matching - push all branches having the same name on both ends.
5161 This makes the repository you are pushing to remember the set
5162 of branches that will be pushed out (e.g. if you always push
5163 maint and master there and no other branches, the repository
5164 you push to will have these two branches, and your local maint
5165 and master will be pushed there).
5166 To use this mode effectively, you have to make sure all the
5168 branches you would push out are ready to be pushed out before
5169 running git push, as the whole point of this mode is to allow
5170 you to push all of the branches in one go. If you usually
5171 finish work on only one branch and push out the result, while
5172 other branches are unfinished, this mode is not for you. Also
5173 this mode is not suitable for pushing into a shared central
5174 repository, as other people may add new branches there, or
5175 update the tip of existing branches outside your control.
5176 This used to be the default, but not since Git 2.0 (simple is
5178 the new default).
5179 push.followTags
5181 If set to true, enable --follow-tags option by default. You may
5182 override this configuration at time of push by specifying
5183 --no-follow-tags.
5184 push.gpgSign
5186 May be set to a boolean value, or the string if-asked. A true value
5187 causes all pushes to be GPG signed, as if --signed is passed to
5188 git-push(1). The string if-asked causes pushes to be signed if the
5189 server supports it, as if --signed=if-asked is passed to git push.
5190 A false value may override a value from a lower-priority config
5191 file. An explicit command-line flag always overrides this config
5192 option.
5193 push.pushOption
5195 When no --push-option=<option> argument is given from the command
5196 line, git push behaves as if each <value> of this variable is given
5197 as --push-option=<value>.
5198 This is a multi-valued variable, and an empty value can be used in
5200 a higher priority configuration file (e.g. .git/config in a
5201 repository) to clear the values inherited from a lower priority
5202 configuration files (e.g. $HOME/.gitconfig).
5203 Example:
5205 /etc/gitconfig
5207 push.pushoption = a
5208 push.pushoption = b
5209 ~/.gitconfig
5211 push.pushoption = c
5212 repo/.git/config
5214 push.pushoption =
5215 push.pushoption = b
5216 This will result in only b (a and c are cleared).
5218 push.recurseSubmodules
5220 May be "check", "on-demand", "only", or "no", with the same
5221 behavior as that of "push --recurse-submodules". If not set, no is
5222 used by default, unless submodule.recurse is set (in which case a
5223 true value means on-demand).
5224 push.useForceIfIncludes
5226 If set to "true", it is equivalent to specifying
5227 --force-if-includes as an option to git-push(1) in the command
5228 line. Adding --no-force-if-includes at the time of push overrides
5229 this configuration setting.
5230 push.negotiate
5232 If set to "true", attempt to reduce the size of the packfile sent
5233 by rounds of negotiation in which the client and the server attempt
5234 to find commits in common. If "false", Git will rely solely on the
5235 server’s ref advertisement to find commits in common.
5236 push.useBitmaps
5238 If set to "false", disable use of bitmaps for "git push" even if
5239 pack.useBitmaps is "true", without preventing other git operations
5240 from using bitmaps. Default is true.
5241 rebase.backend
5243 Default backend to use for rebasing. Possible choices are apply or
5244 merge. In the future, if the merge backend gains all remaining
5245 capabilities of the apply backend, this setting may become unused.
5246 rebase.stat
5248 Whether to show a diffstat of what changed upstream since the last
5249 rebase. False by default.
5250 rebase.autoSquash
5252 If set to true enable --autosquash option by default.
5253 rebase.autoStash
5255 When set to true, automatically create a temporary stash entry
5256 before the operation begins, and apply it after the operation ends.
5257 This means that you can run rebase on a dirty worktree. However,
5258 use with care: the final stash application after a successful
5259 rebase might result in non-trivial conflicts. This option can be
5260 overridden by the --no-autostash and --autostash options of git-
5261 rebase(1). Defaults to false.
5262 rebase.updateRefs
5264 If set to true enable --update-refs option by default.
5265 rebase.missingCommitsCheck
5267 If set to "warn", git rebase -i will print a warning if some
5268 commits are removed (e.g. a line was deleted), however the rebase
5269 will still proceed. If set to "error", it will print the previous
5270 warning and stop the rebase, git rebase --edit-todo can then be
5271 used to correct the error. If set to "ignore", no checking is done.
5272 To drop a commit without warning or error, use the drop command in
5273 the todo list. Defaults to "ignore".
5274 rebase.instructionFormat
5276 A format string, as specified in git-log(1), to be used for the
5277 todo list during an interactive rebase. The format will
5278 automatically have the long commit hash prepended to the format.
5279 rebase.abbreviateCommands
5281 If set to true, git rebase will use abbreviated command names in
5282 the todo list resulting in something like this:
5283 p deadbee The oneline of the commit
5285 p fa1afe1 The oneline of the next commit
5286 ...
5287 instead of:
5289 pick deadbee The oneline of the commit
5291 pick fa1afe1 The oneline of the next commit
5292 ...
5293 Defaults to false.
5295 rebase.rescheduleFailedExec
5297 Automatically reschedule exec commands that failed. This only makes
5298 sense in interactive mode (or when an --exec option was provided).
5299 This is the same as specifying the --reschedule-failed-exec option.
5300 rebase.forkPoint
5302 If set to false set --no-fork-point option by default.
5303 rebase.rebaseMerges
5305 Whether and how to set the --rebase-merges option by default. Can
5306 be rebase-cousins, no-rebase-cousins, or a boolean. Setting to true
5307 or to no-rebase-cousins is equivalent to
5308 --rebase-merges=no-rebase-cousins, setting to rebase-cousins is
5309 equivalent to --rebase-merges=rebase-cousins, and setting to false
5310 is equivalent to --no-rebase-merges. Passing --rebase-merges on the
5311 command line, with or without an argument, overrides any
5312 rebase.rebaseMerges configuration.
5313 rebase.maxLabelLength
5315 When generating label names from commit subjects, truncate the
5316 names to this length. By default, the names are truncated to a
5317 little less than NAME_MAX (to allow e.g. .lock files to be written
5318 for the corresponding loose refs).
5319 receive.advertiseAtomic
5321 By default, git-receive-pack will advertise the atomic push
5322 capability to its clients. If you don’t want to advertise this
5323 capability, set this variable to false.
5324 receive.advertisePushOptions
5326 When set to true, git-receive-pack will advertise the push options
5327 capability to its clients. False by default.
5328 receive.autogc
5330 By default, git-receive-pack will run "git-gc --auto" after
5331 receiving data from git-push and updating refs. You can stop it by
5332 setting this variable to false.
5333 receive.certNonceSeed
5335 By setting this variable to a string, git receive-pack will accept
5336 a git push --signed and verify it by using a "nonce" protected by
5337 HMAC using this string as a secret key.
5338 receive.certNonceSlop
5340 When a git push --signed sends a push certificate with a "nonce"
5341 that was issued by a receive-pack serving the same repository
5342 within this many seconds, export the "nonce" found in the
5343 certificate to GIT_PUSH_CERT_NONCE to the hooks (instead of what
5344 the receive-pack asked the sending side to include). This may allow
5345 writing checks in pre-receive and post-receive a bit easier.
5346 Instead of checking GIT_PUSH_CERT_NONCE_SLOP environment variable
5347 that records by how many seconds the nonce is stale to decide if
5348 they want to accept the certificate, they only can check
5349 GIT_PUSH_CERT_NONCE_STATUS is OK.
5350 receive.fsckObjects
5352 If it is set to true, git-receive-pack will check all received
5353 objects. See transfer.fsckObjects for what’s checked. Defaults to
5354 false. If not set, the value of transfer.fsckObjects is used
5355 instead.
5356 receive.fsck.<msg-id>
5358 Acts like fsck.<msg-id>, but is used by git-receive-pack(1) instead
5359 of git-fsck(1). See the fsck.<msg-id> documentation for details.
5360 receive.fsck.skipList
5362 Acts like fsck.skipList, but is used by git-receive-pack(1) instead
5363 of git-fsck(1). See the fsck.skipList documentation for details.
5364 receive.keepAlive
5366 After receiving the pack from the client, receive-pack may produce
5367 no output (if --quiet was specified) while processing the pack,
5368 causing some networks to drop the TCP connection. With this option
5369 set, if receive-pack does not transmit any data in this phase for
5370 receive.keepAlive seconds, it will send a short keepalive packet.
5371 The default is 5 seconds; set to 0 to disable keepalives entirely.
5372 receive.unpackLimit
5374 If the number of objects received in a push is below this limit
5375 then the objects will be unpacked into loose object files. However
5376 if the number of received objects equals or exceeds this limit then
5377 the received pack will be stored as a pack, after adding any
5378 missing delta bases. Storing the pack from a push can make the push
5379 operation complete faster, especially on slow filesystems. If not
5380 set, the value of transfer.unpackLimit is used instead.
5381 receive.maxInputSize
5383 If the size of the incoming pack stream is larger than this limit,
5384 then git-receive-pack will error out, instead of accepting the pack
5385 file. If not set or set to 0, then the size is unlimited.
5386 receive.denyDeletes
5388 If set to true, git-receive-pack will deny a ref update that
5389 deletes the ref. Use this to prevent such a ref deletion via a
5390 push.
5391 receive.denyDeleteCurrent
5393 If set to true, git-receive-pack will deny a ref update that
5394 deletes the currently checked out branch of a non-bare repository.
5395 receive.denyCurrentBranch
5397 If set to true or "refuse", git-receive-pack will deny a ref update
5398 to the currently checked out branch of a non-bare repository. Such
5399 a push is potentially dangerous because it brings the HEAD out of
5400 sync with the index and working tree. If set to "warn", print a
5401 warning of such a push to stderr, but allow the push to proceed. If
5402 set to false or "ignore", allow such pushes with no message.
5403 Defaults to "refuse".
5404 Another option is "updateInstead" which will update the working
5406 tree if pushing into the current branch. This option is intended
5407 for synchronizing working directories when one side is not easily
5408 accessible via interactive ssh (e.g. a live web site, hence the
5409 requirement that the working directory be clean). This mode also
5410 comes in handy when developing inside a VM to test and fix code on
5411 different Operating Systems.
5412 By default, "updateInstead" will refuse the push if the working
5414 tree or the index have any difference from the HEAD, but the
5415 push-to-checkout hook can be used to customize this. See
5416 githooks(5).
5417 receive.denyNonFastForwards
5419 If set to true, git-receive-pack will deny a ref update which is
5420 not a fast-forward. Use this to prevent such an update via a push,
5421 even if that push is forced. This configuration variable is set
5422 when initializing a shared repository.
5423 receive.hideRefs
5425 This variable is the same as transfer.hideRefs, but applies only to
5426 receive-pack (and so affects pushes, but not fetches). An attempt
5427 to update or delete a hidden ref by git push is rejected.
5428 receive.procReceiveRefs
5430 This is a multi-valued variable that defines reference prefixes to
5431 match the commands in receive-pack. Commands matching the prefixes
5432 will be executed by an external hook "proc-receive", instead of the
5433 internal execute_commands function. If this variable is not
5434 defined, the "proc-receive" hook will never be used, and all
5435 commands will be executed by the internal execute_commands
5436 function.
5437 For example, if this variable is set to "refs/for", pushing to
5439 reference such as "refs/for/master" will not create or update a
5440 reference named "refs/for/master", but may create or update a pull
5441 request directly by running the hook "proc-receive".
5442 Optional modifiers can be provided in the beginning of the value to
5444 filter commands for specific actions: create (a), modify (m),
5445 delete (d). A ! can be included in the modifiers to negate the
5446 reference prefix entry. E.g.:
5447 git config --system --add receive.procReceiveRefs ad:refs/heads
5449 git config --system --add receive.procReceiveRefs !:refs/heads
5450 receive.updateServerInfo
5452 If set to true, git-receive-pack will run git-update-server-info
5453 after receiving data from git-push and updating refs.
5454 receive.shallowUpdate
5456 If set to true, .git/shallow can be updated when new refs require
5457 new shallow roots. Otherwise those refs are rejected.
5458 remote.pushDefault
5460 The remote to push to by default. Overrides branch.<name>.remote
5461 for all branches, and is overridden by branch.<name>.pushRemote for
5462 specific branches.
5463 remote.<name>.url
5465 The URL of a remote repository. See git-fetch(1) or git-push(1).
5466 remote.<name>.pushurl
5468 The push URL of a remote repository. See git-push(1).
5469 remote.<name>.proxy
5471 For remotes that require curl (http, https and ftp), the URL to the
5472 proxy to use for that remote. Set to the empty string to disable
5473 proxying for that remote.
5474 remote.<name>.proxyAuthMethod
5476 For remotes that require curl (http, https and ftp), the method to
5477 use for authenticating against the proxy in use (probably set in
5478 remote.<name>.proxy). See http.proxyAuthMethod.
5479 remote.<name>.fetch
5481 The default set of "refspec" for git-fetch(1). See git-fetch(1).
5482 remote.<name>.push
5484 The default set of "refspec" for git-push(1). See git-push(1).
5485 remote.<name>.mirror
5487 If true, pushing to this remote will automatically behave as if the
5488 --mirror option was given on the command line.
5489 remote.<name>.skipDefaultUpdate
5491 If true, this remote will be skipped by default when updating using
5492 git-fetch(1) or the update subcommand of git-remote(1).
5493 remote.<name>.skipFetchAll
5495 If true, this remote will be skipped by default when updating using
5496 git-fetch(1) or the update subcommand of git-remote(1).
5497 remote.<name>.receivepack
5499 The default program to execute on the remote side when pushing. See
5500 option --receive-pack of git-push(1).
5501 remote.<name>.uploadpack
5503 The default program to execute on the remote side when fetching.
5504 See option --upload-pack of git-fetch-pack(1).
5505 remote.<name>.tagOpt
5507 Setting this value to --no-tags disables automatic tag following
5508 when fetching from remote <name>. Setting it to --tags will fetch
5509 every tag from remote <name>, even if they are not reachable from
5510 remote branch heads. Passing these flags directly to git-fetch(1)
5511 can override this setting. See options --tags and --no-tags of git-
5512 fetch(1).
5513 remote.<name>.vcs
5515 Setting this to a value <vcs> will cause Git to interact with the
5516 remote with the git-remote-<vcs> helper.
5517 remote.<name>.prune
5519 When set to true, fetching from this remote by default will also
5520 remove any remote-tracking references that no longer exist on the
5521 remote (as if the --prune option was given on the command line).
5522 Overrides fetch.prune settings, if any.
5523 remote.<name>.pruneTags
5525 When set to true, fetching from this remote by default will also
5526 remove any local tags that no longer exist on the remote if pruning
5527 is activated in general via remote.<name>.prune, fetch.prune or
5528 --prune. Overrides fetch.pruneTags settings, if any.
5529 See also remote.<name>.prune and the PRUNING section of git-
5531 fetch(1).
5532 remote.<name>.promisor
5534 When set to true, this remote will be used to fetch promisor
5535 objects.
5536 remote.<name>.partialclonefilter
5538 The filter that will be applied when fetching from this promisor
5539 remote. Changing or clearing this value will only affect fetches
5540 for new commits. To fetch associated objects for commits already
5541 present in the local object database, use the --refetch option of
5542 git-fetch(1).
5543 remotes.<group>
5545 The list of remotes which are fetched by "git remote update
5546 <group>". See git-remote(1).
5547 repack.useDeltaBaseOffset
5549 By default, git-repack(1) creates packs that use delta-base offset.
5550 If you need to share your repository with Git older than version
5551 1.4.4, either directly or via a dumb protocol such as http, then
5552 you need to set this option to "false" and repack. Access from old
5553 Git versions over the native protocol are unaffected by this
5554 option.
5555 repack.packKeptObjects
5557 If set to true, makes git repack act as if --pack-kept-objects was
5558 passed. See git-repack(1) for details. Defaults to false normally,
5559 but true if a bitmap index is being written (either via
5560 --write-bitmap-index or repack.writeBitmaps).
5561 repack.useDeltaIslands
5563 If set to true, makes git repack act as if --delta-islands was
5564 passed. Defaults to false.
5565 repack.writeBitmaps
5567 When true, git will write a bitmap index when packing all objects
5568 to disk (e.g., when git repack -a is run). This index can speed up
5569 the "counting objects" phase of subsequent packs created for clones
5570 and fetches, at the cost of some disk space and extra time spent on
5571 the initial repack. This has no effect if multiple packfiles are
5572 created. Defaults to true on bare repos, false otherwise.
5573 repack.updateServerInfo
5575 If set to false, git-repack(1) will not run git-update-server-
5576 info(1). Defaults to true. Can be overridden when true by the -n
5577 option of git-repack(1).
5578 repack.cruftWindow, repack.cruftWindowMemory, repack.cruftDepth,
5580 repack.cruftThreads
5581 Parameters used by git-pack-objects(1) when generating a cruft pack
5582 and the respective parameters are not given over the command line.
5583 See similarly named pack.* configuration variables for defaults
5584 and meaning.
5585 rerere.autoUpdate
5587 When set to true, git-rerere updates the index with the resulting
5588 contents after it cleanly resolves conflicts using previously
5589 recorded resolutions. Defaults to false.
5590 rerere.enabled
5592 Activate recording of resolved conflicts, so that identical
5593 conflict hunks can be resolved automatically, should they be
5594 encountered again. By default, git-rerere(1) is enabled if there is
5595 an rr-cache directory under the $GIT_DIR, e.g. if "rerere" was
5596 previously used in the repository.
5597 revert.reference
5599 Setting this variable to true makes git revert behave as if the
5600 --reference option is given.
5601 safe.bareRepository
5603 Specifies which bare repositories Git will work with. The currently
5604 supported values are:
5605 • all: Git works with all bare repositories. This is the default.
5607 • explicit: Git only works with bare repositories specified via
5609 the top-level --git-dir command-line option, or the GIT_DIR
5610 environment variable (see git(1)).
5611 If you do not use bare repositories in your workflow, then it
5613 may be beneficial to set safe.bareRepository to explicit in
5614 your global config. This will protect you from attacks that
5615 involve cloning a repository that contains a bare repository
5616 and running a Git command within that directory.
5617 This config setting is only respected in protected
5619 configuration (see the section called “SCOPES”). This prevents
5620 untrusted repositories from tampering with this value.
5621 safe.directory
5623 These config entries specify Git-tracked directories that are
5624 considered safe even if they are owned by someone other than the
5625 current user. By default, Git will refuse to even parse a Git
5626 config of a repository owned by someone else, let alone run its
5627 hooks, and this config setting allows users to specify exceptions,
5628 e.g. for intentionally shared repositories (see the --shared option
5629 in git-init(1)).
5630 This is a multi-valued setting, i.e. you can add more than one
5632 directory via git config --add. To reset the list of safe
5633 directories (e.g. to override any such directories specified in the
5634 system config), add a safe.directory entry with an empty value.
5635 This config setting is only respected in protected configuration
5637 (see the section called “SCOPES”). This prevents untrusted
5638 repositories from tampering with this value.
5639 The value of this setting is interpolated, i.e. ~/<path> expands
5641 to a path relative to the home directory and %(prefix)/<path>
5642 expands to a path relative to Git’s (runtime) prefix.
5643 To completely opt-out of this security check, set safe.directory to
5645 the string *. This will allow all repositories to be treated as if
5646 their directory was listed in the safe.directory list. If
5647 safe.directory=* is set in system config and you want to re-enable
5648 this protection, then initialize your list with an empty value
5649 before listing the repositories that you deem safe.
5650 As explained, Git only allows you to access repositories owned by
5652 yourself, i.e. the user who is running Git, by default. When Git is
5653 running as root in a non Windows platform that provides sudo,
5654 however, git checks the SUDO_UID environment variable that sudo
5655 creates and will allow access to the uid recorded as its value in
5656 addition to the id from root. This is to make it easy to perform a
5657 common sequence during installation "make && sudo make install". A
5658 git process running under sudo runs as root but the sudo command
5659 exports the environment variable to record which id the original
5660 user has. If that is not what you would prefer and want git to only
5661 trust repositories that are owned by root instead, then you can
5662 remove the SUDO_UID variable from root’s environment before
5663 invoking git.
5664 sendemail.identity
5666 A configuration identity. When given, causes values in the
5667 sendemail.<identity> subsection to take precedence over values in
5668 the sendemail section. The default identity is the value of
5669 sendemail.identity.
5670 sendemail.smtpEncryption
5672 See git-send-email(1) for description. Note that this setting is
5673 not subject to the identity mechanism.
5674 sendemail.smtpsslcertpath
5676 Path to ca-certificates (either a directory or a single file). Set
5677 it to an empty string to disable certificate verification.
5678 sendemail.<identity>.*
5680 Identity-specific versions of the sendemail.* parameters found
5681 below, taking precedence over those when this identity is selected,
5682 through either the command-line or sendemail.identity.
5683 sendemail.multiEdit
5685 If true (default), a single editor instance will be spawned to edit
5686 files you have to edit (patches when --annotate is used, and the
5687 summary when --compose is used). If false, files will be edited one
5688 after the other, spawning a new editor each time.
5689 sendemail.confirm
5691 Sets the default for whether to confirm before sending. Must be one
5692 of always, never, cc, compose, or auto. See --confirm in the git-
5693 send-email(1) documentation for the meaning of these values.
5694 sendemail.aliasesFile
5696 To avoid typing long email addresses, point this to one or more
5697 email aliases files. You must also supply sendemail.aliasFileType.
5698 sendemail.aliasFileType
5700 Format of the file(s) specified in sendemail.aliasesFile. Must be
5701 one of mutt, mailrc, pine, elm, gnus, or sendmail.
5702 What an alias file in each format looks like can be found in the
5704 documentation of the email program of the same name. The
5705 differences and limitations from the standard formats are described
5706 below:
5707 sendmail
5709 • Quoted aliases and quoted addresses are not supported:
5711 lines that contain a " symbol are ignored.
5712 • Redirection to a file (/path/name) or pipe (|command) is
5714 not supported.
5715 • File inclusion (:include: /path/name) is not supported.
5717 • Warnings are printed on the standard error output for any
5719 explicitly unsupported constructs, and any other lines that
5720 are not recognized by the parser.
5721 sendemail.annotate, sendemail.bcc, sendemail.cc, sendemail.ccCmd,
5723 sendemail.chainReplyTo, sendemail.envelopeSender, sendemail.from,
5724 sendemail.headerCmd, sendemail.signedoffbycc, sendemail.smtpPass,
5725 sendemail.suppresscc, sendemail.suppressFrom, sendemail.to,
5726 sendemail.tocmd, sendemail.smtpDomain, sendemail.smtpServer,
5727 sendemail.smtpServerPort, sendemail.smtpServerOption,
5728 sendemail.smtpUser, sendemail.thread, sendemail.transferEncoding,
5729 sendemail.validate, sendemail.xmailer
5730 These configuration variables all provide a default for git-send-
5731 email(1) command-line options. See its documentation for details.
5732 sendemail.signedoffcc (deprecated)
5734 Deprecated alias for sendemail.signedoffbycc.
5735 sendemail.smtpBatchSize
5737 Number of messages to be sent per connection, after that a relogin
5738 will happen. If the value is 0 or undefined, send all messages in
5739 one connection. See also the --batch-size option of git-send-
5740 email(1).
5741 sendemail.smtpReloginDelay
5743 Seconds to wait before reconnecting to the smtp server. See also
5744 the --relogin-delay option of git-send-email(1).
5745 sendemail.forbidSendmailVariables
5747 To avoid common misconfiguration mistakes, git-send-email(1) will
5748 abort with a warning if any configuration options for "sendmail"
5749 exist. Set this variable to bypass the check.
5750 sequence.editor
5752 Text editor used by git rebase -i for editing the rebase
5753 instruction file. The value is meant to be interpreted by the shell
5754 when it is used. It can be overridden by the GIT_SEQUENCE_EDITOR
5755 environment variable. When not configured, the default commit
5756 message editor is used instead.
5757 showBranch.default
5759 The default set of branches for git-show-branch(1). See git-show-
5760 branch(1).
5761 sparse.expectFilesOutsideOfPatterns
5763 Typically with sparse checkouts, files not matching any sparsity
5764 patterns are marked with a SKIP_WORKTREE bit in the index and are
5765 missing from the working tree. Accordingly, Git will ordinarily
5766 check whether files with the SKIP_WORKTREE bit are in fact present
5767 in the working tree contrary to expectations. If Git finds any, it
5768 marks those paths as present by clearing the relevant SKIP_WORKTREE
5769 bits. This option can be used to tell Git that such
5770 present-despite-skipped files are expected and to stop checking for
5771 them.
5772 The default is false, which allows Git to automatically recover
5774 from the list of files in the index and working tree falling out of
5775 sync.
5776 Set this to true if you are in a setup where some external factor
5778 relieves Git of the responsibility for maintaining the consistency
5779 between the presence of working tree files and sparsity patterns.
5780 For example, if you have a Git-aware virtual file system that has a
5781 robust mechanism for keeping the working tree and the sparsity
5782 patterns up to date based on access patterns.
5783 Regardless of this setting, Git does not check for
5785 present-despite-skipped files unless sparse checkout is enabled, so
5786 this config option has no effect unless core.sparseCheckout is
5787 true.
5788 splitIndex.maxPercentChange
5790 When the split index feature is used, this specifies the percent of
5791 entries the split index can contain compared to the total number of
5792 entries in both the split index and the shared index before a new
5793 shared index is written. The value should be between 0 and 100. If
5794 the value is 0, then a new shared index is always written; if it is
5795 100, a new shared index is never written. By default, the value is
5796 20, so a new shared index is written if the number of entries in
5797 the split index would be greater than 20 percent of the total
5798 number of entries. See git-update-index(1).
5799 splitIndex.sharedIndexExpire
5801 When the split index feature is used, shared index files that were
5802 not modified since the time this variable specifies will be removed
5803 when a new shared index file is created. The value "now" expires
5804 all entries immediately, and "never" suppresses expiration
5805 altogether. The default value is "2.weeks.ago". Note that a shared
5806 index file is considered modified (for the purpose of expiration)
5807 each time a new split-index file is either created based on it or
5808 read from it. See git-update-index(1).
5809 ssh.variant
5811 By default, Git determines the command line arguments to use based
5812 on the basename of the configured SSH command (configured using the
5813 environment variable GIT_SSH or GIT_SSH_COMMAND or the config
5814 setting core.sshCommand). If the basename is unrecognized, Git will
5815 attempt to detect support of OpenSSH options by first invoking the
5816 configured SSH command with the -G (print configuration) option and
5817 will subsequently use OpenSSH options (if that is successful) or no
5818 options besides the host and remote command (if it fails).
5819 The config variable ssh.variant can be set to override this
5821 detection. Valid values are ssh (to use OpenSSH options), plink,
5822 putty, tortoiseplink, simple (no options except the host and remote
5823 command). The default auto-detection can be explicitly requested
5824 using the value auto. Any other value is treated as ssh. This
5825 setting can also be overridden via the environment variable
5826 GIT_SSH_VARIANT.
5827 The current command-line parameters used for each variant are as
5829 follows:
5830 • ssh - [-p port] [-4] [-6] [-o option] [username@]host command
5832 • simple - [username@]host command
5834 • plink or putty - [-P port] [-4] [-6] [username@]host command
5836 • tortoiseplink - [-P port] [-4] [-6] -batch [username@]host
5838 command
5839 Except for the simple variant, command-line parameters are likely
5841 to change as git gains new features.
5842 status.relativePaths
5844 By default, git-status(1) shows paths relative to the current
5845 directory. Setting this variable to false shows paths relative to
5846 the repository root (this was the default for Git prior to v1.5.4).
5847 status.short
5849 Set to true to enable --short by default in git-status(1). The
5850 option --no-short takes precedence over this variable.
5851 status.branch
5853 Set to true to enable --branch by default in git-status(1). The
5854 option --no-branch takes precedence over this variable.
5855 status.aheadBehind
5857 Set to true to enable --ahead-behind and false to enable
5858 --no-ahead-behind by default in git-status(1) for non-porcelain
5859 status formats. Defaults to true.
5860 status.displayCommentPrefix
5862 If set to true, git-status(1) will insert a comment prefix before
5863 each output line (starting with core.commentChar, i.e. # by
5864 default). This was the behavior of git-status(1) in Git 1.8.4 and
5865 previous. Defaults to false.
5866 status.renameLimit
5868 The number of files to consider when performing rename detection in
5869 git-status(1) and git-commit(1). Defaults to the value of
5870 diff.renameLimit.
5871 status.renames
5873 Whether and how Git detects renames in git-status(1) and git-
5874 commit(1) . If set to "false", rename detection is disabled. If set
5875 to "true", basic rename detection is enabled. If set to "copies" or
5876 "copy", Git will detect copies, as well. Defaults to the value of
5877 diff.renames.
5878 status.showStash
5880 If set to true, git-status(1) will display the number of entries
5881 currently stashed away. Defaults to false.
5882 status.showUntrackedFiles
5884 By default, git-status(1) and git-commit(1) show files which are
5885 not currently tracked by Git. Directories which contain only
5886 untracked files, are shown with the directory name only. Showing
5887 untracked files means that Git needs to lstat() all the files in
5888 the whole repository, which might be slow on some systems. So, this
5889 variable controls how the commands display the untracked files.
5890 Possible values are:
5891 • no - Show no untracked files.
5893 • normal - Show untracked files and directories.
5895 • all - Show also individual files in untracked directories.
5897 If this variable is not specified, it defaults to normal. This
5899 variable can be overridden with the -u|--untracked-files option of
5900 git-status(1) and git-commit(1).
5901 status.submoduleSummary
5903 Defaults to false. If this is set to a non-zero number or true
5904 (identical to -1 or an unlimited number), the submodule summary
5905 will be enabled and a summary of commits for modified submodules
5906 will be shown (see --summary-limit option of git-submodule(1)).
5907 Please note that the summary output command will be suppressed for
5908 all submodules when diff.ignoreSubmodules is set to all or only for
5909 those submodules where submodule.<name>.ignore=all. The only
5910 exception to that rule is that status and commit will show staged
5911 submodule changes. To also view the summary for ignored submodules
5912 you can either use the --ignore-submodules=dirty command-line
5913 option or the git submodule summary command, which shows a similar
5914 output but does not honor these settings.
5915 stash.showIncludeUntracked
5917 If this is set to true, the git stash show command will show the
5918 untracked files of a stash entry. Defaults to false. See the
5919 description of the show command in git-stash(1).
5920 stash.showPatch
5922 If this is set to true, the git stash show command without an
5923 option will show the stash entry in patch form. Defaults to false.
5924 See the description of the show command in git-stash(1).
5925 stash.showStat
5927 If this is set to true, the git stash show command without an
5928 option will show a diffstat of the stash entry. Defaults to true.
5929 See the description of the show command in git-stash(1).
5930 submodule.<name>.url
5932 The URL for a submodule. This variable is copied from the
5933 .gitmodules file to the git config via git submodule init. The user
5934 can change the configured URL before obtaining the submodule via
5935 git submodule update. If neither submodule.<name>.active nor
5936 submodule.active are set, the presence of this variable is used as
5937 a fallback to indicate whether the submodule is of interest to git
5938 commands. See git-submodule(1) and gitmodules(5) for details.
5939 submodule.<name>.update
5941 The method by which a submodule is updated by git submodule update,
5942 which is the only affected command, others such as git checkout
5943 --recurse-submodules are unaffected. It exists for historical
5944 reasons, when git submodule was the only command to interact with
5945 submodules; settings like submodule.active and pull.rebase are more
5946 specific. It is populated by git submodule init from the
5947 gitmodules(5) file. See description of update command in git-
5948 submodule(1).
5949 submodule.<name>.branch
5951 The remote branch name for a submodule, used by git submodule
5952 update --remote. Set this option to override the value found in the
5953 .gitmodules file. See git-submodule(1) and gitmodules(5) for
5954 details.
5955 submodule.<name>.fetchRecurseSubmodules
5957 This option can be used to control recursive fetching of this
5958 submodule. It can be overridden by using the
5959 --[no-]recurse-submodules command-line option to "git fetch" and
5960 "git pull". This setting will override that from in the
5961 gitmodules(5) file.
5962 submodule.<name>.ignore
5964 Defines under what circumstances "git status" and the diff family
5965 show a submodule as modified. When set to "all", it will never be
5966 considered modified (but it will nonetheless show up in the output
5967 of status and commit when it has been staged), "dirty" will ignore
5968 all changes to the submodule’s work tree and takes only differences
5969 between the HEAD of the submodule and the commit recorded in the
5970 superproject into account. "untracked" will additionally let
5971 submodules with modified tracked files in their work tree show up.
5972 Using "none" (the default when this option is not set) also shows
5973 submodules that have untracked files in their work tree as changed.
5974 This setting overrides any setting made in .gitmodules for this
5975 submodule, both settings can be overridden on the command line by
5976 using the "--ignore-submodules" option. The git submodule commands
5977 are not affected by this setting.
5978 submodule.<name>.active
5980 Boolean value indicating if the submodule is of interest to git
5981 commands. This config option takes precedence over the
5982 submodule.active config option. See gitsubmodules(7) for details.
5983 submodule.active
5985 A repeated field which contains a pathspec used to match against a
5986 submodule’s path to determine if the submodule is of interest to
5987 git commands. See gitsubmodules(7) for details.
5988 submodule.recurse
5990 A boolean indicating if commands should enable the
5991 --recurse-submodules option by default. Defaults to false.
5992 When set to true, it can be deactivated via the
5994 --no-recurse-submodules option. Note that some Git commands lacking
5995 this option may call some of the above commands affected by
5996 submodule.recurse; for instance git remote update will call git
5997 fetch but does not have a --no-recurse-submodules option. For these
5998 commands a workaround is to temporarily change the configuration
5999 value by using git -c submodule.recurse=0.
6000 The following list shows the commands that accept
6002 --recurse-submodules and whether they are supported by this
6003 setting.
6004 • checkout, fetch, grep, pull, push, read-tree, reset, restore
6006 and switch are always supported.
6007 • clone and ls-files are not supported.
6009 • branch is supported only if submodule.propagateBranches is
6011 enabled
6012 submodule.propagateBranches
6014 [EXPERIMENTAL] A boolean that enables branching support when using
6015 --recurse-submodules or submodule.recurse=true. Enabling this will
6016 allow certain commands to accept --recurse-submodules and certain
6017 commands that already accept --recurse-submodules will now consider
6018 branches. Defaults to false.
6019 submodule.fetchJobs
6021 Specifies how many submodules are fetched/cloned at the same time.
6022 A positive integer allows up to that number of submodules fetched
6023 in parallel. A value of 0 will give some reasonable default. If
6024 unset, it defaults to 1.
6025 submodule.alternateLocation
6027 Specifies how the submodules obtain alternates when submodules are
6028 cloned. Possible values are no, superproject. By default no is
6029 assumed, which doesn’t add references. When the value is set to
6030 superproject the submodule to be cloned computes its alternates
6031 location relative to the superprojects alternate.
6032 submodule.alternateErrorStrategy
6034 Specifies how to treat errors with the alternates for a submodule
6035 as computed via submodule.alternateLocation. Possible values are
6036 ignore, info, die. Default is die. Note that if set to ignore or
6037 info, and if there is an error with the computed alternate, the
6038 clone proceeds as if no alternate was specified.
6039 tag.forceSignAnnotated
6041 A boolean to specify whether annotated tags created should be GPG
6042 signed. If --annotate is specified on the command line, it takes
6043 precedence over this option.
6044 tag.sort
6046 This variable controls the sort ordering of tags when displayed by
6047 git-tag(1). Without the "--sort=<value>" option provided, the value
6048 of this variable will be used as the default.
6049 tag.gpgSign
6051 A boolean to specify whether all tags should be GPG signed. Use of
6052 this option when running in an automated script can result in a
6053 large number of tags being signed. It is therefore convenient to
6054 use an agent to avoid typing your gpg passphrase several times.
6055 Note that this option doesn’t affect tag signing behavior enabled
6056 by "-u <keyid>" or "--local-user=<keyid>" options.
6057 tar.umask
6059 This variable can be used to restrict the permission bits of tar
6060 archive entries. The default is 0002, which turns off the world
6061 write bit. The special value "user" indicates that the archiving
6062 user’s umask will be used instead. See umask(2) and git-archive(1).
6063 Trace2 config settings are only read from the system and global config
6065 files; repository local and worktree config files and -c command line
6066 arguments are not respected.
6067 trace2.normalTarget
6069 This variable controls the normal target destination. It may be
6070 overridden by the GIT_TRACE2 environment variable. The following
6071 table shows possible values.
6072 trace2.perfTarget
6074 This variable controls the performance target destination. It may
6075 be overridden by the GIT_TRACE2_PERF environment variable. The
6076 following table shows possible values.
6077 trace2.eventTarget
6079 This variable controls the event target destination. It may be
6080 overridden by the GIT_TRACE2_EVENT environment variable. The
6081 following table shows possible values.
6082 • 0 or false - Disables the target.
6084 • 1 or true - Writes to STDERR.
6086 • [2-9] - Writes to the already opened file descriptor.
6088 • <absolute-pathname> - Writes to the file in append mode. If the
6090 target already exists and is a directory, the traces will be
6091 written to files (one per process) underneath the given
6092 directory.
6093 • af_unix:[<socket_type>:]<absolute-pathname> - Write to a Unix
6095 DomainSocket (on platforms that support them). Socket type can
6096 be either stream or dgram; if omitted Git will try both.
6097 trace2.normalBrief
6099 Boolean. When true time, filename, and line fields are omitted from
6100 normal output. May be overridden by the GIT_TRACE2_BRIEF
6101 environment variable. Defaults to false.
6102 trace2.perfBrief
6104 Boolean. When true time, filename, and line fields are omitted from
6105 PERF output. May be overridden by the GIT_TRACE2_PERF_BRIEF
6106 environment variable. Defaults to false.
6107 trace2.eventBrief
6109 Boolean. When true time, filename, and line fields are omitted from
6110 event output. May be overridden by the GIT_TRACE2_EVENT_BRIEF
6111 environment variable. Defaults to false.
6112 trace2.eventNesting
6114 Integer. Specifies desired depth of nested regions in the event
6115 output. Regions deeper than this value will be omitted. May be
6116 overridden by the GIT_TRACE2_EVENT_NESTING environment variable.
6117 Defaults to 2.
6118 trace2.configParams
6120 A comma-separated list of patterns of "important" config settings
6121 that should be recorded in the trace2 output. For example,
6122 core.*,remote.*.url would cause the trace2 output to contain events
6123 listing each configured remote. May be overridden by the
6124 GIT_TRACE2_CONFIG_PARAMS environment variable. Unset by default.
6125 trace2.envVars
6127 A comma-separated list of "important" environment variables that
6128 should be recorded in the trace2 output. For example,
6129 GIT_HTTP_USER_AGENT,GIT_CONFIG would cause the trace2 output to
6130 contain events listing the overrides for HTTP user agent and the
6131 location of the Git configuration file (assuming any are set). May
6132 be overridden by the GIT_TRACE2_ENV_VARS environment variable.
6133 Unset by default.
6134 trace2.destinationDebug
6136 Boolean. When true Git will print error messages when a trace
6137 target destination cannot be opened for writing. By default, these
6138 errors are suppressed and tracing is silently disabled. May be
6139 overridden by the GIT_TRACE2_DST_DEBUG environment variable.
6140 trace2.maxFiles
6142 Integer. When writing trace files to a target directory, do not
6143 write additional traces if doing so would exceed this many files.
6144 Instead, write a sentinel file that will block further tracing to
6145 this directory. Defaults to 0, which disables this check.
6146 transfer.credentialsInUrl
6148 A configured URL can contain plaintext credentials in the form
6149 <protocol>://<user>:<password>@<domain>/<path>. You may want to
6150 warn or forbid the use of such configuration (in favor of using
6151 git-credential(1)). This will be used on git-clone(1), git-
6152 fetch(1), git-push(1), and any other direct use of the configured
6153 URL.
6154 Note that this is currently limited to detecting credentials in
6156 remote.<name>.url configuration; it won’t detect credentials in
6157 remote.<name>.pushurl configuration.
6158 You might want to enable this to prevent inadvertent credentials
6160 exposure, e.g. because:
6161 • The OS or system where you’re running git may not provide a way
6163 or otherwise allow you to configure the permissions of the
6164 configuration file where the username and/or password are
6165 stored.
6166 • Even if it does, having such data stored "at rest" might expose
6168 you in other ways, e.g. a backup process might copy the data to
6169 another system.
6170 • The git programs will pass the full URL to one another as
6172 arguments on the command-line, meaning the credentials will be
6173 exposed to other unprivileged users on systems that allow them
6174 to see the full process list of other users. On linux the
6175 "hidepid" setting documented in procfs(5) allows for
6176 configuring this behavior.
6177 If such concerns don’t apply to you then you probably don’t
6179 need to be concerned about credentials exposure due to storing
6180 sensitive data in git’s configuration files. If you do want to
6181 use this, set transfer.credentialsInUrl to one of these values:
6182 • allow (default): Git will proceed with its activity without
6184 warning.
6185 • warn: Git will write a warning message to stderr when parsing a
6187 URL with a plaintext credential.
6188 • die: Git will write a failure message to stderr when parsing a
6190 URL with a plaintext credential.
6191 transfer.fsckObjects
6193 When fetch.fsckObjects or receive.fsckObjects are not set, the
6194 value of this variable is used instead. Defaults to false.
6195 When set, the fetch or receive will abort in the case of a
6197 malformed object or a link to a nonexistent object. In addition,
6198 various other issues are checked for, including legacy issues (see
6199 fsck.<msg-id>), and potential security issues like the existence of
6200 a .GIT directory or a malicious .gitmodules file (see the release
6201 notes for v2.2.1 and v2.17.1 for details). Other sanity and
6202 security checks may be added in future releases.
6203 On the receiving side, failing fsckObjects will make those objects
6205 unreachable, see "QUARANTINE ENVIRONMENT" in git-receive-pack(1).
6206 On the fetch side, malformed objects will instead be left
6207 unreferenced in the repository.
6208 Due to the non-quarantine nature of the fetch.fsckObjects
6210 implementation it cannot be relied upon to leave the object store
6211 clean like receive.fsckObjects can.
6212 As objects are unpacked they’re written to the object store, so
6214 there can be cases where malicious objects get introduced even
6215 though the "fetch" failed, only to have a subsequent "fetch"
6216 succeed because only new incoming objects are checked, not those
6217 that have already been written to the object store. That difference
6218 in behavior should not be relied upon. In the future, such objects
6219 may be quarantined for "fetch" as well.
6220 For now, the paranoid need to find some way to emulate the
6222 quarantine environment if they’d like the same protection as
6223 "push". E.g. in the case of an internal mirror do the mirroring in
6224 two steps, one to fetch the untrusted objects, and then do a second
6225 "push" (which will use the quarantine) to another internal repo,
6226 and have internal clients consume this pushed-to repository, or
6227 embargo internal fetches and only allow them once a full "fsck" has
6228 run (and no new fetches have happened in the meantime).
6229 transfer.hideRefs
6231 String(s) receive-pack and upload-pack use to decide which refs to
6232 omit from their initial advertisements. Use more than one
6233 definition to specify multiple prefix strings. A ref that is under
6234 the hierarchies listed in the value of this variable is excluded,
6235 and is hidden when responding to git push or git fetch. See
6236 receive.hideRefs and uploadpack.hideRefs for program-specific
6237 versions of this config.
6238 You may also include a ! in front of the ref name to negate the
6240 entry, explicitly exposing it, even if an earlier entry marked it
6241 as hidden. If you have multiple hideRefs values, later entries
6242 override earlier ones (and entries in more-specific config files
6243 override less-specific ones).
6244 If a namespace is in use, the namespace prefix is stripped from
6246 each reference before it is matched against transfer.hiderefs
6247 patterns. In order to match refs before stripping, add a ^ in front
6248 of the ref name. If you combine ! and ^, ! must be specified
6249 first.
6250 For example, if refs/heads/master is specified in transfer.hideRefs
6252 and the current namespace is foo, then
6253 refs/namespaces/foo/refs/heads/master is omitted from the
6254 advertisements. If uploadpack.allowRefInWant is set, upload-pack
6255 will treat want-ref refs/heads/master in a protocol v2 fetch
6256 command as if refs/namespaces/foo/refs/heads/master did not exist.
6257 receive-pack, on the other hand, will still advertise the object id
6258 the ref is pointing to without mentioning its name (a so-called
6259 ".have" line).
6260 Even if you hide refs, a client may still be able to steal the
6262 target objects via the techniques described in the "SECURITY"
6263 section of the gitnamespaces(7) man page; it’s best to keep private
6264 data in a separate repository.
6265 transfer.unpackLimit
6267 When fetch.unpackLimit or receive.unpackLimit are not set, the
6268 value of this variable is used instead. The default value is 100.
6269 transfer.advertiseSID
6271 Boolean. When true, client and server processes will advertise
6272 their unique session IDs to their remote counterpart. Defaults to
6273 false.
6274 transfer.bundleURI
6276 When true, local git clone commands will request bundle information
6277 from the remote server (if advertised) and download bundles before
6278 continuing the clone through the Git protocol. Defaults to false.
6279 uploadarchive.allowUnreachable
6281 If true, allow clients to use git archive --remote to request any
6282 tree, whether reachable from the ref tips or not. See the
6283 discussion in the "SECURITY" section of git-upload-archive(1) for
6284 more details. Defaults to false.
6285 uploadpack.hideRefs
6287 This variable is the same as transfer.hideRefs, but applies only to
6288 upload-pack (and so affects only fetches, not pushes). An attempt
6289 to fetch a hidden ref by git fetch will fail. See also
6290 uploadpack.allowTipSHA1InWant.
6291 uploadpack.allowTipSHA1InWant
6293 When uploadpack.hideRefs is in effect, allow upload-pack to accept
6294 a fetch request that asks for an object at the tip of a hidden ref
6295 (by default, such a request is rejected). See also
6296 uploadpack.hideRefs. Even if this is false, a client may be able to
6297 steal objects via the techniques described in the "SECURITY"
6298 section of the gitnamespaces(7) man page; it’s best to keep private
6299 data in a separate repository.
6300 uploadpack.allowReachableSHA1InWant
6302 Allow upload-pack to accept a fetch request that asks for an object
6303 that is reachable from any ref tip. However, note that calculating
6304 object reachability is computationally expensive. Defaults to
6305 false. Even if this is false, a client may be able to steal objects
6306 via the techniques described in the "SECURITY" section of the
6307 gitnamespaces(7) man page; it’s best to keep private data in a
6308 separate repository.
6309 uploadpack.allowAnySHA1InWant
6311 Allow upload-pack to accept a fetch request that asks for any
6312 object at all. Defaults to false.
6313 uploadpack.keepAlive
6315 When upload-pack has started pack-objects, there may be a quiet
6316 period while pack-objects prepares the pack. Normally it would
6317 output progress information, but if --quiet was used for the fetch,
6318 pack-objects will output nothing at all until the pack data begins.
6319 Some clients and networks may consider the server to be hung and
6320 give up. Setting this option instructs upload-pack to send an empty
6321 keepalive packet every uploadpack.keepAlive seconds. Setting this
6322 option to 0 disables keepalive packets entirely. The default is 5
6323 seconds.
6324 uploadpack.packObjectsHook
6326 If this option is set, when upload-pack would run git pack-objects
6327 to create a packfile for a client, it will run this shell command
6328 instead. The pack-objects command and arguments it would have run
6329 (including the git pack-objects at the beginning) are appended to
6330 the shell command. The stdin and stdout of the hook are treated as
6331 if pack-objects itself was run. I.e., upload-pack will feed input
6332 intended for pack-objects to the hook, and expects a completed
6333 packfile on stdout.
6334 Note that this configuration variable is only respected when it is
6336 specified in protected configuration (see the section called
6337 “SCOPES”). This is a safety measure against fetching from untrusted
6338 repositories.
6339 uploadpack.allowFilter
6341 If this option is set, upload-pack will support partial clone and
6342 partial fetch object filtering.
6343 uploadpackfilter.allow
6345 Provides a default value for unspecified object filters (see: the
6346 below configuration variable). If set to true, this will also
6347 enable all filters which get added in the future. Defaults to true.
6348 uploadpackfilter.<filter>.allow
6350 Explicitly allow or ban the object filter corresponding to
6351 <filter>, where <filter> may be one of: blob:none, blob:limit,
6352 object:type, tree, sparse:oid, or combine. If using combined
6353 filters, both combine and all of the nested filter kinds must be
6354 allowed. Defaults to uploadpackfilter.allow.
6355 uploadpackfilter.tree.maxDepth
6357 Only allow --filter=tree:<n> when <n> is no more than the value of
6358 uploadpackfilter.tree.maxDepth. If set, this also implies
6359 uploadpackfilter.tree.allow=true, unless this configuration
6360 variable had already been set. Has no effect if unset.
6361 uploadpack.allowRefInWant
6363 If this option is set, upload-pack will support the ref-in-want
6364 feature of the protocol version 2 fetch command. This feature is
6365 intended for the benefit of load-balanced servers which may not
6366 have the same view of what OIDs their refs point to due to
6367 replication delay.
6368 url.<base>.insteadOf
6370 Any URL that starts with this value will be rewritten to start,
6371 instead, with <base>. In cases where some site serves a large
6372 number of repositories, and serves them with multiple access
6373 methods, and some users need to use different access methods, this
6374 feature allows people to specify any of the equivalent URLs and
6375 have Git automatically rewrite the URL to the best alternative for
6376 the particular user, even for a never-before-seen repository on the
6377 site. When more than one insteadOf strings match a given URL, the
6378 longest match is used.
6379 Note that any protocol restrictions will be applied to the
6381 rewritten URL. If the rewrite changes the URL to use a custom
6382 protocol or remote helper, you may need to adjust the
6383 protocol.*.allow config to permit the request. In particular,
6384 protocols you expect to use for submodules must be set to always
6385 rather than the default of user. See the description of
6386 protocol.allow above.
6387 url.<base>.pushInsteadOf
6389 Any URL that starts with this value will not be pushed to; instead,
6390 it will be rewritten to start with <base>, and the resulting URL
6391 will be pushed to. In cases where some site serves a large number
6392 of repositories, and serves them with multiple access methods, some
6393 of which do not allow push, this feature allows people to specify a
6394 pull-only URL and have Git automatically use an appropriate URL to
6395 push, even for a never-before-seen repository on the site. When
6396 more than one pushInsteadOf strings match a given URL, the longest
6397 match is used. If a remote has an explicit pushurl, Git will ignore
6398 this setting for that remote.
6399 user.name, user.email, author.name, author.email, committer.name,
6401 committer.email
6402 The user.name and user.email variables determine what ends up in
6403 the author and committer fields of commit objects. If you need the
6404 author or committer to be different, the author.name, author.email,
6405 committer.name, or committer.email variables can be set. All of
6406 these can be overridden by the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL,
6407 GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL, and EMAIL environment
6408 variables.
6409 Note that the name forms of these variables conventionally refer to
6411 some form of a personal name. See git-commit(1) and the environment
6412 variables section of git(1) for more information on these settings
6413 and the credential.username option if you’re looking for
6414 authentication credentials instead.
6415 user.useConfigOnly
6417 Instruct Git to avoid trying to guess defaults for user.email and
6418 user.name, and instead retrieve the values only from the
6419 configuration. For example, if you have multiple email addresses
6420 and would like to use a different one for each repository, then
6421 with this configuration option set to true in the global config
6422 along with a name, Git will prompt you to set up an email before
6423 making new commits in a newly cloned repository. Defaults to false.
6424 user.signingKey
6426 If git-tag(1) or git-commit(1) is not selecting the key you want it
6427 to automatically when creating a signed tag or commit, you can
6428 override the default selection with this variable. This option is
6429 passed unchanged to gpg’s --local-user parameter, so you may
6430 specify a key using any method that gpg supports. If gpg.format is
6431 set to ssh this can contain the path to either your private ssh key
6432 or the public key when ssh-agent is used. Alternatively it can
6433 contain a public key prefixed with key:: directly (e.g.:
6434 "key::ssh-rsa XXXXXX identifier"). The private key needs to be
6435 available via ssh-agent. If not set Git will call
6436 gpg.ssh.defaultKeyCommand (e.g.: "ssh-add -L") and try to use the
6437 first key available. For backward compatibility, a raw key which
6438 begins with "ssh-", such as "ssh-rsa XXXXXX identifier", is treated
6439 as "key::ssh-rsa XXXXXX identifier", but this form is deprecated;
6440 use the key:: form instead.
6441 versionsort.prereleaseSuffix (deprecated)
6443 Deprecated alias for versionsort.suffix. Ignored if
6444 versionsort.suffix is set.
6445 versionsort.suffix
6447 Even when version sort is used in git-tag(1), tagnames with the
6448 same base version but different suffixes are still sorted
6449 lexicographically, resulting e.g. in prerelease tags appearing
6450 after the main release (e.g. "1.0-rc1" after "1.0"). This variable
6451 can be specified to determine the sorting order of tags with
6452 different suffixes.
6453 By specifying a single suffix in this variable, any tagname
6455 containing that suffix will appear before the corresponding main
6456 release. E.g. if the variable is set to "-rc", then all "1.0-rcX"
6457 tags will appear before "1.0". If specified multiple times, once
6458 per suffix, then the order of suffixes in the configuration will
6459 determine the sorting order of tagnames with those suffixes. E.g.
6460 if "-pre" appears before "-rc" in the configuration, then all
6461 "1.0-preX" tags will be listed before any "1.0-rcX" tags. The
6462 placement of the main release tag relative to tags with various
6463 suffixes can be determined by specifying the empty suffix among
6464 those other suffixes. E.g. if the suffixes "-rc", "", "-ck", and
6465 "-bfs" appear in the configuration in this order, then all
6466 "v4.8-rcX" tags are listed first, followed by "v4.8", then
6467 "v4.8-ckX" and finally "v4.8-bfsX".
6468 If more than one suffix matches the same tagname, then that tagname
6470 will be sorted according to the suffix which starts at the earliest
6471 position in the tagname. If more than one different matching suffix
6472 starts at that earliest position, then that tagname will be sorted
6473 according to the longest of those suffixes. The sorting order
6474 between different suffixes is undefined if they are in multiple
6475 config files.
6476 web.browser
6478 Specify a web browser that may be used by some commands. Currently
6479 only git-instaweb(1) and git-help(1) may use it.
6480 worktree.guessRemote
6482 If no branch is specified and neither -b nor -B nor --detach is
6483 used, then git worktree add defaults to creating a new branch from
6484 HEAD. If worktree.guessRemote is set to true, worktree add tries to
6485 find a remote-tracking branch whose name uniquely matches the new
6486 branch name. If such a branch exists, it is checked out and set as
6487 "upstream" for the new branch. If no such match can be found, it
6488 falls back to creating a new branch from the current HEAD.
6489
6491 When using the deprecated [section.subsection] syntax, changing a value
6492 will result in adding a multi-line key instead of a change, if the
6493 subsection is given with at least one uppercase character. For example
6494 when the config looks like
6495 [section.subsection]
6497 key = value1
6498 and running git config section.Subsection.key value2 will result in
6500 [section.subsection]
6502 key = value1
6503 key = value2
6504
6506 Part of the git(1) suite
6507
6509 1. the bundle URI design document
6510 file:///usr/share/doc/git/technical/bundle-uri.html
6511Git 2.43.0 11/20/2023 GIT-CONFIG(1)