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