4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times; we say then that the variable is
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored. The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
27 The file consists of sections and variables. A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins. Section names are case-insensitive. Only alphanumeric
30 characters, `-` and `.` are allowed in section names. Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
34 Sections can be further divided into subsections. To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
39 [section "subsection"]
43 Subsection names are case sensitive and can contain any characters except
44 newline and the null byte. Doublequote `"` and backslash can be included
45 by escaping them as `\"` and `\\`, respectively. Backslashes preceding
46 other characters are dropped when reading; for example, `\t` is read as
47 `t` and `\0` is read as `0` Section headers cannot span multiple lines.
48 Variables may belong directly to a section or to a given subsection. You
49 can have `[section]` if you have `[section "subsection"]`, but you don't
52 There is also a deprecated `[section.subsection]` syntax. With this
53 syntax, the subsection name is converted to lower-case and is also
54 compared case sensitively. These subsection names follow the same
55 restrictions as section names.
57 All the other lines (and the remainder of the line after the section
58 header) are recognized as setting variables, in the form
59 'name = value' (or just 'name', which is a short-hand to say that
60 the variable is the boolean "true").
61 The variable names are case-insensitive, allow only alphanumeric characters
62 and `-`, and must start with an alphabetic character.
64 A line that defines a value can be continued to the next line by
65 ending it with a `\`; the backquote and the end-of-line are
66 stripped. Leading whitespaces after 'name =', the remainder of the
67 line after the first comment character '#' or ';', and trailing
68 whitespaces of the line are discarded unless they are enclosed in
69 double quotes. Internal whitespaces within the value are retained
72 Inside double quotes, double quote `"` and backslash `\` characters
73 must be escaped: use `\"` for `"` and `\\` for `\`.
75 The following escape sequences (beside `\"` and `\\`) are recognized:
76 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77 and `\b` for backspace (BS). Other char escape sequences (including octal
78 escape sequences) are invalid.
84 The `include` and `includeIf` sections allow you to include config
85 directives from another source. These sections behave identically to
86 each other with the exception that `includeIf` sections may be ignored
87 if their condition does not evaluate to true; see "Conditional includes"
90 You can include a config file from another by setting the special
91 `include.path` (or `includeIf.*.path`) variable to the name of the file
92 to be included. The variable takes a pathname as its value, and is
93 subject to tilde expansion. These variables can be given multiple times.
95 The contents of the included file are inserted immediately, as if they
96 had been found at the location of the include directive. If the value of the
97 variable is a relative path, the path is considered to
98 be relative to the configuration file in which the include directive
99 was found. See below for examples.
104 You can include a config file from another conditionally by setting a
105 `includeIf.<condition>.path` variable to the name of the file to be
108 The condition starts with a keyword followed by a colon and some data
109 whose format and meaning depends on the keyword. Supported keywords
114 The data that follows the keyword `gitdir:` is used as a glob
115 pattern. If the location of the .git directory matches the
116 pattern, the include condition is met.
118 The .git location may be auto-discovered, or come from `$GIT_DIR`
119 environment variable. If the repository is auto discovered via a .git
120 file (e.g. from submodules, or a linked worktree), the .git location
121 would be the final location where the .git directory is, not where the
124 The pattern can contain standard globbing wildcards and two additional
125 ones, `**/` and `/**`, that can match multiple path components. Please
126 refer to linkgit:gitignore[5] for details. For convenience:
128 * If the pattern starts with `~/`, `~` will be substituted with the
129 content of the environment variable `HOME`.
131 * If the pattern starts with `./`, it is replaced with the directory
132 containing the current config file.
134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
135 will be automatically prepended. For example, the pattern `foo/bar`
136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
138 * If the pattern ends with `/`, `**` will be automatically added. For
139 example, the pattern `foo/` becomes `foo/**`. In other words, it
140 matches "foo" and everything inside, recursively.
143 This is the same as `gitdir` except that matching is done
144 case-insensitively (e.g. on case-insensitive file sytems)
146 A few more notes on matching via `gitdir` and `gitdir/i`:
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
150 * Both the symlink & realpath versions of paths will be matched
151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
155 This was not the case in the initial release of this feature in
156 v2.13.0, which only matched the realpath version. Configuration that
157 wants to be compatible with the initial release of this feature needs
158 to either specify only the realpath version, or both versions.
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
168 ; Don't trust file modes
173 external = /usr/local/bin/diff-wrapper
178 merge = refs/heads/devel
182 gitProxy="ssh" for "kernel.org"
183 gitProxy=default-proxy ; for the rest
186 path = /path/to/foo.inc ; include by absolute path
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
202 ; relative paths are always relative to the including
203 ; file (if the condition is true); their location is not
204 ; affected by the condition
205 [includeIf "gitdir:/path/to/group/"]
211 Values of many variables are treated as a simple string, but there
212 are variables that take values of specific types and there are rules
213 as to how to spell them.
217 When a variable is said to take a boolean value, many
218 synonyms are accepted for 'true' and 'false'; these are all
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
228 When converting value to the canonical form using `--bool` type
229 specifier, 'git config' will ensure that the output is "true" or
230 "false" (spelled in lowercase).
233 The value for many variables that specify various sizes can
234 be suffixed with `k`, `M`,... to mean "scale the number by
235 1024", "by 1024x1024", etc.
238 The value for a variable that takes a color is a list of
239 colors (at most two, one for foreground and one for background)
240 and attributes (as many as you want), separated by spaces.
242 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
243 `blue`, `magenta`, `cyan` and `white`. The first color given is the
244 foreground; the second is the background.
246 Colors may also be given as numbers between 0 and 255; these use ANSI
247 256-color mode (but note that not all terminals may support this). If
248 your terminal supports it, you may also specify 24-bit RGB values as
251 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
252 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
253 The position of any attributes with respect to the colors
254 (before, after, or in between), doesn't matter. Specific attributes may
255 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
258 An empty color string produces no color effect at all. This can be used
259 to avoid coloring specific elements without disabling color entirely.
261 For git's pre-defined color slots, the attributes are meant to be reset
262 at the beginning of each item in the colored output. So setting
263 `color.decorate.branch` to `black` will paint that branch name in a
264 plain `black`, even if the previous thing on the same output line (e.g.
265 opening parenthesis before the list of branch names in `log --decorate`
266 output) is set to be painted with `bold` or some other attribute.
267 However, custom log formats may do more complicated and layered
268 coloring, and the negated forms may be useful there.
271 A variable that takes a pathname value can be given a
272 string that begins with "`~/`" or "`~user/`", and the usual
273 tilde expansion happens to such a string: `~/`
274 is expanded to the value of `$HOME`, and `~user/` to the
275 specified user's home directory.
281 Note that this list is non-comprehensive and not necessarily complete.
282 For command-specific variables, you will find a more detailed description
283 in the appropriate manual page.
285 Other git-related tools may and do use their own variables. When
286 inventing new variables for use in your own tool, make sure their
287 names do not conflict with those that are used by Git itself and
288 other popular tools, and describe them in your documentation.
292 These variables control various optional help messages designed to
293 aid new users. All 'advice.*' variables default to 'true', and you
294 can tell Git that you do not need help by setting these to 'false':
298 Set this variable to 'false' if you want to disable
300 'pushNonFFMatching', 'pushAlreadyExists',
301 'pushFetchFirst', and 'pushNeedsForce'
304 Advice shown when linkgit:git-push[1] fails due to a
305 non-fast-forward update to the current branch.
307 Advice shown when you ran linkgit:git-push[1] and pushed
308 'matching refs' explicitly (i.e. you used ':', or
309 specified a refspec that isn't your current branch) and
310 it resulted in a non-fast-forward error.
312 Shown when linkgit:git-push[1] rejects an update that
313 does not qualify for fast-forwarding (e.g., a tag.)
315 Shown when linkgit:git-push[1] rejects an update that
316 tries to overwrite a remote ref that points at an
317 object we do not have.
319 Shown when linkgit:git-push[1] rejects an update that
320 tries to overwrite a remote ref that points at an
321 object that is not a commit-ish, or make the remote
322 ref point at an object that is not a commit-ish.
324 Show directions on how to proceed from the current
325 state in the output of linkgit:git-status[1], in
326 the template shown when writing commit messages in
327 linkgit:git-commit[1], and in the help message shown
328 by linkgit:git-checkout[1] when switching branch.
330 Advise to consider using the `-u` option to linkgit:git-status[1]
331 when the command takes more than 2 seconds to enumerate untracked
334 Advice shown when linkgit:git-merge[1] refuses to
335 merge to avoid overwriting local changes.
337 Advice shown by various commands when conflicts
338 prevent the operation from being performed.
340 Advice on how to set your identity configuration when
341 your information is guessed from the system username and
344 Advice shown when you used linkgit:git-checkout[1] to
345 move to the detach HEAD state, to instruct how to create
346 a local branch after the fact.
347 checkoutAmbiguousRemoteBranchName::
348 Advice shown when the argument to
349 linkgit:git-checkout[1] ambiguously resolves to a
350 remote tracking branch on more than one remote in
351 situations where an unambiguous argument would have
352 otherwise caused a remote-tracking branch to be
353 checked out. See the `checkout.defaultRemote`
354 configuration variable for how to set a given remote
355 to used by default in some situations where this
356 advice would be printed.
358 Advice that shows the location of the patch file when
359 linkgit:git-am[1] fails to apply it.
361 In case of failure in the output of linkgit:git-rm[1],
362 show directions on how to proceed from the current state.
364 Advice on what to do when you've accidentally added one
365 git repo inside of another.
367 Advice shown if a hook is ignored because the hook is not
370 Print a message to the terminal whenever Git is waiting for
371 editor input from the user.
375 Tells Git if the executable bit of files in the working tree
378 Some filesystems lose the executable bit when a file that is
379 marked as executable is checked out, or checks out a
380 non-executable file with executable bit on.
381 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
382 to see if it handles the executable bit correctly
383 and this variable is automatically set as necessary.
385 A repository, however, may be on a filesystem that handles
386 the filemode correctly, and this variable is set to 'true'
387 when created, but later may be made accessible from another
388 environment that loses the filemode (e.g. exporting ext4 via
389 CIFS mount, visiting a Cygwin created repository with
390 Git for Windows or Eclipse).
391 In such a case it may be necessary to set this variable to 'false'.
392 See linkgit:git-update-index[1].
394 The default is true (when core.filemode is not specified in the config file).
397 (Windows-only) If true, mark newly-created directories and files whose
398 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
399 directory is hidden, but no other files starting with a dot. The
400 default mode is 'dotGitOnly'.
403 Internal variable which enables various workarounds to enable
404 Git to work better on filesystems that are not case sensitive,
405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
406 finds "makefile" when Git expects "Makefile", Git will assume
407 it is really the same file, and continue to remember it as
410 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
411 will probe and set core.ignoreCase true if appropriate when the repository
414 Git relies on the proper configuration of this variable for your operating
415 and file system. Modifying this value may result in unexpected behavior.
417 core.precomposeUnicode::
418 This option is only used by Mac OS implementation of Git.
419 When core.precomposeUnicode=true, Git reverts the unicode decomposition
420 of filenames done by Mac OS. This is useful when sharing a repository
421 between Mac OS and Linux or Windows.
422 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
423 When false, file names are handled fully transparent by Git,
424 which is backward compatible with older versions of Git.
427 If set to true, do not allow checkout of paths that would
428 be considered equivalent to `.git` on an HFS+ filesystem.
429 Defaults to `true` on Mac OS, and `false` elsewhere.
432 If set to true, do not allow checkout of paths that would
433 cause problems with the NTFS filesystem, e.g. conflict with
435 Defaults to `true` on Windows, and `false` elsewhere.
438 If set, the value of this variable is used as a command which
439 will identify all files that may have changed since the
440 requested date/time. This information is used to speed up git by
441 avoiding unnecessary processing of files that have not changed.
442 See the "fsmonitor-watchman" section of linkgit:githooks[5].
445 If false, the ctime differences between the index and the
446 working tree are ignored; useful when the inode change time
447 is regularly modified by something outside Git (file system
448 crawlers and some backup systems).
449 See linkgit:git-update-index[1]. True by default.
452 If true, the split-index feature of the index will be used.
453 See linkgit:git-update-index[1]. False by default.
455 core.untrackedCache::
456 Determines what to do about the untracked cache feature of the
457 index. It will be kept, if this variable is unset or set to
458 `keep`. It will automatically be added if set to `true`. And
459 it will automatically be removed, if set to `false`. Before
460 setting it to `true`, you should check that mtime is working
461 properly on your system.
462 See linkgit:git-update-index[1]. `keep` by default.
465 When missing or is set to `default`, many fields in the stat
466 structure are checked to detect if a file has been modified
467 since Git looked at it. When this configuration variable is
468 set to `minimal`, sub-second part of mtime and ctime, the
469 uid and gid of the owner of the file, the inode number (and
470 the device number, if Git was compiled to use it), are
471 excluded from the check among these fields, leaving only the
472 whole-second part of mtime (and ctime, if `core.trustCtime`
473 is set) and the filesize to be checked.
475 There are implementations of Git that do not leave usable values in
476 some fields (e.g. JGit); by excluding these fields from the
477 comparison, the `minimal` mode may help interoperability when the
478 same repository is used by these other systems at the same time.
481 Commands that output paths (e.g. 'ls-files', 'diff'), will
482 quote "unusual" characters in the pathname by enclosing the
483 pathname in double-quotes and escaping those characters with
484 backslashes in the same way C escapes control characters (e.g.
485 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
486 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
487 UTF-8). If this variable is set to false, bytes higher than
488 0x80 are not considered "unusual" any more. Double-quotes,
489 backslash and control characters are always escaped regardless
490 of the setting of this variable. A simple space character is
491 not considered "unusual". Many commands can output pathnames
492 completely verbatim using the `-z` option. The default value
496 Sets the line ending type to use in the working directory for
497 files that have the `text` property set when core.autocrlf is false.
498 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
499 native line ending. The default value is `native`. See
500 linkgit:gitattributes[5] for more information on end-of-line
504 If true, makes Git check if converting `CRLF` is reversible when
505 end-of-line conversion is active. Git will verify if a command
506 modifies a file in the work tree either directly or indirectly.
507 For example, committing a file followed by checking out the
508 same file should yield the original file in the work tree. If
509 this is not the case for the current setting of
510 `core.autocrlf`, Git will reject the file. The variable can
511 be set to "warn", in which case Git will only warn about an
512 irreversible conversion but continue the operation.
514 CRLF conversion bears a slight chance of corrupting data.
515 When it is enabled, Git will convert CRLF to LF during commit and LF to
516 CRLF during checkout. A file that contains a mixture of LF and
517 CRLF before the commit cannot be recreated by Git. For text
518 files this is the right thing to do: it corrects line endings
519 such that we have only LF line endings in the repository.
520 But for binary files that are accidentally classified as text the
521 conversion can corrupt data.
523 If you recognize such corruption early you can easily fix it by
524 setting the conversion type explicitly in .gitattributes. Right
525 after committing you still have the original file in your work
526 tree and this file is not yet corrupted. You can explicitly tell
527 Git that this file is binary and Git will handle the file
530 Unfortunately, the desired effect of cleaning up text files with
531 mixed line endings and the undesired effect of corrupting binary
532 files cannot be distinguished. In both cases CRLFs are removed
533 in an irreversible way. For text files this is the right thing
534 to do because CRLFs are line endings, while for binary files
535 converting CRLFs corrupts data.
537 Note, this safety check does not mean that a checkout will generate a
538 file identical to the original file for a different setting of
539 `core.eol` and `core.autocrlf`, but only for the current one. For
540 example, a text file with `LF` would be accepted with `core.eol=lf`
541 and could later be checked out with `core.eol=crlf`, in which case the
542 resulting file would contain `CRLF`, although the original file
543 contained `LF`. However, in both work trees the line endings would be
544 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
545 file with mixed line endings would be reported by the `core.safecrlf`
549 Setting this variable to "true" is the same as setting
550 the `text` attribute to "auto" on all files and core.eol to "crlf".
551 Set to true if you want to have `CRLF` line endings in your
552 working directory and the repository has LF line endings.
553 This variable can be set to 'input',
554 in which case no output conversion is performed.
556 core.checkRoundtripEncoding::
557 A comma and/or whitespace separated list of encodings that Git
558 performs UTF-8 round trip checks on if they are used in an
559 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
560 The default value is `SHIFT-JIS`.
563 If false, symbolic links are checked out as small plain files that
564 contain the link text. linkgit:git-update-index[1] and
565 linkgit:git-add[1] will not change the recorded type to regular
566 file. Useful on filesystems like FAT that do not support
569 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
570 will probe and set core.symlinks false if appropriate when the repository
574 A "proxy command" to execute (as 'command host port') instead
575 of establishing direct connection to the remote server when
576 using the Git protocol for fetching. If the variable value is
577 in the "COMMAND for DOMAIN" format, the command is applied only
578 on hostnames ending with the specified domain string. This variable
579 may be set multiple times and is matched in the given order;
580 the first match wins.
582 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
583 (which always applies universally, without the special "for"
586 The special string `none` can be used as the proxy command to
587 specify that no proxy be used for a given domain pattern.
588 This is useful for excluding servers inside a firewall from
589 proxy use, while defaulting to a common proxy for external domains.
592 If this variable is set, `git fetch` and `git push` will
593 use the specified command instead of `ssh` when they need to
594 connect to a remote system. The command is in the same form as
595 the `GIT_SSH_COMMAND` environment variable and is overridden
596 when the environment variable is set.
599 If true, Git will avoid using lstat() calls to detect if files have
600 changed by setting the "assume-unchanged" bit for those tracked files
601 which it has updated identically in both the index and working tree.
603 When files are modified outside of Git, the user will need to stage
604 the modified files explicitly (e.g. see 'Examples' section in
605 linkgit:git-update-index[1]).
606 Git will not normally detect changes to those files.
608 This is useful on systems where lstat() calls are very slow, such as
609 CIFS/Microsoft Windows.
613 core.preferSymlinkRefs::
614 Instead of the default "symref" format for HEAD
615 and other symbolic reference files, use symbolic links.
616 This is sometimes needed to work with old scripts that
617 expect HEAD to be a symbolic link.
620 If true this repository is assumed to be 'bare' and has no
621 working directory associated with it. If this is the case a
622 number of commands that require a working directory will be
623 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
625 This setting is automatically guessed by linkgit:git-clone[1] or
626 linkgit:git-init[1] when the repository was created. By default a
627 repository that ends in "/.git" is assumed to be not bare (bare =
628 false), while all other repositories are assumed to be bare (bare
632 Set the path to the root of the working tree.
633 If `GIT_COMMON_DIR` environment variable is set, core.worktree
634 is ignored and not used for determining the root of working tree.
635 This can be overridden by the `GIT_WORK_TREE` environment
636 variable and the `--work-tree` command-line option.
637 The value can be an absolute path or relative to the path to
638 the .git directory, which is either specified by --git-dir
639 or GIT_DIR, or automatically discovered.
640 If --git-dir or GIT_DIR is specified but none of
641 --work-tree, GIT_WORK_TREE and core.worktree is specified,
642 the current working directory is regarded as the top level
643 of your working tree.
645 Note that this variable is honored even when set in a configuration
646 file in a ".git" subdirectory of a directory and its value differs
647 from the latter directory (e.g. "/path/to/.git/config" has
648 core.worktree set to "/different/path"), which is most likely a
649 misconfiguration. Running Git commands in the "/path/to" directory will
650 still use "/different/path" as the root of the work tree and can cause
651 confusion unless you know what you are doing (e.g. you are creating a
652 read-only snapshot of the same index to a location different from the
653 repository's usual working tree).
655 core.logAllRefUpdates::
656 Enable the reflog. Updates to a ref <ref> is logged to the file
657 "`$GIT_DIR/logs/<ref>`", by appending the new and old
658 SHA-1, the date/time and the reason of the update, but
659 only when the file exists. If this configuration
660 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
661 file is automatically created for branch heads (i.e. under
662 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
663 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
664 If it is set to `always`, then a missing reflog is automatically
665 created for any ref under `refs/`.
667 This information can be used to determine what commit
668 was the tip of a branch "2 days ago".
670 This value is true by default in a repository that has
671 a working directory associated with it, and false by
672 default in a bare repository.
674 core.repositoryFormatVersion::
675 Internal variable identifying the repository format and layout
678 core.sharedRepository::
679 When 'group' (or 'true'), the repository is made shareable between
680 several users in a group (making sure all the files and objects are
681 group-writable). When 'all' (or 'world' or 'everybody'), the
682 repository will be readable by all users, additionally to being
683 group-shareable. When 'umask' (or 'false'), Git will use permissions
684 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
685 files in the repository will have this mode value. '0xxx' will override
686 user's umask value (whereas the other options will only override
687 requested parts of the user's umask value). Examples: '0660' will make
688 the repo read/write-able for the owner and group, but inaccessible to
689 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
690 repository that is group-readable but not group-writable.
691 See linkgit:git-init[1]. False by default.
693 core.warnAmbiguousRefs::
694 If true, Git will warn you if the ref name you passed it is ambiguous
695 and might match multiple refs in the repository. True by default.
698 An integer -1..9, indicating a default compression level.
699 -1 is the zlib default. 0 means no compression,
700 and 1..9 are various speed/size tradeoffs, 9 being slowest.
701 If set, this provides a default to other compression variables,
702 such as `core.looseCompression` and `pack.compression`.
704 core.looseCompression::
705 An integer -1..9, indicating the compression level for objects that
706 are not in a pack file. -1 is the zlib default. 0 means no
707 compression, and 1..9 are various speed/size tradeoffs, 9 being
708 slowest. If not set, defaults to core.compression. If that is
709 not set, defaults to 1 (best speed).
711 core.packedGitWindowSize::
712 Number of bytes of a pack file to map into memory in a
713 single mapping operation. Larger window sizes may allow
714 your system to process a smaller number of large pack files
715 more quickly. Smaller window sizes will negatively affect
716 performance due to increased calls to the operating system's
717 memory manager, but may improve performance when accessing
718 a large number of large pack files.
720 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
721 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
722 be reasonable for all users/operating systems. You probably do
723 not need to adjust this value.
725 Common unit suffixes of 'k', 'm', or 'g' are supported.
727 core.packedGitLimit::
728 Maximum number of bytes to map simultaneously into memory
729 from pack files. If Git needs to access more than this many
730 bytes at once to complete an operation it will unmap existing
731 regions to reclaim virtual address space within the process.
733 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
734 unlimited) on 64 bit platforms.
735 This should be reasonable for all users/operating systems, except on
736 the largest projects. You probably do not need to adjust this value.
738 Common unit suffixes of 'k', 'm', or 'g' are supported.
740 core.deltaBaseCacheLimit::
741 Maximum number of bytes to reserve for caching base objects
742 that may be referenced by multiple deltified objects. By storing the
743 entire decompressed base objects in a cache Git is able
744 to avoid unpacking and decompressing frequently used base
745 objects multiple times.
747 Default is 96 MiB on all platforms. This should be reasonable
748 for all users/operating systems, except on the largest projects.
749 You probably do not need to adjust this value.
751 Common unit suffixes of 'k', 'm', or 'g' are supported.
753 core.bigFileThreshold::
754 Files larger than this size are stored deflated, without
755 attempting delta compression. Storing large files without
756 delta compression avoids excessive memory usage, at the
757 slight expense of increased disk usage. Additionally files
758 larger than this size are always treated as binary.
760 Default is 512 MiB on all platforms. This should be reasonable
761 for most projects as source code and other text files can still
762 be delta compressed, but larger binary media files won't be.
764 Common unit suffixes of 'k', 'm', or 'g' are supported.
767 Specifies the pathname to the file that contains patterns to
768 describe paths that are not meant to be tracked, in addition
769 to '.gitignore' (per-directory) and '.git/info/exclude'.
770 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
771 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
772 is used instead. See linkgit:gitignore[5].
775 Some commands (e.g. svn and http interfaces) that interactively
776 ask for a password can be told to use an external program given
777 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
778 environment variable. If not set, fall back to the value of the
779 `SSH_ASKPASS` environment variable or, failing that, a simple password
780 prompt. The external program shall be given a suitable prompt as
781 command-line argument and write the password on its STDOUT.
783 core.attributesFile::
784 In addition to '.gitattributes' (per-directory) and
785 '.git/info/attributes', Git looks into this file for attributes
786 (see linkgit:gitattributes[5]). Path expansions are made the same
787 way as for `core.excludesFile`. Its default value is
788 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
789 set or empty, `$HOME/.config/git/attributes` is used instead.
792 By default Git will look for your hooks in the
793 '$GIT_DIR/hooks' directory. Set this to different path,
794 e.g. '/etc/git/hooks', and Git will try to find your hooks in
795 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
796 in '$GIT_DIR/hooks/pre-receive'.
798 The path can be either absolute or relative. A relative path is
799 taken as relative to the directory where the hooks are run (see
800 the "DESCRIPTION" section of linkgit:githooks[5]).
802 This configuration variable is useful in cases where you'd like to
803 centrally configure your Git hooks instead of configuring them on a
804 per-repository basis, or as a more flexible and centralized
805 alternative to having an `init.templateDir` where you've changed
809 Commands such as `commit` and `tag` that let you edit
810 messages by launching an editor use the value of this
811 variable when it is set, and the environment variable
812 `GIT_EDITOR` is not set. See linkgit:git-var[1].
815 Commands such as `commit` and `tag` that let you edit
816 messages consider a line that begins with this character
817 commented, and removes them after the editor returns
820 If set to "auto", `git-commit` would select a character that is not
821 the beginning character of any line in existing commit messages.
823 core.filesRefLockTimeout::
824 The length of time, in milliseconds, to retry when trying to
825 lock an individual reference. Value 0 means not to retry at
826 all; -1 means to try indefinitely. Default is 100 (i.e.,
829 core.packedRefsTimeout::
830 The length of time, in milliseconds, to retry when trying to
831 lock the `packed-refs` file. Value 0 means not to retry at
832 all; -1 means to try indefinitely. Default is 1000 (i.e.,
836 Text editor used by `git rebase -i` for editing the rebase instruction file.
837 The value is meant to be interpreted by the shell when it is used.
838 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
839 When not configured the default commit message editor is used instead.
842 Text viewer for use by Git commands (e.g., 'less'). The value
843 is meant to be interpreted by the shell. The order of preference
844 is the `$GIT_PAGER` environment variable, then `core.pager`
845 configuration, then `$PAGER`, and then the default chosen at
846 compile time (usually 'less').
848 When the `LESS` environment variable is unset, Git sets it to `FRX`
849 (if `LESS` environment variable is set, Git does not change it at
850 all). If you want to selectively override Git's default setting
851 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
852 be passed to the shell by Git, which will translate the final
853 command to `LESS=FRX less -S`. The environment does not set the
854 `S` option but the command line does, instructing less to truncate
855 long lines. Similarly, setting `core.pager` to `less -+F` will
856 deactivate the `F` option specified by the environment from the
857 command-line, deactivating the "quit if one screen" behavior of
858 `less`. One can specifically activate some flags for particular
859 commands: for example, setting `pager.blame` to `less -S` enables
860 line truncation only for `git blame`.
862 Likewise, when the `LV` environment variable is unset, Git sets it
863 to `-c`. You can override this setting by exporting `LV` with
864 another value or setting `core.pager` to `lv +c`.
867 A comma separated list of common whitespace problems to
868 notice. 'git diff' will use `color.diff.whitespace` to
869 highlight them, and 'git apply --whitespace=error' will
870 consider them as errors. You can prefix `-` to disable
871 any of them (e.g. `-trailing-space`):
873 * `blank-at-eol` treats trailing whitespaces at the end of the line
874 as an error (enabled by default).
875 * `space-before-tab` treats a space character that appears immediately
876 before a tab character in the initial indent part of the line as an
877 error (enabled by default).
878 * `indent-with-non-tab` treats a line that is indented with space
879 characters instead of the equivalent tabs as an error (not enabled by
881 * `tab-in-indent` treats a tab character in the initial indent part of
882 the line as an error (not enabled by default).
883 * `blank-at-eof` treats blank lines added at the end of file as an error
884 (enabled by default).
885 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
887 * `cr-at-eol` treats a carriage-return at the end of line as
888 part of the line terminator, i.e. with it, `trailing-space`
889 does not trigger if the character before such a carriage-return
890 is not a whitespace (not enabled by default).
891 * `tabwidth=<n>` tells how many character positions a tab occupies; this
892 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
893 errors. The default tab width is 8. Allowed values are 1 to 63.
895 core.fsyncObjectFiles::
896 This boolean will enable 'fsync()' when writing object files.
898 This is a total waste of time and effort on a filesystem that orders
899 data writes properly, but can be useful for filesystems that do not use
900 journalling (traditional UNIX filesystems) or that only journal metadata
901 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
904 Enable parallel index preload for operations like 'git diff'
906 This can speed up operations like 'git diff' and 'git status' especially
907 on filesystems like NFS that have weak caching semantics and thus
908 relatively high IO latencies. When enabled, Git will do the
909 index comparison to the filesystem data in parallel, allowing
910 overlapping IO's. Defaults to true.
913 You can set this to 'link', in which case a hardlink followed by
914 a delete of the source are used to make sure that object creation
915 will not overwrite existing objects.
917 On some file system/operating system combinations, this is unreliable.
918 Set this config setting to 'rename' there; However, This will remove the
919 check that makes sure that existing object files will not get overwritten.
922 When showing commit messages, also show notes which are stored in
923 the given ref. The ref must be fully qualified. If the given
924 ref does not exist, it is not an error but means that no
925 notes should be printed.
927 This setting defaults to "refs/notes/commits", and it can be overridden by
928 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
931 If true, then git will read the commit-graph file (if it exists)
932 to parse the graph structure of commits. Defaults to false. See
933 linkgit:git-commit-graph[1] for more information.
935 core.useReplaceRefs::
936 If set to `false`, behave as if the `--no-replace-objects`
937 option was given on the command line. See linkgit:git[1] and
938 linkgit:git-replace[1] for more information.
940 core.sparseCheckout::
941 Enable "sparse checkout" feature. See section "Sparse checkout" in
942 linkgit:git-read-tree[1] for more information.
945 Set the length object names are abbreviated to. If
946 unspecified or set to "auto", an appropriate value is
947 computed based on the approximate number of packed objects
948 in your repository, which hopefully is enough for
949 abbreviated object names to stay unique for some time.
950 The minimum length is 4.
953 add.ignore-errors (deprecated)::
954 Tells 'git add' to continue adding files when some files cannot be
955 added due to indexing errors. Equivalent to the `--ignore-errors`
956 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
957 as it does not follow the usual naming convention for configuration
961 Command aliases for the linkgit:git[1] command wrapper - e.g.
962 after defining "alias.last = cat-file commit HEAD", the invocation
963 "git last" is equivalent to "git cat-file commit HEAD". To avoid
964 confusion and troubles with script usage, aliases that
965 hide existing Git commands are ignored. Arguments are split by
966 spaces, the usual shell quoting and escaping is supported.
967 A quote pair or a backslash can be used to quote them.
969 If the alias expansion is prefixed with an exclamation point,
970 it will be treated as a shell command. For example, defining
971 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
972 "git new" is equivalent to running the shell command
973 "gitk --all --not ORIG_HEAD". Note that shell commands will be
974 executed from the top-level directory of a repository, which may
975 not necessarily be the current directory.
976 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
977 from the original current directory. See linkgit:git-rev-parse[1].
980 If true, git-am will call git-mailsplit for patches in mbox format
981 with parameter `--keep-cr`. In this case git-mailsplit will
982 not remove `\r` from lines ending with `\r\n`. Can be overridden
983 by giving `--no-keep-cr` from the command line.
984 See linkgit:git-am[1], linkgit:git-mailsplit[1].
987 By default, `git am` will fail if the patch does not apply cleanly. When
988 set to true, this setting tells `git am` to fall back on 3-way merge if
989 the patch records the identity of blobs it is supposed to apply to and
990 we have those blobs available locally (equivalent to giving the `--3way`
991 option from the command line). Defaults to `false`.
992 See linkgit:git-am[1].
994 apply.ignoreWhitespace::
995 When set to 'change', tells 'git apply' to ignore changes in
996 whitespace, in the same way as the `--ignore-space-change`
998 When set to one of: no, none, never, false tells 'git apply' to
999 respect all whitespace differences.
1000 See linkgit:git-apply[1].
1003 Tells 'git apply' how to handle whitespaces, in the same way
1004 as the `--whitespace` option. See linkgit:git-apply[1].
1006 blame.blankBoundary::
1007 Show blank commit object name for boundary commits in
1008 linkgit:git-blame[1]. This option defaults to false.
1011 This determines the coloring scheme to be applied to blame
1012 output. It can be 'repeatedLines', 'highlightRecent',
1013 or 'none' which is the default.
1016 Specifies the format used to output dates in linkgit:git-blame[1].
1017 If unset the iso format is used. For supported values,
1018 see the discussion of the `--date` option at linkgit:git-log[1].
1021 Show the author email instead of author name in linkgit:git-blame[1].
1022 This option defaults to false.
1025 Do not treat root commits as boundaries in linkgit:git-blame[1].
1026 This option defaults to false.
1028 branch.autoSetupMerge::
1029 Tells 'git branch' and 'git checkout' to set up new branches
1030 so that linkgit:git-pull[1] will appropriately merge from the
1031 starting point branch. Note that even if this option is not set,
1032 this behavior can be chosen per-branch using the `--track`
1033 and `--no-track` options. The valid settings are: `false` -- no
1034 automatic setup is done; `true` -- automatic setup is done when the
1035 starting point is a remote-tracking branch; `always` --
1036 automatic setup is done when the starting point is either a
1037 local branch or remote-tracking
1038 branch. This option defaults to true.
1040 branch.autoSetupRebase::
1041 When a new branch is created with 'git branch' or 'git checkout'
1042 that tracks another branch, this variable tells Git to set
1043 up pull to rebase instead of merge (see "branch.<name>.rebase").
1044 When `never`, rebase is never automatically set to true.
1045 When `local`, rebase is set to true for tracked branches of
1046 other local branches.
1047 When `remote`, rebase is set to true for tracked branches of
1048 remote-tracking branches.
1049 When `always`, rebase will be set to true for all tracking
1051 See "branch.autoSetupMerge" for details on how to set up a
1052 branch to track another branch.
1053 This option defaults to never.
1056 This variable controls the sort ordering of branches when displayed by
1057 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1058 value of this variable will be used as the default.
1059 See linkgit:git-for-each-ref[1] field names for valid values.
1061 branch.<name>.remote::
1062 When on branch <name>, it tells 'git fetch' and 'git push'
1063 which remote to fetch from/push to. The remote to push to
1064 may be overridden with `remote.pushDefault` (for all branches).
1065 The remote to push to, for the current branch, may be further
1066 overridden by `branch.<name>.pushRemote`. If no remote is
1067 configured, or if you are not on any branch, it defaults to
1068 `origin` for fetching and `remote.pushDefault` for pushing.
1069 Additionally, `.` (a period) is the current local repository
1070 (a dot-repository), see `branch.<name>.merge`'s final note below.
1072 branch.<name>.pushRemote::
1073 When on branch <name>, it overrides `branch.<name>.remote` for
1074 pushing. It also overrides `remote.pushDefault` for pushing
1075 from branch <name>. When you pull from one place (e.g. your
1076 upstream) and push to another place (e.g. your own publishing
1077 repository), you would want to set `remote.pushDefault` to
1078 specify the remote to push to for all branches, and use this
1079 option to override it for a specific branch.
1081 branch.<name>.merge::
1082 Defines, together with branch.<name>.remote, the upstream branch
1083 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1084 branch to merge and can also affect 'git push' (see push.default).
1085 When in branch <name>, it tells 'git fetch' the default
1086 refspec to be marked for merging in FETCH_HEAD. The value is
1087 handled like the remote part of a refspec, and must match a
1088 ref which is fetched from the remote given by
1089 "branch.<name>.remote".
1090 The merge information is used by 'git pull' (which at first calls
1091 'git fetch') to lookup the default branch for merging. Without
1092 this option, 'git pull' defaults to merge the first refspec fetched.
1093 Specify multiple values to get an octopus merge.
1094 If you wish to setup 'git pull' so that it merges into <name> from
1095 another branch in the local repository, you can point
1096 branch.<name>.merge to the desired branch, and use the relative path
1097 setting `.` (a period) for branch.<name>.remote.
1099 branch.<name>.mergeOptions::
1100 Sets default options for merging into branch <name>. The syntax and
1101 supported options are the same as those of linkgit:git-merge[1], but
1102 option values containing whitespace characters are currently not
1105 branch.<name>.rebase::
1106 When true, rebase the branch <name> on top of the fetched branch,
1107 instead of merging the default branch from the default remote when
1108 "git pull" is run. See "pull.rebase" for doing this in a non
1109 branch-specific manner.
1111 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1112 so that the local merge commits are included in the rebase (see
1113 linkgit:git-rebase[1] for details).
1115 When preserve, also pass `--preserve-merges` along to 'git rebase'
1116 so that locally committed merge commits will not be flattened
1117 by running 'git pull'.
1119 When the value is `interactive`, the rebase is run in interactive mode.
1121 *NOTE*: this is a possibly dangerous operation; do *not* use
1122 it unless you understand the implications (see linkgit:git-rebase[1]
1125 branch.<name>.description::
1126 Branch description, can be edited with
1127 `git branch --edit-description`. Branch description is
1128 automatically added in the format-patch cover letter or
1129 request-pull summary.
1131 browser.<tool>.cmd::
1132 Specify the command to invoke the specified browser. The
1133 specified command is evaluated in shell with the URLs passed
1134 as arguments. (See linkgit:git-web{litdd}browse[1].)
1136 browser.<tool>.path::
1137 Override the path for the given tool that may be used to
1138 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1139 working repository in gitweb (see linkgit:git-instaweb[1]).
1141 checkout.defaultRemote::
1142 When you run 'git checkout <something>' and only have one
1143 remote, it may implicitly fall back on checking out and
1144 tracking e.g. 'origin/<something>'. This stops working as soon
1145 as you have more than one remote with a '<something>'
1146 reference. This setting allows for setting the name of a
1147 preferred remote that should always win when it comes to
1148 disambiguation. The typical use-case is to set this to
1151 Currently this is used by linkgit:git-checkout[1] when 'git checkout
1152 <something>' will checkout the '<something>' branch on another remote,
1153 and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1154 remote branch. This setting might be used for other checkout-like
1155 commands or functionality in the future.
1157 clean.requireForce::
1158 A boolean to make git-clean do nothing unless given -f,
1159 -i or -n. Defaults to true.
1162 A boolean to enable/disable color in hints (e.g. when a push
1163 failed, see `advice.*` for a list). May be set to `always`,
1164 `false` (or `never`) or `auto` (or `true`), in which case colors
1165 are used only when the error output goes to a terminal. If
1166 unset, then the value of `color.ui` is used (`auto` by default).
1169 Use customized color for hints.
1171 color.blame.highlightRecent::
1172 This can be used to color the metadata of a blame line depending
1175 This setting should be set to a comma-separated list of color and date settings,
1176 starting and ending with a color, the dates should be set from oldest to newest.
1177 The metadata will be colored given the colors if the the line was introduced
1178 before the given timestamp, overwriting older timestamped colors.
1180 Instead of an absolute timestamp relative timestamps work as well, e.g.
1181 2.weeks.ago is valid to address anything older than 2 weeks.
1183 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1184 everything older than one year blue, recent changes between one month and
1185 one year old are kept white, and lines introduced within the last month are
1188 color.blame.repeatedLines::
1189 Use the customized color for the part of git-blame output that
1190 is repeated meta information per line (such as commit id,
1191 author name, date and timezone). Defaults to cyan.
1194 A boolean to enable/disable color in the output of
1195 linkgit:git-branch[1]. May be set to `always`,
1196 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1197 only when the output is to a terminal. If unset, then the
1198 value of `color.ui` is used (`auto` by default).
1200 color.branch.<slot>::
1201 Use customized color for branch coloration. `<slot>` is one of
1202 `current` (the current branch), `local` (a local branch),
1203 `remote` (a remote-tracking branch in refs/remotes/),
1204 `upstream` (upstream tracking branch), `plain` (other
1208 Whether to use ANSI escape sequences to add color to patches.
1209 If this is set to `always`, linkgit:git-diff[1],
1210 linkgit:git-log[1], and linkgit:git-show[1] will use color
1211 for all patches. If it is set to `true` or `auto`, those
1212 commands will only use color when output is to the terminal.
1213 If unset, then the value of `color.ui` is used (`auto` by
1216 This does not affect linkgit:git-format-patch[1] or the
1217 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1218 command line with the `--color[=<when>]` option.
1221 Use customized color for diff colorization. `<slot>` specifies
1222 which part of the patch to use the specified color, and is one
1223 of `context` (context text - `plain` is a historical synonym),
1224 `meta` (metainformation), `frag`
1225 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1226 `new` (added lines), `commit` (commit headers), `whitespace`
1227 (highlighting whitespace errors), `oldMoved` (deleted lines),
1228 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1229 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1230 `newMovedAlternativeDimmed` (See the '<mode>'
1231 setting of '--color-moved' in linkgit:git-diff[1] for details),
1232 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1233 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1235 color.decorate.<slot>::
1236 Use customized color for 'git log --decorate' output. `<slot>` is one
1237 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1238 branches, remote-tracking branches, tags, stash and HEAD, respectively
1239 and `grafted` for grafted commits.
1242 When set to `always`, always highlight matches. When `false` (or
1243 `never`), never. When set to `true` or `auto`, use color only
1244 when the output is written to the terminal. If unset, then the
1245 value of `color.ui` is used (`auto` by default).
1248 Use customized color for grep colorization. `<slot>` specifies which
1249 part of the line to use the specified color, and is one of
1253 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1255 filename prefix (when not using `-h`)
1257 function name lines (when using `-p`)
1259 line number prefix (when using `-n`)
1261 column number prefix (when using `--column`)
1263 matching text (same as setting `matchContext` and `matchSelected`)
1265 matching text in context lines
1267 matching text in selected lines
1269 non-matching text in selected lines
1271 separators between fields on a line (`:`, `-`, and `=`)
1272 and between hunks (`--`)
1276 When set to `always`, always use colors for interactive prompts
1277 and displays (such as those used by "git-add --interactive" and
1278 "git-clean --interactive"). When false (or `never`), never.
1279 When set to `true` or `auto`, use colors only when the output is
1280 to the terminal. If unset, then the value of `color.ui` is
1281 used (`auto` by default).
1283 color.interactive.<slot>::
1284 Use customized color for 'git add --interactive' and 'git clean
1285 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1286 or `error`, for four distinct types of normal output from
1287 interactive commands.
1290 A boolean to enable/disable colored output when the pager is in
1291 use (default is true).
1294 A boolean to enable/disable color in push errors. May be set to
1295 `always`, `false` (or `never`) or `auto` (or `true`), in which
1296 case colors are used only when the error output goes to a terminal.
1297 If unset, then the value of `color.ui` is used (`auto` by default).
1300 Use customized color for push errors.
1303 If set, keywords at the start of the line are highlighted. The
1304 keywords are "error", "warning", "hint" and "success", and are
1305 matched case-insensitively. May be set to `always`, `false` (or
1306 `never`) or `auto` (or `true`). If unset, then the value of
1307 `color.ui` is used (`auto` by default).
1309 color.remote.<slot>::
1310 Use customized color for each remote keyword. `<slot>` may be
1311 `hint`, `warning`, `success` or `error` which match the
1312 corresponding keyword.
1315 A boolean to enable/disable color in the output of
1316 linkgit:git-show-branch[1]. May be set to `always`,
1317 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1318 only when the output is to a terminal. If unset, then the
1319 value of `color.ui` is used (`auto` by default).
1322 A boolean to enable/disable color in the output of
1323 linkgit:git-status[1]. May be set to `always`,
1324 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1325 only when the output is to a terminal. If unset, then the
1326 value of `color.ui` is used (`auto` by default).
1328 color.status.<slot>::
1329 Use customized color for status colorization. `<slot>` is
1330 one of `header` (the header text of the status message),
1331 `added` or `updated` (files which are added but not committed),
1332 `changed` (files which are changed but not added in the index),
1333 `untracked` (files which are not tracked by Git),
1334 `branch` (the current branch),
1335 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1337 `localBranch` or `remoteBranch` (the local and remote branch names,
1338 respectively, when branch and tracking information is displayed in the
1339 status short-format), or
1340 `unmerged` (files which have unmerged changes).
1343 A boolean to enable/disable color when pushes are rejected. May be
1344 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1345 case colors are used only when the error output goes to a terminal.
1346 If unset, then the value of `color.ui` is used (`auto` by default).
1348 color.transport.rejected::
1349 Use customized color when a push was rejected.
1352 This variable determines the default value for variables such
1353 as `color.diff` and `color.grep` that control the use of color
1354 per command family. Its scope will expand as more commands learn
1355 configuration to set a default for the `--color` option. Set it
1356 to `false` or `never` if you prefer Git commands not to use
1357 color unless enabled explicitly with some other configuration
1358 or the `--color` option. Set it to `always` if you want all
1359 output not intended for machine consumption to use color, to
1360 `true` or `auto` (this is the default since Git 1.8.4) if you
1361 want such output to use color when written to the terminal.
1364 Specify whether supported commands should output in columns.
1365 This variable consists of a list of tokens separated by spaces
1368 These options control when the feature should be enabled
1369 (defaults to 'never'):
1373 always show in columns
1375 never show in columns
1377 show in columns if the output is to the terminal
1380 These options control layout (defaults to 'column'). Setting any
1381 of these implies 'always' if none of 'always', 'never', or 'auto' are
1386 fill columns before rows
1388 fill rows before columns
1393 Finally, these options can be combined with a layout option (defaults
1398 make unequal size columns to utilize more space
1400 make equal size columns
1404 Specify whether to output branch listing in `git branch` in columns.
1405 See `column.ui` for details.
1408 Specify the layout when list items in `git clean -i`, which always
1409 shows files and directories in columns. See `column.ui` for details.
1412 Specify whether to output untracked files in `git status` in columns.
1413 See `column.ui` for details.
1416 Specify whether to output tag listing in `git tag` in columns.
1417 See `column.ui` for details.
1420 This setting overrides the default of the `--cleanup` option in
1421 `git commit`. See linkgit:git-commit[1] for details. Changing the
1422 default can be useful when you always want to keep lines that begin
1423 with comment character `#` in your log message, in which case you
1424 would do `git config commit.cleanup whitespace` (note that you will
1425 have to remove the help lines that begin with `#` in the commit log
1426 template yourself, if you do this).
1430 A boolean to specify whether all commits should be GPG signed.
1431 Use of this option when doing operations such as rebase can
1432 result in a large number of commits being signed. It may be
1433 convenient to use an agent to avoid typing your GPG passphrase
1437 A boolean to enable/disable inclusion of status information in the
1438 commit message template when using an editor to prepare the commit
1439 message. Defaults to true.
1442 Specify the pathname of a file to use as the template for
1443 new commit messages.
1446 A boolean or int to specify the level of verbose with `git commit`.
1447 See linkgit:git-commit[1].
1450 Specify an external helper to be called when a username or
1451 password credential is needed; the helper may consult external
1452 storage to avoid prompting the user for the credentials. Note
1453 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1456 credential.useHttpPath::
1457 When acquiring credentials, consider the "path" component of an http
1458 or https URL to be important. Defaults to false. See
1459 linkgit:gitcredentials[7] for more information.
1461 credential.username::
1462 If no username is set for a network authentication, use this username
1463 by default. See credential.<context>.* below, and
1464 linkgit:gitcredentials[7].
1466 credential.<url>.*::
1467 Any of the credential.* options above can be applied selectively to
1468 some credentials. For example "credential.https://example.com.username"
1469 would set the default username only for https connections to
1470 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1473 credentialCache.ignoreSIGHUP::
1474 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1476 completion.commands::
1477 This is only used by git-completion.bash to add or remove
1478 commands from the list of completed commands. Normally only
1479 porcelain commands and a few select others are completed. You
1480 can add more commands, separated by space, in this
1481 variable. Prefixing the command with '-' will remove it from
1484 include::diff-config.txt[]
1486 difftool.<tool>.path::
1487 Override the path for the given tool. This is useful in case
1488 your tool is not in the PATH.
1490 difftool.<tool>.cmd::
1491 Specify the command to invoke the specified diff tool.
1492 The specified command is evaluated in shell with the following
1493 variables available: 'LOCAL' is set to the name of the temporary
1494 file containing the contents of the diff pre-image and 'REMOTE'
1495 is set to the name of the temporary file containing the contents
1496 of the diff post-image.
1499 Prompt before each invocation of the diff tool.
1501 fastimport.unpackLimit::
1502 If the number of objects imported by linkgit:git-fast-import[1]
1503 is below this limit, then the objects will be unpacked into
1504 loose object files. However if the number of imported objects
1505 equals or exceeds this limit then the pack will be stored as a
1506 pack. Storing the pack from a fast-import can make the import
1507 operation complete faster, especially on slow filesystems. If
1508 not set, the value of `transfer.unpackLimit` is used instead.
1510 fetch.recurseSubmodules::
1511 This option can be either set to a boolean value or to 'on-demand'.
1512 Setting it to a boolean changes the behavior of fetch and pull to
1513 unconditionally recurse into submodules when set to true or to not
1514 recurse at all when set to false. When set to 'on-demand' (the default
1515 value), fetch and pull will only recurse into a populated submodule
1516 when its superproject retrieves a commit that updates the submodule's
1520 If it is set to true, git-fetch-pack will check all fetched
1521 objects. See `transfer.fsckObjects` for what's
1522 checked. Defaults to false. If not set, the value of
1523 `transfer.fsckObjects` is used instead.
1525 fetch.fsck.<msg-id>::
1526 Acts like `fsck.<msg-id>`, but is used by
1527 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1528 the `fsck.<msg-id>` documentation for details.
1530 fetch.fsck.skipList::
1531 Acts like `fsck.skipList`, but is used by
1532 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1533 the `fsck.skipList` documentation for details.
1536 If the number of objects fetched over the Git native
1537 transfer is below this
1538 limit, then the objects will be unpacked into loose object
1539 files. However if the number of received objects equals or
1540 exceeds this limit then the received pack will be stored as
1541 a pack, after adding any missing delta bases. Storing the
1542 pack from a push can make the push operation complete faster,
1543 especially on slow filesystems. If not set, the value of
1544 `transfer.unpackLimit` is used instead.
1547 If true, fetch will automatically behave as if the `--prune`
1548 option was given on the command line. See also `remote.<name>.prune`
1549 and the PRUNING section of linkgit:git-fetch[1].
1552 If true, fetch will automatically behave as if the
1553 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1554 if not set already. This allows for setting both this option
1555 and `fetch.prune` to maintain a 1=1 mapping to upstream
1556 refs. See also `remote.<name>.pruneTags` and the PRUNING
1557 section of linkgit:git-fetch[1].
1560 Control how ref update status is printed. Valid values are
1561 `full` and `compact`. Default value is `full`. See section
1562 OUTPUT in linkgit:git-fetch[1] for detail.
1564 fetch.negotiationAlgorithm::
1565 Control how information about the commits in the local repository is
1566 sent when negotiating the contents of the packfile to be sent by the
1567 server. Set to "skipping" to use an algorithm that skips commits in an
1568 effort to converge faster, but may result in a larger-than-necessary
1569 packfile; The default is "default" which instructs Git to use the default algorithm
1570 that never skips commits (unless the server has acknowledged it or one
1571 of its descendants).
1572 Unknown values will cause 'git fetch' to error out.
1574 See also the `--negotiation-tip` option for linkgit:git-fetch[1].
1577 Enable multipart/mixed attachments as the default for
1578 'format-patch'. The value can also be a double quoted string
1579 which will enable attachments as the default and set the
1580 value as the boundary. See the --attach option in
1581 linkgit:git-format-patch[1].
1584 Provides the default value for the `--from` option to format-patch.
1585 Accepts a boolean value, or a name and email address. If false,
1586 format-patch defaults to `--no-from`, using commit authors directly in
1587 the "From:" field of patch mails. If true, format-patch defaults to
1588 `--from`, using your committer identity in the "From:" field of patch
1589 mails and including a "From:" field in the body of the patch mail if
1590 different. If set to a non-boolean value, format-patch uses that
1591 value instead of your committer identity. Defaults to false.
1594 A boolean which can enable or disable sequence numbers in patch
1595 subjects. It defaults to "auto" which enables it only if there
1596 is more than one patch. It can be enabled or disabled for all
1597 messages by setting it to "true" or "false". See --numbered
1598 option in linkgit:git-format-patch[1].
1601 Additional email headers to include in a patch to be submitted
1602 by mail. See linkgit:git-format-patch[1].
1606 Additional recipients to include in a patch to be submitted
1607 by mail. See the --to and --cc options in
1608 linkgit:git-format-patch[1].
1610 format.subjectPrefix::
1611 The default for format-patch is to output files with the '[PATCH]'
1612 subject prefix. Use this variable to change that prefix.
1615 The default for format-patch is to output a signature containing
1616 the Git version number. Use this variable to change that default.
1617 Set this variable to the empty string ("") to suppress
1618 signature generation.
1620 format.signatureFile::
1621 Works just like format.signature except the contents of the
1622 file specified by this variable will be used as the signature.
1625 The default for format-patch is to output files with the suffix
1626 `.patch`. Use this variable to change that suffix (make sure to
1627 include the dot if you want it).
1630 The default pretty format for log/show/whatchanged command,
1631 See linkgit:git-log[1], linkgit:git-show[1],
1632 linkgit:git-whatchanged[1].
1635 The default threading style for 'git format-patch'. Can be
1636 a boolean value, or `shallow` or `deep`. `shallow` threading
1637 makes every mail a reply to the head of the series,
1638 where the head is chosen from the cover letter, the
1639 `--in-reply-to`, and the first patch mail, in this order.
1640 `deep` threading makes every mail a reply to the previous one.
1641 A true boolean value is the same as `shallow`, and a false
1642 value disables threading.
1645 A boolean value which lets you enable the `-s/--signoff` option of
1646 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1647 patch should be a conscious act and means that you certify you have
1648 the rights to submit this work under the same open source license.
1649 Please see the 'SubmittingPatches' document for further discussion.
1651 format.coverLetter::
1652 A boolean that controls whether to generate a cover-letter when
1653 format-patch is invoked, but in addition can be set to "auto", to
1654 generate a cover-letter only when there's more than one patch.
1656 format.outputDirectory::
1657 Set a custom directory to store the resulting files instead of the
1658 current working directory.
1660 format.useAutoBase::
1661 A boolean value which lets you enable the `--base=auto` option of
1662 format-patch by default.
1664 filter.<driver>.clean::
1665 The command which is used to convert the content of a worktree
1666 file to a blob upon checkin. See linkgit:gitattributes[5] for
1669 filter.<driver>.smudge::
1670 The command which is used to convert the content of a blob
1671 object to a worktree file upon checkout. See
1672 linkgit:gitattributes[5] for details.
1675 During fsck git may find issues with legacy data which
1676 wouldn't be generated by current versions of git, and which
1677 wouldn't be sent over the wire if `transfer.fsckObjects` was
1678 set. This feature is intended to support working with legacy
1679 repositories containing such data.
1681 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1682 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1683 to clone or fetch it set `fetch.fsck.<msg-id>`.
1685 The rest of the documentation discusses `fsck.*` for brevity, but the
1686 same applies for the corresponding `receive.fsck.*` and
1687 `fetch.<msg-id>.*`. variables.
1689 Unlike variables like `color.ui` and `core.editor` the
1690 `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1691 fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1692 uniformly configure the same fsck settings in different circumstances
1693 all three of them they must all set to the same values.
1695 When `fsck.<msg-id>` is set, errors can be switched to warnings and
1696 vice versa by configuring the `fsck.<msg-id>` setting where the
1697 `<msg-id>` is the fsck message ID and the value is one of `error`,
1698 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
1699 with the message ID, e.g. "missingEmail: invalid author/committer line
1700 - missing email" means that setting `fsck.missingEmail = ignore` will
1703 In general, it is better to enumerate existing objects with problems
1704 with `fsck.skipList`, instead of listing the kind of breakages these
1705 problematic objects share to be ignored, as doing the latter will
1706 allow new instances of the same breakages go unnoticed.
1708 Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1709 doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1710 will only cause git to warn.
1713 The path to a list of object names (i.e. one unabbreviated SHA-1 per
1714 line) that are known to be broken in a non-fatal way and should
1715 be ignored. On versions of Git 2.20 and later comments ('#'), empty
1716 lines, and any leading and trailing whitespace is ignored. Everything
1717 but a SHA-1 per line will error out on older versions.
1719 This feature is useful when an established project should be accepted
1720 despite early commits containing errors that can be safely ignored
1721 such as invalid committer email addresses. Note: corrupt objects
1722 cannot be skipped with this setting.
1724 Like `fsck.<msg-id>` this variable has corresponding
1725 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1727 Unlike variables like `color.ui` and `core.editor` the
1728 `receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1729 fall back on the `fsck.skipList` configuration if they aren't set. To
1730 uniformly configure the same fsck settings in different circumstances
1731 all three of them they must all set to the same values.
1733 Older versions of Git (before 2.20) documented that the object names
1734 list should be sorted. This was never a requirement, the object names
1735 could appear in any order, but when reading the list we tracked whether
1736 the list was sorted for the purposes of an internal binary search
1737 implementation, which could save itself some work with an already sorted
1738 list. Unless you had a humongous list there was no reason to go out of
1739 your way to pre-sort the list. After Git version 2.20 a hash implementation
1740 is used instead, so there's now no reason to pre-sort the list.
1742 gc.aggressiveDepth::
1743 The depth parameter used in the delta compression
1744 algorithm used by 'git gc --aggressive'. This defaults
1747 gc.aggressiveWindow::
1748 The window size parameter used in the delta compression
1749 algorithm used by 'git gc --aggressive'. This defaults
1753 When there are approximately more than this many loose
1754 objects in the repository, `git gc --auto` will pack them.
1755 Some Porcelain commands use this command to perform a
1756 light-weight garbage collection from time to time. The
1757 default value is 6700. Setting this to 0 disables it.
1760 When there are more than this many packs that are not
1761 marked with `*.keep` file in the repository, `git gc
1762 --auto` consolidates them into one larger pack. The
1763 default value is 50. Setting this to 0 disables it.
1766 Make `git gc --auto` return immediately and run in background
1767 if the system supports it. Default is true.
1769 gc.bigPackThreshold::
1770 If non-zero, all packs larger than this limit are kept when
1771 `git gc` is run. This is very similar to `--keep-base-pack`
1772 except that all packs that meet the threshold are kept, not
1773 just the base pack. Defaults to zero. Common unit suffixes of
1774 'k', 'm', or 'g' are supported.
1776 Note that if the number of kept packs is more than gc.autoPackLimit,
1777 this configuration variable is ignored, all packs except the base pack
1778 will be repacked. After this the number of packs should go below
1779 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1781 gc.writeCommitGraph::
1782 If true, then gc will rewrite the commit-graph file when
1783 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1784 '--auto' the commit-graph will be updated if housekeeping is
1785 required. Default is false. See linkgit:git-commit-graph[1]
1789 If the file gc.log exists, then `git gc --auto` won't run
1790 unless that file is more than 'gc.logExpiry' old. Default is
1791 "1.day". See `gc.pruneExpire` for more ways to specify its
1795 Running `git pack-refs` in a repository renders it
1796 unclonable by Git versions prior to 1.5.1.2 over dumb
1797 transports such as HTTP. This variable determines whether
1798 'git gc' runs `git pack-refs`. This can be set to `notbare`
1799 to enable it within all non-bare repos or it can be set to a
1800 boolean value. The default is `true`.
1803 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1804 Override the grace period with this config variable. The value
1805 "now" may be used to disable this grace period and always prune
1806 unreachable objects immediately, or "never" may be used to
1807 suppress pruning. This feature helps prevent corruption when
1808 'git gc' runs concurrently with another process writing to the
1809 repository; see the "NOTES" section of linkgit:git-gc[1].
1811 gc.worktreePruneExpire::
1812 When 'git gc' is run, it calls
1813 'git worktree prune --expire 3.months.ago'.
1814 This config variable can be used to set a different grace
1815 period. The value "now" may be used to disable the grace
1816 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1817 may be used to suppress pruning.
1820 gc.<pattern>.reflogExpire::
1821 'git reflog expire' removes reflog entries older than
1822 this time; defaults to 90 days. The value "now" expires all
1823 entries immediately, and "never" suppresses expiration
1824 altogether. With "<pattern>" (e.g.
1825 "refs/stash") in the middle the setting applies only to
1826 the refs that match the <pattern>.
1828 gc.reflogExpireUnreachable::
1829 gc.<pattern>.reflogExpireUnreachable::
1830 'git reflog expire' removes reflog entries older than
1831 this time and are not reachable from the current tip;
1832 defaults to 30 days. The value "now" expires all entries
1833 immediately, and "never" suppresses expiration altogether.
1834 With "<pattern>" (e.g. "refs/stash")
1835 in the middle, the setting applies only to the refs that
1836 match the <pattern>.
1839 Records of conflicted merge you resolved earlier are
1840 kept for this many days when 'git rerere gc' is run.
1841 You can also use more human-readable "1.month.ago", etc.
1842 The default is 60 days. See linkgit:git-rerere[1].
1844 gc.rerereUnresolved::
1845 Records of conflicted merge you have not resolved are
1846 kept for this many days when 'git rerere gc' is run.
1847 You can also use more human-readable "1.month.ago", etc.
1848 The default is 15 days. See linkgit:git-rerere[1].
1850 gitcvs.commitMsgAnnotation::
1851 Append this string to each commit message. Set to empty string
1852 to disable this feature. Defaults to "via git-CVS emulator".
1855 Whether the CVS server interface is enabled for this repository.
1856 See linkgit:git-cvsserver[1].
1859 Path to a log file where the CVS server interface well... logs
1860 various stuff. See linkgit:git-cvsserver[1].
1862 gitcvs.usecrlfattr::
1863 If true, the server will look up the end-of-line conversion
1864 attributes for files to determine the `-k` modes to use. If
1865 the attributes force Git to treat a file as text,
1866 the `-k` mode will be left blank so CVS clients will
1867 treat it as text. If they suppress text conversion, the file
1868 will be set with '-kb' mode, which suppresses any newline munging
1869 the client might otherwise do. If the attributes do not allow
1870 the file type to be determined, then `gitcvs.allBinary` is
1871 used. See linkgit:gitattributes[5].
1874 This is used if `gitcvs.usecrlfattr` does not resolve
1875 the correct '-kb' mode to use. If true, all
1876 unresolved files are sent to the client in
1877 mode '-kb'. This causes the client to treat them
1878 as binary files, which suppresses any newline munging it
1879 otherwise might do. Alternatively, if it is set to "guess",
1880 then the contents of the file are examined to decide if
1881 it is binary, similar to `core.autocrlf`.
1884 Database used by git-cvsserver to cache revision information
1885 derived from the Git repository. The exact meaning depends on the
1886 used database driver, for SQLite (which is the default driver) this
1887 is a filename. Supports variable substitution (see
1888 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1889 Default: '%Ggitcvs.%m.sqlite'
1892 Used Perl DBI driver. You can specify any available driver
1893 for this here, but it might not work. git-cvsserver is tested
1894 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1895 reported *not* to work with 'DBD::mysql'. Experimental feature.
1896 May not contain double colons (`:`). Default: 'SQLite'.
1897 See linkgit:git-cvsserver[1].
1899 gitcvs.dbUser, gitcvs.dbPass::
1900 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1901 since SQLite has no concept of database users and/or passwords.
1902 'gitcvs.dbUser' supports variable substitution (see
1903 linkgit:git-cvsserver[1] for details).
1905 gitcvs.dbTableNamePrefix::
1906 Database table name prefix. Prepended to the names of any
1907 database tables used, allowing a single database to be used
1908 for several repositories. Supports variable substitution (see
1909 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1910 characters will be replaced with underscores.
1912 All gitcvs variables except for `gitcvs.usecrlfattr` and
1913 `gitcvs.allBinary` can also be specified as
1914 'gitcvs.<access_method>.<varname>' (where 'access_method'
1915 is one of "ext" and "pserver") to make them apply only for the given
1919 gitweb.description::
1922 See linkgit:gitweb[1] for description.
1930 gitweb.remote_heads::
1933 See linkgit:gitweb.conf[5] for description.
1936 If set to true, enable `-n` option by default.
1939 If set to true, enable the `--column` option by default.
1942 Set the default matching behavior. Using a value of 'basic', 'extended',
1943 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1944 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1945 value 'default' will return to the default matching behavior.
1947 grep.extendedRegexp::
1948 If set to true, enable `--extended-regexp` option by default. This
1949 option is ignored when the `grep.patternType` option is set to a value
1950 other than 'default'.
1953 Number of grep worker threads to use.
1954 See `grep.threads` in linkgit:git-grep[1] for more information.
1956 grep.fallbackToNoIndex::
1957 If set to true, fall back to git grep --no-index if git grep
1958 is executed outside of a git repository. Defaults to false.
1961 Use this custom program instead of "`gpg`" found on `$PATH` when
1962 making or verifying a PGP signature. The program must support the
1963 same command-line interface as GPG, namely, to verify a detached
1964 signature, "`gpg --verify $file - <$signature`" is run, and the
1965 program is expected to signal a good signature by exiting with
1966 code 0, and to generate an ASCII-armored detached signature, the
1967 standard input of "`gpg -bsau $key`" is fed with the contents to be
1968 signed, and the program is expected to send the result to its
1972 Specifies which key format to use when signing with `--gpg-sign`.
1973 Default is "openpgp" and another possible value is "x509".
1975 gpg.<format>.program::
1976 Use this to customize the program used for the signing format you
1977 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1978 be used as a legacy synonym for `gpg.openpgp.program`. The default
1979 value for `gpg.x509.program` is "gpgsm".
1981 gui.commitMsgWidth::
1982 Defines how wide the commit message window is in the
1983 linkgit:git-gui[1]. "75" is the default.
1986 Specifies how many context lines should be used in calls to diff
1987 made by the linkgit:git-gui[1]. The default is "5".
1989 gui.displayUntracked::
1990 Determines if linkgit:git-gui[1] shows untracked files
1991 in the file list. The default is "true".
1994 Specifies the default encoding to use for displaying of
1995 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1996 It can be overridden by setting the 'encoding' attribute
1997 for relevant files (see linkgit:gitattributes[5]).
1998 If this option is not set, the tools default to the
2001 gui.matchTrackingBranch::
2002 Determines if new branches created with linkgit:git-gui[1] should
2003 default to tracking remote branches with matching names or
2004 not. Default: "false".
2006 gui.newBranchTemplate::
2007 Is used as suggested name when creating new branches using the
2010 gui.pruneDuringFetch::
2011 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
2012 performing a fetch. The default value is "false".
2015 Determines if linkgit:git-gui[1] should trust the file modification
2016 timestamp or not. By default the timestamps are not trusted.
2018 gui.spellingDictionary::
2019 Specifies the dictionary used for spell checking commit messages in
2020 the linkgit:git-gui[1]. When set to "none" spell checking is turned
2024 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
2025 location detection. It makes blame significantly faster on huge
2026 repositories at the expense of less thorough copy detection.
2028 gui.copyBlameThreshold::
2029 Specifies the threshold to use in 'git gui blame' original location
2030 detection, measured in alphanumeric characters. See the
2031 linkgit:git-blame[1] manual for more information on copy detection.
2033 gui.blamehistoryctx::
2034 Specifies the radius of history context in days to show in
2035 linkgit:gitk[1] for the selected commit, when the `Show History
2036 Context` menu item is invoked from 'git gui blame'. If this
2037 variable is set to zero, the whole history is shown.
2039 guitool.<name>.cmd::
2040 Specifies the shell command line to execute when the corresponding item
2041 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
2042 mandatory for every tool. The command is executed from the root of
2043 the working directory, and in the environment it receives the name of
2044 the tool as `GIT_GUITOOL`, the name of the currently selected file as
2045 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
2046 the head is detached, 'CUR_BRANCH' is empty).
2048 guitool.<name>.needsFile::
2049 Run the tool only if a diff is selected in the GUI. It guarantees
2050 that 'FILENAME' is not empty.
2052 guitool.<name>.noConsole::
2053 Run the command silently, without creating a window to display its
2056 guitool.<name>.noRescan::
2057 Don't rescan the working directory for changes after the tool
2060 guitool.<name>.confirm::
2061 Show a confirmation dialog before actually running the tool.
2063 guitool.<name>.argPrompt::
2064 Request a string argument from the user, and pass it to the tool
2065 through the `ARGS` environment variable. Since requesting an
2066 argument implies confirmation, the 'confirm' option has no effect
2067 if this is enabled. If the option is set to 'true', 'yes', or '1',
2068 the dialog uses a built-in generic prompt; otherwise the exact
2069 value of the variable is used.
2071 guitool.<name>.revPrompt::
2072 Request a single valid revision from the user, and set the
2073 `REVISION` environment variable. In other aspects this option
2074 is similar to 'argPrompt', and can be used together with it.
2076 guitool.<name>.revUnmerged::
2077 Show only unmerged branches in the 'revPrompt' subdialog.
2078 This is useful for tools similar to merge or rebase, but not
2079 for things like checkout or reset.
2081 guitool.<name>.title::
2082 Specifies the title to use for the prompt dialog. The default
2085 guitool.<name>.prompt::
2086 Specifies the general prompt string to display at the top of
2087 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
2088 The default value includes the actual command.
2091 Specify the browser that will be used to display help in the
2092 'web' format. See linkgit:git-help[1].
2095 Override the default help format used by linkgit:git-help[1].
2096 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2097 the default. 'web' and 'html' are the same.
2100 Automatically correct and execute mistyped commands after
2101 waiting for the given number of deciseconds (0.1 sec). If more
2102 than one command can be deduced from the entered text, nothing
2103 will be executed. If the value of this option is negative,
2104 the corrected command will be executed immediately. If the
2105 value is 0 - the command will be just shown but not executed.
2106 This is the default.
2109 Specify the path where the HTML documentation resides. File system paths
2110 and URLs are supported. HTML pages will be prefixed with this path when
2111 help is displayed in the 'web' format. This defaults to the documentation
2112 path of your Git installation.
2115 Override the HTTP proxy, normally configured using the 'http_proxy',
2116 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2117 addition to the syntax understood by curl, it is possible to specify a
2118 proxy string with a user name but no password, in which case git will
2119 attempt to acquire one in the same way it does for other credentials. See
2120 linkgit:gitcredentials[7] for more information. The syntax thus is
2121 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2122 on a per-remote basis; see remote.<name>.proxy
2124 http.proxyAuthMethod::
2125 Set the method with which to authenticate against the HTTP proxy. This
2126 only takes effect if the configured proxy string contains a user name part
2127 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2128 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2129 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2130 variable. Possible values are:
2133 * `anyauth` - Automatically pick a suitable authentication method. It is
2134 assumed that the proxy answers an unauthenticated request with a 407
2135 status code and one or more Proxy-authenticate headers with supported
2136 authentication methods. This is the default.
2137 * `basic` - HTTP Basic authentication
2138 * `digest` - HTTP Digest authentication; this prevents the password from being
2139 transmitted to the proxy in clear text
2140 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2142 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2146 Attempt authentication without seeking a username or password. This
2147 can be used to attempt GSS-Negotiate authentication without specifying
2148 a username in the URL, as libcurl normally requires a username for
2152 Control GSSAPI credential delegation. The delegation is disabled
2153 by default in libcurl since version 7.21.7. Set parameter to tell
2154 the server what it is allowed to delegate when it comes to user
2155 credentials. Used with GSS/kerberos. Possible values are:
2158 * `none` - Don't allow any delegation.
2159 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2160 Kerberos service ticket, which is a matter of realm policy.
2161 * `always` - Unconditionally allow the server to delegate.
2166 Pass an additional HTTP header when communicating with a server. If
2167 more than one such entry exists, all of them are added as extra
2168 headers. To allow overriding the settings inherited from the system
2169 config, an empty value will reset the extra headers to the empty list.
2172 The pathname of a file containing previously stored cookie lines,
2173 which should be used
2174 in the Git http session, if they match the server. The file format
2175 of the file to read cookies from should be plain HTTP headers or
2176 the Netscape/Mozilla cookie file format (see `curl(1)`).
2177 NOTE that the file specified with http.cookieFile is used only as
2178 input unless http.saveCookies is set.
2181 If set, store cookies received during requests to the file specified by
2182 http.cookieFile. Has no effect if http.cookieFile is unset.
2185 The SSL version to use when negotiating an SSL connection, if you
2186 want to force the default. The available and default version
2187 depend on whether libcurl was built against NSS or OpenSSL and the
2188 particular configuration of the crypto library in use. Internally
2189 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2190 documentation for more details on the format of this option and
2191 for the ssl version supported. Actually the possible values of
2203 Can be overridden by the `GIT_SSL_VERSION` environment variable.
2204 To force git to use libcurl's default ssl version and ignore any
2205 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2208 http.sslCipherList::
2209 A list of SSL ciphers to use when negotiating an SSL connection.
2210 The available ciphers depend on whether libcurl was built against
2211 NSS or OpenSSL and the particular configuration of the crypto
2212 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2213 option; see the libcurl documentation for more details on the format
2216 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2217 To force git to use libcurl's default cipher list and ignore any
2218 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2222 Whether to verify the SSL certificate when fetching or pushing
2223 over HTTPS. Defaults to true. Can be overridden by the
2224 `GIT_SSL_NO_VERIFY` environment variable.
2227 File containing the SSL certificate when fetching or pushing
2228 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2232 File containing the SSL private key when fetching or pushing
2233 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2236 http.sslCertPasswordProtected::
2237 Enable Git's password prompt for the SSL certificate. Otherwise
2238 OpenSSL will prompt the user, possibly many times, if the
2239 certificate or private key is encrypted. Can be overridden by the
2240 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2243 File containing the certificates to verify the peer with when
2244 fetching or pushing over HTTPS. Can be overridden by the
2245 `GIT_SSL_CAINFO` environment variable.
2248 Path containing files with the CA certificates to verify the peer
2249 with when fetching or pushing over HTTPS. Can be overridden
2250 by the `GIT_SSL_CAPATH` environment variable.
2253 Public key of the https service. It may either be the filename of
2254 a PEM or DER encoded public key file or a string starting with
2255 'sha256//' followed by the base64 encoded sha256 hash of the
2256 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2257 exit with an error if this option is set but not supported by
2261 Attempt to use AUTH SSL/TLS and encrypted data transfers
2262 when connecting via regular FTP protocol. This might be needed
2263 if the FTP server requires it for security reasons or you wish
2264 to connect securely whenever remote FTP server supports it.
2265 Default is false since it might trigger certificate verification
2266 errors on misconfigured servers.
2269 How many HTTP requests to launch in parallel. Can be overridden
2270 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2273 The number of curl sessions (counted across slots) to be kept across
2274 requests. They will not be ended with curl_easy_cleanup() until
2275 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2276 value will be capped at 1. Defaults to 1.
2279 Maximum size in bytes of the buffer used by smart HTTP
2280 transports when POSTing data to the remote system.
2281 For requests larger than this buffer size, HTTP/1.1 and
2282 Transfer-Encoding: chunked is used to avoid creating a
2283 massive pack file locally. Default is 1 MiB, which is
2284 sufficient for most requests.
2286 http.lowSpeedLimit, http.lowSpeedTime::
2287 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2288 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2289 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2290 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2293 A boolean which disables using of EPSV ftp command by curl.
2294 This can helpful with some "poor" ftp servers which don't
2295 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2296 environment variable. Default is false (curl will use EPSV).
2299 The HTTP USER_AGENT string presented to an HTTP server. The default
2300 value represents the version of the client Git such as git/1.7.1.
2301 This option allows you to override this value to a more common value
2302 such as Mozilla/4.0. This may be necessary, for instance, if
2303 connecting through a firewall that restricts HTTP connections to a set
2304 of common USER_AGENT strings (but not including those like git/1.7.1).
2305 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2307 http.followRedirects::
2308 Whether git should follow HTTP redirects. If set to `true`, git
2309 will transparently follow any redirect issued by a server it
2310 encounters. If set to `false`, git will treat all redirects as
2311 errors. If set to `initial`, git will follow redirects only for
2312 the initial request to a remote, but not for subsequent
2313 follow-up HTTP requests. Since git uses the redirected URL as
2314 the base for the follow-up requests, this is generally
2315 sufficient. The default is `initial`.
2318 Any of the http.* options above can be applied selectively to some URLs.
2319 For a config key to match a URL, each element of the config key is
2320 compared to that of the URL, in the following order:
2323 . Scheme (e.g., `https` in `https://example.com/`). This field
2324 must match exactly between the config key and the URL.
2326 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2327 This field must match between the config key and the URL. It is
2328 possible to specify a `*` as part of the host name to match all subdomains
2329 at this level. `https://*.example.com/` for example would match
2330 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2332 . Port number (e.g., `8080` in `http://example.com:8080/`).
2333 This field must match exactly between the config key and the URL.
2334 Omitted port numbers are automatically converted to the correct
2335 default for the scheme before matching.
2337 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2338 path field of the config key must match the path field of the URL
2339 either exactly or as a prefix of slash-delimited path elements. This means
2340 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2341 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2342 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2343 key with just path `foo/`).
2345 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2346 the config key has a user name it must match the user name in the
2347 URL exactly. If the config key does not have a user name, that
2348 config key will match a URL with any user name (including none),
2349 but at a lower precedence than a config key with a user name.
2352 The list above is ordered by decreasing precedence; a URL that matches
2353 a config key's path is preferred to one that matches its user name. For example,
2354 if the URL is `https://user@example.com/foo/bar` a config key match of
2355 `https://example.com/foo` will be preferred over a config key match of
2356 `https://user@example.com`.
2358 All URLs are normalized before attempting any matching (the password part,
2359 if embedded in the URL, is always ignored for matching purposes) so that
2360 equivalent URLs that are simply spelled differently will match properly.
2361 Environment variable settings always override any matches. The URLs that are
2362 matched against are those given directly to Git commands. This means any URLs
2363 visited as a result of a redirection do not participate in matching.
2366 By default, Git determines the command line arguments to use
2367 based on the basename of the configured SSH command (configured
2368 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2369 the config setting `core.sshCommand`). If the basename is
2370 unrecognized, Git will attempt to detect support of OpenSSH
2371 options by first invoking the configured SSH command with the
2372 `-G` (print configuration) option and will subsequently use
2373 OpenSSH options (if that is successful) or no options besides
2374 the host and remote command (if it fails).
2376 The config variable `ssh.variant` can be set to override this detection.
2377 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2378 `tortoiseplink`, `simple` (no options except the host and remote command).
2379 The default auto-detection can be explicitly requested using the value
2380 `auto`. Any other value is treated as `ssh`. This setting can also be
2381 overridden via the environment variable `GIT_SSH_VARIANT`.
2383 The current command-line parameters used for each variant are as
2388 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2390 * `simple` - [username@]host command
2392 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2394 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2398 Except for the `simple` variant, command-line parameters are likely to
2399 change as git gains new features.
2401 i18n.commitEncoding::
2402 Character encoding the commit messages are stored in; Git itself
2403 does not care per se, but this information is necessary e.g. when
2404 importing commits from emails or in the gitk graphical history
2405 browser (and possibly at other places in the future or in other
2406 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2408 i18n.logOutputEncoding::
2409 Character encoding the commit messages are converted to when
2410 running 'git log' and friends.
2413 The configuration variables in the 'imap' section are described
2414 in linkgit:git-imap-send[1].
2417 Specify the version with which new index files should be
2418 initialized. This does not affect existing repositories.
2421 Specify the directory from which templates will be copied.
2422 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2425 Specify the program that will be used to browse your working
2426 repository in gitweb. See linkgit:git-instaweb[1].
2429 The HTTP daemon command-line to start gitweb on your working
2430 repository. See linkgit:git-instaweb[1].
2433 If true the web server started by linkgit:git-instaweb[1] will
2434 be bound to the local IP (127.0.0.1).
2436 instaweb.modulePath::
2437 The default module path for linkgit:git-instaweb[1] to use
2438 instead of /usr/lib/apache2/modules. Only used if httpd
2442 The port number to bind the gitweb httpd to. See
2443 linkgit:git-instaweb[1].
2445 interactive.singleKey::
2446 In interactive commands, allow the user to provide one-letter
2447 input with a single key (i.e., without hitting enter).
2448 Currently this is used by the `--patch` mode of
2449 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2450 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2451 setting is silently ignored if portable keystroke input
2452 is not available; requires the Perl module Term::ReadKey.
2454 interactive.diffFilter::
2455 When an interactive command (such as `git add --patch`) shows
2456 a colorized diff, git will pipe the diff through the shell
2457 command defined by this configuration variable. The command may
2458 mark up the diff further for human consumption, provided that it
2459 retains a one-to-one correspondence with the lines in the
2460 original diff. Defaults to disabled (no filtering).
2463 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2464 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2465 override this option with `--no-abbrev-commit`.
2468 Set the default date-time mode for the 'log' command.
2469 Setting a value for log.date is similar to using 'git log''s
2470 `--date` option. See linkgit:git-log[1] for details.
2473 Print out the ref names of any commits that are shown by the log
2474 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2475 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2476 specified, the full ref name (including prefix) will be printed.
2477 If 'auto' is specified, then if the output is going to a terminal,
2478 the ref names are shown as if 'short' were given, otherwise no ref
2479 names are shown. This is the same as the `--decorate` option
2483 If `true`, `git log` will act as if the `--follow` option was used when
2484 a single <path> is given. This has the same limitations as `--follow`,
2485 i.e. it cannot be used to follow multiple files and does not work well
2486 on non-linear history.
2489 A list of colors, separated by commas, that can be used to draw
2490 history lines in `git log --graph`.
2493 If true, the initial commit will be shown as a big creation event.
2494 This is equivalent to a diff against an empty tree.
2495 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2496 normally hide the root commit will now show it. True by default.
2499 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2500 linkgit:git-whatchanged[1] assume `--show-signature`.
2503 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2504 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2507 If true, makes linkgit:git-mailinfo[1] (and therefore
2508 linkgit:git-am[1]) act by default as if the --scissors option
2509 was provided on the command-line. When active, this features
2510 removes everything from the message body before a scissors
2511 line (i.e. consisting mainly of ">8", "8<" and "-").
2514 The location of an augmenting mailmap file. The default
2515 mailmap, located in the root of the repository, is loaded
2516 first, then the mailmap file pointed to by this variable.
2517 The location of the mailmap file may be in a repository
2518 subdirectory, or somewhere outside of the repository itself.
2519 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2522 Like `mailmap.file`, but consider the value as a reference to a
2523 blob in the repository. If both `mailmap.file` and
2524 `mailmap.blob` are given, both are parsed, with entries from
2525 `mailmap.file` taking precedence. In a bare repository, this
2526 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2530 Specify the programs that may be used to display help in the
2531 'man' format. See linkgit:git-help[1].
2534 Specify the command to invoke the specified man viewer. The
2535 specified command is evaluated in shell with the man page
2536 passed as argument. (See linkgit:git-help[1].)
2539 Override the path for the given tool that may be used to
2540 display help in the 'man' format. See linkgit:git-help[1].
2542 include::merge-config.txt[]
2544 mergetool.<tool>.path::
2545 Override the path for the given tool. This is useful in case
2546 your tool is not in the PATH.
2548 mergetool.<tool>.cmd::
2549 Specify the command to invoke the specified merge tool. The
2550 specified command is evaluated in shell with the following
2551 variables available: 'BASE' is the name of a temporary file
2552 containing the common base of the files to be merged, if available;
2553 'LOCAL' is the name of a temporary file containing the contents of
2554 the file on the current branch; 'REMOTE' is the name of a temporary
2555 file containing the contents of the file from the branch being
2556 merged; 'MERGED' contains the name of the file to which the merge
2557 tool should write the results of a successful merge.
2559 mergetool.<tool>.trustExitCode::
2560 For a custom merge command, specify whether the exit code of
2561 the merge command can be used to determine whether the merge was
2562 successful. If this is not set to true then the merge target file
2563 timestamp is checked and the merge assumed to have been successful
2564 if the file has been updated, otherwise the user is prompted to
2565 indicate the success of the merge.
2567 mergetool.meld.hasOutput::
2568 Older versions of `meld` do not support the `--output` option.
2569 Git will attempt to detect whether `meld` supports `--output`
2570 by inspecting the output of `meld --help`. Configuring
2571 `mergetool.meld.hasOutput` will make Git skip these checks and
2572 use the configured value instead. Setting `mergetool.meld.hasOutput`
2573 to `true` tells Git to unconditionally use the `--output` option,
2574 and `false` avoids using `--output`.
2576 mergetool.keepBackup::
2577 After performing a merge, the original file with conflict markers
2578 can be saved as a file with a `.orig` extension. If this variable
2579 is set to `false` then this file is not preserved. Defaults to
2580 `true` (i.e. keep the backup files).
2582 mergetool.keepTemporaries::
2583 When invoking a custom merge tool, Git uses a set of temporary
2584 files to pass to the tool. If the tool returns an error and this
2585 variable is set to `true`, then these temporary files will be
2586 preserved, otherwise they will be removed after the tool has
2587 exited. Defaults to `false`.
2589 mergetool.writeToTemp::
2590 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2591 conflicting files in the worktree by default. Git will attempt
2592 to use a temporary directory for these files when set `true`.
2593 Defaults to `false`.
2596 Prompt before each invocation of the merge resolution program.
2598 notes.mergeStrategy::
2599 Which merge strategy to choose by default when resolving notes
2600 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2601 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2602 section of linkgit:git-notes[1] for more information on each strategy.
2604 notes.<name>.mergeStrategy::
2605 Which merge strategy to choose when doing a notes merge into
2606 refs/notes/<name>. This overrides the more general
2607 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2608 linkgit:git-notes[1] for more information on the available strategies.
2611 The (fully qualified) refname from which to show notes when
2612 showing commit messages. The value of this variable can be set
2613 to a glob, in which case notes from all matching refs will be
2614 shown. You may also specify this configuration variable
2615 several times. A warning will be issued for refs that do not
2616 exist, but a glob that does not match any refs is silently
2619 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2620 environment variable, which must be a colon separated list of refs or
2623 The effective value of "core.notesRef" (possibly overridden by
2624 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2627 notes.rewrite.<command>::
2628 When rewriting commits with <command> (currently `amend` or
2629 `rebase`) and this variable is set to `true`, Git
2630 automatically copies your notes from the original to the
2631 rewritten commit. Defaults to `true`, but see
2632 "notes.rewriteRef" below.
2635 When copying notes during a rewrite (see the
2636 "notes.rewrite.<command>" option), determines what to do if
2637 the target commit already has a note. Must be one of
2638 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2639 Defaults to `concatenate`.
2641 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2642 environment variable.
2645 When copying notes during a rewrite, specifies the (fully
2646 qualified) ref whose notes should be copied. The ref may be a
2647 glob, in which case notes in all matching refs will be copied.
2648 You may also specify this configuration several times.
2650 Does not have a default value; you must configure this variable to
2651 enable note rewriting. Set it to `refs/notes/commits` to enable
2652 rewriting for the default commit notes.
2654 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2655 environment variable, which must be a colon separated list of refs or
2659 The size of the window used by linkgit:git-pack-objects[1] when no
2660 window size is given on the command line. Defaults to 10.
2663 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2664 maximum depth is given on the command line. Defaults to 50.
2665 Maximum value is 4095.
2668 The maximum size of memory that is consumed by each thread
2669 in linkgit:git-pack-objects[1] for pack window memory when
2670 no limit is given on the command line. The value can be
2671 suffixed with "k", "m", or "g". When left unconfigured (or
2672 set explicitly to 0), there will be no limit.
2675 An integer -1..9, indicating the compression level for objects
2676 in a pack file. -1 is the zlib default. 0 means no
2677 compression, and 1..9 are various speed/size tradeoffs, 9 being
2678 slowest. If not set, defaults to core.compression. If that is
2679 not set, defaults to -1, the zlib default, which is "a default
2680 compromise between speed and compression (currently equivalent
2683 Note that changing the compression level will not automatically recompress
2684 all existing objects. You can force recompression by passing the -F option
2685 to linkgit:git-repack[1].
2687 pack.deltaCacheSize::
2688 The maximum memory in bytes used for caching deltas in
2689 linkgit:git-pack-objects[1] before writing them out to a pack.
2690 This cache is used to speed up the writing object phase by not
2691 having to recompute the final delta result once the best match
2692 for all objects is found. Repacking large repositories on machines
2693 which are tight with memory might be badly impacted by this though,
2694 especially if this cache pushes the system into swapping.
2695 A value of 0 means no limit. The smallest size of 1 byte may be
2696 used to virtually disable this cache. Defaults to 256 MiB.
2698 pack.deltaCacheLimit::
2699 The maximum size of a delta, that is cached in
2700 linkgit:git-pack-objects[1]. This cache is used to speed up the
2701 writing object phase by not having to recompute the final delta
2702 result once the best match for all objects is found.
2703 Defaults to 1000. Maximum value is 65535.
2706 Specifies the number of threads to spawn when searching for best
2707 delta matches. This requires that linkgit:git-pack-objects[1]
2708 be compiled with pthreads otherwise this option is ignored with a
2709 warning. This is meant to reduce packing time on multiprocessor
2710 machines. The required amount of memory for the delta search window
2711 is however multiplied by the number of threads.
2712 Specifying 0 will cause Git to auto-detect the number of CPU's
2713 and set the number of threads accordingly.
2716 Specify the default pack index version. Valid values are 1 for
2717 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2718 the new pack index with capabilities for packs larger than 4 GB
2719 as well as proper protection against the repacking of corrupted
2720 packs. Version 2 is the default. Note that version 2 is enforced
2721 and this config option ignored whenever the corresponding pack is
2724 If you have an old Git that does not understand the version 2 `*.idx` file,
2725 cloning or fetching over a non native protocol (e.g. "http")
2726 that will copy both `*.pack` file and corresponding `*.idx` file from the
2727 other side may give you a repository that cannot be accessed with your
2728 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2729 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2732 pack.packSizeLimit::
2733 The maximum size of a pack. This setting only affects
2734 packing to a file when repacking, i.e. the git:// protocol
2735 is unaffected. It can be overridden by the `--max-pack-size`
2736 option of linkgit:git-repack[1]. Reaching this limit results
2737 in the creation of multiple packfiles; which in turn prevents
2738 bitmaps from being created.
2739 The minimum size allowed is limited to 1 MiB.
2740 The default is unlimited.
2741 Common unit suffixes of 'k', 'm', or 'g' are
2745 When true, git will use pack bitmaps (if available) when packing
2746 to stdout (e.g., during the server side of a fetch). Defaults to
2747 true. You should not generally need to turn this off unless
2748 you are debugging pack bitmaps.
2750 pack.writeBitmaps (deprecated)::
2751 This is a deprecated synonym for `repack.writeBitmaps`.
2753 pack.writeBitmapHashCache::
2754 When true, git will include a "hash cache" section in the bitmap
2755 index (if one is written). This cache can be used to feed git's
2756 delta heuristics, potentially leading to better deltas between
2757 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2758 between an older, bitmapped pack and objects that have been
2759 pushed since the last gc). The downside is that it consumes 4
2760 bytes per object of disk space, and that JGit's bitmap
2761 implementation does not understand it, causing it to complain if
2762 Git and JGit are used on the same repository. Defaults to false.
2765 If the value is boolean, turns on or off pagination of the
2766 output of a particular Git subcommand when writing to a tty.
2767 Otherwise, turns on pagination for the subcommand using the
2768 pager specified by the value of `pager.<cmd>`. If `--paginate`
2769 or `--no-pager` is specified on the command line, it takes
2770 precedence over this option. To disable pagination for all
2771 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2774 Alias for a --pretty= format string, as specified in
2775 linkgit:git-log[1]. Any aliases defined here can be used just
2776 as the built-in pretty formats could. For example,
2777 running `git config pretty.changelog "format:* %H %s"`
2778 would cause the invocation `git log --pretty=changelog`
2779 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2780 Note that an alias with the same name as a built-in format
2781 will be silently ignored.
2784 If set, provide a user defined default policy for all protocols which
2785 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2786 if unset, known-safe protocols (http, https, git, ssh, file) have a
2787 default policy of `always`, known-dangerous protocols (ext) have a
2788 default policy of `never`, and all other protocols have a default
2789 policy of `user`. Supported policies:
2793 * `always` - protocol is always able to be used.
2795 * `never` - protocol is never able to be used.
2797 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2798 either unset or has a value of 1. This policy should be used when you want a
2799 protocol to be directly usable by the user but don't want it used by commands which
2800 execute clone/fetch/push commands without user input, e.g. recursive
2801 submodule initialization.
2805 protocol.<name>.allow::
2806 Set a policy to be used by protocol `<name>` with clone/fetch/push
2807 commands. See `protocol.allow` above for the available policies.
2809 The protocol names currently used by git are:
2812 - `file`: any local file-based path (including `file://` URLs,
2815 - `git`: the anonymous git protocol over a direct TCP
2816 connection (or proxy, if configured)
2818 - `ssh`: git over ssh (including `host:path` syntax,
2821 - `http`: git over http, both "smart http" and "dumb http".
2822 Note that this does _not_ include `https`; if you want to configure
2823 both, you must do so individually.
2825 - any external helpers are named by their protocol (e.g., use
2826 `hg` to allow the `git-remote-hg` helper)
2830 Experimental. If set, clients will attempt to communicate with a
2831 server using the specified protocol version. If unset, no
2832 attempt will be made by the client to communicate using a
2833 particular protocol version, this results in protocol version 0
2839 * `0` - the original wire protocol.
2841 * `1` - the original wire protocol with the addition of a version string
2842 in the initial response from the server.
2847 By default, Git does not create an extra merge commit when merging
2848 a commit that is a descendant of the current commit. Instead, the
2849 tip of the current branch is fast-forwarded. When set to `false`,
2850 this variable tells Git to create an extra merge commit in such
2851 a case (equivalent to giving the `--no-ff` option from the command
2852 line). When set to `only`, only such fast-forward merges are
2853 allowed (equivalent to giving the `--ff-only` option from the
2854 command line). This setting overrides `merge.ff` when pulling.
2857 When true, rebase branches on top of the fetched branch, instead
2858 of merging the default branch from the default remote when "git
2859 pull" is run. See "branch.<name>.rebase" for setting this on a
2862 When `merges`, pass the `--rebase-merges` option to 'git rebase'
2863 so that the local merge commits are included in the rebase (see
2864 linkgit:git-rebase[1] for details).
2866 When preserve, also pass `--preserve-merges` along to 'git rebase'
2867 so that locally committed merge commits will not be flattened
2868 by running 'git pull'.
2870 When the value is `interactive`, the rebase is run in interactive mode.
2872 *NOTE*: this is a possibly dangerous operation; do *not* use
2873 it unless you understand the implications (see linkgit:git-rebase[1]
2877 The default merge strategy to use when pulling multiple branches
2881 The default merge strategy to use when pulling a single branch.
2884 Defines the action `git push` should take if no refspec is
2885 explicitly given. Different values are well-suited for
2886 specific workflows; for instance, in a purely central workflow
2887 (i.e. the fetch source is equal to the push destination),
2888 `upstream` is probably what you want. Possible values are:
2892 * `nothing` - do not push anything (error out) unless a refspec is
2893 explicitly given. This is primarily meant for people who want to
2894 avoid mistakes by always being explicit.
2896 * `current` - push the current branch to update a branch with the same
2897 name on the receiving end. Works in both central and non-central
2900 * `upstream` - push the current branch back to the branch whose
2901 changes are usually integrated into the current branch (which is
2902 called `@{upstream}`). This mode only makes sense if you are
2903 pushing to the same repository you would normally pull from
2904 (i.e. central workflow).
2906 * `tracking` - This is a deprecated synonym for `upstream`.
2908 * `simple` - in centralized workflow, work like `upstream` with an
2909 added safety to refuse to push if the upstream branch's name is
2910 different from the local one.
2912 When pushing to a remote that is different from the remote you normally
2913 pull from, work as `current`. This is the safest option and is suited
2916 This mode has become the default in Git 2.0.
2918 * `matching` - push all branches having the same name on both ends.
2919 This makes the repository you are pushing to remember the set of
2920 branches that will be pushed out (e.g. if you always push 'maint'
2921 and 'master' there and no other branches, the repository you push
2922 to will have these two branches, and your local 'maint' and
2923 'master' will be pushed there).
2925 To use this mode effectively, you have to make sure _all_ the
2926 branches you would push out are ready to be pushed out before
2927 running 'git push', as the whole point of this mode is to allow you
2928 to push all of the branches in one go. If you usually finish work
2929 on only one branch and push out the result, while other branches are
2930 unfinished, this mode is not for you. Also this mode is not
2931 suitable for pushing into a shared central repository, as other
2932 people may add new branches there, or update the tip of existing
2933 branches outside your control.
2935 This used to be the default, but not since Git 2.0 (`simple` is the
2941 If set to true enable `--follow-tags` option by default. You
2942 may override this configuration at time of push by specifying
2946 May be set to a boolean value, or the string 'if-asked'. A true
2947 value causes all pushes to be GPG signed, as if `--signed` is
2948 passed to linkgit:git-push[1]. The string 'if-asked' causes
2949 pushes to be signed if the server supports it, as if
2950 `--signed=if-asked` is passed to 'git push'. A false value may
2951 override a value from a lower-priority config file. An explicit
2952 command-line flag always overrides this config option.
2955 When no `--push-option=<option>` argument is given from the
2956 command line, `git push` behaves as if each <value> of
2957 this variable is given as `--push-option=<value>`.
2959 This is a multi-valued variable, and an empty value can be used in a
2960 higher priority configuration file (e.g. `.git/config` in a
2961 repository) to clear the values inherited from a lower priority
2962 configuration files (e.g. `$HOME/.gitconfig`).
2979 This will result in only b (a and c are cleared).
2983 push.recurseSubmodules::
2984 Make sure all submodule commits used by the revisions to be pushed
2985 are available on a remote-tracking branch. If the value is 'check'
2986 then Git will verify that all submodule commits that changed in the
2987 revisions to be pushed are available on at least one remote of the
2988 submodule. If any commits are missing, the push will be aborted and
2989 exit with non-zero status. If the value is 'on-demand' then all
2990 submodules that changed in the revisions to be pushed will be
2991 pushed. If on-demand was not able to push all necessary revisions
2992 it will also be aborted and exit with non-zero status. If the value
2993 is 'no' then default behavior of ignoring submodules when pushing
2994 is retained. You may override this configuration at time of push by
2995 specifying '--recurse-submodules=check|on-demand|no'.
2997 include::rebase-config.txt[]
2999 receive.advertiseAtomic::
3000 By default, git-receive-pack will advertise the atomic push
3001 capability to its clients. If you don't want to advertise this
3002 capability, set this variable to false.
3004 receive.advertisePushOptions::
3005 When set to true, git-receive-pack will advertise the push options
3006 capability to its clients. False by default.
3009 By default, git-receive-pack will run "git-gc --auto" after
3010 receiving data from git-push and updating refs. You can stop
3011 it by setting this variable to false.
3013 receive.certNonceSeed::
3014 By setting this variable to a string, `git receive-pack`
3015 will accept a `git push --signed` and verifies it by using
3016 a "nonce" protected by HMAC using this string as a secret
3019 receive.certNonceSlop::
3020 When a `git push --signed` sent a push certificate with a
3021 "nonce" that was issued by a receive-pack serving the same
3022 repository within this many seconds, export the "nonce"
3023 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
3024 hooks (instead of what the receive-pack asked the sending
3025 side to include). This may allow writing checks in
3026 `pre-receive` and `post-receive` a bit easier. Instead of
3027 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
3028 that records by how many seconds the nonce is stale to
3029 decide if they want to accept the certificate, they only
3030 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
3032 receive.fsckObjects::
3033 If it is set to true, git-receive-pack will check all received
3034 objects. See `transfer.fsckObjects` for what's checked.
3035 Defaults to false. If not set, the value of
3036 `transfer.fsckObjects` is used instead.
3038 receive.fsck.<msg-id>::
3039 Acts like `fsck.<msg-id>`, but is used by
3040 linkgit:git-receive-pack[1] instead of
3041 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
3044 receive.fsck.skipList::
3045 Acts like `fsck.skipList`, but is used by
3046 linkgit:git-receive-pack[1] instead of
3047 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
3051 After receiving the pack from the client, `receive-pack` may
3052 produce no output (if `--quiet` was specified) while processing
3053 the pack, causing some networks to drop the TCP connection.
3054 With this option set, if `receive-pack` does not transmit
3055 any data in this phase for `receive.keepAlive` seconds, it will
3056 send a short keepalive packet. The default is 5 seconds; set
3057 to 0 to disable keepalives entirely.
3059 receive.unpackLimit::
3060 If the number of objects received in a push is below this
3061 limit then the objects will be unpacked into loose object
3062 files. However if the number of received objects equals or
3063 exceeds this limit then the received pack will be stored as
3064 a pack, after adding any missing delta bases. Storing the
3065 pack from a push can make the push operation complete faster,
3066 especially on slow filesystems. If not set, the value of
3067 `transfer.unpackLimit` is used instead.
3069 receive.maxInputSize::
3070 If the size of the incoming pack stream is larger than this
3071 limit, then git-receive-pack will error out, instead of
3072 accepting the pack file. If not set or set to 0, then the size
3075 receive.denyDeletes::
3076 If set to true, git-receive-pack will deny a ref update that deletes
3077 the ref. Use this to prevent such a ref deletion via a push.
3079 receive.denyDeleteCurrent::
3080 If set to true, git-receive-pack will deny a ref update that
3081 deletes the currently checked out branch of a non-bare repository.
3083 receive.denyCurrentBranch::
3084 If set to true or "refuse", git-receive-pack will deny a ref update
3085 to the currently checked out branch of a non-bare repository.
3086 Such a push is potentially dangerous because it brings the HEAD
3087 out of sync with the index and working tree. If set to "warn",
3088 print a warning of such a push to stderr, but allow the push to
3089 proceed. If set to false or "ignore", allow such pushes with no
3090 message. Defaults to "refuse".
3092 Another option is "updateInstead" which will update the working
3093 tree if pushing into the current branch. This option is
3094 intended for synchronizing working directories when one side is not easily
3095 accessible via interactive ssh (e.g. a live web site, hence the requirement
3096 that the working directory be clean). This mode also comes in handy when
3097 developing inside a VM to test and fix code on different Operating Systems.
3099 By default, "updateInstead" will refuse the push if the working tree or
3100 the index have any difference from the HEAD, but the `push-to-checkout`
3101 hook can be used to customize this. See linkgit:githooks[5].
3103 receive.denyNonFastForwards::
3104 If set to true, git-receive-pack will deny a ref update which is
3105 not a fast-forward. Use this to prevent such an update via a push,
3106 even if that push is forced. This configuration variable is
3107 set when initializing a shared repository.
3110 This variable is the same as `transfer.hideRefs`, but applies
3111 only to `receive-pack` (and so affects pushes, but not fetches).
3112 An attempt to update or delete a hidden ref by `git push` is
3115 receive.updateServerInfo::
3116 If set to true, git-receive-pack will run git-update-server-info
3117 after receiving data from git-push and updating refs.
3119 receive.shallowUpdate::
3120 If set to true, .git/shallow can be updated when new refs
3121 require new shallow roots. Otherwise those refs are rejected.
3123 remote.pushDefault::
3124 The remote to push to by default. Overrides
3125 `branch.<name>.remote` for all branches, and is overridden by
3126 `branch.<name>.pushRemote` for specific branches.
3129 The URL of a remote repository. See linkgit:git-fetch[1] or
3130 linkgit:git-push[1].
3132 remote.<name>.pushurl::
3133 The push URL of a remote repository. See linkgit:git-push[1].
3135 remote.<name>.proxy::
3136 For remotes that require curl (http, https and ftp), the URL to
3137 the proxy to use for that remote. Set to the empty string to
3138 disable proxying for that remote.
3140 remote.<name>.proxyAuthMethod::
3141 For remotes that require curl (http, https and ftp), the method to use for
3142 authenticating against the proxy in use (probably set in
3143 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3145 remote.<name>.fetch::
3146 The default set of "refspec" for linkgit:git-fetch[1]. See
3147 linkgit:git-fetch[1].
3149 remote.<name>.push::
3150 The default set of "refspec" for linkgit:git-push[1]. See
3151 linkgit:git-push[1].
3153 remote.<name>.mirror::
3154 If true, pushing to this remote will automatically behave
3155 as if the `--mirror` option was given on the command line.
3157 remote.<name>.skipDefaultUpdate::
3158 If true, this remote will be skipped by default when updating
3159 using linkgit:git-fetch[1] or the `update` subcommand of
3160 linkgit:git-remote[1].
3162 remote.<name>.skipFetchAll::
3163 If true, this remote will be skipped by default when updating
3164 using linkgit:git-fetch[1] or the `update` subcommand of
3165 linkgit:git-remote[1].
3167 remote.<name>.receivepack::
3168 The default program to execute on the remote side when pushing. See
3169 option --receive-pack of linkgit:git-push[1].
3171 remote.<name>.uploadpack::
3172 The default program to execute on the remote side when fetching. See
3173 option --upload-pack of linkgit:git-fetch-pack[1].
3175 remote.<name>.tagOpt::
3176 Setting this value to --no-tags disables automatic tag following when
3177 fetching from remote <name>. Setting it to --tags will fetch every
3178 tag from remote <name>, even if they are not reachable from remote
3179 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3180 override this setting. See options --tags and --no-tags of
3181 linkgit:git-fetch[1].
3184 Setting this to a value <vcs> will cause Git to interact with
3185 the remote with the git-remote-<vcs> helper.
3187 remote.<name>.prune::
3188 When set to true, fetching from this remote by default will also
3189 remove any remote-tracking references that no longer exist on the
3190 remote (as if the `--prune` option was given on the command line).
3191 Overrides `fetch.prune` settings, if any.
3193 remote.<name>.pruneTags::
3194 When set to true, fetching from this remote by default will also
3195 remove any local tags that no longer exist on the remote if pruning
3196 is activated in general via `remote.<name>.prune`, `fetch.prune` or
3197 `--prune`. Overrides `fetch.pruneTags` settings, if any.
3199 See also `remote.<name>.prune` and the PRUNING section of
3200 linkgit:git-fetch[1].
3203 The list of remotes which are fetched by "git remote update
3204 <group>". See linkgit:git-remote[1].
3206 repack.useDeltaBaseOffset::
3207 By default, linkgit:git-repack[1] creates packs that use
3208 delta-base offset. If you need to share your repository with
3209 Git older than version 1.4.4, either directly or via a dumb
3210 protocol such as http, then you need to set this option to
3211 "false" and repack. Access from old Git versions over the
3212 native protocol are unaffected by this option.
3214 repack.packKeptObjects::
3215 If set to true, makes `git repack` act as if
3216 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3217 details. Defaults to `false` normally, but `true` if a bitmap
3218 index is being written (either via `--write-bitmap-index` or
3219 `repack.writeBitmaps`).
3221 repack.writeBitmaps::
3222 When true, git will write a bitmap index when packing all
3223 objects to disk (e.g., when `git repack -a` is run). This
3224 index can speed up the "counting objects" phase of subsequent
3225 packs created for clones and fetches, at the cost of some disk
3226 space and extra time spent on the initial repack. This has
3227 no effect if multiple packfiles are created.
3231 When set to true, `git-rerere` updates the index with the
3232 resulting contents after it cleanly resolves conflicts using
3233 previously recorded resolution. Defaults to false.
3236 Activate recording of resolved conflicts, so that identical
3237 conflict hunks can be resolved automatically, should they be
3238 encountered again. By default, linkgit:git-rerere[1] is
3239 enabled if there is an `rr-cache` directory under the
3240 `$GIT_DIR`, e.g. if "rerere" was previously used in the
3243 sendemail.identity::
3244 A configuration identity. When given, causes values in the
3245 'sendemail.<identity>' subsection to take precedence over
3246 values in the 'sendemail' section. The default identity is
3247 the value of `sendemail.identity`.
3249 sendemail.smtpEncryption::
3250 See linkgit:git-send-email[1] for description. Note that this
3251 setting is not subject to the 'identity' mechanism.
3253 sendemail.smtpssl (deprecated)::
3254 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3256 sendemail.smtpsslcertpath::
3257 Path to ca-certificates (either a directory or a single file).
3258 Set it to an empty string to disable certificate verification.
3260 sendemail.<identity>.*::
3261 Identity-specific versions of the 'sendemail.*' parameters
3262 found below, taking precedence over those when this
3263 identity is selected, through either the command-line or
3264 `sendemail.identity`.
3266 sendemail.aliasesFile::
3267 sendemail.aliasFileType::
3268 sendemail.annotate::
3272 sendemail.chainReplyTo::
3274 sendemail.envelopeSender::
3276 sendemail.multiEdit::
3277 sendemail.signedoffbycc::
3278 sendemail.smtpPass::
3279 sendemail.suppresscc::
3280 sendemail.suppressFrom::
3283 sendemail.smtpDomain::
3284 sendemail.smtpServer::
3285 sendemail.smtpServerPort::
3286 sendemail.smtpServerOption::
3287 sendemail.smtpUser::
3289 sendemail.transferEncoding::
3290 sendemail.validate::
3292 See linkgit:git-send-email[1] for description.
3294 sendemail.signedoffcc (deprecated)::
3295 Deprecated alias for `sendemail.signedoffbycc`.
3297 sendemail.smtpBatchSize::
3298 Number of messages to be sent per connection, after that a relogin
3299 will happen. If the value is 0 or undefined, send all messages in
3301 See also the `--batch-size` option of linkgit:git-send-email[1].
3303 sendemail.smtpReloginDelay::
3304 Seconds wait before reconnecting to smtp server.
3305 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3307 showbranch.default::
3308 The default set of branches for linkgit:git-show-branch[1].
3309 See linkgit:git-show-branch[1].
3311 splitIndex.maxPercentChange::
3312 When the split index feature is used, this specifies the
3313 percent of entries the split index can contain compared to the
3314 total number of entries in both the split index and the shared
3315 index before a new shared index is written.
3316 The value should be between 0 and 100. If the value is 0 then
3317 a new shared index is always written, if it is 100 a new
3318 shared index is never written.
3319 By default the value is 20, so a new shared index is written
3320 if the number of entries in the split index would be greater
3321 than 20 percent of the total number of entries.
3322 See linkgit:git-update-index[1].
3324 splitIndex.sharedIndexExpire::
3325 When the split index feature is used, shared index files that
3326 were not modified since the time this variable specifies will
3327 be removed when a new shared index file is created. The value
3328 "now" expires all entries immediately, and "never" suppresses
3329 expiration altogether.
3330 The default value is "2.weeks.ago".
3331 Note that a shared index file is considered modified (for the
3332 purpose of expiration) each time a new split-index file is
3333 either created based on it or read from it.
3334 See linkgit:git-update-index[1].
3336 status.relativePaths::
3337 By default, linkgit:git-status[1] shows paths relative to the
3338 current directory. Setting this variable to `false` shows paths
3339 relative to the repository root (this was the default for Git
3343 Set to true to enable --short by default in linkgit:git-status[1].
3344 The option --no-short takes precedence over this variable.
3347 Set to true to enable --branch by default in linkgit:git-status[1].
3348 The option --no-branch takes precedence over this variable.
3350 status.displayCommentPrefix::
3351 If set to true, linkgit:git-status[1] will insert a comment
3352 prefix before each output line (starting with
3353 `core.commentChar`, i.e. `#` by default). This was the
3354 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3357 status.renameLimit::
3358 The number of files to consider when performing rename detection
3359 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3360 the value of diff.renameLimit.
3363 Whether and how Git detects renames in linkgit:git-status[1] and
3364 linkgit:git-commit[1] . If set to "false", rename detection is
3365 disabled. If set to "true", basic rename detection is enabled.
3366 If set to "copies" or "copy", Git will detect copies, as well.
3367 Defaults to the value of diff.renames.
3370 If set to true, linkgit:git-status[1] will display the number of
3371 entries currently stashed away.
3374 status.showUntrackedFiles::
3375 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3376 files which are not currently tracked by Git. Directories which
3377 contain only untracked files, are shown with the directory name
3378 only. Showing untracked files means that Git needs to lstat() all
3379 the files in the whole repository, which might be slow on some
3380 systems. So, this variable controls how the commands displays
3381 the untracked files. Possible values are:
3384 * `no` - Show no untracked files.
3385 * `normal` - Show untracked files and directories.
3386 * `all` - Show also individual files in untracked directories.
3389 If this variable is not specified, it defaults to 'normal'.
3390 This variable can be overridden with the -u|--untracked-files option
3391 of linkgit:git-status[1] and linkgit:git-commit[1].
3393 status.submoduleSummary::
3395 If this is set to a non zero number or true (identical to -1 or an
3396 unlimited number), the submodule summary will be enabled and a
3397 summary of commits for modified submodules will be shown (see
3398 --summary-limit option of linkgit:git-submodule[1]). Please note
3399 that the summary output command will be suppressed for all
3400 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3401 for those submodules where `submodule.<name>.ignore=all`. The only
3402 exception to that rule is that status and commit will show staged
3403 submodule changes. To
3404 also view the summary for ignored submodules you can either use
3405 the --ignore-submodules=dirty command-line option or the 'git
3406 submodule summary' command, which shows a similar output but does
3407 not honor these settings.
3410 If this is set to true, the `git stash show` command without an
3411 option will show the stash entry in patch form. Defaults to false.
3412 See description of 'show' command in linkgit:git-stash[1].
3415 If this is set to true, the `git stash show` command without an
3416 option will show diffstat of the stash entry. Defaults to true.
3417 See description of 'show' command in linkgit:git-stash[1].
3419 submodule.<name>.url::
3420 The URL for a submodule. This variable is copied from the .gitmodules
3421 file to the git config via 'git submodule init'. The user can change
3422 the configured URL before obtaining the submodule via 'git submodule
3423 update'. If neither submodule.<name>.active or submodule.active are
3424 set, the presence of this variable is used as a fallback to indicate
3425 whether the submodule is of interest to git commands.
3426 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3428 submodule.<name>.update::
3429 The method by which a submodule is updated by 'git submodule update',
3430 which is the only affected command, others such as
3431 'git checkout --recurse-submodules' are unaffected. It exists for
3432 historical reasons, when 'git submodule' was the only command to
3433 interact with submodules; settings like `submodule.active`
3434 and `pull.rebase` are more specific. It is populated by
3435 `git submodule init` from the linkgit:gitmodules[5] file.
3436 See description of 'update' command in linkgit:git-submodule[1].
3438 submodule.<name>.branch::
3439 The remote branch name for a submodule, used by `git submodule
3440 update --remote`. Set this option to override the value found in
3441 the `.gitmodules` file. See linkgit:git-submodule[1] and
3442 linkgit:gitmodules[5] for details.
3444 submodule.<name>.fetchRecurseSubmodules::
3445 This option can be used to control recursive fetching of this
3446 submodule. It can be overridden by using the --[no-]recurse-submodules
3447 command-line option to "git fetch" and "git pull".
3448 This setting will override that from in the linkgit:gitmodules[5]
3451 submodule.<name>.ignore::
3452 Defines under what circumstances "git status" and the diff family show
3453 a submodule as modified. When set to "all", it will never be considered
3454 modified (but it will nonetheless show up in the output of status and
3455 commit when it has been staged), "dirty" will ignore all changes
3456 to the submodules work tree and
3457 takes only differences between the HEAD of the submodule and the commit
3458 recorded in the superproject into account. "untracked" will additionally
3459 let submodules with modified tracked files in their work tree show up.
3460 Using "none" (the default when this option is not set) also shows
3461 submodules that have untracked files in their work tree as changed.
3462 This setting overrides any setting made in .gitmodules for this submodule,
3463 both settings can be overridden on the command line by using the
3464 "--ignore-submodules" option. The 'git submodule' commands are not
3465 affected by this setting.
3467 submodule.<name>.active::
3468 Boolean value indicating if the submodule is of interest to git
3469 commands. This config option takes precedence over the
3470 submodule.active config option. See linkgit:gitsubmodules[7] for
3474 A repeated field which contains a pathspec used to match against a
3475 submodule's path to determine if the submodule is of interest to git
3476 commands. See linkgit:gitsubmodules[7] for details.
3479 Specifies if commands recurse into submodules by default. This
3480 applies to all commands that have a `--recurse-submodules` option,
3484 submodule.fetchJobs::
3485 Specifies how many submodules are fetched/cloned at the same time.
3486 A positive integer allows up to that number of submodules fetched
3487 in parallel. A value of 0 will give some reasonable default.
3488 If unset, it defaults to 1.
3490 submodule.alternateLocation::
3491 Specifies how the submodules obtain alternates when submodules are
3492 cloned. Possible values are `no`, `superproject`.
3493 By default `no` is assumed, which doesn't add references. When the
3494 value is set to `superproject` the submodule to be cloned computes
3495 its alternates location relative to the superprojects alternate.
3497 submodule.alternateErrorStrategy::
3498 Specifies how to treat errors with the alternates for a submodule
3499 as computed via `submodule.alternateLocation`. Possible values are
3500 `ignore`, `info`, `die`. Default is `die`.
3502 tag.forceSignAnnotated::
3503 A boolean to specify whether annotated tags created should be GPG signed.
3504 If `--annotate` is specified on the command line, it takes
3505 precedence over this option.
3508 This variable controls the sort ordering of tags when displayed by
3509 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3510 value of this variable will be used as the default.
3513 This variable can be used to restrict the permission bits of
3514 tar archive entries. The default is 0002, which turns off the
3515 world write bit. The special value "user" indicates that the
3516 archiving user's umask will be used instead. See umask(2) and
3517 linkgit:git-archive[1].
3519 transfer.fsckObjects::
3520 When `fetch.fsckObjects` or `receive.fsckObjects` are
3521 not set, the value of this variable is used instead.
3524 When set, the fetch or receive will abort in the case of a malformed
3525 object or a link to a nonexistent object. In addition, various other
3526 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
3527 and potential security issues like the existence of a `.GIT` directory
3528 or a malicious `.gitmodules` file (see the release notes for v2.2.1
3529 and v2.17.1 for details). Other sanity and security checks may be
3530 added in future releases.
3532 On the receiving side, failing fsckObjects will make those objects
3533 unreachable, see "QUARANTINE ENVIRONMENT" in
3534 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
3535 instead be left unreferenced in the repository.
3537 Due to the non-quarantine nature of the `fetch.fsckObjects`
3538 implementation it can not be relied upon to leave the object store
3539 clean like `receive.fsckObjects` can.
3541 As objects are unpacked they're written to the object store, so there
3542 can be cases where malicious objects get introduced even though the
3543 "fetch" failed, only to have a subsequent "fetch" succeed because only
3544 new incoming objects are checked, not those that have already been
3545 written to the object store. That difference in behavior should not be
3546 relied upon. In the future, such objects may be quarantined for
3549 For now, the paranoid need to find some way to emulate the quarantine
3550 environment if they'd like the same protection as "push". E.g. in the
3551 case of an internal mirror do the mirroring in two steps, one to fetch
3552 the untrusted objects, and then do a second "push" (which will use the
3553 quarantine) to another internal repo, and have internal clients
3554 consume this pushed-to repository, or embargo internal fetches and
3555 only allow them once a full "fsck" has run (and no new fetches have
3556 happened in the meantime).
3559 String(s) `receive-pack` and `upload-pack` use to decide which
3560 refs to omit from their initial advertisements. Use more than
3561 one definition to specify multiple prefix strings. A ref that is
3562 under the hierarchies listed in the value of this variable is
3563 excluded, and is hidden when responding to `git push` or `git
3564 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3565 program-specific versions of this config.
3567 You may also include a `!` in front of the ref name to negate the entry,
3568 explicitly exposing it, even if an earlier entry marked it as hidden.
3569 If you have multiple hideRefs values, later entries override earlier ones
3570 (and entries in more-specific config files override less-specific ones).
3572 If a namespace is in use, the namespace prefix is stripped from each
3573 reference before it is matched against `transfer.hiderefs` patterns.
3574 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3575 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3576 is omitted from the advertisements but `refs/heads/master` and
3577 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3578 "have" lines. In order to match refs before stripping, add a `^` in front of
3579 the ref name. If you combine `!` and `^`, `!` must be specified first.
3581 Even if you hide refs, a client may still be able to steal the target
3582 objects via the techniques described in the "SECURITY" section of the
3583 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3584 separate repository.
3586 transfer.unpackLimit::
3587 When `fetch.unpackLimit` or `receive.unpackLimit` are
3588 not set, the value of this variable is used instead.
3589 The default value is 100.
3591 uploadarchive.allowUnreachable::
3592 If true, allow clients to use `git archive --remote` to request
3593 any tree, whether reachable from the ref tips or not. See the
3594 discussion in the "SECURITY" section of
3595 linkgit:git-upload-archive[1] for more details. Defaults to
3598 uploadpack.hideRefs::
3599 This variable is the same as `transfer.hideRefs`, but applies
3600 only to `upload-pack` (and so affects only fetches, not pushes).
3601 An attempt to fetch a hidden ref by `git fetch` will fail. See
3602 also `uploadpack.allowTipSHA1InWant`.
3604 uploadpack.allowTipSHA1InWant::
3605 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3606 to accept a fetch request that asks for an object at the tip
3607 of a hidden ref (by default, such a request is rejected).
3608 See also `uploadpack.hideRefs`. Even if this is false, a client
3609 may be able to steal objects via the techniques described in the
3610 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3611 best to keep private data in a separate repository.
3613 uploadpack.allowReachableSHA1InWant::
3614 Allow `upload-pack` to accept a fetch request that asks for an
3615 object that is reachable from any ref tip. However, note that
3616 calculating object reachability is computationally expensive.
3617 Defaults to `false`. Even if this is false, a client may be able
3618 to steal objects via the techniques described in the "SECURITY"
3619 section of the linkgit:gitnamespaces[7] man page; it's best to
3620 keep private data in a separate repository.
3622 uploadpack.allowAnySHA1InWant::
3623 Allow `upload-pack` to accept a fetch request that asks for any
3625 Defaults to `false`.
3627 uploadpack.keepAlive::
3628 When `upload-pack` has started `pack-objects`, there may be a
3629 quiet period while `pack-objects` prepares the pack. Normally
3630 it would output progress information, but if `--quiet` was used
3631 for the fetch, `pack-objects` will output nothing at all until
3632 the pack data begins. Some clients and networks may consider
3633 the server to be hung and give up. Setting this option instructs
3634 `upload-pack` to send an empty keepalive packet every
3635 `uploadpack.keepAlive` seconds. Setting this option to 0
3636 disables keepalive packets entirely. The default is 5 seconds.
3638 uploadpack.packObjectsHook::
3639 If this option is set, when `upload-pack` would run
3640 `git pack-objects` to create a packfile for a client, it will
3641 run this shell command instead. The `pack-objects` command and
3642 arguments it _would_ have run (including the `git pack-objects`
3643 at the beginning) are appended to the shell command. The stdin
3644 and stdout of the hook are treated as if `pack-objects` itself
3645 was run. I.e., `upload-pack` will feed input intended for
3646 `pack-objects` to the hook, and expects a completed packfile on
3649 uploadpack.allowFilter::
3650 If this option is set, `upload-pack` will support partial
3651 clone and partial fetch object filtering.
3653 Note that this configuration variable is ignored if it is seen in the
3654 repository-level config (this is a safety measure against fetching from
3655 untrusted repositories).
3657 uploadpack.allowRefInWant::
3658 If this option is set, `upload-pack` will support the `ref-in-want`
3659 feature of the protocol version 2 `fetch` command. This feature
3660 is intended for the benefit of load-balanced servers which may
3661 not have the same view of what OIDs their refs point to due to
3664 url.<base>.insteadOf::
3665 Any URL that starts with this value will be rewritten to
3666 start, instead, with <base>. In cases where some site serves a
3667 large number of repositories, and serves them with multiple
3668 access methods, and some users need to use different access
3669 methods, this feature allows people to specify any of the
3670 equivalent URLs and have Git automatically rewrite the URL to
3671 the best alternative for the particular user, even for a
3672 never-before-seen repository on the site. When more than one
3673 insteadOf strings match a given URL, the longest match is used.
3675 Note that any protocol restrictions will be applied to the rewritten
3676 URL. If the rewrite changes the URL to use a custom protocol or remote
3677 helper, you may need to adjust the `protocol.*.allow` config to permit
3678 the request. In particular, protocols you expect to use for submodules
3679 must be set to `always` rather than the default of `user`. See the
3680 description of `protocol.allow` above.
3682 url.<base>.pushInsteadOf::
3683 Any URL that starts with this value will not be pushed to;
3684 instead, it will be rewritten to start with <base>, and the
3685 resulting URL will be pushed to. In cases where some site serves
3686 a large number of repositories, and serves them with multiple
3687 access methods, some of which do not allow push, this feature
3688 allows people to specify a pull-only URL and have Git
3689 automatically use an appropriate URL to push, even for a
3690 never-before-seen repository on the site. When more than one
3691 pushInsteadOf strings match a given URL, the longest match is
3692 used. If a remote has an explicit pushurl, Git will ignore this
3693 setting for that remote.
3696 Your email address to be recorded in any newly created commits.
3697 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3698 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3701 Your full name to be recorded in any newly created commits.
3702 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3703 environment variables. See linkgit:git-commit-tree[1].
3705 user.useConfigOnly::
3706 Instruct Git to avoid trying to guess defaults for `user.email`
3707 and `user.name`, and instead retrieve the values only from the
3708 configuration. For example, if you have multiple email addresses
3709 and would like to use a different one for each repository, then
3710 with this configuration option set to `true` in the global config
3711 along with a name, Git will prompt you to set up an email before
3712 making new commits in a newly cloned repository.
3713 Defaults to `false`.
3716 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3717 key you want it to automatically when creating a signed tag or
3718 commit, you can override the default selection with this variable.
3719 This option is passed unchanged to gpg's --local-user parameter,
3720 so you may specify a key using any method that gpg supports.
3722 versionsort.prereleaseSuffix (deprecated)::
3723 Deprecated alias for `versionsort.suffix`. Ignored if
3724 `versionsort.suffix` is set.
3726 versionsort.suffix::
3727 Even when version sort is used in linkgit:git-tag[1], tagnames
3728 with the same base version but different suffixes are still sorted
3729 lexicographically, resulting e.g. in prerelease tags appearing
3730 after the main release (e.g. "1.0-rc1" after "1.0"). This
3731 variable can be specified to determine the sorting order of tags
3732 with different suffixes.
3734 By specifying a single suffix in this variable, any tagname containing
3735 that suffix will appear before the corresponding main release. E.g. if
3736 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3737 "1.0". If specified multiple times, once per suffix, then the order of
3738 suffixes in the configuration will determine the sorting order of tagnames
3739 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3740 configuration, then all "1.0-preX" tags will be listed before any
3741 "1.0-rcX" tags. The placement of the main release tag relative to tags
3742 with various suffixes can be determined by specifying the empty suffix
3743 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3744 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3745 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3748 If more than one suffixes match the same tagname, then that tagname will
3749 be sorted according to the suffix which starts at the earliest position in
3750 the tagname. If more than one different matching suffixes start at
3751 that earliest position, then that tagname will be sorted according to the
3752 longest of those suffixes.
3753 The sorting order between different suffixes is undefined if they are
3754 in multiple config files.
3757 Specify a web browser that may be used by some commands.
3758 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3761 worktree.guessRemote::
3762 With `add`, if no branch argument, and neither of `-b` nor
3763 `-B` nor `--detach` are given, the command defaults to
3764 creating a new branch from HEAD. If `worktree.guessRemote` is
3765 set to true, `worktree add` tries to find a remote-tracking
3766 branch whose name uniquely matches the new branch name. If
3767 such a branch exists, it is checked out and set as "upstream"
3768 for the new branch. If no such match can be found, it falls
3769 back to creating a new branch from the current HEAD.