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>] [--show-origin] [-z|--null] name [value [value_regex]]
10 git config [<file-option>] [--type=<type>] --add name value
11 git config [<file-option>] [--type=<type>] --replace-all name value [value_regex]
12 git config [<file-option>] [--type=<type>] [--show-origin] [-z|--null] --get name [value_regex]
13 git config [<file-option>] [--type=<type>] [--show-origin] [-z|--null] --get-all name [value_regex]
14 git config [<file-option>] [--type=<type>] [--show-origin] [-z|--null] [--name-only] --get-regexp name_regex [value_regex]
15 git config [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
16 git config [<file-option>] --unset name [value_regex]
17 git config [<file-option>] --unset-all name [value_regex]
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] [-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
27 You can query/set/replace/unset options with this command. The name is
28 actually the section and the key separated by a dot, and the value will
29 be escaped.
30 Multiple lines can be added to an option by using the --add option. If
32 you want to update or unset an option which can occur on multiple
33 lines, a POSIX regexp value_regex needs to be given. Only the existing
34 values that match the regexp are updated or unset. If you want to
35 handle the lines that do not match the regex, just prepend a single
36 exclamation mark in front (see also the section called “EXAMPLES”).
37 The --type=<type> option instructs git config to ensure that incoming
39 and outgoing values are canonicalize-able under the given <type>. If no
40 --type=<type> is given, no canonicalization will be performed. Callers
41 may unset an existing --type specifier with --no-type.
42 When reading, the values are read from the system, global and
44 repository local configuration files by default, and options --system,
45 --global, --local, --worktree and --file <filename> can be used to tell
46 the command to read from only that location (see the section called
47 “FILES”).
48 When writing, the new value is written to the repository local
50 configuration file by default, and options --system, --global,
51 --worktree, --file <filename> can be used to tell the command to write
52 to that location (you can say --local but that is the default).
53 This command will fail with non-zero status upon error. Some exit codes
55 are:
56 · The section or key is invalid (ret=1),
58 · no section or name was provided (ret=2),
60 · the config file is invalid (ret=3),
62 · the config file cannot be written (ret=4),
64 · you try to unset an option which does not exist (ret=5),
66 · you try to unset/set an option for which multiple lines match
68 (ret=5), or
69 · you try to use an invalid regexp (ret=6).
71 On success, the command returns the exit code 0.
73
75 --replace-all
76 Default behavior is to replace at most one line. This replaces all
77 lines matching the key (and optionally the value_regex).
78 --add
80 Adds a new line to the option without altering any existing values.
81 This is the same as providing ^$ as the value_regex in
82 --replace-all.
83 --get
85 Get the value for a given key (optionally filtered by a regex
86 matching the value). Returns error code 1 if the key was not found
87 and the last value if multiple key values were found.
88 --get-all
90 Like get, but returns all values for a multi-valued key.
91 --get-regexp
93 Like --get-all, but interprets the name as a regular expression and
94 writes out the key names. Regular expression matching is currently
95 case-sensitive and done against a canonicalized version of the key
96 in which section and variable names are lowercased, but subsection
97 names are not.
98 --get-urlmatch name URL
100 When given a two-part name section.key, the value for
101 section.<url>.key whose <url> part matches the best to the given
102 URL is returned (if no such key exists, the value for section.key
103 is used as a fallback). When given just the section as name, do so
104 for all the keys in the section and list them. Returns error code 1
105 if no value is found.
106 --global
108 For writing options: write to global ~/.gitconfig file rather than
109 the repository .git/config, write to $XDG_CONFIG_HOME/git/config
110 file if this file exists and the ~/.gitconfig file doesn’t.
111 For reading options: read only from global ~/.gitconfig and from
113 $XDG_CONFIG_HOME/git/config rather than from all available files.
114 See also the section called “FILES”.
116 --system
118 For writing options: write to system-wide $(prefix)/etc/gitconfig
119 rather than the repository .git/config.
120 For reading options: read only from system-wide
122 $(prefix)/etc/gitconfig rather than from all available files.
123 See also the section called “FILES”.
125 --local
127 For writing options: write to the repository .git/config file. This
128 is the default behavior.
129 For reading options: read only from the repository .git/config
131 rather than from all available files.
132 See also the section called “FILES”.
134 --worktree
136 Similar to --local except that .git/config.worktree is read from or
137 written to if extensions.worktreeConfig is present. If not it’s the
138 same as --local.
139 -f config-file, --file config-file
141 Use the given config file instead of the one specified by
142 GIT_CONFIG.
143 --blob blob
145 Similar to --file but use the given blob instead of a file. E.g.
146 you can use master:.gitmodules to read values from the file
147 .gitmodules in the master branch. See "SPECIFYING REVISIONS"
148 section in gitrevisions(7) for a more complete list of ways to
149 spell blob names.
150 --remove-section
152 Remove the given section from the configuration file.
153 --rename-section
155 Rename the given section to a new name.
156 --unset
158 Remove the line matching the key from config file.
159 --unset-all
161 Remove all lines matching the key from config file.
162 -l, --list
164 List all variables set in config file, along with their values.
165 --type <type>
167 git config will ensure that any input or output is valid under the
168 given type constraint(s), and will canonicalize outgoing values in
169 <type>'s canonical form.
170 Valid <type>'s include:
172 · bool: canonicalize values as either "true" or "false".
174 · int: canonicalize values as simple decimal numbers. An optional
176 suffix of k, m, or g will cause the value to be multiplied by
177 1024, 1048576, or 1073741824 upon input.
178 · bool-or-int: canonicalize according to either bool or int, as
180 described above.
181 · path: canonicalize by adding a leading ~ to the value of $HOME
183 and ~user to the home directory for the specified user. This
184 specifier has no effect when setting the value (but you can use
185 git config section.variable ~/ from the command line to let
186 your shell do the expansion.)
187 · expiry-date: canonicalize by converting from a fixed or
189 relative date-string to a timestamp. This specifier has no
190 effect when setting the value.
191 · color: When getting a value, canonicalize by converting to an
193 ANSI color escape sequence. When setting a value, a
194 sanity-check is performed to ensure that the given value is
195 canonicalize-able as an ANSI color, but it is written as-is.
196 --bool, --int, --bool-or-int, --path, --expiry-date
198 Historical options for selecting a type specifier. Prefer instead
199 --type (see above).
200 --no-type
202 Un-sets the previously set type specifier (if one was previously
203 set). This option requests that git config not canonicalize the
204 retrieved variable. --no-type has no effect without --type=<type>
205 or --<type>.
206 -z, --null
208 For all options that output values and/or keys, always end values
209 with the null character (instead of a newline). Use newline instead
210 as a delimiter between key and value. This allows for secure
211 parsing of the output without getting confused e.g. by values that
212 contain line breaks.
213 --name-only
215 Output only the names of config variables for --list or
216 --get-regexp.
217 --show-origin
219 Augment the output of all queried config options with the origin
220 type (file, standard input, blob, command line) and the actual
221 origin (config file path, ref, or blob id if applicable).
222 --get-colorbool name [stdout-is-tty]
224 Find the color setting for name (e.g. color.diff) and output
225 "true" or "false". stdout-is-tty should be either "true" or
226 "false", and is taken into account when configuration says "auto".
227 If stdout-is-tty is missing, then checks the standard output of the
228 command itself, and exits with status 0 if color is to be used, or
229 exits with status 1 otherwise. When the color setting for name is
230 undefined, the command uses color.ui as fallback.
231 --get-color name [default]
233 Find the color configured for name (e.g. color.diff.new) and
234 output it as the ANSI color escape sequence to the standard output.
235 The optional default parameter is used instead, if there is no
236 color configured for name.
237 --type=color [--default=<default>] is preferred over --get-color.
239 -e, --edit
241 Opens an editor to modify the specified config file; either
242 --system, --global, or repository (default).
243 --[no-]includes
245 Respect include.* directives in config files when looking up
246 values. Defaults to off when a specific file is given (e.g., using
247 --file, --global, etc) and on when searching all config files.
248 --default <value>
250 When using --get, and the requested variable is not found, behave
251 as if <value> were the value assigned to the that variable.
252
254 pager.config is only respected when listing configuration, i.e., when
255 using --list or any of the --get-* which may return multiple results.
256 The default is to use a pager.
257
259 If not set explicitly with --file, there are four files where git
260 config will search for configuration options:
261 $(prefix)/etc/gitconfig
263 System-wide configuration file.
264 $XDG_CONFIG_HOME/git/config
266 Second user-specific configuration file. If $XDG_CONFIG_HOME is not
267 set or empty, $HOME/.config/git/config will be used. Any
268 single-valued variable set in this file will be overwritten by
269 whatever is in ~/.gitconfig. It is a good idea not to create this
270 file if you sometimes use older versions of Git, as support for
271 this file was added fairly recently.
272 ~/.gitconfig
274 User-specific configuration file. Also called "global"
275 configuration file.
276 $GIT_DIR/config
278 Repository specific configuration file.
279 $GIT_DIR/config.worktree
281 This is optional and is only searched when
282 extensions.worktreeConfig is present in $GIT_DIR/config.
283 If no further options are given, all reading options will read all of
285 these files that are available. If the global or the system-wide
286 configuration file are not available they will be ignored. If the
287 repository configuration file is not available or readable, git config
288 will exit with a non-zero error code. However, in neither case will an
289 error message be issued.
290 The files are read in the order given above, with last value found
292 taking precedence over values read earlier. When multiple values are
293 taken then all values of a key from all files will be used.
294 You may override individual configuration parameters when running any
296 git command by using the -c option. See git(1) for details.
297 All writing options will per default write to the repository specific
299 configuration file. Note that this also affects options like
300 --replace-all and --unset. git config will only ever change one file at
301 a time.
302 You can override these rules either by command-line options or by
304 environment variables. The --global, --system and --worktree options
305 will limit the file used to the global, system-wide or per-worktree
306 file respectively. The GIT_CONFIG environment variable has a similar
307 effect, but you can specify any filename you want.
308
310 GIT_CONFIG
311 Take the configuration from the given file instead of .git/config.
312 Using the "--global" option forces this to ~/.gitconfig. Using the
313 "--system" option forces this to $(prefix)/etc/gitconfig.
314 GIT_CONFIG_NOSYSTEM
316 Whether to skip reading settings from the system-wide
317 $(prefix)/etc/gitconfig file. See git(1) for details.
318 See also the section called “FILES”.
320
322 Given a .git/config like this:
323 #
325 # This is the config file, and
326 # a '#' or ';' character indicates
327 # a comment
328 #
329 ; core variables
331 [core]
332 ; Don't trust file modes
333 filemode = false
334 ; Our diff algorithm
336 [diff]
337 external = /usr/local/bin/diff-wrapper
338 renames = true
339 ; Proxy settings
341 [core]
342 gitproxy=proxy-command for kernel.org
343 gitproxy=default-proxy ; for all the rest
344 ; HTTP
346 [http]
347 sslVerify
348 [http "https://weak.example.com"]
349 sslVerify = false
350 cookieFile = /tmp/cookie.txt
351 you can set the filemode to true with
353 % git config core.filemode true
355 The hypothetical proxy command entries actually have a postfix to
358 discern what URL they apply to. Here is how to change the entry for
359 kernel.org to "ssh".
360 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
362 This makes sure that only the key/value pair for kernel.org is
365 replaced.
366 To delete the entry for renames, do
368 % git config --unset diff.renames
370 If you want to delete an entry for a multivar (like core.gitproxy
373 above), you have to provide a regex matching the value of exactly one
374 line.
375 To query the value for a given key, do
377 % git config --get core.filemode
379 or
382 % git config core.filemode
384 or, to query a multivar:
387 % git config --get core.gitproxy "for kernel.org$"
389 If you want to know all the values for a multivar, do:
392 % git config --get-all core.gitproxy
394 If you like to live dangerously, you can replace all core.gitproxy by a
397 new one with
398 % git config --replace-all core.gitproxy ssh
400 However, if you really only want to replace the line for the default
403 proxy, i.e. the one without a "for ..." postfix, do something like
404 this:
405 % git config core.gitproxy ssh '! for '
407 To actually match only values with an exclamation mark, you have to
410 % git config section.key value '[!]'
412 To add a new proxy, without altering any of the existing ones, use
415 % git config --add core.gitproxy '"proxy-command" for example.com'
417 An example to use customized color from the configuration in your
420 script:
421 #!/bin/sh
423 WS=$(git config --get-color color.diff.whitespace "blue reverse")
424 RESET=$(git config --get-color "" "reset")
425 echo "${WS}your whitespace color or blue reverse${RESET}"
426 For URLs in https://weak.example.com, http.sslVerify is set to false,
429 while it is set to true for all others:
430 % git config --type=bool --get-urlmatch http.sslverify https://good.example.com
432 true
433 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
434 false
435 % git config --get-urlmatch http https://weak.example.com
436 http.cookieFile /tmp/cookie.txt
437 http.sslverify false
438
441 The Git configuration file contains a number of variables that affect
442 the Git commands' behavior. The files .git/config and optionally
443 config.worktree (see extensions.worktreeConfig below) in each
444 repository are used to store the configuration for that repository, and
445 $HOME/.gitconfig is used to store a per-user configuration as fallback
446 values for the .git/config file. The file /etc/gitconfig can be used to
447 store a system-wide default configuration.
448 The configuration variables are used by both the Git plumbing and the
450 porcelains. The variables are divided into sections, wherein the fully
451 qualified variable name of the variable itself is the last
452 dot-separated segment and the section name is everything before the
453 last dot. The variable names are case-insensitive, allow only
454 alphanumeric characters and -, and must start with an alphabetic
455 character. Some variables may appear multiple times; we say then that
456 the variable is multivalued.
457 Syntax
459 The syntax is fairly flexible and permissive; whitespaces are mostly
460 ignored. The # and ; characters begin comments to the end of line,
461 blank lines are ignored.
462 The file consists of sections and variables. A section begins with the
464 name of the section in square brackets and continues until the next
465 section begins. Section names are case-insensitive. Only alphanumeric
466 characters, - and . are allowed in section names. Each variable must
467 belong to some section, which means that there must be a section header
468 before the first setting of a variable.
469 Sections can be further divided into subsections. To begin a subsection
471 put its name in double quotes, separated by space from the section
472 name, in the section header, like in the example below:
473 [section "subsection"]
475 Subsection names are case sensitive and can contain any characters
478 except newline and the null byte. Doublequote " and backslash can be
479 included by escaping them as \" and \\, respectively. Backslashes
480 preceding other characters are dropped when reading; for example, \t is
481 read as t and \0 is read as 0 Section headers cannot span multiple
482 lines. Variables may belong directly to a section or to a given
483 subsection. You can have [section] if you have [section "subsection"],
484 but you don’t need to.
485 There is also a deprecated [section.subsection] syntax. With this
487 syntax, the subsection name is converted to lower-case and is also
488 compared case sensitively. These subsection names follow the same
489 restrictions as section names.
490 All the other lines (and the remainder of the line after the section
492 header) are recognized as setting variables, in the form name = value
493 (or just name, which is a short-hand to say that the variable is the
494 boolean "true"). The variable names are case-insensitive, allow only
495 alphanumeric characters and -, and must start with an alphabetic
496 character.
497 A line that defines a value can be continued to the next line by ending
499 it with a \; the backquote and the end-of-line are stripped. Leading
500 whitespaces after name =, the remainder of the line after the first
501 comment character # or ;, and trailing whitespaces of the line are
502 discarded unless they are enclosed in double quotes. Internal
503 whitespaces within the value are retained verbatim.
504 Inside double quotes, double quote " and backslash \ characters must be
506 escaped: use \" for " and \\ for \.
507 The following escape sequences (beside \" and \\) are recognized: \n
509 for newline character (NL), \t for horizontal tabulation (HT, TAB) and
510 \b for backspace (BS). Other char escape sequences (including octal
511 escape sequences) are invalid.
512 Includes
514 The include and includeIf sections allow you to include config
515 directives from another source. These sections behave identically to
516 each other with the exception that includeIf sections may be ignored if
517 their condition does not evaluate to true; see "Conditional includes"
518 below.
519 You can include a config file from another by setting the special
521 include.path (or includeIf.*.path) variable to the name of the file to
522 be included. The variable takes a pathname as its value, and is subject
523 to tilde expansion. These variables can be given multiple times.
524 The contents of the included file are inserted immediately, as if they
526 had been found at the location of the include directive. If the value
527 of the variable is a relative path, the path is considered to be
528 relative to the configuration file in which the include directive was
529 found. See below for examples.
530 Conditional includes
532 You can include a config file from another conditionally by setting a
533 includeIf.<condition>.path variable to the name of the file to be
534 included.
535 The condition starts with a keyword followed by a colon and some data
537 whose format and meaning depends on the keyword. Supported keywords
538 are:
539 gitdir
541 The data that follows the keyword gitdir: is used as a glob
542 pattern. If the location of the .git directory matches the pattern,
543 the include condition is met.
544 The .git location may be auto-discovered, or come from $GIT_DIR
546 environment variable. If the repository is auto discovered via a
547 .git file (e.g. from submodules, or a linked worktree), the .git
548 location would be the final location where the .git directory is,
549 not where the .git file is.
550 The pattern can contain standard globbing wildcards and two
552 additional ones, **/ and /**, that can match multiple path
553 components. Please refer to gitignore(5) for details. For
554 convenience:
555 · If the pattern starts with ~/, ~ will be substituted with the
557 content of the environment variable HOME.
558 · If the pattern starts with ./, it is replaced with the
560 directory containing the current config file.
561 · If the pattern does not start with either ~/, ./ or /, **/ will
563 be automatically prepended. For example, the pattern foo/bar
564 becomes **/foo/bar and would match /any/path/to/foo/bar.
565 · If the pattern ends with /, ** will be automatically added. For
567 example, the pattern foo/ becomes foo/**. In other words, it
568 matches "foo" and everything inside, recursively.
569 gitdir/i
571 This is the same as gitdir except that matching is done
572 case-insensitively (e.g. on case-insensitive file sytems)
573 A few more notes on matching via gitdir and gitdir/i:
575 · Symlinks in $GIT_DIR are not resolved before matching.
577 · Both the symlink & realpath versions of paths will be matched
579 outside of $GIT_DIR. E.g. if ~/git is a symlink to
580 /mnt/storage/git, both gitdir:~/git and gitdir:/mnt/storage/git
581 will match.
582 This was not the case in the initial release of this feature in
584 v2.13.0, which only matched the realpath version. Configuration
585 that wants to be compatible with the initial release of this
586 feature needs to either specify only the realpath version, or both
587 versions.
588 · Note that "../" is not special and will match literally, which is
590 unlikely what you want.
591 Example
593 # Core variables
594 [core]
595 ; Don't trust file modes
596 filemode = false
597 # Our diff algorithm
599 [diff]
600 external = /usr/local/bin/diff-wrapper
601 renames = true
602 [branch "devel"]
604 remote = origin
605 merge = refs/heads/devel
606 # Proxy settings
608 [core]
609 gitProxy="ssh" for "kernel.org"
610 gitProxy=default-proxy ; for the rest
611 [include]
613 path = /path/to/foo.inc ; include by absolute path
614 path = foo.inc ; find "foo.inc" relative to the current file
615 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
616 ; include if $GIT_DIR is /path/to/foo/.git
618 [includeIf "gitdir:/path/to/foo/.git"]
619 path = /path/to/foo.inc
620 ; include for all repositories inside /path/to/group
622 [includeIf "gitdir:/path/to/group/"]
623 path = /path/to/foo.inc
624 ; include for all repositories inside $HOME/to/group
626 [includeIf "gitdir:~/to/group/"]
627 path = /path/to/foo.inc
628 ; relative paths are always relative to the including
630 ; file (if the condition is true); their location is not
631 ; affected by the condition
632 [includeIf "gitdir:/path/to/group/"]
633 path = foo.inc
634 Values
636 Values of many variables are treated as a simple string, but there are
637 variables that take values of specific types and there are rules as to
638 how to spell them.
639 boolean
641 When a variable is said to take a boolean value, many synonyms are
642 accepted for true and false; these are all case-insensitive.
643 true
645 Boolean true literals are yes, on, true, and 1. Also, a
646 variable defined without = <value> is taken as true.
647 false
649 Boolean false literals are no, off, false, 0 and the empty
650 string.
651 When converting a value to its canonical form using the
653 --type=bool type specifier, git config will ensure that the
654 output is "true" or "false" (spelled in lowercase).
655 integer
657 The value for many variables that specify various sizes can be
658 suffixed with k, M,... to mean "scale the number by 1024", "by
659 1024x1024", etc.
660 color
662 The value for a variable that takes a color is a list of colors (at
663 most two, one for foreground and one for background) and attributes
664 (as many as you want), separated by spaces.
665 The basic colors accepted are normal, black, red, green, yellow,
667 blue, magenta, cyan and white. The first color given is the
668 foreground; the second is the background.
669 Colors may also be given as numbers between 0 and 255; these use
671 ANSI 256-color mode (but note that not all terminals may support
672 this). If your terminal supports it, you may also specify 24-bit
673 RGB values as hex, like #ff0ab3.
674 The accepted attributes are bold, dim, ul, blink, reverse, italic,
676 and strike (for crossed-out or "strikethrough" letters). The
677 position of any attributes with respect to the colors (before,
678 after, or in between), doesn’t matter. Specific attributes may be
679 turned off by prefixing them with no or no- (e.g., noreverse,
680 no-ul, etc).
681 An empty color string produces no color effect at all. This can be
683 used to avoid coloring specific elements without disabling color
684 entirely.
685 For git’s pre-defined color slots, the attributes are meant to be
687 reset at the beginning of each item in the colored output. So
688 setting color.decorate.branch to black will paint that branch name
689 in a plain black, even if the previous thing on the same output
690 line (e.g. opening parenthesis before the list of branch names in
691 log --decorate output) is set to be painted with bold or some other
692 attribute. However, custom log formats may do more complicated and
693 layered coloring, and the negated forms may be useful there.
694 pathname
696 A variable that takes a pathname value can be given a string that
697 begins with "~/" or "~user/", and the usual tilde expansion happens
698 to such a string: ~/ is expanded to the value of $HOME, and ~user/
699 to the specified user’s home directory.
700 Variables
702 Note that this list is non-comprehensive and not necessarily complete.
703 For command-specific variables, you will find a more detailed
704 description in the appropriate manual page.
705 Other git-related tools may and do use their own variables. When
707 inventing new variables for use in your own tool, make sure their names
708 do not conflict with those that are used by Git itself and other
709 popular tools, and describe them in your documentation.
710 advice.*
712 These variables control various optional help messages designed to
713 aid new users. All advice.* variables default to true, and you can
714 tell Git that you do not need help by setting these to false:
715 pushUpdateRejected
717 Set this variable to false if you want to disable
718 pushNonFFCurrent, pushNonFFMatching, pushAlreadyExists,
719 pushFetchFirst, and pushNeedsForce simultaneously.
720 pushNonFFCurrent
722 Advice shown when git-push(1) fails due to a non-fast-forward
723 update to the current branch.
724 pushNonFFMatching
726 Advice shown when you ran git-push(1) and pushed matching refs
727 explicitly (i.e. you used :, or specified a refspec that isn’t
728 your current branch) and it resulted in a non-fast-forward
729 error.
730 pushAlreadyExists
732 Shown when git-push(1) rejects an update that does not qualify
733 for fast-forwarding (e.g., a tag.)
734 pushFetchFirst
736 Shown when git-push(1) rejects an update that tries to
737 overwrite a remote ref that points at an object we do not have.
738 pushNeedsForce
740 Shown when git-push(1) rejects an update that tries to
741 overwrite a remote ref that points at an object that is not a
742 commit-ish, or make the remote ref point at an object that is
743 not a commit-ish.
744 pushUnqualifiedRefname
746 Shown when git-push(1) gives up trying to guess based on the
747 source and destination refs what remote ref namespace the
748 source belongs in, but where we can still suggest that the user
749 push to either refs/heads/* or refs/tags/* based on the type of
750 the source object.
751 statusHints
753 Show directions on how to proceed from the current state in the
754 output of git-status(1), in the template shown when writing
755 commit messages in git-commit(1), and in the help message shown
756 by git-checkout(1) when switching branch.
757 statusUoption
759 Advise to consider using the -u option to git-status(1) when
760 the command takes more than 2 seconds to enumerate untracked
761 files.
762 commitBeforeMerge
764 Advice shown when git-merge(1) refuses to merge to avoid
765 overwriting local changes.
766 resetQuiet
768 Advice to consider using the --quiet option to git-reset(1)
769 when the command takes more than 2 seconds to enumerate
770 unstaged changes after reset.
771 resolveConflict
773 Advice shown by various commands when conflicts prevent the
774 operation from being performed.
775 implicitIdentity
777 Advice on how to set your identity configuration when your
778 information is guessed from the system username and domain
779 name.
780 detachedHead
782 Advice shown when you used git-checkout(1) to move to the
783 detach HEAD state, to instruct how to create a local branch
784 after the fact.
785 checkoutAmbiguousRemoteBranchName
787 Advice shown when the argument to git-checkout(1) ambiguously
788 resolves to a remote tracking branch on more than one remote in
789 situations where an unambiguous argument would have otherwise
790 caused a remote-tracking branch to be checked out. See the
791 checkout.defaultRemote configuration variable for how to set a
792 given remote to used by default in some situations where this
793 advice would be printed.
794 amWorkDir
796 Advice that shows the location of the patch file when git-am(1)
797 fails to apply it.
798 rmHints
800 In case of failure in the output of git-rm(1), show directions
801 on how to proceed from the current state.
802 addEmbeddedRepo
804 Advice on what to do when you’ve accidentally added one git
805 repo inside of another.
806 ignoredHook
808 Advice shown if a hook is ignored because the hook is not set
809 as executable.
810 waitingForEditor
812 Print a message to the terminal whenever Git is waiting for
813 editor input from the user.
814 core.fileMode
816 Tells Git if the executable bit of files in the working tree is to
817 be honored.
818 Some filesystems lose the executable bit when a file that is marked
820 as executable is checked out, or checks out a non-executable file
821 with executable bit on. git-clone(1) or git-init(1) probe the
822 filesystem to see if it handles the executable bit correctly and
823 this variable is automatically set as necessary.
824 A repository, however, may be on a filesystem that handles the
826 filemode correctly, and this variable is set to true when created,
827 but later may be made accessible from another environment that
828 loses the filemode (e.g. exporting ext4 via CIFS mount, visiting a
829 Cygwin created repository with Git for Windows or Eclipse). In such
830 a case it may be necessary to set this variable to false. See git-
831 update-index(1).
832 The default is true (when core.filemode is not specified in the
834 config file).
835 core.hideDotFiles
837 (Windows-only) If true, mark newly-created directories and files
838 whose name starts with a dot as hidden. If dotGitOnly, only the
839 .git/ directory is hidden, but no other files starting with a dot.
840 The default mode is dotGitOnly.
841 core.ignoreCase
843 Internal variable which enables various workarounds to enable Git
844 to work better on filesystems that are not case sensitive, like
845 APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
846 finds "makefile" when Git expects "Makefile", Git will assume it is
847 really the same file, and continue to remember it as "Makefile".
848 The default is false, except git-clone(1) or git-init(1) will probe
850 and set core.ignoreCase true if appropriate when the repository is
851 created.
852 Git relies on the proper configuration of this variable for your
854 operating and file system. Modifying this value may result in
855 unexpected behavior.
856 core.precomposeUnicode
858 This option is only used by Mac OS implementation of Git. When
859 core.precomposeUnicode=true, Git reverts the unicode decomposition
860 of filenames done by Mac OS. This is useful when sharing a
861 repository between Mac OS and Linux or Windows. (Git for Windows
862 1.7.10 or higher is needed, or Git under cygwin 1.7). When false,
863 file names are handled fully transparent by Git, which is backward
864 compatible with older versions of Git.
865 core.protectHFS
867 If set to true, do not allow checkout of paths that would be
868 considered equivalent to .git on an HFS+ filesystem. Defaults to
869 true on Mac OS, and false elsewhere.
870 core.protectNTFS
872 If set to true, do not allow checkout of paths that would cause
873 problems with the NTFS filesystem, e.g. conflict with 8.3 "short"
874 names. Defaults to true on Windows, and false elsewhere.
875 core.fsmonitor
877 If set, the value of this variable is used as a command which will
878 identify all files that may have changed since the requested
879 date/time. This information is used to speed up git by avoiding
880 unnecessary processing of files that have not changed. See the
881 "fsmonitor-watchman" section of githooks(5).
882 core.trustctime
884 If false, the ctime differences between the index and the working
885 tree are ignored; useful when the inode change time is regularly
886 modified by something outside Git (file system crawlers and some
887 backup systems). See git-update-index(1). True by default.
888 core.splitIndex
890 If true, the split-index feature of the index will be used. See
891 git-update-index(1). False by default.
892 core.untrackedCache
894 Determines what to do about the untracked cache feature of the
895 index. It will be kept, if this variable is unset or set to keep.
896 It will automatically be added if set to true. And it will
897 automatically be removed, if set to false. Before setting it to
898 true, you should check that mtime is working properly on your
899 system. See git-update-index(1). keep by default.
900 core.checkStat
902 When missing or is set to default, many fields in the stat
903 structure are checked to detect if a file has been modified since
904 Git looked at it. When this configuration variable is set to
905 minimal, sub-second part of mtime and ctime, the uid and gid of the
906 owner of the file, the inode number (and the device number, if Git
907 was compiled to use it), are excluded from the check among these
908 fields, leaving only the whole-second part of mtime (and ctime, if
909 core.trustCtime is set) and the filesize to be checked.
910 There are implementations of Git that do not leave usable values in
912 some fields (e.g. JGit); by excluding these fields from the
913 comparison, the minimal mode may help interoperability when the
914 same repository is used by these other systems at the same time.
915 core.quotePath
917 Commands that output paths (e.g. ls-files, diff), will quote
918 "unusual" characters in the pathname by enclosing the pathname in
919 double-quotes and escaping those characters with backslashes in the
920 same way C escapes control characters (e.g. \t for TAB, \n for LF,
921 \\ for backslash) or bytes with values larger than 0x80 (e.g. octal
922 \302\265 for "micro" in UTF-8). If this variable is set to false,
923 bytes higher than 0x80 are not considered "unusual" any more.
924 Double-quotes, backslash and control characters are always escaped
925 regardless of the setting of this variable. A simple space
926 character is not considered "unusual". Many commands can output
927 pathnames completely verbatim using the -z option. The default
928 value is true.
929 core.eol
931 Sets the line ending type to use in the working directory for files
932 that are marked as text (either by having the text attribute set,
933 or by having text=auto and Git auto-detecting the contents as
934 text). Alternatives are lf, crlf and native, which uses the
935 platform’s native line ending. The default value is native. See
936 gitattributes(5) for more information on end-of-line conversion.
937 Note that this value is ignored if core.autocrlf is set to true or
938 input.
939 core.safecrlf
941 If true, makes Git check if converting CRLF is reversible when
942 end-of-line conversion is active. Git will verify if a command
943 modifies a file in the work tree either directly or indirectly. For
944 example, committing a file followed by checking out the same file
945 should yield the original file in the work tree. If this is not the
946 case for the current setting of core.autocrlf, Git will reject the
947 file. The variable can be set to "warn", in which case Git will
948 only warn about an irreversible conversion but continue the
949 operation.
950 CRLF conversion bears a slight chance of corrupting data. When it
952 is enabled, Git will convert CRLF to LF during commit and LF to
953 CRLF during checkout. A file that contains a mixture of LF and CRLF
954 before the commit cannot be recreated by Git. For text files this
955 is the right thing to do: it corrects line endings such that we
956 have only LF line endings in the repository. But for binary files
957 that are accidentally classified as text the conversion can corrupt
958 data.
959 If you recognize such corruption early you can easily fix it by
961 setting the conversion type explicitly in .gitattributes. Right
962 after committing you still have the original file in your work tree
963 and this file is not yet corrupted. You can explicitly tell Git
964 that this file is binary and Git will handle the file
965 appropriately.
966 Unfortunately, the desired effect of cleaning up text files with
968 mixed line endings and the undesired effect of corrupting binary
969 files cannot be distinguished. In both cases CRLFs are removed in
970 an irreversible way. For text files this is the right thing to do
971 because CRLFs are line endings, while for binary files converting
972 CRLFs corrupts data.
973 Note, this safety check does not mean that a checkout will generate
975 a file identical to the original file for a different setting of
976 core.eol and core.autocrlf, but only for the current one. For
977 example, a text file with LF would be accepted with core.eol=lf and
978 could later be checked out with core.eol=crlf, in which case the
979 resulting file would contain CRLF, although the original file
980 contained LF. However, in both work trees the line endings would be
981 consistent, that is either all LF or all CRLF, but never mixed. A
982 file with mixed line endings would be reported by the core.safecrlf
983 mechanism.
984 core.autocrlf
986 Setting this variable to "true" is the same as setting the text
987 attribute to "auto" on all files and core.eol to "crlf". Set to
988 true if you want to have CRLF line endings in your working
989 directory and the repository has LF line endings. This variable can
990 be set to input, in which case no output conversion is performed.
991 core.checkRoundtripEncoding
993 A comma and/or whitespace separated list of encodings that Git
994 performs UTF-8 round trip checks on if they are used in an
995 working-tree-encoding attribute (see gitattributes(5)). The default
996 value is SHIFT-JIS.
997 core.symlinks
999 If false, symbolic links are checked out as small plain files that
1000 contain the link text. git-update-index(1) and git-add(1) will not
1001 change the recorded type to regular file. Useful on filesystems
1002 like FAT that do not support symbolic links.
1003 The default is true, except git-clone(1) or git-init(1) will probe
1005 and set core.symlinks false if appropriate when the repository is
1006 created.
1007 core.gitProxy
1009 A "proxy command" to execute (as command host port) instead of
1010 establishing direct connection to the remote server when using the
1011 Git protocol for fetching. If the variable value is in the "COMMAND
1012 for DOMAIN" format, the command is applied only on hostnames ending
1013 with the specified domain string. This variable may be set multiple
1014 times and is matched in the given order; the first match wins.
1015 Can be overridden by the GIT_PROXY_COMMAND environment variable
1017 (which always applies universally, without the special "for"
1018 handling).
1019 The special string none can be used as the proxy command to specify
1021 that no proxy be used for a given domain pattern. This is useful
1022 for excluding servers inside a firewall from proxy use, while
1023 defaulting to a common proxy for external domains.
1024 core.sshCommand
1026 If this variable is set, git fetch and git push will use the
1027 specified command instead of ssh when they need to connect to a
1028 remote system. The command is in the same form as the
1029 GIT_SSH_COMMAND environment variable and is overridden when the
1030 environment variable is set.
1031 core.ignoreStat
1033 If true, Git will avoid using lstat() calls to detect if files have
1034 changed by setting the "assume-unchanged" bit for those tracked
1035 files which it has updated identically in both the index and
1036 working tree.
1037 When files are modified outside of Git, the user will need to stage
1039 the modified files explicitly (e.g. see Examples section in git-
1040 update-index(1)). Git will not normally detect changes to those
1041 files.
1042 This is useful on systems where lstat() calls are very slow, such
1044 as CIFS/Microsoft Windows.
1045 False by default.
1047 core.preferSymlinkRefs
1049 Instead of the default "symref" format for HEAD and other symbolic
1050 reference files, use symbolic links. This is sometimes needed to
1051 work with old scripts that expect HEAD to be a symbolic link.
1052 core.alternateRefsCommand
1054 When advertising tips of available history from an alternate, use
1055 the shell to execute the specified command instead of git-for-each-
1056 ref(1). The first argument is the absolute path of the alternate.
1057 Output must contain one hex object id per line (i.e., the same as
1058 produced by git for-each-ref --format='%(objectname)').
1059 Note that you cannot generally put git for-each-ref directly into
1061 the config value, as it does not take a repository path as an
1062 argument (but you can wrap the command above in a shell script).
1063 core.alternateRefsPrefixes
1065 When listing references from an alternate, list only references
1066 that begin with the given prefix. Prefixes match as if they were
1067 given as arguments to git-for-each-ref(1). To list multiple
1068 prefixes, separate them with whitespace. If
1069 core.alternateRefsCommand is set, setting
1070 core.alternateRefsPrefixes has no effect.
1071 core.bare
1073 If true this repository is assumed to be bare and has no working
1074 directory associated with it. If this is the case a number of
1075 commands that require a working directory will be disabled, such as
1076 git-add(1) or git-merge(1).
1077 This setting is automatically guessed by git-clone(1) or git-
1079 init(1) when the repository was created. By default a repository
1080 that ends in "/.git" is assumed to be not bare (bare = false),
1081 while all other repositories are assumed to be bare (bare = true).
1082 core.worktree
1084 Set the path to the root of the working tree. If GIT_COMMON_DIR
1085 environment variable is set, core.worktree is ignored and not used
1086 for determining the root of working tree. This can be overridden by
1087 the GIT_WORK_TREE environment variable and the --work-tree
1088 command-line option. The value can be an absolute path or relative
1089 to the path to the .git directory, which is either specified by
1090 --git-dir or GIT_DIR, or automatically discovered. If --git-dir or
1091 GIT_DIR is specified but none of --work-tree, GIT_WORK_TREE and
1092 core.worktree is specified, the current working directory is
1093 regarded as the top level of your working tree.
1094 Note that this variable is honored even when set in a configuration
1096 file in a ".git" subdirectory of a directory and its value differs
1097 from the latter directory (e.g. "/path/to/.git/config" has
1098 core.worktree set to "/different/path"), which is most likely a
1099 misconfiguration. Running Git commands in the "/path/to" directory
1100 will still use "/different/path" as the root of the work tree and
1101 can cause confusion unless you know what you are doing (e.g. you
1102 are creating a read-only snapshot of the same index to a location
1103 different from the repository’s usual working tree).
1104 core.logAllRefUpdates
1106 Enable the reflog. Updates to a ref <ref> is logged to the file
1107 "$GIT_DIR/logs/<ref>", by appending the new and old SHA-1, the
1108 date/time and the reason of the update, but only when the file
1109 exists. If this configuration variable is set to true, missing
1110 "$GIT_DIR/logs/<ref>" file is automatically created for branch
1111 heads (i.e. under refs/heads/), remote refs (i.e. under
1112 refs/remotes/), note refs (i.e. under refs/notes/), and the
1113 symbolic ref HEAD. If it is set to always, then a missing reflog is
1114 automatically created for any ref under refs/.
1115 This information can be used to determine what commit was the tip
1117 of a branch "2 days ago".
1118 This value is true by default in a repository that has a working
1120 directory associated with it, and false by default in a bare
1121 repository.
1122 core.repositoryFormatVersion
1124 Internal variable identifying the repository format and layout
1125 version.
1126 core.sharedRepository
1128 When group (or true), the repository is made shareable between
1129 several users in a group (making sure all the files and objects are
1130 group-writable). When all (or world or everybody), the repository
1131 will be readable by all users, additionally to being
1132 group-shareable. When umask (or false), Git will use permissions
1133 reported by umask(2). When 0xxx, where 0xxx is an octal number,
1134 files in the repository will have this mode value. 0xxx will
1135 override user’s umask value (whereas the other options will only
1136 override requested parts of the user’s umask value). Examples: 0660
1137 will make the repo read/write-able for the owner and group, but
1138 inaccessible to others (equivalent to group unless umask is e.g.
1139 0022). 0640 is a repository that is group-readable but not
1140 group-writable. See git-init(1). False by default.
1141 core.warnAmbiguousRefs
1143 If true, Git will warn you if the ref name you passed it is
1144 ambiguous and might match multiple refs in the repository. True by
1145 default.
1146 core.compression
1148 An integer -1..9, indicating a default compression level. -1 is the
1149 zlib default. 0 means no compression, and 1..9 are various
1150 speed/size tradeoffs, 9 being slowest. If set, this provides a
1151 default to other compression variables, such as
1152 core.looseCompression and pack.compression.
1153 core.looseCompression
1155 An integer -1..9, indicating the compression level for objects that
1156 are not in a pack file. -1 is the zlib default. 0 means no
1157 compression, and 1..9 are various speed/size tradeoffs, 9 being
1158 slowest. If not set, defaults to core.compression. If that is not
1159 set, defaults to 1 (best speed).
1160 core.packedGitWindowSize
1162 Number of bytes of a pack file to map into memory in a single
1163 mapping operation. Larger window sizes may allow your system to
1164 process a smaller number of large pack files more quickly. Smaller
1165 window sizes will negatively affect performance due to increased
1166 calls to the operating system’s memory manager, but may improve
1167 performance when accessing a large number of large pack files.
1168 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
1170 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
1171 be reasonable for all users/operating systems. You probably do not
1172 need to adjust this value.
1173 Common unit suffixes of k, m, or g are supported.
1175 core.packedGitLimit
1177 Maximum number of bytes to map simultaneously into memory from pack
1178 files. If Git needs to access more than this many bytes at once to
1179 complete an operation it will unmap existing regions to reclaim
1180 virtual address space within the process.
1181 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
1183 unlimited) on 64 bit platforms. This should be reasonable for all
1184 users/operating systems, except on the largest projects. You
1185 probably do not need to adjust this value.
1186 Common unit suffixes of k, m, or g are supported.
1188 core.deltaBaseCacheLimit
1190 Maximum number of bytes to reserve for caching base objects that
1191 may be referenced by multiple deltified objects. By storing the
1192 entire decompressed base objects in a cache Git is able to avoid
1193 unpacking and decompressing frequently used base objects multiple
1194 times.
1195 Default is 96 MiB on all platforms. This should be reasonable for
1197 all users/operating systems, except on the largest projects. You
1198 probably do not need to adjust this value.
1199 Common unit suffixes of k, m, or g are supported.
1201 core.bigFileThreshold
1203 Files larger than this size are stored deflated, without attempting
1204 delta compression. Storing large files without delta compression
1205 avoids excessive memory usage, at the slight expense of increased
1206 disk usage. Additionally files larger than this size are always
1207 treated as binary.
1208 Default is 512 MiB on all platforms. This should be reasonable for
1210 most projects as source code and other text files can still be
1211 delta compressed, but larger binary media files won’t be.
1212 Common unit suffixes of k, m, or g are supported.
1214 core.excludesFile
1216 Specifies the pathname to the file that contains patterns to
1217 describe paths that are not meant to be tracked, in addition to
1218 .gitignore (per-directory) and .git/info/exclude. Defaults to
1219 $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set
1220 or empty, $HOME/.config/git/ignore is used instead. See
1221 gitignore(5).
1222 core.askPass
1224 Some commands (e.g. svn and http interfaces) that interactively ask
1225 for a password can be told to use an external program given via the
1226 value of this variable. Can be overridden by the GIT_ASKPASS
1227 environment variable. If not set, fall back to the value of the
1228 SSH_ASKPASS environment variable or, failing that, a simple
1229 password prompt. The external program shall be given a suitable
1230 prompt as command-line argument and write the password on its
1231 STDOUT.
1232 core.attributesFile
1234 In addition to .gitattributes (per-directory) and
1235 .git/info/attributes, Git looks into this file for attributes (see
1236 gitattributes(5)). Path expansions are made the same way as for
1237 core.excludesFile. Its default value is
1238 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
1239 set or empty, $HOME/.config/git/attributes is used instead.
1240 core.hooksPath
1242 By default Git will look for your hooks in the $GIT_DIR/hooks
1243 directory. Set this to different path, e.g. /etc/git/hooks, and
1244 Git will try to find your hooks in that directory, e.g.
1245 /etc/git/hooks/pre-receive instead of in
1246 $GIT_DIR/hooks/pre-receive.
1247 The path can be either absolute or relative. A relative path is
1249 taken as relative to the directory where the hooks are run (see the
1250 "DESCRIPTION" section of githooks(5)).
1251 This configuration variable is useful in cases where you’d like to
1253 centrally configure your Git hooks instead of configuring them on a
1254 per-repository basis, or as a more flexible and centralized
1255 alternative to having an init.templateDir where you’ve changed
1256 default hooks.
1257 core.editor
1259 Commands such as commit and tag that let you edit messages by
1260 launching an editor use the value of this variable when it is set,
1261 and the environment variable GIT_EDITOR is not set. See git-var(1).
1262 core.commentChar
1264 Commands such as commit and tag that let you edit messages consider
1265 a line that begins with this character commented, and removes them
1266 after the editor returns (default #).
1267 If set to "auto", git-commit would select a character that is not
1269 the beginning character of any line in existing commit messages.
1270 core.filesRefLockTimeout
1272 The length of time, in milliseconds, to retry when trying to lock
1273 an individual reference. Value 0 means not to retry at all; -1
1274 means to try indefinitely. Default is 100 (i.e., retry for 100ms).
1275 core.packedRefsTimeout
1277 The length of time, in milliseconds, to retry when trying to lock
1278 the packed-refs file. Value 0 means not to retry at all; -1 means
1279 to try indefinitely. Default is 1000 (i.e., retry for 1 second).
1280 core.pager
1282 Text viewer for use by Git commands (e.g., less). The value is
1283 meant to be interpreted by the shell. The order of preference is
1284 the $GIT_PAGER environment variable, then core.pager configuration,
1285 then $PAGER, and then the default chosen at compile time (usually
1286 less).
1287 When the LESS environment variable is unset, Git sets it to FRX (if
1289 LESS environment variable is set, Git does not change it at all).
1290 If you want to selectively override Git’s default setting for LESS,
1291 you can set core.pager to e.g. less -S. This will be passed to the
1292 shell by Git, which will translate the final command to LESS=FRX
1293 less -S. The environment does not set the S option but the command
1294 line does, instructing less to truncate long lines. Similarly,
1295 setting core.pager to less -+F will deactivate the F option
1296 specified by the environment from the command-line, deactivating
1297 the "quit if one screen" behavior of less. One can specifically
1298 activate some flags for particular commands: for example, setting
1299 pager.blame to less -S enables line truncation only for git blame.
1300 Likewise, when the LV environment variable is unset, Git sets it to
1302 -c. You can override this setting by exporting LV with another
1303 value or setting core.pager to lv +c.
1304 core.whitespace
1306 A comma separated list of common whitespace problems to notice.
1307 git diff will use color.diff.whitespace to highlight them, and git
1308 apply --whitespace=error will consider them as errors. You can
1309 prefix - to disable any of them (e.g. -trailing-space):
1310 · blank-at-eol treats trailing whitespaces at the end of the line
1312 as an error (enabled by default).
1313 · space-before-tab treats a space character that appears
1315 immediately before a tab character in the initial indent part
1316 of the line as an error (enabled by default).
1317 · indent-with-non-tab treats a line that is indented with space
1319 characters instead of the equivalent tabs as an error (not
1320 enabled by default).
1321 · tab-in-indent treats a tab character in the initial indent part
1323 of the line as an error (not enabled by default).
1324 · blank-at-eof treats blank lines added at the end of file as an
1326 error (enabled by default).
1327 · trailing-space is a short-hand to cover both blank-at-eol and
1329 blank-at-eof.
1330 · cr-at-eol treats a carriage-return at the end of line as part
1332 of the line terminator, i.e. with it, trailing-space does not
1333 trigger if the character before such a carriage-return is not a
1334 whitespace (not enabled by default).
1335 · tabwidth=<n> tells how many character positions a tab occupies;
1337 this is relevant for indent-with-non-tab and when Git fixes
1338 tab-in-indent errors. The default tab width is 8. Allowed
1339 values are 1 to 63.
1340 core.fsyncObjectFiles
1342 This boolean will enable fsync() when writing object files.
1343 This is a total waste of time and effort on a filesystem that
1345 orders data writes properly, but can be useful for filesystems that
1346 do not use journalling (traditional UNIX filesystems) or that only
1347 journal metadata and not file contents (OS X’s HFS+, or Linux ext3
1348 with "data=writeback").
1349 core.preloadIndex
1351 Enable parallel index preload for operations like git diff
1352 This can speed up operations like git diff and git status
1354 especially on filesystems like NFS that have weak caching semantics
1355 and thus relatively high IO latencies. When enabled, Git will do
1356 the index comparison to the filesystem data in parallel, allowing
1357 overlapping IO’s. Defaults to true.
1358 core.unsetenvvars
1360 Windows-only: comma-separated list of environment variables' names
1361 that need to be unset before spawning any other process. Defaults
1362 to PERL5LIB to account for the fact that Git for Windows insists on
1363 using its own Perl interpreter.
1364 core.createObject
1366 You can set this to link, in which case a hardlink followed by a
1367 delete of the source are used to make sure that object creation
1368 will not overwrite existing objects.
1369 On some file system/operating system combinations, this is
1371 unreliable. Set this config setting to rename there; However, This
1372 will remove the check that makes sure that existing object files
1373 will not get overwritten.
1374 core.notesRef
1376 When showing commit messages, also show notes which are stored in
1377 the given ref. The ref must be fully qualified. If the given ref
1378 does not exist, it is not an error but means that no notes should
1379 be printed.
1380 This setting defaults to "refs/notes/commits", and it can be
1382 overridden by the GIT_NOTES_REF environment variable. See git-
1383 notes(1).
1384 core.commitGraph
1386 If true, then git will read the commit-graph file (if it exists) to
1387 parse the graph structure of commits. Defaults to false. See git-
1388 commit-graph(1) for more information.
1389 core.useReplaceRefs
1391 If set to false, behave as if the --no-replace-objects option was
1392 given on the command line. See git(1) and git-replace(1) for more
1393 information.
1394 core.multiPackIndex
1396 Use the multi-pack-index file to track multiple packfiles using a
1397 single index. See the multi-pack-index design document[1].
1398 core.sparseCheckout
1400 Enable "sparse checkout" feature. See section "Sparse checkout" in
1401 git-read-tree(1) for more information.
1402 core.abbrev
1404 Set the length object names are abbreviated to. If unspecified or
1405 set to "auto", an appropriate value is computed based on the
1406 approximate number of packed objects in your repository, which
1407 hopefully is enough for abbreviated object names to stay unique for
1408 some time. The minimum length is 4.
1409 add.ignoreErrors, add.ignore-errors (deprecated)
1411 Tells git add to continue adding files when some files cannot be
1412 added due to indexing errors. Equivalent to the --ignore-errors
1413 option of git-add(1). add.ignore-errors is deprecated, as it does
1414 not follow the usual naming convention for configuration variables.
1415 alias.*
1417 Command aliases for the git(1) command wrapper - e.g. after
1418 defining "alias.last = cat-file commit HEAD", the invocation "git
1419 last" is equivalent to "git cat-file commit HEAD". To avoid
1420 confusion and troubles with script usage, aliases that hide
1421 existing Git commands are ignored. Arguments are split by spaces,
1422 the usual shell quoting and escaping is supported. A quote pair or
1423 a backslash can be used to quote them.
1424 If the alias expansion is prefixed with an exclamation point, it
1426 will be treated as a shell command. For example, defining
1427 "alias.new = !gitk --all --not ORIG_HEAD", the invocation "git new"
1428 is equivalent to running the shell command "gitk --all --not
1429 ORIG_HEAD". Note that shell commands will be executed from the
1430 top-level directory of a repository, which may not necessarily be
1431 the current directory. GIT_PREFIX is set as returned by running
1432 git rev-parse --show-prefix from the original current directory.
1433 See git-rev-parse(1).
1434 am.keepcr
1436 If true, git-am will call git-mailsplit for patches in mbox format
1437 with parameter --keep-cr. In this case git-mailsplit will not
1438 remove \r from lines ending with \r\n. Can be overridden by giving
1439 --no-keep-cr from the command line. See git-am(1), git-
1440 mailsplit(1).
1441 am.threeWay
1443 By default, git am will fail if the patch does not apply cleanly.
1444 When set to true, this setting tells git am to fall back on 3-way
1445 merge if the patch records the identity of blobs it is supposed to
1446 apply to and we have those blobs available locally (equivalent to
1447 giving the --3way option from the command line). Defaults to false.
1448 See git-am(1).
1449 apply.ignoreWhitespace
1451 When set to change, tells git apply to ignore changes in
1452 whitespace, in the same way as the --ignore-space-change option.
1453 When set to one of: no, none, never, false tells git apply to
1454 respect all whitespace differences. See git-apply(1).
1455 apply.whitespace
1457 Tells git apply how to handle whitespaces, in the same way as the
1458 --whitespace option. See git-apply(1).
1459 blame.blankBoundary
1461 Show blank commit object name for boundary commits in git-blame(1).
1462 This option defaults to false.
1463 blame.coloring
1465 This determines the coloring scheme to be applied to blame output.
1466 It can be repeatedLines, highlightRecent, or none which is the
1467 default.
1468 blame.date
1470 Specifies the format used to output dates in git-blame(1). If unset
1471 the iso format is used. For supported values, see the discussion of
1472 the --date option at git-log(1).
1473 blame.showEmail
1475 Show the author email instead of author name in git-blame(1). This
1476 option defaults to false.
1477 blame.showRoot
1479 Do not treat root commits as boundaries in git-blame(1). This
1480 option defaults to false.
1481 branch.autoSetupMerge
1483 Tells git branch and git checkout to set up new branches so that
1484 git-pull(1) will appropriately merge from the starting point
1485 branch. Note that even if this option is not set, this behavior can
1486 be chosen per-branch using the --track and --no-track options. The
1487 valid settings are: false — no automatic setup is done; true —
1488 automatic setup is done when the starting point is a
1489 remote-tracking branch; always — automatic setup is done when the
1490 starting point is either a local branch or remote-tracking branch.
1491 This option defaults to true.
1492 branch.autoSetupRebase
1494 When a new branch is created with git branch or git checkout that
1495 tracks another branch, this variable tells Git to set up pull to
1496 rebase instead of merge (see "branch.<name>.rebase"). When never,
1497 rebase is never automatically set to true. When local, rebase is
1498 set to true for tracked branches of other local branches. When
1499 remote, rebase is set to true for tracked branches of
1500 remote-tracking branches. When always, rebase will be set to true
1501 for all tracking branches. See "branch.autoSetupMerge" for details
1502 on how to set up a branch to track another branch. This option
1503 defaults to never.
1504 branch.sort
1506 This variable controls the sort ordering of branches when displayed
1507 by git-branch(1). Without the "--sort=<value>" option provided, the
1508 value of this variable will be used as the default. See git-for-
1509 each-ref(1) field names for valid values.
1510 branch.<name>.remote
1512 When on branch <name>, it tells git fetch and git push which remote
1513 to fetch from/push to. The remote to push to may be overridden with
1514 remote.pushDefault (for all branches). The remote to push to, for
1515 the current branch, may be further overridden by
1516 branch.<name>.pushRemote. If no remote is configured, or if you are
1517 not on any branch, it defaults to origin for fetching and
1518 remote.pushDefault for pushing. Additionally, . (a period) is the
1519 current local repository (a dot-repository), see
1520 branch.<name>.merge's final note below.
1521 branch.<name>.pushRemote
1523 When on branch <name>, it overrides branch.<name>.remote for
1524 pushing. It also overrides remote.pushDefault for pushing from
1525 branch <name>. When you pull from one place (e.g. your upstream)
1526 and push to another place (e.g. your own publishing repository),
1527 you would want to set remote.pushDefault to specify the remote to
1528 push to for all branches, and use this option to override it for a
1529 specific branch.
1530 branch.<name>.merge
1532 Defines, together with branch.<name>.remote, the upstream branch
1533 for the given branch. It tells git fetch/git pull/git rebase which
1534 branch to merge and can also affect git push (see push.default).
1535 When in branch <name>, it tells git fetch the default refspec to be
1536 marked for merging in FETCH_HEAD. The value is handled like the
1537 remote part of a refspec, and must match a ref which is fetched
1538 from the remote given by "branch.<name>.remote". The merge
1539 information is used by git pull (which at first calls git fetch) to
1540 lookup the default branch for merging. Without this option, git
1541 pull defaults to merge the first refspec fetched. Specify multiple
1542 values to get an octopus merge. If you wish to setup git pull so
1543 that it merges into <name> from another branch in the local
1544 repository, you can point branch.<name>.merge to the desired
1545 branch, and use the relative path setting . (a period) for
1546 branch.<name>.remote.
1547 branch.<name>.mergeOptions
1549 Sets default options for merging into branch <name>. The syntax and
1550 supported options are the same as those of git-merge(1), but option
1551 values containing whitespace characters are currently not
1552 supported.
1553 branch.<name>.rebase
1555 When true, rebase the branch <name> on top of the fetched branch,
1556 instead of merging the default branch from the default remote when
1557 "git pull" is run. See "pull.rebase" for doing this in a non
1558 branch-specific manner.
1559 When merges, pass the --rebase-merges option to git rebase so that
1561 the local merge commits are included in the rebase (see git-
1562 rebase(1) for details).
1563 When preserve, also pass --preserve-merges along to git rebase so
1565 that locally committed merge commits will not be flattened by
1566 running git pull.
1567 When the value is interactive, the rebase is run in interactive
1569 mode.
1570 NOTE: this is a possibly dangerous operation; do not use it unless
1572 you understand the implications (see git-rebase(1) for details).
1573 branch.<name>.description
1575 Branch description, can be edited with git branch
1576 --edit-description. Branch description is automatically added in
1577 the format-patch cover letter or request-pull summary.
1578 browser.<tool>.cmd
1580 Specify the command to invoke the specified browser. The specified
1581 command is evaluated in shell with the URLs passed as arguments.
1582 (See git-web--browse(1).)
1583 browser.<tool>.path
1585 Override the path for the given tool that may be used to browse
1586 HTML help (see -w option in git-help(1)) or a working repository in
1587 gitweb (see git-instaweb(1)).
1588 checkout.defaultRemote
1590 When you run git checkout <something> and only have one remote, it
1591 may implicitly fall back on checking out and tracking e.g.
1592 origin/<something>. This stops working as soon as you have more
1593 than one remote with a <something> reference. This setting allows
1594 for setting the name of a preferred remote that should always win
1595 when it comes to disambiguation. The typical use-case is to set
1596 this to origin.
1597 Currently this is used by git-checkout(1) when git checkout
1599 <something> will checkout the <something> branch on another remote,
1600 and by git-worktree(1) when git worktree add refers to a remote
1601 branch. This setting might be used for other checkout-like commands
1602 or functionality in the future.
1603 checkout.optimizeNewBranch
1605 Optimizes the performance of "git checkout -b <new_branch>" when
1606 using sparse-checkout. When set to true, git will not update the
1607 repo based on the current sparse-checkout settings. This means it
1608 will not update the skip-worktree bit in the index nor add/remove
1609 files in the working directory to reflect the current sparse
1610 checkout settings nor will it show the local changes.
1611 clean.requireForce
1613 A boolean to make git-clean do nothing unless given -f, -i or -n.
1614 Defaults to true.
1615 color.advice
1617 A boolean to enable/disable color in hints (e.g. when a push
1618 failed, see advice.* for a list). May be set to always, false (or
1619 never) or auto (or true), in which case colors are used only when
1620 the error output goes to a terminal. If unset, then the value of
1621 color.ui is used (auto by default).
1622 color.advice.hint
1624 Use customized color for hints.
1625 color.blame.highlightRecent
1627 This can be used to color the metadata of a blame line depending on
1628 age of the line.
1629 This setting should be set to a comma-separated list of color and
1631 date settings, starting and ending with a color, the dates should
1632 be set from oldest to newest. The metadata will be colored given
1633 the colors if the the line was introduced before the given
1634 timestamp, overwriting older timestamped colors.
1635 Instead of an absolute timestamp relative timestamps work as well,
1637 e.g. 2.weeks.ago is valid to address anything older than 2 weeks.
1638 It defaults to blue,12 month ago,white,1 month ago,red, which
1640 colors everything older than one year blue, recent changes between
1641 one month and one year old are kept white, and lines introduced
1642 within the last month are colored red.
1643 color.blame.repeatedLines
1645 Use the customized color for the part of git-blame output that is
1646 repeated meta information per line (such as commit id, author name,
1647 date and timezone). Defaults to cyan.
1648 color.branch
1650 A boolean to enable/disable color in the output of git-branch(1).
1651 May be set to always, false (or never) or auto (or true), in which
1652 case colors are used only when the output is to a terminal. If
1653 unset, then the value of color.ui is used (auto by default).
1654 color.branch.<slot>
1656 Use customized color for branch coloration. <slot> is one of
1657 current (the current branch), local (a local branch), remote (a
1658 remote-tracking branch in refs/remotes/), upstream (upstream
1659 tracking branch), plain (other refs).
1660 color.diff
1662 Whether to use ANSI escape sequences to add color to patches. If
1663 this is set to always, git-diff(1), git-log(1), and git-show(1)
1664 will use color for all patches. If it is set to true or auto, those
1665 commands will only use color when output is to the terminal. If
1666 unset, then the value of color.ui is used (auto by default).
1667 This does not affect git-format-patch(1) or the git-diff-* plumbing
1669 commands. Can be overridden on the command line with the
1670 --color[=<when>] option.
1671 color.diff.<slot>
1673 Use customized color for diff colorization. <slot> specifies which
1674 part of the patch to use the specified color, and is one of context
1675 (context text - plain is a historical synonym), meta
1676 (metainformation), frag (hunk header), func (function in hunk
1677 header), old (removed lines), new (added lines), commit (commit
1678 headers), whitespace (highlighting whitespace errors), oldMoved
1679 (deleted lines), newMoved (added lines), oldMovedDimmed,
1680 oldMovedAlternative, oldMovedAlternativeDimmed, newMovedDimmed,
1681 newMovedAlternative newMovedAlternativeDimmed (See the <mode>
1682 setting of --color-moved in git-diff(1) for details),
1683 contextDimmed, oldDimmed, newDimmed, contextBold, oldBold, and
1684 newBold (see git-range-diff(1) for details).
1685 color.decorate.<slot>
1687 Use customized color for git log --decorate output. <slot> is one
1688 of branch, remoteBranch, tag, stash or HEAD for local branches,
1689 remote-tracking branches, tags, stash and HEAD, respectively and
1690 grafted for grafted commits.
1691 color.grep
1693 When set to always, always highlight matches. When false (or
1694 never), never. When set to true or auto, use color only when the
1695 output is written to the terminal. If unset, then the value of
1696 color.ui is used (auto by default).
1697 color.grep.<slot>
1699 Use customized color for grep colorization. <slot> specifies which
1700 part of the line to use the specified color, and is one of
1701 context
1703 non-matching text in context lines (when using -A, -B, or -C)
1704 filename
1706 filename prefix (when not using -h)
1707 function
1709 function name lines (when using -p)
1710 lineNumber
1712 line number prefix (when using -n)
1713 column
1715 column number prefix (when using --column)
1716 match
1718 matching text (same as setting matchContext and matchSelected)
1719 matchContext
1721 matching text in context lines
1722 matchSelected
1724 matching text in selected lines
1725 selected
1727 non-matching text in selected lines
1728 separator
1730 separators between fields on a line (:, -, and =) and between
1731 hunks (--)
1732 color.interactive
1734 When set to always, always use colors for interactive prompts and
1735 displays (such as those used by "git-add --interactive" and
1736 "git-clean --interactive"). When false (or never), never. When set
1737 to true or auto, use colors only when the output is to the
1738 terminal. If unset, then the value of color.ui is used (auto by
1739 default).
1740 color.interactive.<slot>
1742 Use customized color for git add --interactive and git clean
1743 --interactive output. <slot> may be prompt, header, help or error,
1744 for four distinct types of normal output from interactive commands.
1745 color.pager
1747 A boolean to enable/disable colored output when the pager is in use
1748 (default is true).
1749 color.push
1751 A boolean to enable/disable color in push errors. May be set to
1752 always, false (or never) or auto (or true), in which case colors
1753 are used only when the error output goes to a terminal. If unset,
1754 then the value of color.ui is used (auto by default).
1755 color.push.error
1757 Use customized color for push errors.
1758 color.remote
1760 If set, keywords at the start of the line are highlighted. The
1761 keywords are "error", "warning", "hint" and "success", and are
1762 matched case-insensitively. May be set to always, false (or never)
1763 or auto (or true). If unset, then the value of color.ui is used
1764 (auto by default).
1765 color.remote.<slot>
1767 Use customized color for each remote keyword. <slot> may be hint,
1768 warning, success or error which match the corresponding keyword.
1769 color.showBranch
1771 A boolean to enable/disable color in the output of git-show-
1772 branch(1). May be set to always, false (or never) or auto (or
1773 true), in which case colors are used only when the output is to a
1774 terminal. If unset, then the value of color.ui is used (auto by
1775 default).
1776 color.status
1778 A boolean to enable/disable color in the output of git-status(1).
1779 May be set to always, false (or never) or auto (or true), in which
1780 case colors are used only when the output is to a terminal. If
1781 unset, then the value of color.ui is used (auto by default).
1782 color.status.<slot>
1784 Use customized color for status colorization. <slot> is one of
1785 header (the header text of the status message), added or updated
1786 (files which are added but not committed), changed (files which are
1787 changed but not added in the index), untracked (files which are not
1788 tracked by Git), branch (the current branch), nobranch (the color
1789 the no branch warning is shown in, defaulting to red), localBranch
1790 or remoteBranch (the local and remote branch names, respectively,
1791 when branch and tracking information is displayed in the status
1792 short-format), or unmerged (files which have unmerged changes).
1793 color.transport
1795 A boolean to enable/disable color when pushes are rejected. May be
1796 set to always, false (or never) or auto (or true), in which case
1797 colors are used only when the error output goes to a terminal. If
1798 unset, then the value of color.ui is used (auto by default).
1799 color.transport.rejected
1801 Use customized color when a push was rejected.
1802 color.ui
1804 This variable determines the default value for variables such as
1805 color.diff and color.grep that control the use of color per command
1806 family. Its scope will expand as more commands learn configuration
1807 to set a default for the --color option. Set it to false or never
1808 if you prefer Git commands not to use color unless enabled
1809 explicitly with some other configuration or the --color option. Set
1810 it to always if you want all output not intended for machine
1811 consumption to use color, to true or auto (this is the default
1812 since Git 1.8.4) if you want such output to use color when written
1813 to the terminal.
1814 column.ui
1816 Specify whether supported commands should output in columns. This
1817 variable consists of a list of tokens separated by spaces or
1818 commas:
1819 These options control when the feature should be enabled (defaults
1821 to never):
1822 always
1824 always show in columns
1825 never
1827 never show in columns
1828 auto
1830 show in columns if the output is to the terminal
1831 These options control layout (defaults to column). Setting any of
1833 these implies always if none of always, never, or auto are
1834 specified.
1835 column
1837 fill columns before rows
1838 row
1840 fill rows before columns
1841 plain
1843 show in one column
1844 Finally, these options can be combined with a layout option
1846 (defaults to nodense):
1847 dense
1849 make unequal size columns to utilize more space
1850 nodense
1852 make equal size columns
1853 column.branch
1855 Specify whether to output branch listing in git branch in columns.
1856 See column.ui for details.
1857 column.clean
1859 Specify the layout when list items in git clean -i, which always
1860 shows files and directories in columns. See column.ui for details.
1861 column.status
1863 Specify whether to output untracked files in git status in columns.
1864 See column.ui for details.
1865 column.tag
1867 Specify whether to output tag listing in git tag in columns. See
1868 column.ui for details.
1869 commit.cleanup
1871 This setting overrides the default of the --cleanup option in git
1872 commit. See git-commit(1) for details. Changing the default can be
1873 useful when you always want to keep lines that begin with comment
1874 character # in your log message, in which case you would do git
1875 config commit.cleanup whitespace (note that you will have to remove
1876 the help lines that begin with # in the commit log template
1877 yourself, if you do this).
1878 commit.gpgSign
1880 A boolean to specify whether all commits should be GPG signed. Use
1881 of this option when doing operations such as rebase can result in a
1882 large number of commits being signed. It may be convenient to use
1883 an agent to avoid typing your GPG passphrase several times.
1884 commit.status
1886 A boolean to enable/disable inclusion of status information in the
1887 commit message template when using an editor to prepare the commit
1888 message. Defaults to true.
1889 commit.template
1891 Specify the pathname of a file to use as the template for new
1892 commit messages.
1893 commit.verbose
1895 A boolean or int to specify the level of verbose with git commit.
1896 See git-commit(1).
1897 credential.helper
1899 Specify an external helper to be called when a username or password
1900 credential is needed; the helper may consult external storage to
1901 avoid prompting the user for the credentials. Note that multiple
1902 helpers may be defined. See gitcredentials(7) for details.
1903 credential.useHttpPath
1905 When acquiring credentials, consider the "path" component of an
1906 http or https URL to be important. Defaults to false. See
1907 gitcredentials(7) for more information.
1908 credential.username
1910 If no username is set for a network authentication, use this
1911 username by default. See credential.<context>.* below, and
1912 gitcredentials(7).
1913 credential.<url>.*
1915 Any of the credential.* options above can be applied selectively to
1916 some credentials. For example
1917 "credential.https://example.com.username" would set the default
1918 username only for https connections to example.com. See
1919 gitcredentials(7) for details on how URLs are matched.
1920 credentialCache.ignoreSIGHUP
1922 Tell git-credential-cache—daemon to ignore SIGHUP, instead of
1923 quitting.
1924 completion.commands
1926 This is only used by git-completion.bash to add or remove commands
1927 from the list of completed commands. Normally only porcelain
1928 commands and a few select others are completed. You can add more
1929 commands, separated by space, in this variable. Prefixing the
1930 command with - will remove it from the existing list.
1931 diff.autoRefreshIndex
1933 When using git diff to compare with work tree files, do not
1934 consider stat-only change as changed. Instead, silently run git
1935 update-index --refresh to update the cached stat information for
1936 paths whose contents in the work tree match the contents in the
1937 index. This option defaults to true. Note that this affects only
1938 git diff Porcelain, and not lower level diff commands such as git
1939 diff-files.
1940 diff.dirstat
1942 A comma separated list of --dirstat parameters specifying the
1943 default behavior of the --dirstat option to git-diff(1)` and
1944 friends. The defaults can be overridden on the command line (using
1945 --dirstat=<param1,param2,...>). The fallback defaults (when not
1946 changed by diff.dirstat) are changes,noncumulative,3. The following
1947 parameters are available:
1948 changes
1950 Compute the dirstat numbers by counting the lines that have
1951 been removed from the source, or added to the destination. This
1952 ignores the amount of pure code movements within a file. In
1953 other words, rearranging lines in a file is not counted as much
1954 as other changes. This is the default behavior when no
1955 parameter is given.
1956 lines
1958 Compute the dirstat numbers by doing the regular line-based
1959 diff analysis, and summing the removed/added line counts. (For
1960 binary files, count 64-byte chunks instead, since binary files
1961 have no natural concept of lines). This is a more expensive
1962 --dirstat behavior than the changes behavior, but it does count
1963 rearranged lines within a file as much as other changes. The
1964 resulting output is consistent with what you get from the other
1965 --*stat options.
1966 files
1968 Compute the dirstat numbers by counting the number of files
1969 changed. Each changed file counts equally in the dirstat
1970 analysis. This is the computationally cheapest --dirstat
1971 behavior, since it does not have to look at the file contents
1972 at all.
1973 cumulative
1975 Count changes in a child directory for the parent directory as
1976 well. Note that when using cumulative, the sum of the
1977 percentages reported may exceed 100%. The default
1978 (non-cumulative) behavior can be specified with the
1979 noncumulative parameter.
1980 <limit>
1982 An integer parameter specifies a cut-off percent (3% by
1983 default). Directories contributing less than this percentage of
1984 the changes are not shown in the output.
1985 Example: The following will count changed files, while ignoring
1987 directories with less than 10% of the total amount of changed
1988 files, and accumulating child directory counts in the parent
1989 directories: files,10,cumulative.
1990 diff.statGraphWidth
1992 Limit the width of the graph part in --stat output. If set, applies
1993 to all commands generating --stat output except format-patch.
1994 diff.context
1996 Generate diffs with <n> lines of context instead of the default of
1997 3. This value is overridden by the -U option.
1998 diff.interHunkContext
2000 Show the context between diff hunks, up to the specified number of
2001 lines, thereby fusing the hunks that are close to each other. This
2002 value serves as the default for the --inter-hunk-context command
2003 line option.
2004 diff.external
2006 If this config variable is set, diff generation is not performed
2007 using the internal diff machinery, but using the given command. Can
2008 be overridden with the ‘GIT_EXTERNAL_DIFF’ environment variable.
2009 The command is called with parameters as described under "git
2010 Diffs" in git(1). Note: if you want to use an external diff program
2011 only on a subset of your files, you might want to use
2012 gitattributes(5) instead.
2013 diff.ignoreSubmodules
2015 Sets the default value of --ignore-submodules. Note that this
2016 affects only git diff Porcelain, and not lower level diff commands
2017 such as git diff-files. git checkout also honors this setting when
2018 reporting uncommitted changes. Setting it to all disables the
2019 submodule summary normally shown by git commit and git status when
2020 status.submoduleSummary is set unless it is overridden by using the
2021 --ignore-submodules command-line option. The git submodule commands
2022 are not affected by this setting.
2023 diff.mnemonicPrefix
2025 If set, git diff uses a prefix pair that is different from the
2026 standard "a/" and "b/" depending on what is being compared. When
2027 this configuration is in effect, reverse diff output also swaps the
2028 order of the prefixes:
2029 git diff
2031 compares the (i)ndex and the (w)ork tree;
2032 git diff HEAD
2034 compares a (c)ommit and the (w)ork tree;
2035 git diff --cached
2037 compares a (c)ommit and the (i)ndex;
2038 git diff HEAD:file1 file2
2040 compares an (o)bject and a (w)ork tree entity;
2041 git diff --no-index a b
2043 compares two non-git things (1) and (2).
2044 diff.noprefix
2046 If set, git diff does not show any source or destination prefix.
2047 diff.orderFile
2049 File indicating how to order files within a diff. See the -O option
2050 to git-diff(1) for details. If diff.orderFile is a relative
2051 pathname, it is treated as relative to the top of the working tree.
2052 diff.renameLimit
2054 The number of files to consider when performing the copy/rename
2055 detection; equivalent to the git diff option -l. This setting has
2056 no effect if rename detection is turned off.
2057 diff.renames
2059 Whether and how Git detects renames. If set to "false", rename
2060 detection is disabled. If set to "true", basic rename detection is
2061 enabled. If set to "copies" or "copy", Git will detect copies, as
2062 well. Defaults to true. Note that this affects only git diff
2063 Porcelain like git-diff(1) and git-log(1), and not lower level
2064 commands such as git-diff-files(1).
2065 diff.suppressBlankEmpty
2067 A boolean to inhibit the standard behavior of printing a space
2068 before each empty output line. Defaults to false.
2069 diff.submodule
2071 Specify the format in which differences in submodules are shown.
2072 The "short" format just shows the names of the commits at the
2073 beginning and end of the range. The "log" format lists the commits
2074 in the range like git-submodule(1) summary does. The "diff" format
2075 shows an inline diff of the changed contents of the submodule.
2076 Defaults to "short".
2077 diff.wordRegex
2079 A POSIX Extended Regular Expression used to determine what is a
2080 "word" when performing word-by-word difference calculations.
2081 Character sequences that match the regular expression are "words",
2082 all other characters are ignorable whitespace.
2083 diff.<driver>.command
2085 The custom diff driver command. See gitattributes(5) for details.
2086 diff.<driver>.xfuncname
2088 The regular expression that the diff driver should use to recognize
2089 the hunk header. A built-in pattern may also be used. See
2090 gitattributes(5) for details.
2091 diff.<driver>.binary
2093 Set this option to true to make the diff driver treat files as
2094 binary. See gitattributes(5) for details.
2095 diff.<driver>.textconv
2097 The command that the diff driver should call to generate the
2098 text-converted version of a file. The result of the conversion is
2099 used to generate a human-readable diff. See gitattributes(5) for
2100 details.
2101 diff.<driver>.wordRegex
2103 The regular expression that the diff driver should use to split
2104 words in a line. See gitattributes(5) for details.
2105 diff.<driver>.cachetextconv
2107 Set this option to true to make the diff driver cache the text
2108 conversion outputs. See gitattributes(5) for details.
2109 diff.tool
2111 Controls which diff tool is used by git-difftool(1). This variable
2112 overrides the value configured in merge.tool. The list below shows
2113 the valid built-in values. Any other value is treated as a custom
2114 diff tool and requires that a corresponding difftool.<tool>.cmd
2115 variable is defined.
2116 diff.guitool
2118 Controls which diff tool is used by git-difftool(1) when the
2119 -g/--gui flag is specified. This variable overrides the value
2120 configured in merge.guitool. The list below shows the valid
2121 built-in values. Any other value is treated as a custom diff tool
2122 and requires that a corresponding difftool.<guitool>.cmd variable
2123 is defined.
2124 · araxis
2126 · bc
2128 · bc3
2130 · codecompare
2132 · deltawalker
2134 · diffmerge
2136 · diffuse
2138 · ecmerge
2140 · emerge
2142 · examdiff
2144 · guiffy
2146 · gvimdiff
2148 · gvimdiff2
2150 · gvimdiff3
2152 · kdiff3
2154 · kompare
2156 · meld
2158 · opendiff
2160 · p4merge
2162 · tkdiff
2164 · vimdiff
2166 · vimdiff2
2168 · vimdiff3
2170 · winmerge
2172 · xxdiff
2174 diff.indentHeuristic
2176 Set this option to true to enable experimental heuristics that
2177 shift diff hunk boundaries to make patches easier to read.
2178 diff.algorithm
2180 Choose a diff algorithm. The variants are as follows:
2181 default, myers
2183 The basic greedy diff algorithm. Currently, this is the
2184 default.
2185 minimal
2187 Spend extra time to make sure the smallest possible diff is
2188 produced.
2189 patience
2191 Use "patience diff" algorithm when generating patches.
2192 histogram
2194 This algorithm extends the patience algorithm to "support
2195 low-occurrence common elements".
2196 diff.wsErrorHighlight
2198 Highlight whitespace errors in the context, old or new lines of the
2199 diff. Multiple values are separated by comma, none resets previous
2200 values, default reset the list to new and all is a shorthand for
2201 old,new,context. The whitespace errors are colored with
2202 color.diff.whitespace. The command line option
2203 --ws-error-highlight=<kind> overrides this setting.
2204 diff.colorMoved
2206 If set to either a valid <mode> or a true value, moved lines in a
2207 diff are colored differently, for details of valid modes see
2208 --color-moved in git-diff(1). If simply set to true the default
2209 color mode will be used. When set to false, moved lines are not
2210 colored.
2211 diff.colorMovedWS
2213 When moved lines are colored using e.g. the diff.colorMoved
2214 setting, this option controls the <mode> how spaces are treated for
2215 details of valid modes see --color-moved-ws in git-diff(1).
2216 difftool.<tool>.path
2218 Override the path for the given tool. This is useful in case your
2219 tool is not in the PATH.
2220 difftool.<tool>.cmd
2222 Specify the command to invoke the specified diff tool. The
2223 specified command is evaluated in shell with the following
2224 variables available: LOCAL is set to the name of the temporary file
2225 containing the contents of the diff pre-image and REMOTE is set to
2226 the name of the temporary file containing the contents of the diff
2227 post-image.
2228 difftool.prompt
2230 Prompt before each invocation of the diff tool.
2231 fastimport.unpackLimit
2233 If the number of objects imported by git-fast-import(1) is below
2234 this limit, then the objects will be unpacked into loose object
2235 files. However if the number of imported objects equals or exceeds
2236 this limit then the pack will be stored as a pack. Storing the pack
2237 from a fast-import can make the import operation complete faster,
2238 especially on slow filesystems. If not set, the value of
2239 transfer.unpackLimit is used instead.
2240 fetch.recurseSubmodules
2242 This option can be either set to a boolean value or to on-demand.
2243 Setting it to a boolean changes the behavior of fetch and pull to
2244 unconditionally recurse into submodules when set to true or to not
2245 recurse at all when set to false. When set to on-demand (the
2246 default value), fetch and pull will only recurse into a populated
2247 submodule when its superproject retrieves a commit that updates the
2248 submodule’s reference.
2249 fetch.fsckObjects
2251 If it is set to true, git-fetch-pack will check all fetched
2252 objects. See transfer.fsckObjects for what’s checked. Defaults to
2253 false. If not set, the value of transfer.fsckObjects is used
2254 instead.
2255 fetch.fsck.<msg-id>
2257 Acts like fsck.<msg-id>, but is used by git-fetch-pack(1) instead
2258 of git-fsck(1). See the fsck.<msg-id> documentation for details.
2259 fetch.fsck.skipList
2261 Acts like fsck.skipList, but is used by git-fetch-pack(1) instead
2262 of git-fsck(1). See the fsck.skipList documentation for details.
2263 fetch.unpackLimit
2265 If the number of objects fetched over the Git native transfer is
2266 below this limit, then the objects will be unpacked into loose
2267 object files. However if the number of received objects equals or
2268 exceeds this limit then the received pack will be stored as a pack,
2269 after adding any missing delta bases. Storing the pack from a push
2270 can make the push operation complete faster, especially on slow
2271 filesystems. If not set, the value of transfer.unpackLimit is used
2272 instead.
2273 fetch.prune
2275 If true, fetch will automatically behave as if the --prune option
2276 was given on the command line. See also remote.<name>.prune and the
2277 PRUNING section of git-fetch(1).
2278 fetch.pruneTags
2280 If true, fetch will automatically behave as if the
2281 refs/tags/*:refs/tags/* refspec was provided when pruning, if not
2282 set already. This allows for setting both this option and
2283 fetch.prune to maintain a 1=1 mapping to upstream refs. See also
2284 remote.<name>.pruneTags and the PRUNING section of git-fetch(1).
2285 fetch.output
2287 Control how ref update status is printed. Valid values are full and
2288 compact. Default value is full. See section OUTPUT in git-fetch(1)
2289 for detail.
2290 fetch.negotiationAlgorithm
2292 Control how information about the commits in the local repository
2293 is sent when negotiating the contents of the packfile to be sent by
2294 the server. Set to "skipping" to use an algorithm that skips
2295 commits in an effort to converge faster, but may result in a
2296 larger-than-necessary packfile; The default is "default" which
2297 instructs Git to use the default algorithm that never skips commits
2298 (unless the server has acknowledged it or one of its descendants).
2299 Unknown values will cause git fetch to error out.
2300 See also the --negotiation-tip option for git-fetch(1).
2302 format.attach
2304 Enable multipart/mixed attachments as the default for format-patch.
2305 The value can also be a double quoted string which will enable
2306 attachments as the default and set the value as the boundary. See
2307 the --attach option in git-format-patch(1).
2308 format.from
2310 Provides the default value for the --from option to format-patch.
2311 Accepts a boolean value, or a name and email address. If false,
2312 format-patch defaults to --no-from, using commit authors directly
2313 in the "From:" field of patch mails. If true, format-patch defaults
2314 to --from, using your committer identity in the "From:" field of
2315 patch mails and including a "From:" field in the body of the patch
2316 mail if different. If set to a non-boolean value, format-patch uses
2317 that value instead of your committer identity. Defaults to false.
2318 format.numbered
2320 A boolean which can enable or disable sequence numbers in patch
2321 subjects. It defaults to "auto" which enables it only if there is
2322 more than one patch. It can be enabled or disabled for all messages
2323 by setting it to "true" or "false". See --numbered option in git-
2324 format-patch(1).
2325 format.headers
2327 Additional email headers to include in a patch to be submitted by
2328 mail. See git-format-patch(1).
2329 format.to, format.cc
2331 Additional recipients to include in a patch to be submitted by
2332 mail. See the --to and --cc options in git-format-patch(1).
2333 format.subjectPrefix
2335 The default for format-patch is to output files with the [PATCH]
2336 subject prefix. Use this variable to change that prefix.
2337 format.signature
2339 The default for format-patch is to output a signature containing
2340 the Git version number. Use this variable to change that default.
2341 Set this variable to the empty string ("") to suppress signature
2342 generation.
2343 format.signatureFile
2345 Works just like format.signature except the contents of the file
2346 specified by this variable will be used as the signature.
2347 format.suffix
2349 The default for format-patch is to output files with the suffix
2350 .patch. Use this variable to change that suffix (make sure to
2351 include the dot if you want it).
2352 format.pretty
2354 The default pretty format for log/show/whatchanged command, See
2355 git-log(1), git-show(1), git-whatchanged(1).
2356 format.thread
2358 The default threading style for git format-patch. Can be a boolean
2359 value, or shallow or deep. shallow threading makes every mail a
2360 reply to the head of the series, where the head is chosen from the
2361 cover letter, the --in-reply-to, and the first patch mail, in this
2362 order. deep threading makes every mail a reply to the previous
2363 one. A true boolean value is the same as shallow, and a false value
2364 disables threading.
2365 format.signOff
2367 A boolean value which lets you enable the -s/--signoff option of
2368 format-patch by default. Note: Adding the Signed-off-by: line to a
2369 patch should be a conscious act and means that you certify you have
2370 the rights to submit this work under the same open source license.
2371 Please see the SubmittingPatches document for further discussion.
2372 format.coverLetter
2374 A boolean that controls whether to generate a cover-letter when
2375 format-patch is invoked, but in addition can be set to "auto", to
2376 generate a cover-letter only when there’s more than one patch.
2377 format.outputDirectory
2379 Set a custom directory to store the resulting files instead of the
2380 current working directory.
2381 format.useAutoBase
2383 A boolean value which lets you enable the --base=auto option of
2384 format-patch by default.
2385 filter.<driver>.clean
2387 The command which is used to convert the content of a worktree file
2388 to a blob upon checkin. See gitattributes(5) for details.
2389 filter.<driver>.smudge
2391 The command which is used to convert the content of a blob object
2392 to a worktree file upon checkout. See gitattributes(5) for details.
2393 fsck.<msg-id>
2395 During fsck git may find issues with legacy data which wouldn’t be
2396 generated by current versions of git, and which wouldn’t be sent
2397 over the wire if transfer.fsckObjects was set. This feature is
2398 intended to support working with legacy repositories containing
2399 such data.
2400 Setting fsck.<msg-id> will be picked up by git-fsck(1), but to
2402 accept pushes of such data set receive.fsck.<msg-id> instead, or to
2403 clone or fetch it set fetch.fsck.<msg-id>.
2404 The rest of the documentation discusses fsck.* for brevity, but
2406 the same applies for the corresponding receive.fsck.* and
2407 fetch.<msg-id>.*. variables.
2408 Unlike variables like color.ui and core.editor the
2410 receive.fsck.<msg-id> and fetch.fsck.<msg-id> variables will not
2411 fall back on the fsck.<msg-id> configuration if they aren’t set. To
2412 uniformly configure the same fsck settings in different
2413 circumstances all three of them they must all set to the same
2414 values.
2415 When fsck.<msg-id> is set, errors can be switched to warnings and
2417 vice versa by configuring the fsck.<msg-id> setting where the
2418 <msg-id> is the fsck message ID and the value is one of error, warn
2419 or ignore. For convenience, fsck prefixes the error/warning with
2420 the message ID, e.g. "missingEmail: invalid author/committer line -
2421 missing email" means that setting fsck.missingEmail = ignore will
2422 hide that issue.
2423 In general, it is better to enumerate existing objects with
2425 problems with fsck.skipList, instead of listing the kind of
2426 breakages these problematic objects share to be ignored, as doing
2427 the latter will allow new instances of the same breakages go
2428 unnoticed.
2429 Setting an unknown fsck.<msg-id> value will cause fsck to die, but
2431 doing the same for receive.fsck.<msg-id> and fetch.fsck.<msg-id>
2432 will only cause git to warn.
2433 fsck.skipList
2435 The path to a list of object names (i.e. one unabbreviated SHA-1
2436 per line) that are known to be broken in a non-fatal way and should
2437 be ignored. On versions of Git 2.20 and later comments (#), empty
2438 lines, and any leading and trailing whitespace is ignored.
2439 Everything but a SHA-1 per line will error out on older versions.
2440 This feature is useful when an established project should be
2442 accepted despite early commits containing errors that can be safely
2443 ignored such as invalid committer email addresses. Note: corrupt
2444 objects cannot be skipped with this setting.
2445 Like fsck.<msg-id> this variable has corresponding
2447 receive.fsck.skipList and fetch.fsck.skipList variants.
2448 Unlike variables like color.ui and core.editor the
2450 receive.fsck.skipList and fetch.fsck.skipList variables will not
2451 fall back on the fsck.skipList configuration if they aren’t set. To
2452 uniformly configure the same fsck settings in different
2453 circumstances all three of them they must all set to the same
2454 values.
2455 Older versions of Git (before 2.20) documented that the object
2457 names list should be sorted. This was never a requirement, the
2458 object names could appear in any order, but when reading the list
2459 we tracked whether the list was sorted for the purposes of an
2460 internal binary search implementation, which could save itself some
2461 work with an already sorted list. Unless you had a humongous list
2462 there was no reason to go out of your way to pre-sort the list.
2463 After Git version 2.20 a hash implementation is used instead, so
2464 there’s now no reason to pre-sort the list.
2465 gc.aggressiveDepth
2467 The depth parameter used in the delta compression algorithm used by
2468 git gc --aggressive. This defaults to 50.
2469 gc.aggressiveWindow
2471 The window size parameter used in the delta compression algorithm
2472 used by git gc --aggressive. This defaults to 250.
2473 gc.auto
2475 When there are approximately more than this many loose objects in
2476 the repository, git gc --auto will pack them. Some Porcelain
2477 commands use this command to perform a light-weight garbage
2478 collection from time to time. The default value is 6700. Setting
2479 this to 0 disables it.
2480 gc.autoPackLimit
2482 When there are more than this many packs that are not marked with
2483 *.keep file in the repository, git gc --auto consolidates them into
2484 one larger pack. The default value is 50. Setting this to 0
2485 disables it.
2486 gc.autoDetach
2488 Make git gc --auto return immediately and run in background if the
2489 system supports it. Default is true.
2490 gc.bigPackThreshold
2492 If non-zero, all packs larger than this limit are kept when git gc
2493 is run. This is very similar to --keep-base-pack except that all
2494 packs that meet the threshold are kept, not just the base pack.
2495 Defaults to zero. Common unit suffixes of k, m, or g are supported.
2496 Note that if the number of kept packs is more than
2498 gc.autoPackLimit, this configuration variable is ignored, all packs
2499 except the base pack will be repacked. After this the number of
2500 packs should go below gc.autoPackLimit and gc.bigPackThreshold
2501 should be respected again.
2502 gc.writeCommitGraph
2504 If true, then gc will rewrite the commit-graph file when git-gc(1)
2505 is run. When using git-gc(1) --auto the commit-graph will be
2506 updated if housekeeping is required. Default is false. See git-
2507 commit-graph(1) for details.
2508 gc.logExpiry
2510 If the file gc.log exists, then git gc --auto will print its
2511 content and exit with status zero instead of running unless that
2512 file is more than gc.logExpiry old. Default is "1.day". See
2513 gc.pruneExpire for more ways to specify its value.
2514 gc.packRefs
2516 Running git pack-refs in a repository renders it unclonable by Git
2517 versions prior to 1.5.1.2 over dumb transports such as HTTP. This
2518 variable determines whether git gc runs git pack-refs. This can be
2519 set to notbare to enable it within all non-bare repos or it can be
2520 set to a boolean value. The default is true.
2521 gc.pruneExpire
2523 When git gc is run, it will call prune --expire 2.weeks.ago.
2524 Override the grace period with this config variable. The value
2525 "now" may be used to disable this grace period and always prune
2526 unreachable objects immediately, or "never" may be used to suppress
2527 pruning. This feature helps prevent corruption when git gc runs
2528 concurrently with another process writing to the repository; see
2529 the "NOTES" section of git-gc(1).
2530 gc.worktreePruneExpire
2532 When git gc is run, it calls git worktree prune --expire
2533 3.months.ago. This config variable can be used to set a different
2534 grace period. The value "now" may be used to disable the grace
2535 period and prune $GIT_DIR/worktrees immediately, or "never" may be
2536 used to suppress pruning.
2537 gc.reflogExpire, gc.<pattern>.reflogExpire
2539 git reflog expire removes reflog entries older than this time;
2540 defaults to 90 days. The value "now" expires all entries
2541 immediately, and "never" suppresses expiration altogether. With
2542 "<pattern>" (e.g. "refs/stash") in the middle the setting applies
2543 only to the refs that match the <pattern>.
2544 gc.reflogExpireUnreachable, gc.<pattern>.reflogExpireUnreachable
2546 git reflog expire removes reflog entries older than this time and
2547 are not reachable from the current tip; defaults to 30 days. The
2548 value "now" expires all entries immediately, and "never" suppresses
2549 expiration altogether. With "<pattern>" (e.g. "refs/stash") in the
2550 middle, the setting applies only to the refs that match the
2551 <pattern>.
2552 gc.rerereResolved
2554 Records of conflicted merge you resolved earlier are kept for this
2555 many days when git rerere gc is run. You can also use more
2556 human-readable "1.month.ago", etc. The default is 60 days. See git-
2557 rerere(1).
2558 gc.rerereUnresolved
2560 Records of conflicted merge you have not resolved are kept for this
2561 many days when git rerere gc is run. You can also use more
2562 human-readable "1.month.ago", etc. The default is 15 days. See git-
2563 rerere(1).
2564 gitcvs.commitMsgAnnotation
2566 Append this string to each commit message. Set to empty string to
2567 disable this feature. Defaults to "via git-CVS emulator".
2568 gitcvs.enabled
2570 Whether the CVS server interface is enabled for this repository.
2571 See git-cvsserver(1).
2572 gitcvs.logFile
2574 Path to a log file where the CVS server interface well... logs
2575 various stuff. See git-cvsserver(1).
2576 gitcvs.usecrlfattr
2578 If true, the server will look up the end-of-line conversion
2579 attributes for files to determine the -k modes to use. If the
2580 attributes force Git to treat a file as text, the -k mode will be
2581 left blank so CVS clients will treat it as text. If they suppress
2582 text conversion, the file will be set with -kb mode, which
2583 suppresses any newline munging the client might otherwise do. If
2584 the attributes do not allow the file type to be determined, then
2585 gitcvs.allBinary is used. See gitattributes(5).
2586 gitcvs.allBinary
2588 This is used if gitcvs.usecrlfattr does not resolve the correct -kb
2589 mode to use. If true, all unresolved files are sent to the client
2590 in mode -kb. This causes the client to treat them as binary files,
2591 which suppresses any newline munging it otherwise might do.
2592 Alternatively, if it is set to "guess", then the contents of the
2593 file are examined to decide if it is binary, similar to
2594 core.autocrlf.
2595 gitcvs.dbName
2597 Database used by git-cvsserver to cache revision information
2598 derived from the Git repository. The exact meaning depends on the
2599 used database driver, for SQLite (which is the default driver) this
2600 is a filename. Supports variable substitution (see git-cvsserver(1)
2601 for details). May not contain semicolons (;). Default:
2602 %Ggitcvs.%m.sqlite
2603 gitcvs.dbDriver
2605 Used Perl DBI driver. You can specify any available driver for this
2606 here, but it might not work. git-cvsserver is tested with
2607 DBD::SQLite, reported to work with DBD::Pg, and reported not to
2608 work with DBD::mysql. Experimental feature. May not contain double
2609 colons (:). Default: SQLite. See git-cvsserver(1).
2610 gitcvs.dbUser, gitcvs.dbPass
2612 Database user and password. Only useful if setting gitcvs.dbDriver,
2613 since SQLite has no concept of database users and/or passwords.
2614 gitcvs.dbUser supports variable substitution (see git-cvsserver(1)
2615 for details).
2616 gitcvs.dbTableNamePrefix
2618 Database table name prefix. Prepended to the names of any database
2619 tables used, allowing a single database to be used for several
2620 repositories. Supports variable substitution (see git-cvsserver(1)
2621 for details). Any non-alphabetic characters will be replaced with
2622 underscores.
2623 All gitcvs variables except for gitcvs.usecrlfattr and gitcvs.allBinary
2625 can also be specified as gitcvs.<access_method>.<varname> (where
2626 access_method is one of "ext" and "pserver") to make them apply only
2627 for the given access method.
2628 gitweb.category, gitweb.description, gitweb.owner, gitweb.url
2630 See gitweb(1) for description.
2631 gitweb.avatar, gitweb.blame, gitweb.grep, gitweb.highlight,
2633 gitweb.patches, gitweb.pickaxe, gitweb.remote_heads, gitweb.showSizes,
2634 gitweb.snapshot
2635 See gitweb.conf(5) for description.
2636 grep.lineNumber
2638 If set to true, enable -n option by default.
2639 grep.column
2641 If set to true, enable the --column option by default.
2642 grep.patternType
2644 Set the default matching behavior. Using a value of basic,
2645 extended, fixed, or perl will enable the --basic-regexp,
2646 --extended-regexp, --fixed-strings, or --perl-regexp option
2647 accordingly, while the value default will return to the default
2648 matching behavior.
2649 grep.extendedRegexp
2651 If set to true, enable --extended-regexp option by default. This
2652 option is ignored when the grep.patternType option is set to a
2653 value other than default.
2654 grep.threads
2656 Number of grep worker threads to use. See grep.threads in git-
2657 grep(1) for more information.
2658 grep.fallbackToNoIndex
2660 If set to true, fall back to git grep --no-index if git grep is
2661 executed outside of a git repository. Defaults to false.
2662 gpg.program
2664 Use this custom program instead of "gpg" found on $PATH when making
2665 or verifying a PGP signature. The program must support the same
2666 command-line interface as GPG, namely, to verify a detached
2667 signature, "gpg --verify $file - <$signature" is run, and the
2668 program is expected to signal a good signature by exiting with code
2669 0, and to generate an ASCII-armored detached signature, the
2670 standard input of "gpg -bsau $key" is fed with the contents to be
2671 signed, and the program is expected to send the result to its
2672 standard output.
2673 gpg.format
2675 Specifies which key format to use when signing with --gpg-sign.
2676 Default is "openpgp" and another possible value is "x509".
2677 gpg.<format>.program
2679 Use this to customize the program used for the signing format you
2680 chose. (see gpg.program and gpg.format) gpg.program can still be
2681 used as a legacy synonym for gpg.openpgp.program. The default value
2682 for gpg.x509.program is "gpgsm".
2683 gui.commitMsgWidth
2685 Defines how wide the commit message window is in the git-gui(1).
2686 "75" is the default.
2687 gui.diffContext
2689 Specifies how many context lines should be used in calls to diff
2690 made by the git-gui(1). The default is "5".
2691 gui.displayUntracked
2693 Determines if git-gui(1) shows untracked files in the file list.
2694 The default is "true".
2695 gui.encoding
2697 Specifies the default encoding to use for displaying of file
2698 contents in git-gui(1) and gitk(1). It can be overridden by setting
2699 the encoding attribute for relevant files (see gitattributes(5)).
2700 If this option is not set, the tools default to the locale
2701 encoding.
2702 gui.matchTrackingBranch
2704 Determines if new branches created with git-gui(1) should default
2705 to tracking remote branches with matching names or not. Default:
2706 "false".
2707 gui.newBranchTemplate
2709 Is used as suggested name when creating new branches using the git-
2710 gui(1).
2711 gui.pruneDuringFetch
2713 "true" if git-gui(1) should prune remote-tracking branches when
2714 performing a fetch. The default value is "false".
2715 gui.trustmtime
2717 Determines if git-gui(1) should trust the file modification
2718 timestamp or not. By default the timestamps are not trusted.
2719 gui.spellingDictionary
2721 Specifies the dictionary used for spell checking commit messages in
2722 the git-gui(1). When set to "none" spell checking is turned off.
2723 gui.fastCopyBlame
2725 If true, git gui blame uses -C instead of -C -C for original
2726 location detection. It makes blame significantly faster on huge
2727 repositories at the expense of less thorough copy detection.
2728 gui.copyBlameThreshold
2730 Specifies the threshold to use in git gui blame original location
2731 detection, measured in alphanumeric characters. See the git-
2732 blame(1) manual for more information on copy detection.
2733 gui.blamehistoryctx
2735 Specifies the radius of history context in days to show in gitk(1)
2736 for the selected commit, when the Show History Context menu item is
2737 invoked from git gui blame. If this variable is set to zero, the
2738 whole history is shown.
2739 guitool.<name>.cmd
2741 Specifies the shell command line to execute when the corresponding
2742 item of the git-gui(1) Tools menu is invoked. This option is
2743 mandatory for every tool. The command is executed from the root of
2744 the working directory, and in the environment it receives the name
2745 of the tool as GIT_GUITOOL, the name of the currently selected file
2746 as FILENAME, and the name of the current branch as CUR_BRANCH (if
2747 the head is detached, CUR_BRANCH is empty).
2748 guitool.<name>.needsFile
2750 Run the tool only if a diff is selected in the GUI. It guarantees
2751 that FILENAME is not empty.
2752 guitool.<name>.noConsole
2754 Run the command silently, without creating a window to display its
2755 output.
2756 guitool.<name>.noRescan
2758 Don’t rescan the working directory for changes after the tool
2759 finishes execution.
2760 guitool.<name>.confirm
2762 Show a confirmation dialog before actually running the tool.
2763 guitool.<name>.argPrompt
2765 Request a string argument from the user, and pass it to the tool
2766 through the ARGS environment variable. Since requesting an argument
2767 implies confirmation, the confirm option has no effect if this is
2768 enabled. If the option is set to true, yes, or 1, the dialog uses a
2769 built-in generic prompt; otherwise the exact value of the variable
2770 is used.
2771 guitool.<name>.revPrompt
2773 Request a single valid revision from the user, and set the REVISION
2774 environment variable. In other aspects this option is similar to
2775 argPrompt, and can be used together with it.
2776 guitool.<name>.revUnmerged
2778 Show only unmerged branches in the revPrompt subdialog. This is
2779 useful for tools similar to merge or rebase, but not for things
2780 like checkout or reset.
2781 guitool.<name>.title
2783 Specifies the title to use for the prompt dialog. The default is
2784 the tool name.
2785 guitool.<name>.prompt
2787 Specifies the general prompt string to display at the top of the
2788 dialog, before subsections for argPrompt and revPrompt. The default
2789 value includes the actual command.
2790 help.browser
2792 Specify the browser that will be used to display help in the web
2793 format. See git-help(1).
2794 help.format
2796 Override the default help format used by git-help(1). Values man,
2797 info, web and html are supported. man is the default. web and
2798 html are the same.
2799 help.autoCorrect
2801 Automatically correct and execute mistyped commands after waiting
2802 for the given number of deciseconds (0.1 sec). If more than one
2803 command can be deduced from the entered text, nothing will be
2804 executed. If the value of this option is negative, the corrected
2805 command will be executed immediately. If the value is 0 - the
2806 command will be just shown but not executed. This is the default.
2807 help.htmlPath
2809 Specify the path where the HTML documentation resides. File system
2810 paths and URLs are supported. HTML pages will be prefixed with this
2811 path when help is displayed in the web format. This defaults to the
2812 documentation path of your Git installation.
2813 http.proxy
2815 Override the HTTP proxy, normally configured using the http_proxy,
2816 https_proxy, and all_proxy environment variables (see curl(1)). In
2817 addition to the syntax understood by curl, it is possible to
2818 specify a proxy string with a user name but no password, in which
2819 case git will attempt to acquire one in the same way it does for
2820 other credentials. See gitcredentials(7) for more information. The
2821 syntax thus is [protocol://][user[:password]@]proxyhost[:port].
2822 This can be overridden on a per-remote basis; see
2823 remote.<name>.proxy
2824 http.proxyAuthMethod
2826 Set the method with which to authenticate against the HTTP proxy.
2827 This only takes effect if the configured proxy string contains a
2828 user name part (i.e. is of the form user@host or user@host:port).
2829 This can be overridden on a per-remote basis; see
2830 remote.<name>.proxyAuthMethod. Both can be overridden by the
2831 GIT_HTTP_PROXY_AUTHMETHOD environment variable. Possible values
2832 are:
2833 · anyauth - Automatically pick a suitable authentication method.
2835 It is assumed that the proxy answers an unauthenticated request
2836 with a 407 status code and one or more Proxy-authenticate
2837 headers with supported authentication methods. This is the
2838 default.
2839 · basic - HTTP Basic authentication
2841 · digest - HTTP Digest authentication; this prevents the password
2843 from being transmitted to the proxy in clear text
2844 · negotiate - GSS-Negotiate authentication (compare the
2846 --negotiate option of curl(1))
2847 · ntlm - NTLM authentication (compare the --ntlm option of
2849 curl(1))
2850 http.emptyAuth
2852 Attempt authentication without seeking a username or password. This
2853 can be used to attempt GSS-Negotiate authentication without
2854 specifying a username in the URL, as libcurl normally requires a
2855 username for authentication.
2856 http.delegation
2858 Control GSSAPI credential delegation. The delegation is disabled by
2859 default in libcurl since version 7.21.7. Set parameter to tell the
2860 server what it is allowed to delegate when it comes to user
2861 credentials. Used with GSS/kerberos. Possible values are:
2862 · none - Don’t allow any delegation.
2864 · policy - Delegates if and only if the OK-AS-DELEGATE flag is
2866 set in the Kerberos service ticket, which is a matter of realm
2867 policy.
2868 · always - Unconditionally allow the server to delegate.
2870 http.extraHeader
2872 Pass an additional HTTP header when communicating with a server. If
2873 more than one such entry exists, all of them are added as extra
2874 headers. To allow overriding the settings inherited from the system
2875 config, an empty value will reset the extra headers to the empty
2876 list.
2877 http.cookieFile
2879 The pathname of a file containing previously stored cookie lines,
2880 which should be used in the Git http session, if they match the
2881 server. The file format of the file to read cookies from should be
2882 plain HTTP headers or the Netscape/Mozilla cookie file format (see
2883 curl(1)). NOTE that the file specified with http.cookieFile is used
2884 only as input unless http.saveCookies is set.
2885 http.saveCookies
2887 If set, store cookies received during requests to the file
2888 specified by http.cookieFile. Has no effect if http.cookieFile is
2889 unset.
2890 http.version
2892 Use the specified HTTP protocol version when communicating with a
2893 server. If you want to force the default. The available and default
2894 version depend on libcurl. Actually the possible values of this
2895 option are:
2896 · HTTP/2
2898 · HTTP/1.1
2900 http.sslVersion
2902 The SSL version to use when negotiating an SSL connection, if you
2903 want to force the default. The available and default version depend
2904 on whether libcurl was built against NSS or OpenSSL and the
2905 particular configuration of the crypto library in use. Internally
2906 this sets the CURLOPT_SSL_VERSION option; see the libcurl
2907 documentation for more details on the format of this option and for
2908 the ssl version supported. Actually the possible values of this
2909 option are:
2910 · sslv2
2912 · sslv3
2914 · tlsv1
2916 · tlsv1.0
2918 · tlsv1.1
2920 · tlsv1.2
2922 · tlsv1.3
2924 Can be overridden by the GIT_SSL_VERSION environment variable. To
2926 force git to use libcurl’s default ssl version and ignore any
2927 explicit http.sslversion option, set GIT_SSL_VERSION to the empty
2928 string.
2929 http.sslCipherList
2931 A list of SSL ciphers to use when negotiating an SSL connection.
2932 The available ciphers depend on whether libcurl was built against
2933 NSS or OpenSSL and the particular configuration of the crypto
2934 library in use. Internally this sets the CURLOPT_SSL_CIPHER_LIST
2935 option; see the libcurl documentation for more details on the
2936 format of this list.
2937 Can be overridden by the GIT_SSL_CIPHER_LIST environment variable.
2939 To force git to use libcurl’s default cipher list and ignore any
2940 explicit http.sslCipherList option, set GIT_SSL_CIPHER_LIST to the
2941 empty string.
2942 http.sslVerify
2944 Whether to verify the SSL certificate when fetching or pushing over
2945 HTTPS. Defaults to true. Can be overridden by the GIT_SSL_NO_VERIFY
2946 environment variable.
2947 http.sslCert
2949 File containing the SSL certificate when fetching or pushing over
2950 HTTPS. Can be overridden by the GIT_SSL_CERT environment variable.
2951 http.sslKey
2953 File containing the SSL private key when fetching or pushing over
2954 HTTPS. Can be overridden by the GIT_SSL_KEY environment variable.
2955 http.sslCertPasswordProtected
2957 Enable Git’s password prompt for the SSL certificate. Otherwise
2958 OpenSSL will prompt the user, possibly many times, if the
2959 certificate or private key is encrypted. Can be overridden by the
2960 GIT_SSL_CERT_PASSWORD_PROTECTED environment variable.
2961 http.sslCAInfo
2963 File containing the certificates to verify the peer with when
2964 fetching or pushing over HTTPS. Can be overridden by the
2965 GIT_SSL_CAINFO environment variable.
2966 http.sslCAPath
2968 Path containing files with the CA certificates to verify the peer
2969 with when fetching or pushing over HTTPS. Can be overridden by the
2970 GIT_SSL_CAPATH environment variable.
2971 http.sslBackend
2973 Name of the SSL backend to use (e.g. "openssl" or "schannel"). This
2974 option is ignored if cURL lacks support for choosing the SSL
2975 backend at runtime.
2976 http.schannelCheckRevoke
2978 Used to enforce or disable certificate revocation checks in cURL
2979 when http.sslBackend is set to "schannel". Defaults to true if
2980 unset. Only necessary to disable this if Git consistently errors
2981 and the message is about checking the revocation status of a
2982 certificate. This option is ignored if cURL lacks support for
2983 setting the relevant SSL option at runtime.
2984 http.schannelUseSSLCAInfo
2986 As of cURL v7.60.0, the Secure Channel backend can use the
2987 certificate bundle provided via http.sslCAInfo, but that would
2988 override the Windows Certificate Store. Since this is not desirable
2989 by default, Git will tell cURL not to use that bundle by default
2990 when the schannel backend was configured via http.sslBackend,
2991 unless http.schannelUseSSLCAInfo overrides this behavior.
2992 http.pinnedpubkey
2994 Public key of the https service. It may either be the filename of a
2995 PEM or DER encoded public key file or a string starting with
2996 sha256// followed by the base64 encoded sha256 hash of the public
2997 key. See also libcurl CURLOPT_PINNEDPUBLICKEY. git will exit with
2998 an error if this option is set but not supported by cURL.
2999 http.sslTry
3001 Attempt to use AUTH SSL/TLS and encrypted data transfers when
3002 connecting via regular FTP protocol. This might be needed if the
3003 FTP server requires it for security reasons or you wish to connect
3004 securely whenever remote FTP server supports it. Default is false
3005 since it might trigger certificate verification errors on
3006 misconfigured servers.
3007 http.maxRequests
3009 How many HTTP requests to launch in parallel. Can be overridden by
3010 the GIT_HTTP_MAX_REQUESTS environment variable. Default is 5.
3011 http.minSessions
3013 The number of curl sessions (counted across slots) to be kept
3014 across requests. They will not be ended with curl_easy_cleanup()
3015 until http_cleanup() is invoked. If USE_CURL_MULTI is not defined,
3016 this value will be capped at 1. Defaults to 1.
3017 http.postBuffer
3019 Maximum size in bytes of the buffer used by smart HTTP transports
3020 when POSTing data to the remote system. For requests larger than
3021 this buffer size, HTTP/1.1 and Transfer-Encoding: chunked is used
3022 to avoid creating a massive pack file locally. Default is 1 MiB,
3023 which is sufficient for most requests.
3024 http.lowSpeedLimit, http.lowSpeedTime
3026 If the HTTP transfer speed is less than http.lowSpeedLimit for
3027 longer than http.lowSpeedTime seconds, the transfer is aborted. Can
3028 be overridden by the GIT_HTTP_LOW_SPEED_LIMIT and
3029 GIT_HTTP_LOW_SPEED_TIME environment variables.
3030 http.noEPSV
3032 A boolean which disables using of EPSV ftp command by curl. This
3033 can helpful with some "poor" ftp servers which don’t support EPSV
3034 mode. Can be overridden by the GIT_CURL_FTP_NO_EPSV environment
3035 variable. Default is false (curl will use EPSV).
3036 http.userAgent
3038 The HTTP USER_AGENT string presented to an HTTP server. The default
3039 value represents the version of the client Git such as git/1.7.1.
3040 This option allows you to override this value to a more common
3041 value such as Mozilla/4.0. This may be necessary, for instance, if
3042 connecting through a firewall that restricts HTTP connections to a
3043 set of common USER_AGENT strings (but not including those like
3044 git/1.7.1). Can be overridden by the GIT_HTTP_USER_AGENT
3045 environment variable.
3046 http.followRedirects
3048 Whether git should follow HTTP redirects. If set to true, git will
3049 transparently follow any redirect issued by a server it encounters.
3050 If set to false, git will treat all redirects as errors. If set to
3051 initial, git will follow redirects only for the initial request to
3052 a remote, but not for subsequent follow-up HTTP requests. Since git
3053 uses the redirected URL as the base for the follow-up requests,
3054 this is generally sufficient. The default is initial.
3055 http.<url>.*
3057 Any of the http.* options above can be applied selectively to some
3058 URLs. For a config key to match a URL, each element of the config
3059 key is compared to that of the URL, in the following order:
3060 1. Scheme (e.g., https in https://example.com/). This field must
3062 match exactly between the config key and the URL.
3063 2. Host/domain name (e.g., example.com in https://example.com/).
3065 This field must match between the config key and the URL. It is
3066 possible to specify a * as part of the host name to match all
3067 subdomains at this level. https://*.example.com/ for example
3068 would match https://foo.example.com/, but not
3069 https://foo.bar.example.com/.
3070 3. Port number (e.g., 8080 in http://example.com:8080/). This
3072 field must match exactly between the config key and the URL.
3073 Omitted port numbers are automatically converted to the correct
3074 default for the scheme before matching.
3075 4. Path (e.g., repo.git in https://example.com/repo.git). The path
3077 field of the config key must match the path field of the URL
3078 either exactly or as a prefix of slash-delimited path elements.
3079 This means a config key with path foo/ matches URL path
3080 foo/bar. A prefix can only match on a slash (/) boundary.
3081 Longer matches take precedence (so a config key with path
3082 foo/bar is a better match to URL path foo/bar than a config key
3083 with just path foo/).
3084 5. User name (e.g., user in https://user@example.com/repo.git). If
3086 the config key has a user name it must match the user name in
3087 the URL exactly. If the config key does not have a user name,
3088 that config key will match a URL with any user name (including
3089 none), but at a lower precedence than a config key with a user
3090 name.
3091 The list above is ordered by decreasing precedence; a URL that
3093 matches a config key’s path is preferred to one that matches its
3094 user name. For example, if the URL is
3095 https://user@example.com/foo/bar a config key match of
3096 https://example.com/foo will be preferred over a config key match
3097 of https://user@example.com.
3098 All URLs are normalized before attempting any matching (the
3100 password part, if embedded in the URL, is always ignored for
3101 matching purposes) so that equivalent URLs that are simply spelled
3102 differently will match properly. Environment variable settings
3103 always override any matches. The URLs that are matched against are
3104 those given directly to Git commands. This means any URLs visited
3105 as a result of a redirection do not participate in matching.
3106 i18n.commitEncoding
3108 Character encoding the commit messages are stored in; Git itself
3109 does not care per se, but this information is necessary e.g. when
3110 importing commits from emails or in the gitk graphical history
3111 browser (and possibly at other places in the future or in other
3112 porcelains). See e.g. git-mailinfo(1). Defaults to utf-8.
3113 i18n.logOutputEncoding
3115 Character encoding the commit messages are converted to when
3116 running git log and friends.
3117 imap.folder
3119 The folder to drop the mails into, which is typically the Drafts
3120 folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
3121 "[Gmail]/Drafts". Required.
3122 imap.tunnel
3124 Command used to setup a tunnel to the IMAP server through which
3125 commands will be piped instead of using a direct network connection
3126 to the server. Required when imap.host is not set.
3127 imap.host
3129 A URL identifying the server. Use an imap:// prefix for non-secure
3130 connections and an imaps:// prefix for secure connections. Ignored
3131 when imap.tunnel is set, but required otherwise.
3132 imap.user
3134 The username to use when logging in to the server.
3135 imap.pass
3137 The password to use when logging in to the server.
3138 imap.port
3140 An integer port number to connect to on the server. Defaults to 143
3141 for imap:// hosts and 993 for imaps:// hosts. Ignored when
3142 imap.tunnel is set.
3143 imap.sslverify
3145 A boolean to enable/disable verification of the server certificate
3146 used by the SSL/TLS connection. Default is true. Ignored when
3147 imap.tunnel is set.
3148 imap.preformattedHTML
3150 A boolean to enable/disable the use of html encoding when sending a
3151 patch. An html encoded patch will be bracketed with <pre> and have
3152 a content type of text/html. Ironically, enabling this option
3153 causes Thunderbird to send the patch as a plain/text, format=fixed
3154 email. Default is false.
3155 imap.authMethod
3157 Specify authenticate method for authentication with IMAP server. If
3158 Git was built with the NO_CURL option, or if your curl version is
3159 older than 7.34.0, or if you’re running git-imap-send with the
3160 --no-curl option, the only supported method is CRAM-MD5. If this is
3161 not set then git imap-send uses the basic IMAP plaintext LOGIN
3162 command.
3163 index.recordEndOfIndexEntries
3165 Specifies whether the index file should include an "End Of Index
3166 Entry" section. This reduces index load time on multiprocessor
3167 machines but produces a message "ignoring EOIE extension" when
3168 reading the index using Git versions before 2.20. Defaults to true
3169 if index.threads has been explicitly enabled, false otherwise.
3170 index.recordOffsetTable
3172 Specifies whether the index file should include an "Index Entry
3173 Offset Table" section. This reduces index load time on
3174 multiprocessor machines but produces a message "ignoring IEOT
3175 extension" when reading the index using Git versions before 2.20.
3176 Defaults to true if index.threads has been explicitly enabled,
3177 false otherwise.
3178 index.threads
3180 Specifies the number of threads to spawn when loading the index.
3181 This is meant to reduce index load time on multiprocessor machines.
3182 Specifying 0 or true will cause Git to auto-detect the number of
3183 CPU’s and set the number of threads accordingly. Specifying 1 or
3184 false will disable multithreading. Defaults to true.
3185 index.version
3187 Specify the version with which new index files should be
3188 initialized. This does not affect existing repositories.
3189 init.templateDir
3191 Specify the directory from which templates will be copied. (See the
3192 "TEMPLATE DIRECTORY" section of git-init(1).)
3193 instaweb.browser
3195 Specify the program that will be used to browse your working
3196 repository in gitweb. See git-instaweb(1).
3197 instaweb.httpd
3199 The HTTP daemon command-line to start gitweb on your working
3200 repository. See git-instaweb(1).
3201 instaweb.local
3203 If true the web server started by git-instaweb(1) will be bound to
3204 the local IP (127.0.0.1).
3205 instaweb.modulePath
3207 The default module path for git-instaweb(1) to use instead of
3208 /usr/lib/apache2/modules. Only used if httpd is Apache.
3209 instaweb.port
3211 The port number to bind the gitweb httpd to. See git-instaweb(1).
3212 interactive.singleKey
3214 In interactive commands, allow the user to provide one-letter input
3215 with a single key (i.e., without hitting enter). Currently this is
3216 used by the --patch mode of git-add(1), git-checkout(1), git-
3217 commit(1), git-reset(1), and git-stash(1). Note that this setting
3218 is silently ignored if portable keystroke input is not available;
3219 requires the Perl module Term::ReadKey.
3220 interactive.diffFilter
3222 When an interactive command (such as git add --patch) shows a
3223 colorized diff, git will pipe the diff through the shell command
3224 defined by this configuration variable. The command may mark up the
3225 diff further for human consumption, provided that it retains a
3226 one-to-one correspondence with the lines in the original diff.
3227 Defaults to disabled (no filtering).
3228 log.abbrevCommit
3230 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
3231 assume --abbrev-commit. You may override this option with
3232 --no-abbrev-commit.
3233 log.date
3235 Set the default date-time mode for the log command. Setting a value
3236 for log.date is similar to using git log's --date option. See git-
3237 log(1) for details.
3238 log.decorate
3240 Print out the ref names of any commits that are shown by the log
3241 command. If short is specified, the ref name prefixes refs/heads/,
3242 refs/tags/ and refs/remotes/ will not be printed. If full is
3243 specified, the full ref name (including prefix) will be printed. If
3244 auto is specified, then if the output is going to a terminal, the
3245 ref names are shown as if short were given, otherwise no ref names
3246 are shown. This is the same as the --decorate option of the git
3247 log.
3248 log.follow
3250 If true, git log will act as if the --follow option was used when a
3251 single <path> is given. This has the same limitations as --follow,
3252 i.e. it cannot be used to follow multiple files and does not work
3253 well on non-linear history.
3254 log.graphColors
3256 A list of colors, separated by commas, that can be used to draw
3257 history lines in git log --graph.
3258 log.showRoot
3260 If true, the initial commit will be shown as a big creation event.
3261 This is equivalent to a diff against an empty tree. Tools like git-
3262 log(1) or git-whatchanged(1), which normally hide the root commit
3263 will now show it. True by default.
3264 log.showSignature
3266 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
3267 assume --show-signature.
3268 log.mailmap
3270 If true, makes git-log(1), git-show(1), and git-whatchanged(1)
3271 assume --use-mailmap.
3272 mailinfo.scissors
3274 If true, makes git-mailinfo(1) (and therefore git-am(1)) act by
3275 default as if the --scissors option was provided on the
3276 command-line. When active, this features removes everything from
3277 the message body before a scissors line (i.e. consisting mainly of
3278 ">8", "8<" and "-").
3279 mailmap.file
3281 The location of an augmenting mailmap file. The default mailmap,
3282 located in the root of the repository, is loaded first, then the
3283 mailmap file pointed to by this variable. The location of the
3284 mailmap file may be in a repository subdirectory, or somewhere
3285 outside of the repository itself. See git-shortlog(1) and git-
3286 blame(1).
3287 mailmap.blob
3289 Like mailmap.file, but consider the value as a reference to a blob
3290 in the repository. If both mailmap.file and mailmap.blob are given,
3291 both are parsed, with entries from mailmap.file taking precedence.
3292 In a bare repository, this defaults to HEAD:.mailmap. In a non-bare
3293 repository, it defaults to empty.
3294 man.viewer
3296 Specify the programs that may be used to display help in the man
3297 format. See git-help(1).
3298 man.<tool>.cmd
3300 Specify the command to invoke the specified man viewer. The
3301 specified command is evaluated in shell with the man page passed as
3302 argument. (See git-help(1).)
3303 man.<tool>.path
3305 Override the path for the given tool that may be used to display
3306 help in the man format. See git-help(1).
3307 merge.conflictStyle
3309 Specify the style in which conflicted hunks are written out to
3310 working tree files upon merge. The default is "merge", which shows
3311 a <<<<<<< conflict marker, changes made by one side, a =======
3312 marker, changes made by the other side, and then a >>>>>>> marker.
3313 An alternate style, "diff3", adds a ||||||| marker and the original
3314 text before the ======= marker.
3315 merge.defaultToUpstream
3317 If merge is called without any commit argument, merge the upstream
3318 branches configured for the current branch by using their last
3319 observed values stored in their remote-tracking branches. The
3320 values of the branch.<current branch>.merge that name the branches
3321 at the remote named by branch.<current branch>.remote are
3322 consulted, and then they are mapped via remote.<remote>.fetch to
3323 their corresponding remote-tracking branches, and the tips of these
3324 tracking branches are merged.
3325 merge.ff
3327 By default, Git does not create an extra merge commit when merging
3328 a commit that is a descendant of the current commit. Instead, the
3329 tip of the current branch is fast-forwarded. When set to false,
3330 this variable tells Git to create an extra merge commit in such a
3331 case (equivalent to giving the --no-ff option from the command
3332 line). When set to only, only such fast-forward merges are allowed
3333 (equivalent to giving the --ff-only option from the command line).
3334 merge.verifySignatures
3336 If true, this is equivalent to the --verify-signatures command line
3337 option. See git-merge(1) for details.
3338 merge.branchdesc
3340 In addition to branch names, populate the log message with the
3341 branch description text associated with them. Defaults to false.
3342 merge.log
3344 In addition to branch names, populate the log message with at most
3345 the specified number of one-line descriptions from the actual
3346 commits that are being merged. Defaults to false, and true is a
3347 synonym for 20.
3348 merge.renameLimit
3350 The number of files to consider when performing rename detection
3351 during a merge; if not specified, defaults to the value of
3352 diff.renameLimit. This setting has no effect if rename detection is
3353 turned off.
3354 merge.renames
3356 Whether and how Git detects renames. If set to "false", rename
3357 detection is disabled. If set to "true", basic rename detection is
3358 enabled. Defaults to the value of diff.renames.
3359 merge.renormalize
3361 Tell Git that canonical representation of files in the repository
3362 has changed over time (e.g. earlier commits record text files with
3363 CRLF line endings, but recent ones use LF line endings). In such a
3364 repository, Git can convert the data recorded in commits to a
3365 canonical form before performing a merge to reduce unnecessary
3366 conflicts. For more information, see section "Merging branches with
3367 differing checkin/checkout attributes" in gitattributes(5).
3368 merge.stat
3370 Whether to print the diffstat between ORIG_HEAD and the merge
3371 result at the end of the merge. True by default.
3372 merge.tool
3374 Controls which merge tool is used by git-mergetool(1). The list
3375 below shows the valid built-in values. Any other value is treated
3376 as a custom merge tool and requires that a corresponding
3377 mergetool.<tool>.cmd variable is defined.
3378 merge.guitool
3380 Controls which merge tool is used by git-mergetool(1) when the
3381 -g/--gui flag is specified. The list below shows the valid built-in
3382 values. Any other value is treated as a custom merge tool and
3383 requires that a corresponding mergetool.<guitool>.cmd variable is
3384 defined.
3385 · araxis
3387 · bc
3389 · bc3
3391 · codecompare
3393 · deltawalker
3395 · diffmerge
3397 · diffuse
3399 · ecmerge
3401 · emerge
3403 · examdiff
3405 · guiffy
3407 · gvimdiff
3409 · gvimdiff2
3411 · gvimdiff3
3413 · kdiff3
3415 · meld
3417 · opendiff
3419 · p4merge
3421 · tkdiff
3423 · tortoisemerge
3425 · vimdiff
3427 · vimdiff2
3429 · vimdiff3
3431 · winmerge
3433 · xxdiff
3435 merge.verbosity
3437 Controls the amount of output shown by the recursive merge
3438 strategy. Level 0 outputs nothing except a final error message if
3439 conflicts were detected. Level 1 outputs only conflicts, 2 outputs
3440 conflicts and file changes. Level 5 and above outputs debugging
3441 information. The default is level 2. Can be overridden by the
3442 GIT_MERGE_VERBOSITY environment variable.
3443 merge.<driver>.name
3445 Defines a human-readable name for a custom low-level merge driver.
3446 See gitattributes(5) for details.
3447 merge.<driver>.driver
3449 Defines the command that implements a custom low-level merge
3450 driver. See gitattributes(5) for details.
3451 merge.<driver>.recursive
3453 Names a low-level merge driver to be used when performing an
3454 internal merge between common ancestors. See gitattributes(5) for
3455 details.
3456 mergetool.<tool>.path
3458 Override the path for the given tool. This is useful in case your
3459 tool is not in the PATH.
3460 mergetool.<tool>.cmd
3462 Specify the command to invoke the specified merge tool. The
3463 specified command is evaluated in shell with the following
3464 variables available: BASE is the name of a temporary file
3465 containing the common base of the files to be merged, if available;
3466 LOCAL is the name of a temporary file containing the contents of
3467 the file on the current branch; REMOTE is the name of a temporary
3468 file containing the contents of the file from the branch being
3469 merged; MERGED contains the name of the file to which the merge
3470 tool should write the results of a successful merge.
3471 mergetool.<tool>.trustExitCode
3473 For a custom merge command, specify whether the exit code of the
3474 merge command can be used to determine whether the merge was
3475 successful. If this is not set to true then the merge target file
3476 timestamp is checked and the merge assumed to have been successful
3477 if the file has been updated, otherwise the user is prompted to
3478 indicate the success of the merge.
3479 mergetool.meld.hasOutput
3481 Older versions of meld do not support the --output option. Git will
3482 attempt to detect whether meld supports --output by inspecting the
3483 output of meld --help. Configuring mergetool.meld.hasOutput will
3484 make Git skip these checks and use the configured value instead.
3485 Setting mergetool.meld.hasOutput to true tells Git to
3486 unconditionally use the --output option, and false avoids using
3487 --output.
3488 mergetool.keepBackup
3490 After performing a merge, the original file with conflict markers
3491 can be saved as a file with a .orig extension. If this variable is
3492 set to false then this file is not preserved. Defaults to true
3493 (i.e. keep the backup files).
3494 mergetool.keepTemporaries
3496 When invoking a custom merge tool, Git uses a set of temporary
3497 files to pass to the tool. If the tool returns an error and this
3498 variable is set to true, then these temporary files will be
3499 preserved, otherwise they will be removed after the tool has
3500 exited. Defaults to false.
3501 mergetool.writeToTemp
3503 Git writes temporary BASE, LOCAL, and REMOTE versions of
3504 conflicting files in the worktree by default. Git will attempt to
3505 use a temporary directory for these files when set true. Defaults
3506 to false.
3507 mergetool.prompt
3509 Prompt before each invocation of the merge resolution program.
3510 notes.mergeStrategy
3512 Which merge strategy to choose by default when resolving notes
3513 conflicts. Must be one of manual, ours, theirs, union, or
3514 cat_sort_uniq. Defaults to manual. See "NOTES MERGE STRATEGIES"
3515 section of git-notes(1) for more information on each strategy.
3516 notes.<name>.mergeStrategy
3518 Which merge strategy to choose when doing a notes merge into
3519 refs/notes/<name>. This overrides the more general
3520 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
3521 git-notes(1) for more information on the available strategies.
3522 notes.displayRef
3524 The (fully qualified) refname from which to show notes when showing
3525 commit messages. The value of this variable can be set to a glob,
3526 in which case notes from all matching refs will be shown. You may
3527 also specify this configuration variable several times. A warning
3528 will be issued for refs that do not exist, but a glob that does not
3529 match any refs is silently ignored.
3530 This setting can be overridden with the GIT_NOTES_DISPLAY_REF
3532 environment variable, which must be a colon separated list of refs
3533 or globs.
3534 The effective value of "core.notesRef" (possibly overridden by
3536 GIT_NOTES_REF) is also implicitly added to the list of refs to be
3537 displayed.
3538 notes.rewrite.<command>
3540 When rewriting commits with <command> (currently amend or rebase)
3541 and this variable is set to true, Git automatically copies your
3542 notes from the original to the rewritten commit. Defaults to true,
3543 but see "notes.rewriteRef" below.
3544 notes.rewriteMode
3546 When copying notes during a rewrite (see the
3547 "notes.rewrite.<command>" option), determines what to do if the
3548 target commit already has a note. Must be one of overwrite,
3549 concatenate, cat_sort_uniq, or ignore. Defaults to concatenate.
3550 This setting can be overridden with the GIT_NOTES_REWRITE_MODE
3552 environment variable.
3553 notes.rewriteRef
3555 When copying notes during a rewrite, specifies the (fully
3556 qualified) ref whose notes should be copied. The ref may be a glob,
3557 in which case notes in all matching refs will be copied. You may
3558 also specify this configuration several times.
3559 Does not have a default value; you must configure this variable to
3561 enable note rewriting. Set it to refs/notes/commits to enable
3562 rewriting for the default commit notes.
3563 This setting can be overridden with the GIT_NOTES_REWRITE_REF
3565 environment variable, which must be a colon separated list of refs
3566 or globs.
3567 pack.window
3569 The size of the window used by git-pack-objects(1) when no window
3570 size is given on the command line. Defaults to 10.
3571 pack.depth
3573 The maximum delta depth used by git-pack-objects(1) when no maximum
3574 depth is given on the command line. Defaults to 50. Maximum value
3575 is 4095.
3576 pack.windowMemory
3578 The maximum size of memory that is consumed by each thread in git-
3579 pack-objects(1) for pack window memory when no limit is given on
3580 the command line. The value can be suffixed with "k", "m", or "g".
3581 When left unconfigured (or set explicitly to 0), there will be no
3582 limit.
3583 pack.compression
3585 An integer -1..9, indicating the compression level for objects in a
3586 pack file. -1 is the zlib default. 0 means no compression, and 1..9
3587 are various speed/size tradeoffs, 9 being slowest. If not set,
3588 defaults to core.compression. If that is not set, defaults to -1,
3589 the zlib default, which is "a default compromise between speed and
3590 compression (currently equivalent to level 6)."
3591 Note that changing the compression level will not automatically
3593 recompress all existing objects. You can force recompression by
3594 passing the -F option to git-repack(1).
3595 pack.island
3597 An extended regular expression configuring a set of delta islands.
3598 See "DELTA ISLANDS" in git-pack-objects(1) for details.
3599 pack.islandCore
3601 Specify an island name which gets to have its objects be packed
3602 first. This creates a kind of pseudo-pack at the front of one pack,
3603 so that the objects from the specified island are hopefully faster
3604 to copy into any pack that should be served to a user requesting
3605 these objects. In practice this means that the island specified
3606 should likely correspond to what is the most commonly cloned in the
3607 repo. See also "DELTA ISLANDS" in git-pack-objects(1).
3608 pack.deltaCacheSize
3610 The maximum memory in bytes used for caching deltas in git-pack-
3611 objects(1) before writing them out to a pack. This cache is used to
3612 speed up the writing object phase by not having to recompute the
3613 final delta result once the best match for all objects is found.
3614 Repacking large repositories on machines which are tight with
3615 memory might be badly impacted by this though, especially if this
3616 cache pushes the system into swapping. A value of 0 means no limit.
3617 The smallest size of 1 byte may be used to virtually disable this
3618 cache. Defaults to 256 MiB.
3619 pack.deltaCacheLimit
3621 The maximum size of a delta, that is cached in git-pack-objects(1).
3622 This cache is used to speed up the writing object phase by not
3623 having to recompute the final delta result once the best match for
3624 all objects is found. Defaults to 1000. Maximum value is 65535.
3625 pack.threads
3627 Specifies the number of threads to spawn when searching for best
3628 delta matches. This requires that git-pack-objects(1) be compiled
3629 with pthreads otherwise this option is ignored with a warning. This
3630 is meant to reduce packing time on multiprocessor machines. The
3631 required amount of memory for the delta search window is however
3632 multiplied by the number of threads. Specifying 0 will cause Git to
3633 auto-detect the number of CPU’s and set the number of threads
3634 accordingly.
3635 pack.indexVersion
3637 Specify the default pack index version. Valid values are 1 for
3638 legacy pack index used by Git versions prior to 1.5.2, and 2 for
3639 the new pack index with capabilities for packs larger than 4 GB as
3640 well as proper protection against the repacking of corrupted packs.
3641 Version 2 is the default. Note that version 2 is enforced and this
3642 config option ignored whenever the corresponding pack is larger
3643 than 2 GB.
3644 If you have an old Git that does not understand the version 2 *.idx
3646 file, cloning or fetching over a non native protocol (e.g. "http")
3647 that will copy both *.pack file and corresponding *.idx file from
3648 the other side may give you a repository that cannot be accessed
3649 with your older version of Git. If the *.pack file is smaller than
3650 2 GB, however, you can use git-index-pack(1) on the *.pack file to
3651 regenerate the *.idx file.
3652 pack.packSizeLimit
3654 The maximum size of a pack. This setting only affects packing to a
3655 file when repacking, i.e. the git:// protocol is unaffected. It can
3656 be overridden by the --max-pack-size option of git-repack(1).
3657 Reaching this limit results in the creation of multiple packfiles;
3658 which in turn prevents bitmaps from being created. The minimum size
3659 allowed is limited to 1 MiB. The default is unlimited. Common unit
3660 suffixes of k, m, or g are supported.
3661 pack.useBitmaps
3663 When true, git will use pack bitmaps (if available) when packing to
3664 stdout (e.g., during the server side of a fetch). Defaults to true.
3665 You should not generally need to turn this off unless you are
3666 debugging pack bitmaps.
3667 pack.useSparse
3669 When true, git will default to using the --sparse option in git
3670 pack-objects when the --revs option is present. This algorithm only
3671 walks trees that appear in paths that introduce new objects. This
3672 can have significant performance benefits when computing a pack to
3673 send a small change. However, it is possible that extra objects are
3674 added to the pack-file if the included commits contain certain
3675 types of direct renames.
3676 pack.writeBitmaps (deprecated)
3678 This is a deprecated synonym for repack.writeBitmaps.
3679 pack.writeBitmapHashCache
3681 When true, git will include a "hash cache" section in the bitmap
3682 index (if one is written). This cache can be used to feed git’s
3683 delta heuristics, potentially leading to better deltas between
3684 bitmapped and non-bitmapped objects (e.g., when serving a fetch
3685 between an older, bitmapped pack and objects that have been pushed
3686 since the last gc). The downside is that it consumes 4 bytes per
3687 object of disk space, and that JGit’s bitmap implementation does
3688 not understand it, causing it to complain if Git and JGit are used
3689 on the same repository. Defaults to false.
3690 pager.<cmd>
3692 If the value is boolean, turns on or off pagination of the output
3693 of a particular Git subcommand when writing to a tty. Otherwise,
3694 turns on pagination for the subcommand using the pager specified by
3695 the value of pager.<cmd>. If --paginate or --no-pager is specified
3696 on the command line, it takes precedence over this option. To
3697 disable pagination for all commands, set core.pager or GIT_PAGER to
3698 cat.
3699 pretty.<name>
3701 Alias for a --pretty= format string, as specified in git-log(1).
3702 Any aliases defined here can be used just as the built-in pretty
3703 formats could. For example, running git config pretty.changelog
3704 "format:* %H %s" would cause the invocation git log
3705 --pretty=changelog to be equivalent to running git log
3706 "--pretty=format:* %H %s". Note that an alias with the same name as
3707 a built-in format will be silently ignored.
3708 protocol.allow
3710 If set, provide a user defined default policy for all protocols
3711 which don’t explicitly have a policy (protocol.<name>.allow). By
3712 default, if unset, known-safe protocols (http, https, git, ssh,
3713 file) have a default policy of always, known-dangerous protocols
3714 (ext) have a default policy of never, and all other protocols have
3715 a default policy of user. Supported policies:
3716 · always - protocol is always able to be used.
3718 · never - protocol is never able to be used.
3720 · user - protocol is only able to be used when
3722 GIT_PROTOCOL_FROM_USER is either unset or has a value of 1.
3723 This policy should be used when you want a protocol to be
3724 directly usable by the user but don’t want it used by commands
3725 which execute clone/fetch/push commands without user input,
3726 e.g. recursive submodule initialization.
3727 protocol.<name>.allow
3729 Set a policy to be used by protocol <name> with clone/fetch/push
3730 commands. See protocol.allow above for the available policies.
3731 The protocol names currently used by git are:
3733 · file: any local file-based path (including file:// URLs, or
3735 local paths)
3736 · git: the anonymous git protocol over a direct TCP connection
3738 (or proxy, if configured)
3739 · ssh: git over ssh (including host:path syntax, ssh://, etc).
3741 · http: git over http, both "smart http" and "dumb http". Note
3743 that this does not include https; if you want to configure
3744 both, you must do so individually.
3745 · any external helpers are named by their protocol (e.g., use hg
3747 to allow the git-remote-hg helper)
3748 protocol.version
3750 Experimental. If set, clients will attempt to communicate with a
3751 server using the specified protocol version. If unset, no attempt
3752 will be made by the client to communicate using a particular
3753 protocol version, this results in protocol version 0 being used.
3754 Supported versions:
3755 · 0 - the original wire protocol.
3757 · 1 - the original wire protocol with the addition of a version
3759 string in the initial response from the server.
3760 · 2 - wire protocol version 2[2].
3762 pull.ff
3764 By default, Git does not create an extra merge commit when merging
3765 a commit that is a descendant of the current commit. Instead, the
3766 tip of the current branch is fast-forwarded. When set to false,
3767 this variable tells Git to create an extra merge commit in such a
3768 case (equivalent to giving the --no-ff option from the command
3769 line). When set to only, only such fast-forward merges are allowed
3770 (equivalent to giving the --ff-only option from the command line).
3771 This setting overrides merge.ff when pulling.
3772 pull.rebase
3774 When true, rebase branches on top of the fetched branch, instead of
3775 merging the default branch from the default remote when "git pull"
3776 is run. See "branch.<name>.rebase" for setting this on a per-branch
3777 basis.
3778 When merges, pass the --rebase-merges option to git rebase so that
3780 the local merge commits are included in the rebase (see git-
3781 rebase(1) for details).
3782 When preserve, also pass --preserve-merges along to git rebase so
3784 that locally committed merge commits will not be flattened by
3785 running git pull.
3786 When the value is interactive, the rebase is run in interactive
3788 mode.
3789 NOTE: this is a possibly dangerous operation; do not use it unless
3791 you understand the implications (see git-rebase(1) for details).
3792 pull.octopus
3794 The default merge strategy to use when pulling multiple branches at
3795 once.
3796 pull.twohead
3798 The default merge strategy to use when pulling a single branch.
3799 push.default
3801 Defines the action git push should take if no refspec is explicitly
3802 given. Different values are well-suited for specific workflows; for
3803 instance, in a purely central workflow (i.e. the fetch source is
3804 equal to the push destination), upstream is probably what you want.
3805 Possible values are:
3806 · nothing - do not push anything (error out) unless a refspec is
3808 explicitly given. This is primarily meant for people who want
3809 to avoid mistakes by always being explicit.
3810 · current - push the current branch to update a branch with the
3812 same name on the receiving end. Works in both central and
3813 non-central workflows.
3814 · upstream - push the current branch back to the branch whose
3816 changes are usually integrated into the current branch (which
3817 is called @{upstream}). This mode only makes sense if you are
3818 pushing to the same repository you would normally pull from
3819 (i.e. central workflow).
3820 · tracking - This is a deprecated synonym for upstream.
3822 · simple - in centralized workflow, work like upstream with an
3824 added safety to refuse to push if the upstream branch’s name is
3825 different from the local one.
3826 When pushing to a remote that is different from the remote you
3828 normally pull from, work as current. This is the safest option
3829 and is suited for beginners.
3830 This mode has become the default in Git 2.0.
3832 · matching - push all branches having the same name on both ends.
3834 This makes the repository you are pushing to remember the set
3835 of branches that will be pushed out (e.g. if you always push
3836 maint and master there and no other branches, the repository
3837 you push to will have these two branches, and your local maint
3838 and master will be pushed there).
3839 To use this mode effectively, you have to make sure all the
3841 branches you would push out are ready to be pushed out before
3842 running git push, as the whole point of this mode is to allow
3843 you to push all of the branches in one go. If you usually
3844 finish work on only one branch and push out the result, while
3845 other branches are unfinished, this mode is not for you. Also
3846 this mode is not suitable for pushing into a shared central
3847 repository, as other people may add new branches there, or
3848 update the tip of existing branches outside your control.
3849 This used to be the default, but not since Git 2.0 (simple is
3851 the new default).
3852 push.followTags
3854 If set to true enable --follow-tags option by default. You may
3855 override this configuration at time of push by specifying
3856 --no-follow-tags.
3857 push.gpgSign
3859 May be set to a boolean value, or the string if-asked. A true value
3860 causes all pushes to be GPG signed, as if --signed is passed to
3861 git-push(1). The string if-asked causes pushes to be signed if the
3862 server supports it, as if --signed=if-asked is passed to git push.
3863 A false value may override a value from a lower-priority config
3864 file. An explicit command-line flag always overrides this config
3865 option.
3866 push.pushOption
3868 When no --push-option=<option> argument is given from the command
3869 line, git push behaves as if each <value> of this variable is given
3870 as --push-option=<value>.
3871 This is a multi-valued variable, and an empty value can be used in
3873 a higher priority configuration file (e.g. .git/config in a
3874 repository) to clear the values inherited from a lower priority
3875 configuration files (e.g. $HOME/.gitconfig).
3876 Example:
3878 /etc/gitconfig push.pushoption = a push.pushoption = b
3880 ~/.gitconfig push.pushoption = c
3882 repo/.git/config push.pushoption = push.pushoption = b
3884 This will result in only b (a and c are cleared).
3886 push.recurseSubmodules
3888 Make sure all submodule commits used by the revisions to be pushed
3889 are available on a remote-tracking branch. If the value is check
3890 then Git will verify that all submodule commits that changed in the
3891 revisions to be pushed are available on at least one remote of the
3892 submodule. If any commits are missing, the push will be aborted and
3893 exit with non-zero status. If the value is on-demand then all
3894 submodules that changed in the revisions to be pushed will be
3895 pushed. If on-demand was not able to push all necessary revisions
3896 it will also be aborted and exit with non-zero status. If the value
3897 is no then default behavior of ignoring submodules when pushing is
3898 retained. You may override this configuration at time of push by
3899 specifying --recurse-submodules=check|on-demand|no.
3900 rebase.useBuiltin
3902 Set to false to use the legacy shellscript implementation of git-
3903 rebase(1). Is true by default, which means use the built-in rewrite
3904 of it in C.
3905 The C rewrite is first included with Git version 2.20. This option
3907 serves an an escape hatch to re-enable the legacy version in case
3908 any bugs are found in the rewrite. This option and the shellscript
3909 version of git-rebase(1) will be removed in some future release.
3910 If you find some reason to set this option to false other than
3912 one-off testing you should report the behavior difference as a bug
3913 in git.
3914 rebase.stat
3916 Whether to show a diffstat of what changed upstream since the last
3917 rebase. False by default.
3918 rebase.autoSquash
3920 If set to true enable --autosquash option by default.
3921 rebase.autoStash
3923 When set to true, automatically create a temporary stash entry
3924 before the operation begins, and apply it after the operation ends.
3925 This means that you can run rebase on a dirty worktree. However,
3926 use with care: the final stash application after a successful
3927 rebase might result in non-trivial conflicts. This option can be
3928 overridden by the --no-autostash and --autostash options of git-
3929 rebase(1). Defaults to false.
3930 rebase.missingCommitsCheck
3932 If set to "warn", git rebase -i will print a warning if some
3933 commits are removed (e.g. a line was deleted), however the rebase
3934 will still proceed. If set to "error", it will print the previous
3935 warning and stop the rebase, git rebase --edit-todo can then be
3936 used to correct the error. If set to "ignore", no checking is done.
3937 To drop a commit without warning or error, use the drop command in
3938 the todo list. Defaults to "ignore".
3939 rebase.instructionFormat
3941 A format string, as specified in git-log(1), to be used for the
3942 todo list during an interactive rebase. The format will
3943 automatically have the long commit hash prepended to the format.
3944 rebase.abbreviateCommands
3946 If set to true, git rebase will use abbreviated command names in
3947 the todo list resulting in something like this:
3948 p deadbee The oneline of the commit
3950 p fa1afe1 The oneline of the next commit
3951 ...
3952 instead of:
3954 pick deadbee The oneline of the commit
3956 pick fa1afe1 The oneline of the next commit
3957 ...
3958 Defaults to false.
3960 rebase.rescheduleFailedExec
3962 Automatically reschedule exec commands that failed. This only makes
3963 sense in interactive mode (or when an --exec option was provided).
3964 This is the same as specifying the --reschedule-failed-exec option.
3965 receive.advertiseAtomic
3967 By default, git-receive-pack will advertise the atomic push
3968 capability to its clients. If you don’t want to advertise this
3969 capability, set this variable to false.
3970 receive.advertisePushOptions
3972 When set to true, git-receive-pack will advertise the push options
3973 capability to its clients. False by default.
3974 receive.autogc
3976 By default, git-receive-pack will run "git-gc --auto" after
3977 receiving data from git-push and updating refs. You can stop it by
3978 setting this variable to false.
3979 receive.certNonceSeed
3981 By setting this variable to a string, git receive-pack will accept
3982 a git push --signed and verifies it by using a "nonce" protected by
3983 HMAC using this string as a secret key.
3984 receive.certNonceSlop
3986 When a git push --signed sent a push certificate with a "nonce"
3987 that was issued by a receive-pack serving the same repository
3988 within this many seconds, export the "nonce" found in the
3989 certificate to GIT_PUSH_CERT_NONCE to the hooks (instead of what
3990 the receive-pack asked the sending side to include). This may allow
3991 writing checks in pre-receive and post-receive a bit easier.
3992 Instead of checking GIT_PUSH_CERT_NONCE_SLOP environment variable
3993 that records by how many seconds the nonce is stale to decide if
3994 they want to accept the certificate, they only can check
3995 GIT_PUSH_CERT_NONCE_STATUS is OK.
3996 receive.fsckObjects
3998 If it is set to true, git-receive-pack will check all received
3999 objects. See transfer.fsckObjects for what’s checked. Defaults to
4000 false. If not set, the value of transfer.fsckObjects is used
4001 instead.
4002 receive.fsck.<msg-id>
4004 Acts like fsck.<msg-id>, but is used by git-receive-pack(1) instead
4005 of git-fsck(1). See the fsck.<msg-id> documentation for details.
4006 receive.fsck.skipList
4008 Acts like fsck.skipList, but is used by git-receive-pack(1) instead
4009 of git-fsck(1). See the fsck.skipList documentation for details.
4010 receive.keepAlive
4012 After receiving the pack from the client, receive-pack may produce
4013 no output (if --quiet was specified) while processing the pack,
4014 causing some networks to drop the TCP connection. With this option
4015 set, if receive-pack does not transmit any data in this phase for
4016 receive.keepAlive seconds, it will send a short keepalive packet.
4017 The default is 5 seconds; set to 0 to disable keepalives entirely.
4018 receive.unpackLimit
4020 If the number of objects received in a push is below this limit
4021 then the objects will be unpacked into loose object files. However
4022 if the number of received objects equals or exceeds this limit then
4023 the received pack will be stored as a pack, after adding any
4024 missing delta bases. Storing the pack from a push can make the push
4025 operation complete faster, especially on slow filesystems. If not
4026 set, the value of transfer.unpackLimit is used instead.
4027 receive.maxInputSize
4029 If the size of the incoming pack stream is larger than this limit,
4030 then git-receive-pack will error out, instead of accepting the pack
4031 file. If not set or set to 0, then the size is unlimited.
4032 receive.denyDeletes
4034 If set to true, git-receive-pack will deny a ref update that
4035 deletes the ref. Use this to prevent such a ref deletion via a
4036 push.
4037 receive.denyDeleteCurrent
4039 If set to true, git-receive-pack will deny a ref update that
4040 deletes the currently checked out branch of a non-bare repository.
4041 receive.denyCurrentBranch
4043 If set to true or "refuse", git-receive-pack will deny a ref update
4044 to the currently checked out branch of a non-bare repository. Such
4045 a push is potentially dangerous because it brings the HEAD out of
4046 sync with the index and working tree. If set to "warn", print a
4047 warning of such a push to stderr, but allow the push to proceed. If
4048 set to false or "ignore", allow such pushes with no message.
4049 Defaults to "refuse".
4050 Another option is "updateInstead" which will update the working
4052 tree if pushing into the current branch. This option is intended
4053 for synchronizing working directories when one side is not easily
4054 accessible via interactive ssh (e.g. a live web site, hence the
4055 requirement that the working directory be clean). This mode also
4056 comes in handy when developing inside a VM to test and fix code on
4057 different Operating Systems.
4058 By default, "updateInstead" will refuse the push if the working
4060 tree or the index have any difference from the HEAD, but the
4061 push-to-checkout hook can be used to customize this. See
4062 githooks(5).
4063 receive.denyNonFastForwards
4065 If set to true, git-receive-pack will deny a ref update which is
4066 not a fast-forward. Use this to prevent such an update via a push,
4067 even if that push is forced. This configuration variable is set
4068 when initializing a shared repository.
4069 receive.hideRefs
4071 This variable is the same as transfer.hideRefs, but applies only to
4072 receive-pack (and so affects pushes, but not fetches). An attempt
4073 to update or delete a hidden ref by git push is rejected.
4074 receive.updateServerInfo
4076 If set to true, git-receive-pack will run git-update-server-info
4077 after receiving data from git-push and updating refs.
4078 receive.shallowUpdate
4080 If set to true, .git/shallow can be updated when new refs require
4081 new shallow roots. Otherwise those refs are rejected.
4082 remote.pushDefault
4084 The remote to push to by default. Overrides branch.<name>.remote
4085 for all branches, and is overridden by branch.<name>.pushRemote for
4086 specific branches.
4087 remote.<name>.url
4089 The URL of a remote repository. See git-fetch(1) or git-push(1).
4090 remote.<name>.pushurl
4092 The push URL of a remote repository. See git-push(1).
4093 remote.<name>.proxy
4095 For remotes that require curl (http, https and ftp), the URL to the
4096 proxy to use for that remote. Set to the empty string to disable
4097 proxying for that remote.
4098 remote.<name>.proxyAuthMethod
4100 For remotes that require curl (http, https and ftp), the method to
4101 use for authenticating against the proxy in use (probably set in
4102 remote.<name>.proxy). See http.proxyAuthMethod.
4103 remote.<name>.fetch
4105 The default set of "refspec" for git-fetch(1). See git-fetch(1).
4106 remote.<name>.push
4108 The default set of "refspec" for git-push(1). See git-push(1).
4109 remote.<name>.mirror
4111 If true, pushing to this remote will automatically behave as if the
4112 --mirror option was given on the command line.
4113 remote.<name>.skipDefaultUpdate
4115 If true, this remote will be skipped by default when updating using
4116 git-fetch(1) or the update subcommand of git-remote(1).
4117 remote.<name>.skipFetchAll
4119 If true, this remote will be skipped by default when updating using
4120 git-fetch(1) or the update subcommand of git-remote(1).
4121 remote.<name>.receivepack
4123 The default program to execute on the remote side when pushing. See
4124 option --receive-pack of git-push(1).
4125 remote.<name>.uploadpack
4127 The default program to execute on the remote side when fetching.
4128 See option --upload-pack of git-fetch-pack(1).
4129 remote.<name>.tagOpt
4131 Setting this value to --no-tags disables automatic tag following
4132 when fetching from remote <name>. Setting it to --tags will fetch
4133 every tag from remote <name>, even if they are not reachable from
4134 remote branch heads. Passing these flags directly to git-fetch(1)
4135 can override this setting. See options --tags and --no-tags of git-
4136 fetch(1).
4137 remote.<name>.vcs
4139 Setting this to a value <vcs> will cause Git to interact with the
4140 remote with the git-remote-<vcs> helper.
4141 remote.<name>.prune
4143 When set to true, fetching from this remote by default will also
4144 remove any remote-tracking references that no longer exist on the
4145 remote (as if the --prune option was given on the command line).
4146 Overrides fetch.prune settings, if any.
4147 remote.<name>.pruneTags
4149 When set to true, fetching from this remote by default will also
4150 remove any local tags that no longer exist on the remote if pruning
4151 is activated in general via remote.<name>.prune, fetch.prune or
4152 --prune. Overrides fetch.pruneTags settings, if any.
4153 See also remote.<name>.prune and the PRUNING section of git-
4155 fetch(1).
4156 remotes.<group>
4158 The list of remotes which are fetched by "git remote update
4159 <group>". See git-remote(1).
4160 repack.useDeltaBaseOffset
4162 By default, git-repack(1) creates packs that use delta-base offset.
4163 If you need to share your repository with Git older than version
4164 1.4.4, either directly or via a dumb protocol such as http, then
4165 you need to set this option to "false" and repack. Access from old
4166 Git versions over the native protocol are unaffected by this
4167 option.
4168 repack.packKeptObjects
4170 If set to true, makes git repack act as if --pack-kept-objects was
4171 passed. See git-repack(1) for details. Defaults to false normally,
4172 but true if a bitmap index is being written (either via
4173 --write-bitmap-index or repack.writeBitmaps).
4174 repack.useDeltaIslands
4176 If set to true, makes git repack act as if --delta-islands was
4177 passed. Defaults to false.
4178 repack.writeBitmaps
4180 When true, git will write a bitmap index when packing all objects
4181 to disk (e.g., when git repack -a is run). This index can speed up
4182 the "counting objects" phase of subsequent packs created for clones
4183 and fetches, at the cost of some disk space and extra time spent on
4184 the initial repack. This has no effect if multiple packfiles are
4185 created. Defaults to false.
4186 rerere.autoUpdate
4188 When set to true, git-rerere updates the index with the resulting
4189 contents after it cleanly resolves conflicts using previously
4190 recorded resolution. Defaults to false.
4191 rerere.enabled
4193 Activate recording of resolved conflicts, so that identical
4194 conflict hunks can be resolved automatically, should they be
4195 encountered again. By default, git-rerere(1) is enabled if there is
4196 an rr-cache directory under the $GIT_DIR, e.g. if "rerere" was
4197 previously used in the repository.
4198 reset.quiet
4200 When set to true, git reset will default to the --quiet option.
4201 sendemail.identity
4203 A configuration identity. When given, causes values in the
4204 sendemail.<identity> subsection to take precedence over values in
4205 the sendemail section. The default identity is the value of
4206 sendemail.identity.
4207 sendemail.smtpEncryption
4209 See git-send-email(1) for description. Note that this setting is
4210 not subject to the identity mechanism.
4211 sendemail.smtpssl (deprecated)
4213 Deprecated alias for sendemail.smtpEncryption = ssl.
4214 sendemail.smtpsslcertpath
4216 Path to ca-certificates (either a directory or a single file). Set
4217 it to an empty string to disable certificate verification.
4218 sendemail.<identity>.*
4220 Identity-specific versions of the sendemail.* parameters found
4221 below, taking precedence over those when this identity is selected,
4222 through either the command-line or sendemail.identity.
4223 sendemail.aliasesFile, sendemail.aliasFileType, sendemail.annotate,
4225 sendemail.bcc, sendemail.cc, sendemail.ccCmd, sendemail.chainReplyTo,
4226 sendemail.confirm, sendemail.envelopeSender, sendemail.from,
4227 sendemail.multiEdit, sendemail.signedoffbycc, sendemail.smtpPass,
4228 sendemail.suppresscc, sendemail.suppressFrom, sendemail.to,
4229 sendemail.tocmd, sendemail.smtpDomain, sendemail.smtpServer,
4230 sendemail.smtpServerPort, sendemail.smtpServerOption,
4231 sendemail.smtpUser, sendemail.thread, sendemail.transferEncoding,
4232 sendemail.validate, sendemail.xmailer
4233 See git-send-email(1) for description.
4234 sendemail.signedoffcc (deprecated)
4236 Deprecated alias for sendemail.signedoffbycc.
4237 sendemail.smtpBatchSize
4239 Number of messages to be sent per connection, after that a relogin
4240 will happen. If the value is 0 or undefined, send all messages in
4241 one connection. See also the --batch-size option of git-send-
4242 email(1).
4243 sendemail.smtpReloginDelay
4245 Seconds wait before reconnecting to smtp server. See also the
4246 --relogin-delay option of git-send-email(1).
4247 sequence.editor
4249 Text editor used by git rebase -i for editing the rebase
4250 instruction file. The value is meant to be interpreted by the shell
4251 when it is used. It can be overridden by the GIT_SEQUENCE_EDITOR
4252 environment variable. When not configured the default commit
4253 message editor is used instead.
4254 showBranch.default
4256 The default set of branches for git-show-branch(1). See git-show-
4257 branch(1).
4258 splitIndex.maxPercentChange
4260 When the split index feature is used, this specifies the percent of
4261 entries the split index can contain compared to the total number of
4262 entries in both the split index and the shared index before a new
4263 shared index is written. The value should be between 0 and 100. If
4264 the value is 0 then a new shared index is always written, if it is
4265 100 a new shared index is never written. By default the value is
4266 20, so a new shared index is written if the number of entries in
4267 the split index would be greater than 20 percent of the total
4268 number of entries. See git-update-index(1).
4269 splitIndex.sharedIndexExpire
4271 When the split index feature is used, shared index files that were
4272 not modified since the time this variable specifies will be removed
4273 when a new shared index file is created. The value "now" expires
4274 all entries immediately, and "never" suppresses expiration
4275 altogether. The default value is "2.weeks.ago". Note that a shared
4276 index file is considered modified (for the purpose of expiration)
4277 each time a new split-index file is either created based on it or
4278 read from it. See git-update-index(1).
4279 ssh.variant
4281 By default, Git determines the command line arguments to use based
4282 on the basename of the configured SSH command (configured using the
4283 environment variable GIT_SSH or GIT_SSH_COMMAND or the config
4284 setting core.sshCommand). If the basename is unrecognized, Git will
4285 attempt to detect support of OpenSSH options by first invoking the
4286 configured SSH command with the -G (print configuration) option and
4287 will subsequently use OpenSSH options (if that is successful) or no
4288 options besides the host and remote command (if it fails).
4289 The config variable ssh.variant can be set to override this
4291 detection. Valid values are ssh (to use OpenSSH options), plink,
4292 putty, tortoiseplink, simple (no options except the host and remote
4293 command). The default auto-detection can be explicitly requested
4294 using the value auto. Any other value is treated as ssh. This
4295 setting can also be overridden via the environment variable
4296 GIT_SSH_VARIANT.
4297 The current command-line parameters used for each variant are as
4299 follows:
4300 · ssh - [-p port] [-4] [-6] [-o option] [username@]host command
4302 · simple - [username@]host command
4304 · plink or putty - [-P port] [-4] [-6] [username@]host command
4306 · tortoiseplink - [-P port] [-4] [-6] -batch [username@]host
4308 command
4309 Except for the simple variant, command-line parameters are likely
4311 to change as git gains new features.
4312 status.relativePaths
4314 By default, git-status(1) shows paths relative to the current
4315 directory. Setting this variable to false shows paths relative to
4316 the repository root (this was the default for Git prior to v1.5.4).
4317 status.short
4319 Set to true to enable --short by default in git-status(1). The
4320 option --no-short takes precedence over this variable.
4321 status.branch
4323 Set to true to enable --branch by default in git-status(1). The
4324 option --no-branch takes precedence over this variable.
4325 status.displayCommentPrefix
4327 If set to true, git-status(1) will insert a comment prefix before
4328 each output line (starting with core.commentChar, i.e. # by
4329 default). This was the behavior of git-status(1) in Git 1.8.4 and
4330 previous. Defaults to false.
4331 status.renameLimit
4333 The number of files to consider when performing rename detection in
4334 git-status(1) and git-commit(1). Defaults to the value of
4335 diff.renameLimit.
4336 status.renames
4338 Whether and how Git detects renames in git-status(1) and git-
4339 commit(1) . If set to "false", rename detection is disabled. If set
4340 to "true", basic rename detection is enabled. If set to "copies" or
4341 "copy", Git will detect copies, as well. Defaults to the value of
4342 diff.renames.
4343 status.showStash
4345 If set to true, git-status(1) will display the number of entries
4346 currently stashed away. Defaults to false.
4347 status.showUntrackedFiles
4349 By default, git-status(1) and git-commit(1) show files which are
4350 not currently tracked by Git. Directories which contain only
4351 untracked files, are shown with the directory name only. Showing
4352 untracked files means that Git needs to lstat() all the files in
4353 the whole repository, which might be slow on some systems. So, this
4354 variable controls how the commands displays the untracked files.
4355 Possible values are:
4356 · no - Show no untracked files.
4358 · normal - Show untracked files and directories.
4360 · all - Show also individual files in untracked directories.
4362 If this variable is not specified, it defaults to normal. This
4364 variable can be overridden with the -u|--untracked-files option of
4365 git-status(1) and git-commit(1).
4366 status.submoduleSummary
4368 Defaults to false. If this is set to a non zero number or true
4369 (identical to -1 or an unlimited number), the submodule summary
4370 will be enabled and a summary of commits for modified submodules
4371 will be shown (see --summary-limit option of git-submodule(1)).
4372 Please note that the summary output command will be suppressed for
4373 all submodules when diff.ignoreSubmodules is set to all or only for
4374 those submodules where submodule.<name>.ignore=all. The only
4375 exception to that rule is that status and commit will show staged
4376 submodule changes. To also view the summary for ignored submodules
4377 you can either use the --ignore-submodules=dirty command-line
4378 option or the git submodule summary command, which shows a similar
4379 output but does not honor these settings.
4380 stash.showPatch
4382 If this is set to true, the git stash show command without an
4383 option will show the stash entry in patch form. Defaults to false.
4384 See description of show command in git-stash(1).
4385 stash.showStat
4387 If this is set to true, the git stash show command without an
4388 option will show diffstat of the stash entry. Defaults to true. See
4389 description of show command in git-stash(1).
4390 submodule.<name>.url
4392 The URL for a submodule. This variable is copied from the
4393 .gitmodules file to the git config via git submodule init. The user
4394 can change the configured URL before obtaining the submodule via
4395 git submodule update. If neither submodule.<name>.active or
4396 submodule.active are set, the presence of this variable is used as
4397 a fallback to indicate whether the submodule is of interest to git
4398 commands. See git-submodule(1) and gitmodules(5) for details.
4399 submodule.<name>.update
4401 The method by which a submodule is updated by git submodule update,
4402 which is the only affected command, others such as git checkout
4403 --recurse-submodules are unaffected. It exists for historical
4404 reasons, when git submodule was the only command to interact with
4405 submodules; settings like submodule.active and pull.rebase are more
4406 specific. It is populated by git submodule init from the
4407 gitmodules(5) file. See description of update command in git-
4408 submodule(1).
4409 submodule.<name>.branch
4411 The remote branch name for a submodule, used by git submodule
4412 update --remote. Set this option to override the value found in the
4413 .gitmodules file. See git-submodule(1) and gitmodules(5) for
4414 details.
4415 submodule.<name>.fetchRecurseSubmodules
4417 This option can be used to control recursive fetching of this
4418 submodule. It can be overridden by using the
4419 --[no-]recurse-submodules command-line option to "git fetch" and
4420 "git pull". This setting will override that from in the
4421 gitmodules(5) file.
4422 submodule.<name>.ignore
4424 Defines under what circumstances "git status" and the diff family
4425 show a submodule as modified. When set to "all", it will never be
4426 considered modified (but it will nonetheless show up in the output
4427 of status and commit when it has been staged), "dirty" will ignore
4428 all changes to the submodules work tree and takes only differences
4429 between the HEAD of the submodule and the commit recorded in the
4430 superproject into account. "untracked" will additionally let
4431 submodules with modified tracked files in their work tree show up.
4432 Using "none" (the default when this option is not set) also shows
4433 submodules that have untracked files in their work tree as changed.
4434 This setting overrides any setting made in .gitmodules for this
4435 submodule, both settings can be overridden on the command line by
4436 using the "--ignore-submodules" option. The git submodule commands
4437 are not affected by this setting.
4438 submodule.<name>.active
4440 Boolean value indicating if the submodule is of interest to git
4441 commands. This config option takes precedence over the
4442 submodule.active config option. See gitsubmodules(7) for details.
4443 submodule.active
4445 A repeated field which contains a pathspec used to match against a
4446 submodule’s path to determine if the submodule is of interest to
4447 git commands. See gitsubmodules(7) for details.
4448 submodule.recurse
4450 Specifies if commands recurse into submodules by default. This
4451 applies to all commands that have a --recurse-submodules option,
4452 except clone. Defaults to false.
4453 submodule.fetchJobs
4455 Specifies how many submodules are fetched/cloned at the same time.
4456 A positive integer allows up to that number of submodules fetched
4457 in parallel. A value of 0 will give some reasonable default. If
4458 unset, it defaults to 1.
4459 submodule.alternateLocation
4461 Specifies how the submodules obtain alternates when submodules are
4462 cloned. Possible values are no, superproject. By default no is
4463 assumed, which doesn’t add references. When the value is set to
4464 superproject the submodule to be cloned computes its alternates
4465 location relative to the superprojects alternate.
4466 submodule.alternateErrorStrategy
4468 Specifies how to treat errors with the alternates for a submodule
4469 as computed via submodule.alternateLocation. Possible values are
4470 ignore, info, die. Default is die.
4471 tag.forceSignAnnotated
4473 A boolean to specify whether annotated tags created should be GPG
4474 signed. If --annotate is specified on the command line, it takes
4475 precedence over this option.
4476 tag.sort
4478 This variable controls the sort ordering of tags when displayed by
4479 git-tag(1). Without the "--sort=<value>" option provided, the value
4480 of this variable will be used as the default.
4481 tar.umask
4483 This variable can be used to restrict the permission bits of tar
4484 archive entries. The default is 0002, which turns off the world
4485 write bit. The special value "user" indicates that the archiving
4486 user’s umask will be used instead. See umask(2) and git-archive(1).
4487 transfer.fsckObjects
4489 When fetch.fsckObjects or receive.fsckObjects are not set, the
4490 value of this variable is used instead. Defaults to false.
4491 When set, the fetch or receive will abort in the case of a
4493 malformed object or a link to a nonexistent object. In addition,
4494 various other issues are checked for, including legacy issues (see
4495 fsck.<msg-id>), and potential security issues like the existence of
4496 a .GIT directory or a malicious .gitmodules file (see the release
4497 notes for v2.2.1 and v2.17.1 for details). Other sanity and
4498 security checks may be added in future releases.
4499 On the receiving side, failing fsckObjects will make those objects
4501 unreachable, see "QUARANTINE ENVIRONMENT" in git-receive-pack(1).
4502 On the fetch side, malformed objects will instead be left
4503 unreferenced in the repository.
4504 Due to the non-quarantine nature of the fetch.fsckObjects
4506 implementation it can not be relied upon to leave the object store
4507 clean like receive.fsckObjects can.
4508 As objects are unpacked they’re written to the object store, so
4510 there can be cases where malicious objects get introduced even
4511 though the "fetch" failed, only to have a subsequent "fetch"
4512 succeed because only new incoming objects are checked, not those
4513 that have already been written to the object store. That difference
4514 in behavior should not be relied upon. In the future, such objects
4515 may be quarantined for "fetch" as well.
4516 For now, the paranoid need to find some way to emulate the
4518 quarantine environment if they’d like the same protection as
4519 "push". E.g. in the case of an internal mirror do the mirroring in
4520 two steps, one to fetch the untrusted objects, and then do a second
4521 "push" (which will use the quarantine) to another internal repo,
4522 and have internal clients consume this pushed-to repository, or
4523 embargo internal fetches and only allow them once a full "fsck" has
4524 run (and no new fetches have happened in the meantime).
4525 transfer.hideRefs
4527 String(s) receive-pack and upload-pack use to decide which refs to
4528 omit from their initial advertisements. Use more than one
4529 definition to specify multiple prefix strings. A ref that is under
4530 the hierarchies listed in the value of this variable is excluded,
4531 and is hidden when responding to git push or git fetch. See
4532 receive.hideRefs and uploadpack.hideRefs for program-specific
4533 versions of this config.
4534 You may also include a ! in front of the ref name to negate the
4536 entry, explicitly exposing it, even if an earlier entry marked it
4537 as hidden. If you have multiple hideRefs values, later entries
4538 override earlier ones (and entries in more-specific config files
4539 override less-specific ones).
4540 If a namespace is in use, the namespace prefix is stripped from
4542 each reference before it is matched against transfer.hiderefs
4543 patterns. For example, if refs/heads/master is specified in
4544 transfer.hideRefs and the current namespace is foo, then
4545 refs/namespaces/foo/refs/heads/master is omitted from the
4546 advertisements but refs/heads/master and
4547 refs/namespaces/bar/refs/heads/master are still advertised as
4548 so-called "have" lines. In order to match refs before stripping,
4549 add a ^ in front of the ref name. If you combine ! and ^, ! must
4550 be specified first.
4551 Even if you hide refs, a client may still be able to steal the
4553 target objects via the techniques described in the "SECURITY"
4554 section of the gitnamespaces(7) man page; it’s best to keep private
4555 data in a separate repository.
4556 transfer.unpackLimit
4558 When fetch.unpackLimit or receive.unpackLimit are not set, the
4559 value of this variable is used instead. The default value is 100.
4560 uploadarchive.allowUnreachable
4562 If true, allow clients to use git archive --remote to request any
4563 tree, whether reachable from the ref tips or not. See the
4564 discussion in the "SECURITY" section of git-upload-archive(1) for
4565 more details. Defaults to false.
4566 uploadpack.hideRefs
4568 This variable is the same as transfer.hideRefs, but applies only to
4569 upload-pack (and so affects only fetches, not pushes). An attempt
4570 to fetch a hidden ref by git fetch will fail. See also
4571 uploadpack.allowTipSHA1InWant.
4572 uploadpack.allowTipSHA1InWant
4574 When uploadpack.hideRefs is in effect, allow upload-pack to accept
4575 a fetch request that asks for an object at the tip of a hidden ref
4576 (by default, such a request is rejected). See also
4577 uploadpack.hideRefs. Even if this is false, a client may be able to
4578 steal objects via the techniques described in the "SECURITY"
4579 section of the gitnamespaces(7) man page; it’s best to keep private
4580 data in a separate repository.
4581 uploadpack.allowReachableSHA1InWant
4583 Allow upload-pack to accept a fetch request that asks for an object
4584 that is reachable from any ref tip. However, note that calculating
4585 object reachability is computationally expensive. Defaults to
4586 false. Even if this is false, a client may be able to steal objects
4587 via the techniques described in the "SECURITY" section of the
4588 gitnamespaces(7) man page; it’s best to keep private data in a
4589 separate repository.
4590 uploadpack.allowAnySHA1InWant
4592 Allow upload-pack to accept a fetch request that asks for any
4593 object at all. Defaults to false.
4594 uploadpack.keepAlive
4596 When upload-pack has started pack-objects, there may be a quiet
4597 period while pack-objects prepares the pack. Normally it would
4598 output progress information, but if --quiet was used for the fetch,
4599 pack-objects will output nothing at all until the pack data begins.
4600 Some clients and networks may consider the server to be hung and
4601 give up. Setting this option instructs upload-pack to send an empty
4602 keepalive packet every uploadpack.keepAlive seconds. Setting this
4603 option to 0 disables keepalive packets entirely. The default is 5
4604 seconds.
4605 uploadpack.packObjectsHook
4607 If this option is set, when upload-pack would run git pack-objects
4608 to create a packfile for a client, it will run this shell command
4609 instead. The pack-objects command and arguments it would have run
4610 (including the git pack-objects at the beginning) are appended to
4611 the shell command. The stdin and stdout of the hook are treated as
4612 if pack-objects itself was run. I.e., upload-pack will feed input
4613 intended for pack-objects to the hook, and expects a completed
4614 packfile on stdout.
4615 Note that this configuration variable is ignored if it is seen in
4617 the repository-level config (this is a safety measure against
4618 fetching from untrusted repositories).
4619 uploadpack.allowFilter
4621 If this option is set, upload-pack will support partial clone and
4622 partial fetch object filtering.
4623 uploadpack.allowRefInWant
4625 If this option is set, upload-pack will support the ref-in-want
4626 feature of the protocol version 2 fetch command. This feature is
4627 intended for the benefit of load-balanced servers which may not
4628 have the same view of what OIDs their refs point to due to
4629 replication delay.
4630 url.<base>.insteadOf
4632 Any URL that starts with this value will be rewritten to start,
4633 instead, with <base>. In cases where some site serves a large
4634 number of repositories, and serves them with multiple access
4635 methods, and some users need to use different access methods, this
4636 feature allows people to specify any of the equivalent URLs and
4637 have Git automatically rewrite the URL to the best alternative for
4638 the particular user, even for a never-before-seen repository on the
4639 site. When more than one insteadOf strings match a given URL, the
4640 longest match is used.
4641 Note that any protocol restrictions will be applied to the
4643 rewritten URL. If the rewrite changes the URL to use a custom
4644 protocol or remote helper, you may need to adjust the
4645 protocol.*.allow config to permit the request. In particular,
4646 protocols you expect to use for submodules must be set to always
4647 rather than the default of user. See the description of
4648 protocol.allow above.
4649 url.<base>.pushInsteadOf
4651 Any URL that starts with this value will not be pushed to; instead,
4652 it will be rewritten to start with <base>, and the resulting URL
4653 will be pushed to. In cases where some site serves a large number
4654 of repositories, and serves them with multiple access methods, some
4655 of which do not allow push, this feature allows people to specify a
4656 pull-only URL and have Git automatically use an appropriate URL to
4657 push, even for a never-before-seen repository on the site. When
4658 more than one pushInsteadOf strings match a given URL, the longest
4659 match is used. If a remote has an explicit pushurl, Git will ignore
4660 this setting for that remote.
4661 user.email
4663 Your email address to be recorded in any newly created commits. Can
4664 be overridden by the GIT_AUTHOR_EMAIL, GIT_COMMITTER_EMAIL, and
4665 EMAIL environment variables. See git-commit-tree(1).
4666 user.name
4668 Your full name to be recorded in any newly created commits. Can be
4669 overridden by the GIT_AUTHOR_NAME and GIT_COMMITTER_NAME
4670 environment variables. See git-commit-tree(1).
4671 user.useConfigOnly
4673 Instruct Git to avoid trying to guess defaults for user.email and
4674 user.name, and instead retrieve the values only from the
4675 configuration. For example, if you have multiple email addresses
4676 and would like to use a different one for each repository, then
4677 with this configuration option set to true in the global config
4678 along with a name, Git will prompt you to set up an email before
4679 making new commits in a newly cloned repository. Defaults to false.
4680 user.signingKey
4682 If git-tag(1) or git-commit(1) is not selecting the key you want it
4683 to automatically when creating a signed tag or commit, you can
4684 override the default selection with this variable. This option is
4685 passed unchanged to gpg’s --local-user parameter, so you may
4686 specify a key using any method that gpg supports.
4687 versionsort.prereleaseSuffix (deprecated)
4689 Deprecated alias for versionsort.suffix. Ignored if
4690 versionsort.suffix is set.
4691 versionsort.suffix
4693 Even when version sort is used in git-tag(1), tagnames with the
4694 same base version but different suffixes are still sorted
4695 lexicographically, resulting e.g. in prerelease tags appearing
4696 after the main release (e.g. "1.0-rc1" after "1.0"). This variable
4697 can be specified to determine the sorting order of tags with
4698 different suffixes.
4699 By specifying a single suffix in this variable, any tagname
4701 containing that suffix will appear before the corresponding main
4702 release. E.g. if the variable is set to "-rc", then all "1.0-rcX"
4703 tags will appear before "1.0". If specified multiple times, once
4704 per suffix, then the order of suffixes in the configuration will
4705 determine the sorting order of tagnames with those suffixes. E.g.
4706 if "-pre" appears before "-rc" in the configuration, then all
4707 "1.0-preX" tags will be listed before any "1.0-rcX" tags. The
4708 placement of the main release tag relative to tags with various
4709 suffixes can be determined by specifying the empty suffix among
4710 those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
4711 "-bfs" appear in the configuration in this order, then all
4712 "v4.8-rcX" tags are listed first, followed by "v4.8", then
4713 "v4.8-ckX" and finally "v4.8-bfsX".
4714 If more than one suffixes match the same tagname, then that tagname
4716 will be sorted according to the suffix which starts at the earliest
4717 position in the tagname. If more than one different matching
4718 suffixes start at that earliest position, then that tagname will be
4719 sorted according to the longest of those suffixes. The sorting
4720 order between different suffixes is undefined if they are in
4721 multiple config files.
4722 web.browser
4724 Specify a web browser that may be used by some commands. Currently
4725 only git-instaweb(1) and git-help(1) may use it.
4726 worktree.guessRemote
4728 If no branch is specified and neither -b nor -B nor --detach is
4729 used, then git worktree add defaults to creating a new branch from
4730 HEAD. If worktree.guessRemote is set to true, worktree add tries to
4731 find a remote-tracking branch whose name uniquely matches the new
4732 branch name. If such a branch exists, it is checked out and set as
4733 "upstream" for the new branch. If no such match can be found, it
4734 falls back to creating a new branch from the current HEAD.
4735
4737 When using the deprecated [section.subsection] syntax, changing a value
4738 will result in adding a multi-line key instead of a change, if the
4739 subsection is given with at least one uppercase character. For example
4740 when the config looks like
4741 [section.subsection]
4743 key = value1
4744 and running git config section.Subsection.key value2 will result in
4747 [section.subsection]
4749 key = value1
4750 key = value2
4751
4754 Part of the git(1) suite
4755
4757 1. the multi-pack-index design document
4758 file:///usr/share/doc/git/technical/multi-pack-index.html
4759 2. wire protocol version 2
4761 file:///usr/share/doc/git/technical/protocol-v2.html
4762Git 2.21.0 02/24/2019 GIT-CONFIG(1)