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 (doublequote `"` and backslash can be included by escaping them
45 as `\"` and `\\`, respectively). Section headers cannot span multiple
46 lines. Variables may belong directly to a section or to a given subsection.
47 You can have `[section]` if you have `[section "subsection"]`, but you
50 There is also a deprecated `[section.subsection]` syntax. With this
51 syntax, the subsection name is converted to lower-case and is also
52 compared case sensitively. These subsection names follow the same
53 restrictions as section names.
55 All the other lines (and the remainder of the line after the section
56 header) are recognized as setting variables, in the form
57 'name = value' (or just 'name', which is a short-hand to say that
58 the variable is the boolean "true").
59 The variable names are case-insensitive, allow only alphanumeric characters
60 and `-`, and must start with an alphabetic character.
62 A line that defines a value can be continued to the next line by
63 ending it with a `\`; the backquote and the end-of-line are
64 stripped. Leading whitespaces after 'name =', the remainder of the
65 line after the first comment character '#' or ';', and trailing
66 whitespaces of the line are discarded unless they are enclosed in
67 double quotes. Internal whitespaces within the value are retained
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
73 The following escape sequences (beside `\"` and `\\`) are recognized:
74 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
75 and `\b` for backspace (BS). Other char escape sequences (including octal
76 escape sequences) are invalid.
82 The `include` and `includeIf` sections allow you to include config
83 directives from another source. These sections behave identically to
84 each other with the exception that `includeIf` sections may be ignored
85 if their condition does not evaluate to true; see "Conditional includes"
88 You can include a config file from another by setting the special
89 `include.path` (or `includeIf.*.path`) variable to the name of the file
90 to be included. The variable takes a pathname as its value, and is
91 subject to tilde expansion. These variables can be given multiple times.
93 The contents of the included file are inserted immediately, as if they
94 had been found at the location of the include directive. If the value of the
95 variable is a relative path, the path is considered to
96 be relative to the configuration file in which the include directive
97 was found. See below for examples.
102 You can include a config file from another conditionally by setting a
103 `includeIf.<condition>.path` variable to the name of the file to be
106 The condition starts with a keyword followed by a colon and some data
107 whose format and meaning depends on the keyword. Supported keywords
112 The data that follows the keyword `gitdir:` is used as a glob
113 pattern. If the location of the .git directory matches the
114 pattern, the include condition is met.
116 The .git location may be auto-discovered, or come from `$GIT_DIR`
117 environment variable. If the repository is auto discovered via a .git
118 file (e.g. from submodules, or a linked worktree), the .git location
119 would be the final location where the .git directory is, not where the
122 The pattern can contain standard globbing wildcards and two additional
123 ones, `**/` and `/**`, that can match multiple path components. Please
124 refer to linkgit:gitignore[5] for details. For convenience:
126 * If the pattern starts with `~/`, `~` will be substituted with the
127 content of the environment variable `HOME`.
129 * If the pattern starts with `./`, it is replaced with the directory
130 containing the current config file.
132 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
133 will be automatically prepended. For example, the pattern `foo/bar`
134 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
136 * If the pattern ends with `/`, `**` will be automatically added. For
137 example, the pattern `foo/` becomes `foo/**`. In other words, it
138 matches "foo" and everything inside, recursively.
141 This is the same as `gitdir` except that matching is done
142 case-insensitively (e.g. on case-insensitive file sytems)
144 A few more notes on matching via `gitdir` and `gitdir/i`:
146 * Symlinks in `$GIT_DIR` are not resolved before matching.
148 * Both the symlink & realpath versions of paths will be matched
149 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
150 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
153 This was not the case in the initial release of this feature in
154 v2.13.0, which only matched the realpath version. Configuration that
155 wants to be compatible with the initial release of this feature needs
156 to either specify only the realpath version, or both versions.
158 * Note that "../" is not special and will match literally, which is
159 unlikely what you want.
166 ; Don't trust file modes
171 external = /usr/local/bin/diff-wrapper
176 merge = refs/heads/devel
180 gitProxy="ssh" for "kernel.org"
181 gitProxy=default-proxy ; for the rest
184 path = /path/to/foo.inc ; include by absolute path
185 path = foo.inc ; find "foo.inc" relative to the current file
186 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
188 ; include if $GIT_DIR is /path/to/foo/.git
189 [includeIf "gitdir:/path/to/foo/.git"]
190 path = /path/to/foo.inc
192 ; include for all repositories inside /path/to/group
193 [includeIf "gitdir:/path/to/group/"]
194 path = /path/to/foo.inc
196 ; include for all repositories inside $HOME/to/group
197 [includeIf "gitdir:~/to/group/"]
198 path = /path/to/foo.inc
200 ; relative paths are always relative to the including
201 ; file (if the condition is true); their location is not
202 ; affected by the condition
203 [includeIf "gitdir:/path/to/group/"]
209 Values of many variables are treated as a simple string, but there
210 are variables that take values of specific types and there are rules
211 as to how to spell them.
215 When a variable is said to take a boolean value, many
216 synonyms are accepted for 'true' and 'false'; these are all
219 true;; Boolean true literals are `yes`, `on`, `true`,
220 and `1`. Also, a variable defined without `= <value>`
223 false;; Boolean false literals are `no`, `off`, `false`,
224 `0` and the empty string.
226 When converting value to the canonical form using `--bool` type
227 specifier, 'git config' will ensure that the output is "true" or
228 "false" (spelled in lowercase).
231 The value for many variables that specify various sizes can
232 be suffixed with `k`, `M`,... to mean "scale the number by
233 1024", "by 1024x1024", etc.
236 The value for a variable that takes a color is a list of
237 colors (at most two, one for foreground and one for background)
238 and attributes (as many as you want), separated by spaces.
240 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
241 `blue`, `magenta`, `cyan` and `white`. The first color given is the
242 foreground; the second is the background.
244 Colors may also be given as numbers between 0 and 255; these use ANSI
245 256-color mode (but note that not all terminals may support this). If
246 your terminal supports it, you may also specify 24-bit RGB values as
249 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
250 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
251 The position of any attributes with respect to the colors
252 (before, after, or in between), doesn't matter. Specific attributes may
253 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
256 An empty color string produces no color effect at all. This can be used
257 to avoid coloring specific elements without disabling color entirely.
259 For git's pre-defined color slots, the attributes are meant to be reset
260 at the beginning of each item in the colored output. So setting
261 `color.decorate.branch` to `black` will paint that branch name in a
262 plain `black`, even if the previous thing on the same output line (e.g.
263 opening parenthesis before the list of branch names in `log --decorate`
264 output) is set to be painted with `bold` or some other attribute.
265 However, custom log formats may do more complicated and layered
266 coloring, and the negated forms may be useful there.
269 A variable that takes a pathname value can be given a
270 string that begins with "`~/`" or "`~user/`", and the usual
271 tilde expansion happens to such a string: `~/`
272 is expanded to the value of `$HOME`, and `~user/` to the
273 specified user's home directory.
279 Note that this list is non-comprehensive and not necessarily complete.
280 For command-specific variables, you will find a more detailed description
281 in the appropriate manual page.
283 Other git-related tools may and do use their own variables. When
284 inventing new variables for use in your own tool, make sure their
285 names do not conflict with those that are used by Git itself and
286 other popular tools, and describe them in your documentation.
290 These variables control various optional help messages designed to
291 aid new users. All 'advice.*' variables default to 'true', and you
292 can tell Git that you do not need help by setting these to 'false':
296 Set this variable to 'false' if you want to disable
298 'pushNonFFMatching', 'pushAlreadyExists',
299 'pushFetchFirst', and 'pushNeedsForce'
302 Advice shown when linkgit:git-push[1] fails due to a
303 non-fast-forward update to the current branch.
305 Advice shown when you ran linkgit:git-push[1] and pushed
306 'matching refs' explicitly (i.e. you used ':', or
307 specified a refspec that isn't your current branch) and
308 it resulted in a non-fast-forward error.
310 Shown when linkgit:git-push[1] rejects an update that
311 does not qualify for fast-forwarding (e.g., a tag.)
313 Shown when linkgit:git-push[1] rejects an update that
314 tries to overwrite a remote ref that points at an
315 object we do not have.
317 Shown when linkgit:git-push[1] rejects an update that
318 tries to overwrite a remote ref that points at an
319 object that is not a commit-ish, or make the remote
320 ref point at an object that is not a commit-ish.
322 Show directions on how to proceed from the current
323 state in the output of linkgit:git-status[1], in
324 the template shown when writing commit messages in
325 linkgit:git-commit[1], and in the help message shown
326 by linkgit:git-checkout[1] when switching branch.
328 Advise to consider using the `-u` option to linkgit:git-status[1]
329 when the command takes more than 2 seconds to enumerate untracked
332 Advice shown when linkgit:git-merge[1] refuses to
333 merge to avoid overwriting local changes.
335 Advice shown by various commands when conflicts
336 prevent the operation from being performed.
338 Advice on how to set your identity configuration when
339 your information is guessed from the system username and
342 Advice shown when you used linkgit:git-checkout[1] to
343 move to the detach HEAD state, to instruct how to create
344 a local branch after the fact.
346 Advice that shows the location of the patch file when
347 linkgit:git-am[1] fails to apply it.
349 In case of failure in the output of linkgit:git-rm[1],
350 show directions on how to proceed from the current state.
352 Advice on what to do when you've accidentally added one
353 git repo inside of another.
355 Advice shown if an hook is ignored because the hook is not
360 Tells Git if the executable bit of files in the working tree
363 Some filesystems lose the executable bit when a file that is
364 marked as executable is checked out, or checks out a
365 non-executable file with executable bit on.
366 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
367 to see if it handles the executable bit correctly
368 and this variable is automatically set as necessary.
370 A repository, however, may be on a filesystem that handles
371 the filemode correctly, and this variable is set to 'true'
372 when created, but later may be made accessible from another
373 environment that loses the filemode (e.g. exporting ext4 via
374 CIFS mount, visiting a Cygwin created repository with
375 Git for Windows or Eclipse).
376 In such a case it may be necessary to set this variable to 'false'.
377 See linkgit:git-update-index[1].
379 The default is true (when core.filemode is not specified in the config file).
382 (Windows-only) If true, mark newly-created directories and files whose
383 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
384 directory is hidden, but no other files starting with a dot. The
385 default mode is 'dotGitOnly'.
388 If true, this option enables various workarounds to enable
389 Git to work better on filesystems that are not case sensitive,
390 like FAT. For example, if a directory listing finds
391 "makefile" when Git expects "Makefile", Git will assume
392 it is really the same file, and continue to remember it as
395 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
396 will probe and set core.ignoreCase true if appropriate when the repository
399 core.precomposeUnicode::
400 This option is only used by Mac OS implementation of Git.
401 When core.precomposeUnicode=true, Git reverts the unicode decomposition
402 of filenames done by Mac OS. This is useful when sharing a repository
403 between Mac OS and Linux or Windows.
404 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
405 When false, file names are handled fully transparent by Git,
406 which is backward compatible with older versions of Git.
409 If set to true, do not allow checkout of paths that would
410 be considered equivalent to `.git` on an HFS+ filesystem.
411 Defaults to `true` on Mac OS, and `false` elsewhere.
414 If set to true, do not allow checkout of paths that would
415 cause problems with the NTFS filesystem, e.g. conflict with
417 Defaults to `true` on Windows, and `false` elsewhere.
420 If false, the ctime differences between the index and the
421 working tree are ignored; useful when the inode change time
422 is regularly modified by something outside Git (file system
423 crawlers and some backup systems).
424 See linkgit:git-update-index[1]. True by default.
427 If true, the split-index feature of the index will be used.
428 See linkgit:git-update-index[1]. False by default.
430 core.untrackedCache::
431 Determines what to do about the untracked cache feature of the
432 index. It will be kept, if this variable is unset or set to
433 `keep`. It will automatically be added if set to `true`. And
434 it will automatically be removed, if set to `false`. Before
435 setting it to `true`, you should check that mtime is working
436 properly on your system.
437 See linkgit:git-update-index[1]. `keep` by default.
440 Determines which stat fields to match between the index
441 and work tree. The user can set this to 'default' or
442 'minimal'. Default (or explicitly 'default'), is to check
443 all fields, including the sub-second part of mtime and ctime.
446 Commands that output paths (e.g. 'ls-files', 'diff'), will
447 quote "unusual" characters in the pathname by enclosing the
448 pathname in double-quotes and escaping those characters with
449 backslashes in the same way C escapes control characters (e.g.
450 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
451 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
452 UTF-8). If this variable is set to false, bytes higher than
453 0x80 are not considered "unusual" any more. Double-quotes,
454 backslash and control characters are always escaped regardless
455 of the setting of this variable. A simple space character is
456 not considered "unusual". Many commands can output pathnames
457 completely verbatim using the `-z` option. The default value
461 Sets the line ending type to use in the working directory for
462 files that have the `text` property set when core.autocrlf is false.
463 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
464 native line ending. The default value is `native`. See
465 linkgit:gitattributes[5] for more information on end-of-line
469 If true, makes Git check if converting `CRLF` is reversible when
470 end-of-line conversion is active. Git will verify if a command
471 modifies a file in the work tree either directly or indirectly.
472 For example, committing a file followed by checking out the
473 same file should yield the original file in the work tree. If
474 this is not the case for the current setting of
475 `core.autocrlf`, Git will reject the file. The variable can
476 be set to "warn", in which case Git will only warn about an
477 irreversible conversion but continue the operation.
479 CRLF conversion bears a slight chance of corrupting data.
480 When it is enabled, Git will convert CRLF to LF during commit and LF to
481 CRLF during checkout. A file that contains a mixture of LF and
482 CRLF before the commit cannot be recreated by Git. For text
483 files this is the right thing to do: it corrects line endings
484 such that we have only LF line endings in the repository.
485 But for binary files that are accidentally classified as text the
486 conversion can corrupt data.
488 If you recognize such corruption early you can easily fix it by
489 setting the conversion type explicitly in .gitattributes. Right
490 after committing you still have the original file in your work
491 tree and this file is not yet corrupted. You can explicitly tell
492 Git that this file is binary and Git will handle the file
495 Unfortunately, the desired effect of cleaning up text files with
496 mixed line endings and the undesired effect of corrupting binary
497 files cannot be distinguished. In both cases CRLFs are removed
498 in an irreversible way. For text files this is the right thing
499 to do because CRLFs are line endings, while for binary files
500 converting CRLFs corrupts data.
502 Note, this safety check does not mean that a checkout will generate a
503 file identical to the original file for a different setting of
504 `core.eol` and `core.autocrlf`, but only for the current one. For
505 example, a text file with `LF` would be accepted with `core.eol=lf`
506 and could later be checked out with `core.eol=crlf`, in which case the
507 resulting file would contain `CRLF`, although the original file
508 contained `LF`. However, in both work trees the line endings would be
509 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
510 file with mixed line endings would be reported by the `core.safecrlf`
514 Setting this variable to "true" is the same as setting
515 the `text` attribute to "auto" on all files and core.eol to "crlf".
516 Set to true if you want to have `CRLF` line endings in your
517 working directory and the repository has LF line endings.
518 This variable can be set to 'input',
519 in which case no output conversion is performed.
522 If false, symbolic links are checked out as small plain files that
523 contain the link text. linkgit:git-update-index[1] and
524 linkgit:git-add[1] will not change the recorded type to regular
525 file. Useful on filesystems like FAT that do not support
528 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
529 will probe and set core.symlinks false if appropriate when the repository
533 A "proxy command" to execute (as 'command host port') instead
534 of establishing direct connection to the remote server when
535 using the Git protocol for fetching. If the variable value is
536 in the "COMMAND for DOMAIN" format, the command is applied only
537 on hostnames ending with the specified domain string. This variable
538 may be set multiple times and is matched in the given order;
539 the first match wins.
541 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
542 (which always applies universally, without the special "for"
545 The special string `none` can be used as the proxy command to
546 specify that no proxy be used for a given domain pattern.
547 This is useful for excluding servers inside a firewall from
548 proxy use, while defaulting to a common proxy for external domains.
551 If this variable is set, `git fetch` and `git push` will
552 use the specified command instead of `ssh` when they need to
553 connect to a remote system. The command is in the same form as
554 the `GIT_SSH_COMMAND` environment variable and is overridden
555 when the environment variable is set.
558 If true, Git will avoid using lstat() calls to detect if files have
559 changed by setting the "assume-unchanged" bit for those tracked files
560 which it has updated identically in both the index and working tree.
562 When files are modified outside of Git, the user will need to stage
563 the modified files explicitly (e.g. see 'Examples' section in
564 linkgit:git-update-index[1]).
565 Git will not normally detect changes to those files.
567 This is useful on systems where lstat() calls are very slow, such as
568 CIFS/Microsoft Windows.
572 core.preferSymlinkRefs::
573 Instead of the default "symref" format for HEAD
574 and other symbolic reference files, use symbolic links.
575 This is sometimes needed to work with old scripts that
576 expect HEAD to be a symbolic link.
579 If true this repository is assumed to be 'bare' and has no
580 working directory associated with it. If this is the case a
581 number of commands that require a working directory will be
582 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
584 This setting is automatically guessed by linkgit:git-clone[1] or
585 linkgit:git-init[1] when the repository was created. By default a
586 repository that ends in "/.git" is assumed to be not bare (bare =
587 false), while all other repositories are assumed to be bare (bare
591 Set the path to the root of the working tree.
592 If `GIT_COMMON_DIR` environment variable is set, core.worktree
593 is ignored and not used for determining the root of working tree.
594 This can be overridden by the `GIT_WORK_TREE` environment
595 variable and the `--work-tree` command-line option.
596 The value can be an absolute path or relative to the path to
597 the .git directory, which is either specified by --git-dir
598 or GIT_DIR, or automatically discovered.
599 If --git-dir or GIT_DIR is specified but none of
600 --work-tree, GIT_WORK_TREE and core.worktree is specified,
601 the current working directory is regarded as the top level
602 of your working tree.
604 Note that this variable is honored even when set in a configuration
605 file in a ".git" subdirectory of a directory and its value differs
606 from the latter directory (e.g. "/path/to/.git/config" has
607 core.worktree set to "/different/path"), which is most likely a
608 misconfiguration. Running Git commands in the "/path/to" directory will
609 still use "/different/path" as the root of the work tree and can cause
610 confusion unless you know what you are doing (e.g. you are creating a
611 read-only snapshot of the same index to a location different from the
612 repository's usual working tree).
614 core.logAllRefUpdates::
615 Enable the reflog. Updates to a ref <ref> is logged to the file
616 "`$GIT_DIR/logs/<ref>`", by appending the new and old
617 SHA-1, the date/time and the reason of the update, but
618 only when the file exists. If this configuration
619 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
620 file is automatically created for branch heads (i.e. under
621 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
622 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
623 If it is set to `always`, then a missing reflog is automatically
624 created for any ref under `refs/`.
626 This information can be used to determine what commit
627 was the tip of a branch "2 days ago".
629 This value is true by default in a repository that has
630 a working directory associated with it, and false by
631 default in a bare repository.
633 core.repositoryFormatVersion::
634 Internal variable identifying the repository format and layout
637 core.sharedRepository::
638 When 'group' (or 'true'), the repository is made shareable between
639 several users in a group (making sure all the files and objects are
640 group-writable). When 'all' (or 'world' or 'everybody'), the
641 repository will be readable by all users, additionally to being
642 group-shareable. When 'umask' (or 'false'), Git will use permissions
643 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
644 files in the repository will have this mode value. '0xxx' will override
645 user's umask value (whereas the other options will only override
646 requested parts of the user's umask value). Examples: '0660' will make
647 the repo read/write-able for the owner and group, but inaccessible to
648 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
649 repository that is group-readable but not group-writable.
650 See linkgit:git-init[1]. False by default.
652 core.warnAmbiguousRefs::
653 If true, Git will warn you if the ref name you passed it is ambiguous
654 and might match multiple refs in the repository. True by default.
657 An integer -1..9, indicating a default compression level.
658 -1 is the zlib default. 0 means no compression,
659 and 1..9 are various speed/size tradeoffs, 9 being slowest.
660 If set, this provides a default to other compression variables,
661 such as `core.looseCompression` and `pack.compression`.
663 core.looseCompression::
664 An integer -1..9, indicating the compression level for objects that
665 are not in a pack file. -1 is the zlib default. 0 means no
666 compression, and 1..9 are various speed/size tradeoffs, 9 being
667 slowest. If not set, defaults to core.compression. If that is
668 not set, defaults to 1 (best speed).
670 core.packedGitWindowSize::
671 Number of bytes of a pack file to map into memory in a
672 single mapping operation. Larger window sizes may allow
673 your system to process a smaller number of large pack files
674 more quickly. Smaller window sizes will negatively affect
675 performance due to increased calls to the operating system's
676 memory manager, but may improve performance when accessing
677 a large number of large pack files.
679 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
680 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
681 be reasonable for all users/operating systems. You probably do
682 not need to adjust this value.
684 Common unit suffixes of 'k', 'm', or 'g' are supported.
686 core.packedGitLimit::
687 Maximum number of bytes to map simultaneously into memory
688 from pack files. If Git needs to access more than this many
689 bytes at once to complete an operation it will unmap existing
690 regions to reclaim virtual address space within the process.
692 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
693 unlimited) on 64 bit platforms.
694 This should be reasonable for all users/operating systems, except on
695 the largest projects. You probably do not need to adjust this value.
697 Common unit suffixes of 'k', 'm', or 'g' are supported.
699 core.deltaBaseCacheLimit::
700 Maximum number of bytes to reserve for caching base objects
701 that may be referenced by multiple deltified objects. By storing the
702 entire decompressed base objects in a cache Git is able
703 to avoid unpacking and decompressing frequently used base
704 objects multiple times.
706 Default is 96 MiB on all platforms. This should be reasonable
707 for all users/operating systems, except on the largest projects.
708 You probably do not need to adjust this value.
710 Common unit suffixes of 'k', 'm', or 'g' are supported.
712 core.bigFileThreshold::
713 Files larger than this size are stored deflated, without
714 attempting delta compression. Storing large files without
715 delta compression avoids excessive memory usage, at the
716 slight expense of increased disk usage. Additionally files
717 larger than this size are always treated as binary.
719 Default is 512 MiB on all platforms. This should be reasonable
720 for most projects as source code and other text files can still
721 be delta compressed, but larger binary media files won't be.
723 Common unit suffixes of 'k', 'm', or 'g' are supported.
726 Specifies the pathname to the file that contains patterns to
727 describe paths that are not meant to be tracked, in addition
728 to '.gitignore' (per-directory) and '.git/info/exclude'.
729 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
730 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
731 is used instead. See linkgit:gitignore[5].
734 Some commands (e.g. svn and http interfaces) that interactively
735 ask for a password can be told to use an external program given
736 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
737 environment variable. If not set, fall back to the value of the
738 `SSH_ASKPASS` environment variable or, failing that, a simple password
739 prompt. The external program shall be given a suitable prompt as
740 command-line argument and write the password on its STDOUT.
742 core.attributesFile::
743 In addition to '.gitattributes' (per-directory) and
744 '.git/info/attributes', Git looks into this file for attributes
745 (see linkgit:gitattributes[5]). Path expansions are made the same
746 way as for `core.excludesFile`. Its default value is
747 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
748 set or empty, `$HOME/.config/git/attributes` is used instead.
751 By default Git will look for your hooks in the
752 '$GIT_DIR/hooks' directory. Set this to different path,
753 e.g. '/etc/git/hooks', and Git will try to find your hooks in
754 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
755 in '$GIT_DIR/hooks/pre-receive'.
757 The path can be either absolute or relative. A relative path is
758 taken as relative to the directory where the hooks are run (see
759 the "DESCRIPTION" section of linkgit:githooks[5]).
761 This configuration variable is useful in cases where you'd like to
762 centrally configure your Git hooks instead of configuring them on a
763 per-repository basis, or as a more flexible and centralized
764 alternative to having an `init.templateDir` where you've changed
768 Commands such as `commit` and `tag` that let you edit
769 messages by launching an editor use the value of this
770 variable when it is set, and the environment variable
771 `GIT_EDITOR` is not set. See linkgit:git-var[1].
774 Commands such as `commit` and `tag` that let you edit
775 messages consider a line that begins with this character
776 commented, and removes them after the editor returns
779 If set to "auto", `git-commit` would select a character that is not
780 the beginning character of any line in existing commit messages.
782 core.filesRefLockTimeout::
783 The length of time, in milliseconds, to retry when trying to
784 lock an individual reference. Value 0 means not to retry at
785 all; -1 means to try indefinitely. Default is 100 (i.e.,
788 core.packedRefsTimeout::
789 The length of time, in milliseconds, to retry when trying to
790 lock the `packed-refs` file. Value 0 means not to retry at
791 all; -1 means to try indefinitely. Default is 1000 (i.e.,
795 Text editor used by `git rebase -i` for editing the rebase instruction file.
796 The value is meant to be interpreted by the shell when it is used.
797 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
798 When not configured the default commit message editor is used instead.
801 Text viewer for use by Git commands (e.g., 'less'). The value
802 is meant to be interpreted by the shell. The order of preference
803 is the `$GIT_PAGER` environment variable, then `core.pager`
804 configuration, then `$PAGER`, and then the default chosen at
805 compile time (usually 'less').
807 When the `LESS` environment variable is unset, Git sets it to `FRX`
808 (if `LESS` environment variable is set, Git does not change it at
809 all). If you want to selectively override Git's default setting
810 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
811 be passed to the shell by Git, which will translate the final
812 command to `LESS=FRX less -S`. The environment does not set the
813 `S` option but the command line does, instructing less to truncate
814 long lines. Similarly, setting `core.pager` to `less -+F` will
815 deactivate the `F` option specified by the environment from the
816 command-line, deactivating the "quit if one screen" behavior of
817 `less`. One can specifically activate some flags for particular
818 commands: for example, setting `pager.blame` to `less -S` enables
819 line truncation only for `git blame`.
821 Likewise, when the `LV` environment variable is unset, Git sets it
822 to `-c`. You can override this setting by exporting `LV` with
823 another value or setting `core.pager` to `lv +c`.
826 A comma separated list of common whitespace problems to
827 notice. 'git diff' will use `color.diff.whitespace` to
828 highlight them, and 'git apply --whitespace=error' will
829 consider them as errors. You can prefix `-` to disable
830 any of them (e.g. `-trailing-space`):
832 * `blank-at-eol` treats trailing whitespaces at the end of the line
833 as an error (enabled by default).
834 * `space-before-tab` treats a space character that appears immediately
835 before a tab character in the initial indent part of the line as an
836 error (enabled by default).
837 * `indent-with-non-tab` treats a line that is indented with space
838 characters instead of the equivalent tabs as an error (not enabled by
840 * `tab-in-indent` treats a tab character in the initial indent part of
841 the line as an error (not enabled by default).
842 * `blank-at-eof` treats blank lines added at the end of file as an error
843 (enabled by default).
844 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
846 * `cr-at-eol` treats a carriage-return at the end of line as
847 part of the line terminator, i.e. with it, `trailing-space`
848 does not trigger if the character before such a carriage-return
849 is not a whitespace (not enabled by default).
850 * `tabwidth=<n>` tells how many character positions a tab occupies; this
851 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
852 errors. The default tab width is 8. Allowed values are 1 to 63.
854 core.fsyncObjectFiles::
855 This boolean will enable 'fsync()' when writing object files.
857 This is a total waste of time and effort on a filesystem that orders
858 data writes properly, but can be useful for filesystems that do not use
859 journalling (traditional UNIX filesystems) or that only journal metadata
860 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
863 Enable parallel index preload for operations like 'git diff'
865 This can speed up operations like 'git diff' and 'git status' especially
866 on filesystems like NFS that have weak caching semantics and thus
867 relatively high IO latencies. When enabled, Git will do the
868 index comparison to the filesystem data in parallel, allowing
869 overlapping IO's. Defaults to true.
872 You can set this to 'link', in which case a hardlink followed by
873 a delete of the source are used to make sure that object creation
874 will not overwrite existing objects.
876 On some file system/operating system combinations, this is unreliable.
877 Set this config setting to 'rename' there; However, This will remove the
878 check that makes sure that existing object files will not get overwritten.
881 When showing commit messages, also show notes which are stored in
882 the given ref. The ref must be fully qualified. If the given
883 ref does not exist, it is not an error but means that no
884 notes should be printed.
886 This setting defaults to "refs/notes/commits", and it can be overridden by
887 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
889 core.sparseCheckout::
890 Enable "sparse checkout" feature. See section "Sparse checkout" in
891 linkgit:git-read-tree[1] for more information.
894 Set the length object names are abbreviated to. If
895 unspecified or set to "auto", an appropriate value is
896 computed based on the approximate number of packed objects
897 in your repository, which hopefully is enough for
898 abbreviated object names to stay unique for some time.
899 The minimum length is 4.
902 add.ignore-errors (deprecated)::
903 Tells 'git add' to continue adding files when some files cannot be
904 added due to indexing errors. Equivalent to the `--ignore-errors`
905 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
906 as it does not follow the usual naming convention for configuration
910 Command aliases for the linkgit:git[1] command wrapper - e.g.
911 after defining "alias.last = cat-file commit HEAD", the invocation
912 "git last" is equivalent to "git cat-file commit HEAD". To avoid
913 confusion and troubles with script usage, aliases that
914 hide existing Git commands are ignored. Arguments are split by
915 spaces, the usual shell quoting and escaping is supported.
916 A quote pair or a backslash can be used to quote them.
918 If the alias expansion is prefixed with an exclamation point,
919 it will be treated as a shell command. For example, defining
920 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
921 "git new" is equivalent to running the shell command
922 "gitk --all --not ORIG_HEAD". Note that shell commands will be
923 executed from the top-level directory of a repository, which may
924 not necessarily be the current directory.
925 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
926 from the original current directory. See linkgit:git-rev-parse[1].
929 If true, git-am will call git-mailsplit for patches in mbox format
930 with parameter `--keep-cr`. In this case git-mailsplit will
931 not remove `\r` from lines ending with `\r\n`. Can be overridden
932 by giving `--no-keep-cr` from the command line.
933 See linkgit:git-am[1], linkgit:git-mailsplit[1].
936 By default, `git am` will fail if the patch does not apply cleanly. When
937 set to true, this setting tells `git am` to fall back on 3-way merge if
938 the patch records the identity of blobs it is supposed to apply to and
939 we have those blobs available locally (equivalent to giving the `--3way`
940 option from the command line). Defaults to `false`.
941 See linkgit:git-am[1].
943 apply.ignoreWhitespace::
944 When set to 'change', tells 'git apply' to ignore changes in
945 whitespace, in the same way as the `--ignore-space-change`
947 When set to one of: no, none, never, false tells 'git apply' to
948 respect all whitespace differences.
949 See linkgit:git-apply[1].
952 Tells 'git apply' how to handle whitespaces, in the same way
953 as the `--whitespace` option. See linkgit:git-apply[1].
955 branch.autoSetupMerge::
956 Tells 'git branch' and 'git checkout' to set up new branches
957 so that linkgit:git-pull[1] will appropriately merge from the
958 starting point branch. Note that even if this option is not set,
959 this behavior can be chosen per-branch using the `--track`
960 and `--no-track` options. The valid settings are: `false` -- no
961 automatic setup is done; `true` -- automatic setup is done when the
962 starting point is a remote-tracking branch; `always` --
963 automatic setup is done when the starting point is either a
964 local branch or remote-tracking
965 branch. This option defaults to true.
967 branch.autoSetupRebase::
968 When a new branch is created with 'git branch' or 'git checkout'
969 that tracks another branch, this variable tells Git to set
970 up pull to rebase instead of merge (see "branch.<name>.rebase").
971 When `never`, rebase is never automatically set to true.
972 When `local`, rebase is set to true for tracked branches of
973 other local branches.
974 When `remote`, rebase is set to true for tracked branches of
975 remote-tracking branches.
976 When `always`, rebase will be set to true for all tracking
978 See "branch.autoSetupMerge" for details on how to set up a
979 branch to track another branch.
980 This option defaults to never.
982 branch.<name>.remote::
983 When on branch <name>, it tells 'git fetch' and 'git push'
984 which remote to fetch from/push to. The remote to push to
985 may be overridden with `remote.pushDefault` (for all branches).
986 The remote to push to, for the current branch, may be further
987 overridden by `branch.<name>.pushRemote`. If no remote is
988 configured, or if you are not on any branch, it defaults to
989 `origin` for fetching and `remote.pushDefault` for pushing.
990 Additionally, `.` (a period) is the current local repository
991 (a dot-repository), see `branch.<name>.merge`'s final note below.
993 branch.<name>.pushRemote::
994 When on branch <name>, it overrides `branch.<name>.remote` for
995 pushing. It also overrides `remote.pushDefault` for pushing
996 from branch <name>. When you pull from one place (e.g. your
997 upstream) and push to another place (e.g. your own publishing
998 repository), you would want to set `remote.pushDefault` to
999 specify the remote to push to for all branches, and use this
1000 option to override it for a specific branch.
1002 branch.<name>.merge::
1003 Defines, together with branch.<name>.remote, the upstream branch
1004 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1005 branch to merge and can also affect 'git push' (see push.default).
1006 When in branch <name>, it tells 'git fetch' the default
1007 refspec to be marked for merging in FETCH_HEAD. The value is
1008 handled like the remote part of a refspec, and must match a
1009 ref which is fetched from the remote given by
1010 "branch.<name>.remote".
1011 The merge information is used by 'git pull' (which at first calls
1012 'git fetch') to lookup the default branch for merging. Without
1013 this option, 'git pull' defaults to merge the first refspec fetched.
1014 Specify multiple values to get an octopus merge.
1015 If you wish to setup 'git pull' so that it merges into <name> from
1016 another branch in the local repository, you can point
1017 branch.<name>.merge to the desired branch, and use the relative path
1018 setting `.` (a period) for branch.<name>.remote.
1020 branch.<name>.mergeOptions::
1021 Sets default options for merging into branch <name>. The syntax and
1022 supported options are the same as those of linkgit:git-merge[1], but
1023 option values containing whitespace characters are currently not
1026 branch.<name>.rebase::
1027 When true, rebase the branch <name> on top of the fetched branch,
1028 instead of merging the default branch from the default remote when
1029 "git pull" is run. See "pull.rebase" for doing this in a non
1030 branch-specific manner.
1032 When preserve, also pass `--preserve-merges` along to 'git rebase'
1033 so that locally committed merge commits will not be flattened
1034 by running 'git pull'.
1036 When the value is `interactive`, the rebase is run in interactive mode.
1038 *NOTE*: this is a possibly dangerous operation; do *not* use
1039 it unless you understand the implications (see linkgit:git-rebase[1]
1042 branch.<name>.description::
1043 Branch description, can be edited with
1044 `git branch --edit-description`. Branch description is
1045 automatically added in the format-patch cover letter or
1046 request-pull summary.
1048 browser.<tool>.cmd::
1049 Specify the command to invoke the specified browser. The
1050 specified command is evaluated in shell with the URLs passed
1051 as arguments. (See linkgit:git-web{litdd}browse[1].)
1053 browser.<tool>.path::
1054 Override the path for the given tool that may be used to
1055 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1056 working repository in gitweb (see linkgit:git-instaweb[1]).
1058 clean.requireForce::
1059 A boolean to make git-clean do nothing unless given -f,
1060 -i or -n. Defaults to true.
1063 A boolean to enable/disable color in the output of
1064 linkgit:git-branch[1]. May be set to `always`,
1065 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1066 only when the output is to a terminal. If unset, then the
1067 value of `color.ui` is used (`auto` by default).
1069 color.branch.<slot>::
1070 Use customized color for branch coloration. `<slot>` is one of
1071 `current` (the current branch), `local` (a local branch),
1072 `remote` (a remote-tracking branch in refs/remotes/),
1073 `upstream` (upstream tracking branch), `plain` (other
1077 Whether to use ANSI escape sequences to add color to patches.
1078 If this is set to `always`, linkgit:git-diff[1],
1079 linkgit:git-log[1], and linkgit:git-show[1] will use color
1080 for all patches. If it is set to `true` or `auto`, those
1081 commands will only use color when output is to the terminal.
1082 If unset, then the value of `color.ui` is used (`auto` by
1085 This does not affect linkgit:git-format-patch[1] or the
1086 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1087 command line with the `--color[=<when>]` option.
1090 If set to either a valid `<mode>` or a true value, moved lines
1091 in a diff are colored differently, for details of valid modes
1092 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1093 true the default color mode will be used. When set to false,
1094 moved lines are not colored.
1097 Use customized color for diff colorization. `<slot>` specifies
1098 which part of the patch to use the specified color, and is one
1099 of `context` (context text - `plain` is a historical synonym),
1100 `meta` (metainformation), `frag`
1101 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1102 `new` (added lines), `commit` (commit headers), `whitespace`
1103 (highlighting whitespace errors), `oldMoved` (deleted lines),
1104 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1105 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1106 and `newMovedAlternativeDimmed` (See the '<mode>'
1107 setting of '--color-moved' in linkgit:git-diff[1] for details).
1109 color.decorate.<slot>::
1110 Use customized color for 'git log --decorate' output. `<slot>` is one
1111 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1112 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1115 When set to `always`, always highlight matches. When `false` (or
1116 `never`), never. When set to `true` or `auto`, use color only
1117 when the output is written to the terminal. If unset, then the
1118 value of `color.ui` is used (`auto` by default).
1121 Use customized color for grep colorization. `<slot>` specifies which
1122 part of the line to use the specified color, and is one of
1126 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1128 filename prefix (when not using `-h`)
1130 function name lines (when using `-p`)
1132 line number prefix (when using `-n`)
1134 matching text (same as setting `matchContext` and `matchSelected`)
1136 matching text in context lines
1138 matching text in selected lines
1140 non-matching text in selected lines
1142 separators between fields on a line (`:`, `-`, and `=`)
1143 and between hunks (`--`)
1147 When set to `always`, always use colors for interactive prompts
1148 and displays (such as those used by "git-add --interactive" and
1149 "git-clean --interactive"). When false (or `never`), never.
1150 When set to `true` or `auto`, use colors only when the output is
1151 to the terminal. If unset, then the value of `color.ui` is
1152 used (`auto` by default).
1154 color.interactive.<slot>::
1155 Use customized color for 'git add --interactive' and 'git clean
1156 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1157 or `error`, for four distinct types of normal output from
1158 interactive commands.
1161 A boolean to enable/disable colored output when the pager is in
1162 use (default is true).
1165 A boolean to enable/disable color in the output of
1166 linkgit:git-show-branch[1]. May be set to `always`,
1167 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1168 only when the output is to a terminal. If unset, then the
1169 value of `color.ui` is used (`auto` by default).
1172 A boolean to enable/disable color in the output of
1173 linkgit:git-status[1]. May be set to `always`,
1174 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1175 only when the output is to a terminal. If unset, then the
1176 value of `color.ui` is used (`auto` by default).
1178 color.status.<slot>::
1179 Use customized color for status colorization. `<slot>` is
1180 one of `header` (the header text of the status message),
1181 `added` or `updated` (files which are added but not committed),
1182 `changed` (files which are changed but not added in the index),
1183 `untracked` (files which are not tracked by Git),
1184 `branch` (the current branch),
1185 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1187 `localBranch` or `remoteBranch` (the local and remote branch names,
1188 respectively, when branch and tracking information is displayed in the
1189 status short-format), or
1190 `unmerged` (files which have unmerged changes).
1193 This variable determines the default value for variables such
1194 as `color.diff` and `color.grep` that control the use of color
1195 per command family. Its scope will expand as more commands learn
1196 configuration to set a default for the `--color` option. Set it
1197 to `false` or `never` if you prefer Git commands not to use
1198 color unless enabled explicitly with some other configuration
1199 or the `--color` option. Set it to `always` if you want all
1200 output not intended for machine consumption to use color, to
1201 `true` or `auto` (this is the default since Git 1.8.4) if you
1202 want such output to use color when written to the terminal.
1205 Specify whether supported commands should output in columns.
1206 This variable consists of a list of tokens separated by spaces
1209 These options control when the feature should be enabled
1210 (defaults to 'never'):
1214 always show in columns
1216 never show in columns
1218 show in columns if the output is to the terminal
1221 These options control layout (defaults to 'column'). Setting any
1222 of these implies 'always' if none of 'always', 'never', or 'auto' are
1227 fill columns before rows
1229 fill rows before columns
1234 Finally, these options can be combined with a layout option (defaults
1239 make unequal size columns to utilize more space
1241 make equal size columns
1245 Specify whether to output branch listing in `git branch` in columns.
1246 See `column.ui` for details.
1249 Specify the layout when list items in `git clean -i`, which always
1250 shows files and directories in columns. See `column.ui` for details.
1253 Specify whether to output untracked files in `git status` in columns.
1254 See `column.ui` for details.
1257 Specify whether to output tag listing in `git tag` in columns.
1258 See `column.ui` for details.
1261 This setting overrides the default of the `--cleanup` option in
1262 `git commit`. See linkgit:git-commit[1] for details. Changing the
1263 default can be useful when you always want to keep lines that begin
1264 with comment character `#` in your log message, in which case you
1265 would do `git config commit.cleanup whitespace` (note that you will
1266 have to remove the help lines that begin with `#` in the commit log
1267 template yourself, if you do this).
1271 A boolean to specify whether all commits should be GPG signed.
1272 Use of this option when doing operations such as rebase can
1273 result in a large number of commits being signed. It may be
1274 convenient to use an agent to avoid typing your GPG passphrase
1278 A boolean to enable/disable inclusion of status information in the
1279 commit message template when using an editor to prepare the commit
1280 message. Defaults to true.
1283 Specify the pathname of a file to use as the template for
1284 new commit messages.
1287 A boolean or int to specify the level of verbose with `git commit`.
1288 See linkgit:git-commit[1].
1291 Specify an external helper to be called when a username or
1292 password credential is needed; the helper may consult external
1293 storage to avoid prompting the user for the credentials. Note
1294 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1297 credential.useHttpPath::
1298 When acquiring credentials, consider the "path" component of an http
1299 or https URL to be important. Defaults to false. See
1300 linkgit:gitcredentials[7] for more information.
1302 credential.username::
1303 If no username is set for a network authentication, use this username
1304 by default. See credential.<context>.* below, and
1305 linkgit:gitcredentials[7].
1307 credential.<url>.*::
1308 Any of the credential.* options above can be applied selectively to
1309 some credentials. For example "credential.https://example.com.username"
1310 would set the default username only for https connections to
1311 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1314 credentialCache.ignoreSIGHUP::
1315 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1317 include::diff-config.txt[]
1319 difftool.<tool>.path::
1320 Override the path for the given tool. This is useful in case
1321 your tool is not in the PATH.
1323 difftool.<tool>.cmd::
1324 Specify the command to invoke the specified diff tool.
1325 The specified command is evaluated in shell with the following
1326 variables available: 'LOCAL' is set to the name of the temporary
1327 file containing the contents of the diff pre-image and 'REMOTE'
1328 is set to the name of the temporary file containing the contents
1329 of the diff post-image.
1332 Prompt before each invocation of the diff tool.
1334 fastimport.unpackLimit::
1335 If the number of objects imported by linkgit:git-fast-import[1]
1336 is below this limit, then the objects will be unpacked into
1337 loose object files. However if the number of imported objects
1338 equals or exceeds this limit then the pack will be stored as a
1339 pack. Storing the pack from a fast-import can make the import
1340 operation complete faster, especially on slow filesystems. If
1341 not set, the value of `transfer.unpackLimit` is used instead.
1343 fetch.recurseSubmodules::
1344 This option can be either set to a boolean value or to 'on-demand'.
1345 Setting it to a boolean changes the behavior of fetch and pull to
1346 unconditionally recurse into submodules when set to true or to not
1347 recurse at all when set to false. When set to 'on-demand' (the default
1348 value), fetch and pull will only recurse into a populated submodule
1349 when its superproject retrieves a commit that updates the submodule's
1353 If it is set to true, git-fetch-pack will check all fetched
1354 objects. It will abort in the case of a malformed object or a
1355 broken link. The result of an abort are only dangling objects.
1356 Defaults to false. If not set, the value of `transfer.fsckObjects`
1360 If the number of objects fetched over the Git native
1361 transfer is below this
1362 limit, then the objects will be unpacked into loose object
1363 files. However if the number of received objects equals or
1364 exceeds this limit then the received pack will be stored as
1365 a pack, after adding any missing delta bases. Storing the
1366 pack from a push can make the push operation complete faster,
1367 especially on slow filesystems. If not set, the value of
1368 `transfer.unpackLimit` is used instead.
1371 If true, fetch will automatically behave as if the `--prune`
1372 option was given on the command line. See also `remote.<name>.prune`.
1375 Control how ref update status is printed. Valid values are
1376 `full` and `compact`. Default value is `full`. See section
1377 OUTPUT in linkgit:git-fetch[1] for detail.
1380 Enable multipart/mixed attachments as the default for
1381 'format-patch'. The value can also be a double quoted string
1382 which will enable attachments as the default and set the
1383 value as the boundary. See the --attach option in
1384 linkgit:git-format-patch[1].
1387 Provides the default value for the `--from` option to format-patch.
1388 Accepts a boolean value, or a name and email address. If false,
1389 format-patch defaults to `--no-from`, using commit authors directly in
1390 the "From:" field of patch mails. If true, format-patch defaults to
1391 `--from`, using your committer identity in the "From:" field of patch
1392 mails and including a "From:" field in the body of the patch mail if
1393 different. If set to a non-boolean value, format-patch uses that
1394 value instead of your committer identity. Defaults to false.
1397 A boolean which can enable or disable sequence numbers in patch
1398 subjects. It defaults to "auto" which enables it only if there
1399 is more than one patch. It can be enabled or disabled for all
1400 messages by setting it to "true" or "false". See --numbered
1401 option in linkgit:git-format-patch[1].
1404 Additional email headers to include in a patch to be submitted
1405 by mail. See linkgit:git-format-patch[1].
1409 Additional recipients to include in a patch to be submitted
1410 by mail. See the --to and --cc options in
1411 linkgit:git-format-patch[1].
1413 format.subjectPrefix::
1414 The default for format-patch is to output files with the '[PATCH]'
1415 subject prefix. Use this variable to change that prefix.
1418 The default for format-patch is to output a signature containing
1419 the Git version number. Use this variable to change that default.
1420 Set this variable to the empty string ("") to suppress
1421 signature generation.
1423 format.signatureFile::
1424 Works just like format.signature except the contents of the
1425 file specified by this variable will be used as the signature.
1428 The default for format-patch is to output files with the suffix
1429 `.patch`. Use this variable to change that suffix (make sure to
1430 include the dot if you want it).
1433 The default pretty format for log/show/whatchanged command,
1434 See linkgit:git-log[1], linkgit:git-show[1],
1435 linkgit:git-whatchanged[1].
1438 The default threading style for 'git format-patch'. Can be
1439 a boolean value, or `shallow` or `deep`. `shallow` threading
1440 makes every mail a reply to the head of the series,
1441 where the head is chosen from the cover letter, the
1442 `--in-reply-to`, and the first patch mail, in this order.
1443 `deep` threading makes every mail a reply to the previous one.
1444 A true boolean value is the same as `shallow`, and a false
1445 value disables threading.
1448 A boolean value which lets you enable the `-s/--signoff` option of
1449 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1450 patch should be a conscious act and means that you certify you have
1451 the rights to submit this work under the same open source license.
1452 Please see the 'SubmittingPatches' document for further discussion.
1454 format.coverLetter::
1455 A boolean that controls whether to generate a cover-letter when
1456 format-patch is invoked, but in addition can be set to "auto", to
1457 generate a cover-letter only when there's more than one patch.
1459 format.outputDirectory::
1460 Set a custom directory to store the resulting files instead of the
1461 current working directory.
1463 format.useAutoBase::
1464 A boolean value which lets you enable the `--base=auto` option of
1465 format-patch by default.
1467 filter.<driver>.clean::
1468 The command which is used to convert the content of a worktree
1469 file to a blob upon checkin. See linkgit:gitattributes[5] for
1472 filter.<driver>.smudge::
1473 The command which is used to convert the content of a blob
1474 object to a worktree file upon checkout. See
1475 linkgit:gitattributes[5] for details.
1478 Allows overriding the message type (error, warn or ignore) of a
1479 specific message ID such as `missingEmail`.
1481 For convenience, fsck prefixes the error/warning with the message ID,
1482 e.g. "missingEmail: invalid author/committer line - missing email" means
1483 that setting `fsck.missingEmail = ignore` will hide that issue.
1485 This feature is intended to support working with legacy repositories
1486 which cannot be repaired without disruptive changes.
1489 The path to a sorted list of object names (i.e. one SHA-1 per
1490 line) that are known to be broken in a non-fatal way and should
1491 be ignored. This feature is useful when an established project
1492 should be accepted despite early commits containing errors that
1493 can be safely ignored such as invalid committer email addresses.
1494 Note: corrupt objects cannot be skipped with this setting.
1496 gc.aggressiveDepth::
1497 The depth parameter used in the delta compression
1498 algorithm used by 'git gc --aggressive'. This defaults
1501 gc.aggressiveWindow::
1502 The window size parameter used in the delta compression
1503 algorithm used by 'git gc --aggressive'. This defaults
1507 When there are approximately more than this many loose
1508 objects in the repository, `git gc --auto` will pack them.
1509 Some Porcelain commands use this command to perform a
1510 light-weight garbage collection from time to time. The
1511 default value is 6700. Setting this to 0 disables it.
1514 When there are more than this many packs that are not
1515 marked with `*.keep` file in the repository, `git gc
1516 --auto` consolidates them into one larger pack. The
1517 default value is 50. Setting this to 0 disables it.
1520 Make `git gc --auto` return immediately and run in background
1521 if the system supports it. Default is true.
1524 If the file gc.log exists, then `git gc --auto` won't run
1525 unless that file is more than 'gc.logExpiry' old. Default is
1526 "1.day". See `gc.pruneExpire` for more ways to specify its
1530 Running `git pack-refs` in a repository renders it
1531 unclonable by Git versions prior to 1.5.1.2 over dumb
1532 transports such as HTTP. This variable determines whether
1533 'git gc' runs `git pack-refs`. This can be set to `notbare`
1534 to enable it within all non-bare repos or it can be set to a
1535 boolean value. The default is `true`.
1538 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1539 Override the grace period with this config variable. The value
1540 "now" may be used to disable this grace period and always prune
1541 unreachable objects immediately, or "never" may be used to
1542 suppress pruning. This feature helps prevent corruption when
1543 'git gc' runs concurrently with another process writing to the
1544 repository; see the "NOTES" section of linkgit:git-gc[1].
1546 gc.worktreePruneExpire::
1547 When 'git gc' is run, it calls
1548 'git worktree prune --expire 3.months.ago'.
1549 This config variable can be used to set a different grace
1550 period. The value "now" may be used to disable the grace
1551 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1552 may be used to suppress pruning.
1555 gc.<pattern>.reflogExpire::
1556 'git reflog expire' removes reflog entries older than
1557 this time; defaults to 90 days. The value "now" expires all
1558 entries immediately, and "never" suppresses expiration
1559 altogether. With "<pattern>" (e.g.
1560 "refs/stash") in the middle the setting applies only to
1561 the refs that match the <pattern>.
1563 gc.reflogExpireUnreachable::
1564 gc.<pattern>.reflogExpireUnreachable::
1565 'git reflog expire' removes reflog entries older than
1566 this time and are not reachable from the current tip;
1567 defaults to 30 days. The value "now" expires all entries
1568 immediately, and "never" suppresses expiration altogether.
1569 With "<pattern>" (e.g. "refs/stash")
1570 in the middle, the setting applies only to the refs that
1571 match the <pattern>.
1574 Records of conflicted merge you resolved earlier are
1575 kept for this many days when 'git rerere gc' is run.
1576 You can also use more human-readable "1.month.ago", etc.
1577 The default is 60 days. See linkgit:git-rerere[1].
1579 gc.rerereUnresolved::
1580 Records of conflicted merge you have not resolved are
1581 kept for this many days when 'git rerere gc' is run.
1582 You can also use more human-readable "1.month.ago", etc.
1583 The default is 15 days. See linkgit:git-rerere[1].
1585 gitcvs.commitMsgAnnotation::
1586 Append this string to each commit message. Set to empty string
1587 to disable this feature. Defaults to "via git-CVS emulator".
1590 Whether the CVS server interface is enabled for this repository.
1591 See linkgit:git-cvsserver[1].
1594 Path to a log file where the CVS server interface well... logs
1595 various stuff. See linkgit:git-cvsserver[1].
1597 gitcvs.usecrlfattr::
1598 If true, the server will look up the end-of-line conversion
1599 attributes for files to determine the `-k` modes to use. If
1600 the attributes force Git to treat a file as text,
1601 the `-k` mode will be left blank so CVS clients will
1602 treat it as text. If they suppress text conversion, the file
1603 will be set with '-kb' mode, which suppresses any newline munging
1604 the client might otherwise do. If the attributes do not allow
1605 the file type to be determined, then `gitcvs.allBinary` is
1606 used. See linkgit:gitattributes[5].
1609 This is used if `gitcvs.usecrlfattr` does not resolve
1610 the correct '-kb' mode to use. If true, all
1611 unresolved files are sent to the client in
1612 mode '-kb'. This causes the client to treat them
1613 as binary files, which suppresses any newline munging it
1614 otherwise might do. Alternatively, if it is set to "guess",
1615 then the contents of the file are examined to decide if
1616 it is binary, similar to `core.autocrlf`.
1619 Database used by git-cvsserver to cache revision information
1620 derived from the Git repository. The exact meaning depends on the
1621 used database driver, for SQLite (which is the default driver) this
1622 is a filename. Supports variable substitution (see
1623 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1624 Default: '%Ggitcvs.%m.sqlite'
1627 Used Perl DBI driver. You can specify any available driver
1628 for this here, but it might not work. git-cvsserver is tested
1629 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1630 reported *not* to work with 'DBD::mysql'. Experimental feature.
1631 May not contain double colons (`:`). Default: 'SQLite'.
1632 See linkgit:git-cvsserver[1].
1634 gitcvs.dbUser, gitcvs.dbPass::
1635 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1636 since SQLite has no concept of database users and/or passwords.
1637 'gitcvs.dbUser' supports variable substitution (see
1638 linkgit:git-cvsserver[1] for details).
1640 gitcvs.dbTableNamePrefix::
1641 Database table name prefix. Prepended to the names of any
1642 database tables used, allowing a single database to be used
1643 for several repositories. Supports variable substitution (see
1644 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1645 characters will be replaced with underscores.
1647 All gitcvs variables except for `gitcvs.usecrlfattr` and
1648 `gitcvs.allBinary` can also be specified as
1649 'gitcvs.<access_method>.<varname>' (where 'access_method'
1650 is one of "ext" and "pserver") to make them apply only for the given
1654 gitweb.description::
1657 See linkgit:gitweb[1] for description.
1665 gitweb.remote_heads::
1668 See linkgit:gitweb.conf[5] for description.
1671 If set to true, enable `-n` option by default.
1674 Set the default matching behavior. Using a value of 'basic', 'extended',
1675 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1676 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1677 value 'default' will return to the default matching behavior.
1679 grep.extendedRegexp::
1680 If set to true, enable `--extended-regexp` option by default. This
1681 option is ignored when the `grep.patternType` option is set to a value
1682 other than 'default'.
1685 Number of grep worker threads to use.
1686 See `grep.threads` in linkgit:git-grep[1] for more information.
1688 grep.fallbackToNoIndex::
1689 If set to true, fall back to git grep --no-index if git grep
1690 is executed outside of a git repository. Defaults to false.
1693 Use this custom program instead of "`gpg`" found on `$PATH` when
1694 making or verifying a PGP signature. The program must support the
1695 same command-line interface as GPG, namely, to verify a detached
1696 signature, "`gpg --verify $file - <$signature`" is run, and the
1697 program is expected to signal a good signature by exiting with
1698 code 0, and to generate an ASCII-armored detached signature, the
1699 standard input of "`gpg -bsau $key`" is fed with the contents to be
1700 signed, and the program is expected to send the result to its
1703 gui.commitMsgWidth::
1704 Defines how wide the commit message window is in the
1705 linkgit:git-gui[1]. "75" is the default.
1708 Specifies how many context lines should be used in calls to diff
1709 made by the linkgit:git-gui[1]. The default is "5".
1711 gui.displayUntracked::
1712 Determines if linkgit:git-gui[1] shows untracked files
1713 in the file list. The default is "true".
1716 Specifies the default encoding to use for displaying of
1717 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1718 It can be overridden by setting the 'encoding' attribute
1719 for relevant files (see linkgit:gitattributes[5]).
1720 If this option is not set, the tools default to the
1723 gui.matchTrackingBranch::
1724 Determines if new branches created with linkgit:git-gui[1] should
1725 default to tracking remote branches with matching names or
1726 not. Default: "false".
1728 gui.newBranchTemplate::
1729 Is used as suggested name when creating new branches using the
1732 gui.pruneDuringFetch::
1733 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1734 performing a fetch. The default value is "false".
1737 Determines if linkgit:git-gui[1] should trust the file modification
1738 timestamp or not. By default the timestamps are not trusted.
1740 gui.spellingDictionary::
1741 Specifies the dictionary used for spell checking commit messages in
1742 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1746 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1747 location detection. It makes blame significantly faster on huge
1748 repositories at the expense of less thorough copy detection.
1750 gui.copyBlameThreshold::
1751 Specifies the threshold to use in 'git gui blame' original location
1752 detection, measured in alphanumeric characters. See the
1753 linkgit:git-blame[1] manual for more information on copy detection.
1755 gui.blamehistoryctx::
1756 Specifies the radius of history context in days to show in
1757 linkgit:gitk[1] for the selected commit, when the `Show History
1758 Context` menu item is invoked from 'git gui blame'. If this
1759 variable is set to zero, the whole history is shown.
1761 guitool.<name>.cmd::
1762 Specifies the shell command line to execute when the corresponding item
1763 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1764 mandatory for every tool. The command is executed from the root of
1765 the working directory, and in the environment it receives the name of
1766 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1767 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1768 the head is detached, 'CUR_BRANCH' is empty).
1770 guitool.<name>.needsFile::
1771 Run the tool only if a diff is selected in the GUI. It guarantees
1772 that 'FILENAME' is not empty.
1774 guitool.<name>.noConsole::
1775 Run the command silently, without creating a window to display its
1778 guitool.<name>.noRescan::
1779 Don't rescan the working directory for changes after the tool
1782 guitool.<name>.confirm::
1783 Show a confirmation dialog before actually running the tool.
1785 guitool.<name>.argPrompt::
1786 Request a string argument from the user, and pass it to the tool
1787 through the `ARGS` environment variable. Since requesting an
1788 argument implies confirmation, the 'confirm' option has no effect
1789 if this is enabled. If the option is set to 'true', 'yes', or '1',
1790 the dialog uses a built-in generic prompt; otherwise the exact
1791 value of the variable is used.
1793 guitool.<name>.revPrompt::
1794 Request a single valid revision from the user, and set the
1795 `REVISION` environment variable. In other aspects this option
1796 is similar to 'argPrompt', and can be used together with it.
1798 guitool.<name>.revUnmerged::
1799 Show only unmerged branches in the 'revPrompt' subdialog.
1800 This is useful for tools similar to merge or rebase, but not
1801 for things like checkout or reset.
1803 guitool.<name>.title::
1804 Specifies the title to use for the prompt dialog. The default
1807 guitool.<name>.prompt::
1808 Specifies the general prompt string to display at the top of
1809 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1810 The default value includes the actual command.
1813 Specify the browser that will be used to display help in the
1814 'web' format. See linkgit:git-help[1].
1817 Override the default help format used by linkgit:git-help[1].
1818 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1819 the default. 'web' and 'html' are the same.
1822 Automatically correct and execute mistyped commands after
1823 waiting for the given number of deciseconds (0.1 sec). If more
1824 than one command can be deduced from the entered text, nothing
1825 will be executed. If the value of this option is negative,
1826 the corrected command will be executed immediately. If the
1827 value is 0 - the command will be just shown but not executed.
1828 This is the default.
1831 Specify the path where the HTML documentation resides. File system paths
1832 and URLs are supported. HTML pages will be prefixed with this path when
1833 help is displayed in the 'web' format. This defaults to the documentation
1834 path of your Git installation.
1837 Override the HTTP proxy, normally configured using the 'http_proxy',
1838 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1839 addition to the syntax understood by curl, it is possible to specify a
1840 proxy string with a user name but no password, in which case git will
1841 attempt to acquire one in the same way it does for other credentials. See
1842 linkgit:gitcredentials[7] for more information. The syntax thus is
1843 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1844 on a per-remote basis; see remote.<name>.proxy
1846 http.proxyAuthMethod::
1847 Set the method with which to authenticate against the HTTP proxy. This
1848 only takes effect if the configured proxy string contains a user name part
1849 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1850 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1851 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1852 variable. Possible values are:
1855 * `anyauth` - Automatically pick a suitable authentication method. It is
1856 assumed that the proxy answers an unauthenticated request with a 407
1857 status code and one or more Proxy-authenticate headers with supported
1858 authentication methods. This is the default.
1859 * `basic` - HTTP Basic authentication
1860 * `digest` - HTTP Digest authentication; this prevents the password from being
1861 transmitted to the proxy in clear text
1862 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1864 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1868 Attempt authentication without seeking a username or password. This
1869 can be used to attempt GSS-Negotiate authentication without specifying
1870 a username in the URL, as libcurl normally requires a username for
1874 Control GSSAPI credential delegation. The delegation is disabled
1875 by default in libcurl since version 7.21.7. Set parameter to tell
1876 the server what it is allowed to delegate when it comes to user
1877 credentials. Used with GSS/kerberos. Possible values are:
1880 * `none` - Don't allow any delegation.
1881 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1882 Kerberos service ticket, which is a matter of realm policy.
1883 * `always` - Unconditionally allow the server to delegate.
1888 Pass an additional HTTP header when communicating with a server. If
1889 more than one such entry exists, all of them are added as extra
1890 headers. To allow overriding the settings inherited from the system
1891 config, an empty value will reset the extra headers to the empty list.
1894 The pathname of a file containing previously stored cookie lines,
1895 which should be used
1896 in the Git http session, if they match the server. The file format
1897 of the file to read cookies from should be plain HTTP headers or
1898 the Netscape/Mozilla cookie file format (see `curl(1)`).
1899 NOTE that the file specified with http.cookieFile is used only as
1900 input unless http.saveCookies is set.
1903 If set, store cookies received during requests to the file specified by
1904 http.cookieFile. Has no effect if http.cookieFile is unset.
1907 The SSL version to use when negotiating an SSL connection, if you
1908 want to force the default. The available and default version
1909 depend on whether libcurl was built against NSS or OpenSSL and the
1910 particular configuration of the crypto library in use. Internally
1911 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1912 documentation for more details on the format of this option and
1913 for the ssl version supported. Actually the possible values of
1924 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1925 To force git to use libcurl's default ssl version and ignore any
1926 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1929 http.sslCipherList::
1930 A list of SSL ciphers to use when negotiating an SSL connection.
1931 The available ciphers depend on whether libcurl was built against
1932 NSS or OpenSSL and the particular configuration of the crypto
1933 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1934 option; see the libcurl documentation for more details on the format
1937 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1938 To force git to use libcurl's default cipher list and ignore any
1939 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1943 Whether to verify the SSL certificate when fetching or pushing
1944 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1948 File containing the SSL certificate when fetching or pushing
1949 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1953 File containing the SSL private key when fetching or pushing
1954 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1957 http.sslCertPasswordProtected::
1958 Enable Git's password prompt for the SSL certificate. Otherwise
1959 OpenSSL will prompt the user, possibly many times, if the
1960 certificate or private key is encrypted. Can be overridden by the
1961 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1964 File containing the certificates to verify the peer with when
1965 fetching or pushing over HTTPS. Can be overridden by the
1966 `GIT_SSL_CAINFO` environment variable.
1969 Path containing files with the CA certificates to verify the peer
1970 with when fetching or pushing over HTTPS. Can be overridden
1971 by the `GIT_SSL_CAPATH` environment variable.
1974 Public key of the https service. It may either be the filename of
1975 a PEM or DER encoded public key file or a string starting with
1976 'sha256//' followed by the base64 encoded sha256 hash of the
1977 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1978 exit with an error if this option is set but not supported by
1982 Attempt to use AUTH SSL/TLS and encrypted data transfers
1983 when connecting via regular FTP protocol. This might be needed
1984 if the FTP server requires it for security reasons or you wish
1985 to connect securely whenever remote FTP server supports it.
1986 Default is false since it might trigger certificate verification
1987 errors on misconfigured servers.
1990 How many HTTP requests to launch in parallel. Can be overridden
1991 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1994 The number of curl sessions (counted across slots) to be kept across
1995 requests. They will not be ended with curl_easy_cleanup() until
1996 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1997 value will be capped at 1. Defaults to 1.
2000 Maximum size in bytes of the buffer used by smart HTTP
2001 transports when POSTing data to the remote system.
2002 For requests larger than this buffer size, HTTP/1.1 and
2003 Transfer-Encoding: chunked is used to avoid creating a
2004 massive pack file locally. Default is 1 MiB, which is
2005 sufficient for most requests.
2007 http.lowSpeedLimit, http.lowSpeedTime::
2008 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2009 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2010 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2011 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2014 A boolean which disables using of EPSV ftp command by curl.
2015 This can helpful with some "poor" ftp servers which don't
2016 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2017 environment variable. Default is false (curl will use EPSV).
2020 The HTTP USER_AGENT string presented to an HTTP server. The default
2021 value represents the version of the client Git such as git/1.7.1.
2022 This option allows you to override this value to a more common value
2023 such as Mozilla/4.0. This may be necessary, for instance, if
2024 connecting through a firewall that restricts HTTP connections to a set
2025 of common USER_AGENT strings (but not including those like git/1.7.1).
2026 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2028 http.followRedirects::
2029 Whether git should follow HTTP redirects. If set to `true`, git
2030 will transparently follow any redirect issued by a server it
2031 encounters. If set to `false`, git will treat all redirects as
2032 errors. If set to `initial`, git will follow redirects only for
2033 the initial request to a remote, but not for subsequent
2034 follow-up HTTP requests. Since git uses the redirected URL as
2035 the base for the follow-up requests, this is generally
2036 sufficient. The default is `initial`.
2039 Any of the http.* options above can be applied selectively to some URLs.
2040 For a config key to match a URL, each element of the config key is
2041 compared to that of the URL, in the following order:
2044 . Scheme (e.g., `https` in `https://example.com/`). This field
2045 must match exactly between the config key and the URL.
2047 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2048 This field must match between the config key and the URL. It is
2049 possible to specify a `*` as part of the host name to match all subdomains
2050 at this level. `https://*.example.com/` for example would match
2051 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2053 . Port number (e.g., `8080` in `http://example.com:8080/`).
2054 This field must match exactly between the config key and the URL.
2055 Omitted port numbers are automatically converted to the correct
2056 default for the scheme before matching.
2058 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2059 path field of the config key must match the path field of the URL
2060 either exactly or as a prefix of slash-delimited path elements. This means
2061 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2062 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2063 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2064 key with just path `foo/`).
2066 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2067 the config key has a user name it must match the user name in the
2068 URL exactly. If the config key does not have a user name, that
2069 config key will match a URL with any user name (including none),
2070 but at a lower precedence than a config key with a user name.
2073 The list above is ordered by decreasing precedence; a URL that matches
2074 a config key's path is preferred to one that matches its user name. For example,
2075 if the URL is `https://user@example.com/foo/bar` a config key match of
2076 `https://example.com/foo` will be preferred over a config key match of
2077 `https://user@example.com`.
2079 All URLs are normalized before attempting any matching (the password part,
2080 if embedded in the URL, is always ignored for matching purposes) so that
2081 equivalent URLs that are simply spelled differently will match properly.
2082 Environment variable settings always override any matches. The URLs that are
2083 matched against are those given directly to Git commands. This means any URLs
2084 visited as a result of a redirection do not participate in matching.
2087 Depending on the value of the environment variables `GIT_SSH` or
2088 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2089 auto-detects whether to adjust its command-line parameters for use
2090 with plink or tortoiseplink, as opposed to the default (OpenSSH).
2092 The config variable `ssh.variant` can be set to override this auto-detection;
2093 valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2094 will be treated as normal ssh. This setting can be overridden via the
2095 environment variable `GIT_SSH_VARIANT`.
2097 i18n.commitEncoding::
2098 Character encoding the commit messages are stored in; Git itself
2099 does not care per se, but this information is necessary e.g. when
2100 importing commits from emails or in the gitk graphical history
2101 browser (and possibly at other places in the future or in other
2102 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2104 i18n.logOutputEncoding::
2105 Character encoding the commit messages are converted to when
2106 running 'git log' and friends.
2109 The configuration variables in the 'imap' section are described
2110 in linkgit:git-imap-send[1].
2113 Specify the version with which new index files should be
2114 initialized. This does not affect existing repositories.
2117 Specify the directory from which templates will be copied.
2118 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2121 Specify the program that will be used to browse your working
2122 repository in gitweb. See linkgit:git-instaweb[1].
2125 The HTTP daemon command-line to start gitweb on your working
2126 repository. See linkgit:git-instaweb[1].
2129 If true the web server started by linkgit:git-instaweb[1] will
2130 be bound to the local IP (127.0.0.1).
2132 instaweb.modulePath::
2133 The default module path for linkgit:git-instaweb[1] to use
2134 instead of /usr/lib/apache2/modules. Only used if httpd
2138 The port number to bind the gitweb httpd to. See
2139 linkgit:git-instaweb[1].
2141 interactive.singleKey::
2142 In interactive commands, allow the user to provide one-letter
2143 input with a single key (i.e., without hitting enter).
2144 Currently this is used by the `--patch` mode of
2145 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2146 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2147 setting is silently ignored if portable keystroke input
2148 is not available; requires the Perl module Term::ReadKey.
2150 interactive.diffFilter::
2151 When an interactive command (such as `git add --patch`) shows
2152 a colorized diff, git will pipe the diff through the shell
2153 command defined by this configuration variable. The command may
2154 mark up the diff further for human consumption, provided that it
2155 retains a one-to-one correspondence with the lines in the
2156 original diff. Defaults to disabled (no filtering).
2159 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2160 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2161 override this option with `--no-abbrev-commit`.
2164 Set the default date-time mode for the 'log' command.
2165 Setting a value for log.date is similar to using 'git log''s
2166 `--date` option. See linkgit:git-log[1] for details.
2169 Print out the ref names of any commits that are shown by the log
2170 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2171 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2172 specified, the full ref name (including prefix) will be printed.
2173 If 'auto' is specified, then if the output is going to a terminal,
2174 the ref names are shown as if 'short' were given, otherwise no ref
2175 names are shown. This is the same as the `--decorate` option
2179 If `true`, `git log` will act as if the `--follow` option was used when
2180 a single <path> is given. This has the same limitations as `--follow`,
2181 i.e. it cannot be used to follow multiple files and does not work well
2182 on non-linear history.
2185 A list of colors, separated by commas, that can be used to draw
2186 history lines in `git log --graph`.
2189 If true, the initial commit will be shown as a big creation event.
2190 This is equivalent to a diff against an empty tree.
2191 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2192 normally hide the root commit will now show it. True by default.
2195 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2196 linkgit:git-whatchanged[1] assume `--show-signature`.
2199 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2200 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2203 If true, makes linkgit:git-mailinfo[1] (and therefore
2204 linkgit:git-am[1]) act by default as if the --scissors option
2205 was provided on the command-line. When active, this features
2206 removes everything from the message body before a scissors
2207 line (i.e. consisting mainly of ">8", "8<" and "-").
2210 The location of an augmenting mailmap file. The default
2211 mailmap, located in the root of the repository, is loaded
2212 first, then the mailmap file pointed to by this variable.
2213 The location of the mailmap file may be in a repository
2214 subdirectory, or somewhere outside of the repository itself.
2215 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2218 Like `mailmap.file`, but consider the value as a reference to a
2219 blob in the repository. If both `mailmap.file` and
2220 `mailmap.blob` are given, both are parsed, with entries from
2221 `mailmap.file` taking precedence. In a bare repository, this
2222 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2226 Specify the programs that may be used to display help in the
2227 'man' format. See linkgit:git-help[1].
2230 Specify the command to invoke the specified man viewer. The
2231 specified command is evaluated in shell with the man page
2232 passed as argument. (See linkgit:git-help[1].)
2235 Override the path for the given tool that may be used to
2236 display help in the 'man' format. See linkgit:git-help[1].
2238 include::merge-config.txt[]
2240 mergetool.<tool>.path::
2241 Override the path for the given tool. This is useful in case
2242 your tool is not in the PATH.
2244 mergetool.<tool>.cmd::
2245 Specify the command to invoke the specified merge tool. The
2246 specified command is evaluated in shell with the following
2247 variables available: 'BASE' is the name of a temporary file
2248 containing the common base of the files to be merged, if available;
2249 'LOCAL' is the name of a temporary file containing the contents of
2250 the file on the current branch; 'REMOTE' is the name of a temporary
2251 file containing the contents of the file from the branch being
2252 merged; 'MERGED' contains the name of the file to which the merge
2253 tool should write the results of a successful merge.
2255 mergetool.<tool>.trustExitCode::
2256 For a custom merge command, specify whether the exit code of
2257 the merge command can be used to determine whether the merge was
2258 successful. If this is not set to true then the merge target file
2259 timestamp is checked and the merge assumed to have been successful
2260 if the file has been updated, otherwise the user is prompted to
2261 indicate the success of the merge.
2263 mergetool.meld.hasOutput::
2264 Older versions of `meld` do not support the `--output` option.
2265 Git will attempt to detect whether `meld` supports `--output`
2266 by inspecting the output of `meld --help`. Configuring
2267 `mergetool.meld.hasOutput` will make Git skip these checks and
2268 use the configured value instead. Setting `mergetool.meld.hasOutput`
2269 to `true` tells Git to unconditionally use the `--output` option,
2270 and `false` avoids using `--output`.
2272 mergetool.keepBackup::
2273 After performing a merge, the original file with conflict markers
2274 can be saved as a file with a `.orig` extension. If this variable
2275 is set to `false` then this file is not preserved. Defaults to
2276 `true` (i.e. keep the backup files).
2278 mergetool.keepTemporaries::
2279 When invoking a custom merge tool, Git uses a set of temporary
2280 files to pass to the tool. If the tool returns an error and this
2281 variable is set to `true`, then these temporary files will be
2282 preserved, otherwise they will be removed after the tool has
2283 exited. Defaults to `false`.
2285 mergetool.writeToTemp::
2286 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2287 conflicting files in the worktree by default. Git will attempt
2288 to use a temporary directory for these files when set `true`.
2289 Defaults to `false`.
2292 Prompt before each invocation of the merge resolution program.
2294 notes.mergeStrategy::
2295 Which merge strategy to choose by default when resolving notes
2296 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2297 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2298 section of linkgit:git-notes[1] for more information on each strategy.
2300 notes.<name>.mergeStrategy::
2301 Which merge strategy to choose when doing a notes merge into
2302 refs/notes/<name>. This overrides the more general
2303 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2304 linkgit:git-notes[1] for more information on the available strategies.
2307 The (fully qualified) refname from which to show notes when
2308 showing commit messages. The value of this variable can be set
2309 to a glob, in which case notes from all matching refs will be
2310 shown. You may also specify this configuration variable
2311 several times. A warning will be issued for refs that do not
2312 exist, but a glob that does not match any refs is silently
2315 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2316 environment variable, which must be a colon separated list of refs or
2319 The effective value of "core.notesRef" (possibly overridden by
2320 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2323 notes.rewrite.<command>::
2324 When rewriting commits with <command> (currently `amend` or
2325 `rebase`) and this variable is set to `true`, Git
2326 automatically copies your notes from the original to the
2327 rewritten commit. Defaults to `true`, but see
2328 "notes.rewriteRef" below.
2331 When copying notes during a rewrite (see the
2332 "notes.rewrite.<command>" option), determines what to do if
2333 the target commit already has a note. Must be one of
2334 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2335 Defaults to `concatenate`.
2337 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2338 environment variable.
2341 When copying notes during a rewrite, specifies the (fully
2342 qualified) ref whose notes should be copied. The ref may be a
2343 glob, in which case notes in all matching refs will be copied.
2344 You may also specify this configuration several times.
2346 Does not have a default value; you must configure this variable to
2347 enable note rewriting. Set it to `refs/notes/commits` to enable
2348 rewriting for the default commit notes.
2350 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2351 environment variable, which must be a colon separated list of refs or
2355 The size of the window used by linkgit:git-pack-objects[1] when no
2356 window size is given on the command line. Defaults to 10.
2359 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2360 maximum depth is given on the command line. Defaults to 50.
2363 The maximum size of memory that is consumed by each thread
2364 in linkgit:git-pack-objects[1] for pack window memory when
2365 no limit is given on the command line. The value can be
2366 suffixed with "k", "m", or "g". When left unconfigured (or
2367 set explicitly to 0), there will be no limit.
2370 An integer -1..9, indicating the compression level for objects
2371 in a pack file. -1 is the zlib default. 0 means no
2372 compression, and 1..9 are various speed/size tradeoffs, 9 being
2373 slowest. If not set, defaults to core.compression. If that is
2374 not set, defaults to -1, the zlib default, which is "a default
2375 compromise between speed and compression (currently equivalent
2378 Note that changing the compression level will not automatically recompress
2379 all existing objects. You can force recompression by passing the -F option
2380 to linkgit:git-repack[1].
2382 pack.deltaCacheSize::
2383 The maximum memory in bytes used for caching deltas in
2384 linkgit:git-pack-objects[1] before writing them out to a pack.
2385 This cache is used to speed up the writing object phase by not
2386 having to recompute the final delta result once the best match
2387 for all objects is found. Repacking large repositories on machines
2388 which are tight with memory might be badly impacted by this though,
2389 especially if this cache pushes the system into swapping.
2390 A value of 0 means no limit. The smallest size of 1 byte may be
2391 used to virtually disable this cache. Defaults to 256 MiB.
2393 pack.deltaCacheLimit::
2394 The maximum size of a delta, that is cached in
2395 linkgit:git-pack-objects[1]. This cache is used to speed up the
2396 writing object phase by not having to recompute the final delta
2397 result once the best match for all objects is found. Defaults to 1000.
2400 Specifies the number of threads to spawn when searching for best
2401 delta matches. This requires that linkgit:git-pack-objects[1]
2402 be compiled with pthreads otherwise this option is ignored with a
2403 warning. This is meant to reduce packing time on multiprocessor
2404 machines. The required amount of memory for the delta search window
2405 is however multiplied by the number of threads.
2406 Specifying 0 will cause Git to auto-detect the number of CPU's
2407 and set the number of threads accordingly.
2410 Specify the default pack index version. Valid values are 1 for
2411 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2412 the new pack index with capabilities for packs larger than 4 GB
2413 as well as proper protection against the repacking of corrupted
2414 packs. Version 2 is the default. Note that version 2 is enforced
2415 and this config option ignored whenever the corresponding pack is
2418 If you have an old Git that does not understand the version 2 `*.idx` file,
2419 cloning or fetching over a non native protocol (e.g. "http")
2420 that will copy both `*.pack` file and corresponding `*.idx` file from the
2421 other side may give you a repository that cannot be accessed with your
2422 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2423 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2426 pack.packSizeLimit::
2427 The maximum size of a pack. This setting only affects
2428 packing to a file when repacking, i.e. the git:// protocol
2429 is unaffected. It can be overridden by the `--max-pack-size`
2430 option of linkgit:git-repack[1]. Reaching this limit results
2431 in the creation of multiple packfiles; which in turn prevents
2432 bitmaps from being created.
2433 The minimum size allowed is limited to 1 MiB.
2434 The default is unlimited.
2435 Common unit suffixes of 'k', 'm', or 'g' are
2439 When true, git will use pack bitmaps (if available) when packing
2440 to stdout (e.g., during the server side of a fetch). Defaults to
2441 true. You should not generally need to turn this off unless
2442 you are debugging pack bitmaps.
2444 pack.writeBitmaps (deprecated)::
2445 This is a deprecated synonym for `repack.writeBitmaps`.
2447 pack.writeBitmapHashCache::
2448 When true, git will include a "hash cache" section in the bitmap
2449 index (if one is written). This cache can be used to feed git's
2450 delta heuristics, potentially leading to better deltas between
2451 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2452 between an older, bitmapped pack and objects that have been
2453 pushed since the last gc). The downside is that it consumes 4
2454 bytes per object of disk space, and that JGit's bitmap
2455 implementation does not understand it, causing it to complain if
2456 Git and JGit are used on the same repository. Defaults to false.
2459 If the value is boolean, turns on or off pagination of the
2460 output of a particular Git subcommand when writing to a tty.
2461 Otherwise, turns on pagination for the subcommand using the
2462 pager specified by the value of `pager.<cmd>`. If `--paginate`
2463 or `--no-pager` is specified on the command line, it takes
2464 precedence over this option. To disable pagination for all
2465 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2468 Alias for a --pretty= format string, as specified in
2469 linkgit:git-log[1]. Any aliases defined here can be used just
2470 as the built-in pretty formats could. For example,
2471 running `git config pretty.changelog "format:* %H %s"`
2472 would cause the invocation `git log --pretty=changelog`
2473 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2474 Note that an alias with the same name as a built-in format
2475 will be silently ignored.
2478 If set, provide a user defined default policy for all protocols which
2479 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2480 if unset, known-safe protocols (http, https, git, ssh, file) have a
2481 default policy of `always`, known-dangerous protocols (ext) have a
2482 default policy of `never`, and all other protocols have a default
2483 policy of `user`. Supported policies:
2487 * `always` - protocol is always able to be used.
2489 * `never` - protocol is never able to be used.
2491 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2492 either unset or has a value of 1. This policy should be used when you want a
2493 protocol to be directly usable by the user but don't want it used by commands which
2494 execute clone/fetch/push commands without user input, e.g. recursive
2495 submodule initialization.
2499 protocol.<name>.allow::
2500 Set a policy to be used by protocol `<name>` with clone/fetch/push
2501 commands. See `protocol.allow` above for the available policies.
2503 The protocol names currently used by git are:
2506 - `file`: any local file-based path (including `file://` URLs,
2509 - `git`: the anonymous git protocol over a direct TCP
2510 connection (or proxy, if configured)
2512 - `ssh`: git over ssh (including `host:path` syntax,
2515 - `http`: git over http, both "smart http" and "dumb http".
2516 Note that this does _not_ include `https`; if you want to configure
2517 both, you must do so individually.
2519 - any external helpers are named by their protocol (e.g., use
2520 `hg` to allow the `git-remote-hg` helper)
2524 By default, Git does not create an extra merge commit when merging
2525 a commit that is a descendant of the current commit. Instead, the
2526 tip of the current branch is fast-forwarded. When set to `false`,
2527 this variable tells Git to create an extra merge commit in such
2528 a case (equivalent to giving the `--no-ff` option from the command
2529 line). When set to `only`, only such fast-forward merges are
2530 allowed (equivalent to giving the `--ff-only` option from the
2531 command line). This setting overrides `merge.ff` when pulling.
2534 When true, rebase branches on top of the fetched branch, instead
2535 of merging the default branch from the default remote when "git
2536 pull" is run. See "branch.<name>.rebase" for setting this on a
2539 When preserve, also pass `--preserve-merges` along to 'git rebase'
2540 so that locally committed merge commits will not be flattened
2541 by running 'git pull'.
2543 When the value is `interactive`, the rebase is run in interactive mode.
2545 *NOTE*: this is a possibly dangerous operation; do *not* use
2546 it unless you understand the implications (see linkgit:git-rebase[1]
2550 The default merge strategy to use when pulling multiple branches
2554 The default merge strategy to use when pulling a single branch.
2557 Defines the action `git push` should take if no refspec is
2558 explicitly given. Different values are well-suited for
2559 specific workflows; for instance, in a purely central workflow
2560 (i.e. the fetch source is equal to the push destination),
2561 `upstream` is probably what you want. Possible values are:
2565 * `nothing` - do not push anything (error out) unless a refspec is
2566 explicitly given. This is primarily meant for people who want to
2567 avoid mistakes by always being explicit.
2569 * `current` - push the current branch to update a branch with the same
2570 name on the receiving end. Works in both central and non-central
2573 * `upstream` - push the current branch back to the branch whose
2574 changes are usually integrated into the current branch (which is
2575 called `@{upstream}`). This mode only makes sense if you are
2576 pushing to the same repository you would normally pull from
2577 (i.e. central workflow).
2579 * `tracking` - This is a deprecated synonym for `upstream`.
2581 * `simple` - in centralized workflow, work like `upstream` with an
2582 added safety to refuse to push if the upstream branch's name is
2583 different from the local one.
2585 When pushing to a remote that is different from the remote you normally
2586 pull from, work as `current`. This is the safest option and is suited
2589 This mode has become the default in Git 2.0.
2591 * `matching` - push all branches having the same name on both ends.
2592 This makes the repository you are pushing to remember the set of
2593 branches that will be pushed out (e.g. if you always push 'maint'
2594 and 'master' there and no other branches, the repository you push
2595 to will have these two branches, and your local 'maint' and
2596 'master' will be pushed there).
2598 To use this mode effectively, you have to make sure _all_ the
2599 branches you would push out are ready to be pushed out before
2600 running 'git push', as the whole point of this mode is to allow you
2601 to push all of the branches in one go. If you usually finish work
2602 on only one branch and push out the result, while other branches are
2603 unfinished, this mode is not for you. Also this mode is not
2604 suitable for pushing into a shared central repository, as other
2605 people may add new branches there, or update the tip of existing
2606 branches outside your control.
2608 This used to be the default, but not since Git 2.0 (`simple` is the
2614 If set to true enable `--follow-tags` option by default. You
2615 may override this configuration at time of push by specifying
2619 May be set to a boolean value, or the string 'if-asked'. A true
2620 value causes all pushes to be GPG signed, as if `--signed` is
2621 passed to linkgit:git-push[1]. The string 'if-asked' causes
2622 pushes to be signed if the server supports it, as if
2623 `--signed=if-asked` is passed to 'git push'. A false value may
2624 override a value from a lower-priority config file. An explicit
2625 command-line flag always overrides this config option.
2628 When no `--push-option=<option>` argument is given from the
2629 command line, `git push` behaves as if each <value> of
2630 this variable is given as `--push-option=<value>`.
2632 This is a multi-valued variable, and an empty value can be used in a
2633 higher priority configuration file (e.g. `.git/config` in a
2634 repository) to clear the values inherited from a lower priority
2635 configuration files (e.g. `$HOME/.gitconfig`).
2652 This will result in only b (a and c are cleared).
2656 push.recurseSubmodules::
2657 Make sure all submodule commits used by the revisions to be pushed
2658 are available on a remote-tracking branch. If the value is 'check'
2659 then Git will verify that all submodule commits that changed in the
2660 revisions to be pushed are available on at least one remote of the
2661 submodule. If any commits are missing, the push will be aborted and
2662 exit with non-zero status. If the value is 'on-demand' then all
2663 submodules that changed in the revisions to be pushed will be
2664 pushed. If on-demand was not able to push all necessary revisions
2665 it will also be aborted and exit with non-zero status. If the value
2666 is 'no' then default behavior of ignoring submodules when pushing
2667 is retained. You may override this configuration at time of push by
2668 specifying '--recurse-submodules=check|on-demand|no'.
2671 Whether to show a diffstat of what changed upstream since the last
2672 rebase. False by default.
2675 If set to true enable `--autosquash` option by default.
2678 When set to true, automatically create a temporary stash entry
2679 before the operation begins, and apply it after the operation
2680 ends. This means that you can run rebase on a dirty worktree.
2681 However, use with care: the final stash application after a
2682 successful rebase might result in non-trivial conflicts.
2685 rebase.missingCommitsCheck::
2686 If set to "warn", git rebase -i will print a warning if some
2687 commits are removed (e.g. a line was deleted), however the
2688 rebase will still proceed. If set to "error", it will print
2689 the previous warning and stop the rebase, 'git rebase
2690 --edit-todo' can then be used to correct the error. If set to
2691 "ignore", no checking is done.
2692 To drop a commit without warning or error, use the `drop`
2693 command in the todo-list.
2694 Defaults to "ignore".
2696 rebase.instructionFormat::
2697 A format string, as specified in linkgit:git-log[1], to be used for
2698 the instruction list during an interactive rebase. The format will automatically
2699 have the long commit hash prepended to the format.
2701 receive.advertiseAtomic::
2702 By default, git-receive-pack will advertise the atomic push
2703 capability to its clients. If you don't want to advertise this
2704 capability, set this variable to false.
2706 receive.advertisePushOptions::
2707 When set to true, git-receive-pack will advertise the push options
2708 capability to its clients. False by default.
2711 By default, git-receive-pack will run "git-gc --auto" after
2712 receiving data from git-push and updating refs. You can stop
2713 it by setting this variable to false.
2715 receive.certNonceSeed::
2716 By setting this variable to a string, `git receive-pack`
2717 will accept a `git push --signed` and verifies it by using
2718 a "nonce" protected by HMAC using this string as a secret
2721 receive.certNonceSlop::
2722 When a `git push --signed` sent a push certificate with a
2723 "nonce" that was issued by a receive-pack serving the same
2724 repository within this many seconds, export the "nonce"
2725 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2726 hooks (instead of what the receive-pack asked the sending
2727 side to include). This may allow writing checks in
2728 `pre-receive` and `post-receive` a bit easier. Instead of
2729 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2730 that records by how many seconds the nonce is stale to
2731 decide if they want to accept the certificate, they only
2732 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2734 receive.fsckObjects::
2735 If it is set to true, git-receive-pack will check all received
2736 objects. It will abort in the case of a malformed object or a
2737 broken link. The result of an abort are only dangling objects.
2738 Defaults to false. If not set, the value of `transfer.fsckObjects`
2741 receive.fsck.<msg-id>::
2742 When `receive.fsckObjects` is set to true, errors can be switched
2743 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2744 setting where the `<msg-id>` is the fsck message ID and the value
2745 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2746 the error/warning with the message ID, e.g. "missingEmail: invalid
2747 author/committer line - missing email" means that setting
2748 `receive.fsck.missingEmail = ignore` will hide that issue.
2750 This feature is intended to support working with legacy repositories
2751 which would not pass pushing when `receive.fsckObjects = true`, allowing
2752 the host to accept repositories with certain known issues but still catch
2755 receive.fsck.skipList::
2756 The path to a sorted list of object names (i.e. one SHA-1 per
2757 line) that are known to be broken in a non-fatal way and should
2758 be ignored. This feature is useful when an established project
2759 should be accepted despite early commits containing errors that
2760 can be safely ignored such as invalid committer email addresses.
2761 Note: corrupt objects cannot be skipped with this setting.
2764 After receiving the pack from the client, `receive-pack` may
2765 produce no output (if `--quiet` was specified) while processing
2766 the pack, causing some networks to drop the TCP connection.
2767 With this option set, if `receive-pack` does not transmit
2768 any data in this phase for `receive.keepAlive` seconds, it will
2769 send a short keepalive packet. The default is 5 seconds; set
2770 to 0 to disable keepalives entirely.
2772 receive.unpackLimit::
2773 If the number of objects received in a push is below this
2774 limit then the objects will be unpacked into loose object
2775 files. However if the number of received objects equals or
2776 exceeds this limit then the received pack will be stored as
2777 a pack, after adding any missing delta bases. Storing the
2778 pack from a push can make the push operation complete faster,
2779 especially on slow filesystems. If not set, the value of
2780 `transfer.unpackLimit` is used instead.
2782 receive.maxInputSize::
2783 If the size of the incoming pack stream is larger than this
2784 limit, then git-receive-pack will error out, instead of
2785 accepting the pack file. If not set or set to 0, then the size
2788 receive.denyDeletes::
2789 If set to true, git-receive-pack will deny a ref update that deletes
2790 the ref. Use this to prevent such a ref deletion via a push.
2792 receive.denyDeleteCurrent::
2793 If set to true, git-receive-pack will deny a ref update that
2794 deletes the currently checked out branch of a non-bare repository.
2796 receive.denyCurrentBranch::
2797 If set to true or "refuse", git-receive-pack will deny a ref update
2798 to the currently checked out branch of a non-bare repository.
2799 Such a push is potentially dangerous because it brings the HEAD
2800 out of sync with the index and working tree. If set to "warn",
2801 print a warning of such a push to stderr, but allow the push to
2802 proceed. If set to false or "ignore", allow such pushes with no
2803 message. Defaults to "refuse".
2805 Another option is "updateInstead" which will update the working
2806 tree if pushing into the current branch. This option is
2807 intended for synchronizing working directories when one side is not easily
2808 accessible via interactive ssh (e.g. a live web site, hence the requirement
2809 that the working directory be clean). This mode also comes in handy when
2810 developing inside a VM to test and fix code on different Operating Systems.
2812 By default, "updateInstead" will refuse the push if the working tree or
2813 the index have any difference from the HEAD, but the `push-to-checkout`
2814 hook can be used to customize this. See linkgit:githooks[5].
2816 receive.denyNonFastForwards::
2817 If set to true, git-receive-pack will deny a ref update which is
2818 not a fast-forward. Use this to prevent such an update via a push,
2819 even if that push is forced. This configuration variable is
2820 set when initializing a shared repository.
2823 This variable is the same as `transfer.hideRefs`, but applies
2824 only to `receive-pack` (and so affects pushes, but not fetches).
2825 An attempt to update or delete a hidden ref by `git push` is
2828 receive.updateServerInfo::
2829 If set to true, git-receive-pack will run git-update-server-info
2830 after receiving data from git-push and updating refs.
2832 receive.shallowUpdate::
2833 If set to true, .git/shallow can be updated when new refs
2834 require new shallow roots. Otherwise those refs are rejected.
2836 remote.pushDefault::
2837 The remote to push to by default. Overrides
2838 `branch.<name>.remote` for all branches, and is overridden by
2839 `branch.<name>.pushRemote` for specific branches.
2842 The URL of a remote repository. See linkgit:git-fetch[1] or
2843 linkgit:git-push[1].
2845 remote.<name>.pushurl::
2846 The push URL of a remote repository. See linkgit:git-push[1].
2848 remote.<name>.proxy::
2849 For remotes that require curl (http, https and ftp), the URL to
2850 the proxy to use for that remote. Set to the empty string to
2851 disable proxying for that remote.
2853 remote.<name>.proxyAuthMethod::
2854 For remotes that require curl (http, https and ftp), the method to use for
2855 authenticating against the proxy in use (probably set in
2856 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2858 remote.<name>.fetch::
2859 The default set of "refspec" for linkgit:git-fetch[1]. See
2860 linkgit:git-fetch[1].
2862 remote.<name>.push::
2863 The default set of "refspec" for linkgit:git-push[1]. See
2864 linkgit:git-push[1].
2866 remote.<name>.mirror::
2867 If true, pushing to this remote will automatically behave
2868 as if the `--mirror` option was given on the command line.
2870 remote.<name>.skipDefaultUpdate::
2871 If true, this remote will be skipped by default when updating
2872 using linkgit:git-fetch[1] or the `update` subcommand of
2873 linkgit:git-remote[1].
2875 remote.<name>.skipFetchAll::
2876 If true, this remote will be skipped by default when updating
2877 using linkgit:git-fetch[1] or the `update` subcommand of
2878 linkgit:git-remote[1].
2880 remote.<name>.receivepack::
2881 The default program to execute on the remote side when pushing. See
2882 option --receive-pack of linkgit:git-push[1].
2884 remote.<name>.uploadpack::
2885 The default program to execute on the remote side when fetching. See
2886 option --upload-pack of linkgit:git-fetch-pack[1].
2888 remote.<name>.tagOpt::
2889 Setting this value to --no-tags disables automatic tag following when
2890 fetching from remote <name>. Setting it to --tags will fetch every
2891 tag from remote <name>, even if they are not reachable from remote
2892 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2893 override this setting. See options --tags and --no-tags of
2894 linkgit:git-fetch[1].
2897 Setting this to a value <vcs> will cause Git to interact with
2898 the remote with the git-remote-<vcs> helper.
2900 remote.<name>.prune::
2901 When set to true, fetching from this remote by default will also
2902 remove any remote-tracking references that no longer exist on the
2903 remote (as if the `--prune` option was given on the command line).
2904 Overrides `fetch.prune` settings, if any.
2907 The list of remotes which are fetched by "git remote update
2908 <group>". See linkgit:git-remote[1].
2910 repack.useDeltaBaseOffset::
2911 By default, linkgit:git-repack[1] creates packs that use
2912 delta-base offset. If you need to share your repository with
2913 Git older than version 1.4.4, either directly or via a dumb
2914 protocol such as http, then you need to set this option to
2915 "false" and repack. Access from old Git versions over the
2916 native protocol are unaffected by this option.
2918 repack.packKeptObjects::
2919 If set to true, makes `git repack` act as if
2920 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2921 details. Defaults to `false` normally, but `true` if a bitmap
2922 index is being written (either via `--write-bitmap-index` or
2923 `repack.writeBitmaps`).
2925 repack.writeBitmaps::
2926 When true, git will write a bitmap index when packing all
2927 objects to disk (e.g., when `git repack -a` is run). This
2928 index can speed up the "counting objects" phase of subsequent
2929 packs created for clones and fetches, at the cost of some disk
2930 space and extra time spent on the initial repack. This has
2931 no effect if multiple packfiles are created.
2935 When set to true, `git-rerere` updates the index with the
2936 resulting contents after it cleanly resolves conflicts using
2937 previously recorded resolution. Defaults to false.
2940 Activate recording of resolved conflicts, so that identical
2941 conflict hunks can be resolved automatically, should they be
2942 encountered again. By default, linkgit:git-rerere[1] is
2943 enabled if there is an `rr-cache` directory under the
2944 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2947 sendemail.identity::
2948 A configuration identity. When given, causes values in the
2949 'sendemail.<identity>' subsection to take precedence over
2950 values in the 'sendemail' section. The default identity is
2951 the value of `sendemail.identity`.
2953 sendemail.smtpEncryption::
2954 See linkgit:git-send-email[1] for description. Note that this
2955 setting is not subject to the 'identity' mechanism.
2957 sendemail.smtpssl (deprecated)::
2958 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2960 sendemail.smtpsslcertpath::
2961 Path to ca-certificates (either a directory or a single file).
2962 Set it to an empty string to disable certificate verification.
2964 sendemail.<identity>.*::
2965 Identity-specific versions of the 'sendemail.*' parameters
2966 found below, taking precedence over those when this
2967 identity is selected, through either the command-line or
2968 `sendemail.identity`.
2970 sendemail.aliasesFile::
2971 sendemail.aliasFileType::
2972 sendemail.annotate::
2976 sendemail.chainReplyTo::
2978 sendemail.envelopeSender::
2980 sendemail.multiEdit::
2981 sendemail.signedoffbycc::
2982 sendemail.smtpPass::
2983 sendemail.suppresscc::
2984 sendemail.suppressFrom::
2986 sendemail.smtpDomain::
2987 sendemail.smtpServer::
2988 sendemail.smtpServerPort::
2989 sendemail.smtpServerOption::
2990 sendemail.smtpUser::
2992 sendemail.transferEncoding::
2993 sendemail.validate::
2995 See linkgit:git-send-email[1] for description.
2997 sendemail.signedoffcc (deprecated)::
2998 Deprecated alias for `sendemail.signedoffbycc`.
3000 sendemail.smtpBatchSize::
3001 Number of messages to be sent per connection, after that a relogin
3002 will happen. If the value is 0 or undefined, send all messages in
3004 See also the `--batch-size` option of linkgit:git-send-email[1].
3006 sendemail.smtpReloginDelay::
3007 Seconds wait before reconnecting to smtp server.
3008 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3010 showbranch.default::
3011 The default set of branches for linkgit:git-show-branch[1].
3012 See linkgit:git-show-branch[1].
3014 splitIndex.maxPercentChange::
3015 When the split index feature is used, this specifies the
3016 percent of entries the split index can contain compared to the
3017 total number of entries in both the split index and the shared
3018 index before a new shared index is written.
3019 The value should be between 0 and 100. If the value is 0 then
3020 a new shared index is always written, if it is 100 a new
3021 shared index is never written.
3022 By default the value is 20, so a new shared index is written
3023 if the number of entries in the split index would be greater
3024 than 20 percent of the total number of entries.
3025 See linkgit:git-update-index[1].
3027 splitIndex.sharedIndexExpire::
3028 When the split index feature is used, shared index files that
3029 were not modified since the time this variable specifies will
3030 be removed when a new shared index file is created. The value
3031 "now" expires all entries immediately, and "never" suppresses
3032 expiration altogether.
3033 The default value is "2.weeks.ago".
3034 Note that a shared index file is considered modified (for the
3035 purpose of expiration) each time a new split-index file is
3036 either created based on it or read from it.
3037 See linkgit:git-update-index[1].
3039 status.relativePaths::
3040 By default, linkgit:git-status[1] shows paths relative to the
3041 current directory. Setting this variable to `false` shows paths
3042 relative to the repository root (this was the default for Git
3046 Set to true to enable --short by default in linkgit:git-status[1].
3047 The option --no-short takes precedence over this variable.
3050 Set to true to enable --branch by default in linkgit:git-status[1].
3051 The option --no-branch takes precedence over this variable.
3053 status.displayCommentPrefix::
3054 If set to true, linkgit:git-status[1] will insert a comment
3055 prefix before each output line (starting with
3056 `core.commentChar`, i.e. `#` by default). This was the
3057 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3061 If set to true, linkgit:git-status[1] will display the number of
3062 entries currently stashed away.
3065 status.showUntrackedFiles::
3066 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3067 files which are not currently tracked by Git. Directories which
3068 contain only untracked files, are shown with the directory name
3069 only. Showing untracked files means that Git needs to lstat() all
3070 the files in the whole repository, which might be slow on some
3071 systems. So, this variable controls how the commands displays
3072 the untracked files. Possible values are:
3075 * `no` - Show no untracked files.
3076 * `normal` - Show untracked files and directories.
3077 * `all` - Show also individual files in untracked directories.
3080 If this variable is not specified, it defaults to 'normal'.
3081 This variable can be overridden with the -u|--untracked-files option
3082 of linkgit:git-status[1] and linkgit:git-commit[1].
3084 status.submoduleSummary::
3086 If this is set to a non zero number or true (identical to -1 or an
3087 unlimited number), the submodule summary will be enabled and a
3088 summary of commits for modified submodules will be shown (see
3089 --summary-limit option of linkgit:git-submodule[1]). Please note
3090 that the summary output command will be suppressed for all
3091 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3092 for those submodules where `submodule.<name>.ignore=all`. The only
3093 exception to that rule is that status and commit will show staged
3094 submodule changes. To
3095 also view the summary for ignored submodules you can either use
3096 the --ignore-submodules=dirty command-line option or the 'git
3097 submodule summary' command, which shows a similar output but does
3098 not honor these settings.
3101 If this is set to true, the `git stash show` command without an
3102 option will show the stash entry in patch form. Defaults to false.
3103 See description of 'show' command in linkgit:git-stash[1].
3106 If this is set to true, the `git stash show` command without an
3107 option will show diffstat of the stash entry. Defaults to true.
3108 See description of 'show' command in linkgit:git-stash[1].
3110 submodule.<name>.url::
3111 The URL for a submodule. This variable is copied from the .gitmodules
3112 file to the git config via 'git submodule init'. The user can change
3113 the configured URL before obtaining the submodule via 'git submodule
3114 update'. If neither submodule.<name>.active or submodule.active are
3115 set, the presence of this variable is used as a fallback to indicate
3116 whether the submodule is of interest to git commands.
3117 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3119 submodule.<name>.update::
3120 The method by which a submodule is updated by 'git submodule update',
3121 which is the only affected command, others such as
3122 'git checkout --recurse-submodules' are unaffected. It exists for
3123 historical reasons, when 'git submodule' was the only command to
3124 interact with submodules; settings like `submodule.active`
3125 and `pull.rebase` are more specific. It is populated by
3126 `git submodule init` from the linkgit:gitmodules[5] file.
3127 See description of 'update' command in linkgit:git-submodule[1].
3129 submodule.<name>.branch::
3130 The remote branch name for a submodule, used by `git submodule
3131 update --remote`. Set this option to override the value found in
3132 the `.gitmodules` file. See linkgit:git-submodule[1] and
3133 linkgit:gitmodules[5] for details.
3135 submodule.<name>.fetchRecurseSubmodules::
3136 This option can be used to control recursive fetching of this
3137 submodule. It can be overridden by using the --[no-]recurse-submodules
3138 command-line option to "git fetch" and "git pull".
3139 This setting will override that from in the linkgit:gitmodules[5]
3142 submodule.<name>.ignore::
3143 Defines under what circumstances "git status" and the diff family show
3144 a submodule as modified. When set to "all", it will never be considered
3145 modified (but it will nonetheless show up in the output of status and
3146 commit when it has been staged), "dirty" will ignore all changes
3147 to the submodules work tree and
3148 takes only differences between the HEAD of the submodule and the commit
3149 recorded in the superproject into account. "untracked" will additionally
3150 let submodules with modified tracked files in their work tree show up.
3151 Using "none" (the default when this option is not set) also shows
3152 submodules that have untracked files in their work tree as changed.
3153 This setting overrides any setting made in .gitmodules for this submodule,
3154 both settings can be overridden on the command line by using the
3155 "--ignore-submodules" option. The 'git submodule' commands are not
3156 affected by this setting.
3158 submodule.<name>.active::
3159 Boolean value indicating if the submodule is of interest to git
3160 commands. This config option takes precedence over the
3161 submodule.active config option.
3164 A repeated field which contains a pathspec used to match against a
3165 submodule's path to determine if the submodule is of interest to git
3169 Specifies if commands recurse into submodules by default. This
3170 applies to all commands that have a `--recurse-submodules` option.
3173 submodule.fetchJobs::
3174 Specifies how many submodules are fetched/cloned at the same time.
3175 A positive integer allows up to that number of submodules fetched
3176 in parallel. A value of 0 will give some reasonable default.
3177 If unset, it defaults to 1.
3179 submodule.alternateLocation::
3180 Specifies how the submodules obtain alternates when submodules are
3181 cloned. Possible values are `no`, `superproject`.
3182 By default `no` is assumed, which doesn't add references. When the
3183 value is set to `superproject` the submodule to be cloned computes
3184 its alternates location relative to the superprojects alternate.
3186 submodule.alternateErrorStrategy::
3187 Specifies how to treat errors with the alternates for a submodule
3188 as computed via `submodule.alternateLocation`. Possible values are
3189 `ignore`, `info`, `die`. Default is `die`.
3191 tag.forceSignAnnotated::
3192 A boolean to specify whether annotated tags created should be GPG signed.
3193 If `--annotate` is specified on the command line, it takes
3194 precedence over this option.
3197 This variable controls the sort ordering of tags when displayed by
3198 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3199 value of this variable will be used as the default.
3202 This variable can be used to restrict the permission bits of
3203 tar archive entries. The default is 0002, which turns off the
3204 world write bit. The special value "user" indicates that the
3205 archiving user's umask will be used instead. See umask(2) and
3206 linkgit:git-archive[1].
3208 transfer.fsckObjects::
3209 When `fetch.fsckObjects` or `receive.fsckObjects` are
3210 not set, the value of this variable is used instead.
3214 String(s) `receive-pack` and `upload-pack` use to decide which
3215 refs to omit from their initial advertisements. Use more than
3216 one definition to specify multiple prefix strings. A ref that is
3217 under the hierarchies listed in the value of this variable is
3218 excluded, and is hidden when responding to `git push` or `git
3219 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3220 program-specific versions of this config.
3222 You may also include a `!` in front of the ref name to negate the entry,
3223 explicitly exposing it, even if an earlier entry marked it as hidden.
3224 If you have multiple hideRefs values, later entries override earlier ones
3225 (and entries in more-specific config files override less-specific ones).
3227 If a namespace is in use, the namespace prefix is stripped from each
3228 reference before it is matched against `transfer.hiderefs` patterns.
3229 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3230 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3231 is omitted from the advertisements but `refs/heads/master` and
3232 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3233 "have" lines. In order to match refs before stripping, add a `^` in front of
3234 the ref name. If you combine `!` and `^`, `!` must be specified first.
3236 Even if you hide refs, a client may still be able to steal the target
3237 objects via the techniques described in the "SECURITY" section of the
3238 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3239 separate repository.
3241 transfer.unpackLimit::
3242 When `fetch.unpackLimit` or `receive.unpackLimit` are
3243 not set, the value of this variable is used instead.
3244 The default value is 100.
3246 uploadarchive.allowUnreachable::
3247 If true, allow clients to use `git archive --remote` to request
3248 any tree, whether reachable from the ref tips or not. See the
3249 discussion in the "SECURITY" section of
3250 linkgit:git-upload-archive[1] for more details. Defaults to
3253 uploadpack.hideRefs::
3254 This variable is the same as `transfer.hideRefs`, but applies
3255 only to `upload-pack` (and so affects only fetches, not pushes).
3256 An attempt to fetch a hidden ref by `git fetch` will fail. See
3257 also `uploadpack.allowTipSHA1InWant`.
3259 uploadpack.allowTipSHA1InWant::
3260 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3261 to accept a fetch request that asks for an object at the tip
3262 of a hidden ref (by default, such a request is rejected).
3263 See also `uploadpack.hideRefs`. Even if this is false, a client
3264 may be able to steal objects via the techniques described in the
3265 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3266 best to keep private data in a separate repository.
3268 uploadpack.allowReachableSHA1InWant::
3269 Allow `upload-pack` to accept a fetch request that asks for an
3270 object that is reachable from any ref tip. However, note that
3271 calculating object reachability is computationally expensive.
3272 Defaults to `false`. Even if this is false, a client may be able
3273 to steal objects via the techniques described in the "SECURITY"
3274 section of the linkgit:gitnamespaces[7] man page; it's best to
3275 keep private data in a separate repository.
3277 uploadpack.allowAnySHA1InWant::
3278 Allow `upload-pack` to accept a fetch request that asks for any
3280 Defaults to `false`.
3282 uploadpack.keepAlive::
3283 When `upload-pack` has started `pack-objects`, there may be a
3284 quiet period while `pack-objects` prepares the pack. Normally
3285 it would output progress information, but if `--quiet` was used
3286 for the fetch, `pack-objects` will output nothing at all until
3287 the pack data begins. Some clients and networks may consider
3288 the server to be hung and give up. Setting this option instructs
3289 `upload-pack` to send an empty keepalive packet every
3290 `uploadpack.keepAlive` seconds. Setting this option to 0
3291 disables keepalive packets entirely. The default is 5 seconds.
3293 uploadpack.packObjectsHook::
3294 If this option is set, when `upload-pack` would run
3295 `git pack-objects` to create a packfile for a client, it will
3296 run this shell command instead. The `pack-objects` command and
3297 arguments it _would_ have run (including the `git pack-objects`
3298 at the beginning) are appended to the shell command. The stdin
3299 and stdout of the hook are treated as if `pack-objects` itself
3300 was run. I.e., `upload-pack` will feed input intended for
3301 `pack-objects` to the hook, and expects a completed packfile on
3304 Note that this configuration variable is ignored if it is seen in the
3305 repository-level config (this is a safety measure against fetching from
3306 untrusted repositories).
3308 url.<base>.insteadOf::
3309 Any URL that starts with this value will be rewritten to
3310 start, instead, with <base>. In cases where some site serves a
3311 large number of repositories, and serves them with multiple
3312 access methods, and some users need to use different access
3313 methods, this feature allows people to specify any of the
3314 equivalent URLs and have Git automatically rewrite the URL to
3315 the best alternative for the particular user, even for a
3316 never-before-seen repository on the site. When more than one
3317 insteadOf strings match a given URL, the longest match is used.
3319 Note that any protocol restrictions will be applied to the rewritten
3320 URL. If the rewrite changes the URL to use a custom protocol or remote
3321 helper, you may need to adjust the `protocol.*.allow` config to permit
3322 the request. In particular, protocols you expect to use for submodules
3323 must be set to `always` rather than the default of `user`. See the
3324 description of `protocol.allow` above.
3326 url.<base>.pushInsteadOf::
3327 Any URL that starts with this value will not be pushed to;
3328 instead, it will be rewritten to start with <base>, and the
3329 resulting URL will be pushed to. In cases where some site serves
3330 a large number of repositories, and serves them with multiple
3331 access methods, some of which do not allow push, this feature
3332 allows people to specify a pull-only URL and have Git
3333 automatically use an appropriate URL to push, even for a
3334 never-before-seen repository on the site. When more than one
3335 pushInsteadOf strings match a given URL, the longest match is
3336 used. If a remote has an explicit pushurl, Git will ignore this
3337 setting for that remote.
3340 Your email address to be recorded in any newly created commits.
3341 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3342 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3345 Your full name to be recorded in any newly created commits.
3346 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3347 environment variables. See linkgit:git-commit-tree[1].
3349 user.useConfigOnly::
3350 Instruct Git to avoid trying to guess defaults for `user.email`
3351 and `user.name`, and instead retrieve the values only from the
3352 configuration. For example, if you have multiple email addresses
3353 and would like to use a different one for each repository, then
3354 with this configuration option set to `true` in the global config
3355 along with a name, Git will prompt you to set up an email before
3356 making new commits in a newly cloned repository.
3357 Defaults to `false`.
3360 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3361 key you want it to automatically when creating a signed tag or
3362 commit, you can override the default selection with this variable.
3363 This option is passed unchanged to gpg's --local-user parameter,
3364 so you may specify a key using any method that gpg supports.
3366 versionsort.prereleaseSuffix (deprecated)::
3367 Deprecated alias for `versionsort.suffix`. Ignored if
3368 `versionsort.suffix` is set.
3370 versionsort.suffix::
3371 Even when version sort is used in linkgit:git-tag[1], tagnames
3372 with the same base version but different suffixes are still sorted
3373 lexicographically, resulting e.g. in prerelease tags appearing
3374 after the main release (e.g. "1.0-rc1" after "1.0"). This
3375 variable can be specified to determine the sorting order of tags
3376 with different suffixes.
3378 By specifying a single suffix in this variable, any tagname containing
3379 that suffix will appear before the corresponding main release. E.g. if
3380 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3381 "1.0". If specified multiple times, once per suffix, then the order of
3382 suffixes in the configuration will determine the sorting order of tagnames
3383 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3384 configuration, then all "1.0-preX" tags will be listed before any
3385 "1.0-rcX" tags. The placement of the main release tag relative to tags
3386 with various suffixes can be determined by specifying the empty suffix
3387 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3388 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3389 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3392 If more than one suffixes match the same tagname, then that tagname will
3393 be sorted according to the suffix which starts at the earliest position in
3394 the tagname. If more than one different matching suffixes start at
3395 that earliest position, then that tagname will be sorted according to the
3396 longest of those suffixes.
3397 The sorting order between different suffixes is undefined if they are
3398 in multiple config files.
3401 Specify a web browser that may be used by some commands.
3402 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]