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.
357 Tells Git if the executable bit of files in the working tree
360 Some filesystems lose the executable bit when a file that is
361 marked as executable is checked out, or checks out a
362 non-executable file with executable bit on.
363 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
364 to see if it handles the executable bit correctly
365 and this variable is automatically set as necessary.
367 A repository, however, may be on a filesystem that handles
368 the filemode correctly, and this variable is set to 'true'
369 when created, but later may be made accessible from another
370 environment that loses the filemode (e.g. exporting ext4 via
371 CIFS mount, visiting a Cygwin created repository with
372 Git for Windows or Eclipse).
373 In such a case it may be necessary to set this variable to 'false'.
374 See linkgit:git-update-index[1].
376 The default is true (when core.filemode is not specified in the config file).
379 (Windows-only) If true, mark newly-created directories and files whose
380 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
381 directory is hidden, but no other files starting with a dot. The
382 default mode is 'dotGitOnly'.
385 If true, this option enables various workarounds to enable
386 Git to work better on filesystems that are not case sensitive,
387 like FAT. For example, if a directory listing finds
388 "makefile" when Git expects "Makefile", Git will assume
389 it is really the same file, and continue to remember it as
392 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
393 will probe and set core.ignoreCase true if appropriate when the repository
396 core.precomposeUnicode::
397 This option is only used by Mac OS implementation of Git.
398 When core.precomposeUnicode=true, Git reverts the unicode decomposition
399 of filenames done by Mac OS. This is useful when sharing a repository
400 between Mac OS and Linux or Windows.
401 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
402 When false, file names are handled fully transparent by Git,
403 which is backward compatible with older versions of Git.
406 If set to true, do not allow checkout of paths that would
407 be considered equivalent to `.git` on an HFS+ filesystem.
408 Defaults to `true` on Mac OS, and `false` elsewhere.
411 If set to true, do not allow checkout of paths that would
412 cause problems with the NTFS filesystem, e.g. conflict with
414 Defaults to `true` on Windows, and `false` elsewhere.
417 If set, the value of this variable is used as a command which
418 will identify all files that may have changed since the
419 requested date/time. This information is used to speed up git by
420 avoiding unnecessary processing of files that have not changed.
421 See the "fsmonitor-watchman" section of linkgit:githooks[5].
424 If false, the ctime differences between the index and the
425 working tree are ignored; useful when the inode change time
426 is regularly modified by something outside Git (file system
427 crawlers and some backup systems).
428 See linkgit:git-update-index[1]. True by default.
431 If true, the split-index feature of the index will be used.
432 See linkgit:git-update-index[1]. False by default.
434 core.untrackedCache::
435 Determines what to do about the untracked cache feature of the
436 index. It will be kept, if this variable is unset or set to
437 `keep`. It will automatically be added if set to `true`. And
438 it will automatically be removed, if set to `false`. Before
439 setting it to `true`, you should check that mtime is working
440 properly on your system.
441 See linkgit:git-update-index[1]. `keep` by default.
444 Determines which stat fields to match between the index
445 and work tree. The user can set this to 'default' or
446 'minimal'. Default (or explicitly 'default'), is to check
447 all fields, including the sub-second part of mtime and ctime.
450 Commands that output paths (e.g. 'ls-files', 'diff'), will
451 quote "unusual" characters in the pathname by enclosing the
452 pathname in double-quotes and escaping those characters with
453 backslashes in the same way C escapes control characters (e.g.
454 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
455 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
456 UTF-8). If this variable is set to false, bytes higher than
457 0x80 are not considered "unusual" any more. Double-quotes,
458 backslash and control characters are always escaped regardless
459 of the setting of this variable. A simple space character is
460 not considered "unusual". Many commands can output pathnames
461 completely verbatim using the `-z` option. The default value
465 Sets the line ending type to use in the working directory for
466 files that have the `text` property set when core.autocrlf is false.
467 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
468 native line ending. The default value is `native`. See
469 linkgit:gitattributes[5] for more information on end-of-line
473 If true, makes Git check if converting `CRLF` is reversible when
474 end-of-line conversion is active. Git will verify if a command
475 modifies a file in the work tree either directly or indirectly.
476 For example, committing a file followed by checking out the
477 same file should yield the original file in the work tree. If
478 this is not the case for the current setting of
479 `core.autocrlf`, Git will reject the file. The variable can
480 be set to "warn", in which case Git will only warn about an
481 irreversible conversion but continue the operation.
483 CRLF conversion bears a slight chance of corrupting data.
484 When it is enabled, Git will convert CRLF to LF during commit and LF to
485 CRLF during checkout. A file that contains a mixture of LF and
486 CRLF before the commit cannot be recreated by Git. For text
487 files this is the right thing to do: it corrects line endings
488 such that we have only LF line endings in the repository.
489 But for binary files that are accidentally classified as text the
490 conversion can corrupt data.
492 If you recognize such corruption early you can easily fix it by
493 setting the conversion type explicitly in .gitattributes. Right
494 after committing you still have the original file in your work
495 tree and this file is not yet corrupted. You can explicitly tell
496 Git that this file is binary and Git will handle the file
499 Unfortunately, the desired effect of cleaning up text files with
500 mixed line endings and the undesired effect of corrupting binary
501 files cannot be distinguished. In both cases CRLFs are removed
502 in an irreversible way. For text files this is the right thing
503 to do because CRLFs are line endings, while for binary files
504 converting CRLFs corrupts data.
506 Note, this safety check does not mean that a checkout will generate a
507 file identical to the original file for a different setting of
508 `core.eol` and `core.autocrlf`, but only for the current one. For
509 example, a text file with `LF` would be accepted with `core.eol=lf`
510 and could later be checked out with `core.eol=crlf`, in which case the
511 resulting file would contain `CRLF`, although the original file
512 contained `LF`. However, in both work trees the line endings would be
513 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
514 file with mixed line endings would be reported by the `core.safecrlf`
518 Setting this variable to "true" is the same as setting
519 the `text` attribute to "auto" on all files and core.eol to "crlf".
520 Set to true if you want to have `CRLF` line endings in your
521 working directory and the repository has LF line endings.
522 This variable can be set to 'input',
523 in which case no output conversion is performed.
526 If false, symbolic links are checked out as small plain files that
527 contain the link text. linkgit:git-update-index[1] and
528 linkgit:git-add[1] will not change the recorded type to regular
529 file. Useful on filesystems like FAT that do not support
532 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
533 will probe and set core.symlinks false if appropriate when the repository
537 A "proxy command" to execute (as 'command host port') instead
538 of establishing direct connection to the remote server when
539 using the Git protocol for fetching. If the variable value is
540 in the "COMMAND for DOMAIN" format, the command is applied only
541 on hostnames ending with the specified domain string. This variable
542 may be set multiple times and is matched in the given order;
543 the first match wins.
545 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
546 (which always applies universally, without the special "for"
549 The special string `none` can be used as the proxy command to
550 specify that no proxy be used for a given domain pattern.
551 This is useful for excluding servers inside a firewall from
552 proxy use, while defaulting to a common proxy for external domains.
555 If this variable is set, `git fetch` and `git push` will
556 use the specified command instead of `ssh` when they need to
557 connect to a remote system. The command is in the same form as
558 the `GIT_SSH_COMMAND` environment variable and is overridden
559 when the environment variable is set.
562 If true, Git will avoid using lstat() calls to detect if files have
563 changed by setting the "assume-unchanged" bit for those tracked files
564 which it has updated identically in both the index and working tree.
566 When files are modified outside of Git, the user will need to stage
567 the modified files explicitly (e.g. see 'Examples' section in
568 linkgit:git-update-index[1]).
569 Git will not normally detect changes to those files.
571 This is useful on systems where lstat() calls are very slow, such as
572 CIFS/Microsoft Windows.
576 core.preferSymlinkRefs::
577 Instead of the default "symref" format for HEAD
578 and other symbolic reference files, use symbolic links.
579 This is sometimes needed to work with old scripts that
580 expect HEAD to be a symbolic link.
583 If true this repository is assumed to be 'bare' and has no
584 working directory associated with it. If this is the case a
585 number of commands that require a working directory will be
586 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
588 This setting is automatically guessed by linkgit:git-clone[1] or
589 linkgit:git-init[1] when the repository was created. By default a
590 repository that ends in "/.git" is assumed to be not bare (bare =
591 false), while all other repositories are assumed to be bare (bare
595 Set the path to the root of the working tree.
596 If `GIT_COMMON_DIR` environment variable is set, core.worktree
597 is ignored and not used for determining the root of working tree.
598 This can be overridden by the `GIT_WORK_TREE` environment
599 variable and the `--work-tree` command-line option.
600 The value can be an absolute path or relative to the path to
601 the .git directory, which is either specified by --git-dir
602 or GIT_DIR, or automatically discovered.
603 If --git-dir or GIT_DIR is specified but none of
604 --work-tree, GIT_WORK_TREE and core.worktree is specified,
605 the current working directory is regarded as the top level
606 of your working tree.
608 Note that this variable is honored even when set in a configuration
609 file in a ".git" subdirectory of a directory and its value differs
610 from the latter directory (e.g. "/path/to/.git/config" has
611 core.worktree set to "/different/path"), which is most likely a
612 misconfiguration. Running Git commands in the "/path/to" directory will
613 still use "/different/path" as the root of the work tree and can cause
614 confusion unless you know what you are doing (e.g. you are creating a
615 read-only snapshot of the same index to a location different from the
616 repository's usual working tree).
618 core.logAllRefUpdates::
619 Enable the reflog. Updates to a ref <ref> is logged to the file
620 "`$GIT_DIR/logs/<ref>`", by appending the new and old
621 SHA-1, the date/time and the reason of the update, but
622 only when the file exists. If this configuration
623 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
624 file is automatically created for branch heads (i.e. under
625 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
626 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
627 If it is set to `always`, then a missing reflog is automatically
628 created for any ref under `refs/`.
630 This information can be used to determine what commit
631 was the tip of a branch "2 days ago".
633 This value is true by default in a repository that has
634 a working directory associated with it, and false by
635 default in a bare repository.
637 core.repositoryFormatVersion::
638 Internal variable identifying the repository format and layout
641 core.sharedRepository::
642 When 'group' (or 'true'), the repository is made shareable between
643 several users in a group (making sure all the files and objects are
644 group-writable). When 'all' (or 'world' or 'everybody'), the
645 repository will be readable by all users, additionally to being
646 group-shareable. When 'umask' (or 'false'), Git will use permissions
647 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
648 files in the repository will have this mode value. '0xxx' will override
649 user's umask value (whereas the other options will only override
650 requested parts of the user's umask value). Examples: '0660' will make
651 the repo read/write-able for the owner and group, but inaccessible to
652 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
653 repository that is group-readable but not group-writable.
654 See linkgit:git-init[1]. False by default.
656 core.warnAmbiguousRefs::
657 If true, Git will warn you if the ref name you passed it is ambiguous
658 and might match multiple refs in the repository. True by default.
661 An integer -1..9, indicating a default compression level.
662 -1 is the zlib default. 0 means no compression,
663 and 1..9 are various speed/size tradeoffs, 9 being slowest.
664 If set, this provides a default to other compression variables,
665 such as `core.looseCompression` and `pack.compression`.
667 core.looseCompression::
668 An integer -1..9, indicating the compression level for objects that
669 are not in a pack file. -1 is the zlib default. 0 means no
670 compression, and 1..9 are various speed/size tradeoffs, 9 being
671 slowest. If not set, defaults to core.compression. If that is
672 not set, defaults to 1 (best speed).
674 core.packedGitWindowSize::
675 Number of bytes of a pack file to map into memory in a
676 single mapping operation. Larger window sizes may allow
677 your system to process a smaller number of large pack files
678 more quickly. Smaller window sizes will negatively affect
679 performance due to increased calls to the operating system's
680 memory manager, but may improve performance when accessing
681 a large number of large pack files.
683 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
684 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
685 be reasonable for all users/operating systems. You probably do
686 not need to adjust this value.
688 Common unit suffixes of 'k', 'm', or 'g' are supported.
690 core.packedGitLimit::
691 Maximum number of bytes to map simultaneously into memory
692 from pack files. If Git needs to access more than this many
693 bytes at once to complete an operation it will unmap existing
694 regions to reclaim virtual address space within the process.
696 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
697 unlimited) on 64 bit platforms.
698 This should be reasonable for all users/operating systems, except on
699 the largest projects. You probably do not need to adjust this value.
701 Common unit suffixes of 'k', 'm', or 'g' are supported.
703 core.deltaBaseCacheLimit::
704 Maximum number of bytes to reserve for caching base objects
705 that may be referenced by multiple deltified objects. By storing the
706 entire decompressed base objects in a cache Git is able
707 to avoid unpacking and decompressing frequently used base
708 objects multiple times.
710 Default is 96 MiB on all platforms. This should be reasonable
711 for all users/operating systems, except on the largest projects.
712 You probably do not need to adjust this value.
714 Common unit suffixes of 'k', 'm', or 'g' are supported.
716 core.bigFileThreshold::
717 Files larger than this size are stored deflated, without
718 attempting delta compression. Storing large files without
719 delta compression avoids excessive memory usage, at the
720 slight expense of increased disk usage. Additionally files
721 larger than this size are always treated as binary.
723 Default is 512 MiB on all platforms. This should be reasonable
724 for most projects as source code and other text files can still
725 be delta compressed, but larger binary media files won't be.
727 Common unit suffixes of 'k', 'm', or 'g' are supported.
730 Specifies the pathname to the file that contains patterns to
731 describe paths that are not meant to be tracked, in addition
732 to '.gitignore' (per-directory) and '.git/info/exclude'.
733 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
734 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
735 is used instead. See linkgit:gitignore[5].
738 Some commands (e.g. svn and http interfaces) that interactively
739 ask for a password can be told to use an external program given
740 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
741 environment variable. If not set, fall back to the value of the
742 `SSH_ASKPASS` environment variable or, failing that, a simple password
743 prompt. The external program shall be given a suitable prompt as
744 command-line argument and write the password on its STDOUT.
746 core.attributesFile::
747 In addition to '.gitattributes' (per-directory) and
748 '.git/info/attributes', Git looks into this file for attributes
749 (see linkgit:gitattributes[5]). Path expansions are made the same
750 way as for `core.excludesFile`. Its default value is
751 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
752 set or empty, `$HOME/.config/git/attributes` is used instead.
755 By default Git will look for your hooks in the
756 '$GIT_DIR/hooks' directory. Set this to different path,
757 e.g. '/etc/git/hooks', and Git will try to find your hooks in
758 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
759 in '$GIT_DIR/hooks/pre-receive'.
761 The path can be either absolute or relative. A relative path is
762 taken as relative to the directory where the hooks are run (see
763 the "DESCRIPTION" section of linkgit:githooks[5]).
765 This configuration variable is useful in cases where you'd like to
766 centrally configure your Git hooks instead of configuring them on a
767 per-repository basis, or as a more flexible and centralized
768 alternative to having an `init.templateDir` where you've changed
772 Commands such as `commit` and `tag` that let you edit
773 messages by launching an editor use the value of this
774 variable when it is set, and the environment variable
775 `GIT_EDITOR` is not set. See linkgit:git-var[1].
778 Commands such as `commit` and `tag` that let you edit
779 messages consider a line that begins with this character
780 commented, and removes them after the editor returns
783 If set to "auto", `git-commit` would select a character that is not
784 the beginning character of any line in existing commit messages.
786 core.filesRefLockTimeout::
787 The length of time, in milliseconds, to retry when trying to
788 lock an individual reference. Value 0 means not to retry at
789 all; -1 means to try indefinitely. Default is 100 (i.e.,
792 core.packedRefsTimeout::
793 The length of time, in milliseconds, to retry when trying to
794 lock the `packed-refs` file. Value 0 means not to retry at
795 all; -1 means to try indefinitely. Default is 1000 (i.e.,
799 Text editor used by `git rebase -i` for editing the rebase instruction file.
800 The value is meant to be interpreted by the shell when it is used.
801 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
802 When not configured the default commit message editor is used instead.
805 Text viewer for use by Git commands (e.g., 'less'). The value
806 is meant to be interpreted by the shell. The order of preference
807 is the `$GIT_PAGER` environment variable, then `core.pager`
808 configuration, then `$PAGER`, and then the default chosen at
809 compile time (usually 'less').
811 When the `LESS` environment variable is unset, Git sets it to `FRX`
812 (if `LESS` environment variable is set, Git does not change it at
813 all). If you want to selectively override Git's default setting
814 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
815 be passed to the shell by Git, which will translate the final
816 command to `LESS=FRX less -S`. The environment does not set the
817 `S` option but the command line does, instructing less to truncate
818 long lines. Similarly, setting `core.pager` to `less -+F` will
819 deactivate the `F` option specified by the environment from the
820 command-line, deactivating the "quit if one screen" behavior of
821 `less`. One can specifically activate some flags for particular
822 commands: for example, setting `pager.blame` to `less -S` enables
823 line truncation only for `git blame`.
825 Likewise, when the `LV` environment variable is unset, Git sets it
826 to `-c`. You can override this setting by exporting `LV` with
827 another value or setting `core.pager` to `lv +c`.
830 A comma separated list of common whitespace problems to
831 notice. 'git diff' will use `color.diff.whitespace` to
832 highlight them, and 'git apply --whitespace=error' will
833 consider them as errors. You can prefix `-` to disable
834 any of them (e.g. `-trailing-space`):
836 * `blank-at-eol` treats trailing whitespaces at the end of the line
837 as an error (enabled by default).
838 * `space-before-tab` treats a space character that appears immediately
839 before a tab character in the initial indent part of the line as an
840 error (enabled by default).
841 * `indent-with-non-tab` treats a line that is indented with space
842 characters instead of the equivalent tabs as an error (not enabled by
844 * `tab-in-indent` treats a tab character in the initial indent part of
845 the line as an error (not enabled by default).
846 * `blank-at-eof` treats blank lines added at the end of file as an error
847 (enabled by default).
848 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
850 * `cr-at-eol` treats a carriage-return at the end of line as
851 part of the line terminator, i.e. with it, `trailing-space`
852 does not trigger if the character before such a carriage-return
853 is not a whitespace (not enabled by default).
854 * `tabwidth=<n>` tells how many character positions a tab occupies; this
855 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
856 errors. The default tab width is 8. Allowed values are 1 to 63.
858 core.fsyncObjectFiles::
859 This boolean will enable 'fsync()' when writing object files.
861 This is a total waste of time and effort on a filesystem that orders
862 data writes properly, but can be useful for filesystems that do not use
863 journalling (traditional UNIX filesystems) or that only journal metadata
864 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
867 Enable parallel index preload for operations like 'git diff'
869 This can speed up operations like 'git diff' and 'git status' especially
870 on filesystems like NFS that have weak caching semantics and thus
871 relatively high IO latencies. When enabled, Git will do the
872 index comparison to the filesystem data in parallel, allowing
873 overlapping IO's. Defaults to true.
876 You can set this to 'link', in which case a hardlink followed by
877 a delete of the source are used to make sure that object creation
878 will not overwrite existing objects.
880 On some file system/operating system combinations, this is unreliable.
881 Set this config setting to 'rename' there; However, This will remove the
882 check that makes sure that existing object files will not get overwritten.
885 When showing commit messages, also show notes which are stored in
886 the given ref. The ref must be fully qualified. If the given
887 ref does not exist, it is not an error but means that no
888 notes should be printed.
890 This setting defaults to "refs/notes/commits", and it can be overridden by
891 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
893 core.sparseCheckout::
894 Enable "sparse checkout" feature. See section "Sparse checkout" in
895 linkgit:git-read-tree[1] for more information.
898 Set the length object names are abbreviated to. If
899 unspecified or set to "auto", an appropriate value is
900 computed based on the approximate number of packed objects
901 in your repository, which hopefully is enough for
902 abbreviated object names to stay unique for some time.
903 The minimum length is 4.
906 add.ignore-errors (deprecated)::
907 Tells 'git add' to continue adding files when some files cannot be
908 added due to indexing errors. Equivalent to the `--ignore-errors`
909 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
910 as it does not follow the usual naming convention for configuration
914 Command aliases for the linkgit:git[1] command wrapper - e.g.
915 after defining "alias.last = cat-file commit HEAD", the invocation
916 "git last" is equivalent to "git cat-file commit HEAD". To avoid
917 confusion and troubles with script usage, aliases that
918 hide existing Git commands are ignored. Arguments are split by
919 spaces, the usual shell quoting and escaping is supported.
920 A quote pair or a backslash can be used to quote them.
922 If the alias expansion is prefixed with an exclamation point,
923 it will be treated as a shell command. For example, defining
924 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
925 "git new" is equivalent to running the shell command
926 "gitk --all --not ORIG_HEAD". Note that shell commands will be
927 executed from the top-level directory of a repository, which may
928 not necessarily be the current directory.
929 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
930 from the original current directory. See linkgit:git-rev-parse[1].
933 If true, git-am will call git-mailsplit for patches in mbox format
934 with parameter `--keep-cr`. In this case git-mailsplit will
935 not remove `\r` from lines ending with `\r\n`. Can be overridden
936 by giving `--no-keep-cr` from the command line.
937 See linkgit:git-am[1], linkgit:git-mailsplit[1].
940 By default, `git am` will fail if the patch does not apply cleanly. When
941 set to true, this setting tells `git am` to fall back on 3-way merge if
942 the patch records the identity of blobs it is supposed to apply to and
943 we have those blobs available locally (equivalent to giving the `--3way`
944 option from the command line). Defaults to `false`.
945 See linkgit:git-am[1].
947 apply.ignoreWhitespace::
948 When set to 'change', tells 'git apply' to ignore changes in
949 whitespace, in the same way as the `--ignore-space-change`
951 When set to one of: no, none, never, false tells 'git apply' to
952 respect all whitespace differences.
953 See linkgit:git-apply[1].
956 Tells 'git apply' how to handle whitespaces, in the same way
957 as the `--whitespace` option. See linkgit:git-apply[1].
959 branch.autoSetupMerge::
960 Tells 'git branch' and 'git checkout' to set up new branches
961 so that linkgit:git-pull[1] will appropriately merge from the
962 starting point branch. Note that even if this option is not set,
963 this behavior can be chosen per-branch using the `--track`
964 and `--no-track` options. The valid settings are: `false` -- no
965 automatic setup is done; `true` -- automatic setup is done when the
966 starting point is a remote-tracking branch; `always` --
967 automatic setup is done when the starting point is either a
968 local branch or remote-tracking
969 branch. This option defaults to true.
971 branch.autoSetupRebase::
972 When a new branch is created with 'git branch' or 'git checkout'
973 that tracks another branch, this variable tells Git to set
974 up pull to rebase instead of merge (see "branch.<name>.rebase").
975 When `never`, rebase is never automatically set to true.
976 When `local`, rebase is set to true for tracked branches of
977 other local branches.
978 When `remote`, rebase is set to true for tracked branches of
979 remote-tracking branches.
980 When `always`, rebase will be set to true for all tracking
982 See "branch.autoSetupMerge" for details on how to set up a
983 branch to track another branch.
984 This option defaults to never.
986 branch.<name>.remote::
987 When on branch <name>, it tells 'git fetch' and 'git push'
988 which remote to fetch from/push to. The remote to push to
989 may be overridden with `remote.pushDefault` (for all branches).
990 The remote to push to, for the current branch, may be further
991 overridden by `branch.<name>.pushRemote`. If no remote is
992 configured, or if you are not on any branch, it defaults to
993 `origin` for fetching and `remote.pushDefault` for pushing.
994 Additionally, `.` (a period) is the current local repository
995 (a dot-repository), see `branch.<name>.merge`'s final note below.
997 branch.<name>.pushRemote::
998 When on branch <name>, it overrides `branch.<name>.remote` for
999 pushing. It also overrides `remote.pushDefault` for pushing
1000 from branch <name>. When you pull from one place (e.g. your
1001 upstream) and push to another place (e.g. your own publishing
1002 repository), you would want to set `remote.pushDefault` to
1003 specify the remote to push to for all branches, and use this
1004 option to override it for a specific branch.
1006 branch.<name>.merge::
1007 Defines, together with branch.<name>.remote, the upstream branch
1008 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1009 branch to merge and can also affect 'git push' (see push.default).
1010 When in branch <name>, it tells 'git fetch' the default
1011 refspec to be marked for merging in FETCH_HEAD. The value is
1012 handled like the remote part of a refspec, and must match a
1013 ref which is fetched from the remote given by
1014 "branch.<name>.remote".
1015 The merge information is used by 'git pull' (which at first calls
1016 'git fetch') to lookup the default branch for merging. Without
1017 this option, 'git pull' defaults to merge the first refspec fetched.
1018 Specify multiple values to get an octopus merge.
1019 If you wish to setup 'git pull' so that it merges into <name> from
1020 another branch in the local repository, you can point
1021 branch.<name>.merge to the desired branch, and use the relative path
1022 setting `.` (a period) for branch.<name>.remote.
1024 branch.<name>.mergeOptions::
1025 Sets default options for merging into branch <name>. The syntax and
1026 supported options are the same as those of linkgit:git-merge[1], but
1027 option values containing whitespace characters are currently not
1030 branch.<name>.rebase::
1031 When true, rebase the branch <name> on top of the fetched branch,
1032 instead of merging the default branch from the default remote when
1033 "git pull" is run. See "pull.rebase" for doing this in a non
1034 branch-specific manner.
1036 When preserve, also pass `--preserve-merges` along to 'git rebase'
1037 so that locally committed merge commits will not be flattened
1038 by running 'git pull'.
1040 When the value is `interactive`, the rebase is run in interactive mode.
1042 *NOTE*: this is a possibly dangerous operation; do *not* use
1043 it unless you understand the implications (see linkgit:git-rebase[1]
1046 branch.<name>.description::
1047 Branch description, can be edited with
1048 `git branch --edit-description`. Branch description is
1049 automatically added in the format-patch cover letter or
1050 request-pull summary.
1052 browser.<tool>.cmd::
1053 Specify the command to invoke the specified browser. The
1054 specified command is evaluated in shell with the URLs passed
1055 as arguments. (See linkgit:git-web{litdd}browse[1].)
1057 browser.<tool>.path::
1058 Override the path for the given tool that may be used to
1059 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1060 working repository in gitweb (see linkgit:git-instaweb[1]).
1062 clean.requireForce::
1063 A boolean to make git-clean do nothing unless given -f,
1064 -i or -n. Defaults to true.
1067 A boolean to enable/disable color in the output of
1068 linkgit:git-branch[1]. May be set to `always`,
1069 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1070 only when the output is to a terminal. If unset, then the
1071 value of `color.ui` is used (`auto` by default).
1073 color.branch.<slot>::
1074 Use customized color for branch coloration. `<slot>` is one of
1075 `current` (the current branch), `local` (a local branch),
1076 `remote` (a remote-tracking branch in refs/remotes/),
1077 `upstream` (upstream tracking branch), `plain` (other
1081 Whether to use ANSI escape sequences to add color to patches.
1082 If this is set to `always`, linkgit:git-diff[1],
1083 linkgit:git-log[1], and linkgit:git-show[1] will use color
1084 for all patches. If it is set to `true` or `auto`, those
1085 commands will only use color when output is to the terminal.
1086 If unset, then the value of `color.ui` is used (`auto` by
1089 This does not affect linkgit:git-format-patch[1] or the
1090 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1091 command line with the `--color[=<when>]` option.
1094 If set to either a valid `<mode>` or a true value, moved lines
1095 in a diff are colored differently, for details of valid modes
1096 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1097 true the default color mode will be used. When set to false,
1098 moved lines are not colored.
1101 Use customized color for diff colorization. `<slot>` specifies
1102 which part of the patch to use the specified color, and is one
1103 of `context` (context text - `plain` is a historical synonym),
1104 `meta` (metainformation), `frag`
1105 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1106 `new` (added lines), `commit` (commit headers), `whitespace`
1107 (highlighting whitespace errors), `oldMoved` (deleted lines),
1108 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1109 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1110 and `newMovedAlternativeDimmed` (See the '<mode>'
1111 setting of '--color-moved' in linkgit:git-diff[1] for details).
1113 color.decorate.<slot>::
1114 Use customized color for 'git log --decorate' output. `<slot>` is one
1115 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1116 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1119 When set to `always`, always highlight matches. When `false` (or
1120 `never`), never. When set to `true` or `auto`, use color only
1121 when the output is written to the terminal. If unset, then the
1122 value of `color.ui` is used (`auto` by default).
1125 Use customized color for grep colorization. `<slot>` specifies which
1126 part of the line to use the specified color, and is one of
1130 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1132 filename prefix (when not using `-h`)
1134 function name lines (when using `-p`)
1136 line number prefix (when using `-n`)
1138 matching text (same as setting `matchContext` and `matchSelected`)
1140 matching text in context lines
1142 matching text in selected lines
1144 non-matching text in selected lines
1146 separators between fields on a line (`:`, `-`, and `=`)
1147 and between hunks (`--`)
1151 When set to `always`, always use colors for interactive prompts
1152 and displays (such as those used by "git-add --interactive" and
1153 "git-clean --interactive"). When false (or `never`), never.
1154 When set to `true` or `auto`, use colors only when the output is
1155 to the terminal. If unset, then the value of `color.ui` is
1156 used (`auto` by default).
1158 color.interactive.<slot>::
1159 Use customized color for 'git add --interactive' and 'git clean
1160 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1161 or `error`, for four distinct types of normal output from
1162 interactive commands.
1165 A boolean to enable/disable colored output when the pager is in
1166 use (default is true).
1169 A boolean to enable/disable color in the output of
1170 linkgit:git-show-branch[1]. May be set to `always`,
1171 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1172 only when the output is to a terminal. If unset, then the
1173 value of `color.ui` is used (`auto` by default).
1176 A boolean to enable/disable color in the output of
1177 linkgit:git-status[1]. May be set to `always`,
1178 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1179 only when the output is to a terminal. If unset, then the
1180 value of `color.ui` is used (`auto` by default).
1182 color.status.<slot>::
1183 Use customized color for status colorization. `<slot>` is
1184 one of `header` (the header text of the status message),
1185 `added` or `updated` (files which are added but not committed),
1186 `changed` (files which are changed but not added in the index),
1187 `untracked` (files which are not tracked by Git),
1188 `branch` (the current branch),
1189 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1191 `localBranch` or `remoteBranch` (the local and remote branch names,
1192 respectively, when branch and tracking information is displayed in the
1193 status short-format), or
1194 `unmerged` (files which have unmerged changes).
1197 This variable determines the default value for variables such
1198 as `color.diff` and `color.grep` that control the use of color
1199 per command family. Its scope will expand as more commands learn
1200 configuration to set a default for the `--color` option. Set it
1201 to `false` or `never` if you prefer Git commands not to use
1202 color unless enabled explicitly with some other configuration
1203 or the `--color` option. Set it to `always` if you want all
1204 output not intended for machine consumption to use color, to
1205 `true` or `auto` (this is the default since Git 1.8.4) if you
1206 want such output to use color when written to the terminal.
1209 Specify whether supported commands should output in columns.
1210 This variable consists of a list of tokens separated by spaces
1213 These options control when the feature should be enabled
1214 (defaults to 'never'):
1218 always show in columns
1220 never show in columns
1222 show in columns if the output is to the terminal
1225 These options control layout (defaults to 'column'). Setting any
1226 of these implies 'always' if none of 'always', 'never', or 'auto' are
1231 fill columns before rows
1233 fill rows before columns
1238 Finally, these options can be combined with a layout option (defaults
1243 make unequal size columns to utilize more space
1245 make equal size columns
1249 Specify whether to output branch listing in `git branch` in columns.
1250 See `column.ui` for details.
1253 Specify the layout when list items in `git clean -i`, which always
1254 shows files and directories in columns. See `column.ui` for details.
1257 Specify whether to output untracked files in `git status` in columns.
1258 See `column.ui` for details.
1261 Specify whether to output tag listing in `git tag` in columns.
1262 See `column.ui` for details.
1265 This setting overrides the default of the `--cleanup` option in
1266 `git commit`. See linkgit:git-commit[1] for details. Changing the
1267 default can be useful when you always want to keep lines that begin
1268 with comment character `#` in your log message, in which case you
1269 would do `git config commit.cleanup whitespace` (note that you will
1270 have to remove the help lines that begin with `#` in the commit log
1271 template yourself, if you do this).
1275 A boolean to specify whether all commits should be GPG signed.
1276 Use of this option when doing operations such as rebase can
1277 result in a large number of commits being signed. It may be
1278 convenient to use an agent to avoid typing your GPG passphrase
1282 A boolean to enable/disable inclusion of status information in the
1283 commit message template when using an editor to prepare the commit
1284 message. Defaults to true.
1287 Specify the pathname of a file to use as the template for
1288 new commit messages.
1291 A boolean or int to specify the level of verbose with `git commit`.
1292 See linkgit:git-commit[1].
1295 Specify an external helper to be called when a username or
1296 password credential is needed; the helper may consult external
1297 storage to avoid prompting the user for the credentials. Note
1298 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1301 credential.useHttpPath::
1302 When acquiring credentials, consider the "path" component of an http
1303 or https URL to be important. Defaults to false. See
1304 linkgit:gitcredentials[7] for more information.
1306 credential.username::
1307 If no username is set for a network authentication, use this username
1308 by default. See credential.<context>.* below, and
1309 linkgit:gitcredentials[7].
1311 credential.<url>.*::
1312 Any of the credential.* options above can be applied selectively to
1313 some credentials. For example "credential.https://example.com.username"
1314 would set the default username only for https connections to
1315 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1318 credentialCache.ignoreSIGHUP::
1319 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1321 include::diff-config.txt[]
1323 difftool.<tool>.path::
1324 Override the path for the given tool. This is useful in case
1325 your tool is not in the PATH.
1327 difftool.<tool>.cmd::
1328 Specify the command to invoke the specified diff tool.
1329 The specified command is evaluated in shell with the following
1330 variables available: 'LOCAL' is set to the name of the temporary
1331 file containing the contents of the diff pre-image and 'REMOTE'
1332 is set to the name of the temporary file containing the contents
1333 of the diff post-image.
1336 Prompt before each invocation of the diff tool.
1338 fastimport.unpackLimit::
1339 If the number of objects imported by linkgit:git-fast-import[1]
1340 is below this limit, then the objects will be unpacked into
1341 loose object files. However if the number of imported objects
1342 equals or exceeds this limit then the pack will be stored as a
1343 pack. Storing the pack from a fast-import can make the import
1344 operation complete faster, especially on slow filesystems. If
1345 not set, the value of `transfer.unpackLimit` is used instead.
1347 fetch.recurseSubmodules::
1348 This option can be either set to a boolean value or to 'on-demand'.
1349 Setting it to a boolean changes the behavior of fetch and pull to
1350 unconditionally recurse into submodules when set to true or to not
1351 recurse at all when set to false. When set to 'on-demand' (the default
1352 value), fetch and pull will only recurse into a populated submodule
1353 when its superproject retrieves a commit that updates the submodule's
1357 If it is set to true, git-fetch-pack will check all fetched
1358 objects. It will abort in the case of a malformed object or a
1359 broken link. The result of an abort are only dangling objects.
1360 Defaults to false. If not set, the value of `transfer.fsckObjects`
1364 If the number of objects fetched over the Git native
1365 transfer is below this
1366 limit, then the objects will be unpacked into loose object
1367 files. However if the number of received objects equals or
1368 exceeds this limit then the received pack will be stored as
1369 a pack, after adding any missing delta bases. Storing the
1370 pack from a push can make the push operation complete faster,
1371 especially on slow filesystems. If not set, the value of
1372 `transfer.unpackLimit` is used instead.
1375 If true, fetch will automatically behave as if the `--prune`
1376 option was given on the command line. See also `remote.<name>.prune`.
1379 Control how ref update status is printed. Valid values are
1380 `full` and `compact`. Default value is `full`. See section
1381 OUTPUT in linkgit:git-fetch[1] for detail.
1384 Enable multipart/mixed attachments as the default for
1385 'format-patch'. The value can also be a double quoted string
1386 which will enable attachments as the default and set the
1387 value as the boundary. See the --attach option in
1388 linkgit:git-format-patch[1].
1391 Provides the default value for the `--from` option to format-patch.
1392 Accepts a boolean value, or a name and email address. If false,
1393 format-patch defaults to `--no-from`, using commit authors directly in
1394 the "From:" field of patch mails. If true, format-patch defaults to
1395 `--from`, using your committer identity in the "From:" field of patch
1396 mails and including a "From:" field in the body of the patch mail if
1397 different. If set to a non-boolean value, format-patch uses that
1398 value instead of your committer identity. Defaults to false.
1401 A boolean which can enable or disable sequence numbers in patch
1402 subjects. It defaults to "auto" which enables it only if there
1403 is more than one patch. It can be enabled or disabled for all
1404 messages by setting it to "true" or "false". See --numbered
1405 option in linkgit:git-format-patch[1].
1408 Additional email headers to include in a patch to be submitted
1409 by mail. See linkgit:git-format-patch[1].
1413 Additional recipients to include in a patch to be submitted
1414 by mail. See the --to and --cc options in
1415 linkgit:git-format-patch[1].
1417 format.subjectPrefix::
1418 The default for format-patch is to output files with the '[PATCH]'
1419 subject prefix. Use this variable to change that prefix.
1422 The default for format-patch is to output a signature containing
1423 the Git version number. Use this variable to change that default.
1424 Set this variable to the empty string ("") to suppress
1425 signature generation.
1427 format.signatureFile::
1428 Works just like format.signature except the contents of the
1429 file specified by this variable will be used as the signature.
1432 The default for format-patch is to output files with the suffix
1433 `.patch`. Use this variable to change that suffix (make sure to
1434 include the dot if you want it).
1437 The default pretty format for log/show/whatchanged command,
1438 See linkgit:git-log[1], linkgit:git-show[1],
1439 linkgit:git-whatchanged[1].
1442 The default threading style for 'git format-patch'. Can be
1443 a boolean value, or `shallow` or `deep`. `shallow` threading
1444 makes every mail a reply to the head of the series,
1445 where the head is chosen from the cover letter, the
1446 `--in-reply-to`, and the first patch mail, in this order.
1447 `deep` threading makes every mail a reply to the previous one.
1448 A true boolean value is the same as `shallow`, and a false
1449 value disables threading.
1452 A boolean value which lets you enable the `-s/--signoff` option of
1453 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1454 patch should be a conscious act and means that you certify you have
1455 the rights to submit this work under the same open source license.
1456 Please see the 'SubmittingPatches' document for further discussion.
1458 format.coverLetter::
1459 A boolean that controls whether to generate a cover-letter when
1460 format-patch is invoked, but in addition can be set to "auto", to
1461 generate a cover-letter only when there's more than one patch.
1463 format.outputDirectory::
1464 Set a custom directory to store the resulting files instead of the
1465 current working directory.
1467 format.useAutoBase::
1468 A boolean value which lets you enable the `--base=auto` option of
1469 format-patch by default.
1471 filter.<driver>.clean::
1472 The command which is used to convert the content of a worktree
1473 file to a blob upon checkin. See linkgit:gitattributes[5] for
1476 filter.<driver>.smudge::
1477 The command which is used to convert the content of a blob
1478 object to a worktree file upon checkout. See
1479 linkgit:gitattributes[5] for details.
1482 Allows overriding the message type (error, warn or ignore) of a
1483 specific message ID such as `missingEmail`.
1485 For convenience, fsck prefixes the error/warning with the message ID,
1486 e.g. "missingEmail: invalid author/committer line - missing email" means
1487 that setting `fsck.missingEmail = ignore` will hide that issue.
1489 This feature is intended to support working with legacy repositories
1490 which cannot be repaired without disruptive changes.
1493 The path to a sorted list of object names (i.e. one SHA-1 per
1494 line) that are known to be broken in a non-fatal way and should
1495 be ignored. This feature is useful when an established project
1496 should be accepted despite early commits containing errors that
1497 can be safely ignored such as invalid committer email addresses.
1498 Note: corrupt objects cannot be skipped with this setting.
1500 gc.aggressiveDepth::
1501 The depth parameter used in the delta compression
1502 algorithm used by 'git gc --aggressive'. This defaults
1505 gc.aggressiveWindow::
1506 The window size parameter used in the delta compression
1507 algorithm used by 'git gc --aggressive'. This defaults
1511 When there are approximately more than this many loose
1512 objects in the repository, `git gc --auto` will pack them.
1513 Some Porcelain commands use this command to perform a
1514 light-weight garbage collection from time to time. The
1515 default value is 6700. Setting this to 0 disables it.
1518 When there are more than this many packs that are not
1519 marked with `*.keep` file in the repository, `git gc
1520 --auto` consolidates them into one larger pack. The
1521 default value is 50. Setting this to 0 disables it.
1524 Make `git gc --auto` return immediately and run in background
1525 if the system supports it. Default is true.
1528 If the file gc.log exists, then `git gc --auto` won't run
1529 unless that file is more than 'gc.logExpiry' old. Default is
1530 "1.day". See `gc.pruneExpire` for more ways to specify its
1534 Running `git pack-refs` in a repository renders it
1535 unclonable by Git versions prior to 1.5.1.2 over dumb
1536 transports such as HTTP. This variable determines whether
1537 'git gc' runs `git pack-refs`. This can be set to `notbare`
1538 to enable it within all non-bare repos or it can be set to a
1539 boolean value. The default is `true`.
1542 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1543 Override the grace period with this config variable. The value
1544 "now" may be used to disable this grace period and always prune
1545 unreachable objects immediately, or "never" may be used to
1546 suppress pruning. This feature helps prevent corruption when
1547 'git gc' runs concurrently with another process writing to the
1548 repository; see the "NOTES" section of linkgit:git-gc[1].
1550 gc.worktreePruneExpire::
1551 When 'git gc' is run, it calls
1552 'git worktree prune --expire 3.months.ago'.
1553 This config variable can be used to set a different grace
1554 period. The value "now" may be used to disable the grace
1555 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1556 may be used to suppress pruning.
1559 gc.<pattern>.reflogExpire::
1560 'git reflog expire' removes reflog entries older than
1561 this time; defaults to 90 days. The value "now" expires all
1562 entries immediately, and "never" suppresses expiration
1563 altogether. With "<pattern>" (e.g.
1564 "refs/stash") in the middle the setting applies only to
1565 the refs that match the <pattern>.
1567 gc.reflogExpireUnreachable::
1568 gc.<pattern>.reflogExpireUnreachable::
1569 'git reflog expire' removes reflog entries older than
1570 this time and are not reachable from the current tip;
1571 defaults to 30 days. The value "now" expires all entries
1572 immediately, and "never" suppresses expiration altogether.
1573 With "<pattern>" (e.g. "refs/stash")
1574 in the middle, the setting applies only to the refs that
1575 match the <pattern>.
1578 Records of conflicted merge you resolved earlier are
1579 kept for this many days when 'git rerere gc' is run.
1580 You can also use more human-readable "1.month.ago", etc.
1581 The default is 60 days. See linkgit:git-rerere[1].
1583 gc.rerereUnresolved::
1584 Records of conflicted merge you have not resolved are
1585 kept for this many days when 'git rerere gc' is run.
1586 You can also use more human-readable "1.month.ago", etc.
1587 The default is 15 days. See linkgit:git-rerere[1].
1589 gitcvs.commitMsgAnnotation::
1590 Append this string to each commit message. Set to empty string
1591 to disable this feature. Defaults to "via git-CVS emulator".
1594 Whether the CVS server interface is enabled for this repository.
1595 See linkgit:git-cvsserver[1].
1598 Path to a log file where the CVS server interface well... logs
1599 various stuff. See linkgit:git-cvsserver[1].
1601 gitcvs.usecrlfattr::
1602 If true, the server will look up the end-of-line conversion
1603 attributes for files to determine the `-k` modes to use. If
1604 the attributes force Git to treat a file as text,
1605 the `-k` mode will be left blank so CVS clients will
1606 treat it as text. If they suppress text conversion, the file
1607 will be set with '-kb' mode, which suppresses any newline munging
1608 the client might otherwise do. If the attributes do not allow
1609 the file type to be determined, then `gitcvs.allBinary` is
1610 used. See linkgit:gitattributes[5].
1613 This is used if `gitcvs.usecrlfattr` does not resolve
1614 the correct '-kb' mode to use. If true, all
1615 unresolved files are sent to the client in
1616 mode '-kb'. This causes the client to treat them
1617 as binary files, which suppresses any newline munging it
1618 otherwise might do. Alternatively, if it is set to "guess",
1619 then the contents of the file are examined to decide if
1620 it is binary, similar to `core.autocrlf`.
1623 Database used by git-cvsserver to cache revision information
1624 derived from the Git repository. The exact meaning depends on the
1625 used database driver, for SQLite (which is the default driver) this
1626 is a filename. Supports variable substitution (see
1627 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1628 Default: '%Ggitcvs.%m.sqlite'
1631 Used Perl DBI driver. You can specify any available driver
1632 for this here, but it might not work. git-cvsserver is tested
1633 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1634 reported *not* to work with 'DBD::mysql'. Experimental feature.
1635 May not contain double colons (`:`). Default: 'SQLite'.
1636 See linkgit:git-cvsserver[1].
1638 gitcvs.dbUser, gitcvs.dbPass::
1639 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1640 since SQLite has no concept of database users and/or passwords.
1641 'gitcvs.dbUser' supports variable substitution (see
1642 linkgit:git-cvsserver[1] for details).
1644 gitcvs.dbTableNamePrefix::
1645 Database table name prefix. Prepended to the names of any
1646 database tables used, allowing a single database to be used
1647 for several repositories. Supports variable substitution (see
1648 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1649 characters will be replaced with underscores.
1651 All gitcvs variables except for `gitcvs.usecrlfattr` and
1652 `gitcvs.allBinary` can also be specified as
1653 'gitcvs.<access_method>.<varname>' (where 'access_method'
1654 is one of "ext" and "pserver") to make them apply only for the given
1658 gitweb.description::
1661 See linkgit:gitweb[1] for description.
1669 gitweb.remote_heads::
1672 See linkgit:gitweb.conf[5] for description.
1675 If set to true, enable `-n` option by default.
1678 Set the default matching behavior. Using a value of 'basic', 'extended',
1679 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1680 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1681 value 'default' will return to the default matching behavior.
1683 grep.extendedRegexp::
1684 If set to true, enable `--extended-regexp` option by default. This
1685 option is ignored when the `grep.patternType` option is set to a value
1686 other than 'default'.
1689 Number of grep worker threads to use.
1690 See `grep.threads` in linkgit:git-grep[1] for more information.
1692 grep.fallbackToNoIndex::
1693 If set to true, fall back to git grep --no-index if git grep
1694 is executed outside of a git repository. Defaults to false.
1697 Use this custom program instead of "`gpg`" found on `$PATH` when
1698 making or verifying a PGP signature. The program must support the
1699 same command-line interface as GPG, namely, to verify a detached
1700 signature, "`gpg --verify $file - <$signature`" is run, and the
1701 program is expected to signal a good signature by exiting with
1702 code 0, and to generate an ASCII-armored detached signature, the
1703 standard input of "`gpg -bsau $key`" is fed with the contents to be
1704 signed, and the program is expected to send the result to its
1707 gui.commitMsgWidth::
1708 Defines how wide the commit message window is in the
1709 linkgit:git-gui[1]. "75" is the default.
1712 Specifies how many context lines should be used in calls to diff
1713 made by the linkgit:git-gui[1]. The default is "5".
1715 gui.displayUntracked::
1716 Determines if linkgit:git-gui[1] shows untracked files
1717 in the file list. The default is "true".
1720 Specifies the default encoding to use for displaying of
1721 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1722 It can be overridden by setting the 'encoding' attribute
1723 for relevant files (see linkgit:gitattributes[5]).
1724 If this option is not set, the tools default to the
1727 gui.matchTrackingBranch::
1728 Determines if new branches created with linkgit:git-gui[1] should
1729 default to tracking remote branches with matching names or
1730 not. Default: "false".
1732 gui.newBranchTemplate::
1733 Is used as suggested name when creating new branches using the
1736 gui.pruneDuringFetch::
1737 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1738 performing a fetch. The default value is "false".
1741 Determines if linkgit:git-gui[1] should trust the file modification
1742 timestamp or not. By default the timestamps are not trusted.
1744 gui.spellingDictionary::
1745 Specifies the dictionary used for spell checking commit messages in
1746 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1750 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1751 location detection. It makes blame significantly faster on huge
1752 repositories at the expense of less thorough copy detection.
1754 gui.copyBlameThreshold::
1755 Specifies the threshold to use in 'git gui blame' original location
1756 detection, measured in alphanumeric characters. See the
1757 linkgit:git-blame[1] manual for more information on copy detection.
1759 gui.blamehistoryctx::
1760 Specifies the radius of history context in days to show in
1761 linkgit:gitk[1] for the selected commit, when the `Show History
1762 Context` menu item is invoked from 'git gui blame'. If this
1763 variable is set to zero, the whole history is shown.
1765 guitool.<name>.cmd::
1766 Specifies the shell command line to execute when the corresponding item
1767 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1768 mandatory for every tool. The command is executed from the root of
1769 the working directory, and in the environment it receives the name of
1770 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1771 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1772 the head is detached, 'CUR_BRANCH' is empty).
1774 guitool.<name>.needsFile::
1775 Run the tool only if a diff is selected in the GUI. It guarantees
1776 that 'FILENAME' is not empty.
1778 guitool.<name>.noConsole::
1779 Run the command silently, without creating a window to display its
1782 guitool.<name>.noRescan::
1783 Don't rescan the working directory for changes after the tool
1786 guitool.<name>.confirm::
1787 Show a confirmation dialog before actually running the tool.
1789 guitool.<name>.argPrompt::
1790 Request a string argument from the user, and pass it to the tool
1791 through the `ARGS` environment variable. Since requesting an
1792 argument implies confirmation, the 'confirm' option has no effect
1793 if this is enabled. If the option is set to 'true', 'yes', or '1',
1794 the dialog uses a built-in generic prompt; otherwise the exact
1795 value of the variable is used.
1797 guitool.<name>.revPrompt::
1798 Request a single valid revision from the user, and set the
1799 `REVISION` environment variable. In other aspects this option
1800 is similar to 'argPrompt', and can be used together with it.
1802 guitool.<name>.revUnmerged::
1803 Show only unmerged branches in the 'revPrompt' subdialog.
1804 This is useful for tools similar to merge or rebase, but not
1805 for things like checkout or reset.
1807 guitool.<name>.title::
1808 Specifies the title to use for the prompt dialog. The default
1811 guitool.<name>.prompt::
1812 Specifies the general prompt string to display at the top of
1813 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1814 The default value includes the actual command.
1817 Specify the browser that will be used to display help in the
1818 'web' format. See linkgit:git-help[1].
1821 Override the default help format used by linkgit:git-help[1].
1822 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1823 the default. 'web' and 'html' are the same.
1826 Automatically correct and execute mistyped commands after
1827 waiting for the given number of deciseconds (0.1 sec). If more
1828 than one command can be deduced from the entered text, nothing
1829 will be executed. If the value of this option is negative,
1830 the corrected command will be executed immediately. If the
1831 value is 0 - the command will be just shown but not executed.
1832 This is the default.
1835 Specify the path where the HTML documentation resides. File system paths
1836 and URLs are supported. HTML pages will be prefixed with this path when
1837 help is displayed in the 'web' format. This defaults to the documentation
1838 path of your Git installation.
1841 Override the HTTP proxy, normally configured using the 'http_proxy',
1842 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1843 addition to the syntax understood by curl, it is possible to specify a
1844 proxy string with a user name but no password, in which case git will
1845 attempt to acquire one in the same way it does for other credentials. See
1846 linkgit:gitcredentials[7] for more information. The syntax thus is
1847 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1848 on a per-remote basis; see remote.<name>.proxy
1850 http.proxyAuthMethod::
1851 Set the method with which to authenticate against the HTTP proxy. This
1852 only takes effect if the configured proxy string contains a user name part
1853 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1854 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1855 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1856 variable. Possible values are:
1859 * `anyauth` - Automatically pick a suitable authentication method. It is
1860 assumed that the proxy answers an unauthenticated request with a 407
1861 status code and one or more Proxy-authenticate headers with supported
1862 authentication methods. This is the default.
1863 * `basic` - HTTP Basic authentication
1864 * `digest` - HTTP Digest authentication; this prevents the password from being
1865 transmitted to the proxy in clear text
1866 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1868 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1872 Attempt authentication without seeking a username or password. This
1873 can be used to attempt GSS-Negotiate authentication without specifying
1874 a username in the URL, as libcurl normally requires a username for
1878 Control GSSAPI credential delegation. The delegation is disabled
1879 by default in libcurl since version 7.21.7. Set parameter to tell
1880 the server what it is allowed to delegate when it comes to user
1881 credentials. Used with GSS/kerberos. Possible values are:
1884 * `none` - Don't allow any delegation.
1885 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1886 Kerberos service ticket, which is a matter of realm policy.
1887 * `always` - Unconditionally allow the server to delegate.
1892 Pass an additional HTTP header when communicating with a server. If
1893 more than one such entry exists, all of them are added as extra
1894 headers. To allow overriding the settings inherited from the system
1895 config, an empty value will reset the extra headers to the empty list.
1898 The pathname of a file containing previously stored cookie lines,
1899 which should be used
1900 in the Git http session, if they match the server. The file format
1901 of the file to read cookies from should be plain HTTP headers or
1902 the Netscape/Mozilla cookie file format (see `curl(1)`).
1903 NOTE that the file specified with http.cookieFile is used only as
1904 input unless http.saveCookies is set.
1907 If set, store cookies received during requests to the file specified by
1908 http.cookieFile. Has no effect if http.cookieFile is unset.
1911 The SSL version to use when negotiating an SSL connection, if you
1912 want to force the default. The available and default version
1913 depend on whether libcurl was built against NSS or OpenSSL and the
1914 particular configuration of the crypto library in use. Internally
1915 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1916 documentation for more details on the format of this option and
1917 for the ssl version supported. Actually the possible values of
1928 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1929 To force git to use libcurl's default ssl version and ignore any
1930 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1933 http.sslCipherList::
1934 A list of SSL ciphers to use when negotiating an SSL connection.
1935 The available ciphers depend on whether libcurl was built against
1936 NSS or OpenSSL and the particular configuration of the crypto
1937 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1938 option; see the libcurl documentation for more details on the format
1941 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1942 To force git to use libcurl's default cipher list and ignore any
1943 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1947 Whether to verify the SSL certificate when fetching or pushing
1948 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1952 File containing the SSL certificate when fetching or pushing
1953 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1957 File containing the SSL private key when fetching or pushing
1958 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1961 http.sslCertPasswordProtected::
1962 Enable Git's password prompt for the SSL certificate. Otherwise
1963 OpenSSL will prompt the user, possibly many times, if the
1964 certificate or private key is encrypted. Can be overridden by the
1965 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1968 File containing the certificates to verify the peer with when
1969 fetching or pushing over HTTPS. Can be overridden by the
1970 `GIT_SSL_CAINFO` environment variable.
1973 Path containing files with the CA certificates to verify the peer
1974 with when fetching or pushing over HTTPS. Can be overridden
1975 by the `GIT_SSL_CAPATH` environment variable.
1978 Public key of the https service. It may either be the filename of
1979 a PEM or DER encoded public key file or a string starting with
1980 'sha256//' followed by the base64 encoded sha256 hash of the
1981 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1982 exit with an error if this option is set but not supported by
1986 Attempt to use AUTH SSL/TLS and encrypted data transfers
1987 when connecting via regular FTP protocol. This might be needed
1988 if the FTP server requires it for security reasons or you wish
1989 to connect securely whenever remote FTP server supports it.
1990 Default is false since it might trigger certificate verification
1991 errors on misconfigured servers.
1994 How many HTTP requests to launch in parallel. Can be overridden
1995 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1998 The number of curl sessions (counted across slots) to be kept across
1999 requests. They will not be ended with curl_easy_cleanup() until
2000 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2001 value will be capped at 1. Defaults to 1.
2004 Maximum size in bytes of the buffer used by smart HTTP
2005 transports when POSTing data to the remote system.
2006 For requests larger than this buffer size, HTTP/1.1 and
2007 Transfer-Encoding: chunked is used to avoid creating a
2008 massive pack file locally. Default is 1 MiB, which is
2009 sufficient for most requests.
2011 http.lowSpeedLimit, http.lowSpeedTime::
2012 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2013 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2014 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2015 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2018 A boolean which disables using of EPSV ftp command by curl.
2019 This can helpful with some "poor" ftp servers which don't
2020 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2021 environment variable. Default is false (curl will use EPSV).
2024 The HTTP USER_AGENT string presented to an HTTP server. The default
2025 value represents the version of the client Git such as git/1.7.1.
2026 This option allows you to override this value to a more common value
2027 such as Mozilla/4.0. This may be necessary, for instance, if
2028 connecting through a firewall that restricts HTTP connections to a set
2029 of common USER_AGENT strings (but not including those like git/1.7.1).
2030 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2032 http.followRedirects::
2033 Whether git should follow HTTP redirects. If set to `true`, git
2034 will transparently follow any redirect issued by a server it
2035 encounters. If set to `false`, git will treat all redirects as
2036 errors. If set to `initial`, git will follow redirects only for
2037 the initial request to a remote, but not for subsequent
2038 follow-up HTTP requests. Since git uses the redirected URL as
2039 the base for the follow-up requests, this is generally
2040 sufficient. The default is `initial`.
2043 Any of the http.* options above can be applied selectively to some URLs.
2044 For a config key to match a URL, each element of the config key is
2045 compared to that of the URL, in the following order:
2048 . Scheme (e.g., `https` in `https://example.com/`). This field
2049 must match exactly between the config key and the URL.
2051 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2052 This field must match between the config key and the URL. It is
2053 possible to specify a `*` as part of the host name to match all subdomains
2054 at this level. `https://*.example.com/` for example would match
2055 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2057 . Port number (e.g., `8080` in `http://example.com:8080/`).
2058 This field must match exactly between the config key and the URL.
2059 Omitted port numbers are automatically converted to the correct
2060 default for the scheme before matching.
2062 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2063 path field of the config key must match the path field of the URL
2064 either exactly or as a prefix of slash-delimited path elements. This means
2065 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2066 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2067 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2068 key with just path `foo/`).
2070 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2071 the config key has a user name it must match the user name in the
2072 URL exactly. If the config key does not have a user name, that
2073 config key will match a URL with any user name (including none),
2074 but at a lower precedence than a config key with a user name.
2077 The list above is ordered by decreasing precedence; a URL that matches
2078 a config key's path is preferred to one that matches its user name. For example,
2079 if the URL is `https://user@example.com/foo/bar` a config key match of
2080 `https://example.com/foo` will be preferred over a config key match of
2081 `https://user@example.com`.
2083 All URLs are normalized before attempting any matching (the password part,
2084 if embedded in the URL, is always ignored for matching purposes) so that
2085 equivalent URLs that are simply spelled differently will match properly.
2086 Environment variable settings always override any matches. The URLs that are
2087 matched against are those given directly to Git commands. This means any URLs
2088 visited as a result of a redirection do not participate in matching.
2091 Depending on the value of the environment variables `GIT_SSH` or
2092 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2093 auto-detects whether to adjust its command-line parameters for use
2094 with plink or tortoiseplink, as opposed to the default (OpenSSH).
2096 The config variable `ssh.variant` can be set to override this auto-detection;
2097 valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2098 will be treated as normal ssh. This setting can be overridden via the
2099 environment variable `GIT_SSH_VARIANT`.
2101 i18n.commitEncoding::
2102 Character encoding the commit messages are stored in; Git itself
2103 does not care per se, but this information is necessary e.g. when
2104 importing commits from emails or in the gitk graphical history
2105 browser (and possibly at other places in the future or in other
2106 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2108 i18n.logOutputEncoding::
2109 Character encoding the commit messages are converted to when
2110 running 'git log' and friends.
2113 The configuration variables in the 'imap' section are described
2114 in linkgit:git-imap-send[1].
2117 Specify the version with which new index files should be
2118 initialized. This does not affect existing repositories.
2121 Specify the directory from which templates will be copied.
2122 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2125 Specify the program that will be used to browse your working
2126 repository in gitweb. See linkgit:git-instaweb[1].
2129 The HTTP daemon command-line to start gitweb on your working
2130 repository. See linkgit:git-instaweb[1].
2133 If true the web server started by linkgit:git-instaweb[1] will
2134 be bound to the local IP (127.0.0.1).
2136 instaweb.modulePath::
2137 The default module path for linkgit:git-instaweb[1] to use
2138 instead of /usr/lib/apache2/modules. Only used if httpd
2142 The port number to bind the gitweb httpd to. See
2143 linkgit:git-instaweb[1].
2145 interactive.singleKey::
2146 In interactive commands, allow the user to provide one-letter
2147 input with a single key (i.e., without hitting enter).
2148 Currently this is used by the `--patch` mode of
2149 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2150 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2151 setting is silently ignored if portable keystroke input
2152 is not available; requires the Perl module Term::ReadKey.
2154 interactive.diffFilter::
2155 When an interactive command (such as `git add --patch`) shows
2156 a colorized diff, git will pipe the diff through the shell
2157 command defined by this configuration variable. The command may
2158 mark up the diff further for human consumption, provided that it
2159 retains a one-to-one correspondence with the lines in the
2160 original diff. Defaults to disabled (no filtering).
2163 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2164 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2165 override this option with `--no-abbrev-commit`.
2168 Set the default date-time mode for the 'log' command.
2169 Setting a value for log.date is similar to using 'git log''s
2170 `--date` option. See linkgit:git-log[1] for details.
2173 Print out the ref names of any commits that are shown by the log
2174 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2175 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2176 specified, the full ref name (including prefix) will be printed.
2177 If 'auto' is specified, then if the output is going to a terminal,
2178 the ref names are shown as if 'short' were given, otherwise no ref
2179 names are shown. This is the same as the `--decorate` option
2183 If `true`, `git log` will act as if the `--follow` option was used when
2184 a single <path> is given. This has the same limitations as `--follow`,
2185 i.e. it cannot be used to follow multiple files and does not work well
2186 on non-linear history.
2189 A list of colors, separated by commas, that can be used to draw
2190 history lines in `git log --graph`.
2193 If true, the initial commit will be shown as a big creation event.
2194 This is equivalent to a diff against an empty tree.
2195 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2196 normally hide the root commit will now show it. True by default.
2199 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2200 linkgit:git-whatchanged[1] assume `--show-signature`.
2203 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2204 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2207 If true, makes linkgit:git-mailinfo[1] (and therefore
2208 linkgit:git-am[1]) act by default as if the --scissors option
2209 was provided on the command-line. When active, this features
2210 removes everything from the message body before a scissors
2211 line (i.e. consisting mainly of ">8", "8<" and "-").
2214 The location of an augmenting mailmap file. The default
2215 mailmap, located in the root of the repository, is loaded
2216 first, then the mailmap file pointed to by this variable.
2217 The location of the mailmap file may be in a repository
2218 subdirectory, or somewhere outside of the repository itself.
2219 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2222 Like `mailmap.file`, but consider the value as a reference to a
2223 blob in the repository. If both `mailmap.file` and
2224 `mailmap.blob` are given, both are parsed, with entries from
2225 `mailmap.file` taking precedence. In a bare repository, this
2226 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2230 Specify the programs that may be used to display help in the
2231 'man' format. See linkgit:git-help[1].
2234 Specify the command to invoke the specified man viewer. The
2235 specified command is evaluated in shell with the man page
2236 passed as argument. (See linkgit:git-help[1].)
2239 Override the path for the given tool that may be used to
2240 display help in the 'man' format. See linkgit:git-help[1].
2242 include::merge-config.txt[]
2244 mergetool.<tool>.path::
2245 Override the path for the given tool. This is useful in case
2246 your tool is not in the PATH.
2248 mergetool.<tool>.cmd::
2249 Specify the command to invoke the specified merge tool. The
2250 specified command is evaluated in shell with the following
2251 variables available: 'BASE' is the name of a temporary file
2252 containing the common base of the files to be merged, if available;
2253 'LOCAL' is the name of a temporary file containing the contents of
2254 the file on the current branch; 'REMOTE' is the name of a temporary
2255 file containing the contents of the file from the branch being
2256 merged; 'MERGED' contains the name of the file to which the merge
2257 tool should write the results of a successful merge.
2259 mergetool.<tool>.trustExitCode::
2260 For a custom merge command, specify whether the exit code of
2261 the merge command can be used to determine whether the merge was
2262 successful. If this is not set to true then the merge target file
2263 timestamp is checked and the merge assumed to have been successful
2264 if the file has been updated, otherwise the user is prompted to
2265 indicate the success of the merge.
2267 mergetool.meld.hasOutput::
2268 Older versions of `meld` do not support the `--output` option.
2269 Git will attempt to detect whether `meld` supports `--output`
2270 by inspecting the output of `meld --help`. Configuring
2271 `mergetool.meld.hasOutput` will make Git skip these checks and
2272 use the configured value instead. Setting `mergetool.meld.hasOutput`
2273 to `true` tells Git to unconditionally use the `--output` option,
2274 and `false` avoids using `--output`.
2276 mergetool.keepBackup::
2277 After performing a merge, the original file with conflict markers
2278 can be saved as a file with a `.orig` extension. If this variable
2279 is set to `false` then this file is not preserved. Defaults to
2280 `true` (i.e. keep the backup files).
2282 mergetool.keepTemporaries::
2283 When invoking a custom merge tool, Git uses a set of temporary
2284 files to pass to the tool. If the tool returns an error and this
2285 variable is set to `true`, then these temporary files will be
2286 preserved, otherwise they will be removed after the tool has
2287 exited. Defaults to `false`.
2289 mergetool.writeToTemp::
2290 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2291 conflicting files in the worktree by default. Git will attempt
2292 to use a temporary directory for these files when set `true`.
2293 Defaults to `false`.
2296 Prompt before each invocation of the merge resolution program.
2298 notes.mergeStrategy::
2299 Which merge strategy to choose by default when resolving notes
2300 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2301 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2302 section of linkgit:git-notes[1] for more information on each strategy.
2304 notes.<name>.mergeStrategy::
2305 Which merge strategy to choose when doing a notes merge into
2306 refs/notes/<name>. This overrides the more general
2307 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2308 linkgit:git-notes[1] for more information on the available strategies.
2311 The (fully qualified) refname from which to show notes when
2312 showing commit messages. The value of this variable can be set
2313 to a glob, in which case notes from all matching refs will be
2314 shown. You may also specify this configuration variable
2315 several times. A warning will be issued for refs that do not
2316 exist, but a glob that does not match any refs is silently
2319 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2320 environment variable, which must be a colon separated list of refs or
2323 The effective value of "core.notesRef" (possibly overridden by
2324 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2327 notes.rewrite.<command>::
2328 When rewriting commits with <command> (currently `amend` or
2329 `rebase`) and this variable is set to `true`, Git
2330 automatically copies your notes from the original to the
2331 rewritten commit. Defaults to `true`, but see
2332 "notes.rewriteRef" below.
2335 When copying notes during a rewrite (see the
2336 "notes.rewrite.<command>" option), determines what to do if
2337 the target commit already has a note. Must be one of
2338 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2339 Defaults to `concatenate`.
2341 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2342 environment variable.
2345 When copying notes during a rewrite, specifies the (fully
2346 qualified) ref whose notes should be copied. The ref may be a
2347 glob, in which case notes in all matching refs will be copied.
2348 You may also specify this configuration several times.
2350 Does not have a default value; you must configure this variable to
2351 enable note rewriting. Set it to `refs/notes/commits` to enable
2352 rewriting for the default commit notes.
2354 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2355 environment variable, which must be a colon separated list of refs or
2359 The size of the window used by linkgit:git-pack-objects[1] when no
2360 window size is given on the command line. Defaults to 10.
2363 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2364 maximum depth is given on the command line. Defaults to 50.
2367 The maximum size of memory that is consumed by each thread
2368 in linkgit:git-pack-objects[1] for pack window memory when
2369 no limit is given on the command line. The value can be
2370 suffixed with "k", "m", or "g". When left unconfigured (or
2371 set explicitly to 0), there will be no limit.
2374 An integer -1..9, indicating the compression level for objects
2375 in a pack file. -1 is the zlib default. 0 means no
2376 compression, and 1..9 are various speed/size tradeoffs, 9 being
2377 slowest. If not set, defaults to core.compression. If that is
2378 not set, defaults to -1, the zlib default, which is "a default
2379 compromise between speed and compression (currently equivalent
2382 Note that changing the compression level will not automatically recompress
2383 all existing objects. You can force recompression by passing the -F option
2384 to linkgit:git-repack[1].
2386 pack.deltaCacheSize::
2387 The maximum memory in bytes used for caching deltas in
2388 linkgit:git-pack-objects[1] before writing them out to a pack.
2389 This cache is used to speed up the writing object phase by not
2390 having to recompute the final delta result once the best match
2391 for all objects is found. Repacking large repositories on machines
2392 which are tight with memory might be badly impacted by this though,
2393 especially if this cache pushes the system into swapping.
2394 A value of 0 means no limit. The smallest size of 1 byte may be
2395 used to virtually disable this cache. Defaults to 256 MiB.
2397 pack.deltaCacheLimit::
2398 The maximum size of a delta, that is cached in
2399 linkgit:git-pack-objects[1]. This cache is used to speed up the
2400 writing object phase by not having to recompute the final delta
2401 result once the best match for all objects is found. Defaults to 1000.
2404 Specifies the number of threads to spawn when searching for best
2405 delta matches. This requires that linkgit:git-pack-objects[1]
2406 be compiled with pthreads otherwise this option is ignored with a
2407 warning. This is meant to reduce packing time on multiprocessor
2408 machines. The required amount of memory for the delta search window
2409 is however multiplied by the number of threads.
2410 Specifying 0 will cause Git to auto-detect the number of CPU's
2411 and set the number of threads accordingly.
2414 Specify the default pack index version. Valid values are 1 for
2415 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2416 the new pack index with capabilities for packs larger than 4 GB
2417 as well as proper protection against the repacking of corrupted
2418 packs. Version 2 is the default. Note that version 2 is enforced
2419 and this config option ignored whenever the corresponding pack is
2422 If you have an old Git that does not understand the version 2 `*.idx` file,
2423 cloning or fetching over a non native protocol (e.g. "http")
2424 that will copy both `*.pack` file and corresponding `*.idx` file from the
2425 other side may give you a repository that cannot be accessed with your
2426 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2427 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2430 pack.packSizeLimit::
2431 The maximum size of a pack. This setting only affects
2432 packing to a file when repacking, i.e. the git:// protocol
2433 is unaffected. It can be overridden by the `--max-pack-size`
2434 option of linkgit:git-repack[1]. Reaching this limit results
2435 in the creation of multiple packfiles; which in turn prevents
2436 bitmaps from being created.
2437 The minimum size allowed is limited to 1 MiB.
2438 The default is unlimited.
2439 Common unit suffixes of 'k', 'm', or 'g' are
2443 When true, git will use pack bitmaps (if available) when packing
2444 to stdout (e.g., during the server side of a fetch). Defaults to
2445 true. You should not generally need to turn this off unless
2446 you are debugging pack bitmaps.
2448 pack.writeBitmaps (deprecated)::
2449 This is a deprecated synonym for `repack.writeBitmaps`.
2451 pack.writeBitmapHashCache::
2452 When true, git will include a "hash cache" section in the bitmap
2453 index (if one is written). This cache can be used to feed git's
2454 delta heuristics, potentially leading to better deltas between
2455 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2456 between an older, bitmapped pack and objects that have been
2457 pushed since the last gc). The downside is that it consumes 4
2458 bytes per object of disk space, and that JGit's bitmap
2459 implementation does not understand it, causing it to complain if
2460 Git and JGit are used on the same repository. Defaults to false.
2463 If the value is boolean, turns on or off pagination of the
2464 output of a particular Git subcommand when writing to a tty.
2465 Otherwise, turns on pagination for the subcommand using the
2466 pager specified by the value of `pager.<cmd>`. If `--paginate`
2467 or `--no-pager` is specified on the command line, it takes
2468 precedence over this option. To disable pagination for all
2469 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2472 Alias for a --pretty= format string, as specified in
2473 linkgit:git-log[1]. Any aliases defined here can be used just
2474 as the built-in pretty formats could. For example,
2475 running `git config pretty.changelog "format:* %H %s"`
2476 would cause the invocation `git log --pretty=changelog`
2477 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2478 Note that an alias with the same name as a built-in format
2479 will be silently ignored.
2482 If set, provide a user defined default policy for all protocols which
2483 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2484 if unset, known-safe protocols (http, https, git, ssh, file) have a
2485 default policy of `always`, known-dangerous protocols (ext) have a
2486 default policy of `never`, and all other protocols have a default
2487 policy of `user`. Supported policies:
2491 * `always` - protocol is always able to be used.
2493 * `never` - protocol is never able to be used.
2495 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2496 either unset or has a value of 1. This policy should be used when you want a
2497 protocol to be directly usable by the user but don't want it used by commands which
2498 execute clone/fetch/push commands without user input, e.g. recursive
2499 submodule initialization.
2503 protocol.<name>.allow::
2504 Set a policy to be used by protocol `<name>` with clone/fetch/push
2505 commands. See `protocol.allow` above for the available policies.
2507 The protocol names currently used by git are:
2510 - `file`: any local file-based path (including `file://` URLs,
2513 - `git`: the anonymous git protocol over a direct TCP
2514 connection (or proxy, if configured)
2516 - `ssh`: git over ssh (including `host:path` syntax,
2519 - `http`: git over http, both "smart http" and "dumb http".
2520 Note that this does _not_ include `https`; if you want to configure
2521 both, you must do so individually.
2523 - any external helpers are named by their protocol (e.g., use
2524 `hg` to allow the `git-remote-hg` helper)
2528 By default, Git does not create an extra merge commit when merging
2529 a commit that is a descendant of the current commit. Instead, the
2530 tip of the current branch is fast-forwarded. When set to `false`,
2531 this variable tells Git to create an extra merge commit in such
2532 a case (equivalent to giving the `--no-ff` option from the command
2533 line). When set to `only`, only such fast-forward merges are
2534 allowed (equivalent to giving the `--ff-only` option from the
2535 command line). This setting overrides `merge.ff` when pulling.
2538 When true, rebase branches on top of the fetched branch, instead
2539 of merging the default branch from the default remote when "git
2540 pull" is run. See "branch.<name>.rebase" for setting this on a
2543 When preserve, also pass `--preserve-merges` along to 'git rebase'
2544 so that locally committed merge commits will not be flattened
2545 by running 'git pull'.
2547 When the value is `interactive`, the rebase is run in interactive mode.
2549 *NOTE*: this is a possibly dangerous operation; do *not* use
2550 it unless you understand the implications (see linkgit:git-rebase[1]
2554 The default merge strategy to use when pulling multiple branches
2558 The default merge strategy to use when pulling a single branch.
2561 Defines the action `git push` should take if no refspec is
2562 explicitly given. Different values are well-suited for
2563 specific workflows; for instance, in a purely central workflow
2564 (i.e. the fetch source is equal to the push destination),
2565 `upstream` is probably what you want. Possible values are:
2569 * `nothing` - do not push anything (error out) unless a refspec is
2570 explicitly given. This is primarily meant for people who want to
2571 avoid mistakes by always being explicit.
2573 * `current` - push the current branch to update a branch with the same
2574 name on the receiving end. Works in both central and non-central
2577 * `upstream` - push the current branch back to the branch whose
2578 changes are usually integrated into the current branch (which is
2579 called `@{upstream}`). This mode only makes sense if you are
2580 pushing to the same repository you would normally pull from
2581 (i.e. central workflow).
2583 * `tracking` - This is a deprecated synonym for `upstream`.
2585 * `simple` - in centralized workflow, work like `upstream` with an
2586 added safety to refuse to push if the upstream branch's name is
2587 different from the local one.
2589 When pushing to a remote that is different from the remote you normally
2590 pull from, work as `current`. This is the safest option and is suited
2593 This mode has become the default in Git 2.0.
2595 * `matching` - push all branches having the same name on both ends.
2596 This makes the repository you are pushing to remember the set of
2597 branches that will be pushed out (e.g. if you always push 'maint'
2598 and 'master' there and no other branches, the repository you push
2599 to will have these two branches, and your local 'maint' and
2600 'master' will be pushed there).
2602 To use this mode effectively, you have to make sure _all_ the
2603 branches you would push out are ready to be pushed out before
2604 running 'git push', as the whole point of this mode is to allow you
2605 to push all of the branches in one go. If you usually finish work
2606 on only one branch and push out the result, while other branches are
2607 unfinished, this mode is not for you. Also this mode is not
2608 suitable for pushing into a shared central repository, as other
2609 people may add new branches there, or update the tip of existing
2610 branches outside your control.
2612 This used to be the default, but not since Git 2.0 (`simple` is the
2618 If set to true enable `--follow-tags` option by default. You
2619 may override this configuration at time of push by specifying
2623 May be set to a boolean value, or the string 'if-asked'. A true
2624 value causes all pushes to be GPG signed, as if `--signed` is
2625 passed to linkgit:git-push[1]. The string 'if-asked' causes
2626 pushes to be signed if the server supports it, as if
2627 `--signed=if-asked` is passed to 'git push'. A false value may
2628 override a value from a lower-priority config file. An explicit
2629 command-line flag always overrides this config option.
2631 push.recurseSubmodules::
2632 Make sure all submodule commits used by the revisions to be pushed
2633 are available on a remote-tracking branch. If the value is 'check'
2634 then Git will verify that all submodule commits that changed in the
2635 revisions to be pushed are available on at least one remote of the
2636 submodule. If any commits are missing, the push will be aborted and
2637 exit with non-zero status. If the value is 'on-demand' then all
2638 submodules that changed in the revisions to be pushed will be
2639 pushed. If on-demand was not able to push all necessary revisions
2640 it will also be aborted and exit with non-zero status. If the value
2641 is 'no' then default behavior of ignoring submodules when pushing
2642 is retained. You may override this configuration at time of push by
2643 specifying '--recurse-submodules=check|on-demand|no'.
2646 Whether to show a diffstat of what changed upstream since the last
2647 rebase. False by default.
2650 If set to true enable `--autosquash` option by default.
2653 When set to true, automatically create a temporary stash entry
2654 before the operation begins, and apply it after the operation
2655 ends. This means that you can run rebase on a dirty worktree.
2656 However, use with care: the final stash application after a
2657 successful rebase might result in non-trivial conflicts.
2660 rebase.missingCommitsCheck::
2661 If set to "warn", git rebase -i will print a warning if some
2662 commits are removed (e.g. a line was deleted), however the
2663 rebase will still proceed. If set to "error", it will print
2664 the previous warning and stop the rebase, 'git rebase
2665 --edit-todo' can then be used to correct the error. If set to
2666 "ignore", no checking is done.
2667 To drop a commit without warning or error, use the `drop`
2668 command in the todo-list.
2669 Defaults to "ignore".
2671 rebase.instructionFormat::
2672 A format string, as specified in linkgit:git-log[1], to be used for
2673 the instruction list during an interactive rebase. The format will automatically
2674 have the long commit hash prepended to the format.
2676 receive.advertiseAtomic::
2677 By default, git-receive-pack will advertise the atomic push
2678 capability to its clients. If you don't want to advertise this
2679 capability, set this variable to false.
2681 receive.advertisePushOptions::
2682 When set to true, git-receive-pack will advertise the push options
2683 capability to its clients. False by default.
2686 By default, git-receive-pack will run "git-gc --auto" after
2687 receiving data from git-push and updating refs. You can stop
2688 it by setting this variable to false.
2690 receive.certNonceSeed::
2691 By setting this variable to a string, `git receive-pack`
2692 will accept a `git push --signed` and verifies it by using
2693 a "nonce" protected by HMAC using this string as a secret
2696 receive.certNonceSlop::
2697 When a `git push --signed` sent a push certificate with a
2698 "nonce" that was issued by a receive-pack serving the same
2699 repository within this many seconds, export the "nonce"
2700 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2701 hooks (instead of what the receive-pack asked the sending
2702 side to include). This may allow writing checks in
2703 `pre-receive` and `post-receive` a bit easier. Instead of
2704 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2705 that records by how many seconds the nonce is stale to
2706 decide if they want to accept the certificate, they only
2707 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2709 receive.fsckObjects::
2710 If it is set to true, git-receive-pack will check all received
2711 objects. It will abort in the case of a malformed object or a
2712 broken link. The result of an abort are only dangling objects.
2713 Defaults to false. If not set, the value of `transfer.fsckObjects`
2716 receive.fsck.<msg-id>::
2717 When `receive.fsckObjects` is set to true, errors can be switched
2718 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2719 setting where the `<msg-id>` is the fsck message ID and the value
2720 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2721 the error/warning with the message ID, e.g. "missingEmail: invalid
2722 author/committer line - missing email" means that setting
2723 `receive.fsck.missingEmail = ignore` will hide that issue.
2725 This feature is intended to support working with legacy repositories
2726 which would not pass pushing when `receive.fsckObjects = true`, allowing
2727 the host to accept repositories with certain known issues but still catch
2730 receive.fsck.skipList::
2731 The path to a sorted list of object names (i.e. one SHA-1 per
2732 line) that are known to be broken in a non-fatal way and should
2733 be ignored. This feature is useful when an established project
2734 should be accepted despite early commits containing errors that
2735 can be safely ignored such as invalid committer email addresses.
2736 Note: corrupt objects cannot be skipped with this setting.
2739 After receiving the pack from the client, `receive-pack` may
2740 produce no output (if `--quiet` was specified) while processing
2741 the pack, causing some networks to drop the TCP connection.
2742 With this option set, if `receive-pack` does not transmit
2743 any data in this phase for `receive.keepAlive` seconds, it will
2744 send a short keepalive packet. The default is 5 seconds; set
2745 to 0 to disable keepalives entirely.
2747 receive.unpackLimit::
2748 If the number of objects received in a push is below this
2749 limit then the objects will be unpacked into loose object
2750 files. However if the number of received objects equals or
2751 exceeds this limit then the received pack will be stored as
2752 a pack, after adding any missing delta bases. Storing the
2753 pack from a push can make the push operation complete faster,
2754 especially on slow filesystems. If not set, the value of
2755 `transfer.unpackLimit` is used instead.
2757 receive.maxInputSize::
2758 If the size of the incoming pack stream is larger than this
2759 limit, then git-receive-pack will error out, instead of
2760 accepting the pack file. If not set or set to 0, then the size
2763 receive.denyDeletes::
2764 If set to true, git-receive-pack will deny a ref update that deletes
2765 the ref. Use this to prevent such a ref deletion via a push.
2767 receive.denyDeleteCurrent::
2768 If set to true, git-receive-pack will deny a ref update that
2769 deletes the currently checked out branch of a non-bare repository.
2771 receive.denyCurrentBranch::
2772 If set to true or "refuse", git-receive-pack will deny a ref update
2773 to the currently checked out branch of a non-bare repository.
2774 Such a push is potentially dangerous because it brings the HEAD
2775 out of sync with the index and working tree. If set to "warn",
2776 print a warning of such a push to stderr, but allow the push to
2777 proceed. If set to false or "ignore", allow such pushes with no
2778 message. Defaults to "refuse".
2780 Another option is "updateInstead" which will update the working
2781 tree if pushing into the current branch. This option is
2782 intended for synchronizing working directories when one side is not easily
2783 accessible via interactive ssh (e.g. a live web site, hence the requirement
2784 that the working directory be clean). This mode also comes in handy when
2785 developing inside a VM to test and fix code on different Operating Systems.
2787 By default, "updateInstead" will refuse the push if the working tree or
2788 the index have any difference from the HEAD, but the `push-to-checkout`
2789 hook can be used to customize this. See linkgit:githooks[5].
2791 receive.denyNonFastForwards::
2792 If set to true, git-receive-pack will deny a ref update which is
2793 not a fast-forward. Use this to prevent such an update via a push,
2794 even if that push is forced. This configuration variable is
2795 set when initializing a shared repository.
2798 This variable is the same as `transfer.hideRefs`, but applies
2799 only to `receive-pack` (and so affects pushes, but not fetches).
2800 An attempt to update or delete a hidden ref by `git push` is
2803 receive.updateServerInfo::
2804 If set to true, git-receive-pack will run git-update-server-info
2805 after receiving data from git-push and updating refs.
2807 receive.shallowUpdate::
2808 If set to true, .git/shallow can be updated when new refs
2809 require new shallow roots. Otherwise those refs are rejected.
2811 remote.pushDefault::
2812 The remote to push to by default. Overrides
2813 `branch.<name>.remote` for all branches, and is overridden by
2814 `branch.<name>.pushRemote` for specific branches.
2817 The URL of a remote repository. See linkgit:git-fetch[1] or
2818 linkgit:git-push[1].
2820 remote.<name>.pushurl::
2821 The push URL of a remote repository. See linkgit:git-push[1].
2823 remote.<name>.proxy::
2824 For remotes that require curl (http, https and ftp), the URL to
2825 the proxy to use for that remote. Set to the empty string to
2826 disable proxying for that remote.
2828 remote.<name>.proxyAuthMethod::
2829 For remotes that require curl (http, https and ftp), the method to use for
2830 authenticating against the proxy in use (probably set in
2831 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2833 remote.<name>.fetch::
2834 The default set of "refspec" for linkgit:git-fetch[1]. See
2835 linkgit:git-fetch[1].
2837 remote.<name>.push::
2838 The default set of "refspec" for linkgit:git-push[1]. See
2839 linkgit:git-push[1].
2841 remote.<name>.mirror::
2842 If true, pushing to this remote will automatically behave
2843 as if the `--mirror` option was given on the command line.
2845 remote.<name>.skipDefaultUpdate::
2846 If true, this remote will be skipped by default when updating
2847 using linkgit:git-fetch[1] or the `update` subcommand of
2848 linkgit:git-remote[1].
2850 remote.<name>.skipFetchAll::
2851 If true, this remote will be skipped by default when updating
2852 using linkgit:git-fetch[1] or the `update` subcommand of
2853 linkgit:git-remote[1].
2855 remote.<name>.receivepack::
2856 The default program to execute on the remote side when pushing. See
2857 option --receive-pack of linkgit:git-push[1].
2859 remote.<name>.uploadpack::
2860 The default program to execute on the remote side when fetching. See
2861 option --upload-pack of linkgit:git-fetch-pack[1].
2863 remote.<name>.tagOpt::
2864 Setting this value to --no-tags disables automatic tag following when
2865 fetching from remote <name>. Setting it to --tags will fetch every
2866 tag from remote <name>, even if they are not reachable from remote
2867 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2868 override this setting. See options --tags and --no-tags of
2869 linkgit:git-fetch[1].
2872 Setting this to a value <vcs> will cause Git to interact with
2873 the remote with the git-remote-<vcs> helper.
2875 remote.<name>.prune::
2876 When set to true, fetching from this remote by default will also
2877 remove any remote-tracking references that no longer exist on the
2878 remote (as if the `--prune` option was given on the command line).
2879 Overrides `fetch.prune` settings, if any.
2882 The list of remotes which are fetched by "git remote update
2883 <group>". See linkgit:git-remote[1].
2885 repack.useDeltaBaseOffset::
2886 By default, linkgit:git-repack[1] creates packs that use
2887 delta-base offset. If you need to share your repository with
2888 Git older than version 1.4.4, either directly or via a dumb
2889 protocol such as http, then you need to set this option to
2890 "false" and repack. Access from old Git versions over the
2891 native protocol are unaffected by this option.
2893 repack.packKeptObjects::
2894 If set to true, makes `git repack` act as if
2895 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2896 details. Defaults to `false` normally, but `true` if a bitmap
2897 index is being written (either via `--write-bitmap-index` or
2898 `repack.writeBitmaps`).
2900 repack.writeBitmaps::
2901 When true, git will write a bitmap index when packing all
2902 objects to disk (e.g., when `git repack -a` is run). This
2903 index can speed up the "counting objects" phase of subsequent
2904 packs created for clones and fetches, at the cost of some disk
2905 space and extra time spent on the initial repack. This has
2906 no effect if multiple packfiles are created.
2910 When set to true, `git-rerere` updates the index with the
2911 resulting contents after it cleanly resolves conflicts using
2912 previously recorded resolution. Defaults to false.
2915 Activate recording of resolved conflicts, so that identical
2916 conflict hunks can be resolved automatically, should they be
2917 encountered again. By default, linkgit:git-rerere[1] is
2918 enabled if there is an `rr-cache` directory under the
2919 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2922 sendemail.identity::
2923 A configuration identity. When given, causes values in the
2924 'sendemail.<identity>' subsection to take precedence over
2925 values in the 'sendemail' section. The default identity is
2926 the value of `sendemail.identity`.
2928 sendemail.smtpEncryption::
2929 See linkgit:git-send-email[1] for description. Note that this
2930 setting is not subject to the 'identity' mechanism.
2932 sendemail.smtpssl (deprecated)::
2933 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2935 sendemail.smtpsslcertpath::
2936 Path to ca-certificates (either a directory or a single file).
2937 Set it to an empty string to disable certificate verification.
2939 sendemail.<identity>.*::
2940 Identity-specific versions of the 'sendemail.*' parameters
2941 found below, taking precedence over those when this
2942 identity is selected, through either the command-line or
2943 `sendemail.identity`.
2945 sendemail.aliasesFile::
2946 sendemail.aliasFileType::
2947 sendemail.annotate::
2951 sendemail.chainReplyTo::
2953 sendemail.envelopeSender::
2955 sendemail.multiEdit::
2956 sendemail.signedoffbycc::
2957 sendemail.smtpPass::
2958 sendemail.suppresscc::
2959 sendemail.suppressFrom::
2961 sendemail.smtpDomain::
2962 sendemail.smtpServer::
2963 sendemail.smtpServerPort::
2964 sendemail.smtpServerOption::
2965 sendemail.smtpUser::
2967 sendemail.transferEncoding::
2968 sendemail.validate::
2970 See linkgit:git-send-email[1] for description.
2972 sendemail.signedoffcc (deprecated)::
2973 Deprecated alias for `sendemail.signedoffbycc`.
2975 sendemail.smtpBatchSize::
2976 Number of messages to be sent per connection, after that a relogin
2977 will happen. If the value is 0 or undefined, send all messages in
2979 See also the `--batch-size` option of linkgit:git-send-email[1].
2981 sendemail.smtpReloginDelay::
2982 Seconds wait before reconnecting to smtp server.
2983 See also the `--relogin-delay` option of linkgit:git-send-email[1].
2985 showbranch.default::
2986 The default set of branches for linkgit:git-show-branch[1].
2987 See linkgit:git-show-branch[1].
2989 splitIndex.maxPercentChange::
2990 When the split index feature is used, this specifies the
2991 percent of entries the split index can contain compared to the
2992 total number of entries in both the split index and the shared
2993 index before a new shared index is written.
2994 The value should be between 0 and 100. If the value is 0 then
2995 a new shared index is always written, if it is 100 a new
2996 shared index is never written.
2997 By default the value is 20, so a new shared index is written
2998 if the number of entries in the split index would be greater
2999 than 20 percent of the total number of entries.
3000 See linkgit:git-update-index[1].
3002 splitIndex.sharedIndexExpire::
3003 When the split index feature is used, shared index files that
3004 were not modified since the time this variable specifies will
3005 be removed when a new shared index file is created. The value
3006 "now" expires all entries immediately, and "never" suppresses
3007 expiration altogether.
3008 The default value is "2.weeks.ago".
3009 Note that a shared index file is considered modified (for the
3010 purpose of expiration) each time a new split-index file is
3011 either created based on it or read from it.
3012 See linkgit:git-update-index[1].
3014 status.relativePaths::
3015 By default, linkgit:git-status[1] shows paths relative to the
3016 current directory. Setting this variable to `false` shows paths
3017 relative to the repository root (this was the default for Git
3021 Set to true to enable --short by default in linkgit:git-status[1].
3022 The option --no-short takes precedence over this variable.
3025 Set to true to enable --branch by default in linkgit:git-status[1].
3026 The option --no-branch takes precedence over this variable.
3028 status.displayCommentPrefix::
3029 If set to true, linkgit:git-status[1] will insert a comment
3030 prefix before each output line (starting with
3031 `core.commentChar`, i.e. `#` by default). This was the
3032 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3036 If set to true, linkgit:git-status[1] will display the number of
3037 entries currently stashed away.
3040 status.showUntrackedFiles::
3041 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3042 files which are not currently tracked by Git. Directories which
3043 contain only untracked files, are shown with the directory name
3044 only. Showing untracked files means that Git needs to lstat() all
3045 the files in the whole repository, which might be slow on some
3046 systems. So, this variable controls how the commands displays
3047 the untracked files. Possible values are:
3050 * `no` - Show no untracked files.
3051 * `normal` - Show untracked files and directories.
3052 * `all` - Show also individual files in untracked directories.
3055 If this variable is not specified, it defaults to 'normal'.
3056 This variable can be overridden with the -u|--untracked-files option
3057 of linkgit:git-status[1] and linkgit:git-commit[1].
3059 status.submoduleSummary::
3061 If this is set to a non zero number or true (identical to -1 or an
3062 unlimited number), the submodule summary will be enabled and a
3063 summary of commits for modified submodules will be shown (see
3064 --summary-limit option of linkgit:git-submodule[1]). Please note
3065 that the summary output command will be suppressed for all
3066 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3067 for those submodules where `submodule.<name>.ignore=all`. The only
3068 exception to that rule is that status and commit will show staged
3069 submodule changes. To
3070 also view the summary for ignored submodules you can either use
3071 the --ignore-submodules=dirty command-line option or the 'git
3072 submodule summary' command, which shows a similar output but does
3073 not honor these settings.
3076 If this is set to true, the `git stash show` command without an
3077 option will show the stash entry in patch form. Defaults to false.
3078 See description of 'show' command in linkgit:git-stash[1].
3081 If this is set to true, the `git stash show` command without an
3082 option will show diffstat of the stash entry. Defaults to true.
3083 See description of 'show' command in linkgit:git-stash[1].
3085 submodule.<name>.url::
3086 The URL for a submodule. This variable is copied from the .gitmodules
3087 file to the git config via 'git submodule init'. The user can change
3088 the configured URL before obtaining the submodule via 'git submodule
3089 update'. If neither submodule.<name>.active or submodule.active are
3090 set, the presence of this variable is used as a fallback to indicate
3091 whether the submodule is of interest to git commands.
3092 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3094 submodule.<name>.update::
3095 The default update procedure for a submodule. This variable
3096 is populated by `git submodule init` from the
3097 linkgit:gitmodules[5] file. See description of 'update'
3098 command in linkgit:git-submodule[1].
3100 submodule.<name>.branch::
3101 The remote branch name for a submodule, used by `git submodule
3102 update --remote`. Set this option to override the value found in
3103 the `.gitmodules` file. See linkgit:git-submodule[1] and
3104 linkgit:gitmodules[5] for details.
3106 submodule.<name>.fetchRecurseSubmodules::
3107 This option can be used to control recursive fetching of this
3108 submodule. It can be overridden by using the --[no-]recurse-submodules
3109 command-line option to "git fetch" and "git pull".
3110 This setting will override that from in the linkgit:gitmodules[5]
3113 submodule.<name>.ignore::
3114 Defines under what circumstances "git status" and the diff family show
3115 a submodule as modified. When set to "all", it will never be considered
3116 modified (but it will nonetheless show up in the output of status and
3117 commit when it has been staged), "dirty" will ignore all changes
3118 to the submodules work tree and
3119 takes only differences between the HEAD of the submodule and the commit
3120 recorded in the superproject into account. "untracked" will additionally
3121 let submodules with modified tracked files in their work tree show up.
3122 Using "none" (the default when this option is not set) also shows
3123 submodules that have untracked files in their work tree as changed.
3124 This setting overrides any setting made in .gitmodules for this submodule,
3125 both settings can be overridden on the command line by using the
3126 "--ignore-submodules" option. The 'git submodule' commands are not
3127 affected by this setting.
3129 submodule.<name>.active::
3130 Boolean value indicating if the submodule is of interest to git
3131 commands. This config option takes precedence over the
3132 submodule.active config option.
3135 A repeated field which contains a pathspec used to match against a
3136 submodule's path to determine if the submodule is of interest to git
3140 Specifies if commands recurse into submodules by default. This
3141 applies to all commands that have a `--recurse-submodules` option.
3144 submodule.fetchJobs::
3145 Specifies how many submodules are fetched/cloned at the same time.
3146 A positive integer allows up to that number of submodules fetched
3147 in parallel. A value of 0 will give some reasonable default.
3148 If unset, it defaults to 1.
3150 submodule.alternateLocation::
3151 Specifies how the submodules obtain alternates when submodules are
3152 cloned. Possible values are `no`, `superproject`.
3153 By default `no` is assumed, which doesn't add references. When the
3154 value is set to `superproject` the submodule to be cloned computes
3155 its alternates location relative to the superprojects alternate.
3157 submodule.alternateErrorStrategy::
3158 Specifies how to treat errors with the alternates for a submodule
3159 as computed via `submodule.alternateLocation`. Possible values are
3160 `ignore`, `info`, `die`. Default is `die`.
3162 tag.forceSignAnnotated::
3163 A boolean to specify whether annotated tags created should be GPG signed.
3164 If `--annotate` is specified on the command line, it takes
3165 precedence over this option.
3168 This variable controls the sort ordering of tags when displayed by
3169 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3170 value of this variable will be used as the default.
3173 This variable can be used to restrict the permission bits of
3174 tar archive entries. The default is 0002, which turns off the
3175 world write bit. The special value "user" indicates that the
3176 archiving user's umask will be used instead. See umask(2) and
3177 linkgit:git-archive[1].
3179 transfer.fsckObjects::
3180 When `fetch.fsckObjects` or `receive.fsckObjects` are
3181 not set, the value of this variable is used instead.
3185 String(s) `receive-pack` and `upload-pack` use to decide which
3186 refs to omit from their initial advertisements. Use more than
3187 one definition to specify multiple prefix strings. A ref that is
3188 under the hierarchies listed in the value of this variable is
3189 excluded, and is hidden when responding to `git push` or `git
3190 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3191 program-specific versions of this config.
3193 You may also include a `!` in front of the ref name to negate the entry,
3194 explicitly exposing it, even if an earlier entry marked it as hidden.
3195 If you have multiple hideRefs values, later entries override earlier ones
3196 (and entries in more-specific config files override less-specific ones).
3198 If a namespace is in use, the namespace prefix is stripped from each
3199 reference before it is matched against `transfer.hiderefs` patterns.
3200 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3201 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3202 is omitted from the advertisements but `refs/heads/master` and
3203 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3204 "have" lines. In order to match refs before stripping, add a `^` in front of
3205 the ref name. If you combine `!` and `^`, `!` must be specified first.
3207 Even if you hide refs, a client may still be able to steal the target
3208 objects via the techniques described in the "SECURITY" section of the
3209 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3210 separate repository.
3212 transfer.unpackLimit::
3213 When `fetch.unpackLimit` or `receive.unpackLimit` are
3214 not set, the value of this variable is used instead.
3215 The default value is 100.
3217 uploadarchive.allowUnreachable::
3218 If true, allow clients to use `git archive --remote` to request
3219 any tree, whether reachable from the ref tips or not. See the
3220 discussion in the "SECURITY" section of
3221 linkgit:git-upload-archive[1] for more details. Defaults to
3224 uploadpack.hideRefs::
3225 This variable is the same as `transfer.hideRefs`, but applies
3226 only to `upload-pack` (and so affects only fetches, not pushes).
3227 An attempt to fetch a hidden ref by `git fetch` will fail. See
3228 also `uploadpack.allowTipSHA1InWant`.
3230 uploadpack.allowTipSHA1InWant::
3231 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3232 to accept a fetch request that asks for an object at the tip
3233 of a hidden ref (by default, such a request is rejected).
3234 See also `uploadpack.hideRefs`. Even if this is false, a client
3235 may be able to steal objects via the techniques described in the
3236 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3237 best to keep private data in a separate repository.
3239 uploadpack.allowReachableSHA1InWant::
3240 Allow `upload-pack` to accept a fetch request that asks for an
3241 object that is reachable from any ref tip. However, note that
3242 calculating object reachability is computationally expensive.
3243 Defaults to `false`. Even if this is false, a client may be able
3244 to steal objects via the techniques described in the "SECURITY"
3245 section of the linkgit:gitnamespaces[7] man page; it's best to
3246 keep private data in a separate repository.
3248 uploadpack.allowAnySHA1InWant::
3249 Allow `upload-pack` to accept a fetch request that asks for any
3251 Defaults to `false`.
3253 uploadpack.keepAlive::
3254 When `upload-pack` has started `pack-objects`, there may be a
3255 quiet period while `pack-objects` prepares the pack. Normally
3256 it would output progress information, but if `--quiet` was used
3257 for the fetch, `pack-objects` will output nothing at all until
3258 the pack data begins. Some clients and networks may consider
3259 the server to be hung and give up. Setting this option instructs
3260 `upload-pack` to send an empty keepalive packet every
3261 `uploadpack.keepAlive` seconds. Setting this option to 0
3262 disables keepalive packets entirely. The default is 5 seconds.
3264 uploadpack.packObjectsHook::
3265 If this option is set, when `upload-pack` would run
3266 `git pack-objects` to create a packfile for a client, it will
3267 run this shell command instead. The `pack-objects` command and
3268 arguments it _would_ have run (including the `git pack-objects`
3269 at the beginning) are appended to the shell command. The stdin
3270 and stdout of the hook are treated as if `pack-objects` itself
3271 was run. I.e., `upload-pack` will feed input intended for
3272 `pack-objects` to the hook, and expects a completed packfile on
3275 Note that this configuration variable is ignored if it is seen in the
3276 repository-level config (this is a safety measure against fetching from
3277 untrusted repositories).
3279 url.<base>.insteadOf::
3280 Any URL that starts with this value will be rewritten to
3281 start, instead, with <base>. In cases where some site serves a
3282 large number of repositories, and serves them with multiple
3283 access methods, and some users need to use different access
3284 methods, this feature allows people to specify any of the
3285 equivalent URLs and have Git automatically rewrite the URL to
3286 the best alternative for the particular user, even for a
3287 never-before-seen repository on the site. When more than one
3288 insteadOf strings match a given URL, the longest match is used.
3290 Note that any protocol restrictions will be applied to the rewritten
3291 URL. If the rewrite changes the URL to use a custom protocol or remote
3292 helper, you may need to adjust the `protocol.*.allow` config to permit
3293 the request. In particular, protocols you expect to use for submodules
3294 must be set to `always` rather than the default of `user`. See the
3295 description of `protocol.allow` above.
3297 url.<base>.pushInsteadOf::
3298 Any URL that starts with this value will not be pushed to;
3299 instead, it will be rewritten to start with <base>, and the
3300 resulting URL will be pushed to. In cases where some site serves
3301 a large number of repositories, and serves them with multiple
3302 access methods, some of which do not allow push, this feature
3303 allows people to specify a pull-only URL and have Git
3304 automatically use an appropriate URL to push, even for a
3305 never-before-seen repository on the site. When more than one
3306 pushInsteadOf strings match a given URL, the longest match is
3307 used. If a remote has an explicit pushurl, Git will ignore this
3308 setting for that remote.
3311 Your email address to be recorded in any newly created commits.
3312 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3313 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3316 Your full name to be recorded in any newly created commits.
3317 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3318 environment variables. See linkgit:git-commit-tree[1].
3320 user.useConfigOnly::
3321 Instruct Git to avoid trying to guess defaults for `user.email`
3322 and `user.name`, and instead retrieve the values only from the
3323 configuration. For example, if you have multiple email addresses
3324 and would like to use a different one for each repository, then
3325 with this configuration option set to `true` in the global config
3326 along with a name, Git will prompt you to set up an email before
3327 making new commits in a newly cloned repository.
3328 Defaults to `false`.
3331 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3332 key you want it to automatically when creating a signed tag or
3333 commit, you can override the default selection with this variable.
3334 This option is passed unchanged to gpg's --local-user parameter,
3335 so you may specify a key using any method that gpg supports.
3337 versionsort.prereleaseSuffix (deprecated)::
3338 Deprecated alias for `versionsort.suffix`. Ignored if
3339 `versionsort.suffix` is set.
3341 versionsort.suffix::
3342 Even when version sort is used in linkgit:git-tag[1], tagnames
3343 with the same base version but different suffixes are still sorted
3344 lexicographically, resulting e.g. in prerelease tags appearing
3345 after the main release (e.g. "1.0-rc1" after "1.0"). This
3346 variable can be specified to determine the sorting order of tags
3347 with different suffixes.
3349 By specifying a single suffix in this variable, any tagname containing
3350 that suffix will appear before the corresponding main release. E.g. if
3351 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3352 "1.0". If specified multiple times, once per suffix, then the order of
3353 suffixes in the configuration will determine the sorting order of tagnames
3354 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3355 configuration, then all "1.0-preX" tags will be listed before any
3356 "1.0-rcX" tags. The placement of the main release tag relative to tags
3357 with various suffixes can be determined by specifying the empty suffix
3358 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3359 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3360 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3363 If more than one suffixes match the same tagname, then that tagname will
3364 be sorted according to the suffix which starts at the earliest position in
3365 the tagname. If more than one different matching suffixes start at
3366 that earliest position, then that tagname will be sorted according to the
3367 longest of those suffixes.
3368 The sorting order between different suffixes is undefined if they are
3369 in multiple config files.
3372 Specify a web browser that may be used by some commands.
3373 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]