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 a value to its canonical form using the `--type=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.
619 core.alternateRefsCommand::
620 When advertising tips of available history from an alternate, use the shell to
621 execute the specified command instead of linkgit:git-for-each-ref[1]. The
622 first argument is the absolute path of the alternate. Output must contain one
623 hex object id per line (i.e., the same as produced by `git for-each-ref
624 --format='%(objectname)'`).
626 Note that you cannot generally put `git for-each-ref` directly into the config
627 value, as it does not take a repository path as an argument (but you can wrap
628 the command above in a shell script).
630 core.alternateRefsPrefixes::
631 When listing references from an alternate, list only references that begin
632 with the given prefix. Prefixes match as if they were given as arguments to
633 linkgit:git-for-each-ref[1]. To list multiple prefixes, separate them with
634 whitespace. If `core.alternateRefsCommand` is set, setting
635 `core.alternateRefsPrefixes` has no effect.
638 If true this repository is assumed to be 'bare' and has no
639 working directory associated with it. If this is the case a
640 number of commands that require a working directory will be
641 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
643 This setting is automatically guessed by linkgit:git-clone[1] or
644 linkgit:git-init[1] when the repository was created. By default a
645 repository that ends in "/.git" is assumed to be not bare (bare =
646 false), while all other repositories are assumed to be bare (bare
650 Set the path to the root of the working tree.
651 If `GIT_COMMON_DIR` environment variable is set, core.worktree
652 is ignored and not used for determining the root of working tree.
653 This can be overridden by the `GIT_WORK_TREE` environment
654 variable and the `--work-tree` command-line option.
655 The value can be an absolute path or relative to the path to
656 the .git directory, which is either specified by --git-dir
657 or GIT_DIR, or automatically discovered.
658 If --git-dir or GIT_DIR is specified but none of
659 --work-tree, GIT_WORK_TREE and core.worktree is specified,
660 the current working directory is regarded as the top level
661 of your working tree.
663 Note that this variable is honored even when set in a configuration
664 file in a ".git" subdirectory of a directory and its value differs
665 from the latter directory (e.g. "/path/to/.git/config" has
666 core.worktree set to "/different/path"), which is most likely a
667 misconfiguration. Running Git commands in the "/path/to" directory will
668 still use "/different/path" as the root of the work tree and can cause
669 confusion unless you know what you are doing (e.g. you are creating a
670 read-only snapshot of the same index to a location different from the
671 repository's usual working tree).
673 core.logAllRefUpdates::
674 Enable the reflog. Updates to a ref <ref> is logged to the file
675 "`$GIT_DIR/logs/<ref>`", by appending the new and old
676 SHA-1, the date/time and the reason of the update, but
677 only when the file exists. If this configuration
678 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
679 file is automatically created for branch heads (i.e. under
680 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
681 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
682 If it is set to `always`, then a missing reflog is automatically
683 created for any ref under `refs/`.
685 This information can be used to determine what commit
686 was the tip of a branch "2 days ago".
688 This value is true by default in a repository that has
689 a working directory associated with it, and false by
690 default in a bare repository.
692 core.repositoryFormatVersion::
693 Internal variable identifying the repository format and layout
696 core.sharedRepository::
697 When 'group' (or 'true'), the repository is made shareable between
698 several users in a group (making sure all the files and objects are
699 group-writable). When 'all' (or 'world' or 'everybody'), the
700 repository will be readable by all users, additionally to being
701 group-shareable. When 'umask' (or 'false'), Git will use permissions
702 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
703 files in the repository will have this mode value. '0xxx' will override
704 user's umask value (whereas the other options will only override
705 requested parts of the user's umask value). Examples: '0660' will make
706 the repo read/write-able for the owner and group, but inaccessible to
707 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
708 repository that is group-readable but not group-writable.
709 See linkgit:git-init[1]. False by default.
711 core.warnAmbiguousRefs::
712 If true, Git will warn you if the ref name you passed it is ambiguous
713 and might match multiple refs in the repository. True by default.
716 An integer -1..9, indicating a default compression level.
717 -1 is the zlib default. 0 means no compression,
718 and 1..9 are various speed/size tradeoffs, 9 being slowest.
719 If set, this provides a default to other compression variables,
720 such as `core.looseCompression` and `pack.compression`.
722 core.looseCompression::
723 An integer -1..9, indicating the compression level for objects that
724 are not in a pack file. -1 is the zlib default. 0 means no
725 compression, and 1..9 are various speed/size tradeoffs, 9 being
726 slowest. If not set, defaults to core.compression. If that is
727 not set, defaults to 1 (best speed).
729 core.packedGitWindowSize::
730 Number of bytes of a pack file to map into memory in a
731 single mapping operation. Larger window sizes may allow
732 your system to process a smaller number of large pack files
733 more quickly. Smaller window sizes will negatively affect
734 performance due to increased calls to the operating system's
735 memory manager, but may improve performance when accessing
736 a large number of large pack files.
738 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
739 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
740 be reasonable for all users/operating systems. You probably do
741 not need to adjust this value.
743 Common unit suffixes of 'k', 'm', or 'g' are supported.
745 core.packedGitLimit::
746 Maximum number of bytes to map simultaneously into memory
747 from pack files. If Git needs to access more than this many
748 bytes at once to complete an operation it will unmap existing
749 regions to reclaim virtual address space within the process.
751 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
752 unlimited) on 64 bit platforms.
753 This should be reasonable for all users/operating systems, except on
754 the largest projects. You probably do not need to adjust this value.
756 Common unit suffixes of 'k', 'm', or 'g' are supported.
758 core.deltaBaseCacheLimit::
759 Maximum number of bytes to reserve for caching base objects
760 that may be referenced by multiple deltified objects. By storing the
761 entire decompressed base objects in a cache Git is able
762 to avoid unpacking and decompressing frequently used base
763 objects multiple times.
765 Default is 96 MiB on all platforms. This should be reasonable
766 for all users/operating systems, except on the largest projects.
767 You probably do not need to adjust this value.
769 Common unit suffixes of 'k', 'm', or 'g' are supported.
771 core.bigFileThreshold::
772 Files larger than this size are stored deflated, without
773 attempting delta compression. Storing large files without
774 delta compression avoids excessive memory usage, at the
775 slight expense of increased disk usage. Additionally files
776 larger than this size are always treated as binary.
778 Default is 512 MiB on all platforms. This should be reasonable
779 for most projects as source code and other text files can still
780 be delta compressed, but larger binary media files won't be.
782 Common unit suffixes of 'k', 'm', or 'g' are supported.
785 Specifies the pathname to the file that contains patterns to
786 describe paths that are not meant to be tracked, in addition
787 to '.gitignore' (per-directory) and '.git/info/exclude'.
788 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
789 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
790 is used instead. See linkgit:gitignore[5].
793 Some commands (e.g. svn and http interfaces) that interactively
794 ask for a password can be told to use an external program given
795 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
796 environment variable. If not set, fall back to the value of the
797 `SSH_ASKPASS` environment variable or, failing that, a simple password
798 prompt. The external program shall be given a suitable prompt as
799 command-line argument and write the password on its STDOUT.
801 core.attributesFile::
802 In addition to '.gitattributes' (per-directory) and
803 '.git/info/attributes', Git looks into this file for attributes
804 (see linkgit:gitattributes[5]). Path expansions are made the same
805 way as for `core.excludesFile`. Its default value is
806 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
807 set or empty, `$HOME/.config/git/attributes` is used instead.
810 By default Git will look for your hooks in the
811 '$GIT_DIR/hooks' directory. Set this to different path,
812 e.g. '/etc/git/hooks', and Git will try to find your hooks in
813 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
814 in '$GIT_DIR/hooks/pre-receive'.
816 The path can be either absolute or relative. A relative path is
817 taken as relative to the directory where the hooks are run (see
818 the "DESCRIPTION" section of linkgit:githooks[5]).
820 This configuration variable is useful in cases where you'd like to
821 centrally configure your Git hooks instead of configuring them on a
822 per-repository basis, or as a more flexible and centralized
823 alternative to having an `init.templateDir` where you've changed
827 Commands such as `commit` and `tag` that let you edit
828 messages by launching an editor use the value of this
829 variable when it is set, and the environment variable
830 `GIT_EDITOR` is not set. See linkgit:git-var[1].
833 Commands such as `commit` and `tag` that let you edit
834 messages consider a line that begins with this character
835 commented, and removes them after the editor returns
838 If set to "auto", `git-commit` would select a character that is not
839 the beginning character of any line in existing commit messages.
841 core.filesRefLockTimeout::
842 The length of time, in milliseconds, to retry when trying to
843 lock an individual reference. Value 0 means not to retry at
844 all; -1 means to try indefinitely. Default is 100 (i.e.,
847 core.packedRefsTimeout::
848 The length of time, in milliseconds, to retry when trying to
849 lock the `packed-refs` file. Value 0 means not to retry at
850 all; -1 means to try indefinitely. Default is 1000 (i.e.,
854 Text viewer for use by Git commands (e.g., 'less'). The value
855 is meant to be interpreted by the shell. The order of preference
856 is the `$GIT_PAGER` environment variable, then `core.pager`
857 configuration, then `$PAGER`, and then the default chosen at
858 compile time (usually 'less').
860 When the `LESS` environment variable is unset, Git sets it to `FRX`
861 (if `LESS` environment variable is set, Git does not change it at
862 all). If you want to selectively override Git's default setting
863 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
864 be passed to the shell by Git, which will translate the final
865 command to `LESS=FRX less -S`. The environment does not set the
866 `S` option but the command line does, instructing less to truncate
867 long lines. Similarly, setting `core.pager` to `less -+F` will
868 deactivate the `F` option specified by the environment from the
869 command-line, deactivating the "quit if one screen" behavior of
870 `less`. One can specifically activate some flags for particular
871 commands: for example, setting `pager.blame` to `less -S` enables
872 line truncation only for `git blame`.
874 Likewise, when the `LV` environment variable is unset, Git sets it
875 to `-c`. You can override this setting by exporting `LV` with
876 another value or setting `core.pager` to `lv +c`.
879 A comma separated list of common whitespace problems to
880 notice. 'git diff' will use `color.diff.whitespace` to
881 highlight them, and 'git apply --whitespace=error' will
882 consider them as errors. You can prefix `-` to disable
883 any of them (e.g. `-trailing-space`):
885 * `blank-at-eol` treats trailing whitespaces at the end of the line
886 as an error (enabled by default).
887 * `space-before-tab` treats a space character that appears immediately
888 before a tab character in the initial indent part of the line as an
889 error (enabled by default).
890 * `indent-with-non-tab` treats a line that is indented with space
891 characters instead of the equivalent tabs as an error (not enabled by
893 * `tab-in-indent` treats a tab character in the initial indent part of
894 the line as an error (not enabled by default).
895 * `blank-at-eof` treats blank lines added at the end of file as an error
896 (enabled by default).
897 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
899 * `cr-at-eol` treats a carriage-return at the end of line as
900 part of the line terminator, i.e. with it, `trailing-space`
901 does not trigger if the character before such a carriage-return
902 is not a whitespace (not enabled by default).
903 * `tabwidth=<n>` tells how many character positions a tab occupies; this
904 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
905 errors. The default tab width is 8. Allowed values are 1 to 63.
907 core.fsyncObjectFiles::
908 This boolean will enable 'fsync()' when writing object files.
910 This is a total waste of time and effort on a filesystem that orders
911 data writes properly, but can be useful for filesystems that do not use
912 journalling (traditional UNIX filesystems) or that only journal metadata
913 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
916 Enable parallel index preload for operations like 'git diff'
918 This can speed up operations like 'git diff' and 'git status' especially
919 on filesystems like NFS that have weak caching semantics and thus
920 relatively high IO latencies. When enabled, Git will do the
921 index comparison to the filesystem data in parallel, allowing
922 overlapping IO's. Defaults to true.
925 You can set this to 'link', in which case a hardlink followed by
926 a delete of the source are used to make sure that object creation
927 will not overwrite existing objects.
929 On some file system/operating system combinations, this is unreliable.
930 Set this config setting to 'rename' there; However, This will remove the
931 check that makes sure that existing object files will not get overwritten.
934 When showing commit messages, also show notes which are stored in
935 the given ref. The ref must be fully qualified. If the given
936 ref does not exist, it is not an error but means that no
937 notes should be printed.
939 This setting defaults to "refs/notes/commits", and it can be overridden by
940 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
943 If true, then git will read the commit-graph file (if it exists)
944 to parse the graph structure of commits. Defaults to false. See
945 linkgit:git-commit-graph[1] for more information.
947 core.useReplaceRefs::
948 If set to `false`, behave as if the `--no-replace-objects`
949 option was given on the command line. See linkgit:git[1] and
950 linkgit:git-replace[1] for more information.
952 core.multiPackIndex::
953 Use the multi-pack-index file to track multiple packfiles using a
954 single index. See link:technical/multi-pack-index.html[the
955 multi-pack-index design document].
957 core.sparseCheckout::
958 Enable "sparse checkout" feature. See section "Sparse checkout" in
959 linkgit:git-read-tree[1] for more information.
962 Set the length object names are abbreviated to. If
963 unspecified or set to "auto", an appropriate value is
964 computed based on the approximate number of packed objects
965 in your repository, which hopefully is enough for
966 abbreviated object names to stay unique for some time.
967 The minimum length is 4.
970 add.ignore-errors (deprecated)::
971 Tells 'git add' to continue adding files when some files cannot be
972 added due to indexing errors. Equivalent to the `--ignore-errors`
973 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
974 as it does not follow the usual naming convention for configuration
978 Command aliases for the linkgit:git[1] command wrapper - e.g.
979 after defining "alias.last = cat-file commit HEAD", the invocation
980 "git last" is equivalent to "git cat-file commit HEAD". To avoid
981 confusion and troubles with script usage, aliases that
982 hide existing Git commands are ignored. Arguments are split by
983 spaces, the usual shell quoting and escaping is supported.
984 A quote pair or a backslash can be used to quote them.
986 If the alias expansion is prefixed with an exclamation point,
987 it will be treated as a shell command. For example, defining
988 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
989 "git new" is equivalent to running the shell command
990 "gitk --all --not ORIG_HEAD". Note that shell commands will be
991 executed from the top-level directory of a repository, which may
992 not necessarily be the current directory.
993 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
994 from the original current directory. See linkgit:git-rev-parse[1].
997 If true, git-am will call git-mailsplit for patches in mbox format
998 with parameter `--keep-cr`. In this case git-mailsplit will
999 not remove `\r` from lines ending with `\r\n`. Can be overridden
1000 by giving `--no-keep-cr` from the command line.
1001 See linkgit:git-am[1], linkgit:git-mailsplit[1].
1004 By default, `git am` will fail if the patch does not apply cleanly. When
1005 set to true, this setting tells `git am` to fall back on 3-way merge if
1006 the patch records the identity of blobs it is supposed to apply to and
1007 we have those blobs available locally (equivalent to giving the `--3way`
1008 option from the command line). Defaults to `false`.
1009 See linkgit:git-am[1].
1011 apply.ignoreWhitespace::
1012 When set to 'change', tells 'git apply' to ignore changes in
1013 whitespace, in the same way as the `--ignore-space-change`
1015 When set to one of: no, none, never, false tells 'git apply' to
1016 respect all whitespace differences.
1017 See linkgit:git-apply[1].
1020 Tells 'git apply' how to handle whitespaces, in the same way
1021 as the `--whitespace` option. See linkgit:git-apply[1].
1023 blame.blankBoundary::
1024 Show blank commit object name for boundary commits in
1025 linkgit:git-blame[1]. This option defaults to false.
1028 This determines the coloring scheme to be applied to blame
1029 output. It can be 'repeatedLines', 'highlightRecent',
1030 or 'none' which is the default.
1033 Specifies the format used to output dates in linkgit:git-blame[1].
1034 If unset the iso format is used. For supported values,
1035 see the discussion of the `--date` option at linkgit:git-log[1].
1038 Show the author email instead of author name in linkgit:git-blame[1].
1039 This option defaults to false.
1042 Do not treat root commits as boundaries in linkgit:git-blame[1].
1043 This option defaults to false.
1045 branch.autoSetupMerge::
1046 Tells 'git branch' and 'git checkout' to set up new branches
1047 so that linkgit:git-pull[1] will appropriately merge from the
1048 starting point branch. Note that even if this option is not set,
1049 this behavior can be chosen per-branch using the `--track`
1050 and `--no-track` options. The valid settings are: `false` -- no
1051 automatic setup is done; `true` -- automatic setup is done when the
1052 starting point is a remote-tracking branch; `always` --
1053 automatic setup is done when the starting point is either a
1054 local branch or remote-tracking
1055 branch. This option defaults to true.
1057 branch.autoSetupRebase::
1058 When a new branch is created with 'git branch' or 'git checkout'
1059 that tracks another branch, this variable tells Git to set
1060 up pull to rebase instead of merge (see "branch.<name>.rebase").
1061 When `never`, rebase is never automatically set to true.
1062 When `local`, rebase is set to true for tracked branches of
1063 other local branches.
1064 When `remote`, rebase is set to true for tracked branches of
1065 remote-tracking branches.
1066 When `always`, rebase will be set to true for all tracking
1068 See "branch.autoSetupMerge" for details on how to set up a
1069 branch to track another branch.
1070 This option defaults to never.
1073 This variable controls the sort ordering of branches when displayed by
1074 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1075 value of this variable will be used as the default.
1076 See linkgit:git-for-each-ref[1] field names for valid values.
1078 branch.<name>.remote::
1079 When on branch <name>, it tells 'git fetch' and 'git push'
1080 which remote to fetch from/push to. The remote to push to
1081 may be overridden with `remote.pushDefault` (for all branches).
1082 The remote to push to, for the current branch, may be further
1083 overridden by `branch.<name>.pushRemote`. If no remote is
1084 configured, or if you are not on any branch, it defaults to
1085 `origin` for fetching and `remote.pushDefault` for pushing.
1086 Additionally, `.` (a period) is the current local repository
1087 (a dot-repository), see `branch.<name>.merge`'s final note below.
1089 branch.<name>.pushRemote::
1090 When on branch <name>, it overrides `branch.<name>.remote` for
1091 pushing. It also overrides `remote.pushDefault` for pushing
1092 from branch <name>. When you pull from one place (e.g. your
1093 upstream) and push to another place (e.g. your own publishing
1094 repository), you would want to set `remote.pushDefault` to
1095 specify the remote to push to for all branches, and use this
1096 option to override it for a specific branch.
1098 branch.<name>.merge::
1099 Defines, together with branch.<name>.remote, the upstream branch
1100 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1101 branch to merge and can also affect 'git push' (see push.default).
1102 When in branch <name>, it tells 'git fetch' the default
1103 refspec to be marked for merging in FETCH_HEAD. The value is
1104 handled like the remote part of a refspec, and must match a
1105 ref which is fetched from the remote given by
1106 "branch.<name>.remote".
1107 The merge information is used by 'git pull' (which at first calls
1108 'git fetch') to lookup the default branch for merging. Without
1109 this option, 'git pull' defaults to merge the first refspec fetched.
1110 Specify multiple values to get an octopus merge.
1111 If you wish to setup 'git pull' so that it merges into <name> from
1112 another branch in the local repository, you can point
1113 branch.<name>.merge to the desired branch, and use the relative path
1114 setting `.` (a period) for branch.<name>.remote.
1116 branch.<name>.mergeOptions::
1117 Sets default options for merging into branch <name>. The syntax and
1118 supported options are the same as those of linkgit:git-merge[1], but
1119 option values containing whitespace characters are currently not
1122 branch.<name>.rebase::
1123 When true, rebase the branch <name> on top of the fetched branch,
1124 instead of merging the default branch from the default remote when
1125 "git pull" is run. See "pull.rebase" for doing this in a non
1126 branch-specific manner.
1128 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1129 so that the local merge commits are included in the rebase (see
1130 linkgit:git-rebase[1] for details).
1132 When preserve, also pass `--preserve-merges` along to 'git rebase'
1133 so that locally committed merge commits will not be flattened
1134 by running 'git pull'.
1136 When the value is `interactive`, the rebase is run in interactive mode.
1138 *NOTE*: this is a possibly dangerous operation; do *not* use
1139 it unless you understand the implications (see linkgit:git-rebase[1]
1142 branch.<name>.description::
1143 Branch description, can be edited with
1144 `git branch --edit-description`. Branch description is
1145 automatically added in the format-patch cover letter or
1146 request-pull summary.
1148 browser.<tool>.cmd::
1149 Specify the command to invoke the specified browser. The
1150 specified command is evaluated in shell with the URLs passed
1151 as arguments. (See linkgit:git-web{litdd}browse[1].)
1153 browser.<tool>.path::
1154 Override the path for the given tool that may be used to
1155 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1156 working repository in gitweb (see linkgit:git-instaweb[1]).
1158 checkout.defaultRemote::
1159 When you run 'git checkout <something>' and only have one
1160 remote, it may implicitly fall back on checking out and
1161 tracking e.g. 'origin/<something>'. This stops working as soon
1162 as you have more than one remote with a '<something>'
1163 reference. This setting allows for setting the name of a
1164 preferred remote that should always win when it comes to
1165 disambiguation. The typical use-case is to set this to
1168 Currently this is used by linkgit:git-checkout[1] when 'git checkout
1169 <something>' will checkout the '<something>' branch on another remote,
1170 and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1171 remote branch. This setting might be used for other checkout-like
1172 commands or functionality in the future.
1174 checkout.optimizeNewBranch::
1175 Optimizes the performance of "git checkout -b <new_branch>" when
1176 using sparse-checkout. When set to true, git will not update the
1177 repo based on the current sparse-checkout settings. This means it
1178 will not update the skip-worktree bit in the index nor add/remove
1179 files in the working directory to reflect the current sparse checkout
1180 settings nor will it show the local changes.
1182 clean.requireForce::
1183 A boolean to make git-clean do nothing unless given -f,
1184 -i or -n. Defaults to true.
1187 A boolean to enable/disable color in hints (e.g. when a push
1188 failed, see `advice.*` for a list). May be set to `always`,
1189 `false` (or `never`) or `auto` (or `true`), in which case colors
1190 are used only when the error output goes to a terminal. If
1191 unset, then the value of `color.ui` is used (`auto` by default).
1194 Use customized color for hints.
1196 color.blame.highlightRecent::
1197 This can be used to color the metadata of a blame line depending
1200 This setting should be set to a comma-separated list of color and date settings,
1201 starting and ending with a color, the dates should be set from oldest to newest.
1202 The metadata will be colored given the colors if the the line was introduced
1203 before the given timestamp, overwriting older timestamped colors.
1205 Instead of an absolute timestamp relative timestamps work as well, e.g.
1206 2.weeks.ago is valid to address anything older than 2 weeks.
1208 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1209 everything older than one year blue, recent changes between one month and
1210 one year old are kept white, and lines introduced within the last month are
1213 color.blame.repeatedLines::
1214 Use the customized color for the part of git-blame output that
1215 is repeated meta information per line (such as commit id,
1216 author name, date and timezone). Defaults to cyan.
1219 A boolean to enable/disable color in the output of
1220 linkgit:git-branch[1]. May be set to `always`,
1221 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1222 only when the output is to a terminal. If unset, then the
1223 value of `color.ui` is used (`auto` by default).
1225 color.branch.<slot>::
1226 Use customized color for branch coloration. `<slot>` is one of
1227 `current` (the current branch), `local` (a local branch),
1228 `remote` (a remote-tracking branch in refs/remotes/),
1229 `upstream` (upstream tracking branch), `plain` (other
1233 Whether to use ANSI escape sequences to add color to patches.
1234 If this is set to `always`, linkgit:git-diff[1],
1235 linkgit:git-log[1], and linkgit:git-show[1] will use color
1236 for all patches. If it is set to `true` or `auto`, those
1237 commands will only use color when output is to the terminal.
1238 If unset, then the value of `color.ui` is used (`auto` by
1241 This does not affect linkgit:git-format-patch[1] or the
1242 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1243 command line with the `--color[=<when>]` option.
1246 Use customized color for diff colorization. `<slot>` specifies
1247 which part of the patch to use the specified color, and is one
1248 of `context` (context text - `plain` is a historical synonym),
1249 `meta` (metainformation), `frag`
1250 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1251 `new` (added lines), `commit` (commit headers), `whitespace`
1252 (highlighting whitespace errors), `oldMoved` (deleted lines),
1253 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1254 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1255 `newMovedAlternativeDimmed` (See the '<mode>'
1256 setting of '--color-moved' in linkgit:git-diff[1] for details),
1257 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1258 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1260 color.decorate.<slot>::
1261 Use customized color for 'git log --decorate' output. `<slot>` is one
1262 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1263 branches, remote-tracking branches, tags, stash and HEAD, respectively
1264 and `grafted` for grafted commits.
1267 When set to `always`, always highlight matches. When `false` (or
1268 `never`), never. When set to `true` or `auto`, use color only
1269 when the output is written to the terminal. If unset, then the
1270 value of `color.ui` is used (`auto` by default).
1273 Use customized color for grep colorization. `<slot>` specifies which
1274 part of the line to use the specified color, and is one of
1278 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1280 filename prefix (when not using `-h`)
1282 function name lines (when using `-p`)
1284 line number prefix (when using `-n`)
1286 column number prefix (when using `--column`)
1288 matching text (same as setting `matchContext` and `matchSelected`)
1290 matching text in context lines
1292 matching text in selected lines
1294 non-matching text in selected lines
1296 separators between fields on a line (`:`, `-`, and `=`)
1297 and between hunks (`--`)
1301 When set to `always`, always use colors for interactive prompts
1302 and displays (such as those used by "git-add --interactive" and
1303 "git-clean --interactive"). When false (or `never`), never.
1304 When set to `true` or `auto`, use colors only when the output is
1305 to the terminal. If unset, then the value of `color.ui` is
1306 used (`auto` by default).
1308 color.interactive.<slot>::
1309 Use customized color for 'git add --interactive' and 'git clean
1310 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1311 or `error`, for four distinct types of normal output from
1312 interactive commands.
1315 A boolean to enable/disable colored output when the pager is in
1316 use (default is true).
1319 A boolean to enable/disable color in push errors. May be set to
1320 `always`, `false` (or `never`) or `auto` (or `true`), in which
1321 case colors are used only when the error output goes to a terminal.
1322 If unset, then the value of `color.ui` is used (`auto` by default).
1325 Use customized color for push errors.
1328 If set, keywords at the start of the line are highlighted. The
1329 keywords are "error", "warning", "hint" and "success", and are
1330 matched case-insensitively. May be set to `always`, `false` (or
1331 `never`) or `auto` (or `true`). If unset, then the value of
1332 `color.ui` is used (`auto` by default).
1334 color.remote.<slot>::
1335 Use customized color for each remote keyword. `<slot>` may be
1336 `hint`, `warning`, `success` or `error` which match the
1337 corresponding keyword.
1340 A boolean to enable/disable color in the output of
1341 linkgit:git-show-branch[1]. May be set to `always`,
1342 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1343 only when the output is to a terminal. If unset, then the
1344 value of `color.ui` is used (`auto` by default).
1347 A boolean to enable/disable color in the output of
1348 linkgit:git-status[1]. May be set to `always`,
1349 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1350 only when the output is to a terminal. If unset, then the
1351 value of `color.ui` is used (`auto` by default).
1353 color.status.<slot>::
1354 Use customized color for status colorization. `<slot>` is
1355 one of `header` (the header text of the status message),
1356 `added` or `updated` (files which are added but not committed),
1357 `changed` (files which are changed but not added in the index),
1358 `untracked` (files which are not tracked by Git),
1359 `branch` (the current branch),
1360 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1362 `localBranch` or `remoteBranch` (the local and remote branch names,
1363 respectively, when branch and tracking information is displayed in the
1364 status short-format), or
1365 `unmerged` (files which have unmerged changes).
1368 A boolean to enable/disable color when pushes are rejected. May be
1369 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1370 case colors are used only when the error output goes to a terminal.
1371 If unset, then the value of `color.ui` is used (`auto` by default).
1373 color.transport.rejected::
1374 Use customized color when a push was rejected.
1377 This variable determines the default value for variables such
1378 as `color.diff` and `color.grep` that control the use of color
1379 per command family. Its scope will expand as more commands learn
1380 configuration to set a default for the `--color` option. Set it
1381 to `false` or `never` if you prefer Git commands not to use
1382 color unless enabled explicitly with some other configuration
1383 or the `--color` option. Set it to `always` if you want all
1384 output not intended for machine consumption to use color, to
1385 `true` or `auto` (this is the default since Git 1.8.4) if you
1386 want such output to use color when written to the terminal.
1389 Specify whether supported commands should output in columns.
1390 This variable consists of a list of tokens separated by spaces
1393 These options control when the feature should be enabled
1394 (defaults to 'never'):
1398 always show in columns
1400 never show in columns
1402 show in columns if the output is to the terminal
1405 These options control layout (defaults to 'column'). Setting any
1406 of these implies 'always' if none of 'always', 'never', or 'auto' are
1411 fill columns before rows
1413 fill rows before columns
1418 Finally, these options can be combined with a layout option (defaults
1423 make unequal size columns to utilize more space
1425 make equal size columns
1429 Specify whether to output branch listing in `git branch` in columns.
1430 See `column.ui` for details.
1433 Specify the layout when list items in `git clean -i`, which always
1434 shows files and directories in columns. See `column.ui` for details.
1437 Specify whether to output untracked files in `git status` in columns.
1438 See `column.ui` for details.
1441 Specify whether to output tag listing in `git tag` in columns.
1442 See `column.ui` for details.
1445 This setting overrides the default of the `--cleanup` option in
1446 `git commit`. See linkgit:git-commit[1] for details. Changing the
1447 default can be useful when you always want to keep lines that begin
1448 with comment character `#` in your log message, in which case you
1449 would do `git config commit.cleanup whitespace` (note that you will
1450 have to remove the help lines that begin with `#` in the commit log
1451 template yourself, if you do this).
1455 A boolean to specify whether all commits should be GPG signed.
1456 Use of this option when doing operations such as rebase can
1457 result in a large number of commits being signed. It may be
1458 convenient to use an agent to avoid typing your GPG passphrase
1462 A boolean to enable/disable inclusion of status information in the
1463 commit message template when using an editor to prepare the commit
1464 message. Defaults to true.
1467 Specify the pathname of a file to use as the template for
1468 new commit messages.
1471 A boolean or int to specify the level of verbose with `git commit`.
1472 See linkgit:git-commit[1].
1475 Specify an external helper to be called when a username or
1476 password credential is needed; the helper may consult external
1477 storage to avoid prompting the user for the credentials. Note
1478 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1481 credential.useHttpPath::
1482 When acquiring credentials, consider the "path" component of an http
1483 or https URL to be important. Defaults to false. See
1484 linkgit:gitcredentials[7] for more information.
1486 credential.username::
1487 If no username is set for a network authentication, use this username
1488 by default. See credential.<context>.* below, and
1489 linkgit:gitcredentials[7].
1491 credential.<url>.*::
1492 Any of the credential.* options above can be applied selectively to
1493 some credentials. For example "credential.https://example.com.username"
1494 would set the default username only for https connections to
1495 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1498 credentialCache.ignoreSIGHUP::
1499 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1501 completion.commands::
1502 This is only used by git-completion.bash to add or remove
1503 commands from the list of completed commands. Normally only
1504 porcelain commands and a few select others are completed. You
1505 can add more commands, separated by space, in this
1506 variable. Prefixing the command with '-' will remove it from
1509 include::diff-config.txt[]
1511 difftool.<tool>.path::
1512 Override the path for the given tool. This is useful in case
1513 your tool is not in the PATH.
1515 difftool.<tool>.cmd::
1516 Specify the command to invoke the specified diff tool.
1517 The specified command is evaluated in shell with the following
1518 variables available: 'LOCAL' is set to the name of the temporary
1519 file containing the contents of the diff pre-image and 'REMOTE'
1520 is set to the name of the temporary file containing the contents
1521 of the diff post-image.
1524 Prompt before each invocation of the diff tool.
1526 fastimport.unpackLimit::
1527 If the number of objects imported by linkgit:git-fast-import[1]
1528 is below this limit, then the objects will be unpacked into
1529 loose object files. However if the number of imported objects
1530 equals or exceeds this limit then the pack will be stored as a
1531 pack. Storing the pack from a fast-import can make the import
1532 operation complete faster, especially on slow filesystems. If
1533 not set, the value of `transfer.unpackLimit` is used instead.
1535 include::fetch-config.txt[]
1537 include::format-config.txt[]
1539 filter.<driver>.clean::
1540 The command which is used to convert the content of a worktree
1541 file to a blob upon checkin. See linkgit:gitattributes[5] for
1544 filter.<driver>.smudge::
1545 The command which is used to convert the content of a blob
1546 object to a worktree file upon checkout. See
1547 linkgit:gitattributes[5] for details.
1550 During fsck git may find issues with legacy data which
1551 wouldn't be generated by current versions of git, and which
1552 wouldn't be sent over the wire if `transfer.fsckObjects` was
1553 set. This feature is intended to support working with legacy
1554 repositories containing such data.
1556 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1557 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1558 to clone or fetch it set `fetch.fsck.<msg-id>`.
1560 The rest of the documentation discusses `fsck.*` for brevity, but the
1561 same applies for the corresponding `receive.fsck.*` and
1562 `fetch.<msg-id>.*`. variables.
1564 Unlike variables like `color.ui` and `core.editor` the
1565 `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1566 fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1567 uniformly configure the same fsck settings in different circumstances
1568 all three of them they must all set to the same values.
1570 When `fsck.<msg-id>` is set, errors can be switched to warnings and
1571 vice versa by configuring the `fsck.<msg-id>` setting where the
1572 `<msg-id>` is the fsck message ID and the value is one of `error`,
1573 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
1574 with the message ID, e.g. "missingEmail: invalid author/committer line
1575 - missing email" means that setting `fsck.missingEmail = ignore` will
1578 In general, it is better to enumerate existing objects with problems
1579 with `fsck.skipList`, instead of listing the kind of breakages these
1580 problematic objects share to be ignored, as doing the latter will
1581 allow new instances of the same breakages go unnoticed.
1583 Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1584 doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1585 will only cause git to warn.
1588 The path to a list of object names (i.e. one unabbreviated SHA-1 per
1589 line) that are known to be broken in a non-fatal way and should
1590 be ignored. On versions of Git 2.20 and later comments ('#'), empty
1591 lines, and any leading and trailing whitespace is ignored. Everything
1592 but a SHA-1 per line will error out on older versions.
1594 This feature is useful when an established project should be accepted
1595 despite early commits containing errors that can be safely ignored
1596 such as invalid committer email addresses. Note: corrupt objects
1597 cannot be skipped with this setting.
1599 Like `fsck.<msg-id>` this variable has corresponding
1600 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1602 Unlike variables like `color.ui` and `core.editor` the
1603 `receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1604 fall back on the `fsck.skipList` configuration if they aren't set. To
1605 uniformly configure the same fsck settings in different circumstances
1606 all three of them they must all set to the same values.
1608 Older versions of Git (before 2.20) documented that the object names
1609 list should be sorted. This was never a requirement, the object names
1610 could appear in any order, but when reading the list we tracked whether
1611 the list was sorted for the purposes of an internal binary search
1612 implementation, which could save itself some work with an already sorted
1613 list. Unless you had a humongous list there was no reason to go out of
1614 your way to pre-sort the list. After Git version 2.20 a hash implementation
1615 is used instead, so there's now no reason to pre-sort the list.
1617 gc.aggressiveDepth::
1618 The depth parameter used in the delta compression
1619 algorithm used by 'git gc --aggressive'. This defaults
1622 gc.aggressiveWindow::
1623 The window size parameter used in the delta compression
1624 algorithm used by 'git gc --aggressive'. This defaults
1628 When there are approximately more than this many loose
1629 objects in the repository, `git gc --auto` will pack them.
1630 Some Porcelain commands use this command to perform a
1631 light-weight garbage collection from time to time. The
1632 default value is 6700. Setting this to 0 disables it.
1635 When there are more than this many packs that are not
1636 marked with `*.keep` file in the repository, `git gc
1637 --auto` consolidates them into one larger pack. The
1638 default value is 50. Setting this to 0 disables it.
1641 Make `git gc --auto` return immediately and run in background
1642 if the system supports it. Default is true.
1644 gc.bigPackThreshold::
1645 If non-zero, all packs larger than this limit are kept when
1646 `git gc` is run. This is very similar to `--keep-base-pack`
1647 except that all packs that meet the threshold are kept, not
1648 just the base pack. Defaults to zero. Common unit suffixes of
1649 'k', 'm', or 'g' are supported.
1651 Note that if the number of kept packs is more than gc.autoPackLimit,
1652 this configuration variable is ignored, all packs except the base pack
1653 will be repacked. After this the number of packs should go below
1654 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1656 gc.writeCommitGraph::
1657 If true, then gc will rewrite the commit-graph file when
1658 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1659 '--auto' the commit-graph will be updated if housekeeping is
1660 required. Default is false. See linkgit:git-commit-graph[1]
1664 If the file gc.log exists, then `git gc --auto` will print
1665 its content and exit with status zero instead of running
1666 unless that file is more than 'gc.logExpiry' old. Default is
1667 "1.day". See `gc.pruneExpire` for more ways to specify its
1671 Running `git pack-refs` in a repository renders it
1672 unclonable by Git versions prior to 1.5.1.2 over dumb
1673 transports such as HTTP. This variable determines whether
1674 'git gc' runs `git pack-refs`. This can be set to `notbare`
1675 to enable it within all non-bare repos or it can be set to a
1676 boolean value. The default is `true`.
1679 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1680 Override the grace period with this config variable. The value
1681 "now" may be used to disable this grace period and always prune
1682 unreachable objects immediately, or "never" may be used to
1683 suppress pruning. This feature helps prevent corruption when
1684 'git gc' runs concurrently with another process writing to the
1685 repository; see the "NOTES" section of linkgit:git-gc[1].
1687 gc.worktreePruneExpire::
1688 When 'git gc' is run, it calls
1689 'git worktree prune --expire 3.months.ago'.
1690 This config variable can be used to set a different grace
1691 period. The value "now" may be used to disable the grace
1692 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1693 may be used to suppress pruning.
1696 gc.<pattern>.reflogExpire::
1697 'git reflog expire' removes reflog entries older than
1698 this time; defaults to 90 days. The value "now" expires all
1699 entries immediately, and "never" suppresses expiration
1700 altogether. With "<pattern>" (e.g.
1701 "refs/stash") in the middle the setting applies only to
1702 the refs that match the <pattern>.
1704 gc.reflogExpireUnreachable::
1705 gc.<pattern>.reflogExpireUnreachable::
1706 'git reflog expire' removes reflog entries older than
1707 this time and are not reachable from the current tip;
1708 defaults to 30 days. The value "now" expires all entries
1709 immediately, and "never" suppresses expiration altogether.
1710 With "<pattern>" (e.g. "refs/stash")
1711 in the middle, the setting applies only to the refs that
1712 match the <pattern>.
1715 Records of conflicted merge you resolved earlier are
1716 kept for this many days when 'git rerere gc' is run.
1717 You can also use more human-readable "1.month.ago", etc.
1718 The default is 60 days. See linkgit:git-rerere[1].
1720 gc.rerereUnresolved::
1721 Records of conflicted merge you have not resolved are
1722 kept for this many days when 'git rerere gc' is run.
1723 You can also use more human-readable "1.month.ago", etc.
1724 The default is 15 days. See linkgit:git-rerere[1].
1726 include::gitcvs-config.txt[]
1729 gitweb.description::
1732 See linkgit:gitweb[1] for description.
1740 gitweb.remote_heads::
1743 See linkgit:gitweb.conf[5] for description.
1746 If set to true, enable `-n` option by default.
1749 If set to true, enable the `--column` option by default.
1752 Set the default matching behavior. Using a value of 'basic', 'extended',
1753 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1754 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1755 value 'default' will return to the default matching behavior.
1757 grep.extendedRegexp::
1758 If set to true, enable `--extended-regexp` option by default. This
1759 option is ignored when the `grep.patternType` option is set to a value
1760 other than 'default'.
1763 Number of grep worker threads to use.
1764 See `grep.threads` in linkgit:git-grep[1] for more information.
1766 grep.fallbackToNoIndex::
1767 If set to true, fall back to git grep --no-index if git grep
1768 is executed outside of a git repository. Defaults to false.
1771 Use this custom program instead of "`gpg`" found on `$PATH` when
1772 making or verifying a PGP signature. The program must support the
1773 same command-line interface as GPG, namely, to verify a detached
1774 signature, "`gpg --verify $file - <$signature`" is run, and the
1775 program is expected to signal a good signature by exiting with
1776 code 0, and to generate an ASCII-armored detached signature, the
1777 standard input of "`gpg -bsau $key`" is fed with the contents to be
1778 signed, and the program is expected to send the result to its
1782 Specifies which key format to use when signing with `--gpg-sign`.
1783 Default is "openpgp" and another possible value is "x509".
1785 gpg.<format>.program::
1786 Use this to customize the program used for the signing format you
1787 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1788 be used as a legacy synonym for `gpg.openpgp.program`. The default
1789 value for `gpg.x509.program` is "gpgsm".
1791 include::gui-config.txt[]
1793 guitool.<name>.cmd::
1794 Specifies the shell command line to execute when the corresponding item
1795 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1796 mandatory for every tool. The command is executed from the root of
1797 the working directory, and in the environment it receives the name of
1798 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1799 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1800 the head is detached, 'CUR_BRANCH' is empty).
1802 guitool.<name>.needsFile::
1803 Run the tool only if a diff is selected in the GUI. It guarantees
1804 that 'FILENAME' is not empty.
1806 guitool.<name>.noConsole::
1807 Run the command silently, without creating a window to display its
1810 guitool.<name>.noRescan::
1811 Don't rescan the working directory for changes after the tool
1814 guitool.<name>.confirm::
1815 Show a confirmation dialog before actually running the tool.
1817 guitool.<name>.argPrompt::
1818 Request a string argument from the user, and pass it to the tool
1819 through the `ARGS` environment variable. Since requesting an
1820 argument implies confirmation, the 'confirm' option has no effect
1821 if this is enabled. If the option is set to 'true', 'yes', or '1',
1822 the dialog uses a built-in generic prompt; otherwise the exact
1823 value of the variable is used.
1825 guitool.<name>.revPrompt::
1826 Request a single valid revision from the user, and set the
1827 `REVISION` environment variable. In other aspects this option
1828 is similar to 'argPrompt', and can be used together with it.
1830 guitool.<name>.revUnmerged::
1831 Show only unmerged branches in the 'revPrompt' subdialog.
1832 This is useful for tools similar to merge or rebase, but not
1833 for things like checkout or reset.
1835 guitool.<name>.title::
1836 Specifies the title to use for the prompt dialog. The default
1839 guitool.<name>.prompt::
1840 Specifies the general prompt string to display at the top of
1841 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1842 The default value includes the actual command.
1845 Specify the browser that will be used to display help in the
1846 'web' format. See linkgit:git-help[1].
1849 Override the default help format used by linkgit:git-help[1].
1850 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1851 the default. 'web' and 'html' are the same.
1854 Automatically correct and execute mistyped commands after
1855 waiting for the given number of deciseconds (0.1 sec). If more
1856 than one command can be deduced from the entered text, nothing
1857 will be executed. If the value of this option is negative,
1858 the corrected command will be executed immediately. If the
1859 value is 0 - the command will be just shown but not executed.
1860 This is the default.
1863 Specify the path where the HTML documentation resides. File system paths
1864 and URLs are supported. HTML pages will be prefixed with this path when
1865 help is displayed in the 'web' format. This defaults to the documentation
1866 path of your Git installation.
1869 Override the HTTP proxy, normally configured using the 'http_proxy',
1870 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1871 addition to the syntax understood by curl, it is possible to specify a
1872 proxy string with a user name but no password, in which case git will
1873 attempt to acquire one in the same way it does for other credentials. See
1874 linkgit:gitcredentials[7] for more information. The syntax thus is
1875 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1876 on a per-remote basis; see remote.<name>.proxy
1878 http.proxyAuthMethod::
1879 Set the method with which to authenticate against the HTTP proxy. This
1880 only takes effect if the configured proxy string contains a user name part
1881 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1882 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1883 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1884 variable. Possible values are:
1887 * `anyauth` - Automatically pick a suitable authentication method. It is
1888 assumed that the proxy answers an unauthenticated request with a 407
1889 status code and one or more Proxy-authenticate headers with supported
1890 authentication methods. This is the default.
1891 * `basic` - HTTP Basic authentication
1892 * `digest` - HTTP Digest authentication; this prevents the password from being
1893 transmitted to the proxy in clear text
1894 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1896 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1900 Attempt authentication without seeking a username or password. This
1901 can be used to attempt GSS-Negotiate authentication without specifying
1902 a username in the URL, as libcurl normally requires a username for
1906 Control GSSAPI credential delegation. The delegation is disabled
1907 by default in libcurl since version 7.21.7. Set parameter to tell
1908 the server what it is allowed to delegate when it comes to user
1909 credentials. Used with GSS/kerberos. Possible values are:
1912 * `none` - Don't allow any delegation.
1913 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1914 Kerberos service ticket, which is a matter of realm policy.
1915 * `always` - Unconditionally allow the server to delegate.
1920 Pass an additional HTTP header when communicating with a server. If
1921 more than one such entry exists, all of them are added as extra
1922 headers. To allow overriding the settings inherited from the system
1923 config, an empty value will reset the extra headers to the empty list.
1926 The pathname of a file containing previously stored cookie lines,
1927 which should be used
1928 in the Git http session, if they match the server. The file format
1929 of the file to read cookies from should be plain HTTP headers or
1930 the Netscape/Mozilla cookie file format (see `curl(1)`).
1931 NOTE that the file specified with http.cookieFile is used only as
1932 input unless http.saveCookies is set.
1935 If set, store cookies received during requests to the file specified by
1936 http.cookieFile. Has no effect if http.cookieFile is unset.
1939 The SSL version to use when negotiating an SSL connection, if you
1940 want to force the default. The available and default version
1941 depend on whether libcurl was built against NSS or OpenSSL and the
1942 particular configuration of the crypto library in use. Internally
1943 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1944 documentation for more details on the format of this option and
1945 for the ssl version supported. Actually the possible values of
1957 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1958 To force git to use libcurl's default ssl version and ignore any
1959 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1962 http.sslCipherList::
1963 A list of SSL ciphers to use when negotiating an SSL connection.
1964 The available ciphers depend on whether libcurl was built against
1965 NSS or OpenSSL and the particular configuration of the crypto
1966 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1967 option; see the libcurl documentation for more details on the format
1970 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1971 To force git to use libcurl's default cipher list and ignore any
1972 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1976 Whether to verify the SSL certificate when fetching or pushing
1977 over HTTPS. Defaults to true. Can be overridden by the
1978 `GIT_SSL_NO_VERIFY` environment variable.
1981 File containing the SSL certificate when fetching or pushing
1982 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1986 File containing the SSL private key when fetching or pushing
1987 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1990 http.sslCertPasswordProtected::
1991 Enable Git's password prompt for the SSL certificate. Otherwise
1992 OpenSSL will prompt the user, possibly many times, if the
1993 certificate or private key is encrypted. Can be overridden by the
1994 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1997 File containing the certificates to verify the peer with when
1998 fetching or pushing over HTTPS. Can be overridden by the
1999 `GIT_SSL_CAINFO` environment variable.
2002 Path containing files with the CA certificates to verify the peer
2003 with when fetching or pushing over HTTPS. Can be overridden
2004 by the `GIT_SSL_CAPATH` environment variable.
2007 Name of the SSL backend to use (e.g. "openssl" or "schannel").
2008 This option is ignored if cURL lacks support for choosing the SSL
2011 http.schannelCheckRevoke::
2012 Used to enforce or disable certificate revocation checks in cURL
2013 when http.sslBackend is set to "schannel". Defaults to `true` if
2014 unset. Only necessary to disable this if Git consistently errors
2015 and the message is about checking the revocation status of a
2016 certificate. This option is ignored if cURL lacks support for
2017 setting the relevant SSL option at runtime.
2019 http.schannelUseSSLCAInfo::
2020 As of cURL v7.60.0, the Secure Channel backend can use the
2021 certificate bundle provided via `http.sslCAInfo`, but that would
2022 override the Windows Certificate Store. Since this is not desirable
2023 by default, Git will tell cURL not to use that bundle by default
2024 when the `schannel` backend was configured via `http.sslBackend`,
2025 unless `http.schannelUseSSLCAInfo` overrides this behavior.
2028 Public key of the https service. It may either be the filename of
2029 a PEM or DER encoded public key file or a string starting with
2030 'sha256//' followed by the base64 encoded sha256 hash of the
2031 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2032 exit with an error if this option is set but not supported by
2036 Attempt to use AUTH SSL/TLS and encrypted data transfers
2037 when connecting via regular FTP protocol. This might be needed
2038 if the FTP server requires it for security reasons or you wish
2039 to connect securely whenever remote FTP server supports it.
2040 Default is false since it might trigger certificate verification
2041 errors on misconfigured servers.
2044 How many HTTP requests to launch in parallel. Can be overridden
2045 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2048 The number of curl sessions (counted across slots) to be kept across
2049 requests. They will not be ended with curl_easy_cleanup() until
2050 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2051 value will be capped at 1. Defaults to 1.
2054 Maximum size in bytes of the buffer used by smart HTTP
2055 transports when POSTing data to the remote system.
2056 For requests larger than this buffer size, HTTP/1.1 and
2057 Transfer-Encoding: chunked is used to avoid creating a
2058 massive pack file locally. Default is 1 MiB, which is
2059 sufficient for most requests.
2061 http.lowSpeedLimit, http.lowSpeedTime::
2062 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2063 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2064 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2065 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2068 A boolean which disables using of EPSV ftp command by curl.
2069 This can helpful with some "poor" ftp servers which don't
2070 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2071 environment variable. Default is false (curl will use EPSV).
2074 The HTTP USER_AGENT string presented to an HTTP server. The default
2075 value represents the version of the client Git such as git/1.7.1.
2076 This option allows you to override this value to a more common value
2077 such as Mozilla/4.0. This may be necessary, for instance, if
2078 connecting through a firewall that restricts HTTP connections to a set
2079 of common USER_AGENT strings (but not including those like git/1.7.1).
2080 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2082 http.followRedirects::
2083 Whether git should follow HTTP redirects. If set to `true`, git
2084 will transparently follow any redirect issued by a server it
2085 encounters. If set to `false`, git will treat all redirects as
2086 errors. If set to `initial`, git will follow redirects only for
2087 the initial request to a remote, but not for subsequent
2088 follow-up HTTP requests. Since git uses the redirected URL as
2089 the base for the follow-up requests, this is generally
2090 sufficient. The default is `initial`.
2093 Any of the http.* options above can be applied selectively to some URLs.
2094 For a config key to match a URL, each element of the config key is
2095 compared to that of the URL, in the following order:
2098 . Scheme (e.g., `https` in `https://example.com/`). This field
2099 must match exactly between the config key and the URL.
2101 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2102 This field must match between the config key and the URL. It is
2103 possible to specify a `*` as part of the host name to match all subdomains
2104 at this level. `https://*.example.com/` for example would match
2105 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2107 . Port number (e.g., `8080` in `http://example.com:8080/`).
2108 This field must match exactly between the config key and the URL.
2109 Omitted port numbers are automatically converted to the correct
2110 default for the scheme before matching.
2112 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2113 path field of the config key must match the path field of the URL
2114 either exactly or as a prefix of slash-delimited path elements. This means
2115 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2116 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2117 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2118 key with just path `foo/`).
2120 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2121 the config key has a user name it must match the user name in the
2122 URL exactly. If the config key does not have a user name, that
2123 config key will match a URL with any user name (including none),
2124 but at a lower precedence than a config key with a user name.
2127 The list above is ordered by decreasing precedence; a URL that matches
2128 a config key's path is preferred to one that matches its user name. For example,
2129 if the URL is `https://user@example.com/foo/bar` a config key match of
2130 `https://example.com/foo` will be preferred over a config key match of
2131 `https://user@example.com`.
2133 All URLs are normalized before attempting any matching (the password part,
2134 if embedded in the URL, is always ignored for matching purposes) so that
2135 equivalent URLs that are simply spelled differently will match properly.
2136 Environment variable settings always override any matches. The URLs that are
2137 matched against are those given directly to Git commands. This means any URLs
2138 visited as a result of a redirection do not participate in matching.
2141 By default, Git determines the command line arguments to use
2142 based on the basename of the configured SSH command (configured
2143 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2144 the config setting `core.sshCommand`). If the basename is
2145 unrecognized, Git will attempt to detect support of OpenSSH
2146 options by first invoking the configured SSH command with the
2147 `-G` (print configuration) option and will subsequently use
2148 OpenSSH options (if that is successful) or no options besides
2149 the host and remote command (if it fails).
2151 The config variable `ssh.variant` can be set to override this detection.
2152 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2153 `tortoiseplink`, `simple` (no options except the host and remote command).
2154 The default auto-detection can be explicitly requested using the value
2155 `auto`. Any other value is treated as `ssh`. This setting can also be
2156 overridden via the environment variable `GIT_SSH_VARIANT`.
2158 The current command-line parameters used for each variant are as
2163 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2165 * `simple` - [username@]host command
2167 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2169 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2173 Except for the `simple` variant, command-line parameters are likely to
2174 change as git gains new features.
2176 i18n.commitEncoding::
2177 Character encoding the commit messages are stored in; Git itself
2178 does not care per se, but this information is necessary e.g. when
2179 importing commits from emails or in the gitk graphical history
2180 browser (and possibly at other places in the future or in other
2181 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2183 i18n.logOutputEncoding::
2184 Character encoding the commit messages are converted to when
2185 running 'git log' and friends.
2188 The configuration variables in the 'imap' section are described
2189 in linkgit:git-imap-send[1].
2192 Specifies the number of threads to spawn when loading the index.
2193 This is meant to reduce index load time on multiprocessor machines.
2194 Specifying 0 or 'true' will cause Git to auto-detect the number of
2195 CPU's and set the number of threads accordingly. Specifying 1 or
2196 'false' will disable multithreading. Defaults to 'true'.
2199 Specify the version with which new index files should be
2200 initialized. This does not affect existing repositories.
2203 Specify the directory from which templates will be copied.
2204 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2207 Specify the program that will be used to browse your working
2208 repository in gitweb. See linkgit:git-instaweb[1].
2211 The HTTP daemon command-line to start gitweb on your working
2212 repository. See linkgit:git-instaweb[1].
2215 If true the web server started by linkgit:git-instaweb[1] will
2216 be bound to the local IP (127.0.0.1).
2218 instaweb.modulePath::
2219 The default module path for linkgit:git-instaweb[1] to use
2220 instead of /usr/lib/apache2/modules. Only used if httpd
2224 The port number to bind the gitweb httpd to. See
2225 linkgit:git-instaweb[1].
2227 interactive.singleKey::
2228 In interactive commands, allow the user to provide one-letter
2229 input with a single key (i.e., without hitting enter).
2230 Currently this is used by the `--patch` mode of
2231 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2232 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2233 setting is silently ignored if portable keystroke input
2234 is not available; requires the Perl module Term::ReadKey.
2236 interactive.diffFilter::
2237 When an interactive command (such as `git add --patch`) shows
2238 a colorized diff, git will pipe the diff through the shell
2239 command defined by this configuration variable. The command may
2240 mark up the diff further for human consumption, provided that it
2241 retains a one-to-one correspondence with the lines in the
2242 original diff. Defaults to disabled (no filtering).
2245 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2246 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2247 override this option with `--no-abbrev-commit`.
2250 Set the default date-time mode for the 'log' command.
2251 Setting a value for log.date is similar to using 'git log''s
2252 `--date` option. See linkgit:git-log[1] for details.
2255 Print out the ref names of any commits that are shown by the log
2256 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2257 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2258 specified, the full ref name (including prefix) will be printed.
2259 If 'auto' is specified, then if the output is going to a terminal,
2260 the ref names are shown as if 'short' were given, otherwise no ref
2261 names are shown. This is the same as the `--decorate` option
2265 If `true`, `git log` will act as if the `--follow` option was used when
2266 a single <path> is given. This has the same limitations as `--follow`,
2267 i.e. it cannot be used to follow multiple files and does not work well
2268 on non-linear history.
2271 A list of colors, separated by commas, that can be used to draw
2272 history lines in `git log --graph`.
2275 If true, the initial commit will be shown as a big creation event.
2276 This is equivalent to a diff against an empty tree.
2277 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2278 normally hide the root commit will now show it. True by default.
2281 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2282 linkgit:git-whatchanged[1] assume `--show-signature`.
2285 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2286 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2289 If true, makes linkgit:git-mailinfo[1] (and therefore
2290 linkgit:git-am[1]) act by default as if the --scissors option
2291 was provided on the command-line. When active, this features
2292 removes everything from the message body before a scissors
2293 line (i.e. consisting mainly of ">8", "8<" and "-").
2296 The location of an augmenting mailmap file. The default
2297 mailmap, located in the root of the repository, is loaded
2298 first, then the mailmap file pointed to by this variable.
2299 The location of the mailmap file may be in a repository
2300 subdirectory, or somewhere outside of the repository itself.
2301 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2304 Like `mailmap.file`, but consider the value as a reference to a
2305 blob in the repository. If both `mailmap.file` and
2306 `mailmap.blob` are given, both are parsed, with entries from
2307 `mailmap.file` taking precedence. In a bare repository, this
2308 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2312 Specify the programs that may be used to display help in the
2313 'man' format. See linkgit:git-help[1].
2316 Specify the command to invoke the specified man viewer. The
2317 specified command is evaluated in shell with the man page
2318 passed as argument. (See linkgit:git-help[1].)
2321 Override the path for the given tool that may be used to
2322 display help in the 'man' format. See linkgit:git-help[1].
2324 include::merge-config.txt[]
2326 mergetool.<tool>.path::
2327 Override the path for the given tool. This is useful in case
2328 your tool is not in the PATH.
2330 mergetool.<tool>.cmd::
2331 Specify the command to invoke the specified merge tool. The
2332 specified command is evaluated in shell with the following
2333 variables available: 'BASE' is the name of a temporary file
2334 containing the common base of the files to be merged, if available;
2335 'LOCAL' is the name of a temporary file containing the contents of
2336 the file on the current branch; 'REMOTE' is the name of a temporary
2337 file containing the contents of the file from the branch being
2338 merged; 'MERGED' contains the name of the file to which the merge
2339 tool should write the results of a successful merge.
2341 mergetool.<tool>.trustExitCode::
2342 For a custom merge command, specify whether the exit code of
2343 the merge command can be used to determine whether the merge was
2344 successful. If this is not set to true then the merge target file
2345 timestamp is checked and the merge assumed to have been successful
2346 if the file has been updated, otherwise the user is prompted to
2347 indicate the success of the merge.
2349 mergetool.meld.hasOutput::
2350 Older versions of `meld` do not support the `--output` option.
2351 Git will attempt to detect whether `meld` supports `--output`
2352 by inspecting the output of `meld --help`. Configuring
2353 `mergetool.meld.hasOutput` will make Git skip these checks and
2354 use the configured value instead. Setting `mergetool.meld.hasOutput`
2355 to `true` tells Git to unconditionally use the `--output` option,
2356 and `false` avoids using `--output`.
2358 mergetool.keepBackup::
2359 After performing a merge, the original file with conflict markers
2360 can be saved as a file with a `.orig` extension. If this variable
2361 is set to `false` then this file is not preserved. Defaults to
2362 `true` (i.e. keep the backup files).
2364 mergetool.keepTemporaries::
2365 When invoking a custom merge tool, Git uses a set of temporary
2366 files to pass to the tool. If the tool returns an error and this
2367 variable is set to `true`, then these temporary files will be
2368 preserved, otherwise they will be removed after the tool has
2369 exited. Defaults to `false`.
2371 mergetool.writeToTemp::
2372 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2373 conflicting files in the worktree by default. Git will attempt
2374 to use a temporary directory for these files when set `true`.
2375 Defaults to `false`.
2378 Prompt before each invocation of the merge resolution program.
2380 notes.mergeStrategy::
2381 Which merge strategy to choose by default when resolving notes
2382 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2383 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2384 section of linkgit:git-notes[1] for more information on each strategy.
2386 notes.<name>.mergeStrategy::
2387 Which merge strategy to choose when doing a notes merge into
2388 refs/notes/<name>. This overrides the more general
2389 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2390 linkgit:git-notes[1] for more information on the available strategies.
2393 The (fully qualified) refname from which to show notes when
2394 showing commit messages. The value of this variable can be set
2395 to a glob, in which case notes from all matching refs will be
2396 shown. You may also specify this configuration variable
2397 several times. A warning will be issued for refs that do not
2398 exist, but a glob that does not match any refs is silently
2401 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2402 environment variable, which must be a colon separated list of refs or
2405 The effective value of "core.notesRef" (possibly overridden by
2406 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2409 notes.rewrite.<command>::
2410 When rewriting commits with <command> (currently `amend` or
2411 `rebase`) and this variable is set to `true`, Git
2412 automatically copies your notes from the original to the
2413 rewritten commit. Defaults to `true`, but see
2414 "notes.rewriteRef" below.
2417 When copying notes during a rewrite (see the
2418 "notes.rewrite.<command>" option), determines what to do if
2419 the target commit already has a note. Must be one of
2420 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2421 Defaults to `concatenate`.
2423 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2424 environment variable.
2427 When copying notes during a rewrite, specifies the (fully
2428 qualified) ref whose notes should be copied. The ref may be a
2429 glob, in which case notes in all matching refs will be copied.
2430 You may also specify this configuration several times.
2432 Does not have a default value; you must configure this variable to
2433 enable note rewriting. Set it to `refs/notes/commits` to enable
2434 rewriting for the default commit notes.
2436 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2437 environment variable, which must be a colon separated list of refs or
2441 The size of the window used by linkgit:git-pack-objects[1] when no
2442 window size is given on the command line. Defaults to 10.
2445 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2446 maximum depth is given on the command line. Defaults to 50.
2447 Maximum value is 4095.
2450 The maximum size of memory that is consumed by each thread
2451 in linkgit:git-pack-objects[1] for pack window memory when
2452 no limit is given on the command line. The value can be
2453 suffixed with "k", "m", or "g". When left unconfigured (or
2454 set explicitly to 0), there will be no limit.
2457 An integer -1..9, indicating the compression level for objects
2458 in a pack file. -1 is the zlib default. 0 means no
2459 compression, and 1..9 are various speed/size tradeoffs, 9 being
2460 slowest. If not set, defaults to core.compression. If that is
2461 not set, defaults to -1, the zlib default, which is "a default
2462 compromise between speed and compression (currently equivalent
2465 Note that changing the compression level will not automatically recompress
2466 all existing objects. You can force recompression by passing the -F option
2467 to linkgit:git-repack[1].
2470 An extended regular expression configuring a set of delta
2471 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
2475 Specify an island name which gets to have its objects be
2476 packed first. This creates a kind of pseudo-pack at the front
2477 of one pack, so that the objects from the specified island are
2478 hopefully faster to copy into any pack that should be served
2479 to a user requesting these objects. In practice this means
2480 that the island specified should likely correspond to what is
2481 the most commonly cloned in the repo. See also "DELTA ISLANDS"
2482 in linkgit:git-pack-objects[1].
2484 pack.deltaCacheSize::
2485 The maximum memory in bytes used for caching deltas in
2486 linkgit:git-pack-objects[1] before writing them out to a pack.
2487 This cache is used to speed up the writing object phase by not
2488 having to recompute the final delta result once the best match
2489 for all objects is found. Repacking large repositories on machines
2490 which are tight with memory might be badly impacted by this though,
2491 especially if this cache pushes the system into swapping.
2492 A value of 0 means no limit. The smallest size of 1 byte may be
2493 used to virtually disable this cache. Defaults to 256 MiB.
2495 pack.deltaCacheLimit::
2496 The maximum size of a delta, that is cached in
2497 linkgit:git-pack-objects[1]. This cache is used to speed up the
2498 writing object phase by not having to recompute the final delta
2499 result once the best match for all objects is found.
2500 Defaults to 1000. Maximum value is 65535.
2503 Specifies the number of threads to spawn when searching for best
2504 delta matches. This requires that linkgit:git-pack-objects[1]
2505 be compiled with pthreads otherwise this option is ignored with a
2506 warning. This is meant to reduce packing time on multiprocessor
2507 machines. The required amount of memory for the delta search window
2508 is however multiplied by the number of threads.
2509 Specifying 0 will cause Git to auto-detect the number of CPU's
2510 and set the number of threads accordingly.
2513 Specify the default pack index version. Valid values are 1 for
2514 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2515 the new pack index with capabilities for packs larger than 4 GB
2516 as well as proper protection against the repacking of corrupted
2517 packs. Version 2 is the default. Note that version 2 is enforced
2518 and this config option ignored whenever the corresponding pack is
2521 If you have an old Git that does not understand the version 2 `*.idx` file,
2522 cloning or fetching over a non native protocol (e.g. "http")
2523 that will copy both `*.pack` file and corresponding `*.idx` file from the
2524 other side may give you a repository that cannot be accessed with your
2525 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2526 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2529 pack.packSizeLimit::
2530 The maximum size of a pack. This setting only affects
2531 packing to a file when repacking, i.e. the git:// protocol
2532 is unaffected. It can be overridden by the `--max-pack-size`
2533 option of linkgit:git-repack[1]. Reaching this limit results
2534 in the creation of multiple packfiles; which in turn prevents
2535 bitmaps from being created.
2536 The minimum size allowed is limited to 1 MiB.
2537 The default is unlimited.
2538 Common unit suffixes of 'k', 'm', or 'g' are
2542 When true, git will use pack bitmaps (if available) when packing
2543 to stdout (e.g., during the server side of a fetch). Defaults to
2544 true. You should not generally need to turn this off unless
2545 you are debugging pack bitmaps.
2547 pack.writeBitmaps (deprecated)::
2548 This is a deprecated synonym for `repack.writeBitmaps`.
2550 pack.writeBitmapHashCache::
2551 When true, git will include a "hash cache" section in the bitmap
2552 index (if one is written). This cache can be used to feed git's
2553 delta heuristics, potentially leading to better deltas between
2554 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2555 between an older, bitmapped pack and objects that have been
2556 pushed since the last gc). The downside is that it consumes 4
2557 bytes per object of disk space, and that JGit's bitmap
2558 implementation does not understand it, causing it to complain if
2559 Git and JGit are used on the same repository. Defaults to false.
2562 If the value is boolean, turns on or off pagination of the
2563 output of a particular Git subcommand when writing to a tty.
2564 Otherwise, turns on pagination for the subcommand using the
2565 pager specified by the value of `pager.<cmd>`. If `--paginate`
2566 or `--no-pager` is specified on the command line, it takes
2567 precedence over this option. To disable pagination for all
2568 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2571 Alias for a --pretty= format string, as specified in
2572 linkgit:git-log[1]. Any aliases defined here can be used just
2573 as the built-in pretty formats could. For example,
2574 running `git config pretty.changelog "format:* %H %s"`
2575 would cause the invocation `git log --pretty=changelog`
2576 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2577 Note that an alias with the same name as a built-in format
2578 will be silently ignored.
2581 If set, provide a user defined default policy for all protocols which
2582 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2583 if unset, known-safe protocols (http, https, git, ssh, file) have a
2584 default policy of `always`, known-dangerous protocols (ext) have a
2585 default policy of `never`, and all other protocols have a default
2586 policy of `user`. Supported policies:
2590 * `always` - protocol is always able to be used.
2592 * `never` - protocol is never able to be used.
2594 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2595 either unset or has a value of 1. This policy should be used when you want a
2596 protocol to be directly usable by the user but don't want it used by commands which
2597 execute clone/fetch/push commands without user input, e.g. recursive
2598 submodule initialization.
2602 protocol.<name>.allow::
2603 Set a policy to be used by protocol `<name>` with clone/fetch/push
2604 commands. See `protocol.allow` above for the available policies.
2606 The protocol names currently used by git are:
2609 - `file`: any local file-based path (including `file://` URLs,
2612 - `git`: the anonymous git protocol over a direct TCP
2613 connection (or proxy, if configured)
2615 - `ssh`: git over ssh (including `host:path` syntax,
2618 - `http`: git over http, both "smart http" and "dumb http".
2619 Note that this does _not_ include `https`; if you want to configure
2620 both, you must do so individually.
2622 - any external helpers are named by their protocol (e.g., use
2623 `hg` to allow the `git-remote-hg` helper)
2627 Experimental. If set, clients will attempt to communicate with a
2628 server using the specified protocol version. If unset, no
2629 attempt will be made by the client to communicate using a
2630 particular protocol version, this results in protocol version 0
2636 * `0` - the original wire protocol.
2638 * `1` - the original wire protocol with the addition of a version string
2639 in the initial response from the server.
2641 * `2` - link:technical/protocol-v2.html[wire protocol version 2].
2645 include::pull-config.txt[]
2647 include::push-config.txt[]
2649 include::rebase-config.txt[]
2651 include::receive-config.txt[]
2653 remote.pushDefault::
2654 The remote to push to by default. Overrides
2655 `branch.<name>.remote` for all branches, and is overridden by
2656 `branch.<name>.pushRemote` for specific branches.
2659 The URL of a remote repository. See linkgit:git-fetch[1] or
2660 linkgit:git-push[1].
2662 remote.<name>.pushurl::
2663 The push URL of a remote repository. See linkgit:git-push[1].
2665 remote.<name>.proxy::
2666 For remotes that require curl (http, https and ftp), the URL to
2667 the proxy to use for that remote. Set to the empty string to
2668 disable proxying for that remote.
2670 remote.<name>.proxyAuthMethod::
2671 For remotes that require curl (http, https and ftp), the method to use for
2672 authenticating against the proxy in use (probably set in
2673 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2675 remote.<name>.fetch::
2676 The default set of "refspec" for linkgit:git-fetch[1]. See
2677 linkgit:git-fetch[1].
2679 remote.<name>.push::
2680 The default set of "refspec" for linkgit:git-push[1]. See
2681 linkgit:git-push[1].
2683 remote.<name>.mirror::
2684 If true, pushing to this remote will automatically behave
2685 as if the `--mirror` option was given on the command line.
2687 remote.<name>.skipDefaultUpdate::
2688 If true, this remote will be skipped by default when updating
2689 using linkgit:git-fetch[1] or the `update` subcommand of
2690 linkgit:git-remote[1].
2692 remote.<name>.skipFetchAll::
2693 If true, this remote will be skipped by default when updating
2694 using linkgit:git-fetch[1] or the `update` subcommand of
2695 linkgit:git-remote[1].
2697 remote.<name>.receivepack::
2698 The default program to execute on the remote side when pushing. See
2699 option --receive-pack of linkgit:git-push[1].
2701 remote.<name>.uploadpack::
2702 The default program to execute on the remote side when fetching. See
2703 option --upload-pack of linkgit:git-fetch-pack[1].
2705 remote.<name>.tagOpt::
2706 Setting this value to --no-tags disables automatic tag following when
2707 fetching from remote <name>. Setting it to --tags will fetch every
2708 tag from remote <name>, even if they are not reachable from remote
2709 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2710 override this setting. See options --tags and --no-tags of
2711 linkgit:git-fetch[1].
2714 Setting this to a value <vcs> will cause Git to interact with
2715 the remote with the git-remote-<vcs> helper.
2717 remote.<name>.prune::
2718 When set to true, fetching from this remote by default will also
2719 remove any remote-tracking references that no longer exist on the
2720 remote (as if the `--prune` option was given on the command line).
2721 Overrides `fetch.prune` settings, if any.
2723 remote.<name>.pruneTags::
2724 When set to true, fetching from this remote by default will also
2725 remove any local tags that no longer exist on the remote if pruning
2726 is activated in general via `remote.<name>.prune`, `fetch.prune` or
2727 `--prune`. Overrides `fetch.pruneTags` settings, if any.
2729 See also `remote.<name>.prune` and the PRUNING section of
2730 linkgit:git-fetch[1].
2733 The list of remotes which are fetched by "git remote update
2734 <group>". See linkgit:git-remote[1].
2736 repack.useDeltaBaseOffset::
2737 By default, linkgit:git-repack[1] creates packs that use
2738 delta-base offset. If you need to share your repository with
2739 Git older than version 1.4.4, either directly or via a dumb
2740 protocol such as http, then you need to set this option to
2741 "false" and repack. Access from old Git versions over the
2742 native protocol are unaffected by this option.
2744 repack.packKeptObjects::
2745 If set to true, makes `git repack` act as if
2746 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2747 details. Defaults to `false` normally, but `true` if a bitmap
2748 index is being written (either via `--write-bitmap-index` or
2749 `repack.writeBitmaps`).
2751 repack.useDeltaIslands::
2752 If set to true, makes `git repack` act as if `--delta-islands`
2753 was passed. Defaults to `false`.
2755 repack.writeBitmaps::
2756 When true, git will write a bitmap index when packing all
2757 objects to disk (e.g., when `git repack -a` is run). This
2758 index can speed up the "counting objects" phase of subsequent
2759 packs created for clones and fetches, at the cost of some disk
2760 space and extra time spent on the initial repack. This has
2761 no effect if multiple packfiles are created.
2765 When set to true, `git-rerere` updates the index with the
2766 resulting contents after it cleanly resolves conflicts using
2767 previously recorded resolution. Defaults to false.
2770 Activate recording of resolved conflicts, so that identical
2771 conflict hunks can be resolved automatically, should they be
2772 encountered again. By default, linkgit:git-rerere[1] is
2773 enabled if there is an `rr-cache` directory under the
2774 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2777 include::sendemail-config.txt[]
2780 Text editor used by `git rebase -i` for editing the rebase instruction file.
2781 The value is meant to be interpreted by the shell when it is used.
2782 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
2783 When not configured the default commit message editor is used instead.
2785 showBranch.default::
2786 The default set of branches for linkgit:git-show-branch[1].
2787 See linkgit:git-show-branch[1].
2789 splitIndex.maxPercentChange::
2790 When the split index feature is used, this specifies the
2791 percent of entries the split index can contain compared to the
2792 total number of entries in both the split index and the shared
2793 index before a new shared index is written.
2794 The value should be between 0 and 100. If the value is 0 then
2795 a new shared index is always written, if it is 100 a new
2796 shared index is never written.
2797 By default the value is 20, so a new shared index is written
2798 if the number of entries in the split index would be greater
2799 than 20 percent of the total number of entries.
2800 See linkgit:git-update-index[1].
2802 splitIndex.sharedIndexExpire::
2803 When the split index feature is used, shared index files that
2804 were not modified since the time this variable specifies will
2805 be removed when a new shared index file is created. The value
2806 "now" expires all entries immediately, and "never" suppresses
2807 expiration altogether.
2808 The default value is "2.weeks.ago".
2809 Note that a shared index file is considered modified (for the
2810 purpose of expiration) each time a new split-index file is
2811 either created based on it or read from it.
2812 See linkgit:git-update-index[1].
2814 status.relativePaths::
2815 By default, linkgit:git-status[1] shows paths relative to the
2816 current directory. Setting this variable to `false` shows paths
2817 relative to the repository root (this was the default for Git
2821 Set to true to enable --short by default in linkgit:git-status[1].
2822 The option --no-short takes precedence over this variable.
2825 Set to true to enable --branch by default in linkgit:git-status[1].
2826 The option --no-branch takes precedence over this variable.
2828 status.displayCommentPrefix::
2829 If set to true, linkgit:git-status[1] will insert a comment
2830 prefix before each output line (starting with
2831 `core.commentChar`, i.e. `#` by default). This was the
2832 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2835 status.renameLimit::
2836 The number of files to consider when performing rename detection
2837 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
2838 the value of diff.renameLimit.
2841 Whether and how Git detects renames in linkgit:git-status[1] and
2842 linkgit:git-commit[1] . If set to "false", rename detection is
2843 disabled. If set to "true", basic rename detection is enabled.
2844 If set to "copies" or "copy", Git will detect copies, as well.
2845 Defaults to the value of diff.renames.
2848 If set to true, linkgit:git-status[1] will display the number of
2849 entries currently stashed away.
2852 status.showUntrackedFiles::
2853 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2854 files which are not currently tracked by Git. Directories which
2855 contain only untracked files, are shown with the directory name
2856 only. Showing untracked files means that Git needs to lstat() all
2857 the files in the whole repository, which might be slow on some
2858 systems. So, this variable controls how the commands displays
2859 the untracked files. Possible values are:
2862 * `no` - Show no untracked files.
2863 * `normal` - Show untracked files and directories.
2864 * `all` - Show also individual files in untracked directories.
2867 If this variable is not specified, it defaults to 'normal'.
2868 This variable can be overridden with the -u|--untracked-files option
2869 of linkgit:git-status[1] and linkgit:git-commit[1].
2871 status.submoduleSummary::
2873 If this is set to a non zero number or true (identical to -1 or an
2874 unlimited number), the submodule summary will be enabled and a
2875 summary of commits for modified submodules will be shown (see
2876 --summary-limit option of linkgit:git-submodule[1]). Please note
2877 that the summary output command will be suppressed for all
2878 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2879 for those submodules where `submodule.<name>.ignore=all`. The only
2880 exception to that rule is that status and commit will show staged
2881 submodule changes. To
2882 also view the summary for ignored submodules you can either use
2883 the --ignore-submodules=dirty command-line option or the 'git
2884 submodule summary' command, which shows a similar output but does
2885 not honor these settings.
2888 If this is set to true, the `git stash show` command without an
2889 option will show the stash entry in patch form. Defaults to false.
2890 See description of 'show' command in linkgit:git-stash[1].
2893 If this is set to true, the `git stash show` command without an
2894 option will show diffstat of the stash entry. Defaults to true.
2895 See description of 'show' command in linkgit:git-stash[1].
2897 include::submodule-config.txt[]
2899 tag.forceSignAnnotated::
2900 A boolean to specify whether annotated tags created should be GPG signed.
2901 If `--annotate` is specified on the command line, it takes
2902 precedence over this option.
2905 This variable controls the sort ordering of tags when displayed by
2906 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2907 value of this variable will be used as the default.
2910 This variable can be used to restrict the permission bits of
2911 tar archive entries. The default is 0002, which turns off the
2912 world write bit. The special value "user" indicates that the
2913 archiving user's umask will be used instead. See umask(2) and
2914 linkgit:git-archive[1].
2916 transfer.fsckObjects::
2917 When `fetch.fsckObjects` or `receive.fsckObjects` are
2918 not set, the value of this variable is used instead.
2921 When set, the fetch or receive will abort in the case of a malformed
2922 object or a link to a nonexistent object. In addition, various other
2923 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
2924 and potential security issues like the existence of a `.GIT` directory
2925 or a malicious `.gitmodules` file (see the release notes for v2.2.1
2926 and v2.17.1 for details). Other sanity and security checks may be
2927 added in future releases.
2929 On the receiving side, failing fsckObjects will make those objects
2930 unreachable, see "QUARANTINE ENVIRONMENT" in
2931 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
2932 instead be left unreferenced in the repository.
2934 Due to the non-quarantine nature of the `fetch.fsckObjects`
2935 implementation it can not be relied upon to leave the object store
2936 clean like `receive.fsckObjects` can.
2938 As objects are unpacked they're written to the object store, so there
2939 can be cases where malicious objects get introduced even though the
2940 "fetch" failed, only to have a subsequent "fetch" succeed because only
2941 new incoming objects are checked, not those that have already been
2942 written to the object store. That difference in behavior should not be
2943 relied upon. In the future, such objects may be quarantined for
2946 For now, the paranoid need to find some way to emulate the quarantine
2947 environment if they'd like the same protection as "push". E.g. in the
2948 case of an internal mirror do the mirroring in two steps, one to fetch
2949 the untrusted objects, and then do a second "push" (which will use the
2950 quarantine) to another internal repo, and have internal clients
2951 consume this pushed-to repository, or embargo internal fetches and
2952 only allow them once a full "fsck" has run (and no new fetches have
2953 happened in the meantime).
2956 String(s) `receive-pack` and `upload-pack` use to decide which
2957 refs to omit from their initial advertisements. Use more than
2958 one definition to specify multiple prefix strings. A ref that is
2959 under the hierarchies listed in the value of this variable is
2960 excluded, and is hidden when responding to `git push` or `git
2961 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2962 program-specific versions of this config.
2964 You may also include a `!` in front of the ref name to negate the entry,
2965 explicitly exposing it, even if an earlier entry marked it as hidden.
2966 If you have multiple hideRefs values, later entries override earlier ones
2967 (and entries in more-specific config files override less-specific ones).
2969 If a namespace is in use, the namespace prefix is stripped from each
2970 reference before it is matched against `transfer.hiderefs` patterns.
2971 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2972 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2973 is omitted from the advertisements but `refs/heads/master` and
2974 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2975 "have" lines. In order to match refs before stripping, add a `^` in front of
2976 the ref name. If you combine `!` and `^`, `!` must be specified first.
2978 Even if you hide refs, a client may still be able to steal the target
2979 objects via the techniques described in the "SECURITY" section of the
2980 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
2981 separate repository.
2983 transfer.unpackLimit::
2984 When `fetch.unpackLimit` or `receive.unpackLimit` are
2985 not set, the value of this variable is used instead.
2986 The default value is 100.
2988 uploadarchive.allowUnreachable::
2989 If true, allow clients to use `git archive --remote` to request
2990 any tree, whether reachable from the ref tips or not. See the
2991 discussion in the "SECURITY" section of
2992 linkgit:git-upload-archive[1] for more details. Defaults to
2995 uploadpack.hideRefs::
2996 This variable is the same as `transfer.hideRefs`, but applies
2997 only to `upload-pack` (and so affects only fetches, not pushes).
2998 An attempt to fetch a hidden ref by `git fetch` will fail. See
2999 also `uploadpack.allowTipSHA1InWant`.
3001 uploadpack.allowTipSHA1InWant::
3002 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3003 to accept a fetch request that asks for an object at the tip
3004 of a hidden ref (by default, such a request is rejected).
3005 See also `uploadpack.hideRefs`. Even if this is false, a client
3006 may be able to steal objects via the techniques described in the
3007 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3008 best to keep private data in a separate repository.
3010 uploadpack.allowReachableSHA1InWant::
3011 Allow `upload-pack` to accept a fetch request that asks for an
3012 object that is reachable from any ref tip. However, note that
3013 calculating object reachability is computationally expensive.
3014 Defaults to `false`. Even if this is false, a client may be able
3015 to steal objects via the techniques described in the "SECURITY"
3016 section of the linkgit:gitnamespaces[7] man page; it's best to
3017 keep private data in a separate repository.
3019 uploadpack.allowAnySHA1InWant::
3020 Allow `upload-pack` to accept a fetch request that asks for any
3022 Defaults to `false`.
3024 uploadpack.keepAlive::
3025 When `upload-pack` has started `pack-objects`, there may be a
3026 quiet period while `pack-objects` prepares the pack. Normally
3027 it would output progress information, but if `--quiet` was used
3028 for the fetch, `pack-objects` will output nothing at all until
3029 the pack data begins. Some clients and networks may consider
3030 the server to be hung and give up. Setting this option instructs
3031 `upload-pack` to send an empty keepalive packet every
3032 `uploadpack.keepAlive` seconds. Setting this option to 0
3033 disables keepalive packets entirely. The default is 5 seconds.
3035 uploadpack.packObjectsHook::
3036 If this option is set, when `upload-pack` would run
3037 `git pack-objects` to create a packfile for a client, it will
3038 run this shell command instead. The `pack-objects` command and
3039 arguments it _would_ have run (including the `git pack-objects`
3040 at the beginning) are appended to the shell command. The stdin
3041 and stdout of the hook are treated as if `pack-objects` itself
3042 was run. I.e., `upload-pack` will feed input intended for
3043 `pack-objects` to the hook, and expects a completed packfile on
3046 Note that this configuration variable is ignored if it is seen in the
3047 repository-level config (this is a safety measure against fetching from
3048 untrusted repositories).
3050 uploadpack.allowFilter::
3051 If this option is set, `upload-pack` will support partial
3052 clone and partial fetch object filtering.
3054 uploadpack.allowRefInWant::
3055 If this option is set, `upload-pack` will support the `ref-in-want`
3056 feature of the protocol version 2 `fetch` command. This feature
3057 is intended for the benefit of load-balanced servers which may
3058 not have the same view of what OIDs their refs point to due to
3061 url.<base>.insteadOf::
3062 Any URL that starts with this value will be rewritten to
3063 start, instead, with <base>. In cases where some site serves a
3064 large number of repositories, and serves them with multiple
3065 access methods, and some users need to use different access
3066 methods, this feature allows people to specify any of the
3067 equivalent URLs and have Git automatically rewrite the URL to
3068 the best alternative for the particular user, even for a
3069 never-before-seen repository on the site. When more than one
3070 insteadOf strings match a given URL, the longest match is used.
3072 Note that any protocol restrictions will be applied to the rewritten
3073 URL. If the rewrite changes the URL to use a custom protocol or remote
3074 helper, you may need to adjust the `protocol.*.allow` config to permit
3075 the request. In particular, protocols you expect to use for submodules
3076 must be set to `always` rather than the default of `user`. See the
3077 description of `protocol.allow` above.
3079 url.<base>.pushInsteadOf::
3080 Any URL that starts with this value will not be pushed to;
3081 instead, it will be rewritten to start with <base>, and the
3082 resulting URL will be pushed to. In cases where some site serves
3083 a large number of repositories, and serves them with multiple
3084 access methods, some of which do not allow push, this feature
3085 allows people to specify a pull-only URL and have Git
3086 automatically use an appropriate URL to push, even for a
3087 never-before-seen repository on the site. When more than one
3088 pushInsteadOf strings match a given URL, the longest match is
3089 used. If a remote has an explicit pushurl, Git will ignore this
3090 setting for that remote.
3093 Your email address to be recorded in any newly created commits.
3094 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3095 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3098 Your full name to be recorded in any newly created commits.
3099 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3100 environment variables. See linkgit:git-commit-tree[1].
3102 user.useConfigOnly::
3103 Instruct Git to avoid trying to guess defaults for `user.email`
3104 and `user.name`, and instead retrieve the values only from the
3105 configuration. For example, if you have multiple email addresses
3106 and would like to use a different one for each repository, then
3107 with this configuration option set to `true` in the global config
3108 along with a name, Git will prompt you to set up an email before
3109 making new commits in a newly cloned repository.
3110 Defaults to `false`.
3113 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3114 key you want it to automatically when creating a signed tag or
3115 commit, you can override the default selection with this variable.
3116 This option is passed unchanged to gpg's --local-user parameter,
3117 so you may specify a key using any method that gpg supports.
3119 versionsort.prereleaseSuffix (deprecated)::
3120 Deprecated alias for `versionsort.suffix`. Ignored if
3121 `versionsort.suffix` is set.
3123 versionsort.suffix::
3124 Even when version sort is used in linkgit:git-tag[1], tagnames
3125 with the same base version but different suffixes are still sorted
3126 lexicographically, resulting e.g. in prerelease tags appearing
3127 after the main release (e.g. "1.0-rc1" after "1.0"). This
3128 variable can be specified to determine the sorting order of tags
3129 with different suffixes.
3131 By specifying a single suffix in this variable, any tagname containing
3132 that suffix will appear before the corresponding main release. E.g. if
3133 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3134 "1.0". If specified multiple times, once per suffix, then the order of
3135 suffixes in the configuration will determine the sorting order of tagnames
3136 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3137 configuration, then all "1.0-preX" tags will be listed before any
3138 "1.0-rcX" tags. The placement of the main release tag relative to tags
3139 with various suffixes can be determined by specifying the empty suffix
3140 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3141 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3142 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3145 If more than one suffixes match the same tagname, then that tagname will
3146 be sorted according to the suffix which starts at the earliest position in
3147 the tagname. If more than one different matching suffixes start at
3148 that earliest position, then that tagname will be sorted according to the
3149 longest of those suffixes.
3150 The sorting order between different suffixes is undefined if they are
3151 in multiple config files.
3154 Specify a web browser that may be used by some commands.
3155 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3158 worktree.guessRemote::
3159 With `add`, if no branch argument, and neither of `-b` nor
3160 `-B` nor `--detach` are given, the command defaults to
3161 creating a new branch from HEAD. If `worktree.guessRemote` is
3162 set to true, `worktree add` tries to find a remote-tracking
3163 branch whose name uniquely matches the new branch name. If
3164 such a branch exists, it is checked out and set as "upstream"
3165 for the new branch. If no such match can be found, it falls
3166 back to creating a new branch from the current HEAD.