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 can be spelled as `yes`, `on`, `true`,
220 or `1`. Also, a variable defined without `= <value>`
223 false;; Boolean false can be spelled as `no`, `off`,
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 false, the ctime differences between the index and the
418 working tree are ignored; useful when the inode change time
419 is regularly modified by something outside Git (file system
420 crawlers and some backup systems).
421 See linkgit:git-update-index[1]. True by default.
424 If true, the split-index feature of the index will be used.
425 See linkgit:git-update-index[1]. False by default.
427 core.untrackedCache::
428 Determines what to do about the untracked cache feature of the
429 index. It will be kept, if this variable is unset or set to
430 `keep`. It will automatically be added if set to `true`. And
431 it will automatically be removed, if set to `false`. Before
432 setting it to `true`, you should check that mtime is working
433 properly on your system.
434 See linkgit:git-update-index[1]. `keep` by default.
437 Determines which stat fields to match between the index
438 and work tree. The user can set this to 'default' or
439 'minimal'. Default (or explicitly 'default'), is to check
440 all fields, including the sub-second part of mtime and ctime.
443 Commands that output paths (e.g. 'ls-files', 'diff'), will
444 quote "unusual" characters in the pathname by enclosing the
445 pathname in double-quotes and escaping those characters with
446 backslashes in the same way C escapes control characters (e.g.
447 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
448 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
449 UTF-8). If this variable is set to false, bytes higher than
450 0x80 are not considered "unusual" any more. Double-quotes,
451 backslash and control characters are always escaped regardless
452 of the setting of this variable. A simple space character is
453 not considered "unusual". Many commands can output pathnames
454 completely verbatim using the `-z` option. The default value
458 Sets the line ending type to use in the working directory for
459 files that have the `text` property set when core.autocrlf is false.
460 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
461 native line ending. The default value is `native`. See
462 linkgit:gitattributes[5] for more information on end-of-line
466 If true, makes Git check if converting `CRLF` is reversible when
467 end-of-line conversion is active. Git will verify if a command
468 modifies a file in the work tree either directly or indirectly.
469 For example, committing a file followed by checking out the
470 same file should yield the original file in the work tree. If
471 this is not the case for the current setting of
472 `core.autocrlf`, Git will reject the file. The variable can
473 be set to "warn", in which case Git will only warn about an
474 irreversible conversion but continue the operation.
476 CRLF conversion bears a slight chance of corrupting data.
477 When it is enabled, Git will convert CRLF to LF during commit and LF to
478 CRLF during checkout. A file that contains a mixture of LF and
479 CRLF before the commit cannot be recreated by Git. For text
480 files this is the right thing to do: it corrects line endings
481 such that we have only LF line endings in the repository.
482 But for binary files that are accidentally classified as text the
483 conversion can corrupt data.
485 If you recognize such corruption early you can easily fix it by
486 setting the conversion type explicitly in .gitattributes. Right
487 after committing you still have the original file in your work
488 tree and this file is not yet corrupted. You can explicitly tell
489 Git that this file is binary and Git will handle the file
492 Unfortunately, the desired effect of cleaning up text files with
493 mixed line endings and the undesired effect of corrupting binary
494 files cannot be distinguished. In both cases CRLFs are removed
495 in an irreversible way. For text files this is the right thing
496 to do because CRLFs are line endings, while for binary files
497 converting CRLFs corrupts data.
499 Note, this safety check does not mean that a checkout will generate a
500 file identical to the original file for a different setting of
501 `core.eol` and `core.autocrlf`, but only for the current one. For
502 example, a text file with `LF` would be accepted with `core.eol=lf`
503 and could later be checked out with `core.eol=crlf`, in which case the
504 resulting file would contain `CRLF`, although the original file
505 contained `LF`. However, in both work trees the line endings would be
506 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
507 file with mixed line endings would be reported by the `core.safecrlf`
511 Setting this variable to "true" is the same as setting
512 the `text` attribute to "auto" on all files and core.eol to "crlf".
513 Set to true if you want to have `CRLF` line endings in your
514 working directory and the repository has LF line endings.
515 This variable can be set to 'input',
516 in which case no output conversion is performed.
519 If false, symbolic links are checked out as small plain files that
520 contain the link text. linkgit:git-update-index[1] and
521 linkgit:git-add[1] will not change the recorded type to regular
522 file. Useful on filesystems like FAT that do not support
525 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
526 will probe and set core.symlinks false if appropriate when the repository
530 A "proxy command" to execute (as 'command host port') instead
531 of establishing direct connection to the remote server when
532 using the Git protocol for fetching. If the variable value is
533 in the "COMMAND for DOMAIN" format, the command is applied only
534 on hostnames ending with the specified domain string. This variable
535 may be set multiple times and is matched in the given order;
536 the first match wins.
538 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
539 (which always applies universally, without the special "for"
542 The special string `none` can be used as the proxy command to
543 specify that no proxy be used for a given domain pattern.
544 This is useful for excluding servers inside a firewall from
545 proxy use, while defaulting to a common proxy for external domains.
548 If this variable is set, `git fetch` and `git push` will
549 use the specified command instead of `ssh` when they need to
550 connect to a remote system. The command is in the same form as
551 the `GIT_SSH_COMMAND` environment variable and is overridden
552 when the environment variable is set.
555 If true, Git will avoid using lstat() calls to detect if files have
556 changed by setting the "assume-unchanged" bit for those tracked files
557 which it has updated identically in both the index and working tree.
559 When files are modified outside of Git, the user will need to stage
560 the modified files explicitly (e.g. see 'Examples' section in
561 linkgit:git-update-index[1]).
562 Git will not normally detect changes to those files.
564 This is useful on systems where lstat() calls are very slow, such as
565 CIFS/Microsoft Windows.
569 core.preferSymlinkRefs::
570 Instead of the default "symref" format for HEAD
571 and other symbolic reference files, use symbolic links.
572 This is sometimes needed to work with old scripts that
573 expect HEAD to be a symbolic link.
576 If true this repository is assumed to be 'bare' and has no
577 working directory associated with it. If this is the case a
578 number of commands that require a working directory will be
579 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
581 This setting is automatically guessed by linkgit:git-clone[1] or
582 linkgit:git-init[1] when the repository was created. By default a
583 repository that ends in "/.git" is assumed to be not bare (bare =
584 false), while all other repositories are assumed to be bare (bare
588 Set the path to the root of the working tree.
589 If `GIT_COMMON_DIR` environment variable is set, core.worktree
590 is ignored and not used for determining the root of working tree.
591 This can be overridden by the `GIT_WORK_TREE` environment
592 variable and the `--work-tree` command-line option.
593 The value can be an absolute path or relative to the path to
594 the .git directory, which is either specified by --git-dir
595 or GIT_DIR, or automatically discovered.
596 If --git-dir or GIT_DIR is specified but none of
597 --work-tree, GIT_WORK_TREE and core.worktree is specified,
598 the current working directory is regarded as the top level
599 of your working tree.
601 Note that this variable is honored even when set in a configuration
602 file in a ".git" subdirectory of a directory and its value differs
603 from the latter directory (e.g. "/path/to/.git/config" has
604 core.worktree set to "/different/path"), which is most likely a
605 misconfiguration. Running Git commands in the "/path/to" directory will
606 still use "/different/path" as the root of the work tree and can cause
607 confusion unless you know what you are doing (e.g. you are creating a
608 read-only snapshot of the same index to a location different from the
609 repository's usual working tree).
611 core.logAllRefUpdates::
612 Enable the reflog. Updates to a ref <ref> is logged to the file
613 "`$GIT_DIR/logs/<ref>`", by appending the new and old
614 SHA-1, the date/time and the reason of the update, but
615 only when the file exists. If this configuration
616 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
617 file is automatically created for branch heads (i.e. under
618 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
619 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
620 If it is set to `always`, then a missing reflog is automatically
621 created for any ref under `refs/`.
623 This information can be used to determine what commit
624 was the tip of a branch "2 days ago".
626 This value is true by default in a repository that has
627 a working directory associated with it, and false by
628 default in a bare repository.
630 core.repositoryFormatVersion::
631 Internal variable identifying the repository format and layout
634 core.sharedRepository::
635 When 'group' (or 'true'), the repository is made shareable between
636 several users in a group (making sure all the files and objects are
637 group-writable). When 'all' (or 'world' or 'everybody'), the
638 repository will be readable by all users, additionally to being
639 group-shareable. When 'umask' (or 'false'), Git will use permissions
640 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
641 files in the repository will have this mode value. '0xxx' will override
642 user's umask value (whereas the other options will only override
643 requested parts of the user's umask value). Examples: '0660' will make
644 the repo read/write-able for the owner and group, but inaccessible to
645 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
646 repository that is group-readable but not group-writable.
647 See linkgit:git-init[1]. False by default.
649 core.warnAmbiguousRefs::
650 If true, Git will warn you if the ref name you passed it is ambiguous
651 and might match multiple refs in the repository. True by default.
654 An integer -1..9, indicating a default compression level.
655 -1 is the zlib default. 0 means no compression,
656 and 1..9 are various speed/size tradeoffs, 9 being slowest.
657 If set, this provides a default to other compression variables,
658 such as `core.looseCompression` and `pack.compression`.
660 core.looseCompression::
661 An integer -1..9, indicating the compression level for objects that
662 are not in a pack file. -1 is the zlib default. 0 means no
663 compression, and 1..9 are various speed/size tradeoffs, 9 being
664 slowest. If not set, defaults to core.compression. If that is
665 not set, defaults to 1 (best speed).
667 core.packedGitWindowSize::
668 Number of bytes of a pack file to map into memory in a
669 single mapping operation. Larger window sizes may allow
670 your system to process a smaller number of large pack files
671 more quickly. Smaller window sizes will negatively affect
672 performance due to increased calls to the operating system's
673 memory manager, but may improve performance when accessing
674 a large number of large pack files.
676 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
677 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
678 be reasonable for all users/operating systems. You probably do
679 not need to adjust this value.
681 Common unit suffixes of 'k', 'm', or 'g' are supported.
683 core.packedGitLimit::
684 Maximum number of bytes to map simultaneously into memory
685 from pack files. If Git needs to access more than this many
686 bytes at once to complete an operation it will unmap existing
687 regions to reclaim virtual address space within the process.
689 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
690 This should be reasonable for all users/operating systems, except on
691 the largest projects. You probably do not need to adjust this value.
693 Common unit suffixes of 'k', 'm', or 'g' are supported.
695 core.deltaBaseCacheLimit::
696 Maximum number of bytes to reserve for caching base objects
697 that may be referenced by multiple deltified objects. By storing the
698 entire decompressed base objects in a cache Git is able
699 to avoid unpacking and decompressing frequently used base
700 objects multiple times.
702 Default is 96 MiB on all platforms. This should be reasonable
703 for all users/operating systems, except on the largest projects.
704 You probably do not need to adjust this value.
706 Common unit suffixes of 'k', 'm', or 'g' are supported.
708 core.bigFileThreshold::
709 Files larger than this size are stored deflated, without
710 attempting delta compression. Storing large files without
711 delta compression avoids excessive memory usage, at the
712 slight expense of increased disk usage. Additionally files
713 larger than this size are always treated as binary.
715 Default is 512 MiB on all platforms. This should be reasonable
716 for most projects as source code and other text files can still
717 be delta compressed, but larger binary media files won't be.
719 Common unit suffixes of 'k', 'm', or 'g' are supported.
722 Specifies the pathname to the file that contains patterns to
723 describe paths that are not meant to be tracked, in addition
724 to '.gitignore' (per-directory) and '.git/info/exclude'.
725 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
726 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
727 is used instead. See linkgit:gitignore[5].
730 Some commands (e.g. svn and http interfaces) that interactively
731 ask for a password can be told to use an external program given
732 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
733 environment variable. If not set, fall back to the value of the
734 `SSH_ASKPASS` environment variable or, failing that, a simple password
735 prompt. The external program shall be given a suitable prompt as
736 command-line argument and write the password on its STDOUT.
738 core.attributesFile::
739 In addition to '.gitattributes' (per-directory) and
740 '.git/info/attributes', Git looks into this file for attributes
741 (see linkgit:gitattributes[5]). Path expansions are made the same
742 way as for `core.excludesFile`. Its default value is
743 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
744 set or empty, `$HOME/.config/git/attributes` is used instead.
747 By default Git will look for your hooks in the
748 '$GIT_DIR/hooks' directory. Set this to different path,
749 e.g. '/etc/git/hooks', and Git will try to find your hooks in
750 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
751 in '$GIT_DIR/hooks/pre-receive'.
753 The path can be either absolute or relative. A relative path is
754 taken as relative to the directory where the hooks are run (see
755 the "DESCRIPTION" section of linkgit:githooks[5]).
757 This configuration variable is useful in cases where you'd like to
758 centrally configure your Git hooks instead of configuring them on a
759 per-repository basis, or as a more flexible and centralized
760 alternative to having an `init.templateDir` where you've changed
764 Commands such as `commit` and `tag` that let you edit
765 messages by launching an editor use the value of this
766 variable when it is set, and the environment variable
767 `GIT_EDITOR` is not set. See linkgit:git-var[1].
770 Commands such as `commit` and `tag` that let you edit
771 messages consider a line that begins with this character
772 commented, and removes them after the editor returns
775 If set to "auto", `git-commit` would select a character that is not
776 the beginning character of any line in existing commit messages.
778 core.packedRefsTimeout::
779 The length of time, in milliseconds, to retry when trying to
780 lock the `packed-refs` file. Value 0 means not to retry at
781 all; -1 means to try indefinitely. Default is 1000 (i.e.,
785 Text editor used by `git rebase -i` for editing the rebase instruction file.
786 The value is meant to be interpreted by the shell when it is used.
787 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
788 When not configured the default commit message editor is used instead.
791 Text viewer for use by Git commands (e.g., 'less'). The value
792 is meant to be interpreted by the shell. The order of preference
793 is the `$GIT_PAGER` environment variable, then `core.pager`
794 configuration, then `$PAGER`, and then the default chosen at
795 compile time (usually 'less').
797 When the `LESS` environment variable is unset, Git sets it to `FRX`
798 (if `LESS` environment variable is set, Git does not change it at
799 all). If you want to selectively override Git's default setting
800 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
801 be passed to the shell by Git, which will translate the final
802 command to `LESS=FRX less -S`. The environment does not set the
803 `S` option but the command line does, instructing less to truncate
804 long lines. Similarly, setting `core.pager` to `less -+F` will
805 deactivate the `F` option specified by the environment from the
806 command-line, deactivating the "quit if one screen" behavior of
807 `less`. One can specifically activate some flags for particular
808 commands: for example, setting `pager.blame` to `less -S` enables
809 line truncation only for `git blame`.
811 Likewise, when the `LV` environment variable is unset, Git sets it
812 to `-c`. You can override this setting by exporting `LV` with
813 another value or setting `core.pager` to `lv +c`.
816 A comma separated list of common whitespace problems to
817 notice. 'git diff' will use `color.diff.whitespace` to
818 highlight them, and 'git apply --whitespace=error' will
819 consider them as errors. You can prefix `-` to disable
820 any of them (e.g. `-trailing-space`):
822 * `blank-at-eol` treats trailing whitespaces at the end of the line
823 as an error (enabled by default).
824 * `space-before-tab` treats a space character that appears immediately
825 before a tab character in the initial indent part of the line as an
826 error (enabled by default).
827 * `indent-with-non-tab` treats a line that is indented with space
828 characters instead of the equivalent tabs as an error (not enabled by
830 * `tab-in-indent` treats a tab character in the initial indent part of
831 the line as an error (not enabled by default).
832 * `blank-at-eof` treats blank lines added at the end of file as an error
833 (enabled by default).
834 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
836 * `cr-at-eol` treats a carriage-return at the end of line as
837 part of the line terminator, i.e. with it, `trailing-space`
838 does not trigger if the character before such a carriage-return
839 is not a whitespace (not enabled by default).
840 * `tabwidth=<n>` tells how many character positions a tab occupies; this
841 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
842 errors. The default tab width is 8. Allowed values are 1 to 63.
844 core.fsyncObjectFiles::
845 This boolean will enable 'fsync()' when writing object files.
847 This is a total waste of time and effort on a filesystem that orders
848 data writes properly, but can be useful for filesystems that do not use
849 journalling (traditional UNIX filesystems) or that only journal metadata
850 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
853 Enable parallel index preload for operations like 'git diff'
855 This can speed up operations like 'git diff' and 'git status' especially
856 on filesystems like NFS that have weak caching semantics and thus
857 relatively high IO latencies. When enabled, Git will do the
858 index comparison to the filesystem data in parallel, allowing
859 overlapping IO's. Defaults to true.
862 You can set this to 'link', in which case a hardlink followed by
863 a delete of the source are used to make sure that object creation
864 will not overwrite existing objects.
866 On some file system/operating system combinations, this is unreliable.
867 Set this config setting to 'rename' there; However, This will remove the
868 check that makes sure that existing object files will not get overwritten.
871 When showing commit messages, also show notes which are stored in
872 the given ref. The ref must be fully qualified. If the given
873 ref does not exist, it is not an error but means that no
874 notes should be printed.
876 This setting defaults to "refs/notes/commits", and it can be overridden by
877 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
879 core.sparseCheckout::
880 Enable "sparse checkout" feature. See section "Sparse checkout" in
881 linkgit:git-read-tree[1] for more information.
884 Set the length object names are abbreviated to. If
885 unspecified or set to "auto", an appropriate value is
886 computed based on the approximate number of packed objects
887 in your repository, which hopefully is enough for
888 abbreviated object names to stay unique for some time.
889 The minimum length is 4.
892 add.ignore-errors (deprecated)::
893 Tells 'git add' to continue adding files when some files cannot be
894 added due to indexing errors. Equivalent to the `--ignore-errors`
895 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
896 as it does not follow the usual naming convention for configuration
900 Command aliases for the linkgit:git[1] command wrapper - e.g.
901 after defining "alias.last = cat-file commit HEAD", the invocation
902 "git last" is equivalent to "git cat-file commit HEAD". To avoid
903 confusion and troubles with script usage, aliases that
904 hide existing Git commands are ignored. Arguments are split by
905 spaces, the usual shell quoting and escaping is supported.
906 A quote pair or a backslash can be used to quote them.
908 If the alias expansion is prefixed with an exclamation point,
909 it will be treated as a shell command. For example, defining
910 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
911 "git new" is equivalent to running the shell command
912 "gitk --all --not ORIG_HEAD". Note that shell commands will be
913 executed from the top-level directory of a repository, which may
914 not necessarily be the current directory.
915 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
916 from the original current directory. See linkgit:git-rev-parse[1].
919 If true, git-am will call git-mailsplit for patches in mbox format
920 with parameter `--keep-cr`. In this case git-mailsplit will
921 not remove `\r` from lines ending with `\r\n`. Can be overridden
922 by giving `--no-keep-cr` from the command line.
923 See linkgit:git-am[1], linkgit:git-mailsplit[1].
926 By default, `git am` will fail if the patch does not apply cleanly. When
927 set to true, this setting tells `git am` to fall back on 3-way merge if
928 the patch records the identity of blobs it is supposed to apply to and
929 we have those blobs available locally (equivalent to giving the `--3way`
930 option from the command line). Defaults to `false`.
931 See linkgit:git-am[1].
933 apply.ignoreWhitespace::
934 When set to 'change', tells 'git apply' to ignore changes in
935 whitespace, in the same way as the `--ignore-space-change`
937 When set to one of: no, none, never, false tells 'git apply' to
938 respect all whitespace differences.
939 See linkgit:git-apply[1].
942 Tells 'git apply' how to handle whitespaces, in the same way
943 as the `--whitespace` option. See linkgit:git-apply[1].
945 branch.autoSetupMerge::
946 Tells 'git branch' and 'git checkout' to set up new branches
947 so that linkgit:git-pull[1] will appropriately merge from the
948 starting point branch. Note that even if this option is not set,
949 this behavior can be chosen per-branch using the `--track`
950 and `--no-track` options. The valid settings are: `false` -- no
951 automatic setup is done; `true` -- automatic setup is done when the
952 starting point is a remote-tracking branch; `always` --
953 automatic setup is done when the starting point is either a
954 local branch or remote-tracking
955 branch. This option defaults to true.
957 branch.autoSetupRebase::
958 When a new branch is created with 'git branch' or 'git checkout'
959 that tracks another branch, this variable tells Git to set
960 up pull to rebase instead of merge (see "branch.<name>.rebase").
961 When `never`, rebase is never automatically set to true.
962 When `local`, rebase is set to true for tracked branches of
963 other local branches.
964 When `remote`, rebase is set to true for tracked branches of
965 remote-tracking branches.
966 When `always`, rebase will be set to true for all tracking
968 See "branch.autoSetupMerge" for details on how to set up a
969 branch to track another branch.
970 This option defaults to never.
972 branch.<name>.remote::
973 When on branch <name>, it tells 'git fetch' and 'git push'
974 which remote to fetch from/push to. The remote to push to
975 may be overridden with `remote.pushDefault` (for all branches).
976 The remote to push to, for the current branch, may be further
977 overridden by `branch.<name>.pushRemote`. If no remote is
978 configured, or if you are not on any branch, it defaults to
979 `origin` for fetching and `remote.pushDefault` for pushing.
980 Additionally, `.` (a period) is the current local repository
981 (a dot-repository), see `branch.<name>.merge`'s final note below.
983 branch.<name>.pushRemote::
984 When on branch <name>, it overrides `branch.<name>.remote` for
985 pushing. It also overrides `remote.pushDefault` for pushing
986 from branch <name>. When you pull from one place (e.g. your
987 upstream) and push to another place (e.g. your own publishing
988 repository), you would want to set `remote.pushDefault` to
989 specify the remote to push to for all branches, and use this
990 option to override it for a specific branch.
992 branch.<name>.merge::
993 Defines, together with branch.<name>.remote, the upstream branch
994 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
995 branch to merge and can also affect 'git push' (see push.default).
996 When in branch <name>, it tells 'git fetch' the default
997 refspec to be marked for merging in FETCH_HEAD. The value is
998 handled like the remote part of a refspec, and must match a
999 ref which is fetched from the remote given by
1000 "branch.<name>.remote".
1001 The merge information is used by 'git pull' (which at first calls
1002 'git fetch') to lookup the default branch for merging. Without
1003 this option, 'git pull' defaults to merge the first refspec fetched.
1004 Specify multiple values to get an octopus merge.
1005 If you wish to setup 'git pull' so that it merges into <name> from
1006 another branch in the local repository, you can point
1007 branch.<name>.merge to the desired branch, and use the relative path
1008 setting `.` (a period) for branch.<name>.remote.
1010 branch.<name>.mergeOptions::
1011 Sets default options for merging into branch <name>. The syntax and
1012 supported options are the same as those of linkgit:git-merge[1], but
1013 option values containing whitespace characters are currently not
1016 branch.<name>.rebase::
1017 When true, rebase the branch <name> on top of the fetched branch,
1018 instead of merging the default branch from the default remote when
1019 "git pull" is run. See "pull.rebase" for doing this in a non
1020 branch-specific manner.
1022 When preserve, also pass `--preserve-merges` along to 'git rebase'
1023 so that locally committed merge commits will not be flattened
1024 by running 'git pull'.
1026 When the value is `interactive`, the rebase is run in interactive mode.
1028 *NOTE*: this is a possibly dangerous operation; do *not* use
1029 it unless you understand the implications (see linkgit:git-rebase[1]
1032 branch.<name>.description::
1033 Branch description, can be edited with
1034 `git branch --edit-description`. Branch description is
1035 automatically added in the format-patch cover letter or
1036 request-pull summary.
1038 browser.<tool>.cmd::
1039 Specify the command to invoke the specified browser. The
1040 specified command is evaluated in shell with the URLs passed
1041 as arguments. (See linkgit:git-web{litdd}browse[1].)
1043 browser.<tool>.path::
1044 Override the path for the given tool that may be used to
1045 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1046 working repository in gitweb (see linkgit:git-instaweb[1]).
1048 clean.requireForce::
1049 A boolean to make git-clean do nothing unless given -f,
1050 -i or -n. Defaults to true.
1053 A boolean to enable/disable color in the output of
1054 linkgit:git-branch[1]. May be set to `always`,
1055 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1056 only when the output is to a terminal. If unset, then the
1057 value of `color.ui` is used (`auto` by default).
1059 color.branch.<slot>::
1060 Use customized color for branch coloration. `<slot>` is one of
1061 `current` (the current branch), `local` (a local branch),
1062 `remote` (a remote-tracking branch in refs/remotes/),
1063 `upstream` (upstream tracking branch), `plain` (other
1067 Whether to use ANSI escape sequences to add color to patches.
1068 If this is set to `always`, linkgit:git-diff[1],
1069 linkgit:git-log[1], and linkgit:git-show[1] will use color
1070 for all patches. If it is set to `true` or `auto`, those
1071 commands will only use color when output is to the terminal.
1072 If unset, then the value of `color.ui` is used (`auto` by
1075 This does not affect linkgit:git-format-patch[1] or the
1076 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1077 command line with the `--color[=<when>]` option.
1080 Use customized color for diff colorization. `<slot>` specifies
1081 which part of the patch to use the specified color, and is one
1082 of `context` (context text - `plain` is a historical synonym),
1083 `meta` (metainformation), `frag`
1084 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1085 `new` (added lines), `commit` (commit headers), or `whitespace`
1086 (highlighting whitespace errors).
1088 color.decorate.<slot>::
1089 Use customized color for 'git log --decorate' output. `<slot>` is one
1090 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1091 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1094 When set to `always`, always highlight matches. When `false` (or
1095 `never`), never. When set to `true` or `auto`, use color only
1096 when the output is written to the terminal. If unset, then the
1097 value of `color.ui` is used (`auto` by default).
1100 Use customized color for grep colorization. `<slot>` specifies which
1101 part of the line to use the specified color, and is one of
1105 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1107 filename prefix (when not using `-h`)
1109 function name lines (when using `-p`)
1111 line number prefix (when using `-n`)
1113 matching text (same as setting `matchContext` and `matchSelected`)
1115 matching text in context lines
1117 matching text in selected lines
1119 non-matching text in selected lines
1121 separators between fields on a line (`:`, `-`, and `=`)
1122 and between hunks (`--`)
1126 When set to `always`, always use colors for interactive prompts
1127 and displays (such as those used by "git-add --interactive" and
1128 "git-clean --interactive"). When false (or `never`), never.
1129 When set to `true` or `auto`, use colors only when the output is
1130 to the terminal. If unset, then the value of `color.ui` is
1131 used (`auto` by default).
1133 color.interactive.<slot>::
1134 Use customized color for 'git add --interactive' and 'git clean
1135 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1136 or `error`, for four distinct types of normal output from
1137 interactive commands.
1140 A boolean to enable/disable colored output when the pager is in
1141 use (default is true).
1144 A boolean to enable/disable color in the output of
1145 linkgit:git-show-branch[1]. May be set to `always`,
1146 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1147 only when the output is to a terminal. If unset, then the
1148 value of `color.ui` is used (`auto` by default).
1151 A boolean to enable/disable color in the output of
1152 linkgit:git-status[1]. May be set to `always`,
1153 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1154 only when the output is to a terminal. If unset, then the
1155 value of `color.ui` is used (`auto` by default).
1157 color.status.<slot>::
1158 Use customized color for status colorization. `<slot>` is
1159 one of `header` (the header text of the status message),
1160 `added` or `updated` (files which are added but not committed),
1161 `changed` (files which are changed but not added in the index),
1162 `untracked` (files which are not tracked by Git),
1163 `branch` (the current branch),
1164 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1166 `localBranch` or `remoteBranch` (the local and remote branch names,
1167 respectively, when branch and tracking information is displayed in the
1168 status short-format), or
1169 `unmerged` (files which have unmerged changes).
1172 This variable determines the default value for variables such
1173 as `color.diff` and `color.grep` that control the use of color
1174 per command family. Its scope will expand as more commands learn
1175 configuration to set a default for the `--color` option. Set it
1176 to `false` or `never` if you prefer Git commands not to use
1177 color unless enabled explicitly with some other configuration
1178 or the `--color` option. Set it to `always` if you want all
1179 output not intended for machine consumption to use color, to
1180 `true` or `auto` (this is the default since Git 1.8.4) if you
1181 want such output to use color when written to the terminal.
1184 Specify whether supported commands should output in columns.
1185 This variable consists of a list of tokens separated by spaces
1188 These options control when the feature should be enabled
1189 (defaults to 'never'):
1193 always show in columns
1195 never show in columns
1197 show in columns if the output is to the terminal
1200 These options control layout (defaults to 'column'). Setting any
1201 of these implies 'always' if none of 'always', 'never', or 'auto' are
1206 fill columns before rows
1208 fill rows before columns
1213 Finally, these options can be combined with a layout option (defaults
1218 make unequal size columns to utilize more space
1220 make equal size columns
1224 Specify whether to output branch listing in `git branch` in columns.
1225 See `column.ui` for details.
1228 Specify the layout when list items in `git clean -i`, which always
1229 shows files and directories in columns. See `column.ui` for details.
1232 Specify whether to output untracked files in `git status` in columns.
1233 See `column.ui` for details.
1236 Specify whether to output tag listing in `git tag` in columns.
1237 See `column.ui` for details.
1240 This setting overrides the default of the `--cleanup` option in
1241 `git commit`. See linkgit:git-commit[1] for details. Changing the
1242 default can be useful when you always want to keep lines that begin
1243 with comment character `#` in your log message, in which case you
1244 would do `git config commit.cleanup whitespace` (note that you will
1245 have to remove the help lines that begin with `#` in the commit log
1246 template yourself, if you do this).
1250 A boolean to specify whether all commits should be GPG signed.
1251 Use of this option when doing operations such as rebase can
1252 result in a large number of commits being signed. It may be
1253 convenient to use an agent to avoid typing your GPG passphrase
1257 A boolean to enable/disable inclusion of status information in the
1258 commit message template when using an editor to prepare the commit
1259 message. Defaults to true.
1262 Specify the pathname of a file to use as the template for
1263 new commit messages.
1266 A boolean or int to specify the level of verbose with `git commit`.
1267 See linkgit:git-commit[1].
1270 Specify an external helper to be called when a username or
1271 password credential is needed; the helper may consult external
1272 storage to avoid prompting the user for the credentials. Note
1273 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1276 credential.useHttpPath::
1277 When acquiring credentials, consider the "path" component of an http
1278 or https URL to be important. Defaults to false. See
1279 linkgit:gitcredentials[7] for more information.
1281 credential.username::
1282 If no username is set for a network authentication, use this username
1283 by default. See credential.<context>.* below, and
1284 linkgit:gitcredentials[7].
1286 credential.<url>.*::
1287 Any of the credential.* options above can be applied selectively to
1288 some credentials. For example "credential.https://example.com.username"
1289 would set the default username only for https connections to
1290 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1293 credentialCache.ignoreSIGHUP::
1294 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1296 include::diff-config.txt[]
1298 difftool.<tool>.path::
1299 Override the path for the given tool. This is useful in case
1300 your tool is not in the PATH.
1302 difftool.<tool>.cmd::
1303 Specify the command to invoke the specified diff tool.
1304 The specified command is evaluated in shell with the following
1305 variables available: 'LOCAL' is set to the name of the temporary
1306 file containing the contents of the diff pre-image and 'REMOTE'
1307 is set to the name of the temporary file containing the contents
1308 of the diff post-image.
1311 Prompt before each invocation of the diff tool.
1313 fastimport.unpackLimit::
1314 If the number of objects imported by linkgit:git-fast-import[1]
1315 is below this limit, then the objects will be unpacked into
1316 loose object files. However if the number of imported objects
1317 equals or exceeds this limit then the pack will be stored as a
1318 pack. Storing the pack from a fast-import can make the import
1319 operation complete faster, especially on slow filesystems. If
1320 not set, the value of `transfer.unpackLimit` is used instead.
1322 fetch.recurseSubmodules::
1323 This option can be either set to a boolean value or to 'on-demand'.
1324 Setting it to a boolean changes the behavior of fetch and pull to
1325 unconditionally recurse into submodules when set to true or to not
1326 recurse at all when set to false. When set to 'on-demand' (the default
1327 value), fetch and pull will only recurse into a populated submodule
1328 when its superproject retrieves a commit that updates the submodule's
1332 If it is set to true, git-fetch-pack will check all fetched
1333 objects. It will abort in the case of a malformed object or a
1334 broken link. The result of an abort are only dangling objects.
1335 Defaults to false. If not set, the value of `transfer.fsckObjects`
1339 If the number of objects fetched over the Git native
1340 transfer is below this
1341 limit, then the objects will be unpacked into loose object
1342 files. However if the number of received objects equals or
1343 exceeds this limit then the received pack will be stored as
1344 a pack, after adding any missing delta bases. Storing the
1345 pack from a push can make the push operation complete faster,
1346 especially on slow filesystems. If not set, the value of
1347 `transfer.unpackLimit` is used instead.
1350 If true, fetch will automatically behave as if the `--prune`
1351 option was given on the command line. See also `remote.<name>.prune`.
1354 Control how ref update status is printed. Valid values are
1355 `full` and `compact`. Default value is `full`. See section
1356 OUTPUT in linkgit:git-fetch[1] for detail.
1359 Enable multipart/mixed attachments as the default for
1360 'format-patch'. The value can also be a double quoted string
1361 which will enable attachments as the default and set the
1362 value as the boundary. See the --attach option in
1363 linkgit:git-format-patch[1].
1366 Provides the default value for the `--from` option to format-patch.
1367 Accepts a boolean value, or a name and email address. If false,
1368 format-patch defaults to `--no-from`, using commit authors directly in
1369 the "From:" field of patch mails. If true, format-patch defaults to
1370 `--from`, using your committer identity in the "From:" field of patch
1371 mails and including a "From:" field in the body of the patch mail if
1372 different. If set to a non-boolean value, format-patch uses that
1373 value instead of your committer identity. Defaults to false.
1376 A boolean which can enable or disable sequence numbers in patch
1377 subjects. It defaults to "auto" which enables it only if there
1378 is more than one patch. It can be enabled or disabled for all
1379 messages by setting it to "true" or "false". See --numbered
1380 option in linkgit:git-format-patch[1].
1383 Additional email headers to include in a patch to be submitted
1384 by mail. See linkgit:git-format-patch[1].
1388 Additional recipients to include in a patch to be submitted
1389 by mail. See the --to and --cc options in
1390 linkgit:git-format-patch[1].
1392 format.subjectPrefix::
1393 The default for format-patch is to output files with the '[PATCH]'
1394 subject prefix. Use this variable to change that prefix.
1397 The default for format-patch is to output a signature containing
1398 the Git version number. Use this variable to change that default.
1399 Set this variable to the empty string ("") to suppress
1400 signature generation.
1402 format.signatureFile::
1403 Works just like format.signature except the contents of the
1404 file specified by this variable will be used as the signature.
1407 The default for format-patch is to output files with the suffix
1408 `.patch`. Use this variable to change that suffix (make sure to
1409 include the dot if you want it).
1412 The default pretty format for log/show/whatchanged command,
1413 See linkgit:git-log[1], linkgit:git-show[1],
1414 linkgit:git-whatchanged[1].
1417 The default threading style for 'git format-patch'. Can be
1418 a boolean value, or `shallow` or `deep`. `shallow` threading
1419 makes every mail a reply to the head of the series,
1420 where the head is chosen from the cover letter, the
1421 `--in-reply-to`, and the first patch mail, in this order.
1422 `deep` threading makes every mail a reply to the previous one.
1423 A true boolean value is the same as `shallow`, and a false
1424 value disables threading.
1427 A boolean value which lets you enable the `-s/--signoff` option of
1428 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1429 patch should be a conscious act and means that you certify you have
1430 the rights to submit this work under the same open source license.
1431 Please see the 'SubmittingPatches' document for further discussion.
1433 format.coverLetter::
1434 A boolean that controls whether to generate a cover-letter when
1435 format-patch is invoked, but in addition can be set to "auto", to
1436 generate a cover-letter only when there's more than one patch.
1438 format.outputDirectory::
1439 Set a custom directory to store the resulting files instead of the
1440 current working directory.
1442 format.useAutoBase::
1443 A boolean value which lets you enable the `--base=auto` option of
1444 format-patch by default.
1446 filter.<driver>.clean::
1447 The command which is used to convert the content of a worktree
1448 file to a blob upon checkin. See linkgit:gitattributes[5] for
1451 filter.<driver>.smudge::
1452 The command which is used to convert the content of a blob
1453 object to a worktree file upon checkout. See
1454 linkgit:gitattributes[5] for details.
1457 Allows overriding the message type (error, warn or ignore) of a
1458 specific message ID such as `missingEmail`.
1460 For convenience, fsck prefixes the error/warning with the message ID,
1461 e.g. "missingEmail: invalid author/committer line - missing email" means
1462 that setting `fsck.missingEmail = ignore` will hide that issue.
1464 This feature is intended to support working with legacy repositories
1465 which cannot be repaired without disruptive changes.
1468 The path to a sorted list of object names (i.e. one SHA-1 per
1469 line) that are known to be broken in a non-fatal way and should
1470 be ignored. This feature is useful when an established project
1471 should be accepted despite early commits containing errors that
1472 can be safely ignored such as invalid committer email addresses.
1473 Note: corrupt objects cannot be skipped with this setting.
1475 gc.aggressiveDepth::
1476 The depth parameter used in the delta compression
1477 algorithm used by 'git gc --aggressive'. This defaults
1480 gc.aggressiveWindow::
1481 The window size parameter used in the delta compression
1482 algorithm used by 'git gc --aggressive'. This defaults
1486 When there are approximately more than this many loose
1487 objects in the repository, `git gc --auto` will pack them.
1488 Some Porcelain commands use this command to perform a
1489 light-weight garbage collection from time to time. The
1490 default value is 6700. Setting this to 0 disables it.
1493 When there are more than this many packs that are not
1494 marked with `*.keep` file in the repository, `git gc
1495 --auto` consolidates them into one larger pack. The
1496 default value is 50. Setting this to 0 disables it.
1499 Make `git gc --auto` return immediately and run in background
1500 if the system supports it. Default is true.
1503 If the file gc.log exists, then `git gc --auto` won't run
1504 unless that file is more than 'gc.logExpiry' old. Default is
1505 "1.day". See `gc.pruneExpire` for more ways to specify its
1509 Running `git pack-refs` in a repository renders it
1510 unclonable by Git versions prior to 1.5.1.2 over dumb
1511 transports such as HTTP. This variable determines whether
1512 'git gc' runs `git pack-refs`. This can be set to `notbare`
1513 to enable it within all non-bare repos or it can be set to a
1514 boolean value. The default is `true`.
1517 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1518 Override the grace period with this config variable. The value
1519 "now" may be used to disable this grace period and always prune
1520 unreachable objects immediately, or "never" may be used to
1521 suppress pruning. This feature helps prevent corruption when
1522 'git gc' runs concurrently with another process writing to the
1523 repository; see the "NOTES" section of linkgit:git-gc[1].
1525 gc.worktreePruneExpire::
1526 When 'git gc' is run, it calls
1527 'git worktree prune --expire 3.months.ago'.
1528 This config variable can be used to set a different grace
1529 period. The value "now" may be used to disable the grace
1530 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1531 may be used to suppress pruning.
1534 gc.<pattern>.reflogExpire::
1535 'git reflog expire' removes reflog entries older than
1536 this time; defaults to 90 days. The value "now" expires all
1537 entries immediately, and "never" suppresses expiration
1538 altogether. With "<pattern>" (e.g.
1539 "refs/stash") in the middle the setting applies only to
1540 the refs that match the <pattern>.
1542 gc.reflogExpireUnreachable::
1543 gc.<pattern>.reflogExpireUnreachable::
1544 'git reflog expire' removes reflog entries older than
1545 this time and are not reachable from the current tip;
1546 defaults to 30 days. The value "now" expires all entries
1547 immediately, and "never" suppresses expiration altogether.
1548 With "<pattern>" (e.g. "refs/stash")
1549 in the middle, the setting applies only to the refs that
1550 match the <pattern>.
1553 Records of conflicted merge you resolved earlier are
1554 kept for this many days when 'git rerere gc' is run.
1555 The default is 60 days. See linkgit:git-rerere[1].
1557 gc.rerereUnresolved::
1558 Records of conflicted merge you have not resolved are
1559 kept for this many days when 'git rerere gc' is run.
1560 The default is 15 days. See linkgit:git-rerere[1].
1562 gitcvs.commitMsgAnnotation::
1563 Append this string to each commit message. Set to empty string
1564 to disable this feature. Defaults to "via git-CVS emulator".
1567 Whether the CVS server interface is enabled for this repository.
1568 See linkgit:git-cvsserver[1].
1571 Path to a log file where the CVS server interface well... logs
1572 various stuff. See linkgit:git-cvsserver[1].
1574 gitcvs.usecrlfattr::
1575 If true, the server will look up the end-of-line conversion
1576 attributes for files to determine the `-k` modes to use. If
1577 the attributes force Git to treat a file as text,
1578 the `-k` mode will be left blank so CVS clients will
1579 treat it as text. If they suppress text conversion, the file
1580 will be set with '-kb' mode, which suppresses any newline munging
1581 the client might otherwise do. If the attributes do not allow
1582 the file type to be determined, then `gitcvs.allBinary` is
1583 used. See linkgit:gitattributes[5].
1586 This is used if `gitcvs.usecrlfattr` does not resolve
1587 the correct '-kb' mode to use. If true, all
1588 unresolved files are sent to the client in
1589 mode '-kb'. This causes the client to treat them
1590 as binary files, which suppresses any newline munging it
1591 otherwise might do. Alternatively, if it is set to "guess",
1592 then the contents of the file are examined to decide if
1593 it is binary, similar to `core.autocrlf`.
1596 Database used by git-cvsserver to cache revision information
1597 derived from the Git repository. The exact meaning depends on the
1598 used database driver, for SQLite (which is the default driver) this
1599 is a filename. Supports variable substitution (see
1600 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1601 Default: '%Ggitcvs.%m.sqlite'
1604 Used Perl DBI driver. You can specify any available driver
1605 for this here, but it might not work. git-cvsserver is tested
1606 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1607 reported *not* to work with 'DBD::mysql'. Experimental feature.
1608 May not contain double colons (`:`). Default: 'SQLite'.
1609 See linkgit:git-cvsserver[1].
1611 gitcvs.dbUser, gitcvs.dbPass::
1612 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1613 since SQLite has no concept of database users and/or passwords.
1614 'gitcvs.dbUser' supports variable substitution (see
1615 linkgit:git-cvsserver[1] for details).
1617 gitcvs.dbTableNamePrefix::
1618 Database table name prefix. Prepended to the names of any
1619 database tables used, allowing a single database to be used
1620 for several repositories. Supports variable substitution (see
1621 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1622 characters will be replaced with underscores.
1624 All gitcvs variables except for `gitcvs.usecrlfattr` and
1625 `gitcvs.allBinary` can also be specified as
1626 'gitcvs.<access_method>.<varname>' (where 'access_method'
1627 is one of "ext" and "pserver") to make them apply only for the given
1631 gitweb.description::
1634 See linkgit:gitweb[1] for description.
1642 gitweb.remote_heads::
1645 See linkgit:gitweb.conf[5] for description.
1648 If set to true, enable `-n` option by default.
1651 Set the default matching behavior. Using a value of 'basic', 'extended',
1652 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1653 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1654 value 'default' will return to the default matching behavior.
1656 grep.extendedRegexp::
1657 If set to true, enable `--extended-regexp` option by default. This
1658 option is ignored when the `grep.patternType` option is set to a value
1659 other than 'default'.
1662 Number of grep worker threads to use.
1663 See `grep.threads` in linkgit:git-grep[1] for more information.
1665 grep.fallbackToNoIndex::
1666 If set to true, fall back to git grep --no-index if git grep
1667 is executed outside of a git repository. Defaults to false.
1670 Use this custom program instead of "`gpg`" found on `$PATH` when
1671 making or verifying a PGP signature. The program must support the
1672 same command-line interface as GPG, namely, to verify a detached
1673 signature, "`gpg --verify $file - <$signature`" is run, and the
1674 program is expected to signal a good signature by exiting with
1675 code 0, and to generate an ASCII-armored detached signature, the
1676 standard input of "`gpg -bsau $key`" is fed with the contents to be
1677 signed, and the program is expected to send the result to its
1680 gui.commitMsgWidth::
1681 Defines how wide the commit message window is in the
1682 linkgit:git-gui[1]. "75" is the default.
1685 Specifies how many context lines should be used in calls to diff
1686 made by the linkgit:git-gui[1]. The default is "5".
1688 gui.displayUntracked::
1689 Determines if linkgit:git-gui[1] shows untracked files
1690 in the file list. The default is "true".
1693 Specifies the default encoding to use for displaying of
1694 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1695 It can be overridden by setting the 'encoding' attribute
1696 for relevant files (see linkgit:gitattributes[5]).
1697 If this option is not set, the tools default to the
1700 gui.matchTrackingBranch::
1701 Determines if new branches created with linkgit:git-gui[1] should
1702 default to tracking remote branches with matching names or
1703 not. Default: "false".
1705 gui.newBranchTemplate::
1706 Is used as suggested name when creating new branches using the
1709 gui.pruneDuringFetch::
1710 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1711 performing a fetch. The default value is "false".
1714 Determines if linkgit:git-gui[1] should trust the file modification
1715 timestamp or not. By default the timestamps are not trusted.
1717 gui.spellingDictionary::
1718 Specifies the dictionary used for spell checking commit messages in
1719 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1723 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1724 location detection. It makes blame significantly faster on huge
1725 repositories at the expense of less thorough copy detection.
1727 gui.copyBlameThreshold::
1728 Specifies the threshold to use in 'git gui blame' original location
1729 detection, measured in alphanumeric characters. See the
1730 linkgit:git-blame[1] manual for more information on copy detection.
1732 gui.blamehistoryctx::
1733 Specifies the radius of history context in days to show in
1734 linkgit:gitk[1] for the selected commit, when the `Show History
1735 Context` menu item is invoked from 'git gui blame'. If this
1736 variable is set to zero, the whole history is shown.
1738 guitool.<name>.cmd::
1739 Specifies the shell command line to execute when the corresponding item
1740 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1741 mandatory for every tool. The command is executed from the root of
1742 the working directory, and in the environment it receives the name of
1743 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1744 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1745 the head is detached, 'CUR_BRANCH' is empty).
1747 guitool.<name>.needsFile::
1748 Run the tool only if a diff is selected in the GUI. It guarantees
1749 that 'FILENAME' is not empty.
1751 guitool.<name>.noConsole::
1752 Run the command silently, without creating a window to display its
1755 guitool.<name>.noRescan::
1756 Don't rescan the working directory for changes after the tool
1759 guitool.<name>.confirm::
1760 Show a confirmation dialog before actually running the tool.
1762 guitool.<name>.argPrompt::
1763 Request a string argument from the user, and pass it to the tool
1764 through the `ARGS` environment variable. Since requesting an
1765 argument implies confirmation, the 'confirm' option has no effect
1766 if this is enabled. If the option is set to 'true', 'yes', or '1',
1767 the dialog uses a built-in generic prompt; otherwise the exact
1768 value of the variable is used.
1770 guitool.<name>.revPrompt::
1771 Request a single valid revision from the user, and set the
1772 `REVISION` environment variable. In other aspects this option
1773 is similar to 'argPrompt', and can be used together with it.
1775 guitool.<name>.revUnmerged::
1776 Show only unmerged branches in the 'revPrompt' subdialog.
1777 This is useful for tools similar to merge or rebase, but not
1778 for things like checkout or reset.
1780 guitool.<name>.title::
1781 Specifies the title to use for the prompt dialog. The default
1784 guitool.<name>.prompt::
1785 Specifies the general prompt string to display at the top of
1786 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1787 The default value includes the actual command.
1790 Specify the browser that will be used to display help in the
1791 'web' format. See linkgit:git-help[1].
1794 Override the default help format used by linkgit:git-help[1].
1795 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1796 the default. 'web' and 'html' are the same.
1799 Automatically correct and execute mistyped commands after
1800 waiting for the given number of deciseconds (0.1 sec). If more
1801 than one command can be deduced from the entered text, nothing
1802 will be executed. If the value of this option is negative,
1803 the corrected command will be executed immediately. If the
1804 value is 0 - the command will be just shown but not executed.
1805 This is the default.
1808 Specify the path where the HTML documentation resides. File system paths
1809 and URLs are supported. HTML pages will be prefixed with this path when
1810 help is displayed in the 'web' format. This defaults to the documentation
1811 path of your Git installation.
1814 Override the HTTP proxy, normally configured using the 'http_proxy',
1815 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1816 addition to the syntax understood by curl, it is possible to specify a
1817 proxy string with a user name but no password, in which case git will
1818 attempt to acquire one in the same way it does for other credentials. See
1819 linkgit:gitcredentials[7] for more information. The syntax thus is
1820 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1821 on a per-remote basis; see remote.<name>.proxy
1823 http.proxyAuthMethod::
1824 Set the method with which to authenticate against the HTTP proxy. This
1825 only takes effect if the configured proxy string contains a user name part
1826 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1827 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1828 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1829 variable. Possible values are:
1832 * `anyauth` - Automatically pick a suitable authentication method. It is
1833 assumed that the proxy answers an unauthenticated request with a 407
1834 status code and one or more Proxy-authenticate headers with supported
1835 authentication methods. This is the default.
1836 * `basic` - HTTP Basic authentication
1837 * `digest` - HTTP Digest authentication; this prevents the password from being
1838 transmitted to the proxy in clear text
1839 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1841 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1845 Attempt authentication without seeking a username or password. This
1846 can be used to attempt GSS-Negotiate authentication without specifying
1847 a username in the URL, as libcurl normally requires a username for
1851 Control GSSAPI credential delegation. The delegation is disabled
1852 by default in libcurl since version 7.21.7. Set parameter to tell
1853 the server what it is allowed to delegate when it comes to user
1854 credentials. Used with GSS/kerberos. Possible values are:
1857 * `none` - Don't allow any delegation.
1858 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1859 Kerberos service ticket, which is a matter of realm policy.
1860 * `always` - Unconditionally allow the server to delegate.
1865 Pass an additional HTTP header when communicating with a server. If
1866 more than one such entry exists, all of them are added as extra
1867 headers. To allow overriding the settings inherited from the system
1868 config, an empty value will reset the extra headers to the empty list.
1871 The pathname of a file containing previously stored cookie lines,
1872 which should be used
1873 in the Git http session, if they match the server. The file format
1874 of the file to read cookies from should be plain HTTP headers or
1875 the Netscape/Mozilla cookie file format (see `curl(1)`).
1876 NOTE that the file specified with http.cookieFile is used only as
1877 input unless http.saveCookies is set.
1880 If set, store cookies received during requests to the file specified by
1881 http.cookieFile. Has no effect if http.cookieFile is unset.
1884 The SSL version to use when negotiating an SSL connection, if you
1885 want to force the default. The available and default version
1886 depend on whether libcurl was built against NSS or OpenSSL and the
1887 particular configuration of the crypto library in use. Internally
1888 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1889 documentation for more details on the format of this option and
1890 for the ssl version supported. Actually the possible values of
1901 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1902 To force git to use libcurl's default ssl version and ignore any
1903 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1906 http.sslCipherList::
1907 A list of SSL ciphers to use when negotiating an SSL connection.
1908 The available ciphers depend on whether libcurl was built against
1909 NSS or OpenSSL and the particular configuration of the crypto
1910 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1911 option; see the libcurl documentation for more details on the format
1914 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1915 To force git to use libcurl's default cipher list and ignore any
1916 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1920 Whether to verify the SSL certificate when fetching or pushing
1921 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1925 File containing the SSL certificate when fetching or pushing
1926 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1930 File containing the SSL private key when fetching or pushing
1931 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1934 http.sslCertPasswordProtected::
1935 Enable Git's password prompt for the SSL certificate. Otherwise
1936 OpenSSL will prompt the user, possibly many times, if the
1937 certificate or private key is encrypted. Can be overridden by the
1938 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1941 File containing the certificates to verify the peer with when
1942 fetching or pushing over HTTPS. Can be overridden by the
1943 `GIT_SSL_CAINFO` environment variable.
1946 Path containing files with the CA certificates to verify the peer
1947 with when fetching or pushing over HTTPS. Can be overridden
1948 by the `GIT_SSL_CAPATH` environment variable.
1951 Public key of the https service. It may either be the filename of
1952 a PEM or DER encoded public key file or a string starting with
1953 'sha256//' followed by the base64 encoded sha256 hash of the
1954 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1955 exit with an error if this option is set but not supported by
1959 Attempt to use AUTH SSL/TLS and encrypted data transfers
1960 when connecting via regular FTP protocol. This might be needed
1961 if the FTP server requires it for security reasons or you wish
1962 to connect securely whenever remote FTP server supports it.
1963 Default is false since it might trigger certificate verification
1964 errors on misconfigured servers.
1967 How many HTTP requests to launch in parallel. Can be overridden
1968 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1971 The number of curl sessions (counted across slots) to be kept across
1972 requests. They will not be ended with curl_easy_cleanup() until
1973 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1974 value will be capped at 1. Defaults to 1.
1977 Maximum size in bytes of the buffer used by smart HTTP
1978 transports when POSTing data to the remote system.
1979 For requests larger than this buffer size, HTTP/1.1 and
1980 Transfer-Encoding: chunked is used to avoid creating a
1981 massive pack file locally. Default is 1 MiB, which is
1982 sufficient for most requests.
1984 http.lowSpeedLimit, http.lowSpeedTime::
1985 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1986 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1987 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1988 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1991 A boolean which disables using of EPSV ftp command by curl.
1992 This can helpful with some "poor" ftp servers which don't
1993 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1994 environment variable. Default is false (curl will use EPSV).
1997 The HTTP USER_AGENT string presented to an HTTP server. The default
1998 value represents the version of the client Git such as git/1.7.1.
1999 This option allows you to override this value to a more common value
2000 such as Mozilla/4.0. This may be necessary, for instance, if
2001 connecting through a firewall that restricts HTTP connections to a set
2002 of common USER_AGENT strings (but not including those like git/1.7.1).
2003 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2005 http.followRedirects::
2006 Whether git should follow HTTP redirects. If set to `true`, git
2007 will transparently follow any redirect issued by a server it
2008 encounters. If set to `false`, git will treat all redirects as
2009 errors. If set to `initial`, git will follow redirects only for
2010 the initial request to a remote, but not for subsequent
2011 follow-up HTTP requests. Since git uses the redirected URL as
2012 the base for the follow-up requests, this is generally
2013 sufficient. The default is `initial`.
2016 Any of the http.* options above can be applied selectively to some URLs.
2017 For a config key to match a URL, each element of the config key is
2018 compared to that of the URL, in the following order:
2021 . Scheme (e.g., `https` in `https://example.com/`). This field
2022 must match exactly between the config key and the URL.
2024 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2025 This field must match between the config key and the URL. It is
2026 possible to specify a `*` as part of the host name to match all subdomains
2027 at this level. `https://*.example.com/` for example would match
2028 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2030 . Port number (e.g., `8080` in `http://example.com:8080/`).
2031 This field must match exactly between the config key and the URL.
2032 Omitted port numbers are automatically converted to the correct
2033 default for the scheme before matching.
2035 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2036 path field of the config key must match the path field of the URL
2037 either exactly or as a prefix of slash-delimited path elements. This means
2038 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2039 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2040 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2041 key with just path `foo/`).
2043 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2044 the config key has a user name it must match the user name in the
2045 URL exactly. If the config key does not have a user name, that
2046 config key will match a URL with any user name (including none),
2047 but at a lower precedence than a config key with a user name.
2050 The list above is ordered by decreasing precedence; a URL that matches
2051 a config key's path is preferred to one that matches its user name. For example,
2052 if the URL is `https://user@example.com/foo/bar` a config key match of
2053 `https://example.com/foo` will be preferred over a config key match of
2054 `https://user@example.com`.
2056 All URLs are normalized before attempting any matching (the password part,
2057 if embedded in the URL, is always ignored for matching purposes) so that
2058 equivalent URLs that are simply spelled differently will match properly.
2059 Environment variable settings always override any matches. The URLs that are
2060 matched against are those given directly to Git commands. This means any URLs
2061 visited as a result of a redirection do not participate in matching.
2064 Depending on the value of the environment variables `GIT_SSH` or
2065 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2066 auto-detects whether to adjust its command-line parameters for use
2067 with plink or tortoiseplink, as opposed to the default (OpenSSH).
2069 The config variable `ssh.variant` can be set to override this auto-detection;
2070 valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2071 will be treated as normal ssh. This setting can be overridden via the
2072 environment variable `GIT_SSH_VARIANT`.
2074 i18n.commitEncoding::
2075 Character encoding the commit messages are stored in; Git itself
2076 does not care per se, but this information is necessary e.g. when
2077 importing commits from emails or in the gitk graphical history
2078 browser (and possibly at other places in the future or in other
2079 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2081 i18n.logOutputEncoding::
2082 Character encoding the commit messages are converted to when
2083 running 'git log' and friends.
2086 The configuration variables in the 'imap' section are described
2087 in linkgit:git-imap-send[1].
2090 Specify the version with which new index files should be
2091 initialized. This does not affect existing repositories.
2094 Specify the directory from which templates will be copied.
2095 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2098 Specify the program that will be used to browse your working
2099 repository in gitweb. See linkgit:git-instaweb[1].
2102 The HTTP daemon command-line to start gitweb on your working
2103 repository. See linkgit:git-instaweb[1].
2106 If true the web server started by linkgit:git-instaweb[1] will
2107 be bound to the local IP (127.0.0.1).
2109 instaweb.modulePath::
2110 The default module path for linkgit:git-instaweb[1] to use
2111 instead of /usr/lib/apache2/modules. Only used if httpd
2115 The port number to bind the gitweb httpd to. See
2116 linkgit:git-instaweb[1].
2118 interactive.singleKey::
2119 In interactive commands, allow the user to provide one-letter
2120 input with a single key (i.e., without hitting enter).
2121 Currently this is used by the `--patch` mode of
2122 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2123 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2124 setting is silently ignored if portable keystroke input
2125 is not available; requires the Perl module Term::ReadKey.
2127 interactive.diffFilter::
2128 When an interactive command (such as `git add --patch`) shows
2129 a colorized diff, git will pipe the diff through the shell
2130 command defined by this configuration variable. The command may
2131 mark up the diff further for human consumption, provided that it
2132 retains a one-to-one correspondence with the lines in the
2133 original diff. Defaults to disabled (no filtering).
2136 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2137 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2138 override this option with `--no-abbrev-commit`.
2141 Set the default date-time mode for the 'log' command.
2142 Setting a value for log.date is similar to using 'git log''s
2143 `--date` option. See linkgit:git-log[1] for details.
2146 Print out the ref names of any commits that are shown by the log
2147 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2148 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2149 specified, the full ref name (including prefix) will be printed.
2150 If 'auto' is specified, then if the output is going to a terminal,
2151 the ref names are shown as if 'short' were given, otherwise no ref
2152 names are shown. This is the same as the `--decorate` option
2156 If `true`, `git log` will act as if the `--follow` option was used when
2157 a single <path> is given. This has the same limitations as `--follow`,
2158 i.e. it cannot be used to follow multiple files and does not work well
2159 on non-linear history.
2162 A list of colors, separated by commas, that can be used to draw
2163 history lines in `git log --graph`.
2166 If true, the initial commit will be shown as a big creation event.
2167 This is equivalent to a diff against an empty tree.
2168 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2169 normally hide the root commit will now show it. True by default.
2172 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2173 linkgit:git-whatchanged[1] assume `--show-signature`.
2176 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2177 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2180 If true, makes linkgit:git-mailinfo[1] (and therefore
2181 linkgit:git-am[1]) act by default as if the --scissors option
2182 was provided on the command-line. When active, this features
2183 removes everything from the message body before a scissors
2184 line (i.e. consisting mainly of ">8", "8<" and "-").
2187 The location of an augmenting mailmap file. The default
2188 mailmap, located in the root of the repository, is loaded
2189 first, then the mailmap file pointed to by this variable.
2190 The location of the mailmap file may be in a repository
2191 subdirectory, or somewhere outside of the repository itself.
2192 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2195 Like `mailmap.file`, but consider the value as a reference to a
2196 blob in the repository. If both `mailmap.file` and
2197 `mailmap.blob` are given, both are parsed, with entries from
2198 `mailmap.file` taking precedence. In a bare repository, this
2199 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2203 Specify the programs that may be used to display help in the
2204 'man' format. See linkgit:git-help[1].
2207 Specify the command to invoke the specified man viewer. The
2208 specified command is evaluated in shell with the man page
2209 passed as argument. (See linkgit:git-help[1].)
2212 Override the path for the given tool that may be used to
2213 display help in the 'man' format. See linkgit:git-help[1].
2215 include::merge-config.txt[]
2217 mergetool.<tool>.path::
2218 Override the path for the given tool. This is useful in case
2219 your tool is not in the PATH.
2221 mergetool.<tool>.cmd::
2222 Specify the command to invoke the specified merge tool. The
2223 specified command is evaluated in shell with the following
2224 variables available: 'BASE' is the name of a temporary file
2225 containing the common base of the files to be merged, if available;
2226 'LOCAL' is the name of a temporary file containing the contents of
2227 the file on the current branch; 'REMOTE' is the name of a temporary
2228 file containing the contents of the file from the branch being
2229 merged; 'MERGED' contains the name of the file to which the merge
2230 tool should write the results of a successful merge.
2232 mergetool.<tool>.trustExitCode::
2233 For a custom merge command, specify whether the exit code of
2234 the merge command can be used to determine whether the merge was
2235 successful. If this is not set to true then the merge target file
2236 timestamp is checked and the merge assumed to have been successful
2237 if the file has been updated, otherwise the user is prompted to
2238 indicate the success of the merge.
2240 mergetool.meld.hasOutput::
2241 Older versions of `meld` do not support the `--output` option.
2242 Git will attempt to detect whether `meld` supports `--output`
2243 by inspecting the output of `meld --help`. Configuring
2244 `mergetool.meld.hasOutput` will make Git skip these checks and
2245 use the configured value instead. Setting `mergetool.meld.hasOutput`
2246 to `true` tells Git to unconditionally use the `--output` option,
2247 and `false` avoids using `--output`.
2249 mergetool.keepBackup::
2250 After performing a merge, the original file with conflict markers
2251 can be saved as a file with a `.orig` extension. If this variable
2252 is set to `false` then this file is not preserved. Defaults to
2253 `true` (i.e. keep the backup files).
2255 mergetool.keepTemporaries::
2256 When invoking a custom merge tool, Git uses a set of temporary
2257 files to pass to the tool. If the tool returns an error and this
2258 variable is set to `true`, then these temporary files will be
2259 preserved, otherwise they will be removed after the tool has
2260 exited. Defaults to `false`.
2262 mergetool.writeToTemp::
2263 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2264 conflicting files in the worktree by default. Git will attempt
2265 to use a temporary directory for these files when set `true`.
2266 Defaults to `false`.
2269 Prompt before each invocation of the merge resolution program.
2271 notes.mergeStrategy::
2272 Which merge strategy to choose by default when resolving notes
2273 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2274 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2275 section of linkgit:git-notes[1] for more information on each strategy.
2277 notes.<name>.mergeStrategy::
2278 Which merge strategy to choose when doing a notes merge into
2279 refs/notes/<name>. This overrides the more general
2280 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2281 linkgit:git-notes[1] for more information on the available strategies.
2284 The (fully qualified) refname from which to show notes when
2285 showing commit messages. The value of this variable can be set
2286 to a glob, in which case notes from all matching refs will be
2287 shown. You may also specify this configuration variable
2288 several times. A warning will be issued for refs that do not
2289 exist, but a glob that does not match any refs is silently
2292 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2293 environment variable, which must be a colon separated list of refs or
2296 The effective value of "core.notesRef" (possibly overridden by
2297 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2300 notes.rewrite.<command>::
2301 When rewriting commits with <command> (currently `amend` or
2302 `rebase`) and this variable is set to `true`, Git
2303 automatically copies your notes from the original to the
2304 rewritten commit. Defaults to `true`, but see
2305 "notes.rewriteRef" below.
2308 When copying notes during a rewrite (see the
2309 "notes.rewrite.<command>" option), determines what to do if
2310 the target commit already has a note. Must be one of
2311 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2312 Defaults to `concatenate`.
2314 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2315 environment variable.
2318 When copying notes during a rewrite, specifies the (fully
2319 qualified) ref whose notes should be copied. The ref may be a
2320 glob, in which case notes in all matching refs will be copied.
2321 You may also specify this configuration several times.
2323 Does not have a default value; you must configure this variable to
2324 enable note rewriting. Set it to `refs/notes/commits` to enable
2325 rewriting for the default commit notes.
2327 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2328 environment variable, which must be a colon separated list of refs or
2332 The size of the window used by linkgit:git-pack-objects[1] when no
2333 window size is given on the command line. Defaults to 10.
2336 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2337 maximum depth is given on the command line. Defaults to 50.
2340 The maximum size of memory that is consumed by each thread
2341 in linkgit:git-pack-objects[1] for pack window memory when
2342 no limit is given on the command line. The value can be
2343 suffixed with "k", "m", or "g". When left unconfigured (or
2344 set explicitly to 0), there will be no limit.
2347 An integer -1..9, indicating the compression level for objects
2348 in a pack file. -1 is the zlib default. 0 means no
2349 compression, and 1..9 are various speed/size tradeoffs, 9 being
2350 slowest. If not set, defaults to core.compression. If that is
2351 not set, defaults to -1, the zlib default, which is "a default
2352 compromise between speed and compression (currently equivalent
2355 Note that changing the compression level will not automatically recompress
2356 all existing objects. You can force recompression by passing the -F option
2357 to linkgit:git-repack[1].
2359 pack.deltaCacheSize::
2360 The maximum memory in bytes used for caching deltas in
2361 linkgit:git-pack-objects[1] before writing them out to a pack.
2362 This cache is used to speed up the writing object phase by not
2363 having to recompute the final delta result once the best match
2364 for all objects is found. Repacking large repositories on machines
2365 which are tight with memory might be badly impacted by this though,
2366 especially if this cache pushes the system into swapping.
2367 A value of 0 means no limit. The smallest size of 1 byte may be
2368 used to virtually disable this cache. Defaults to 256 MiB.
2370 pack.deltaCacheLimit::
2371 The maximum size of a delta, that is cached in
2372 linkgit:git-pack-objects[1]. This cache is used to speed up the
2373 writing object phase by not having to recompute the final delta
2374 result once the best match for all objects is found. Defaults to 1000.
2377 Specifies the number of threads to spawn when searching for best
2378 delta matches. This requires that linkgit:git-pack-objects[1]
2379 be compiled with pthreads otherwise this option is ignored with a
2380 warning. This is meant to reduce packing time on multiprocessor
2381 machines. The required amount of memory for the delta search window
2382 is however multiplied by the number of threads.
2383 Specifying 0 will cause Git to auto-detect the number of CPU's
2384 and set the number of threads accordingly.
2387 Specify the default pack index version. Valid values are 1 for
2388 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2389 the new pack index with capabilities for packs larger than 4 GB
2390 as well as proper protection against the repacking of corrupted
2391 packs. Version 2 is the default. Note that version 2 is enforced
2392 and this config option ignored whenever the corresponding pack is
2395 If you have an old Git that does not understand the version 2 `*.idx` file,
2396 cloning or fetching over a non native protocol (e.g. "http")
2397 that will copy both `*.pack` file and corresponding `*.idx` file from the
2398 other side may give you a repository that cannot be accessed with your
2399 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2400 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2403 pack.packSizeLimit::
2404 The maximum size of a pack. This setting only affects
2405 packing to a file when repacking, i.e. the git:// protocol
2406 is unaffected. It can be overridden by the `--max-pack-size`
2407 option of linkgit:git-repack[1]. Reaching this limit results
2408 in the creation of multiple packfiles; which in turn prevents
2409 bitmaps from being created.
2410 The minimum size allowed is limited to 1 MiB.
2411 The default is unlimited.
2412 Common unit suffixes of 'k', 'm', or 'g' are
2416 When true, git will use pack bitmaps (if available) when packing
2417 to stdout (e.g., during the server side of a fetch). Defaults to
2418 true. You should not generally need to turn this off unless
2419 you are debugging pack bitmaps.
2421 pack.writeBitmaps (deprecated)::
2422 This is a deprecated synonym for `repack.writeBitmaps`.
2424 pack.writeBitmapHashCache::
2425 When true, git will include a "hash cache" section in the bitmap
2426 index (if one is written). This cache can be used to feed git's
2427 delta heuristics, potentially leading to better deltas between
2428 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2429 between an older, bitmapped pack and objects that have been
2430 pushed since the last gc). The downside is that it consumes 4
2431 bytes per object of disk space, and that JGit's bitmap
2432 implementation does not understand it, causing it to complain if
2433 Git and JGit are used on the same repository. Defaults to false.
2436 If the value is boolean, turns on or off pagination of the
2437 output of a particular Git subcommand when writing to a tty.
2438 Otherwise, turns on pagination for the subcommand using the
2439 pager specified by the value of `pager.<cmd>`. If `--paginate`
2440 or `--no-pager` is specified on the command line, it takes
2441 precedence over this option. To disable pagination for all
2442 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2445 Alias for a --pretty= format string, as specified in
2446 linkgit:git-log[1]. Any aliases defined here can be used just
2447 as the built-in pretty formats could. For example,
2448 running `git config pretty.changelog "format:* %H %s"`
2449 would cause the invocation `git log --pretty=changelog`
2450 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2451 Note that an alias with the same name as a built-in format
2452 will be silently ignored.
2455 If set, provide a user defined default policy for all protocols which
2456 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2457 if unset, known-safe protocols (http, https, git, ssh, file) have a
2458 default policy of `always`, known-dangerous protocols (ext) have a
2459 default policy of `never`, and all other protocols have a default
2460 policy of `user`. Supported policies:
2464 * `always` - protocol is always able to be used.
2466 * `never` - protocol is never able to be used.
2468 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2469 either unset or has a value of 1. This policy should be used when you want a
2470 protocol to be directly usable by the user but don't want it used by commands which
2471 execute clone/fetch/push commands without user input, e.g. recursive
2472 submodule initialization.
2476 protocol.<name>.allow::
2477 Set a policy to be used by protocol `<name>` with clone/fetch/push
2478 commands. See `protocol.allow` above for the available policies.
2480 The protocol names currently used by git are:
2483 - `file`: any local file-based path (including `file://` URLs,
2486 - `git`: the anonymous git protocol over a direct TCP
2487 connection (or proxy, if configured)
2489 - `ssh`: git over ssh (including `host:path` syntax,
2492 - `http`: git over http, both "smart http" and "dumb http".
2493 Note that this does _not_ include `https`; if you want to configure
2494 both, you must do so individually.
2496 - any external helpers are named by their protocol (e.g., use
2497 `hg` to allow the `git-remote-hg` helper)
2501 By default, Git does not create an extra merge commit when merging
2502 a commit that is a descendant of the current commit. Instead, the
2503 tip of the current branch is fast-forwarded. When set to `false`,
2504 this variable tells Git to create an extra merge commit in such
2505 a case (equivalent to giving the `--no-ff` option from the command
2506 line). When set to `only`, only such fast-forward merges are
2507 allowed (equivalent to giving the `--ff-only` option from the
2508 command line). This setting overrides `merge.ff` when pulling.
2511 When true, rebase branches on top of the fetched branch, instead
2512 of merging the default branch from the default remote when "git
2513 pull" is run. See "branch.<name>.rebase" for setting this on a
2516 When preserve, also pass `--preserve-merges` along to 'git rebase'
2517 so that locally committed merge commits will not be flattened
2518 by running 'git pull'.
2520 When the value is `interactive`, the rebase is run in interactive mode.
2522 *NOTE*: this is a possibly dangerous operation; do *not* use
2523 it unless you understand the implications (see linkgit:git-rebase[1]
2527 The default merge strategy to use when pulling multiple branches
2531 The default merge strategy to use when pulling a single branch.
2534 Defines the action `git push` should take if no refspec is
2535 explicitly given. Different values are well-suited for
2536 specific workflows; for instance, in a purely central workflow
2537 (i.e. the fetch source is equal to the push destination),
2538 `upstream` is probably what you want. Possible values are:
2542 * `nothing` - do not push anything (error out) unless a refspec is
2543 explicitly given. This is primarily meant for people who want to
2544 avoid mistakes by always being explicit.
2546 * `current` - push the current branch to update a branch with the same
2547 name on the receiving end. Works in both central and non-central
2550 * `upstream` - push the current branch back to the branch whose
2551 changes are usually integrated into the current branch (which is
2552 called `@{upstream}`). This mode only makes sense if you are
2553 pushing to the same repository you would normally pull from
2554 (i.e. central workflow).
2556 * `tracking` - This is a deprecated synonym for `upstream`.
2558 * `simple` - in centralized workflow, work like `upstream` with an
2559 added safety to refuse to push if the upstream branch's name is
2560 different from the local one.
2562 When pushing to a remote that is different from the remote you normally
2563 pull from, work as `current`. This is the safest option and is suited
2566 This mode has become the default in Git 2.0.
2568 * `matching` - push all branches having the same name on both ends.
2569 This makes the repository you are pushing to remember the set of
2570 branches that will be pushed out (e.g. if you always push 'maint'
2571 and 'master' there and no other branches, the repository you push
2572 to will have these two branches, and your local 'maint' and
2573 'master' will be pushed there).
2575 To use this mode effectively, you have to make sure _all_ the
2576 branches you would push out are ready to be pushed out before
2577 running 'git push', as the whole point of this mode is to allow you
2578 to push all of the branches in one go. If you usually finish work
2579 on only one branch and push out the result, while other branches are
2580 unfinished, this mode is not for you. Also this mode is not
2581 suitable for pushing into a shared central repository, as other
2582 people may add new branches there, or update the tip of existing
2583 branches outside your control.
2585 This used to be the default, but not since Git 2.0 (`simple` is the
2591 If set to true enable `--follow-tags` option by default. You
2592 may override this configuration at time of push by specifying
2596 May be set to a boolean value, or the string 'if-asked'. A true
2597 value causes all pushes to be GPG signed, as if `--signed` is
2598 passed to linkgit:git-push[1]. The string 'if-asked' causes
2599 pushes to be signed if the server supports it, as if
2600 `--signed=if-asked` is passed to 'git push'. A false value may
2601 override a value from a lower-priority config file. An explicit
2602 command-line flag always overrides this config option.
2604 push.recurseSubmodules::
2605 Make sure all submodule commits used by the revisions to be pushed
2606 are available on a remote-tracking branch. If the value is 'check'
2607 then Git will verify that all submodule commits that changed in the
2608 revisions to be pushed are available on at least one remote of the
2609 submodule. If any commits are missing, the push will be aborted and
2610 exit with non-zero status. If the value is 'on-demand' then all
2611 submodules that changed in the revisions to be pushed will be
2612 pushed. If on-demand was not able to push all necessary revisions
2613 it will also be aborted and exit with non-zero status. If the value
2614 is 'no' then default behavior of ignoring submodules when pushing
2615 is retained. You may override this configuration at time of push by
2616 specifying '--recurse-submodules=check|on-demand|no'.
2619 Whether to show a diffstat of what changed upstream since the last
2620 rebase. False by default.
2623 If set to true enable `--autosquash` option by default.
2626 When set to true, automatically create a temporary stash
2627 before the operation begins, and apply it after the operation
2628 ends. This means that you can run rebase on a dirty worktree.
2629 However, use with care: the final stash application after a
2630 successful rebase might result in non-trivial conflicts.
2633 rebase.missingCommitsCheck::
2634 If set to "warn", git rebase -i will print a warning if some
2635 commits are removed (e.g. a line was deleted), however the
2636 rebase will still proceed. If set to "error", it will print
2637 the previous warning and stop the rebase, 'git rebase
2638 --edit-todo' can then be used to correct the error. If set to
2639 "ignore", no checking is done.
2640 To drop a commit without warning or error, use the `drop`
2641 command in the todo-list.
2642 Defaults to "ignore".
2644 rebase.instructionFormat::
2645 A format string, as specified in linkgit:git-log[1], to be used for
2646 the instruction list during an interactive rebase. The format will automatically
2647 have the long commit hash prepended to the format.
2649 receive.advertiseAtomic::
2650 By default, git-receive-pack will advertise the atomic push
2651 capability to its clients. If you don't want to advertise this
2652 capability, set this variable to false.
2654 receive.advertisePushOptions::
2655 When set to true, git-receive-pack will advertise the push options
2656 capability to its clients. False by default.
2659 By default, git-receive-pack will run "git-gc --auto" after
2660 receiving data from git-push and updating refs. You can stop
2661 it by setting this variable to false.
2663 receive.certNonceSeed::
2664 By setting this variable to a string, `git receive-pack`
2665 will accept a `git push --signed` and verifies it by using
2666 a "nonce" protected by HMAC using this string as a secret
2669 receive.certNonceSlop::
2670 When a `git push --signed` sent a push certificate with a
2671 "nonce" that was issued by a receive-pack serving the same
2672 repository within this many seconds, export the "nonce"
2673 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2674 hooks (instead of what the receive-pack asked the sending
2675 side to include). This may allow writing checks in
2676 `pre-receive` and `post-receive` a bit easier. Instead of
2677 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2678 that records by how many seconds the nonce is stale to
2679 decide if they want to accept the certificate, they only
2680 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2682 receive.fsckObjects::
2683 If it is set to true, git-receive-pack will check all received
2684 objects. It will abort in the case of a malformed object or a
2685 broken link. The result of an abort are only dangling objects.
2686 Defaults to false. If not set, the value of `transfer.fsckObjects`
2689 receive.fsck.<msg-id>::
2690 When `receive.fsckObjects` is set to true, errors can be switched
2691 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2692 setting where the `<msg-id>` is the fsck message ID and the value
2693 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2694 the error/warning with the message ID, e.g. "missingEmail: invalid
2695 author/committer line - missing email" means that setting
2696 `receive.fsck.missingEmail = ignore` will hide that issue.
2698 This feature is intended to support working with legacy repositories
2699 which would not pass pushing when `receive.fsckObjects = true`, allowing
2700 the host to accept repositories with certain known issues but still catch
2703 receive.fsck.skipList::
2704 The path to a sorted list of object names (i.e. one SHA-1 per
2705 line) that are known to be broken in a non-fatal way and should
2706 be ignored. This feature is useful when an established project
2707 should be accepted despite early commits containing errors that
2708 can be safely ignored such as invalid committer email addresses.
2709 Note: corrupt objects cannot be skipped with this setting.
2712 After receiving the pack from the client, `receive-pack` may
2713 produce no output (if `--quiet` was specified) while processing
2714 the pack, causing some networks to drop the TCP connection.
2715 With this option set, if `receive-pack` does not transmit
2716 any data in this phase for `receive.keepAlive` seconds, it will
2717 send a short keepalive packet. The default is 5 seconds; set
2718 to 0 to disable keepalives entirely.
2720 receive.unpackLimit::
2721 If the number of objects received in a push is below this
2722 limit then the objects will be unpacked into loose object
2723 files. However if the number of received objects equals or
2724 exceeds this limit then the received pack will be stored as
2725 a pack, after adding any missing delta bases. Storing the
2726 pack from a push can make the push operation complete faster,
2727 especially on slow filesystems. If not set, the value of
2728 `transfer.unpackLimit` is used instead.
2730 receive.maxInputSize::
2731 If the size of the incoming pack stream is larger than this
2732 limit, then git-receive-pack will error out, instead of
2733 accepting the pack file. If not set or set to 0, then the size
2736 receive.denyDeletes::
2737 If set to true, git-receive-pack will deny a ref update that deletes
2738 the ref. Use this to prevent such a ref deletion via a push.
2740 receive.denyDeleteCurrent::
2741 If set to true, git-receive-pack will deny a ref update that
2742 deletes the currently checked out branch of a non-bare repository.
2744 receive.denyCurrentBranch::
2745 If set to true or "refuse", git-receive-pack will deny a ref update
2746 to the currently checked out branch of a non-bare repository.
2747 Such a push is potentially dangerous because it brings the HEAD
2748 out of sync with the index and working tree. If set to "warn",
2749 print a warning of such a push to stderr, but allow the push to
2750 proceed. If set to false or "ignore", allow such pushes with no
2751 message. Defaults to "refuse".
2753 Another option is "updateInstead" which will update the working
2754 tree if pushing into the current branch. This option is
2755 intended for synchronizing working directories when one side is not easily
2756 accessible via interactive ssh (e.g. a live web site, hence the requirement
2757 that the working directory be clean). This mode also comes in handy when
2758 developing inside a VM to test and fix code on different Operating Systems.
2760 By default, "updateInstead" will refuse the push if the working tree or
2761 the index have any difference from the HEAD, but the `push-to-checkout`
2762 hook can be used to customize this. See linkgit:githooks[5].
2764 receive.denyNonFastForwards::
2765 If set to true, git-receive-pack will deny a ref update which is
2766 not a fast-forward. Use this to prevent such an update via a push,
2767 even if that push is forced. This configuration variable is
2768 set when initializing a shared repository.
2771 This variable is the same as `transfer.hideRefs`, but applies
2772 only to `receive-pack` (and so affects pushes, but not fetches).
2773 An attempt to update or delete a hidden ref by `git push` is
2776 receive.updateServerInfo::
2777 If set to true, git-receive-pack will run git-update-server-info
2778 after receiving data from git-push and updating refs.
2780 receive.shallowUpdate::
2781 If set to true, .git/shallow can be updated when new refs
2782 require new shallow roots. Otherwise those refs are rejected.
2784 remote.pushDefault::
2785 The remote to push to by default. Overrides
2786 `branch.<name>.remote` for all branches, and is overridden by
2787 `branch.<name>.pushRemote` for specific branches.
2790 The URL of a remote repository. See linkgit:git-fetch[1] or
2791 linkgit:git-push[1].
2793 remote.<name>.pushurl::
2794 The push URL of a remote repository. See linkgit:git-push[1].
2796 remote.<name>.proxy::
2797 For remotes that require curl (http, https and ftp), the URL to
2798 the proxy to use for that remote. Set to the empty string to
2799 disable proxying for that remote.
2801 remote.<name>.proxyAuthMethod::
2802 For remotes that require curl (http, https and ftp), the method to use for
2803 authenticating against the proxy in use (probably set in
2804 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2806 remote.<name>.fetch::
2807 The default set of "refspec" for linkgit:git-fetch[1]. See
2808 linkgit:git-fetch[1].
2810 remote.<name>.push::
2811 The default set of "refspec" for linkgit:git-push[1]. See
2812 linkgit:git-push[1].
2814 remote.<name>.mirror::
2815 If true, pushing to this remote will automatically behave
2816 as if the `--mirror` option was given on the command line.
2818 remote.<name>.skipDefaultUpdate::
2819 If true, this remote will be skipped by default when updating
2820 using linkgit:git-fetch[1] or the `update` subcommand of
2821 linkgit:git-remote[1].
2823 remote.<name>.skipFetchAll::
2824 If true, this remote will be skipped by default when updating
2825 using linkgit:git-fetch[1] or the `update` subcommand of
2826 linkgit:git-remote[1].
2828 remote.<name>.receivepack::
2829 The default program to execute on the remote side when pushing. See
2830 option --receive-pack of linkgit:git-push[1].
2832 remote.<name>.uploadpack::
2833 The default program to execute on the remote side when fetching. See
2834 option --upload-pack of linkgit:git-fetch-pack[1].
2836 remote.<name>.tagOpt::
2837 Setting this value to --no-tags disables automatic tag following when
2838 fetching from remote <name>. Setting it to --tags will fetch every
2839 tag from remote <name>, even if they are not reachable from remote
2840 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2841 override this setting. See options --tags and --no-tags of
2842 linkgit:git-fetch[1].
2845 Setting this to a value <vcs> will cause Git to interact with
2846 the remote with the git-remote-<vcs> helper.
2848 remote.<name>.prune::
2849 When set to true, fetching from this remote by default will also
2850 remove any remote-tracking references that no longer exist on the
2851 remote (as if the `--prune` option was given on the command line).
2852 Overrides `fetch.prune` settings, if any.
2855 The list of remotes which are fetched by "git remote update
2856 <group>". See linkgit:git-remote[1].
2858 repack.useDeltaBaseOffset::
2859 By default, linkgit:git-repack[1] creates packs that use
2860 delta-base offset. If you need to share your repository with
2861 Git older than version 1.4.4, either directly or via a dumb
2862 protocol such as http, then you need to set this option to
2863 "false" and repack. Access from old Git versions over the
2864 native protocol are unaffected by this option.
2866 repack.packKeptObjects::
2867 If set to true, makes `git repack` act as if
2868 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2869 details. Defaults to `false` normally, but `true` if a bitmap
2870 index is being written (either via `--write-bitmap-index` or
2871 `repack.writeBitmaps`).
2873 repack.writeBitmaps::
2874 When true, git will write a bitmap index when packing all
2875 objects to disk (e.g., when `git repack -a` is run). This
2876 index can speed up the "counting objects" phase of subsequent
2877 packs created for clones and fetches, at the cost of some disk
2878 space and extra time spent on the initial repack. This has
2879 no effect if multiple packfiles are created.
2883 When set to true, `git-rerere` updates the index with the
2884 resulting contents after it cleanly resolves conflicts using
2885 previously recorded resolution. Defaults to false.
2888 Activate recording of resolved conflicts, so that identical
2889 conflict hunks can be resolved automatically, should they be
2890 encountered again. By default, linkgit:git-rerere[1] is
2891 enabled if there is an `rr-cache` directory under the
2892 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2895 sendemail.identity::
2896 A configuration identity. When given, causes values in the
2897 'sendemail.<identity>' subsection to take precedence over
2898 values in the 'sendemail' section. The default identity is
2899 the value of `sendemail.identity`.
2901 sendemail.smtpEncryption::
2902 See linkgit:git-send-email[1] for description. Note that this
2903 setting is not subject to the 'identity' mechanism.
2905 sendemail.smtpssl (deprecated)::
2906 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2908 sendemail.smtpsslcertpath::
2909 Path to ca-certificates (either a directory or a single file).
2910 Set it to an empty string to disable certificate verification.
2912 sendemail.<identity>.*::
2913 Identity-specific versions of the 'sendemail.*' parameters
2914 found below, taking precedence over those when the this
2915 identity is selected, through command-line or
2916 `sendemail.identity`.
2918 sendemail.aliasesFile::
2919 sendemail.aliasFileType::
2920 sendemail.annotate::
2924 sendemail.chainReplyTo::
2926 sendemail.envelopeSender::
2928 sendemail.multiEdit::
2929 sendemail.signedoffbycc::
2930 sendemail.smtpPass::
2931 sendemail.suppresscc::
2932 sendemail.suppressFrom::
2934 sendemail.smtpDomain::
2935 sendemail.smtpServer::
2936 sendemail.smtpServerPort::
2937 sendemail.smtpServerOption::
2938 sendemail.smtpUser::
2940 sendemail.transferEncoding::
2941 sendemail.validate::
2943 See linkgit:git-send-email[1] for description.
2945 sendemail.signedoffcc (deprecated)::
2946 Deprecated alias for `sendemail.signedoffbycc`.
2948 showbranch.default::
2949 The default set of branches for linkgit:git-show-branch[1].
2950 See linkgit:git-show-branch[1].
2952 splitIndex.maxPercentChange::
2953 When the split index feature is used, this specifies the
2954 percent of entries the split index can contain compared to the
2955 total number of entries in both the split index and the shared
2956 index before a new shared index is written.
2957 The value should be between 0 and 100. If the value is 0 then
2958 a new shared index is always written, if it is 100 a new
2959 shared index is never written.
2960 By default the value is 20, so a new shared index is written
2961 if the number of entries in the split index would be greater
2962 than 20 percent of the total number of entries.
2963 See linkgit:git-update-index[1].
2965 splitIndex.sharedIndexExpire::
2966 When the split index feature is used, shared index files that
2967 were not modified since the time this variable specifies will
2968 be removed when a new shared index file is created. The value
2969 "now" expires all entries immediately, and "never" suppresses
2970 expiration altogether.
2971 The default value is "2.weeks.ago".
2972 Note that a shared index file is considered modified (for the
2973 purpose of expiration) each time a new split-index file is
2974 either created based on it or read from it.
2975 See linkgit:git-update-index[1].
2977 status.relativePaths::
2978 By default, linkgit:git-status[1] shows paths relative to the
2979 current directory. Setting this variable to `false` shows paths
2980 relative to the repository root (this was the default for Git
2984 Set to true to enable --short by default in linkgit:git-status[1].
2985 The option --no-short takes precedence over this variable.
2988 Set to true to enable --branch by default in linkgit:git-status[1].
2989 The option --no-branch takes precedence over this variable.
2991 status.displayCommentPrefix::
2992 If set to true, linkgit:git-status[1] will insert a comment
2993 prefix before each output line (starting with
2994 `core.commentChar`, i.e. `#` by default). This was the
2995 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2998 status.showUntrackedFiles::
2999 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3000 files which are not currently tracked by Git. Directories which
3001 contain only untracked files, are shown with the directory name
3002 only. Showing untracked files means that Git needs to lstat() all
3003 the files in the whole repository, which might be slow on some
3004 systems. So, this variable controls how the commands displays
3005 the untracked files. Possible values are:
3008 * `no` - Show no untracked files.
3009 * `normal` - Show untracked files and directories.
3010 * `all` - Show also individual files in untracked directories.
3013 If this variable is not specified, it defaults to 'normal'.
3014 This variable can be overridden with the -u|--untracked-files option
3015 of linkgit:git-status[1] and linkgit:git-commit[1].
3017 status.submoduleSummary::
3019 If this is set to a non zero number or true (identical to -1 or an
3020 unlimited number), the submodule summary will be enabled and a
3021 summary of commits for modified submodules will be shown (see
3022 --summary-limit option of linkgit:git-submodule[1]). Please note
3023 that the summary output command will be suppressed for all
3024 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3025 for those submodules where `submodule.<name>.ignore=all`. The only
3026 exception to that rule is that status and commit will show staged
3027 submodule changes. To
3028 also view the summary for ignored submodules you can either use
3029 the --ignore-submodules=dirty command-line option or the 'git
3030 submodule summary' command, which shows a similar output but does
3031 not honor these settings.
3034 If this is set to true, the `git stash show` command without an
3035 option will show the stash in patch form. Defaults to false.
3036 See description of 'show' command in linkgit:git-stash[1].
3039 If this is set to true, the `git stash show` command without an
3040 option will show diffstat of the stash. Defaults to true.
3041 See description of 'show' command in linkgit:git-stash[1].
3043 submodule.<name>.url::
3044 The URL for a submodule. This variable is copied from the .gitmodules
3045 file to the git config via 'git submodule init'. The user can change
3046 the configured URL before obtaining the submodule via 'git submodule
3047 update'. If neither submodule.<name>.active or submodule.active are
3048 set, the presence of this variable is used as a fallback to indicate
3049 whether the submodule is of interest to git commands.
3050 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3052 submodule.<name>.update::
3053 The default update procedure for a submodule. This variable
3054 is populated by `git submodule init` from the
3055 linkgit:gitmodules[5] file. See description of 'update'
3056 command in linkgit:git-submodule[1].
3058 submodule.<name>.branch::
3059 The remote branch name for a submodule, used by `git submodule
3060 update --remote`. Set this option to override the value found in
3061 the `.gitmodules` file. See linkgit:git-submodule[1] and
3062 linkgit:gitmodules[5] for details.
3064 submodule.<name>.fetchRecurseSubmodules::
3065 This option can be used to control recursive fetching of this
3066 submodule. It can be overridden by using the --[no-]recurse-submodules
3067 command-line option to "git fetch" and "git pull".
3068 This setting will override that from in the linkgit:gitmodules[5]
3071 submodule.<name>.ignore::
3072 Defines under what circumstances "git status" and the diff family show
3073 a submodule as modified. When set to "all", it will never be considered
3074 modified (but it will nonetheless show up in the output of status and
3075 commit when it has been staged), "dirty" will ignore all changes
3076 to the submodules work tree and
3077 takes only differences between the HEAD of the submodule and the commit
3078 recorded in the superproject into account. "untracked" will additionally
3079 let submodules with modified tracked files in their work tree show up.
3080 Using "none" (the default when this option is not set) also shows
3081 submodules that have untracked files in their work tree as changed.
3082 This setting overrides any setting made in .gitmodules for this submodule,
3083 both settings can be overridden on the command line by using the
3084 "--ignore-submodules" option. The 'git submodule' commands are not
3085 affected by this setting.
3087 submodule.<name>.active::
3088 Boolean value indicating if the submodule is of interest to git
3089 commands. This config option takes precedence over the
3090 submodule.active config option.
3093 A repeated field which contains a pathspec used to match against a
3094 submodule's path to determine if the submodule is of interest to git
3098 Specifies if commands recurse into submodules by default. This
3099 applies to all commands that have a `--recurse-submodules` option.
3102 submodule.fetchJobs::
3103 Specifies how many submodules are fetched/cloned at the same time.
3104 A positive integer allows up to that number of submodules fetched
3105 in parallel. A value of 0 will give some reasonable default.
3106 If unset, it defaults to 1.
3108 submodule.alternateLocation::
3109 Specifies how the submodules obtain alternates when submodules are
3110 cloned. Possible values are `no`, `superproject`.
3111 By default `no` is assumed, which doesn't add references. When the
3112 value is set to `superproject` the submodule to be cloned computes
3113 its alternates location relative to the superprojects alternate.
3115 submodule.alternateErrorStrategy::
3116 Specifies how to treat errors with the alternates for a submodule
3117 as computed via `submodule.alternateLocation`. Possible values are
3118 `ignore`, `info`, `die`. Default is `die`.
3120 tag.forceSignAnnotated::
3121 A boolean to specify whether annotated tags created should be GPG signed.
3122 If `--annotate` is specified on the command line, it takes
3123 precedence over this option.
3126 This variable controls the sort ordering of tags when displayed by
3127 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3128 value of this variable will be used as the default.
3131 This variable can be used to restrict the permission bits of
3132 tar archive entries. The default is 0002, which turns off the
3133 world write bit. The special value "user" indicates that the
3134 archiving user's umask will be used instead. See umask(2) and
3135 linkgit:git-archive[1].
3137 transfer.fsckObjects::
3138 When `fetch.fsckObjects` or `receive.fsckObjects` are
3139 not set, the value of this variable is used instead.
3143 String(s) `receive-pack` and `upload-pack` use to decide which
3144 refs to omit from their initial advertisements. Use more than
3145 one definition to specify multiple prefix strings. A ref that is
3146 under the hierarchies listed in the value of this variable is
3147 excluded, and is hidden when responding to `git push` or `git
3148 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3149 program-specific versions of this config.
3151 You may also include a `!` in front of the ref name to negate the entry,
3152 explicitly exposing it, even if an earlier entry marked it as hidden.
3153 If you have multiple hideRefs values, later entries override earlier ones
3154 (and entries in more-specific config files override less-specific ones).
3156 If a namespace is in use, the namespace prefix is stripped from each
3157 reference before it is matched against `transfer.hiderefs` patterns.
3158 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3159 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3160 is omitted from the advertisements but `refs/heads/master` and
3161 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3162 "have" lines. In order to match refs before stripping, add a `^` in front of
3163 the ref name. If you combine `!` and `^`, `!` must be specified first.
3165 Even if you hide refs, a client may still be able to steal the target
3166 objects via the techniques described in the "SECURITY" section of the
3167 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3168 separate repository.
3170 transfer.unpackLimit::
3171 When `fetch.unpackLimit` or `receive.unpackLimit` are
3172 not set, the value of this variable is used instead.
3173 The default value is 100.
3175 uploadarchive.allowUnreachable::
3176 If true, allow clients to use `git archive --remote` to request
3177 any tree, whether reachable from the ref tips or not. See the
3178 discussion in the "SECURITY" section of
3179 linkgit:git-upload-archive[1] for more details. Defaults to
3182 uploadpack.hideRefs::
3183 This variable is the same as `transfer.hideRefs`, but applies
3184 only to `upload-pack` (and so affects only fetches, not pushes).
3185 An attempt to fetch a hidden ref by `git fetch` will fail. See
3186 also `uploadpack.allowTipSHA1InWant`.
3188 uploadpack.allowTipSHA1InWant::
3189 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3190 to accept a fetch request that asks for an object at the tip
3191 of a hidden ref (by default, such a request is rejected).
3192 See also `uploadpack.hideRefs`. Even if this is false, a client
3193 may be able to steal objects via the techniques described in the
3194 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3195 best to keep private data in a separate repository.
3197 uploadpack.allowReachableSHA1InWant::
3198 Allow `upload-pack` to accept a fetch request that asks for an
3199 object that is reachable from any ref tip. However, note that
3200 calculating object reachability is computationally expensive.
3201 Defaults to `false`. Even if this is false, a client may be able
3202 to steal objects via the techniques described in the "SECURITY"
3203 section of the linkgit:gitnamespaces[7] man page; it's best to
3204 keep private data in a separate repository.
3206 uploadpack.allowAnySHA1InWant::
3207 Allow `upload-pack` to accept a fetch request that asks for any
3209 Defaults to `false`.
3211 uploadpack.keepAlive::
3212 When `upload-pack` has started `pack-objects`, there may be a
3213 quiet period while `pack-objects` prepares the pack. Normally
3214 it would output progress information, but if `--quiet` was used
3215 for the fetch, `pack-objects` will output nothing at all until
3216 the pack data begins. Some clients and networks may consider
3217 the server to be hung and give up. Setting this option instructs
3218 `upload-pack` to send an empty keepalive packet every
3219 `uploadpack.keepAlive` seconds. Setting this option to 0
3220 disables keepalive packets entirely. The default is 5 seconds.
3222 uploadpack.packObjectsHook::
3223 If this option is set, when `upload-pack` would run
3224 `git pack-objects` to create a packfile for a client, it will
3225 run this shell command instead. The `pack-objects` command and
3226 arguments it _would_ have run (including the `git pack-objects`
3227 at the beginning) are appended to the shell command. The stdin
3228 and stdout of the hook are treated as if `pack-objects` itself
3229 was run. I.e., `upload-pack` will feed input intended for
3230 `pack-objects` to the hook, and expects a completed packfile on
3233 Note that this configuration variable is ignored if it is seen in the
3234 repository-level config (this is a safety measure against fetching from
3235 untrusted repositories).
3237 url.<base>.insteadOf::
3238 Any URL that starts with this value will be rewritten to
3239 start, instead, with <base>. In cases where some site serves a
3240 large number of repositories, and serves them with multiple
3241 access methods, and some users need to use different access
3242 methods, this feature allows people to specify any of the
3243 equivalent URLs and have Git automatically rewrite the URL to
3244 the best alternative for the particular user, even for a
3245 never-before-seen repository on the site. When more than one
3246 insteadOf strings match a given URL, the longest match is used.
3248 Note that any protocol restrictions will be applied to the rewritten
3249 URL. If the rewrite changes the URL to use a custom protocol or remote
3250 helper, you may need to adjust the `protocol.*.allow` config to permit
3251 the request. In particular, protocols you expect to use for submodules
3252 must be set to `always` rather than the default of `user`. See the
3253 description of `protocol.allow` above.
3255 url.<base>.pushInsteadOf::
3256 Any URL that starts with this value will not be pushed to;
3257 instead, it will be rewritten to start with <base>, and the
3258 resulting URL will be pushed to. In cases where some site serves
3259 a large number of repositories, and serves them with multiple
3260 access methods, some of which do not allow push, this feature
3261 allows people to specify a pull-only URL and have Git
3262 automatically use an appropriate URL to push, even for a
3263 never-before-seen repository on the site. When more than one
3264 pushInsteadOf strings match a given URL, the longest match is
3265 used. If a remote has an explicit pushurl, Git will ignore this
3266 setting for that remote.
3269 Your email address to be recorded in any newly created commits.
3270 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3271 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3274 Your full name to be recorded in any newly created commits.
3275 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3276 environment variables. See linkgit:git-commit-tree[1].
3278 user.useConfigOnly::
3279 Instruct Git to avoid trying to guess defaults for `user.email`
3280 and `user.name`, and instead retrieve the values only from the
3281 configuration. For example, if you have multiple email addresses
3282 and would like to use a different one for each repository, then
3283 with this configuration option set to `true` in the global config
3284 along with a name, Git will prompt you to set up an email before
3285 making new commits in a newly cloned repository.
3286 Defaults to `false`.
3289 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3290 key you want it to automatically when creating a signed tag or
3291 commit, you can override the default selection with this variable.
3292 This option is passed unchanged to gpg's --local-user parameter,
3293 so you may specify a key using any method that gpg supports.
3295 versionsort.prereleaseSuffix (deprecated)::
3296 Deprecated alias for `versionsort.suffix`. Ignored if
3297 `versionsort.suffix` is set.
3299 versionsort.suffix::
3300 Even when version sort is used in linkgit:git-tag[1], tagnames
3301 with the same base version but different suffixes are still sorted
3302 lexicographically, resulting e.g. in prerelease tags appearing
3303 after the main release (e.g. "1.0-rc1" after "1.0"). This
3304 variable can be specified to determine the sorting order of tags
3305 with different suffixes.
3307 By specifying a single suffix in this variable, any tagname containing
3308 that suffix will appear before the corresponding main release. E.g. if
3309 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3310 "1.0". If specified multiple times, once per suffix, then the order of
3311 suffixes in the configuration will determine the sorting order of tagnames
3312 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3313 configuration, then all "1.0-preX" tags will be listed before any
3314 "1.0-rcX" tags. The placement of the main release tag relative to tags
3315 with various suffixes can be determined by specifying the empty suffix
3316 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3317 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3318 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3321 If more than one suffixes match the same tagname, then that tagname will
3322 be sorted according to the suffix which starts at the earliest position in
3323 the tagname. If more than one different matching suffixes start at
3324 that earliest position, then that tagname will be sorted according to the
3325 longest of those suffixes.
3326 The sorting order between different suffixes is undefined if they are
3327 in multiple config files.
3330 Specify a web browser that may be used by some commands.
3331 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]