4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times; we say then that the variable is
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored. The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
27 The file consists of sections and variables. A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins. Section names are case-insensitive. Only alphanumeric
30 characters, `-` and `.` are allowed in section names. Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
34 Sections can be further divided into subsections. To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
39 [section "subsection"]
43 Subsection names are case sensitive and can contain any characters except
44 newline and the null byte. Doublequote `"` and backslash can be included
45 by escaping them as `\"` and `\\`, respectively. Backslashes preceding
46 other characters are dropped when reading; for example, `\t` is read as
47 `t` and `\0` is read as `0` Section headers cannot span multiple lines.
48 Variables may belong directly to a section or to a given subsection. You
49 can have `[section]` if you have `[section "subsection"]`, but you don't
52 There is also a deprecated `[section.subsection]` syntax. With this
53 syntax, the subsection name is converted to lower-case and is also
54 compared case sensitively. These subsection names follow the same
55 restrictions as section names.
57 All the other lines (and the remainder of the line after the section
58 header) are recognized as setting variables, in the form
59 'name = value' (or just 'name', which is a short-hand to say that
60 the variable is the boolean "true").
61 The variable names are case-insensitive, allow only alphanumeric characters
62 and `-`, and must start with an alphabetic character.
64 A line that defines a value can be continued to the next line by
65 ending it with a `\`; the backquote and the end-of-line are
66 stripped. Leading whitespaces after 'name =', the remainder of the
67 line after the first comment character '#' or ';', and trailing
68 whitespaces of the line are discarded unless they are enclosed in
69 double quotes. Internal whitespaces within the value are retained
72 Inside double quotes, double quote `"` and backslash `\` characters
73 must be escaped: use `\"` for `"` and `\\` for `\`.
75 The following escape sequences (beside `\"` and `\\`) are recognized:
76 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77 and `\b` for backspace (BS). Other char escape sequences (including octal
78 escape sequences) are invalid.
84 The `include` and `includeIf` sections allow you to include config
85 directives from another source. These sections behave identically to
86 each other with the exception that `includeIf` sections may be ignored
87 if their condition does not evaluate to true; see "Conditional includes"
90 You can include a config file from another by setting the special
91 `include.path` (or `includeIf.*.path`) variable to the name of the file
92 to be included. The variable takes a pathname as its value, and is
93 subject to tilde expansion. These variables can be given multiple times.
95 The contents of the included file are inserted immediately, as if they
96 had been found at the location of the include directive. If the value of the
97 variable is a relative path, the path is considered to
98 be relative to the configuration file in which the include directive
99 was found. See below for examples.
104 You can include a config file from another conditionally by setting a
105 `includeIf.<condition>.path` variable to the name of the file to be
108 The condition starts with a keyword followed by a colon and some data
109 whose format and meaning depends on the keyword. Supported keywords
114 The data that follows the keyword `gitdir:` is used as a glob
115 pattern. If the location of the .git directory matches the
116 pattern, the include condition is met.
118 The .git location may be auto-discovered, or come from `$GIT_DIR`
119 environment variable. If the repository is auto discovered via a .git
120 file (e.g. from submodules, or a linked worktree), the .git location
121 would be the final location where the .git directory is, not where the
124 The pattern can contain standard globbing wildcards and two additional
125 ones, `**/` and `/**`, that can match multiple path components. Please
126 refer to linkgit:gitignore[5] for details. For convenience:
128 * If the pattern starts with `~/`, `~` will be substituted with the
129 content of the environment variable `HOME`.
131 * If the pattern starts with `./`, it is replaced with the directory
132 containing the current config file.
134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
135 will be automatically prepended. For example, the pattern `foo/bar`
136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
138 * If the pattern ends with `/`, `**` will be automatically added. For
139 example, the pattern `foo/` becomes `foo/**`. In other words, it
140 matches "foo" and everything inside, recursively.
143 This is the same as `gitdir` except that matching is done
144 case-insensitively (e.g. on case-insensitive file sytems)
146 A few more notes on matching via `gitdir` and `gitdir/i`:
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
150 * Both the symlink & realpath versions of paths will be matched
151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
155 This was not the case in the initial release of this feature in
156 v2.13.0, which only matched the realpath version. Configuration that
157 wants to be compatible with the initial release of this feature needs
158 to either specify only the realpath version, or both versions.
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
168 ; Don't trust file modes
173 external = /usr/local/bin/diff-wrapper
178 merge = refs/heads/devel
182 gitProxy="ssh" for "kernel.org"
183 gitProxy=default-proxy ; for the rest
186 path = /path/to/foo.inc ; include by absolute path
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
202 ; relative paths are always relative to the including
203 ; file (if the condition is true); their location is not
204 ; affected by the condition
205 [includeIf "gitdir:/path/to/group/"]
211 Values of many variables are treated as a simple string, but there
212 are variables that take values of specific types and there are rules
213 as to how to spell them.
217 When a variable is said to take a boolean value, many
218 synonyms are accepted for 'true' and 'false'; these are all
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
228 When converting value to the canonical form using `--bool` type
229 specifier, 'git config' will ensure that the output is "true" or
230 "false" (spelled in lowercase).
233 The value for many variables that specify various sizes can
234 be suffixed with `k`, `M`,... to mean "scale the number by
235 1024", "by 1024x1024", etc.
238 The value for a variable that takes a color is a list of
239 colors (at most two, one for foreground and one for background)
240 and attributes (as many as you want), separated by spaces.
242 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
243 `blue`, `magenta`, `cyan` and `white`. The first color given is the
244 foreground; the second is the background.
246 Colors may also be given as numbers between 0 and 255; these use ANSI
247 256-color mode (but note that not all terminals may support this). If
248 your terminal supports it, you may also specify 24-bit RGB values as
251 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
252 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
253 The position of any attributes with respect to the colors
254 (before, after, or in between), doesn't matter. Specific attributes may
255 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
258 An empty color string produces no color effect at all. This can be used
259 to avoid coloring specific elements without disabling color entirely.
261 For git's pre-defined color slots, the attributes are meant to be reset
262 at the beginning of each item in the colored output. So setting
263 `color.decorate.branch` to `black` will paint that branch name in a
264 plain `black`, even if the previous thing on the same output line (e.g.
265 opening parenthesis before the list of branch names in `log --decorate`
266 output) is set to be painted with `bold` or some other attribute.
267 However, custom log formats may do more complicated and layered
268 coloring, and the negated forms may be useful there.
271 A variable that takes a pathname value can be given a
272 string that begins with "`~/`" or "`~user/`", and the usual
273 tilde expansion happens to such a string: `~/`
274 is expanded to the value of `$HOME`, and `~user/` to the
275 specified user's home directory.
281 Note that this list is non-comprehensive and not necessarily complete.
282 For command-specific variables, you will find a more detailed description
283 in the appropriate manual page.
285 Other git-related tools may and do use their own variables. When
286 inventing new variables for use in your own tool, make sure their
287 names do not conflict with those that are used by Git itself and
288 other popular tools, and describe them in your documentation.
292 These variables control various optional help messages designed to
293 aid new users. All 'advice.*' variables default to 'true', and you
294 can tell Git that you do not need help by setting these to 'false':
298 Set this variable to 'false' if you want to disable
300 'pushNonFFMatching', 'pushAlreadyExists',
301 'pushFetchFirst', and 'pushNeedsForce'
304 Advice shown when linkgit:git-push[1] fails due to a
305 non-fast-forward update to the current branch.
307 Advice shown when you ran linkgit:git-push[1] and pushed
308 'matching refs' explicitly (i.e. you used ':', or
309 specified a refspec that isn't your current branch) and
310 it resulted in a non-fast-forward error.
312 Shown when linkgit:git-push[1] rejects an update that
313 does not qualify for fast-forwarding (e.g., a tag.)
315 Shown when linkgit:git-push[1] rejects an update that
316 tries to overwrite a remote ref that points at an
317 object we do not have.
319 Shown when linkgit:git-push[1] rejects an update that
320 tries to overwrite a remote ref that points at an
321 object that is not a commit-ish, or make the remote
322 ref point at an object that is not a commit-ish.
324 Show directions on how to proceed from the current
325 state in the output of linkgit:git-status[1], in
326 the template shown when writing commit messages in
327 linkgit:git-commit[1], and in the help message shown
328 by linkgit:git-checkout[1] when switching branch.
330 Advise to consider using the `-u` option to linkgit:git-status[1]
331 when the command takes more than 2 seconds to enumerate untracked
334 Advice shown when linkgit:git-merge[1] refuses to
335 merge to avoid overwriting local changes.
337 Advice shown by various commands when conflicts
338 prevent the operation from being performed.
340 Advice on how to set your identity configuration when
341 your information is guessed from the system username and
344 Advice shown when you used linkgit:git-checkout[1] to
345 move to the detach HEAD state, to instruct how to create
346 a local branch after the fact.
348 Advice that shows the location of the patch file when
349 linkgit:git-am[1] fails to apply it.
351 In case of failure in the output of linkgit:git-rm[1],
352 show directions on how to proceed from the current state.
354 Advice on what to do when you've accidentally added one
355 git repo inside of another.
357 Advice shown if a hook is ignored because the hook is not
360 Print a message to the terminal whenever Git is waiting for
361 editor input from the user.
365 Tells Git if the executable bit of files in the working tree
368 Some filesystems lose the executable bit when a file that is
369 marked as executable is checked out, or checks out a
370 non-executable file with executable bit on.
371 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
372 to see if it handles the executable bit correctly
373 and this variable is automatically set as necessary.
375 A repository, however, may be on a filesystem that handles
376 the filemode correctly, and this variable is set to 'true'
377 when created, but later may be made accessible from another
378 environment that loses the filemode (e.g. exporting ext4 via
379 CIFS mount, visiting a Cygwin created repository with
380 Git for Windows or Eclipse).
381 In such a case it may be necessary to set this variable to 'false'.
382 See linkgit:git-update-index[1].
384 The default is true (when core.filemode is not specified in the config file).
387 (Windows-only) If true, mark newly-created directories and files whose
388 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
389 directory is hidden, but no other files starting with a dot. The
390 default mode is 'dotGitOnly'.
393 Internal variable which enables various workarounds to enable
394 Git to work better on filesystems that are not case sensitive,
395 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
396 finds "makefile" when Git expects "Makefile", Git will assume
397 it is really the same file, and continue to remember it as
400 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
401 will probe and set core.ignoreCase true if appropriate when the repository
404 Git relies on the proper configuration of this variable for your operating
405 and file system. Modifying this value may result in unexpected behavior.
407 core.precomposeUnicode::
408 This option is only used by Mac OS implementation of Git.
409 When core.precomposeUnicode=true, Git reverts the unicode decomposition
410 of filenames done by Mac OS. This is useful when sharing a repository
411 between Mac OS and Linux or Windows.
412 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
413 When false, file names are handled fully transparent by Git,
414 which is backward compatible with older versions of Git.
417 If set to true, do not allow checkout of paths that would
418 be considered equivalent to `.git` on an HFS+ filesystem.
419 Defaults to `true` on Mac OS, and `false` elsewhere.
422 If set to true, do not allow checkout of paths that would
423 cause problems with the NTFS filesystem, e.g. conflict with
425 Defaults to `true` on Windows, and `false` elsewhere.
428 If set, the value of this variable is used as a command which
429 will identify all files that may have changed since the
430 requested date/time. This information is used to speed up git by
431 avoiding unnecessary processing of files that have not changed.
432 See the "fsmonitor-watchman" section of linkgit:githooks[5].
435 If false, the ctime differences between the index and the
436 working tree are ignored; useful when the inode change time
437 is regularly modified by something outside Git (file system
438 crawlers and some backup systems).
439 See linkgit:git-update-index[1]. True by default.
442 If true, the split-index feature of the index will be used.
443 See linkgit:git-update-index[1]. False by default.
445 core.untrackedCache::
446 Determines what to do about the untracked cache feature of the
447 index. It will be kept, if this variable is unset or set to
448 `keep`. It will automatically be added if set to `true`. And
449 it will automatically be removed, if set to `false`. Before
450 setting it to `true`, you should check that mtime is working
451 properly on your system.
452 See linkgit:git-update-index[1]. `keep` by default.
455 Determines which stat fields to match between the index
456 and work tree. The user can set this to 'default' or
457 'minimal'. Default (or explicitly 'default'), is to check
458 all fields, including the sub-second part of mtime and ctime.
461 Commands that output paths (e.g. 'ls-files', 'diff'), will
462 quote "unusual" characters in the pathname by enclosing the
463 pathname in double-quotes and escaping those characters with
464 backslashes in the same way C escapes control characters (e.g.
465 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
466 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
467 UTF-8). If this variable is set to false, bytes higher than
468 0x80 are not considered "unusual" any more. Double-quotes,
469 backslash and control characters are always escaped regardless
470 of the setting of this variable. A simple space character is
471 not considered "unusual". Many commands can output pathnames
472 completely verbatim using the `-z` option. The default value
476 Sets the line ending type to use in the working directory for
477 files that have the `text` property set when core.autocrlf is false.
478 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
479 native line ending. The default value is `native`. See
480 linkgit:gitattributes[5] for more information on end-of-line
484 If true, makes Git check if converting `CRLF` is reversible when
485 end-of-line conversion is active. Git will verify if a command
486 modifies a file in the work tree either directly or indirectly.
487 For example, committing a file followed by checking out the
488 same file should yield the original file in the work tree. If
489 this is not the case for the current setting of
490 `core.autocrlf`, Git will reject the file. The variable can
491 be set to "warn", in which case Git will only warn about an
492 irreversible conversion but continue the operation.
494 CRLF conversion bears a slight chance of corrupting data.
495 When it is enabled, Git will convert CRLF to LF during commit and LF to
496 CRLF during checkout. A file that contains a mixture of LF and
497 CRLF before the commit cannot be recreated by Git. For text
498 files this is the right thing to do: it corrects line endings
499 such that we have only LF line endings in the repository.
500 But for binary files that are accidentally classified as text the
501 conversion can corrupt data.
503 If you recognize such corruption early you can easily fix it by
504 setting the conversion type explicitly in .gitattributes. Right
505 after committing you still have the original file in your work
506 tree and this file is not yet corrupted. You can explicitly tell
507 Git that this file is binary and Git will handle the file
510 Unfortunately, the desired effect of cleaning up text files with
511 mixed line endings and the undesired effect of corrupting binary
512 files cannot be distinguished. In both cases CRLFs are removed
513 in an irreversible way. For text files this is the right thing
514 to do because CRLFs are line endings, while for binary files
515 converting CRLFs corrupts data.
517 Note, this safety check does not mean that a checkout will generate a
518 file identical to the original file for a different setting of
519 `core.eol` and `core.autocrlf`, but only for the current one. For
520 example, a text file with `LF` would be accepted with `core.eol=lf`
521 and could later be checked out with `core.eol=crlf`, in which case the
522 resulting file would contain `CRLF`, although the original file
523 contained `LF`. However, in both work trees the line endings would be
524 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
525 file with mixed line endings would be reported by the `core.safecrlf`
529 Setting this variable to "true" is the same as setting
530 the `text` attribute to "auto" on all files and core.eol to "crlf".
531 Set to true if you want to have `CRLF` line endings in your
532 working directory and the repository has LF line endings.
533 This variable can be set to 'input',
534 in which case no output conversion is performed.
536 core.checkRoundtripEncoding::
537 A comma and/or whitespace separated list of encodings that Git
538 performs UTF-8 round trip checks on if they are used in an
539 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
540 The default value is `SHIFT-JIS`.
543 If false, symbolic links are checked out as small plain files that
544 contain the link text. linkgit:git-update-index[1] and
545 linkgit:git-add[1] will not change the recorded type to regular
546 file. Useful on filesystems like FAT that do not support
549 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
550 will probe and set core.symlinks false if appropriate when the repository
554 A "proxy command" to execute (as 'command host port') instead
555 of establishing direct connection to the remote server when
556 using the Git protocol for fetching. If the variable value is
557 in the "COMMAND for DOMAIN" format, the command is applied only
558 on hostnames ending with the specified domain string. This variable
559 may be set multiple times and is matched in the given order;
560 the first match wins.
562 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
563 (which always applies universally, without the special "for"
566 The special string `none` can be used as the proxy command to
567 specify that no proxy be used for a given domain pattern.
568 This is useful for excluding servers inside a firewall from
569 proxy use, while defaulting to a common proxy for external domains.
572 If this variable is set, `git fetch` and `git push` will
573 use the specified command instead of `ssh` when they need to
574 connect to a remote system. The command is in the same form as
575 the `GIT_SSH_COMMAND` environment variable and is overridden
576 when the environment variable is set.
579 If true, Git will avoid using lstat() calls to detect if files have
580 changed by setting the "assume-unchanged" bit for those tracked files
581 which it has updated identically in both the index and working tree.
583 When files are modified outside of Git, the user will need to stage
584 the modified files explicitly (e.g. see 'Examples' section in
585 linkgit:git-update-index[1]).
586 Git will not normally detect changes to those files.
588 This is useful on systems where lstat() calls are very slow, such as
589 CIFS/Microsoft Windows.
593 core.preferSymlinkRefs::
594 Instead of the default "symref" format for HEAD
595 and other symbolic reference files, use symbolic links.
596 This is sometimes needed to work with old scripts that
597 expect HEAD to be a symbolic link.
600 If true this repository is assumed to be 'bare' and has no
601 working directory associated with it. If this is the case a
602 number of commands that require a working directory will be
603 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
605 This setting is automatically guessed by linkgit:git-clone[1] or
606 linkgit:git-init[1] when the repository was created. By default a
607 repository that ends in "/.git" is assumed to be not bare (bare =
608 false), while all other repositories are assumed to be bare (bare
612 Set the path to the root of the working tree.
613 If `GIT_COMMON_DIR` environment variable is set, core.worktree
614 is ignored and not used for determining the root of working tree.
615 This can be overridden by the `GIT_WORK_TREE` environment
616 variable and the `--work-tree` command-line option.
617 The value can be an absolute path or relative to the path to
618 the .git directory, which is either specified by --git-dir
619 or GIT_DIR, or automatically discovered.
620 If --git-dir or GIT_DIR is specified but none of
621 --work-tree, GIT_WORK_TREE and core.worktree is specified,
622 the current working directory is regarded as the top level
623 of your working tree.
625 Note that this variable is honored even when set in a configuration
626 file in a ".git" subdirectory of a directory and its value differs
627 from the latter directory (e.g. "/path/to/.git/config" has
628 core.worktree set to "/different/path"), which is most likely a
629 misconfiguration. Running Git commands in the "/path/to" directory will
630 still use "/different/path" as the root of the work tree and can cause
631 confusion unless you know what you are doing (e.g. you are creating a
632 read-only snapshot of the same index to a location different from the
633 repository's usual working tree).
635 core.logAllRefUpdates::
636 Enable the reflog. Updates to a ref <ref> is logged to the file
637 "`$GIT_DIR/logs/<ref>`", by appending the new and old
638 SHA-1, the date/time and the reason of the update, but
639 only when the file exists. If this configuration
640 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
641 file is automatically created for branch heads (i.e. under
642 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
643 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
644 If it is set to `always`, then a missing reflog is automatically
645 created for any ref under `refs/`.
647 This information can be used to determine what commit
648 was the tip of a branch "2 days ago".
650 This value is true by default in a repository that has
651 a working directory associated with it, and false by
652 default in a bare repository.
654 core.repositoryFormatVersion::
655 Internal variable identifying the repository format and layout
658 core.sharedRepository::
659 When 'group' (or 'true'), the repository is made shareable between
660 several users in a group (making sure all the files and objects are
661 group-writable). When 'all' (or 'world' or 'everybody'), the
662 repository will be readable by all users, additionally to being
663 group-shareable. When 'umask' (or 'false'), Git will use permissions
664 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
665 files in the repository will have this mode value. '0xxx' will override
666 user's umask value (whereas the other options will only override
667 requested parts of the user's umask value). Examples: '0660' will make
668 the repo read/write-able for the owner and group, but inaccessible to
669 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
670 repository that is group-readable but not group-writable.
671 See linkgit:git-init[1]. False by default.
673 core.warnAmbiguousRefs::
674 If true, Git will warn you if the ref name you passed it is ambiguous
675 and might match multiple refs in the repository. True by default.
678 An integer -1..9, indicating a default compression level.
679 -1 is the zlib default. 0 means no compression,
680 and 1..9 are various speed/size tradeoffs, 9 being slowest.
681 If set, this provides a default to other compression variables,
682 such as `core.looseCompression` and `pack.compression`.
684 core.looseCompression::
685 An integer -1..9, indicating the compression level for objects that
686 are not in a pack file. -1 is the zlib default. 0 means no
687 compression, and 1..9 are various speed/size tradeoffs, 9 being
688 slowest. If not set, defaults to core.compression. If that is
689 not set, defaults to 1 (best speed).
691 core.packedGitWindowSize::
692 Number of bytes of a pack file to map into memory in a
693 single mapping operation. Larger window sizes may allow
694 your system to process a smaller number of large pack files
695 more quickly. Smaller window sizes will negatively affect
696 performance due to increased calls to the operating system's
697 memory manager, but may improve performance when accessing
698 a large number of large pack files.
700 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
701 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
702 be reasonable for all users/operating systems. You probably do
703 not need to adjust this value.
705 Common unit suffixes of 'k', 'm', or 'g' are supported.
707 core.packedGitLimit::
708 Maximum number of bytes to map simultaneously into memory
709 from pack files. If Git needs to access more than this many
710 bytes at once to complete an operation it will unmap existing
711 regions to reclaim virtual address space within the process.
713 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
714 unlimited) on 64 bit platforms.
715 This should be reasonable for all users/operating systems, except on
716 the largest projects. You probably do not need to adjust this value.
718 Common unit suffixes of 'k', 'm', or 'g' are supported.
720 core.deltaBaseCacheLimit::
721 Maximum number of bytes to reserve for caching base objects
722 that may be referenced by multiple deltified objects. By storing the
723 entire decompressed base objects in a cache Git is able
724 to avoid unpacking and decompressing frequently used base
725 objects multiple times.
727 Default is 96 MiB on all platforms. This should be reasonable
728 for all users/operating systems, except on the largest projects.
729 You probably do not need to adjust this value.
731 Common unit suffixes of 'k', 'm', or 'g' are supported.
733 core.bigFileThreshold::
734 Files larger than this size are stored deflated, without
735 attempting delta compression. Storing large files without
736 delta compression avoids excessive memory usage, at the
737 slight expense of increased disk usage. Additionally files
738 larger than this size are always treated as binary.
740 Default is 512 MiB on all platforms. This should be reasonable
741 for most projects as source code and other text files can still
742 be delta compressed, but larger binary media files won't be.
744 Common unit suffixes of 'k', 'm', or 'g' are supported.
747 Specifies the pathname to the file that contains patterns to
748 describe paths that are not meant to be tracked, in addition
749 to '.gitignore' (per-directory) and '.git/info/exclude'.
750 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
751 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
752 is used instead. See linkgit:gitignore[5].
755 Some commands (e.g. svn and http interfaces) that interactively
756 ask for a password can be told to use an external program given
757 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
758 environment variable. If not set, fall back to the value of the
759 `SSH_ASKPASS` environment variable or, failing that, a simple password
760 prompt. The external program shall be given a suitable prompt as
761 command-line argument and write the password on its STDOUT.
763 core.attributesFile::
764 In addition to '.gitattributes' (per-directory) and
765 '.git/info/attributes', Git looks into this file for attributes
766 (see linkgit:gitattributes[5]). Path expansions are made the same
767 way as for `core.excludesFile`. Its default value is
768 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
769 set or empty, `$HOME/.config/git/attributes` is used instead.
772 By default Git will look for your hooks in the
773 '$GIT_DIR/hooks' directory. Set this to different path,
774 e.g. '/etc/git/hooks', and Git will try to find your hooks in
775 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
776 in '$GIT_DIR/hooks/pre-receive'.
778 The path can be either absolute or relative. A relative path is
779 taken as relative to the directory where the hooks are run (see
780 the "DESCRIPTION" section of linkgit:githooks[5]).
782 This configuration variable is useful in cases where you'd like to
783 centrally configure your Git hooks instead of configuring them on a
784 per-repository basis, or as a more flexible and centralized
785 alternative to having an `init.templateDir` where you've changed
789 Commands such as `commit` and `tag` that let you edit
790 messages by launching an editor use the value of this
791 variable when it is set, and the environment variable
792 `GIT_EDITOR` is not set. See linkgit:git-var[1].
795 Commands such as `commit` and `tag` that let you edit
796 messages consider a line that begins with this character
797 commented, and removes them after the editor returns
800 If set to "auto", `git-commit` would select a character that is not
801 the beginning character of any line in existing commit messages.
803 core.filesRefLockTimeout::
804 The length of time, in milliseconds, to retry when trying to
805 lock an individual reference. Value 0 means not to retry at
806 all; -1 means to try indefinitely. Default is 100 (i.e.,
809 core.packedRefsTimeout::
810 The length of time, in milliseconds, to retry when trying to
811 lock the `packed-refs` file. Value 0 means not to retry at
812 all; -1 means to try indefinitely. Default is 1000 (i.e.,
816 Text editor used by `git rebase -i` for editing the rebase instruction file.
817 The value is meant to be interpreted by the shell when it is used.
818 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
819 When not configured the default commit message editor is used instead.
822 Text viewer for use by Git commands (e.g., 'less'). The value
823 is meant to be interpreted by the shell. The order of preference
824 is the `$GIT_PAGER` environment variable, then `core.pager`
825 configuration, then `$PAGER`, and then the default chosen at
826 compile time (usually 'less').
828 When the `LESS` environment variable is unset, Git sets it to `FRX`
829 (if `LESS` environment variable is set, Git does not change it at
830 all). If you want to selectively override Git's default setting
831 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
832 be passed to the shell by Git, which will translate the final
833 command to `LESS=FRX less -S`. The environment does not set the
834 `S` option but the command line does, instructing less to truncate
835 long lines. Similarly, setting `core.pager` to `less -+F` will
836 deactivate the `F` option specified by the environment from the
837 command-line, deactivating the "quit if one screen" behavior of
838 `less`. One can specifically activate some flags for particular
839 commands: for example, setting `pager.blame` to `less -S` enables
840 line truncation only for `git blame`.
842 Likewise, when the `LV` environment variable is unset, Git sets it
843 to `-c`. You can override this setting by exporting `LV` with
844 another value or setting `core.pager` to `lv +c`.
847 A comma separated list of common whitespace problems to
848 notice. 'git diff' will use `color.diff.whitespace` to
849 highlight them, and 'git apply --whitespace=error' will
850 consider them as errors. You can prefix `-` to disable
851 any of them (e.g. `-trailing-space`):
853 * `blank-at-eol` treats trailing whitespaces at the end of the line
854 as an error (enabled by default).
855 * `space-before-tab` treats a space character that appears immediately
856 before a tab character in the initial indent part of the line as an
857 error (enabled by default).
858 * `indent-with-non-tab` treats a line that is indented with space
859 characters instead of the equivalent tabs as an error (not enabled by
861 * `tab-in-indent` treats a tab character in the initial indent part of
862 the line as an error (not enabled by default).
863 * `blank-at-eof` treats blank lines added at the end of file as an error
864 (enabled by default).
865 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
867 * `cr-at-eol` treats a carriage-return at the end of line as
868 part of the line terminator, i.e. with it, `trailing-space`
869 does not trigger if the character before such a carriage-return
870 is not a whitespace (not enabled by default).
871 * `tabwidth=<n>` tells how many character positions a tab occupies; this
872 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
873 errors. The default tab width is 8. Allowed values are 1 to 63.
875 core.fsyncObjectFiles::
876 This boolean will enable 'fsync()' when writing object files.
878 This is a total waste of time and effort on a filesystem that orders
879 data writes properly, but can be useful for filesystems that do not use
880 journalling (traditional UNIX filesystems) or that only journal metadata
881 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
884 Enable parallel index preload for operations like 'git diff'
886 This can speed up operations like 'git diff' and 'git status' especially
887 on filesystems like NFS that have weak caching semantics and thus
888 relatively high IO latencies. When enabled, Git will do the
889 index comparison to the filesystem data in parallel, allowing
890 overlapping IO's. Defaults to true.
893 You can set this to 'link', in which case a hardlink followed by
894 a delete of the source are used to make sure that object creation
895 will not overwrite existing objects.
897 On some file system/operating system combinations, this is unreliable.
898 Set this config setting to 'rename' there; However, This will remove the
899 check that makes sure that existing object files will not get overwritten.
902 When showing commit messages, also show notes which are stored in
903 the given ref. The ref must be fully qualified. If the given
904 ref does not exist, it is not an error but means that no
905 notes should be printed.
907 This setting defaults to "refs/notes/commits", and it can be overridden by
908 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
911 Enable git commit graph feature. Allows reading from the
914 core.sparseCheckout::
915 Enable "sparse checkout" feature. See section "Sparse checkout" in
916 linkgit:git-read-tree[1] for more information.
919 Set the length object names are abbreviated to. If
920 unspecified or set to "auto", an appropriate value is
921 computed based on the approximate number of packed objects
922 in your repository, which hopefully is enough for
923 abbreviated object names to stay unique for some time.
924 The minimum length is 4.
927 add.ignore-errors (deprecated)::
928 Tells 'git add' to continue adding files when some files cannot be
929 added due to indexing errors. Equivalent to the `--ignore-errors`
930 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
931 as it does not follow the usual naming convention for configuration
935 Command aliases for the linkgit:git[1] command wrapper - e.g.
936 after defining "alias.last = cat-file commit HEAD", the invocation
937 "git last" is equivalent to "git cat-file commit HEAD". To avoid
938 confusion and troubles with script usage, aliases that
939 hide existing Git commands are ignored. Arguments are split by
940 spaces, the usual shell quoting and escaping is supported.
941 A quote pair or a backslash can be used to quote them.
943 If the alias expansion is prefixed with an exclamation point,
944 it will be treated as a shell command. For example, defining
945 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
946 "git new" is equivalent to running the shell command
947 "gitk --all --not ORIG_HEAD". Note that shell commands will be
948 executed from the top-level directory of a repository, which may
949 not necessarily be the current directory.
950 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
951 from the original current directory. See linkgit:git-rev-parse[1].
954 If true, git-am will call git-mailsplit for patches in mbox format
955 with parameter `--keep-cr`. In this case git-mailsplit will
956 not remove `\r` from lines ending with `\r\n`. Can be overridden
957 by giving `--no-keep-cr` from the command line.
958 See linkgit:git-am[1], linkgit:git-mailsplit[1].
961 By default, `git am` will fail if the patch does not apply cleanly. When
962 set to true, this setting tells `git am` to fall back on 3-way merge if
963 the patch records the identity of blobs it is supposed to apply to and
964 we have those blobs available locally (equivalent to giving the `--3way`
965 option from the command line). Defaults to `false`.
966 See linkgit:git-am[1].
968 apply.ignoreWhitespace::
969 When set to 'change', tells 'git apply' to ignore changes in
970 whitespace, in the same way as the `--ignore-space-change`
972 When set to one of: no, none, never, false tells 'git apply' to
973 respect all whitespace differences.
974 See linkgit:git-apply[1].
977 Tells 'git apply' how to handle whitespaces, in the same way
978 as the `--whitespace` option. See linkgit:git-apply[1].
981 Do not treat root commits as boundaries in linkgit:git-blame[1].
982 This option defaults to false.
984 blame.blankBoundary::
985 Show blank commit object name for boundary commits in
986 linkgit:git-blame[1]. This option defaults to false.
989 Show the author email instead of author name in linkgit:git-blame[1].
990 This option defaults to false.
993 Specifies the format used to output dates in linkgit:git-blame[1].
994 If unset the iso format is used. For supported values,
995 see the discussion of the `--date` option at linkgit:git-log[1].
997 branch.autoSetupMerge::
998 Tells 'git branch' and 'git checkout' to set up new branches
999 so that linkgit:git-pull[1] will appropriately merge from the
1000 starting point branch. Note that even if this option is not set,
1001 this behavior can be chosen per-branch using the `--track`
1002 and `--no-track` options. The valid settings are: `false` -- no
1003 automatic setup is done; `true` -- automatic setup is done when the
1004 starting point is a remote-tracking branch; `always` --
1005 automatic setup is done when the starting point is either a
1006 local branch or remote-tracking
1007 branch. This option defaults to true.
1009 branch.autoSetupRebase::
1010 When a new branch is created with 'git branch' or 'git checkout'
1011 that tracks another branch, this variable tells Git to set
1012 up pull to rebase instead of merge (see "branch.<name>.rebase").
1013 When `never`, rebase is never automatically set to true.
1014 When `local`, rebase is set to true for tracked branches of
1015 other local branches.
1016 When `remote`, rebase is set to true for tracked branches of
1017 remote-tracking branches.
1018 When `always`, rebase will be set to true for all tracking
1020 See "branch.autoSetupMerge" for details on how to set up a
1021 branch to track another branch.
1022 This option defaults to never.
1024 branch.<name>.remote::
1025 When on branch <name>, it tells 'git fetch' and 'git push'
1026 which remote to fetch from/push to. The remote to push to
1027 may be overridden with `remote.pushDefault` (for all branches).
1028 The remote to push to, for the current branch, may be further
1029 overridden by `branch.<name>.pushRemote`. If no remote is
1030 configured, or if you are not on any branch, it defaults to
1031 `origin` for fetching and `remote.pushDefault` for pushing.
1032 Additionally, `.` (a period) is the current local repository
1033 (a dot-repository), see `branch.<name>.merge`'s final note below.
1035 branch.<name>.pushRemote::
1036 When on branch <name>, it overrides `branch.<name>.remote` for
1037 pushing. It also overrides `remote.pushDefault` for pushing
1038 from branch <name>. When you pull from one place (e.g. your
1039 upstream) and push to another place (e.g. your own publishing
1040 repository), you would want to set `remote.pushDefault` to
1041 specify the remote to push to for all branches, and use this
1042 option to override it for a specific branch.
1044 branch.<name>.merge::
1045 Defines, together with branch.<name>.remote, the upstream branch
1046 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1047 branch to merge and can also affect 'git push' (see push.default).
1048 When in branch <name>, it tells 'git fetch' the default
1049 refspec to be marked for merging in FETCH_HEAD. The value is
1050 handled like the remote part of a refspec, and must match a
1051 ref which is fetched from the remote given by
1052 "branch.<name>.remote".
1053 The merge information is used by 'git pull' (which at first calls
1054 'git fetch') to lookup the default branch for merging. Without
1055 this option, 'git pull' defaults to merge the first refspec fetched.
1056 Specify multiple values to get an octopus merge.
1057 If you wish to setup 'git pull' so that it merges into <name> from
1058 another branch in the local repository, you can point
1059 branch.<name>.merge to the desired branch, and use the relative path
1060 setting `.` (a period) for branch.<name>.remote.
1062 branch.<name>.mergeOptions::
1063 Sets default options for merging into branch <name>. The syntax and
1064 supported options are the same as those of linkgit:git-merge[1], but
1065 option values containing whitespace characters are currently not
1068 branch.<name>.rebase::
1069 When true, rebase the branch <name> on top of the fetched branch,
1070 instead of merging the default branch from the default remote when
1071 "git pull" is run. See "pull.rebase" for doing this in a non
1072 branch-specific manner.
1074 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1075 so that the local merge commits are included in the rebase (see
1076 linkgit:git-rebase[1] for details).
1078 When preserve, also pass `--preserve-merges` along to 'git rebase'
1079 so that locally committed merge commits will not be flattened
1080 by running 'git pull'.
1082 When the value is `interactive`, the rebase is run in interactive mode.
1084 *NOTE*: this is a possibly dangerous operation; do *not* use
1085 it unless you understand the implications (see linkgit:git-rebase[1]
1088 branch.<name>.description::
1089 Branch description, can be edited with
1090 `git branch --edit-description`. Branch description is
1091 automatically added in the format-patch cover letter or
1092 request-pull summary.
1094 browser.<tool>.cmd::
1095 Specify the command to invoke the specified browser. The
1096 specified command is evaluated in shell with the URLs passed
1097 as arguments. (See linkgit:git-web{litdd}browse[1].)
1099 browser.<tool>.path::
1100 Override the path for the given tool that may be used to
1101 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1102 working repository in gitweb (see linkgit:git-instaweb[1]).
1104 clean.requireForce::
1105 A boolean to make git-clean do nothing unless given -f,
1106 -i or -n. Defaults to true.
1109 A boolean to enable/disable color in hints (e.g. when a push
1110 failed, see `advice.*` for a list). May be set to `always`,
1111 `false` (or `never`) or `auto` (or `true`), in which case colors
1112 are used only when the error output goes to a terminal. If
1113 unset, then the value of `color.ui` is used (`auto` by default).
1116 Use customized color for hints.
1119 A boolean to enable/disable color in the output of
1120 linkgit:git-branch[1]. May be set to `always`,
1121 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1122 only when the output is to a terminal. If unset, then the
1123 value of `color.ui` is used (`auto` by default).
1125 color.branch.<slot>::
1126 Use customized color for branch coloration. `<slot>` is one of
1127 `current` (the current branch), `local` (a local branch),
1128 `remote` (a remote-tracking branch in refs/remotes/),
1129 `upstream` (upstream tracking branch), `plain` (other
1133 Whether to use ANSI escape sequences to add color to patches.
1134 If this is set to `always`, linkgit:git-diff[1],
1135 linkgit:git-log[1], and linkgit:git-show[1] will use color
1136 for all patches. If it is set to `true` or `auto`, those
1137 commands will only use color when output is to the terminal.
1138 If unset, then the value of `color.ui` is used (`auto` by
1141 This does not affect linkgit:git-format-patch[1] or the
1142 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1143 command line with the `--color[=<when>]` option.
1146 If set to either a valid `<mode>` or a true value, moved lines
1147 in a diff are colored differently, for details of valid modes
1148 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1149 true the default color mode will be used. When set to false,
1150 moved lines are not colored.
1153 Use customized color for diff colorization. `<slot>` specifies
1154 which part of the patch to use the specified color, and is one
1155 of `context` (context text - `plain` is a historical synonym),
1156 `meta` (metainformation), `frag`
1157 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1158 `new` (added lines), `commit` (commit headers), `whitespace`
1159 (highlighting whitespace errors), `oldMoved` (deleted lines),
1160 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1161 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1162 and `newMovedAlternativeDimmed` (See the '<mode>'
1163 setting of '--color-moved' in linkgit:git-diff[1] for details).
1165 color.decorate.<slot>::
1166 Use customized color for 'git log --decorate' output. `<slot>` is one
1167 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1168 branches, remote-tracking branches, tags, stash and HEAD, respectively
1169 and `grafted` for grafted commits.
1172 When set to `always`, always highlight matches. When `false` (or
1173 `never`), never. When set to `true` or `auto`, use color only
1174 when the output is written to the terminal. If unset, then the
1175 value of `color.ui` is used (`auto` by default).
1178 Use customized color for grep colorization. `<slot>` specifies which
1179 part of the line to use the specified color, and is one of
1183 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1185 filename prefix (when not using `-h`)
1187 function name lines (when using `-p`)
1189 line number prefix (when using `-n`)
1191 column number prefix (when using `--column`)
1193 matching text (same as setting `matchContext` and `matchSelected`)
1195 matching text in context lines
1197 matching text in selected lines
1199 non-matching text in selected lines
1201 separators between fields on a line (`:`, `-`, and `=`)
1202 and between hunks (`--`)
1206 When set to `always`, always use colors for interactive prompts
1207 and displays (such as those used by "git-add --interactive" and
1208 "git-clean --interactive"). When false (or `never`), never.
1209 When set to `true` or `auto`, use colors only when the output is
1210 to the terminal. If unset, then the value of `color.ui` is
1211 used (`auto` by default).
1213 color.interactive.<slot>::
1214 Use customized color for 'git add --interactive' and 'git clean
1215 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1216 or `error`, for four distinct types of normal output from
1217 interactive commands.
1220 A boolean to enable/disable colored output when the pager is in
1221 use (default is true).
1224 A boolean to enable/disable color in push errors. May be set to
1225 `always`, `false` (or `never`) or `auto` (or `true`), in which
1226 case colors are used only when the error output goes to a terminal.
1227 If unset, then the value of `color.ui` is used (`auto` by default).
1230 Use customized color for push errors.
1233 A boolean to enable/disable color in the output of
1234 linkgit:git-show-branch[1]. May be set to `always`,
1235 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1236 only when the output is to a terminal. If unset, then the
1237 value of `color.ui` is used (`auto` by default).
1240 A boolean to enable/disable color in the output of
1241 linkgit:git-status[1]. May be set to `always`,
1242 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1243 only when the output is to a terminal. If unset, then the
1244 value of `color.ui` is used (`auto` by default).
1246 color.status.<slot>::
1247 Use customized color for status colorization. `<slot>` is
1248 one of `header` (the header text of the status message),
1249 `added` or `updated` (files which are added but not committed),
1250 `changed` (files which are changed but not added in the index),
1251 `untracked` (files which are not tracked by Git),
1252 `branch` (the current branch),
1253 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1255 `localBranch` or `remoteBranch` (the local and remote branch names,
1256 respectively, when branch and tracking information is displayed in the
1257 status short-format), or
1258 `unmerged` (files which have unmerged changes).
1260 color.blame.repeatedLines::
1261 Use the customized color for the part of git-blame output that
1262 is repeated meta information per line (such as commit id,
1263 author name, date and timezone). Defaults to cyan.
1265 color.blame.highlightRecent::
1266 This can be used to color the metadata of a blame line depending
1269 This setting should be set to a comma-separated list of color and date settings,
1270 starting and ending with a color, the dates should be set from oldest to newest.
1271 The metadata will be colored given the colors if the the line was introduced
1272 before the given timestamp, overwriting older timestamped colors.
1274 Instead of an absolute timestamp relative timestamps work as well, e.g.
1275 2.weeks.ago is valid to address anything older than 2 weeks.
1277 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1278 everything older than one year blue, recent changes between one month and
1279 one year old are kept white, and lines introduced within the last month are
1283 This determines the coloring scheme to be applied to blame
1284 output. It can be 'repeatedLines', 'highlightRecent',
1285 or 'none' which is the default.
1288 A boolean to enable/disable color when pushes are rejected. May be
1289 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1290 case colors are used only when the error output goes to a terminal.
1291 If unset, then the value of `color.ui` is used (`auto` by default).
1293 color.transport.rejected::
1294 Use customized color when a push was rejected.
1297 This variable determines the default value for variables such
1298 as `color.diff` and `color.grep` that control the use of color
1299 per command family. Its scope will expand as more commands learn
1300 configuration to set a default for the `--color` option. Set it
1301 to `false` or `never` if you prefer Git commands not to use
1302 color unless enabled explicitly with some other configuration
1303 or the `--color` option. Set it to `always` if you want all
1304 output not intended for machine consumption to use color, to
1305 `true` or `auto` (this is the default since Git 1.8.4) if you
1306 want such output to use color when written to the terminal.
1309 Specify whether supported commands should output in columns.
1310 This variable consists of a list of tokens separated by spaces
1313 These options control when the feature should be enabled
1314 (defaults to 'never'):
1318 always show in columns
1320 never show in columns
1322 show in columns if the output is to the terminal
1325 These options control layout (defaults to 'column'). Setting any
1326 of these implies 'always' if none of 'always', 'never', or 'auto' are
1331 fill columns before rows
1333 fill rows before columns
1338 Finally, these options can be combined with a layout option (defaults
1343 make unequal size columns to utilize more space
1345 make equal size columns
1349 Specify whether to output branch listing in `git branch` in columns.
1350 See `column.ui` for details.
1353 Specify the layout when list items in `git clean -i`, which always
1354 shows files and directories in columns. See `column.ui` for details.
1357 Specify whether to output untracked files in `git status` in columns.
1358 See `column.ui` for details.
1361 Specify whether to output tag listing in `git tag` in columns.
1362 See `column.ui` for details.
1365 This setting overrides the default of the `--cleanup` option in
1366 `git commit`. See linkgit:git-commit[1] for details. Changing the
1367 default can be useful when you always want to keep lines that begin
1368 with comment character `#` in your log message, in which case you
1369 would do `git config commit.cleanup whitespace` (note that you will
1370 have to remove the help lines that begin with `#` in the commit log
1371 template yourself, if you do this).
1375 A boolean to specify whether all commits should be GPG signed.
1376 Use of this option when doing operations such as rebase can
1377 result in a large number of commits being signed. It may be
1378 convenient to use an agent to avoid typing your GPG passphrase
1382 A boolean to enable/disable inclusion of status information in the
1383 commit message template when using an editor to prepare the commit
1384 message. Defaults to true.
1387 Specify the pathname of a file to use as the template for
1388 new commit messages.
1391 A boolean or int to specify the level of verbose with `git commit`.
1392 See linkgit:git-commit[1].
1395 Specify an external helper to be called when a username or
1396 password credential is needed; the helper may consult external
1397 storage to avoid prompting the user for the credentials. Note
1398 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1401 credential.useHttpPath::
1402 When acquiring credentials, consider the "path" component of an http
1403 or https URL to be important. Defaults to false. See
1404 linkgit:gitcredentials[7] for more information.
1406 credential.username::
1407 If no username is set for a network authentication, use this username
1408 by default. See credential.<context>.* below, and
1409 linkgit:gitcredentials[7].
1411 credential.<url>.*::
1412 Any of the credential.* options above can be applied selectively to
1413 some credentials. For example "credential.https://example.com.username"
1414 would set the default username only for https connections to
1415 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1418 credentialCache.ignoreSIGHUP::
1419 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1421 completion.commands::
1422 This is only used by git-completion.bash to add or remove
1423 commands from the list of completed commands. Normally only
1424 porcelain commands and a few select others are completed. You
1425 can add more commands, separated by space, in this
1426 variable. Prefixing the command with '-' will remove it from
1429 include::diff-config.txt[]
1431 difftool.<tool>.path::
1432 Override the path for the given tool. This is useful in case
1433 your tool is not in the PATH.
1435 difftool.<tool>.cmd::
1436 Specify the command to invoke the specified diff tool.
1437 The specified command is evaluated in shell with the following
1438 variables available: 'LOCAL' is set to the name of the temporary
1439 file containing the contents of the diff pre-image and 'REMOTE'
1440 is set to the name of the temporary file containing the contents
1441 of the diff post-image.
1444 Prompt before each invocation of the diff tool.
1446 fastimport.unpackLimit::
1447 If the number of objects imported by linkgit:git-fast-import[1]
1448 is below this limit, then the objects will be unpacked into
1449 loose object files. However if the number of imported objects
1450 equals or exceeds this limit then the pack will be stored as a
1451 pack. Storing the pack from a fast-import can make the import
1452 operation complete faster, especially on slow filesystems. If
1453 not set, the value of `transfer.unpackLimit` is used instead.
1455 fetch.recurseSubmodules::
1456 This option can be either set to a boolean value or to 'on-demand'.
1457 Setting it to a boolean changes the behavior of fetch and pull to
1458 unconditionally recurse into submodules when set to true or to not
1459 recurse at all when set to false. When set to 'on-demand' (the default
1460 value), fetch and pull will only recurse into a populated submodule
1461 when its superproject retrieves a commit that updates the submodule's
1465 If it is set to true, git-fetch-pack will check all fetched
1466 objects. See `transfer.fsckObjects` for what's
1467 checked. Defaults to false. If not set, the value of
1468 `transfer.fsckObjects` is used instead.
1470 fetch.fsck.<msg-id>::
1471 Acts like `fsck.<msg-id>`, but is used by
1472 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1473 the `fsck.<msg-id>` documentation for details.
1475 fetch.fsck.skipList::
1476 Acts like `fsck.skipList`, but is used by
1477 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1478 the `fsck.skipList` documentation for details.
1481 If the number of objects fetched over the Git native
1482 transfer is below this
1483 limit, then the objects will be unpacked into loose object
1484 files. However if the number of received objects equals or
1485 exceeds this limit then the received pack will be stored as
1486 a pack, after adding any missing delta bases. Storing the
1487 pack from a push can make the push operation complete faster,
1488 especially on slow filesystems. If not set, the value of
1489 `transfer.unpackLimit` is used instead.
1492 If true, fetch will automatically behave as if the `--prune`
1493 option was given on the command line. See also `remote.<name>.prune`
1494 and the PRUNING section of linkgit:git-fetch[1].
1497 If true, fetch will automatically behave as if the
1498 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1499 if not set already. This allows for setting both this option
1500 and `fetch.prune` to maintain a 1=1 mapping to upstream
1501 refs. See also `remote.<name>.pruneTags` and the PRUNING
1502 section of linkgit:git-fetch[1].
1505 Control how ref update status is printed. Valid values are
1506 `full` and `compact`. Default value is `full`. See section
1507 OUTPUT in linkgit:git-fetch[1] for detail.
1510 Enable multipart/mixed attachments as the default for
1511 'format-patch'. The value can also be a double quoted string
1512 which will enable attachments as the default and set the
1513 value as the boundary. See the --attach option in
1514 linkgit:git-format-patch[1].
1517 Provides the default value for the `--from` option to format-patch.
1518 Accepts a boolean value, or a name and email address. If false,
1519 format-patch defaults to `--no-from`, using commit authors directly in
1520 the "From:" field of patch mails. If true, format-patch defaults to
1521 `--from`, using your committer identity in the "From:" field of patch
1522 mails and including a "From:" field in the body of the patch mail if
1523 different. If set to a non-boolean value, format-patch uses that
1524 value instead of your committer identity. Defaults to false.
1527 A boolean which can enable or disable sequence numbers in patch
1528 subjects. It defaults to "auto" which enables it only if there
1529 is more than one patch. It can be enabled or disabled for all
1530 messages by setting it to "true" or "false". See --numbered
1531 option in linkgit:git-format-patch[1].
1534 Additional email headers to include in a patch to be submitted
1535 by mail. See linkgit:git-format-patch[1].
1539 Additional recipients to include in a patch to be submitted
1540 by mail. See the --to and --cc options in
1541 linkgit:git-format-patch[1].
1543 format.subjectPrefix::
1544 The default for format-patch is to output files with the '[PATCH]'
1545 subject prefix. Use this variable to change that prefix.
1548 The default for format-patch is to output a signature containing
1549 the Git version number. Use this variable to change that default.
1550 Set this variable to the empty string ("") to suppress
1551 signature generation.
1553 format.signatureFile::
1554 Works just like format.signature except the contents of the
1555 file specified by this variable will be used as the signature.
1558 The default for format-patch is to output files with the suffix
1559 `.patch`. Use this variable to change that suffix (make sure to
1560 include the dot if you want it).
1563 The default pretty format for log/show/whatchanged command,
1564 See linkgit:git-log[1], linkgit:git-show[1],
1565 linkgit:git-whatchanged[1].
1568 The default threading style for 'git format-patch'. Can be
1569 a boolean value, or `shallow` or `deep`. `shallow` threading
1570 makes every mail a reply to the head of the series,
1571 where the head is chosen from the cover letter, the
1572 `--in-reply-to`, and the first patch mail, in this order.
1573 `deep` threading makes every mail a reply to the previous one.
1574 A true boolean value is the same as `shallow`, and a false
1575 value disables threading.
1578 A boolean value which lets you enable the `-s/--signoff` option of
1579 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1580 patch should be a conscious act and means that you certify you have
1581 the rights to submit this work under the same open source license.
1582 Please see the 'SubmittingPatches' document for further discussion.
1584 format.coverLetter::
1585 A boolean that controls whether to generate a cover-letter when
1586 format-patch is invoked, but in addition can be set to "auto", to
1587 generate a cover-letter only when there's more than one patch.
1589 format.outputDirectory::
1590 Set a custom directory to store the resulting files instead of the
1591 current working directory.
1593 format.useAutoBase::
1594 A boolean value which lets you enable the `--base=auto` option of
1595 format-patch by default.
1597 filter.<driver>.clean::
1598 The command which is used to convert the content of a worktree
1599 file to a blob upon checkin. See linkgit:gitattributes[5] for
1602 filter.<driver>.smudge::
1603 The command which is used to convert the content of a blob
1604 object to a worktree file upon checkout. See
1605 linkgit:gitattributes[5] for details.
1608 During fsck git may find issues with legacy data which
1609 wouldn't be generated by current versions of git, and which
1610 wouldn't be sent over the wire if `transfer.fsckObjects` was
1611 set. This feature is intended to support working with legacy
1612 repositories containing such data.
1614 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1615 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1616 to clone or fetch it set `fetch.fsck.<msg-id>`.
1618 The rest of the documentation discusses `fsck.*` for brevity, but the
1619 same applies for the corresponding `receive.fsck.*` and
1620 `fetch.<msg-id>.*`. variables.
1622 When `fsck.<msg-id>` is set, errors can be switched to warnings and
1623 vice versa by configuring the `fsck.<msg-id>` setting where the
1624 `<msg-id>` is the fsck message ID and the value is one of `error`,
1625 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
1626 with the message ID, e.g. "missingEmail: invalid author/committer line
1627 - missing email" means that setting `fsck.missingEmail = ignore` will
1630 In general, it is better to enumerate existing objects with problems
1631 with `fsck.skipList`, instead of listing the kind of breakages these
1632 problematic objects share to be ignored, as doing the latter will
1633 allow new instances of the same breakages go unnoticed.
1636 The path to a sorted list of object names (i.e. one SHA-1 per
1637 line) that are known to be broken in a non-fatal way and should
1638 be ignored. This feature is useful when an established project
1639 should be accepted despite early commits containing errors that
1640 can be safely ignored such as invalid committer email addresses.
1641 Note: corrupt objects cannot be skipped with this setting.
1643 Like `fsck.<msg-id>` this variable has corresponding
1644 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1646 gc.aggressiveDepth::
1647 The depth parameter used in the delta compression
1648 algorithm used by 'git gc --aggressive'. This defaults
1651 gc.aggressiveWindow::
1652 The window size parameter used in the delta compression
1653 algorithm used by 'git gc --aggressive'. This defaults
1657 When there are approximately more than this many loose
1658 objects in the repository, `git gc --auto` will pack them.
1659 Some Porcelain commands use this command to perform a
1660 light-weight garbage collection from time to time. The
1661 default value is 6700. Setting this to 0 disables it.
1664 When there are more than this many packs that are not
1665 marked with `*.keep` file in the repository, `git gc
1666 --auto` consolidates them into one larger pack. The
1667 default value is 50. Setting this to 0 disables it.
1670 Make `git gc --auto` return immediately and run in background
1671 if the system supports it. Default is true.
1673 gc.bigPackThreshold::
1674 If non-zero, all packs larger than this limit are kept when
1675 `git gc` is run. This is very similar to `--keep-base-pack`
1676 except that all packs that meet the threshold are kept, not
1677 just the base pack. Defaults to zero. Common unit suffixes of
1678 'k', 'm', or 'g' are supported.
1680 Note that if the number of kept packs is more than gc.autoPackLimit,
1681 this configuration variable is ignored, all packs except the base pack
1682 will be repacked. After this the number of packs should go below
1683 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1686 If the file gc.log exists, then `git gc --auto` won't run
1687 unless that file is more than 'gc.logExpiry' old. Default is
1688 "1.day". See `gc.pruneExpire` for more ways to specify its
1692 Running `git pack-refs` in a repository renders it
1693 unclonable by Git versions prior to 1.5.1.2 over dumb
1694 transports such as HTTP. This variable determines whether
1695 'git gc' runs `git pack-refs`. This can be set to `notbare`
1696 to enable it within all non-bare repos or it can be set to a
1697 boolean value. The default is `true`.
1700 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1701 Override the grace period with this config variable. The value
1702 "now" may be used to disable this grace period and always prune
1703 unreachable objects immediately, or "never" may be used to
1704 suppress pruning. This feature helps prevent corruption when
1705 'git gc' runs concurrently with another process writing to the
1706 repository; see the "NOTES" section of linkgit:git-gc[1].
1708 gc.worktreePruneExpire::
1709 When 'git gc' is run, it calls
1710 'git worktree prune --expire 3.months.ago'.
1711 This config variable can be used to set a different grace
1712 period. The value "now" may be used to disable the grace
1713 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1714 may be used to suppress pruning.
1717 gc.<pattern>.reflogExpire::
1718 'git reflog expire' removes reflog entries older than
1719 this time; defaults to 90 days. The value "now" expires all
1720 entries immediately, and "never" suppresses expiration
1721 altogether. With "<pattern>" (e.g.
1722 "refs/stash") in the middle the setting applies only to
1723 the refs that match the <pattern>.
1725 gc.reflogExpireUnreachable::
1726 gc.<pattern>.reflogExpireUnreachable::
1727 'git reflog expire' removes reflog entries older than
1728 this time and are not reachable from the current tip;
1729 defaults to 30 days. The value "now" expires all entries
1730 immediately, and "never" suppresses expiration altogether.
1731 With "<pattern>" (e.g. "refs/stash")
1732 in the middle, the setting applies only to the refs that
1733 match the <pattern>.
1736 Records of conflicted merge you resolved earlier are
1737 kept for this many days when 'git rerere gc' is run.
1738 You can also use more human-readable "1.month.ago", etc.
1739 The default is 60 days. See linkgit:git-rerere[1].
1741 gc.rerereUnresolved::
1742 Records of conflicted merge you have not resolved are
1743 kept for this many days when 'git rerere gc' is run.
1744 You can also use more human-readable "1.month.ago", etc.
1745 The default is 15 days. See linkgit:git-rerere[1].
1747 gitcvs.commitMsgAnnotation::
1748 Append this string to each commit message. Set to empty string
1749 to disable this feature. Defaults to "via git-CVS emulator".
1752 Whether the CVS server interface is enabled for this repository.
1753 See linkgit:git-cvsserver[1].
1756 Path to a log file where the CVS server interface well... logs
1757 various stuff. See linkgit:git-cvsserver[1].
1759 gitcvs.usecrlfattr::
1760 If true, the server will look up the end-of-line conversion
1761 attributes for files to determine the `-k` modes to use. If
1762 the attributes force Git to treat a file as text,
1763 the `-k` mode will be left blank so CVS clients will
1764 treat it as text. If they suppress text conversion, the file
1765 will be set with '-kb' mode, which suppresses any newline munging
1766 the client might otherwise do. If the attributes do not allow
1767 the file type to be determined, then `gitcvs.allBinary` is
1768 used. See linkgit:gitattributes[5].
1771 This is used if `gitcvs.usecrlfattr` does not resolve
1772 the correct '-kb' mode to use. If true, all
1773 unresolved files are sent to the client in
1774 mode '-kb'. This causes the client to treat them
1775 as binary files, which suppresses any newline munging it
1776 otherwise might do. Alternatively, if it is set to "guess",
1777 then the contents of the file are examined to decide if
1778 it is binary, similar to `core.autocrlf`.
1781 Database used by git-cvsserver to cache revision information
1782 derived from the Git repository. The exact meaning depends on the
1783 used database driver, for SQLite (which is the default driver) this
1784 is a filename. Supports variable substitution (see
1785 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1786 Default: '%Ggitcvs.%m.sqlite'
1789 Used Perl DBI driver. You can specify any available driver
1790 for this here, but it might not work. git-cvsserver is tested
1791 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1792 reported *not* to work with 'DBD::mysql'. Experimental feature.
1793 May not contain double colons (`:`). Default: 'SQLite'.
1794 See linkgit:git-cvsserver[1].
1796 gitcvs.dbUser, gitcvs.dbPass::
1797 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1798 since SQLite has no concept of database users and/or passwords.
1799 'gitcvs.dbUser' supports variable substitution (see
1800 linkgit:git-cvsserver[1] for details).
1802 gitcvs.dbTableNamePrefix::
1803 Database table name prefix. Prepended to the names of any
1804 database tables used, allowing a single database to be used
1805 for several repositories. Supports variable substitution (see
1806 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1807 characters will be replaced with underscores.
1809 All gitcvs variables except for `gitcvs.usecrlfattr` and
1810 `gitcvs.allBinary` can also be specified as
1811 'gitcvs.<access_method>.<varname>' (where 'access_method'
1812 is one of "ext" and "pserver") to make them apply only for the given
1816 gitweb.description::
1819 See linkgit:gitweb[1] for description.
1827 gitweb.remote_heads::
1830 See linkgit:gitweb.conf[5] for description.
1833 If set to true, enable `-n` option by default.
1836 If set to true, enable the `--column` option by default.
1839 Set the default matching behavior. Using a value of 'basic', 'extended',
1840 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1841 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1842 value 'default' will return to the default matching behavior.
1844 grep.extendedRegexp::
1845 If set to true, enable `--extended-regexp` option by default. This
1846 option is ignored when the `grep.patternType` option is set to a value
1847 other than 'default'.
1850 Number of grep worker threads to use.
1851 See `grep.threads` in linkgit:git-grep[1] for more information.
1853 grep.fallbackToNoIndex::
1854 If set to true, fall back to git grep --no-index if git grep
1855 is executed outside of a git repository. Defaults to false.
1858 Use this custom program instead of "`gpg`" found on `$PATH` when
1859 making or verifying a PGP signature. The program must support the
1860 same command-line interface as GPG, namely, to verify a detached
1861 signature, "`gpg --verify $file - <$signature`" is run, and the
1862 program is expected to signal a good signature by exiting with
1863 code 0, and to generate an ASCII-armored detached signature, the
1864 standard input of "`gpg -bsau $key`" is fed with the contents to be
1865 signed, and the program is expected to send the result to its
1868 gui.commitMsgWidth::
1869 Defines how wide the commit message window is in the
1870 linkgit:git-gui[1]. "75" is the default.
1873 Specifies how many context lines should be used in calls to diff
1874 made by the linkgit:git-gui[1]. The default is "5".
1876 gui.displayUntracked::
1877 Determines if linkgit:git-gui[1] shows untracked files
1878 in the file list. The default is "true".
1881 Specifies the default encoding to use for displaying of
1882 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1883 It can be overridden by setting the 'encoding' attribute
1884 for relevant files (see linkgit:gitattributes[5]).
1885 If this option is not set, the tools default to the
1888 gui.matchTrackingBranch::
1889 Determines if new branches created with linkgit:git-gui[1] should
1890 default to tracking remote branches with matching names or
1891 not. Default: "false".
1893 gui.newBranchTemplate::
1894 Is used as suggested name when creating new branches using the
1897 gui.pruneDuringFetch::
1898 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1899 performing a fetch. The default value is "false".
1902 Determines if linkgit:git-gui[1] should trust the file modification
1903 timestamp or not. By default the timestamps are not trusted.
1905 gui.spellingDictionary::
1906 Specifies the dictionary used for spell checking commit messages in
1907 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1911 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1912 location detection. It makes blame significantly faster on huge
1913 repositories at the expense of less thorough copy detection.
1915 gui.copyBlameThreshold::
1916 Specifies the threshold to use in 'git gui blame' original location
1917 detection, measured in alphanumeric characters. See the
1918 linkgit:git-blame[1] manual for more information on copy detection.
1920 gui.blamehistoryctx::
1921 Specifies the radius of history context in days to show in
1922 linkgit:gitk[1] for the selected commit, when the `Show History
1923 Context` menu item is invoked from 'git gui blame'. If this
1924 variable is set to zero, the whole history is shown.
1926 guitool.<name>.cmd::
1927 Specifies the shell command line to execute when the corresponding item
1928 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1929 mandatory for every tool. The command is executed from the root of
1930 the working directory, and in the environment it receives the name of
1931 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1932 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1933 the head is detached, 'CUR_BRANCH' is empty).
1935 guitool.<name>.needsFile::
1936 Run the tool only if a diff is selected in the GUI. It guarantees
1937 that 'FILENAME' is not empty.
1939 guitool.<name>.noConsole::
1940 Run the command silently, without creating a window to display its
1943 guitool.<name>.noRescan::
1944 Don't rescan the working directory for changes after the tool
1947 guitool.<name>.confirm::
1948 Show a confirmation dialog before actually running the tool.
1950 guitool.<name>.argPrompt::
1951 Request a string argument from the user, and pass it to the tool
1952 through the `ARGS` environment variable. Since requesting an
1953 argument implies confirmation, the 'confirm' option has no effect
1954 if this is enabled. If the option is set to 'true', 'yes', or '1',
1955 the dialog uses a built-in generic prompt; otherwise the exact
1956 value of the variable is used.
1958 guitool.<name>.revPrompt::
1959 Request a single valid revision from the user, and set the
1960 `REVISION` environment variable. In other aspects this option
1961 is similar to 'argPrompt', and can be used together with it.
1963 guitool.<name>.revUnmerged::
1964 Show only unmerged branches in the 'revPrompt' subdialog.
1965 This is useful for tools similar to merge or rebase, but not
1966 for things like checkout or reset.
1968 guitool.<name>.title::
1969 Specifies the title to use for the prompt dialog. The default
1972 guitool.<name>.prompt::
1973 Specifies the general prompt string to display at the top of
1974 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1975 The default value includes the actual command.
1978 Specify the browser that will be used to display help in the
1979 'web' format. See linkgit:git-help[1].
1982 Override the default help format used by linkgit:git-help[1].
1983 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1984 the default. 'web' and 'html' are the same.
1987 Automatically correct and execute mistyped commands after
1988 waiting for the given number of deciseconds (0.1 sec). If more
1989 than one command can be deduced from the entered text, nothing
1990 will be executed. If the value of this option is negative,
1991 the corrected command will be executed immediately. If the
1992 value is 0 - the command will be just shown but not executed.
1993 This is the default.
1996 Specify the path where the HTML documentation resides. File system paths
1997 and URLs are supported. HTML pages will be prefixed with this path when
1998 help is displayed in the 'web' format. This defaults to the documentation
1999 path of your Git installation.
2002 Override the HTTP proxy, normally configured using the 'http_proxy',
2003 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2004 addition to the syntax understood by curl, it is possible to specify a
2005 proxy string with a user name but no password, in which case git will
2006 attempt to acquire one in the same way it does for other credentials. See
2007 linkgit:gitcredentials[7] for more information. The syntax thus is
2008 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2009 on a per-remote basis; see remote.<name>.proxy
2011 http.proxyAuthMethod::
2012 Set the method with which to authenticate against the HTTP proxy. This
2013 only takes effect if the configured proxy string contains a user name part
2014 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2015 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2016 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2017 variable. Possible values are:
2020 * `anyauth` - Automatically pick a suitable authentication method. It is
2021 assumed that the proxy answers an unauthenticated request with a 407
2022 status code and one or more Proxy-authenticate headers with supported
2023 authentication methods. This is the default.
2024 * `basic` - HTTP Basic authentication
2025 * `digest` - HTTP Digest authentication; this prevents the password from being
2026 transmitted to the proxy in clear text
2027 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2029 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2033 Attempt authentication without seeking a username or password. This
2034 can be used to attempt GSS-Negotiate authentication without specifying
2035 a username in the URL, as libcurl normally requires a username for
2039 Control GSSAPI credential delegation. The delegation is disabled
2040 by default in libcurl since version 7.21.7. Set parameter to tell
2041 the server what it is allowed to delegate when it comes to user
2042 credentials. Used with GSS/kerberos. Possible values are:
2045 * `none` - Don't allow any delegation.
2046 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2047 Kerberos service ticket, which is a matter of realm policy.
2048 * `always` - Unconditionally allow the server to delegate.
2053 Pass an additional HTTP header when communicating with a server. If
2054 more than one such entry exists, all of them are added as extra
2055 headers. To allow overriding the settings inherited from the system
2056 config, an empty value will reset the extra headers to the empty list.
2059 The pathname of a file containing previously stored cookie lines,
2060 which should be used
2061 in the Git http session, if they match the server. The file format
2062 of the file to read cookies from should be plain HTTP headers or
2063 the Netscape/Mozilla cookie file format (see `curl(1)`).
2064 NOTE that the file specified with http.cookieFile is used only as
2065 input unless http.saveCookies is set.
2068 If set, store cookies received during requests to the file specified by
2069 http.cookieFile. Has no effect if http.cookieFile is unset.
2072 The SSL version to use when negotiating an SSL connection, if you
2073 want to force the default. The available and default version
2074 depend on whether libcurl was built against NSS or OpenSSL and the
2075 particular configuration of the crypto library in use. Internally
2076 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2077 documentation for more details on the format of this option and
2078 for the ssl version supported. Actually the possible values of
2090 Can be overridden by the `GIT_SSL_VERSION` environment variable.
2091 To force git to use libcurl's default ssl version and ignore any
2092 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2095 http.sslCipherList::
2096 A list of SSL ciphers to use when negotiating an SSL connection.
2097 The available ciphers depend on whether libcurl was built against
2098 NSS or OpenSSL and the particular configuration of the crypto
2099 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2100 option; see the libcurl documentation for more details on the format
2103 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2104 To force git to use libcurl's default cipher list and ignore any
2105 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2109 Whether to verify the SSL certificate when fetching or pushing
2110 over HTTPS. Defaults to true. Can be overridden by the
2111 `GIT_SSL_NO_VERIFY` environment variable.
2114 File containing the SSL certificate when fetching or pushing
2115 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2119 File containing the SSL private key when fetching or pushing
2120 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2123 http.sslCertPasswordProtected::
2124 Enable Git's password prompt for the SSL certificate. Otherwise
2125 OpenSSL will prompt the user, possibly many times, if the
2126 certificate or private key is encrypted. Can be overridden by the
2127 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2130 File containing the certificates to verify the peer with when
2131 fetching or pushing over HTTPS. Can be overridden by the
2132 `GIT_SSL_CAINFO` environment variable.
2135 Path containing files with the CA certificates to verify the peer
2136 with when fetching or pushing over HTTPS. Can be overridden
2137 by the `GIT_SSL_CAPATH` environment variable.
2140 Public key of the https service. It may either be the filename of
2141 a PEM or DER encoded public key file or a string starting with
2142 'sha256//' followed by the base64 encoded sha256 hash of the
2143 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2144 exit with an error if this option is set but not supported by
2148 Attempt to use AUTH SSL/TLS and encrypted data transfers
2149 when connecting via regular FTP protocol. This might be needed
2150 if the FTP server requires it for security reasons or you wish
2151 to connect securely whenever remote FTP server supports it.
2152 Default is false since it might trigger certificate verification
2153 errors on misconfigured servers.
2156 How many HTTP requests to launch in parallel. Can be overridden
2157 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2160 The number of curl sessions (counted across slots) to be kept across
2161 requests. They will not be ended with curl_easy_cleanup() until
2162 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2163 value will be capped at 1. Defaults to 1.
2166 Maximum size in bytes of the buffer used by smart HTTP
2167 transports when POSTing data to the remote system.
2168 For requests larger than this buffer size, HTTP/1.1 and
2169 Transfer-Encoding: chunked is used to avoid creating a
2170 massive pack file locally. Default is 1 MiB, which is
2171 sufficient for most requests.
2173 http.lowSpeedLimit, http.lowSpeedTime::
2174 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2175 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2176 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2177 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2180 A boolean which disables using of EPSV ftp command by curl.
2181 This can helpful with some "poor" ftp servers which don't
2182 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2183 environment variable. Default is false (curl will use EPSV).
2186 The HTTP USER_AGENT string presented to an HTTP server. The default
2187 value represents the version of the client Git such as git/1.7.1.
2188 This option allows you to override this value to a more common value
2189 such as Mozilla/4.0. This may be necessary, for instance, if
2190 connecting through a firewall that restricts HTTP connections to a set
2191 of common USER_AGENT strings (but not including those like git/1.7.1).
2192 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2194 http.followRedirects::
2195 Whether git should follow HTTP redirects. If set to `true`, git
2196 will transparently follow any redirect issued by a server it
2197 encounters. If set to `false`, git will treat all redirects as
2198 errors. If set to `initial`, git will follow redirects only for
2199 the initial request to a remote, but not for subsequent
2200 follow-up HTTP requests. Since git uses the redirected URL as
2201 the base for the follow-up requests, this is generally
2202 sufficient. The default is `initial`.
2205 Any of the http.* options above can be applied selectively to some URLs.
2206 For a config key to match a URL, each element of the config key is
2207 compared to that of the URL, in the following order:
2210 . Scheme (e.g., `https` in `https://example.com/`). This field
2211 must match exactly between the config key and the URL.
2213 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2214 This field must match between the config key and the URL. It is
2215 possible to specify a `*` as part of the host name to match all subdomains
2216 at this level. `https://*.example.com/` for example would match
2217 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2219 . Port number (e.g., `8080` in `http://example.com:8080/`).
2220 This field must match exactly between the config key and the URL.
2221 Omitted port numbers are automatically converted to the correct
2222 default for the scheme before matching.
2224 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2225 path field of the config key must match the path field of the URL
2226 either exactly or as a prefix of slash-delimited path elements. This means
2227 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2228 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2229 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2230 key with just path `foo/`).
2232 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2233 the config key has a user name it must match the user name in the
2234 URL exactly. If the config key does not have a user name, that
2235 config key will match a URL with any user name (including none),
2236 but at a lower precedence than a config key with a user name.
2239 The list above is ordered by decreasing precedence; a URL that matches
2240 a config key's path is preferred to one that matches its user name. For example,
2241 if the URL is `https://user@example.com/foo/bar` a config key match of
2242 `https://example.com/foo` will be preferred over a config key match of
2243 `https://user@example.com`.
2245 All URLs are normalized before attempting any matching (the password part,
2246 if embedded in the URL, is always ignored for matching purposes) so that
2247 equivalent URLs that are simply spelled differently will match properly.
2248 Environment variable settings always override any matches. The URLs that are
2249 matched against are those given directly to Git commands. This means any URLs
2250 visited as a result of a redirection do not participate in matching.
2253 By default, Git determines the command line arguments to use
2254 based on the basename of the configured SSH command (configured
2255 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2256 the config setting `core.sshCommand`). If the basename is
2257 unrecognized, Git will attempt to detect support of OpenSSH
2258 options by first invoking the configured SSH command with the
2259 `-G` (print configuration) option and will subsequently use
2260 OpenSSH options (if that is successful) or no options besides
2261 the host and remote command (if it fails).
2263 The config variable `ssh.variant` can be set to override this detection.
2264 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2265 `tortoiseplink`, `simple` (no options except the host and remote command).
2266 The default auto-detection can be explicitly requested using the value
2267 `auto`. Any other value is treated as `ssh`. This setting can also be
2268 overridden via the environment variable `GIT_SSH_VARIANT`.
2270 The current command-line parameters used for each variant are as
2275 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2277 * `simple` - [username@]host command
2279 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2281 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2285 Except for the `simple` variant, command-line parameters are likely to
2286 change as git gains new features.
2288 i18n.commitEncoding::
2289 Character encoding the commit messages are stored in; Git itself
2290 does not care per se, but this information is necessary e.g. when
2291 importing commits from emails or in the gitk graphical history
2292 browser (and possibly at other places in the future or in other
2293 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2295 i18n.logOutputEncoding::
2296 Character encoding the commit messages are converted to when
2297 running 'git log' and friends.
2300 The configuration variables in the 'imap' section are described
2301 in linkgit:git-imap-send[1].
2304 Specify the version with which new index files should be
2305 initialized. This does not affect existing repositories.
2308 Specify the directory from which templates will be copied.
2309 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2312 Specify the program that will be used to browse your working
2313 repository in gitweb. See linkgit:git-instaweb[1].
2316 The HTTP daemon command-line to start gitweb on your working
2317 repository. See linkgit:git-instaweb[1].
2320 If true the web server started by linkgit:git-instaweb[1] will
2321 be bound to the local IP (127.0.0.1).
2323 instaweb.modulePath::
2324 The default module path for linkgit:git-instaweb[1] to use
2325 instead of /usr/lib/apache2/modules. Only used if httpd
2329 The port number to bind the gitweb httpd to. See
2330 linkgit:git-instaweb[1].
2332 interactive.singleKey::
2333 In interactive commands, allow the user to provide one-letter
2334 input with a single key (i.e., without hitting enter).
2335 Currently this is used by the `--patch` mode of
2336 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2337 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2338 setting is silently ignored if portable keystroke input
2339 is not available; requires the Perl module Term::ReadKey.
2341 interactive.diffFilter::
2342 When an interactive command (such as `git add --patch`) shows
2343 a colorized diff, git will pipe the diff through the shell
2344 command defined by this configuration variable. The command may
2345 mark up the diff further for human consumption, provided that it
2346 retains a one-to-one correspondence with the lines in the
2347 original diff. Defaults to disabled (no filtering).
2350 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2351 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2352 override this option with `--no-abbrev-commit`.
2355 Set the default date-time mode for the 'log' command.
2356 Setting a value for log.date is similar to using 'git log''s
2357 `--date` option. See linkgit:git-log[1] for details.
2360 Print out the ref names of any commits that are shown by the log
2361 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2362 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2363 specified, the full ref name (including prefix) will be printed.
2364 If 'auto' is specified, then if the output is going to a terminal,
2365 the ref names are shown as if 'short' were given, otherwise no ref
2366 names are shown. This is the same as the `--decorate` option
2370 If `true`, `git log` will act as if the `--follow` option was used when
2371 a single <path> is given. This has the same limitations as `--follow`,
2372 i.e. it cannot be used to follow multiple files and does not work well
2373 on non-linear history.
2376 A list of colors, separated by commas, that can be used to draw
2377 history lines in `git log --graph`.
2380 If true, the initial commit will be shown as a big creation event.
2381 This is equivalent to a diff against an empty tree.
2382 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2383 normally hide the root commit will now show it. True by default.
2386 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2387 linkgit:git-whatchanged[1] assume `--show-signature`.
2390 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2391 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2394 If true, makes linkgit:git-mailinfo[1] (and therefore
2395 linkgit:git-am[1]) act by default as if the --scissors option
2396 was provided on the command-line. When active, this features
2397 removes everything from the message body before a scissors
2398 line (i.e. consisting mainly of ">8", "8<" and "-").
2401 The location of an augmenting mailmap file. The default
2402 mailmap, located in the root of the repository, is loaded
2403 first, then the mailmap file pointed to by this variable.
2404 The location of the mailmap file may be in a repository
2405 subdirectory, or somewhere outside of the repository itself.
2406 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2409 Like `mailmap.file`, but consider the value as a reference to a
2410 blob in the repository. If both `mailmap.file` and
2411 `mailmap.blob` are given, both are parsed, with entries from
2412 `mailmap.file` taking precedence. In a bare repository, this
2413 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2417 Specify the programs that may be used to display help in the
2418 'man' format. See linkgit:git-help[1].
2421 Specify the command to invoke the specified man viewer. The
2422 specified command is evaluated in shell with the man page
2423 passed as argument. (See linkgit:git-help[1].)
2426 Override the path for the given tool that may be used to
2427 display help in the 'man' format. See linkgit:git-help[1].
2429 include::merge-config.txt[]
2431 mergetool.<tool>.path::
2432 Override the path for the given tool. This is useful in case
2433 your tool is not in the PATH.
2435 mergetool.<tool>.cmd::
2436 Specify the command to invoke the specified merge tool. The
2437 specified command is evaluated in shell with the following
2438 variables available: 'BASE' is the name of a temporary file
2439 containing the common base of the files to be merged, if available;
2440 'LOCAL' is the name of a temporary file containing the contents of
2441 the file on the current branch; 'REMOTE' is the name of a temporary
2442 file containing the contents of the file from the branch being
2443 merged; 'MERGED' contains the name of the file to which the merge
2444 tool should write the results of a successful merge.
2446 mergetool.<tool>.trustExitCode::
2447 For a custom merge command, specify whether the exit code of
2448 the merge command can be used to determine whether the merge was
2449 successful. If this is not set to true then the merge target file
2450 timestamp is checked and the merge assumed to have been successful
2451 if the file has been updated, otherwise the user is prompted to
2452 indicate the success of the merge.
2454 mergetool.meld.hasOutput::
2455 Older versions of `meld` do not support the `--output` option.
2456 Git will attempt to detect whether `meld` supports `--output`
2457 by inspecting the output of `meld --help`. Configuring
2458 `mergetool.meld.hasOutput` will make Git skip these checks and
2459 use the configured value instead. Setting `mergetool.meld.hasOutput`
2460 to `true` tells Git to unconditionally use the `--output` option,
2461 and `false` avoids using `--output`.
2463 mergetool.keepBackup::
2464 After performing a merge, the original file with conflict markers
2465 can be saved as a file with a `.orig` extension. If this variable
2466 is set to `false` then this file is not preserved. Defaults to
2467 `true` (i.e. keep the backup files).
2469 mergetool.keepTemporaries::
2470 When invoking a custom merge tool, Git uses a set of temporary
2471 files to pass to the tool. If the tool returns an error and this
2472 variable is set to `true`, then these temporary files will be
2473 preserved, otherwise they will be removed after the tool has
2474 exited. Defaults to `false`.
2476 mergetool.writeToTemp::
2477 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2478 conflicting files in the worktree by default. Git will attempt
2479 to use a temporary directory for these files when set `true`.
2480 Defaults to `false`.
2483 Prompt before each invocation of the merge resolution program.
2485 notes.mergeStrategy::
2486 Which merge strategy to choose by default when resolving notes
2487 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2488 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2489 section of linkgit:git-notes[1] for more information on each strategy.
2491 notes.<name>.mergeStrategy::
2492 Which merge strategy to choose when doing a notes merge into
2493 refs/notes/<name>. This overrides the more general
2494 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2495 linkgit:git-notes[1] for more information on the available strategies.
2498 The (fully qualified) refname from which to show notes when
2499 showing commit messages. The value of this variable can be set
2500 to a glob, in which case notes from all matching refs will be
2501 shown. You may also specify this configuration variable
2502 several times. A warning will be issued for refs that do not
2503 exist, but a glob that does not match any refs is silently
2506 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2507 environment variable, which must be a colon separated list of refs or
2510 The effective value of "core.notesRef" (possibly overridden by
2511 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2514 notes.rewrite.<command>::
2515 When rewriting commits with <command> (currently `amend` or
2516 `rebase`) and this variable is set to `true`, Git
2517 automatically copies your notes from the original to the
2518 rewritten commit. Defaults to `true`, but see
2519 "notes.rewriteRef" below.
2522 When copying notes during a rewrite (see the
2523 "notes.rewrite.<command>" option), determines what to do if
2524 the target commit already has a note. Must be one of
2525 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2526 Defaults to `concatenate`.
2528 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2529 environment variable.
2532 When copying notes during a rewrite, specifies the (fully
2533 qualified) ref whose notes should be copied. The ref may be a
2534 glob, in which case notes in all matching refs will be copied.
2535 You may also specify this configuration several times.
2537 Does not have a default value; you must configure this variable to
2538 enable note rewriting. Set it to `refs/notes/commits` to enable
2539 rewriting for the default commit notes.
2541 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2542 environment variable, which must be a colon separated list of refs or
2546 The size of the window used by linkgit:git-pack-objects[1] when no
2547 window size is given on the command line. Defaults to 10.
2550 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2551 maximum depth is given on the command line. Defaults to 50.
2552 Maximum value is 4095.
2555 The maximum size of memory that is consumed by each thread
2556 in linkgit:git-pack-objects[1] for pack window memory when
2557 no limit is given on the command line. The value can be
2558 suffixed with "k", "m", or "g". When left unconfigured (or
2559 set explicitly to 0), there will be no limit.
2562 An integer -1..9, indicating the compression level for objects
2563 in a pack file. -1 is the zlib default. 0 means no
2564 compression, and 1..9 are various speed/size tradeoffs, 9 being
2565 slowest. If not set, defaults to core.compression. If that is
2566 not set, defaults to -1, the zlib default, which is "a default
2567 compromise between speed and compression (currently equivalent
2570 Note that changing the compression level will not automatically recompress
2571 all existing objects. You can force recompression by passing the -F option
2572 to linkgit:git-repack[1].
2574 pack.deltaCacheSize::
2575 The maximum memory in bytes used for caching deltas in
2576 linkgit:git-pack-objects[1] before writing them out to a pack.
2577 This cache is used to speed up the writing object phase by not
2578 having to recompute the final delta result once the best match
2579 for all objects is found. Repacking large repositories on machines
2580 which are tight with memory might be badly impacted by this though,
2581 especially if this cache pushes the system into swapping.
2582 A value of 0 means no limit. The smallest size of 1 byte may be
2583 used to virtually disable this cache. Defaults to 256 MiB.
2585 pack.deltaCacheLimit::
2586 The maximum size of a delta, that is cached in
2587 linkgit:git-pack-objects[1]. This cache is used to speed up the
2588 writing object phase by not having to recompute the final delta
2589 result once the best match for all objects is found.
2590 Defaults to 1000. Maximum value is 65535.
2593 Specifies the number of threads to spawn when searching for best
2594 delta matches. This requires that linkgit:git-pack-objects[1]
2595 be compiled with pthreads otherwise this option is ignored with a
2596 warning. This is meant to reduce packing time on multiprocessor
2597 machines. The required amount of memory for the delta search window
2598 is however multiplied by the number of threads.
2599 Specifying 0 will cause Git to auto-detect the number of CPU's
2600 and set the number of threads accordingly.
2603 Specify the default pack index version. Valid values are 1 for
2604 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2605 the new pack index with capabilities for packs larger than 4 GB
2606 as well as proper protection against the repacking of corrupted
2607 packs. Version 2 is the default. Note that version 2 is enforced
2608 and this config option ignored whenever the corresponding pack is
2611 If you have an old Git that does not understand the version 2 `*.idx` file,
2612 cloning or fetching over a non native protocol (e.g. "http")
2613 that will copy both `*.pack` file and corresponding `*.idx` file from the
2614 other side may give you a repository that cannot be accessed with your
2615 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2616 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2619 pack.packSizeLimit::
2620 The maximum size of a pack. This setting only affects
2621 packing to a file when repacking, i.e. the git:// protocol
2622 is unaffected. It can be overridden by the `--max-pack-size`
2623 option of linkgit:git-repack[1]. Reaching this limit results
2624 in the creation of multiple packfiles; which in turn prevents
2625 bitmaps from being created.
2626 The minimum size allowed is limited to 1 MiB.
2627 The default is unlimited.
2628 Common unit suffixes of 'k', 'm', or 'g' are
2632 When true, git will use pack bitmaps (if available) when packing
2633 to stdout (e.g., during the server side of a fetch). Defaults to
2634 true. You should not generally need to turn this off unless
2635 you are debugging pack bitmaps.
2637 pack.writeBitmaps (deprecated)::
2638 This is a deprecated synonym for `repack.writeBitmaps`.
2640 pack.writeBitmapHashCache::
2641 When true, git will include a "hash cache" section in the bitmap
2642 index (if one is written). This cache can be used to feed git's
2643 delta heuristics, potentially leading to better deltas between
2644 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2645 between an older, bitmapped pack and objects that have been
2646 pushed since the last gc). The downside is that it consumes 4
2647 bytes per object of disk space, and that JGit's bitmap
2648 implementation does not understand it, causing it to complain if
2649 Git and JGit are used on the same repository. Defaults to false.
2652 If the value is boolean, turns on or off pagination of the
2653 output of a particular Git subcommand when writing to a tty.
2654 Otherwise, turns on pagination for the subcommand using the
2655 pager specified by the value of `pager.<cmd>`. If `--paginate`
2656 or `--no-pager` is specified on the command line, it takes
2657 precedence over this option. To disable pagination for all
2658 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2661 Alias for a --pretty= format string, as specified in
2662 linkgit:git-log[1]. Any aliases defined here can be used just
2663 as the built-in pretty formats could. For example,
2664 running `git config pretty.changelog "format:* %H %s"`
2665 would cause the invocation `git log --pretty=changelog`
2666 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2667 Note that an alias with the same name as a built-in format
2668 will be silently ignored.
2671 If set, provide a user defined default policy for all protocols which
2672 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2673 if unset, known-safe protocols (http, https, git, ssh, file) have a
2674 default policy of `always`, known-dangerous protocols (ext) have a
2675 default policy of `never`, and all other protocols have a default
2676 policy of `user`. Supported policies:
2680 * `always` - protocol is always able to be used.
2682 * `never` - protocol is never able to be used.
2684 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2685 either unset or has a value of 1. This policy should be used when you want a
2686 protocol to be directly usable by the user but don't want it used by commands which
2687 execute clone/fetch/push commands without user input, e.g. recursive
2688 submodule initialization.
2692 protocol.<name>.allow::
2693 Set a policy to be used by protocol `<name>` with clone/fetch/push
2694 commands. See `protocol.allow` above for the available policies.
2696 The protocol names currently used by git are:
2699 - `file`: any local file-based path (including `file://` URLs,
2702 - `git`: the anonymous git protocol over a direct TCP
2703 connection (or proxy, if configured)
2705 - `ssh`: git over ssh (including `host:path` syntax,
2708 - `http`: git over http, both "smart http" and "dumb http".
2709 Note that this does _not_ include `https`; if you want to configure
2710 both, you must do so individually.
2712 - any external helpers are named by their protocol (e.g., use
2713 `hg` to allow the `git-remote-hg` helper)
2717 Experimental. If set, clients will attempt to communicate with a
2718 server using the specified protocol version. If unset, no
2719 attempt will be made by the client to communicate using a
2720 particular protocol version, this results in protocol version 0
2726 * `0` - the original wire protocol.
2728 * `1` - the original wire protocol with the addition of a version string
2729 in the initial response from the server.
2734 By default, Git does not create an extra merge commit when merging
2735 a commit that is a descendant of the current commit. Instead, the
2736 tip of the current branch is fast-forwarded. When set to `false`,
2737 this variable tells Git to create an extra merge commit in such
2738 a case (equivalent to giving the `--no-ff` option from the command
2739 line). When set to `only`, only such fast-forward merges are
2740 allowed (equivalent to giving the `--ff-only` option from the
2741 command line). This setting overrides `merge.ff` when pulling.
2744 When true, rebase branches on top of the fetched branch, instead
2745 of merging the default branch from the default remote when "git
2746 pull" is run. See "branch.<name>.rebase" for setting this on a
2749 When `merges`, pass the `--rebase-merges` option to 'git rebase'
2750 so that the local merge commits are included in the rebase (see
2751 linkgit:git-rebase[1] for details).
2753 When preserve, also pass `--preserve-merges` along to 'git rebase'
2754 so that locally committed merge commits will not be flattened
2755 by running 'git pull'.
2757 When the value is `interactive`, the rebase is run in interactive mode.
2759 *NOTE*: this is a possibly dangerous operation; do *not* use
2760 it unless you understand the implications (see linkgit:git-rebase[1]
2764 The default merge strategy to use when pulling multiple branches
2768 The default merge strategy to use when pulling a single branch.
2771 Defines the action `git push` should take if no refspec is
2772 explicitly given. Different values are well-suited for
2773 specific workflows; for instance, in a purely central workflow
2774 (i.e. the fetch source is equal to the push destination),
2775 `upstream` is probably what you want. Possible values are:
2779 * `nothing` - do not push anything (error out) unless a refspec is
2780 explicitly given. This is primarily meant for people who want to
2781 avoid mistakes by always being explicit.
2783 * `current` - push the current branch to update a branch with the same
2784 name on the receiving end. Works in both central and non-central
2787 * `upstream` - push the current branch back to the branch whose
2788 changes are usually integrated into the current branch (which is
2789 called `@{upstream}`). This mode only makes sense if you are
2790 pushing to the same repository you would normally pull from
2791 (i.e. central workflow).
2793 * `tracking` - This is a deprecated synonym for `upstream`.
2795 * `simple` - in centralized workflow, work like `upstream` with an
2796 added safety to refuse to push if the upstream branch's name is
2797 different from the local one.
2799 When pushing to a remote that is different from the remote you normally
2800 pull from, work as `current`. This is the safest option and is suited
2803 This mode has become the default in Git 2.0.
2805 * `matching` - push all branches having the same name on both ends.
2806 This makes the repository you are pushing to remember the set of
2807 branches that will be pushed out (e.g. if you always push 'maint'
2808 and 'master' there and no other branches, the repository you push
2809 to will have these two branches, and your local 'maint' and
2810 'master' will be pushed there).
2812 To use this mode effectively, you have to make sure _all_ the
2813 branches you would push out are ready to be pushed out before
2814 running 'git push', as the whole point of this mode is to allow you
2815 to push all of the branches in one go. If you usually finish work
2816 on only one branch and push out the result, while other branches are
2817 unfinished, this mode is not for you. Also this mode is not
2818 suitable for pushing into a shared central repository, as other
2819 people may add new branches there, or update the tip of existing
2820 branches outside your control.
2822 This used to be the default, but not since Git 2.0 (`simple` is the
2828 If set to true enable `--follow-tags` option by default. You
2829 may override this configuration at time of push by specifying
2833 May be set to a boolean value, or the string 'if-asked'. A true
2834 value causes all pushes to be GPG signed, as if `--signed` is
2835 passed to linkgit:git-push[1]. The string 'if-asked' causes
2836 pushes to be signed if the server supports it, as if
2837 `--signed=if-asked` is passed to 'git push'. A false value may
2838 override a value from a lower-priority config file. An explicit
2839 command-line flag always overrides this config option.
2842 When no `--push-option=<option>` argument is given from the
2843 command line, `git push` behaves as if each <value> of
2844 this variable is given as `--push-option=<value>`.
2846 This is a multi-valued variable, and an empty value can be used in a
2847 higher priority configuration file (e.g. `.git/config` in a
2848 repository) to clear the values inherited from a lower priority
2849 configuration files (e.g. `$HOME/.gitconfig`).
2866 This will result in only b (a and c are cleared).
2870 push.recurseSubmodules::
2871 Make sure all submodule commits used by the revisions to be pushed
2872 are available on a remote-tracking branch. If the value is 'check'
2873 then Git will verify that all submodule commits that changed in the
2874 revisions to be pushed are available on at least one remote of the
2875 submodule. If any commits are missing, the push will be aborted and
2876 exit with non-zero status. If the value is 'on-demand' then all
2877 submodules that changed in the revisions to be pushed will be
2878 pushed. If on-demand was not able to push all necessary revisions
2879 it will also be aborted and exit with non-zero status. If the value
2880 is 'no' then default behavior of ignoring submodules when pushing
2881 is retained. You may override this configuration at time of push by
2882 specifying '--recurse-submodules=check|on-demand|no'.
2884 include::rebase-config.txt[]
2886 receive.advertiseAtomic::
2887 By default, git-receive-pack will advertise the atomic push
2888 capability to its clients. If you don't want to advertise this
2889 capability, set this variable to false.
2891 receive.advertisePushOptions::
2892 When set to true, git-receive-pack will advertise the push options
2893 capability to its clients. False by default.
2896 By default, git-receive-pack will run "git-gc --auto" after
2897 receiving data from git-push and updating refs. You can stop
2898 it by setting this variable to false.
2900 receive.certNonceSeed::
2901 By setting this variable to a string, `git receive-pack`
2902 will accept a `git push --signed` and verifies it by using
2903 a "nonce" protected by HMAC using this string as a secret
2906 receive.certNonceSlop::
2907 When a `git push --signed` sent a push certificate with a
2908 "nonce" that was issued by a receive-pack serving the same
2909 repository within this many seconds, export the "nonce"
2910 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2911 hooks (instead of what the receive-pack asked the sending
2912 side to include). This may allow writing checks in
2913 `pre-receive` and `post-receive` a bit easier. Instead of
2914 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2915 that records by how many seconds the nonce is stale to
2916 decide if they want to accept the certificate, they only
2917 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2919 receive.fsckObjects::
2920 If it is set to true, git-receive-pack will check all received
2921 objects. See `transfer.fsckObjects` for what's checked.
2922 Defaults to false. If not set, the value of
2923 `transfer.fsckObjects` is used instead.
2925 receive.fsck.<msg-id>::
2926 Acts like `fsck.<msg-id>`, but is used by
2927 linkgit:git-receive-pack[1] instead of
2928 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
2931 receive.fsck.skipList::
2932 Acts like `fsck.skipList`, but is used by
2933 linkgit:git-receive-pack[1] instead of
2934 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
2938 After receiving the pack from the client, `receive-pack` may
2939 produce no output (if `--quiet` was specified) while processing
2940 the pack, causing some networks to drop the TCP connection.
2941 With this option set, if `receive-pack` does not transmit
2942 any data in this phase for `receive.keepAlive` seconds, it will
2943 send a short keepalive packet. The default is 5 seconds; set
2944 to 0 to disable keepalives entirely.
2946 receive.unpackLimit::
2947 If the number of objects received in a push is below this
2948 limit then the objects will be unpacked into loose object
2949 files. However if the number of received objects equals or
2950 exceeds this limit then the received pack will be stored as
2951 a pack, after adding any missing delta bases. Storing the
2952 pack from a push can make the push operation complete faster,
2953 especially on slow filesystems. If not set, the value of
2954 `transfer.unpackLimit` is used instead.
2956 receive.maxInputSize::
2957 If the size of the incoming pack stream is larger than this
2958 limit, then git-receive-pack will error out, instead of
2959 accepting the pack file. If not set or set to 0, then the size
2962 receive.denyDeletes::
2963 If set to true, git-receive-pack will deny a ref update that deletes
2964 the ref. Use this to prevent such a ref deletion via a push.
2966 receive.denyDeleteCurrent::
2967 If set to true, git-receive-pack will deny a ref update that
2968 deletes the currently checked out branch of a non-bare repository.
2970 receive.denyCurrentBranch::
2971 If set to true or "refuse", git-receive-pack will deny a ref update
2972 to the currently checked out branch of a non-bare repository.
2973 Such a push is potentially dangerous because it brings the HEAD
2974 out of sync with the index and working tree. If set to "warn",
2975 print a warning of such a push to stderr, but allow the push to
2976 proceed. If set to false or "ignore", allow such pushes with no
2977 message. Defaults to "refuse".
2979 Another option is "updateInstead" which will update the working
2980 tree if pushing into the current branch. This option is
2981 intended for synchronizing working directories when one side is not easily
2982 accessible via interactive ssh (e.g. a live web site, hence the requirement
2983 that the working directory be clean). This mode also comes in handy when
2984 developing inside a VM to test and fix code on different Operating Systems.
2986 By default, "updateInstead" will refuse the push if the working tree or
2987 the index have any difference from the HEAD, but the `push-to-checkout`
2988 hook can be used to customize this. See linkgit:githooks[5].
2990 receive.denyNonFastForwards::
2991 If set to true, git-receive-pack will deny a ref update which is
2992 not a fast-forward. Use this to prevent such an update via a push,
2993 even if that push is forced. This configuration variable is
2994 set when initializing a shared repository.
2997 This variable is the same as `transfer.hideRefs`, but applies
2998 only to `receive-pack` (and so affects pushes, but not fetches).
2999 An attempt to update or delete a hidden ref by `git push` is
3002 receive.updateServerInfo::
3003 If set to true, git-receive-pack will run git-update-server-info
3004 after receiving data from git-push and updating refs.
3006 receive.shallowUpdate::
3007 If set to true, .git/shallow can be updated when new refs
3008 require new shallow roots. Otherwise those refs are rejected.
3010 remote.pushDefault::
3011 The remote to push to by default. Overrides
3012 `branch.<name>.remote` for all branches, and is overridden by
3013 `branch.<name>.pushRemote` for specific branches.
3016 The URL of a remote repository. See linkgit:git-fetch[1] or
3017 linkgit:git-push[1].
3019 remote.<name>.pushurl::
3020 The push URL of a remote repository. See linkgit:git-push[1].
3022 remote.<name>.proxy::
3023 For remotes that require curl (http, https and ftp), the URL to
3024 the proxy to use for that remote. Set to the empty string to
3025 disable proxying for that remote.
3027 remote.<name>.proxyAuthMethod::
3028 For remotes that require curl (http, https and ftp), the method to use for
3029 authenticating against the proxy in use (probably set in
3030 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3032 remote.<name>.fetch::
3033 The default set of "refspec" for linkgit:git-fetch[1]. See
3034 linkgit:git-fetch[1].
3036 remote.<name>.push::
3037 The default set of "refspec" for linkgit:git-push[1]. See
3038 linkgit:git-push[1].
3040 remote.<name>.mirror::
3041 If true, pushing to this remote will automatically behave
3042 as if the `--mirror` option was given on the command line.
3044 remote.<name>.skipDefaultUpdate::
3045 If true, this remote will be skipped by default when updating
3046 using linkgit:git-fetch[1] or the `update` subcommand of
3047 linkgit:git-remote[1].
3049 remote.<name>.skipFetchAll::
3050 If true, this remote will be skipped by default when updating
3051 using linkgit:git-fetch[1] or the `update` subcommand of
3052 linkgit:git-remote[1].
3054 remote.<name>.receivepack::
3055 The default program to execute on the remote side when pushing. See
3056 option --receive-pack of linkgit:git-push[1].
3058 remote.<name>.uploadpack::
3059 The default program to execute on the remote side when fetching. See
3060 option --upload-pack of linkgit:git-fetch-pack[1].
3062 remote.<name>.tagOpt::
3063 Setting this value to --no-tags disables automatic tag following when
3064 fetching from remote <name>. Setting it to --tags will fetch every
3065 tag from remote <name>, even if they are not reachable from remote
3066 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3067 override this setting. See options --tags and --no-tags of
3068 linkgit:git-fetch[1].
3071 Setting this to a value <vcs> will cause Git to interact with
3072 the remote with the git-remote-<vcs> helper.
3074 remote.<name>.prune::
3075 When set to true, fetching from this remote by default will also
3076 remove any remote-tracking references that no longer exist on the
3077 remote (as if the `--prune` option was given on the command line).
3078 Overrides `fetch.prune` settings, if any.
3080 remote.<name>.pruneTags::
3081 When set to true, fetching from this remote by default will also
3082 remove any local tags that no longer exist on the remote if pruning
3083 is activated in general via `remote.<name>.prune`, `fetch.prune` or
3084 `--prune`. Overrides `fetch.pruneTags` settings, if any.
3086 See also `remote.<name>.prune` and the PRUNING section of
3087 linkgit:git-fetch[1].
3090 The list of remotes which are fetched by "git remote update
3091 <group>". See linkgit:git-remote[1].
3093 repack.useDeltaBaseOffset::
3094 By default, linkgit:git-repack[1] creates packs that use
3095 delta-base offset. If you need to share your repository with
3096 Git older than version 1.4.4, either directly or via a dumb
3097 protocol such as http, then you need to set this option to
3098 "false" and repack. Access from old Git versions over the
3099 native protocol are unaffected by this option.
3101 repack.packKeptObjects::
3102 If set to true, makes `git repack` act as if
3103 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3104 details. Defaults to `false` normally, but `true` if a bitmap
3105 index is being written (either via `--write-bitmap-index` or
3106 `repack.writeBitmaps`).
3108 repack.writeBitmaps::
3109 When true, git will write a bitmap index when packing all
3110 objects to disk (e.g., when `git repack -a` is run). This
3111 index can speed up the "counting objects" phase of subsequent
3112 packs created for clones and fetches, at the cost of some disk
3113 space and extra time spent on the initial repack. This has
3114 no effect if multiple packfiles are created.
3118 When set to true, `git-rerere` updates the index with the
3119 resulting contents after it cleanly resolves conflicts using
3120 previously recorded resolution. Defaults to false.
3123 Activate recording of resolved conflicts, so that identical
3124 conflict hunks can be resolved automatically, should they be
3125 encountered again. By default, linkgit:git-rerere[1] is
3126 enabled if there is an `rr-cache` directory under the
3127 `$GIT_DIR`, e.g. if "rerere" was previously used in the
3130 sendemail.identity::
3131 A configuration identity. When given, causes values in the
3132 'sendemail.<identity>' subsection to take precedence over
3133 values in the 'sendemail' section. The default identity is
3134 the value of `sendemail.identity`.
3136 sendemail.smtpEncryption::
3137 See linkgit:git-send-email[1] for description. Note that this
3138 setting is not subject to the 'identity' mechanism.
3140 sendemail.smtpssl (deprecated)::
3141 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3143 sendemail.smtpsslcertpath::
3144 Path to ca-certificates (either a directory or a single file).
3145 Set it to an empty string to disable certificate verification.
3147 sendemail.<identity>.*::
3148 Identity-specific versions of the 'sendemail.*' parameters
3149 found below, taking precedence over those when this
3150 identity is selected, through either the command-line or
3151 `sendemail.identity`.
3153 sendemail.aliasesFile::
3154 sendemail.aliasFileType::
3155 sendemail.annotate::
3159 sendemail.chainReplyTo::
3161 sendemail.envelopeSender::
3163 sendemail.multiEdit::
3164 sendemail.signedoffbycc::
3165 sendemail.smtpPass::
3166 sendemail.suppresscc::
3167 sendemail.suppressFrom::
3170 sendemail.smtpDomain::
3171 sendemail.smtpServer::
3172 sendemail.smtpServerPort::
3173 sendemail.smtpServerOption::
3174 sendemail.smtpUser::
3176 sendemail.transferEncoding::
3177 sendemail.validate::
3179 See linkgit:git-send-email[1] for description.
3181 sendemail.signedoffcc (deprecated)::
3182 Deprecated alias for `sendemail.signedoffbycc`.
3184 sendemail.smtpBatchSize::
3185 Number of messages to be sent per connection, after that a relogin
3186 will happen. If the value is 0 or undefined, send all messages in
3188 See also the `--batch-size` option of linkgit:git-send-email[1].
3190 sendemail.smtpReloginDelay::
3191 Seconds wait before reconnecting to smtp server.
3192 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3194 showbranch.default::
3195 The default set of branches for linkgit:git-show-branch[1].
3196 See linkgit:git-show-branch[1].
3198 splitIndex.maxPercentChange::
3199 When the split index feature is used, this specifies the
3200 percent of entries the split index can contain compared to the
3201 total number of entries in both the split index and the shared
3202 index before a new shared index is written.
3203 The value should be between 0 and 100. If the value is 0 then
3204 a new shared index is always written, if it is 100 a new
3205 shared index is never written.
3206 By default the value is 20, so a new shared index is written
3207 if the number of entries in the split index would be greater
3208 than 20 percent of the total number of entries.
3209 See linkgit:git-update-index[1].
3211 splitIndex.sharedIndexExpire::
3212 When the split index feature is used, shared index files that
3213 were not modified since the time this variable specifies will
3214 be removed when a new shared index file is created. The value
3215 "now" expires all entries immediately, and "never" suppresses
3216 expiration altogether.
3217 The default value is "2.weeks.ago".
3218 Note that a shared index file is considered modified (for the
3219 purpose of expiration) each time a new split-index file is
3220 either created based on it or read from it.
3221 See linkgit:git-update-index[1].
3223 status.relativePaths::
3224 By default, linkgit:git-status[1] shows paths relative to the
3225 current directory. Setting this variable to `false` shows paths
3226 relative to the repository root (this was the default for Git
3230 Set to true to enable --short by default in linkgit:git-status[1].
3231 The option --no-short takes precedence over this variable.
3234 Set to true to enable --branch by default in linkgit:git-status[1].
3235 The option --no-branch takes precedence over this variable.
3237 status.displayCommentPrefix::
3238 If set to true, linkgit:git-status[1] will insert a comment
3239 prefix before each output line (starting with
3240 `core.commentChar`, i.e. `#` by default). This was the
3241 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3244 status.renameLimit::
3245 The number of files to consider when performing rename detection
3246 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3247 the value of diff.renameLimit.
3250 Whether and how Git detects renames in linkgit:git-status[1] and
3251 linkgit:git-commit[1] . If set to "false", rename detection is
3252 disabled. If set to "true", basic rename detection is enabled.
3253 If set to "copies" or "copy", Git will detect copies, as well.
3254 Defaults to the value of diff.renames.
3257 If set to true, linkgit:git-status[1] will display the number of
3258 entries currently stashed away.
3261 status.showUntrackedFiles::
3262 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3263 files which are not currently tracked by Git. Directories which
3264 contain only untracked files, are shown with the directory name
3265 only. Showing untracked files means that Git needs to lstat() all
3266 the files in the whole repository, which might be slow on some
3267 systems. So, this variable controls how the commands displays
3268 the untracked files. Possible values are:
3271 * `no` - Show no untracked files.
3272 * `normal` - Show untracked files and directories.
3273 * `all` - Show also individual files in untracked directories.
3276 If this variable is not specified, it defaults to 'normal'.
3277 This variable can be overridden with the -u|--untracked-files option
3278 of linkgit:git-status[1] and linkgit:git-commit[1].
3280 status.submoduleSummary::
3282 If this is set to a non zero number or true (identical to -1 or an
3283 unlimited number), the submodule summary will be enabled and a
3284 summary of commits for modified submodules will be shown (see
3285 --summary-limit option of linkgit:git-submodule[1]). Please note
3286 that the summary output command will be suppressed for all
3287 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3288 for those submodules where `submodule.<name>.ignore=all`. The only
3289 exception to that rule is that status and commit will show staged
3290 submodule changes. To
3291 also view the summary for ignored submodules you can either use
3292 the --ignore-submodules=dirty command-line option or the 'git
3293 submodule summary' command, which shows a similar output but does
3294 not honor these settings.
3297 If this is set to true, the `git stash show` command without an
3298 option will show the stash entry in patch form. Defaults to false.
3299 See description of 'show' command in linkgit:git-stash[1].
3302 If this is set to true, the `git stash show` command without an
3303 option will show diffstat of the stash entry. Defaults to true.
3304 See description of 'show' command in linkgit:git-stash[1].
3306 submodule.<name>.url::
3307 The URL for a submodule. This variable is copied from the .gitmodules
3308 file to the git config via 'git submodule init'. The user can change
3309 the configured URL before obtaining the submodule via 'git submodule
3310 update'. If neither submodule.<name>.active or submodule.active are
3311 set, the presence of this variable is used as a fallback to indicate
3312 whether the submodule is of interest to git commands.
3313 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3315 submodule.<name>.update::
3316 The method by which a submodule is updated by 'git submodule update',
3317 which is the only affected command, others such as
3318 'git checkout --recurse-submodules' are unaffected. It exists for
3319 historical reasons, when 'git submodule' was the only command to
3320 interact with submodules; settings like `submodule.active`
3321 and `pull.rebase` are more specific. It is populated by
3322 `git submodule init` from the linkgit:gitmodules[5] file.
3323 See description of 'update' command in linkgit:git-submodule[1].
3325 submodule.<name>.branch::
3326 The remote branch name for a submodule, used by `git submodule
3327 update --remote`. Set this option to override the value found in
3328 the `.gitmodules` file. See linkgit:git-submodule[1] and
3329 linkgit:gitmodules[5] for details.
3331 submodule.<name>.fetchRecurseSubmodules::
3332 This option can be used to control recursive fetching of this
3333 submodule. It can be overridden by using the --[no-]recurse-submodules
3334 command-line option to "git fetch" and "git pull".
3335 This setting will override that from in the linkgit:gitmodules[5]
3338 submodule.<name>.ignore::
3339 Defines under what circumstances "git status" and the diff family show
3340 a submodule as modified. When set to "all", it will never be considered
3341 modified (but it will nonetheless show up in the output of status and
3342 commit when it has been staged), "dirty" will ignore all changes
3343 to the submodules work tree and
3344 takes only differences between the HEAD of the submodule and the commit
3345 recorded in the superproject into account. "untracked" will additionally
3346 let submodules with modified tracked files in their work tree show up.
3347 Using "none" (the default when this option is not set) also shows
3348 submodules that have untracked files in their work tree as changed.
3349 This setting overrides any setting made in .gitmodules for this submodule,
3350 both settings can be overridden on the command line by using the
3351 "--ignore-submodules" option. The 'git submodule' commands are not
3352 affected by this setting.
3354 submodule.<name>.active::
3355 Boolean value indicating if the submodule is of interest to git
3356 commands. This config option takes precedence over the
3357 submodule.active config option. See linkgit:gitsubmodules[7] for
3361 A repeated field which contains a pathspec used to match against a
3362 submodule's path to determine if the submodule is of interest to git
3363 commands. See linkgit:gitsubmodules[7] for details.
3366 Specifies if commands recurse into submodules by default. This
3367 applies to all commands that have a `--recurse-submodules` option,
3371 submodule.fetchJobs::
3372 Specifies how many submodules are fetched/cloned at the same time.
3373 A positive integer allows up to that number of submodules fetched
3374 in parallel. A value of 0 will give some reasonable default.
3375 If unset, it defaults to 1.
3377 submodule.alternateLocation::
3378 Specifies how the submodules obtain alternates when submodules are
3379 cloned. Possible values are `no`, `superproject`.
3380 By default `no` is assumed, which doesn't add references. When the
3381 value is set to `superproject` the submodule to be cloned computes
3382 its alternates location relative to the superprojects alternate.
3384 submodule.alternateErrorStrategy::
3385 Specifies how to treat errors with the alternates for a submodule
3386 as computed via `submodule.alternateLocation`. Possible values are
3387 `ignore`, `info`, `die`. Default is `die`.
3389 tag.forceSignAnnotated::
3390 A boolean to specify whether annotated tags created should be GPG signed.
3391 If `--annotate` is specified on the command line, it takes
3392 precedence over this option.
3395 This variable controls the sort ordering of tags when displayed by
3396 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3397 value of this variable will be used as the default.
3400 This variable can be used to restrict the permission bits of
3401 tar archive entries. The default is 0002, which turns off the
3402 world write bit. The special value "user" indicates that the
3403 archiving user's umask will be used instead. See umask(2) and
3404 linkgit:git-archive[1].
3406 transfer.fsckObjects::
3407 When `fetch.fsckObjects` or `receive.fsckObjects` are
3408 not set, the value of this variable is used instead.
3411 When set, the fetch or receive will abort in the case of a malformed
3412 object or a link to a nonexistent object. In addition, various other
3413 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
3414 and potential security issues like the existence of a `.GIT` directory
3415 or a malicious `.gitmodules` file (see the release notes for v2.2.1
3416 and v2.17.1 for details). Other sanity and security checks may be
3417 added in future releases.
3419 On the receiving side, failing fsckObjects will make those objects
3420 unreachable, see "QUARANTINE ENVIRONMENT" in
3421 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
3422 instead be left unreferenced in the repository.
3424 Due to the non-quarantine nature of the `fetch.fsckObjects`
3425 implementation it can not be relied upon to leave the object store
3426 clean like `receive.fsckObjects` can.
3428 As objects are unpacked they're written to the object store, so there
3429 can be cases where malicious objects get introduced even though the
3430 "fetch" failed, only to have a subsequent "fetch" succeed because only
3431 new incoming objects are checked, not those that have already been
3432 written to the object store. That difference in behavior should not be
3433 relied upon. In the future, such objects may be quarantined for
3436 For now, the paranoid need to find some way to emulate the quarantine
3437 environment if they'd like the same protection as "push". E.g. in the
3438 case of an internal mirror do the mirroring in two steps, one to fetch
3439 the untrusted objects, and then do a second "push" (which will use the
3440 quarantine) to another internal repo, and have internal clients
3441 consume this pushed-to repository, or embargo internal fetches and
3442 only allow them once a full "fsck" has run (and no new fetches have
3443 happened in the meantime).
3446 String(s) `receive-pack` and `upload-pack` use to decide which
3447 refs to omit from their initial advertisements. Use more than
3448 one definition to specify multiple prefix strings. A ref that is
3449 under the hierarchies listed in the value of this variable is
3450 excluded, and is hidden when responding to `git push` or `git
3451 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3452 program-specific versions of this config.
3454 You may also include a `!` in front of the ref name to negate the entry,
3455 explicitly exposing it, even if an earlier entry marked it as hidden.
3456 If you have multiple hideRefs values, later entries override earlier ones
3457 (and entries in more-specific config files override less-specific ones).
3459 If a namespace is in use, the namespace prefix is stripped from each
3460 reference before it is matched against `transfer.hiderefs` patterns.
3461 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3462 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3463 is omitted from the advertisements but `refs/heads/master` and
3464 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3465 "have" lines. In order to match refs before stripping, add a `^` in front of
3466 the ref name. If you combine `!` and `^`, `!` must be specified first.
3468 Even if you hide refs, a client may still be able to steal the target
3469 objects via the techniques described in the "SECURITY" section of the
3470 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3471 separate repository.
3473 transfer.unpackLimit::
3474 When `fetch.unpackLimit` or `receive.unpackLimit` are
3475 not set, the value of this variable is used instead.
3476 The default value is 100.
3478 uploadarchive.allowUnreachable::
3479 If true, allow clients to use `git archive --remote` to request
3480 any tree, whether reachable from the ref tips or not. See the
3481 discussion in the "SECURITY" section of
3482 linkgit:git-upload-archive[1] for more details. Defaults to
3485 uploadpack.hideRefs::
3486 This variable is the same as `transfer.hideRefs`, but applies
3487 only to `upload-pack` (and so affects only fetches, not pushes).
3488 An attempt to fetch a hidden ref by `git fetch` will fail. See
3489 also `uploadpack.allowTipSHA1InWant`.
3491 uploadpack.allowTipSHA1InWant::
3492 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3493 to accept a fetch request that asks for an object at the tip
3494 of a hidden ref (by default, such a request is rejected).
3495 See also `uploadpack.hideRefs`. Even if this is false, a client
3496 may be able to steal objects via the techniques described in the
3497 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3498 best to keep private data in a separate repository.
3500 uploadpack.allowReachableSHA1InWant::
3501 Allow `upload-pack` to accept a fetch request that asks for an
3502 object that is reachable from any ref tip. However, note that
3503 calculating object reachability is computationally expensive.
3504 Defaults to `false`. Even if this is false, a client may be able
3505 to steal objects via the techniques described in the "SECURITY"
3506 section of the linkgit:gitnamespaces[7] man page; it's best to
3507 keep private data in a separate repository.
3509 uploadpack.allowAnySHA1InWant::
3510 Allow `upload-pack` to accept a fetch request that asks for any
3512 Defaults to `false`.
3514 uploadpack.keepAlive::
3515 When `upload-pack` has started `pack-objects`, there may be a
3516 quiet period while `pack-objects` prepares the pack. Normally
3517 it would output progress information, but if `--quiet` was used
3518 for the fetch, `pack-objects` will output nothing at all until
3519 the pack data begins. Some clients and networks may consider
3520 the server to be hung and give up. Setting this option instructs
3521 `upload-pack` to send an empty keepalive packet every
3522 `uploadpack.keepAlive` seconds. Setting this option to 0
3523 disables keepalive packets entirely. The default is 5 seconds.
3525 uploadpack.packObjectsHook::
3526 If this option is set, when `upload-pack` would run
3527 `git pack-objects` to create a packfile for a client, it will
3528 run this shell command instead. The `pack-objects` command and
3529 arguments it _would_ have run (including the `git pack-objects`
3530 at the beginning) are appended to the shell command. The stdin
3531 and stdout of the hook are treated as if `pack-objects` itself
3532 was run. I.e., `upload-pack` will feed input intended for
3533 `pack-objects` to the hook, and expects a completed packfile on
3536 uploadpack.allowFilter::
3537 If this option is set, `upload-pack` will support partial
3538 clone and partial fetch object filtering.
3540 Note that this configuration variable is ignored if it is seen in the
3541 repository-level config (this is a safety measure against fetching from
3542 untrusted repositories).
3544 uploadpack.allowRefInWant::
3545 If this option is set, `upload-pack` will support the `ref-in-want`
3546 feature of the protocol version 2 `fetch` command. This feature
3547 is intended for the benefit of load-balanced servers which may
3548 not have the same view of what OIDs their refs point to due to
3551 url.<base>.insteadOf::
3552 Any URL that starts with this value will be rewritten to
3553 start, instead, with <base>. In cases where some site serves a
3554 large number of repositories, and serves them with multiple
3555 access methods, and some users need to use different access
3556 methods, this feature allows people to specify any of the
3557 equivalent URLs and have Git automatically rewrite the URL to
3558 the best alternative for the particular user, even for a
3559 never-before-seen repository on the site. When more than one
3560 insteadOf strings match a given URL, the longest match is used.
3562 Note that any protocol restrictions will be applied to the rewritten
3563 URL. If the rewrite changes the URL to use a custom protocol or remote
3564 helper, you may need to adjust the `protocol.*.allow` config to permit
3565 the request. In particular, protocols you expect to use for submodules
3566 must be set to `always` rather than the default of `user`. See the
3567 description of `protocol.allow` above.
3569 url.<base>.pushInsteadOf::
3570 Any URL that starts with this value will not be pushed to;
3571 instead, it will be rewritten to start with <base>, and the
3572 resulting URL will be pushed to. In cases where some site serves
3573 a large number of repositories, and serves them with multiple
3574 access methods, some of which do not allow push, this feature
3575 allows people to specify a pull-only URL and have Git
3576 automatically use an appropriate URL to push, even for a
3577 never-before-seen repository on the site. When more than one
3578 pushInsteadOf strings match a given URL, the longest match is
3579 used. If a remote has an explicit pushurl, Git will ignore this
3580 setting for that remote.
3583 Your email address to be recorded in any newly created commits.
3584 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3585 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3588 Your full name to be recorded in any newly created commits.
3589 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3590 environment variables. See linkgit:git-commit-tree[1].
3592 user.useConfigOnly::
3593 Instruct Git to avoid trying to guess defaults for `user.email`
3594 and `user.name`, and instead retrieve the values only from the
3595 configuration. For example, if you have multiple email addresses
3596 and would like to use a different one for each repository, then
3597 with this configuration option set to `true` in the global config
3598 along with a name, Git will prompt you to set up an email before
3599 making new commits in a newly cloned repository.
3600 Defaults to `false`.
3603 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3604 key you want it to automatically when creating a signed tag or
3605 commit, you can override the default selection with this variable.
3606 This option is passed unchanged to gpg's --local-user parameter,
3607 so you may specify a key using any method that gpg supports.
3609 versionsort.prereleaseSuffix (deprecated)::
3610 Deprecated alias for `versionsort.suffix`. Ignored if
3611 `versionsort.suffix` is set.
3613 versionsort.suffix::
3614 Even when version sort is used in linkgit:git-tag[1], tagnames
3615 with the same base version but different suffixes are still sorted
3616 lexicographically, resulting e.g. in prerelease tags appearing
3617 after the main release (e.g. "1.0-rc1" after "1.0"). This
3618 variable can be specified to determine the sorting order of tags
3619 with different suffixes.
3621 By specifying a single suffix in this variable, any tagname containing
3622 that suffix will appear before the corresponding main release. E.g. if
3623 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3624 "1.0". If specified multiple times, once per suffix, then the order of
3625 suffixes in the configuration will determine the sorting order of tagnames
3626 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3627 configuration, then all "1.0-preX" tags will be listed before any
3628 "1.0-rcX" tags. The placement of the main release tag relative to tags
3629 with various suffixes can be determined by specifying the empty suffix
3630 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3631 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3632 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3635 If more than one suffixes match the same tagname, then that tagname will
3636 be sorted according to the suffix which starts at the earliest position in
3637 the tagname. If more than one different matching suffixes start at
3638 that earliest position, then that tagname will be sorted according to the
3639 longest of those suffixes.
3640 The sorting order between different suffixes is undefined if they are
3641 in multiple config files.
3644 Specify a web browser that may be used by some commands.
3645 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3648 worktree.guessRemote::
3649 With `add`, if no branch argument, and neither of `-b` nor
3650 `-B` nor `--detach` are given, the command defaults to
3651 creating a new branch from HEAD. If `worktree.guessRemote` is
3652 set to true, `worktree add` tries to find a remote-tracking
3653 branch whose name uniquely matches the new branch name. If
3654 such a branch exists, it is checked out and set as "upstream"
3655 for the new branch. If no such match can be found, it falls
3656 back to creating a new branch from the current HEAD.