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 You can include one config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 variable takes a pathname as its value, and is subject to tilde
88 included file is expanded immediately, as if its contents had been
89 found at the location of the include directive. If the value of the
90 `include.path` variable is a relative path, the path is considered to be
91 relative to the configuration file in which the include directive was
92 found. See below for examples.
100 ; Don't trust file modes
105 external = /usr/local/bin/diff-wrapper
110 merge = refs/heads/devel
114 gitProxy="ssh" for "kernel.org"
115 gitProxy=default-proxy ; for the rest
118 path = /path/to/foo.inc ; include by absolute path
119 path = foo ; expand "foo" relative to the current file
120 path = ~/foo ; expand "foo" in your `$HOME` directory
126 Values of many variables are treated as a simple string, but there
127 are variables that take values of specific types and there are rules
128 as to how to spell them.
132 When a variable is said to take a boolean value, many
133 synonyms are accepted for 'true' and 'false'; these are all
136 true;; Boolean true can be spelled as `yes`, `on`, `true`,
137 or `1`. Also, a variable defined without `= <value>`
140 false;; Boolean false can be spelled as `no`, `off`,
143 When converting value to the canonical form using `--bool` type
144 specifier; 'git config' will ensure that the output is "true" or
145 "false" (spelled in lowercase).
148 The value for many variables that specify various sizes can
149 be suffixed with `k`, `M`,... to mean "scale the number by
150 1024", "by 1024x1024", etc.
153 The value for a variable that takes a color is a list of
154 colors (at most two, one for foreground and one for background)
155 and attributes (as many as you want), separated by spaces.
157 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
158 `blue`, `magenta`, `cyan` and `white`. The first color given is the
159 foreground; the second is the background.
161 Colors may also be given as numbers between 0 and 255; these use ANSI
162 256-color mode (but note that not all terminals may support this). If
163 your terminal supports it, you may also specify 24-bit RGB values as
166 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
167 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
168 The position of any attributes with respect to the colors
169 (before, after, or in between), doesn't matter. Specific attributes may
170 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
173 An empty color string produces no color effect at all. This can be used
174 to avoid coloring specific elements without disabling color entirely.
176 For git's pre-defined color slots, the attributes are meant to be reset
177 at the beginning of each item in the colored output. So setting
178 `color.decorate.branch` to `black` will paint that branch name in a
179 plain `black`, even if the previous thing on the same output line (e.g.
180 opening parenthesis before the list of branch names in `log --decorate`
181 output) is set to be painted with `bold` or some other attribute.
182 However, custom log formats may do more complicated and layered
183 coloring, and the negated forms may be useful there.
186 A variable that takes a pathname value can be given a
187 string that begins with "`~/`" or "`~user/`", and the usual
188 tilde expansion happens to such a string: `~/`
189 is expanded to the value of `$HOME`, and `~user/` to the
190 specified user's home directory.
196 Note that this list is non-comprehensive and not necessarily complete.
197 For command-specific variables, you will find a more detailed description
198 in the appropriate manual page.
200 Other git-related tools may and do use their own variables. When
201 inventing new variables for use in your own tool, make sure their
202 names do not conflict with those that are used by Git itself and
203 other popular tools, and describe them in your documentation.
207 These variables control various optional help messages designed to
208 aid new users. All 'advice.*' variables default to 'true', and you
209 can tell Git that you do not need help by setting these to 'false':
213 Set this variable to 'false' if you want to disable
215 'pushNonFFMatching', 'pushAlreadyExists',
216 'pushFetchFirst', and 'pushNeedsForce'
219 Advice shown when linkgit:git-push[1] fails due to a
220 non-fast-forward update to the current branch.
222 Advice shown when you ran linkgit:git-push[1] and pushed
223 'matching refs' explicitly (i.e. you used ':', or
224 specified a refspec that isn't your current branch) and
225 it resulted in a non-fast-forward error.
227 Shown when linkgit:git-push[1] rejects an update that
228 does not qualify for fast-forwarding (e.g., a tag.)
230 Shown when linkgit:git-push[1] rejects an update that
231 tries to overwrite a remote ref that points at an
232 object we do not have.
234 Shown when linkgit:git-push[1] rejects an update that
235 tries to overwrite a remote ref that points at an
236 object that is not a commit-ish, or make the remote
237 ref point at an object that is not a commit-ish.
239 Show directions on how to proceed from the current
240 state in the output of linkgit:git-status[1], in
241 the template shown when writing commit messages in
242 linkgit:git-commit[1], and in the help message shown
243 by linkgit:git-checkout[1] when switching branch.
245 Advise to consider using the `-u` option to linkgit:git-status[1]
246 when the command takes more than 2 seconds to enumerate untracked
249 Advice shown when linkgit:git-merge[1] refuses to
250 merge to avoid overwriting local changes.
252 Advice shown by various commands when conflicts
253 prevent the operation from being performed.
255 Advice on how to set your identity configuration when
256 your information is guessed from the system username and
259 Advice shown when you used linkgit:git-checkout[1] to
260 move to the detach HEAD state, to instruct how to create
261 a local branch after the fact.
263 Advice that shows the location of the patch file when
264 linkgit:git-am[1] fails to apply it.
266 In case of failure in the output of linkgit:git-rm[1],
267 show directions on how to proceed from the current state.
271 Tells Git if the executable bit of files in the working tree
274 Some filesystems lose the executable bit when a file that is
275 marked as executable is checked out, or checks out an
276 non-executable file with executable bit on.
277 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
278 to see if it handles the executable bit correctly
279 and this variable is automatically set as necessary.
281 A repository, however, may be on a filesystem that handles
282 the filemode correctly, and this variable is set to 'true'
283 when created, but later may be made accessible from another
284 environment that loses the filemode (e.g. exporting ext4 via
285 CIFS mount, visiting a Cygwin created repository with
286 Git for Windows or Eclipse).
287 In such a case it may be necessary to set this variable to 'false'.
288 See linkgit:git-update-index[1].
290 The default is true (when core.filemode is not specified in the config file).
293 (Windows-only) If true, mark newly-created directories and files whose
294 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
295 directory is hidden, but no other files starting with a dot. The
296 default mode is 'dotGitOnly'.
299 If true, this option enables various workarounds to enable
300 Git to work better on filesystems that are not case sensitive,
301 like FAT. For example, if a directory listing finds
302 "makefile" when Git expects "Makefile", Git will assume
303 it is really the same file, and continue to remember it as
306 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
307 will probe and set core.ignoreCase true if appropriate when the repository
310 core.precomposeUnicode::
311 This option is only used by Mac OS implementation of Git.
312 When core.precomposeUnicode=true, Git reverts the unicode decomposition
313 of filenames done by Mac OS. This is useful when sharing a repository
314 between Mac OS and Linux or Windows.
315 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
316 When false, file names are handled fully transparent by Git,
317 which is backward compatible with older versions of Git.
320 If set to true, do not allow checkout of paths that would
321 be considered equivalent to `.git` on an HFS+ filesystem.
322 Defaults to `true` on Mac OS, and `false` elsewhere.
325 If set to true, do not allow checkout of paths that would
326 cause problems with the NTFS filesystem, e.g. conflict with
328 Defaults to `true` on Windows, and `false` elsewhere.
331 If false, the ctime differences between the index and the
332 working tree are ignored; useful when the inode change time
333 is regularly modified by something outside Git (file system
334 crawlers and some backup systems).
335 See linkgit:git-update-index[1]. True by default.
337 core.untrackedCache::
338 Determines what to do about the untracked cache feature of the
339 index. It will be kept, if this variable is unset or set to
340 `keep`. It will automatically be added if set to `true`. And
341 it will automatically be removed, if set to `false`. Before
342 setting it to `true`, you should check that mtime is working
343 properly on your system.
344 See linkgit:git-update-index[1]. `keep` by default.
347 Determines which stat fields to match between the index
348 and work tree. The user can set this to 'default' or
349 'minimal'. Default (or explicitly 'default'), is to check
350 all fields, including the sub-second part of mtime and ctime.
353 The commands that output paths (e.g. 'ls-files',
354 'diff'), when not given the `-z` option, will quote
355 "unusual" characters in the pathname by enclosing the
356 pathname in a double-quote pair and with backslashes the
357 same way strings in C source code are quoted. If this
358 variable is set to false, the bytes higher than 0x80 are
359 not quoted but output as verbatim. Note that double
360 quote, backslash and control characters are always
361 quoted without `-z` regardless of the setting of this
365 Sets the line ending type to use in the working directory for
366 files that have the `text` property set when core.autocrlf is false.
367 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
368 native line ending. The default value is `native`. See
369 linkgit:gitattributes[5] for more information on end-of-line
373 If true, makes Git check if converting `CRLF` is reversible when
374 end-of-line conversion is active. Git will verify if a command
375 modifies a file in the work tree either directly or indirectly.
376 For example, committing a file followed by checking out the
377 same file should yield the original file in the work tree. If
378 this is not the case for the current setting of
379 `core.autocrlf`, Git will reject the file. The variable can
380 be set to "warn", in which case Git will only warn about an
381 irreversible conversion but continue the operation.
383 CRLF conversion bears a slight chance of corrupting data.
384 When it is enabled, Git will convert CRLF to LF during commit and LF to
385 CRLF during checkout. A file that contains a mixture of LF and
386 CRLF before the commit cannot be recreated by Git. For text
387 files this is the right thing to do: it corrects line endings
388 such that we have only LF line endings in the repository.
389 But for binary files that are accidentally classified as text the
390 conversion can corrupt data.
392 If you recognize such corruption early you can easily fix it by
393 setting the conversion type explicitly in .gitattributes. Right
394 after committing you still have the original file in your work
395 tree and this file is not yet corrupted. You can explicitly tell
396 Git that this file is binary and Git will handle the file
399 Unfortunately, the desired effect of cleaning up text files with
400 mixed line endings and the undesired effect of corrupting binary
401 files cannot be distinguished. In both cases CRLFs are removed
402 in an irreversible way. For text files this is the right thing
403 to do because CRLFs are line endings, while for binary files
404 converting CRLFs corrupts data.
406 Note, this safety check does not mean that a checkout will generate a
407 file identical to the original file for a different setting of
408 `core.eol` and `core.autocrlf`, but only for the current one. For
409 example, a text file with `LF` would be accepted with `core.eol=lf`
410 and could later be checked out with `core.eol=crlf`, in which case the
411 resulting file would contain `CRLF`, although the original file
412 contained `LF`. However, in both work trees the line endings would be
413 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
414 file with mixed line endings would be reported by the `core.safecrlf`
418 Setting this variable to "true" is the same as setting
419 the `text` attribute to "auto" on all files and core.eol to "crlf".
420 Set to true if you want to have `CRLF` line endings in your
421 working directory and the repository has LF line endings.
422 This variable can be set to 'input',
423 in which case no output conversion is performed.
426 If false, symbolic links are checked out as small plain files that
427 contain the link text. linkgit:git-update-index[1] and
428 linkgit:git-add[1] will not change the recorded type to regular
429 file. Useful on filesystems like FAT that do not support
432 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
433 will probe and set core.symlinks false if appropriate when the repository
437 A "proxy command" to execute (as 'command host port') instead
438 of establishing direct connection to the remote server when
439 using the Git protocol for fetching. If the variable value is
440 in the "COMMAND for DOMAIN" format, the command is applied only
441 on hostnames ending with the specified domain string. This variable
442 may be set multiple times and is matched in the given order;
443 the first match wins.
445 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
446 (which always applies universally, without the special "for"
449 The special string `none` can be used as the proxy command to
450 specify that no proxy be used for a given domain pattern.
451 This is useful for excluding servers inside a firewall from
452 proxy use, while defaulting to a common proxy for external domains.
455 If this variable is set, `git fetch` and `git push` will
456 use the specified command instead of `ssh` when they need to
457 connect to a remote system. The command is in the same form as
458 the `GIT_SSH_COMMAND` environment variable and is overridden
459 when the environment variable is set.
462 If true, Git will avoid using lstat() calls to detect if files have
463 changed by setting the "assume-unchanged" bit for those tracked files
464 which it has updated identically in both the index and working tree.
466 When files are modified outside of Git, the user will need to stage
467 the modified files explicitly (e.g. see 'Examples' section in
468 linkgit:git-update-index[1]).
469 Git will not normally detect changes to those files.
471 This is useful on systems where lstat() calls are very slow, such as
472 CIFS/Microsoft Windows.
476 core.preferSymlinkRefs::
477 Instead of the default "symref" format for HEAD
478 and other symbolic reference files, use symbolic links.
479 This is sometimes needed to work with old scripts that
480 expect HEAD to be a symbolic link.
483 If true this repository is assumed to be 'bare' and has no
484 working directory associated with it. If this is the case a
485 number of commands that require a working directory will be
486 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
488 This setting is automatically guessed by linkgit:git-clone[1] or
489 linkgit:git-init[1] when the repository was created. By default a
490 repository that ends in "/.git" is assumed to be not bare (bare =
491 false), while all other repositories are assumed to be bare (bare
495 Set the path to the root of the working tree.
496 If `GIT_COMMON_DIR` environment variable is set, core.worktree
497 is ignored and not used for determining the root of working tree.
498 This can be overridden by the `GIT_WORK_TREE` environment
499 variable and the `--work-tree` command-line option.
500 The value can be an absolute path or relative to the path to
501 the .git directory, which is either specified by --git-dir
502 or GIT_DIR, or automatically discovered.
503 If --git-dir or GIT_DIR is specified but none of
504 --work-tree, GIT_WORK_TREE and core.worktree is specified,
505 the current working directory is regarded as the top level
506 of your working tree.
508 Note that this variable is honored even when set in a configuration
509 file in a ".git" subdirectory of a directory and its value differs
510 from the latter directory (e.g. "/path/to/.git/config" has
511 core.worktree set to "/different/path"), which is most likely a
512 misconfiguration. Running Git commands in the "/path/to" directory will
513 still use "/different/path" as the root of the work tree and can cause
514 confusion unless you know what you are doing (e.g. you are creating a
515 read-only snapshot of the same index to a location different from the
516 repository's usual working tree).
518 core.logAllRefUpdates::
519 Enable the reflog. Updates to a ref <ref> is logged to the file
520 "`$GIT_DIR/logs/<ref>`", by appending the new and old
521 SHA-1, the date/time and the reason of the update, but
522 only when the file exists. If this configuration
523 variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
524 file is automatically created for branch heads (i.e. under
525 refs/heads/), remote refs (i.e. under refs/remotes/),
526 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
528 This information can be used to determine what commit
529 was the tip of a branch "2 days ago".
531 This value is true by default in a repository that has
532 a working directory associated with it, and false by
533 default in a bare repository.
535 core.repositoryFormatVersion::
536 Internal variable identifying the repository format and layout
539 core.sharedRepository::
540 When 'group' (or 'true'), the repository is made shareable between
541 several users in a group (making sure all the files and objects are
542 group-writable). When 'all' (or 'world' or 'everybody'), the
543 repository will be readable by all users, additionally to being
544 group-shareable. When 'umask' (or 'false'), Git will use permissions
545 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
546 files in the repository will have this mode value. '0xxx' will override
547 user's umask value (whereas the other options will only override
548 requested parts of the user's umask value). Examples: '0660' will make
549 the repo read/write-able for the owner and group, but inaccessible to
550 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
551 repository that is group-readable but not group-writable.
552 See linkgit:git-init[1]. False by default.
554 core.warnAmbiguousRefs::
555 If true, Git will warn you if the ref name you passed it is ambiguous
556 and might match multiple refs in the repository. True by default.
559 An integer -1..9, indicating a default compression level.
560 -1 is the zlib default. 0 means no compression,
561 and 1..9 are various speed/size tradeoffs, 9 being slowest.
562 If set, this provides a default to other compression variables,
563 such as `core.looseCompression` and `pack.compression`.
565 core.looseCompression::
566 An integer -1..9, indicating the compression level for objects that
567 are not in a pack file. -1 is the zlib default. 0 means no
568 compression, and 1..9 are various speed/size tradeoffs, 9 being
569 slowest. If not set, defaults to core.compression. If that is
570 not set, defaults to 1 (best speed).
572 core.packedGitWindowSize::
573 Number of bytes of a pack file to map into memory in a
574 single mapping operation. Larger window sizes may allow
575 your system to process a smaller number of large pack files
576 more quickly. Smaller window sizes will negatively affect
577 performance due to increased calls to the operating system's
578 memory manager, but may improve performance when accessing
579 a large number of large pack files.
581 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
582 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
583 be reasonable for all users/operating systems. You probably do
584 not need to adjust this value.
586 Common unit suffixes of 'k', 'm', or 'g' are supported.
588 core.packedGitLimit::
589 Maximum number of bytes to map simultaneously into memory
590 from pack files. If Git needs to access more than this many
591 bytes at once to complete an operation it will unmap existing
592 regions to reclaim virtual address space within the process.
594 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
595 This should be reasonable for all users/operating systems, except on
596 the largest projects. You probably do not need to adjust this value.
598 Common unit suffixes of 'k', 'm', or 'g' are supported.
600 core.deltaBaseCacheLimit::
601 Maximum number of bytes to reserve for caching base objects
602 that may be referenced by multiple deltified objects. By storing the
603 entire decompressed base objects in a cache Git is able
604 to avoid unpacking and decompressing frequently used base
605 objects multiple times.
607 Default is 96 MiB on all platforms. This should be reasonable
608 for all users/operating systems, except on the largest projects.
609 You probably do not need to adjust this value.
611 Common unit suffixes of 'k', 'm', or 'g' are supported.
613 core.bigFileThreshold::
614 Files larger than this size are stored deflated, without
615 attempting delta compression. Storing large files without
616 delta compression avoids excessive memory usage, at the
617 slight expense of increased disk usage. Additionally files
618 larger than this size are always treated as binary.
620 Default is 512 MiB on all platforms. This should be reasonable
621 for most projects as source code and other text files can still
622 be delta compressed, but larger binary media files won't be.
624 Common unit suffixes of 'k', 'm', or 'g' are supported.
627 Specifies the pathname to the file that contains patterns to
628 describe paths that are not meant to be tracked, in addition
629 to '.gitignore' (per-directory) and '.git/info/exclude'.
630 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
631 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
632 is used instead. See linkgit:gitignore[5].
635 Some commands (e.g. svn and http interfaces) that interactively
636 ask for a password can be told to use an external program given
637 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
638 environment variable. If not set, fall back to the value of the
639 `SSH_ASKPASS` environment variable or, failing that, a simple password
640 prompt. The external program shall be given a suitable prompt as
641 command-line argument and write the password on its STDOUT.
643 core.attributesFile::
644 In addition to '.gitattributes' (per-directory) and
645 '.git/info/attributes', Git looks into this file for attributes
646 (see linkgit:gitattributes[5]). Path expansions are made the same
647 way as for `core.excludesFile`. Its default value is
648 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
649 set or empty, `$HOME/.config/git/attributes` is used instead.
652 By default Git will look for your hooks in the
653 '$GIT_DIR/hooks' directory. Set this to different path,
654 e.g. '/etc/git/hooks', and Git will try to find your hooks in
655 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
656 in '$GIT_DIR/hooks/pre-receive'.
658 The path can be either absolute or relative. A relative path is
659 taken as relative to the directory where the hooks are run (see
660 the "DESCRIPTION" section of linkgit:githooks[5]).
662 This configuration variable is useful in cases where you'd like to
663 centrally configure your Git hooks instead of configuring them on a
664 per-repository basis, or as a more flexible and centralized
665 alternative to having an `init.templateDir` where you've changed
669 Commands such as `commit` and `tag` that lets you edit
670 messages by launching an editor uses the value of this
671 variable when it is set, and the environment variable
672 `GIT_EDITOR` is not set. See linkgit:git-var[1].
675 Commands such as `commit` and `tag` that lets you edit
676 messages consider a line that begins with this character
677 commented, and removes them after the editor returns
680 If set to "auto", `git-commit` would select a character that is not
681 the beginning character of any line in existing commit messages.
683 core.packedRefsTimeout::
684 The length of time, in milliseconds, to retry when trying to
685 lock the `packed-refs` file. Value 0 means not to retry at
686 all; -1 means to try indefinitely. Default is 1000 (i.e.,
690 Text editor used by `git rebase -i` for editing the rebase instruction file.
691 The value is meant to be interpreted by the shell when it is used.
692 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
693 When not configured the default commit message editor is used instead.
696 Text viewer for use by Git commands (e.g., 'less'). The value
697 is meant to be interpreted by the shell. The order of preference
698 is the `$GIT_PAGER` environment variable, then `core.pager`
699 configuration, then `$PAGER`, and then the default chosen at
700 compile time (usually 'less').
702 When the `LESS` environment variable is unset, Git sets it to `FRX`
703 (if `LESS` environment variable is set, Git does not change it at
704 all). If you want to selectively override Git's default setting
705 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
706 be passed to the shell by Git, which will translate the final
707 command to `LESS=FRX less -S`. The environment does not set the
708 `S` option but the command line does, instructing less to truncate
709 long lines. Similarly, setting `core.pager` to `less -+F` will
710 deactivate the `F` option specified by the environment from the
711 command-line, deactivating the "quit if one screen" behavior of
712 `less`. One can specifically activate some flags for particular
713 commands: for example, setting `pager.blame` to `less -S` enables
714 line truncation only for `git blame`.
716 Likewise, when the `LV` environment variable is unset, Git sets it
717 to `-c`. You can override this setting by exporting `LV` with
718 another value or setting `core.pager` to `lv +c`.
721 A comma separated list of common whitespace problems to
722 notice. 'git diff' will use `color.diff.whitespace` to
723 highlight them, and 'git apply --whitespace=error' will
724 consider them as errors. You can prefix `-` to disable
725 any of them (e.g. `-trailing-space`):
727 * `blank-at-eol` treats trailing whitespaces at the end of the line
728 as an error (enabled by default).
729 * `space-before-tab` treats a space character that appears immediately
730 before a tab character in the initial indent part of the line as an
731 error (enabled by default).
732 * `indent-with-non-tab` treats a line that is indented with space
733 characters instead of the equivalent tabs as an error (not enabled by
735 * `tab-in-indent` treats a tab character in the initial indent part of
736 the line as an error (not enabled by default).
737 * `blank-at-eof` treats blank lines added at the end of file as an error
738 (enabled by default).
739 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
741 * `cr-at-eol` treats a carriage-return at the end of line as
742 part of the line terminator, i.e. with it, `trailing-space`
743 does not trigger if the character before such a carriage-return
744 is not a whitespace (not enabled by default).
745 * `tabwidth=<n>` tells how many character positions a tab occupies; this
746 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
747 errors. The default tab width is 8. Allowed values are 1 to 63.
749 core.fsyncObjectFiles::
750 This boolean will enable 'fsync()' when writing object files.
752 This is a total waste of time and effort on a filesystem that orders
753 data writes properly, but can be useful for filesystems that do not use
754 journalling (traditional UNIX filesystems) or that only journal metadata
755 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
758 Enable parallel index preload for operations like 'git diff'
760 This can speed up operations like 'git diff' and 'git status' especially
761 on filesystems like NFS that have weak caching semantics and thus
762 relatively high IO latencies. When enabled, Git will do the
763 index comparison to the filesystem data in parallel, allowing
764 overlapping IO's. Defaults to true.
767 You can set this to 'link', in which case a hardlink followed by
768 a delete of the source are used to make sure that object creation
769 will not overwrite existing objects.
771 On some file system/operating system combinations, this is unreliable.
772 Set this config setting to 'rename' there; However, This will remove the
773 check that makes sure that existing object files will not get overwritten.
776 When showing commit messages, also show notes which are stored in
777 the given ref. The ref must be fully qualified. If the given
778 ref does not exist, it is not an error but means that no
779 notes should be printed.
781 This setting defaults to "refs/notes/commits", and it can be overridden by
782 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
784 core.sparseCheckout::
785 Enable "sparse checkout" feature. See section "Sparse checkout" in
786 linkgit:git-read-tree[1] for more information.
789 Set the length object names are abbreviated to. If
790 unspecified or set to "auto", an appropriate value is
791 computed based on the approximate number of packed objects
792 in your repository, which hopefully is enough for
793 abbreviated object names to stay unique for some time.
796 add.ignore-errors (deprecated)::
797 Tells 'git add' to continue adding files when some files cannot be
798 added due to indexing errors. Equivalent to the `--ignore-errors`
799 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
800 as it does not follow the usual naming convention for configuration
804 Command aliases for the linkgit:git[1] command wrapper - e.g.
805 after defining "alias.last = cat-file commit HEAD", the invocation
806 "git last" is equivalent to "git cat-file commit HEAD". To avoid
807 confusion and troubles with script usage, aliases that
808 hide existing Git commands are ignored. Arguments are split by
809 spaces, the usual shell quoting and escaping is supported.
810 A quote pair or a backslash can be used to quote them.
812 If the alias expansion is prefixed with an exclamation point,
813 it will be treated as a shell command. For example, defining
814 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
815 "git new" is equivalent to running the shell command
816 "gitk --all --not ORIG_HEAD". Note that shell commands will be
817 executed from the top-level directory of a repository, which may
818 not necessarily be the current directory.
819 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
820 from the original current directory. See linkgit:git-rev-parse[1].
823 If true, git-am will call git-mailsplit for patches in mbox format
824 with parameter `--keep-cr`. In this case git-mailsplit will
825 not remove `\r` from lines ending with `\r\n`. Can be overridden
826 by giving `--no-keep-cr` from the command line.
827 See linkgit:git-am[1], linkgit:git-mailsplit[1].
830 By default, `git am` will fail if the patch does not apply cleanly. When
831 set to true, this setting tells `git am` to fall back on 3-way merge if
832 the patch records the identity of blobs it is supposed to apply to and
833 we have those blobs available locally (equivalent to giving the `--3way`
834 option from the command line). Defaults to `false`.
835 See linkgit:git-am[1].
837 apply.ignoreWhitespace::
838 When set to 'change', tells 'git apply' to ignore changes in
839 whitespace, in the same way as the `--ignore-space-change`
841 When set to one of: no, none, never, false tells 'git apply' to
842 respect all whitespace differences.
843 See linkgit:git-apply[1].
846 Tells 'git apply' how to handle whitespaces, in the same way
847 as the `--whitespace` option. See linkgit:git-apply[1].
849 branch.autoSetupMerge::
850 Tells 'git branch' and 'git checkout' to set up new branches
851 so that linkgit:git-pull[1] will appropriately merge from the
852 starting point branch. Note that even if this option is not set,
853 this behavior can be chosen per-branch using the `--track`
854 and `--no-track` options. The valid settings are: `false` -- no
855 automatic setup is done; `true` -- automatic setup is done when the
856 starting point is a remote-tracking branch; `always` --
857 automatic setup is done when the starting point is either a
858 local branch or remote-tracking
859 branch. This option defaults to true.
861 branch.autoSetupRebase::
862 When a new branch is created with 'git branch' or 'git checkout'
863 that tracks another branch, this variable tells Git to set
864 up pull to rebase instead of merge (see "branch.<name>.rebase").
865 When `never`, rebase is never automatically set to true.
866 When `local`, rebase is set to true for tracked branches of
867 other local branches.
868 When `remote`, rebase is set to true for tracked branches of
869 remote-tracking branches.
870 When `always`, rebase will be set to true for all tracking
872 See "branch.autoSetupMerge" for details on how to set up a
873 branch to track another branch.
874 This option defaults to never.
876 branch.<name>.remote::
877 When on branch <name>, it tells 'git fetch' and 'git push'
878 which remote to fetch from/push to. The remote to push to
879 may be overridden with `remote.pushDefault` (for all branches).
880 The remote to push to, for the current branch, may be further
881 overridden by `branch.<name>.pushRemote`. If no remote is
882 configured, or if you are not on any branch, it defaults to
883 `origin` for fetching and `remote.pushDefault` for pushing.
884 Additionally, `.` (a period) is the current local repository
885 (a dot-repository), see `branch.<name>.merge`'s final note below.
887 branch.<name>.pushRemote::
888 When on branch <name>, it overrides `branch.<name>.remote` for
889 pushing. It also overrides `remote.pushDefault` for pushing
890 from branch <name>. When you pull from one place (e.g. your
891 upstream) and push to another place (e.g. your own publishing
892 repository), you would want to set `remote.pushDefault` to
893 specify the remote to push to for all branches, and use this
894 option to override it for a specific branch.
896 branch.<name>.merge::
897 Defines, together with branch.<name>.remote, the upstream branch
898 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
899 branch to merge and can also affect 'git push' (see push.default).
900 When in branch <name>, it tells 'git fetch' the default
901 refspec to be marked for merging in FETCH_HEAD. The value is
902 handled like the remote part of a refspec, and must match a
903 ref which is fetched from the remote given by
904 "branch.<name>.remote".
905 The merge information is used by 'git pull' (which at first calls
906 'git fetch') to lookup the default branch for merging. Without
907 this option, 'git pull' defaults to merge the first refspec fetched.
908 Specify multiple values to get an octopus merge.
909 If you wish to setup 'git pull' so that it merges into <name> from
910 another branch in the local repository, you can point
911 branch.<name>.merge to the desired branch, and use the relative path
912 setting `.` (a period) for branch.<name>.remote.
914 branch.<name>.mergeOptions::
915 Sets default options for merging into branch <name>. The syntax and
916 supported options are the same as those of linkgit:git-merge[1], but
917 option values containing whitespace characters are currently not
920 branch.<name>.rebase::
921 When true, rebase the branch <name> on top of the fetched branch,
922 instead of merging the default branch from the default remote when
923 "git pull" is run. See "pull.rebase" for doing this in a non
924 branch-specific manner.
926 When preserve, also pass `--preserve-merges` along to 'git rebase'
927 so that locally committed merge commits will not be flattened
928 by running 'git pull'.
930 When the value is `interactive`, the rebase is run in interactive mode.
932 *NOTE*: this is a possibly dangerous operation; do *not* use
933 it unless you understand the implications (see linkgit:git-rebase[1]
936 branch.<name>.description::
937 Branch description, can be edited with
938 `git branch --edit-description`. Branch description is
939 automatically added in the format-patch cover letter or
940 request-pull summary.
943 Specify the command to invoke the specified browser. The
944 specified command is evaluated in shell with the URLs passed
945 as arguments. (See linkgit:git-web{litdd}browse[1].)
947 browser.<tool>.path::
948 Override the path for the given tool that may be used to
949 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
950 working repository in gitweb (see linkgit:git-instaweb[1]).
953 A boolean to make git-clean do nothing unless given -f,
954 -i or -n. Defaults to true.
957 A boolean to enable/disable color in the output of
958 linkgit:git-branch[1]. May be set to `always`,
959 `false` (or `never`) or `auto` (or `true`), in which case colors are used
960 only when the output is to a terminal. If unset, then the
961 value of `color.ui` is used (`auto` by default).
963 color.branch.<slot>::
964 Use customized color for branch coloration. `<slot>` is one of
965 `current` (the current branch), `local` (a local branch),
966 `remote` (a remote-tracking branch in refs/remotes/),
967 `upstream` (upstream tracking branch), `plain` (other
971 Whether to use ANSI escape sequences to add color to patches.
972 If this is set to `always`, linkgit:git-diff[1],
973 linkgit:git-log[1], and linkgit:git-show[1] will use color
974 for all patches. If it is set to `true` or `auto`, those
975 commands will only use color when output is to the terminal.
976 If unset, then the value of `color.ui` is used (`auto` by
979 This does not affect linkgit:git-format-patch[1] or the
980 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
981 command line with the `--color[=<when>]` option.
984 Use customized color for diff colorization. `<slot>` specifies
985 which part of the patch to use the specified color, and is one
986 of `context` (context text - `plain` is a historical synonym),
987 `meta` (metainformation), `frag`
988 (hunk header), 'func' (function in hunk header), `old` (removed lines),
989 `new` (added lines), `commit` (commit headers), or `whitespace`
990 (highlighting whitespace errors).
992 color.decorate.<slot>::
993 Use customized color for 'git log --decorate' output. `<slot>` is one
994 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
995 branches, remote-tracking branches, tags, stash and HEAD, respectively.
998 When set to `always`, always highlight matches. When `false` (or
999 `never`), never. When set to `true` or `auto`, use color only
1000 when the output is written to the terminal. If unset, then the
1001 value of `color.ui` is used (`auto` by default).
1004 Use customized color for grep colorization. `<slot>` specifies which
1005 part of the line to use the specified color, and is one of
1009 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1011 filename prefix (when not using `-h`)
1013 function name lines (when using `-p`)
1015 line number prefix (when using `-n`)
1017 matching text (same as setting `matchContext` and `matchSelected`)
1019 matching text in context lines
1021 matching text in selected lines
1023 non-matching text in selected lines
1025 separators between fields on a line (`:`, `-`, and `=`)
1026 and between hunks (`--`)
1030 When set to `always`, always use colors for interactive prompts
1031 and displays (such as those used by "git-add --interactive" and
1032 "git-clean --interactive"). When false (or `never`), never.
1033 When set to `true` or `auto`, use colors only when the output is
1034 to the terminal. If unset, then the value of `color.ui` is
1035 used (`auto` by default).
1037 color.interactive.<slot>::
1038 Use customized color for 'git add --interactive' and 'git clean
1039 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1040 or `error`, for four distinct types of normal output from
1041 interactive commands.
1044 A boolean to enable/disable colored output when the pager is in
1045 use (default is true).
1048 A boolean to enable/disable color in the output of
1049 linkgit:git-show-branch[1]. May be set to `always`,
1050 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1051 only when the output is to a terminal. If unset, then the
1052 value of `color.ui` is used (`auto` by default).
1055 A boolean to enable/disable color in the output of
1056 linkgit:git-status[1]. May be set to `always`,
1057 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1058 only when the output is to a terminal. If unset, then the
1059 value of `color.ui` is used (`auto` by default).
1061 color.status.<slot>::
1062 Use customized color for status colorization. `<slot>` is
1063 one of `header` (the header text of the status message),
1064 `added` or `updated` (files which are added but not committed),
1065 `changed` (files which are changed but not added in the index),
1066 `untracked` (files which are not tracked by Git),
1067 `branch` (the current branch),
1068 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1070 `unmerged` (files which have unmerged changes).
1073 This variable determines the default value for variables such
1074 as `color.diff` and `color.grep` that control the use of color
1075 per command family. Its scope will expand as more commands learn
1076 configuration to set a default for the `--color` option. Set it
1077 to `false` or `never` if you prefer Git commands not to use
1078 color unless enabled explicitly with some other configuration
1079 or the `--color` option. Set it to `always` if you want all
1080 output not intended for machine consumption to use color, to
1081 `true` or `auto` (this is the default since Git 1.8.4) if you
1082 want such output to use color when written to the terminal.
1085 Specify whether supported commands should output in columns.
1086 This variable consists of a list of tokens separated by spaces
1089 These options control when the feature should be enabled
1090 (defaults to 'never'):
1094 always show in columns
1096 never show in columns
1098 show in columns if the output is to the terminal
1101 These options control layout (defaults to 'column'). Setting any
1102 of these implies 'always' if none of 'always', 'never', or 'auto' are
1107 fill columns before rows
1109 fill rows before columns
1114 Finally, these options can be combined with a layout option (defaults
1119 make unequal size columns to utilize more space
1121 make equal size columns
1125 Specify whether to output branch listing in `git branch` in columns.
1126 See `column.ui` for details.
1129 Specify the layout when list items in `git clean -i`, which always
1130 shows files and directories in columns. See `column.ui` for details.
1133 Specify whether to output untracked files in `git status` in columns.
1134 See `column.ui` for details.
1137 Specify whether to output tag listing in `git tag` in columns.
1138 See `column.ui` for details.
1141 This setting overrides the default of the `--cleanup` option in
1142 `git commit`. See linkgit:git-commit[1] for details. Changing the
1143 default can be useful when you always want to keep lines that begin
1144 with comment character `#` in your log message, in which case you
1145 would do `git config commit.cleanup whitespace` (note that you will
1146 have to remove the help lines that begin with `#` in the commit log
1147 template yourself, if you do this).
1151 A boolean to specify whether all commits should be GPG signed.
1152 Use of this option when doing operations such as rebase can
1153 result in a large number of commits being signed. It may be
1154 convenient to use an agent to avoid typing your GPG passphrase
1158 A boolean to enable/disable inclusion of status information in the
1159 commit message template when using an editor to prepare the commit
1160 message. Defaults to true.
1163 Specify the pathname of a file to use as the template for
1164 new commit messages.
1167 A boolean or int to specify the level of verbose with `git commit`.
1168 See linkgit:git-commit[1].
1171 Specify an external helper to be called when a username or
1172 password credential is needed; the helper may consult external
1173 storage to avoid prompting the user for the credentials. Note
1174 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1177 credential.useHttpPath::
1178 When acquiring credentials, consider the "path" component of an http
1179 or https URL to be important. Defaults to false. See
1180 linkgit:gitcredentials[7] for more information.
1182 credential.username::
1183 If no username is set for a network authentication, use this username
1184 by default. See credential.<context>.* below, and
1185 linkgit:gitcredentials[7].
1187 credential.<url>.*::
1188 Any of the credential.* options above can be applied selectively to
1189 some credentials. For example "credential.https://example.com.username"
1190 would set the default username only for https connections to
1191 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1194 credentialCache.ignoreSIGHUP::
1195 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1197 include::diff-config.txt[]
1199 difftool.<tool>.path::
1200 Override the path for the given tool. This is useful in case
1201 your tool is not in the PATH.
1203 difftool.<tool>.cmd::
1204 Specify the command to invoke the specified diff tool.
1205 The specified command is evaluated in shell with the following
1206 variables available: 'LOCAL' is set to the name of the temporary
1207 file containing the contents of the diff pre-image and 'REMOTE'
1208 is set to the name of the temporary file containing the contents
1209 of the diff post-image.
1212 Prompt before each invocation of the diff tool.
1214 fastimport.unpackLimit::
1215 If the number of objects imported by linkgit:git-fast-import[1]
1216 is below this limit, then the objects will be unpacked into
1217 loose object files. However if the number of imported objects
1218 equals or exceeds this limit then the pack will be stored as a
1219 pack. Storing the pack from a fast-import can make the import
1220 operation complete faster, especially on slow filesystems. If
1221 not set, the value of `transfer.unpackLimit` is used instead.
1223 fetch.recurseSubmodules::
1224 This option can be either set to a boolean value or to 'on-demand'.
1225 Setting it to a boolean changes the behavior of fetch and pull to
1226 unconditionally recurse into submodules when set to true or to not
1227 recurse at all when set to false. When set to 'on-demand' (the default
1228 value), fetch and pull will only recurse into a populated submodule
1229 when its superproject retrieves a commit that updates the submodule's
1233 If it is set to true, git-fetch-pack will check all fetched
1234 objects. It will abort in the case of a malformed object or a
1235 broken link. The result of an abort are only dangling objects.
1236 Defaults to false. If not set, the value of `transfer.fsckObjects`
1240 If the number of objects fetched over the Git native
1241 transfer is below this
1242 limit, then the objects will be unpacked into loose object
1243 files. However if the number of received objects equals or
1244 exceeds this limit then the received pack will be stored as
1245 a pack, after adding any missing delta bases. Storing the
1246 pack from a push can make the push operation complete faster,
1247 especially on slow filesystems. If not set, the value of
1248 `transfer.unpackLimit` is used instead.
1251 If true, fetch will automatically behave as if the `--prune`
1252 option was given on the command line. See also `remote.<name>.prune`.
1255 Control how ref update status is printed. Valid values are
1256 `full` and `compact`. Default value is `full`. See section
1257 OUTPUT in linkgit:git-fetch[1] for detail.
1260 Enable multipart/mixed attachments as the default for
1261 'format-patch'. The value can also be a double quoted string
1262 which will enable attachments as the default and set the
1263 value as the boundary. See the --attach option in
1264 linkgit:git-format-patch[1].
1267 Provides the default value for the `--from` option to format-patch.
1268 Accepts a boolean value, or a name and email address. If false,
1269 format-patch defaults to `--no-from`, using commit authors directly in
1270 the "From:" field of patch mails. If true, format-patch defaults to
1271 `--from`, using your committer identity in the "From:" field of patch
1272 mails and including a "From:" field in the body of the patch mail if
1273 different. If set to a non-boolean value, format-patch uses that
1274 value instead of your committer identity. Defaults to false.
1277 A boolean which can enable or disable sequence numbers in patch
1278 subjects. It defaults to "auto" which enables it only if there
1279 is more than one patch. It can be enabled or disabled for all
1280 messages by setting it to "true" or "false". See --numbered
1281 option in linkgit:git-format-patch[1].
1284 Additional email headers to include in a patch to be submitted
1285 by mail. See linkgit:git-format-patch[1].
1289 Additional recipients to include in a patch to be submitted
1290 by mail. See the --to and --cc options in
1291 linkgit:git-format-patch[1].
1293 format.subjectPrefix::
1294 The default for format-patch is to output files with the '[PATCH]'
1295 subject prefix. Use this variable to change that prefix.
1298 The default for format-patch is to output a signature containing
1299 the Git version number. Use this variable to change that default.
1300 Set this variable to the empty string ("") to suppress
1301 signature generation.
1303 format.signatureFile::
1304 Works just like format.signature except the contents of the
1305 file specified by this variable will be used as the signature.
1308 The default for format-patch is to output files with the suffix
1309 `.patch`. Use this variable to change that suffix (make sure to
1310 include the dot if you want it).
1313 The default pretty format for log/show/whatchanged command,
1314 See linkgit:git-log[1], linkgit:git-show[1],
1315 linkgit:git-whatchanged[1].
1318 The default threading style for 'git format-patch'. Can be
1319 a boolean value, or `shallow` or `deep`. `shallow` threading
1320 makes every mail a reply to the head of the series,
1321 where the head is chosen from the cover letter, the
1322 `--in-reply-to`, and the first patch mail, in this order.
1323 `deep` threading makes every mail a reply to the previous one.
1324 A true boolean value is the same as `shallow`, and a false
1325 value disables threading.
1328 A boolean value which lets you enable the `-s/--signoff` option of
1329 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1330 patch should be a conscious act and means that you certify you have
1331 the rights to submit this work under the same open source license.
1332 Please see the 'SubmittingPatches' document for further discussion.
1334 format.coverLetter::
1335 A boolean that controls whether to generate a cover-letter when
1336 format-patch is invoked, but in addition can be set to "auto", to
1337 generate a cover-letter only when there's more than one patch.
1339 format.outputDirectory::
1340 Set a custom directory to store the resulting files instead of the
1341 current working directory.
1343 format.useAutoBase::
1344 A boolean value which lets you enable the `--base=auto` option of
1345 format-patch by default.
1347 filter.<driver>.clean::
1348 The command which is used to convert the content of a worktree
1349 file to a blob upon checkin. See linkgit:gitattributes[5] for
1352 filter.<driver>.smudge::
1353 The command which is used to convert the content of a blob
1354 object to a worktree file upon checkout. See
1355 linkgit:gitattributes[5] for details.
1358 Allows overriding the message type (error, warn or ignore) of a
1359 specific message ID such as `missingEmail`.
1361 For convenience, fsck prefixes the error/warning with the message ID,
1362 e.g. "missingEmail: invalid author/committer line - missing email" means
1363 that setting `fsck.missingEmail = ignore` will hide that issue.
1365 This feature is intended to support working with legacy repositories
1366 which cannot be repaired without disruptive changes.
1369 The path to a sorted list of object names (i.e. one SHA-1 per
1370 line) that are known to be broken in a non-fatal way and should
1371 be ignored. This feature is useful when an established project
1372 should be accepted despite early commits containing errors that
1373 can be safely ignored such as invalid committer email addresses.
1374 Note: corrupt objects cannot be skipped with this setting.
1376 gc.aggressiveDepth::
1377 The depth parameter used in the delta compression
1378 algorithm used by 'git gc --aggressive'. This defaults
1381 gc.aggressiveWindow::
1382 The window size parameter used in the delta compression
1383 algorithm used by 'git gc --aggressive'. This defaults
1387 When there are approximately more than this many loose
1388 objects in the repository, `git gc --auto` will pack them.
1389 Some Porcelain commands use this command to perform a
1390 light-weight garbage collection from time to time. The
1391 default value is 6700. Setting this to 0 disables it.
1394 When there are more than this many packs that are not
1395 marked with `*.keep` file in the repository, `git gc
1396 --auto` consolidates them into one larger pack. The
1397 default value is 50. Setting this to 0 disables it.
1400 Make `git gc --auto` return immediately and run in background
1401 if the system supports it. Default is true.
1404 Running `git pack-refs` in a repository renders it
1405 unclonable by Git versions prior to 1.5.1.2 over dumb
1406 transports such as HTTP. This variable determines whether
1407 'git gc' runs `git pack-refs`. This can be set to `notbare`
1408 to enable it within all non-bare repos or it can be set to a
1409 boolean value. The default is `true`.
1412 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1413 Override the grace period with this config variable. The value
1414 "now" may be used to disable this grace period and always prune
1415 unreachable objects immediately, or "never" may be used to
1416 suppress pruning. This feature helps prevent corruption when
1417 'git gc' runs concurrently with another process writing to the
1418 repository; see the "NOTES" section of linkgit:git-gc[1].
1420 gc.worktreePruneExpire::
1421 When 'git gc' is run, it calls
1422 'git worktree prune --expire 3.months.ago'.
1423 This config variable can be used to set a different grace
1424 period. The value "now" may be used to disable the grace
1425 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1426 may be used to suppress pruning.
1429 gc.<pattern>.reflogExpire::
1430 'git reflog expire' removes reflog entries older than
1431 this time; defaults to 90 days. The value "now" expires all
1432 entries immediately, and "never" suppresses expiration
1433 altogether. With "<pattern>" (e.g.
1434 "refs/stash") in the middle the setting applies only to
1435 the refs that match the <pattern>.
1437 gc.reflogExpireUnreachable::
1438 gc.<pattern>.reflogExpireUnreachable::
1439 'git reflog expire' removes reflog entries older than
1440 this time and are not reachable from the current tip;
1441 defaults to 30 days. The value "now" expires all entries
1442 immediately, and "never" suppresses expiration altogether.
1443 With "<pattern>" (e.g. "refs/stash")
1444 in the middle, the setting applies only to the refs that
1445 match the <pattern>.
1448 Records of conflicted merge you resolved earlier are
1449 kept for this many days when 'git rerere gc' is run.
1450 The default is 60 days. See linkgit:git-rerere[1].
1452 gc.rerereUnresolved::
1453 Records of conflicted merge you have not resolved are
1454 kept for this many days when 'git rerere gc' is run.
1455 The default is 15 days. See linkgit:git-rerere[1].
1457 gitcvs.commitMsgAnnotation::
1458 Append this string to each commit message. Set to empty string
1459 to disable this feature. Defaults to "via git-CVS emulator".
1462 Whether the CVS server interface is enabled for this repository.
1463 See linkgit:git-cvsserver[1].
1466 Path to a log file where the CVS server interface well... logs
1467 various stuff. See linkgit:git-cvsserver[1].
1469 gitcvs.usecrlfattr::
1470 If true, the server will look up the end-of-line conversion
1471 attributes for files to determine the `-k` modes to use. If
1472 the attributes force Git to treat a file as text,
1473 the `-k` mode will be left blank so CVS clients will
1474 treat it as text. If they suppress text conversion, the file
1475 will be set with '-kb' mode, which suppresses any newline munging
1476 the client might otherwise do. If the attributes do not allow
1477 the file type to be determined, then `gitcvs.allBinary` is
1478 used. See linkgit:gitattributes[5].
1481 This is used if `gitcvs.usecrlfattr` does not resolve
1482 the correct '-kb' mode to use. If true, all
1483 unresolved files are sent to the client in
1484 mode '-kb'. This causes the client to treat them
1485 as binary files, which suppresses any newline munging it
1486 otherwise might do. Alternatively, if it is set to "guess",
1487 then the contents of the file are examined to decide if
1488 it is binary, similar to `core.autocrlf`.
1491 Database used by git-cvsserver to cache revision information
1492 derived from the Git repository. The exact meaning depends on the
1493 used database driver, for SQLite (which is the default driver) this
1494 is a filename. Supports variable substitution (see
1495 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1496 Default: '%Ggitcvs.%m.sqlite'
1499 Used Perl DBI driver. You can specify any available driver
1500 for this here, but it might not work. git-cvsserver is tested
1501 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1502 reported *not* to work with 'DBD::mysql'. Experimental feature.
1503 May not contain double colons (`:`). Default: 'SQLite'.
1504 See linkgit:git-cvsserver[1].
1506 gitcvs.dbUser, gitcvs.dbPass::
1507 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1508 since SQLite has no concept of database users and/or passwords.
1509 'gitcvs.dbUser' supports variable substitution (see
1510 linkgit:git-cvsserver[1] for details).
1512 gitcvs.dbTableNamePrefix::
1513 Database table name prefix. Prepended to the names of any
1514 database tables used, allowing a single database to be used
1515 for several repositories. Supports variable substitution (see
1516 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1517 characters will be replaced with underscores.
1519 All gitcvs variables except for `gitcvs.usecrlfattr` and
1520 `gitcvs.allBinary` can also be specified as
1521 'gitcvs.<access_method>.<varname>' (where 'access_method'
1522 is one of "ext" and "pserver") to make them apply only for the given
1526 gitweb.description::
1529 See linkgit:gitweb[1] for description.
1537 gitweb.remote_heads::
1540 See linkgit:gitweb.conf[5] for description.
1543 If set to true, enable `-n` option by default.
1546 Set the default matching behavior. Using a value of 'basic', 'extended',
1547 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1548 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1549 value 'default' will return to the default matching behavior.
1551 grep.extendedRegexp::
1552 If set to true, enable `--extended-regexp` option by default. This
1553 option is ignored when the `grep.patternType` option is set to a value
1554 other than 'default'.
1557 Number of grep worker threads to use.
1558 See `grep.threads` in linkgit:git-grep[1] for more information.
1560 grep.fallbackToNoIndex::
1561 If set to true, fall back to git grep --no-index if git grep
1562 is executed outside of a git repository. Defaults to false.
1565 Use this custom program instead of "`gpg`" found on `$PATH` when
1566 making or verifying a PGP signature. The program must support the
1567 same command-line interface as GPG, namely, to verify a detached
1568 signature, "`gpg --verify $file - <$signature`" is run, and the
1569 program is expected to signal a good signature by exiting with
1570 code 0, and to generate an ASCII-armored detached signature, the
1571 standard input of "`gpg -bsau $key`" is fed with the contents to be
1572 signed, and the program is expected to send the result to its
1575 gui.commitMsgWidth::
1576 Defines how wide the commit message window is in the
1577 linkgit:git-gui[1]. "75" is the default.
1580 Specifies how many context lines should be used in calls to diff
1581 made by the linkgit:git-gui[1]. The default is "5".
1583 gui.displayUntracked::
1584 Determines if linkgit:git-gui[1] shows untracked files
1585 in the file list. The default is "true".
1588 Specifies the default encoding to use for displaying of
1589 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1590 It can be overridden by setting the 'encoding' attribute
1591 for relevant files (see linkgit:gitattributes[5]).
1592 If this option is not set, the tools default to the
1595 gui.matchTrackingBranch::
1596 Determines if new branches created with linkgit:git-gui[1] should
1597 default to tracking remote branches with matching names or
1598 not. Default: "false".
1600 gui.newBranchTemplate::
1601 Is used as suggested name when creating new branches using the
1604 gui.pruneDuringFetch::
1605 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1606 performing a fetch. The default value is "false".
1609 Determines if linkgit:git-gui[1] should trust the file modification
1610 timestamp or not. By default the timestamps are not trusted.
1612 gui.spellingDictionary::
1613 Specifies the dictionary used for spell checking commit messages in
1614 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1618 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1619 location detection. It makes blame significantly faster on huge
1620 repositories at the expense of less thorough copy detection.
1622 gui.copyBlameThreshold::
1623 Specifies the threshold to use in 'git gui blame' original location
1624 detection, measured in alphanumeric characters. See the
1625 linkgit:git-blame[1] manual for more information on copy detection.
1627 gui.blamehistoryctx::
1628 Specifies the radius of history context in days to show in
1629 linkgit:gitk[1] for the selected commit, when the `Show History
1630 Context` menu item is invoked from 'git gui blame'. If this
1631 variable is set to zero, the whole history is shown.
1633 guitool.<name>.cmd::
1634 Specifies the shell command line to execute when the corresponding item
1635 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1636 mandatory for every tool. The command is executed from the root of
1637 the working directory, and in the environment it receives the name of
1638 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1639 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1640 the head is detached, 'CUR_BRANCH' is empty).
1642 guitool.<name>.needsFile::
1643 Run the tool only if a diff is selected in the GUI. It guarantees
1644 that 'FILENAME' is not empty.
1646 guitool.<name>.noConsole::
1647 Run the command silently, without creating a window to display its
1650 guitool.<name>.noRescan::
1651 Don't rescan the working directory for changes after the tool
1654 guitool.<name>.confirm::
1655 Show a confirmation dialog before actually running the tool.
1657 guitool.<name>.argPrompt::
1658 Request a string argument from the user, and pass it to the tool
1659 through the `ARGS` environment variable. Since requesting an
1660 argument implies confirmation, the 'confirm' option has no effect
1661 if this is enabled. If the option is set to 'true', 'yes', or '1',
1662 the dialog uses a built-in generic prompt; otherwise the exact
1663 value of the variable is used.
1665 guitool.<name>.revPrompt::
1666 Request a single valid revision from the user, and set the
1667 `REVISION` environment variable. In other aspects this option
1668 is similar to 'argPrompt', and can be used together with it.
1670 guitool.<name>.revUnmerged::
1671 Show only unmerged branches in the 'revPrompt' subdialog.
1672 This is useful for tools similar to merge or rebase, but not
1673 for things like checkout or reset.
1675 guitool.<name>.title::
1676 Specifies the title to use for the prompt dialog. The default
1679 guitool.<name>.prompt::
1680 Specifies the general prompt string to display at the top of
1681 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1682 The default value includes the actual command.
1685 Specify the browser that will be used to display help in the
1686 'web' format. See linkgit:git-help[1].
1689 Override the default help format used by linkgit:git-help[1].
1690 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1691 the default. 'web' and 'html' are the same.
1694 Automatically correct and execute mistyped commands after
1695 waiting for the given number of deciseconds (0.1 sec). If more
1696 than one command can be deduced from the entered text, nothing
1697 will be executed. If the value of this option is negative,
1698 the corrected command will be executed immediately. If the
1699 value is 0 - the command will be just shown but not executed.
1700 This is the default.
1703 Specify the path where the HTML documentation resides. File system paths
1704 and URLs are supported. HTML pages will be prefixed with this path when
1705 help is displayed in the 'web' format. This defaults to the documentation
1706 path of your Git installation.
1709 Override the HTTP proxy, normally configured using the 'http_proxy',
1710 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1711 addition to the syntax understood by curl, it is possible to specify a
1712 proxy string with a user name but no password, in which case git will
1713 attempt to acquire one in the same way it does for other credentials. See
1714 linkgit:gitcredentials[7] for more information. The syntax thus is
1715 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1716 on a per-remote basis; see remote.<name>.proxy
1718 http.proxyAuthMethod::
1719 Set the method with which to authenticate against the HTTP proxy. This
1720 only takes effect if the configured proxy string contains a user name part
1721 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1722 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1723 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1724 variable. Possible values are:
1727 * `anyauth` - Automatically pick a suitable authentication method. It is
1728 assumed that the proxy answers an unauthenticated request with a 407
1729 status code and one or more Proxy-authenticate headers with supported
1730 authentication methods. This is the default.
1731 * `basic` - HTTP Basic authentication
1732 * `digest` - HTTP Digest authentication; this prevents the password from being
1733 transmitted to the proxy in clear text
1734 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1736 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1740 Attempt authentication without seeking a username or password. This
1741 can be used to attempt GSS-Negotiate authentication without specifying
1742 a username in the URL, as libcurl normally requires a username for
1746 Control GSSAPI credential delegation. The delegation is disabled
1747 by default in libcurl since version 7.21.7. Set parameter to tell
1748 the server what it is allowed to delegate when it comes to user
1749 credentials. Used with GSS/kerberos. Possible values are:
1752 * `none` - Don't allow any delegation.
1753 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1754 Kerberos service ticket, which is a matter of realm policy.
1755 * `always` - Unconditionally allow the server to delegate.
1760 Pass an additional HTTP header when communicating with a server. If
1761 more than one such entry exists, all of them are added as extra
1762 headers. To allow overriding the settings inherited from the system
1763 config, an empty value will reset the extra headers to the empty list.
1766 The pathname of a file containing previously stored cookie lines,
1767 which should be used
1768 in the Git http session, if they match the server. The file format
1769 of the file to read cookies from should be plain HTTP headers or
1770 the Netscape/Mozilla cookie file format (see `curl(1)`).
1771 NOTE that the file specified with http.cookieFile is used only as
1772 input unless http.saveCookies is set.
1775 If set, store cookies received during requests to the file specified by
1776 http.cookieFile. Has no effect if http.cookieFile is unset.
1779 The SSL version to use when negotiating an SSL connection, if you
1780 want to force the default. The available and default version
1781 depend on whether libcurl was built against NSS or OpenSSL and the
1782 particular configuration of the crypto library in use. Internally
1783 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1784 documentation for more details on the format of this option and
1785 for the ssl version supported. Actually the possible values of
1796 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1797 To force git to use libcurl's default ssl version and ignore any
1798 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1801 http.sslCipherList::
1802 A list of SSL ciphers to use when negotiating an SSL connection.
1803 The available ciphers depend on whether libcurl was built against
1804 NSS or OpenSSL and the particular configuration of the crypto
1805 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1806 option; see the libcurl documentation for more details on the format
1809 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1810 To force git to use libcurl's default cipher list and ignore any
1811 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1815 Whether to verify the SSL certificate when fetching or pushing
1816 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1820 File containing the SSL certificate when fetching or pushing
1821 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1825 File containing the SSL private key when fetching or pushing
1826 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1829 http.sslCertPasswordProtected::
1830 Enable Git's password prompt for the SSL certificate. Otherwise
1831 OpenSSL will prompt the user, possibly many times, if the
1832 certificate or private key is encrypted. Can be overridden by the
1833 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1836 File containing the certificates to verify the peer with when
1837 fetching or pushing over HTTPS. Can be overridden by the
1838 `GIT_SSL_CAINFO` environment variable.
1841 Path containing files with the CA certificates to verify the peer
1842 with when fetching or pushing over HTTPS. Can be overridden
1843 by the `GIT_SSL_CAPATH` environment variable.
1846 Public key of the https service. It may either be the filename of
1847 a PEM or DER encoded public key file or a string starting with
1848 'sha256//' followed by the base64 encoded sha256 hash of the
1849 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1850 exit with an error if this option is set but not supported by
1854 Attempt to use AUTH SSL/TLS and encrypted data transfers
1855 when connecting via regular FTP protocol. This might be needed
1856 if the FTP server requires it for security reasons or you wish
1857 to connect securely whenever remote FTP server supports it.
1858 Default is false since it might trigger certificate verification
1859 errors on misconfigured servers.
1862 How many HTTP requests to launch in parallel. Can be overridden
1863 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1866 The number of curl sessions (counted across slots) to be kept across
1867 requests. They will not be ended with curl_easy_cleanup() until
1868 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1869 value will be capped at 1. Defaults to 1.
1872 Maximum size in bytes of the buffer used by smart HTTP
1873 transports when POSTing data to the remote system.
1874 For requests larger than this buffer size, HTTP/1.1 and
1875 Transfer-Encoding: chunked is used to avoid creating a
1876 massive pack file locally. Default is 1 MiB, which is
1877 sufficient for most requests.
1879 http.lowSpeedLimit, http.lowSpeedTime::
1880 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1881 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1882 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1883 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1886 A boolean which disables using of EPSV ftp command by curl.
1887 This can helpful with some "poor" ftp servers which don't
1888 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1889 environment variable. Default is false (curl will use EPSV).
1892 The HTTP USER_AGENT string presented to an HTTP server. The default
1893 value represents the version of the client Git such as git/1.7.1.
1894 This option allows you to override this value to a more common value
1895 such as Mozilla/4.0. This may be necessary, for instance, if
1896 connecting through a firewall that restricts HTTP connections to a set
1897 of common USER_AGENT strings (but not including those like git/1.7.1).
1898 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
1900 http.followRedirects::
1901 Whether git should follow HTTP redirects. If set to `true`, git
1902 will transparently follow any redirect issued by a server it
1903 encounters. If set to `false`, git will treat all redirects as
1904 errors. If set to `initial`, git will follow redirects only for
1905 the initial request to a remote, but not for subsequent
1906 follow-up HTTP requests. Since git uses the redirected URL as
1907 the base for the follow-up requests, this is generally
1908 sufficient. The default is `initial`.
1911 Any of the http.* options above can be applied selectively to some URLs.
1912 For a config key to match a URL, each element of the config key is
1913 compared to that of the URL, in the following order:
1916 . Scheme (e.g., `https` in `https://example.com/`). This field
1917 must match exactly between the config key and the URL.
1919 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1920 This field must match exactly between the config key and the URL.
1922 . Port number (e.g., `8080` in `http://example.com:8080/`).
1923 This field must match exactly between the config key and the URL.
1924 Omitted port numbers are automatically converted to the correct
1925 default for the scheme before matching.
1927 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1928 path field of the config key must match the path field of the URL
1929 either exactly or as a prefix of slash-delimited path elements. This means
1930 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1931 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1932 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1933 key with just path `foo/`).
1935 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1936 the config key has a user name it must match the user name in the
1937 URL exactly. If the config key does not have a user name, that
1938 config key will match a URL with any user name (including none),
1939 but at a lower precedence than a config key with a user name.
1942 The list above is ordered by decreasing precedence; a URL that matches
1943 a config key's path is preferred to one that matches its user name. For example,
1944 if the URL is `https://user@example.com/foo/bar` a config key match of
1945 `https://example.com/foo` will be preferred over a config key match of
1946 `https://user@example.com`.
1948 All URLs are normalized before attempting any matching (the password part,
1949 if embedded in the URL, is always ignored for matching purposes) so that
1950 equivalent URLs that are simply spelled differently will match properly.
1951 Environment variable settings always override any matches. The URLs that are
1952 matched against are those given directly to Git commands. This means any URLs
1953 visited as a result of a redirection do not participate in matching.
1955 i18n.commitEncoding::
1956 Character encoding the commit messages are stored in; Git itself
1957 does not care per se, but this information is necessary e.g. when
1958 importing commits from emails or in the gitk graphical history
1959 browser (and possibly at other places in the future or in other
1960 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1962 i18n.logOutputEncoding::
1963 Character encoding the commit messages are converted to when
1964 running 'git log' and friends.
1967 The configuration variables in the 'imap' section are described
1968 in linkgit:git-imap-send[1].
1971 Specify the version with which new index files should be
1972 initialized. This does not affect existing repositories.
1975 Specify the directory from which templates will be copied.
1976 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1979 Specify the program that will be used to browse your working
1980 repository in gitweb. See linkgit:git-instaweb[1].
1983 The HTTP daemon command-line to start gitweb on your working
1984 repository. See linkgit:git-instaweb[1].
1987 If true the web server started by linkgit:git-instaweb[1] will
1988 be bound to the local IP (127.0.0.1).
1990 instaweb.modulePath::
1991 The default module path for linkgit:git-instaweb[1] to use
1992 instead of /usr/lib/apache2/modules. Only used if httpd
1996 The port number to bind the gitweb httpd to. See
1997 linkgit:git-instaweb[1].
1999 interactive.singleKey::
2000 In interactive commands, allow the user to provide one-letter
2001 input with a single key (i.e., without hitting enter).
2002 Currently this is used by the `--patch` mode of
2003 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2004 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2005 setting is silently ignored if portable keystroke input
2006 is not available; requires the Perl module Term::ReadKey.
2008 interactive.diffFilter::
2009 When an interactive command (such as `git add --patch`) shows
2010 a colorized diff, git will pipe the diff through the shell
2011 command defined by this configuration variable. The command may
2012 mark up the diff further for human consumption, provided that it
2013 retains a one-to-one correspondence with the lines in the
2014 original diff. Defaults to disabled (no filtering).
2017 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2018 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2019 override this option with `--no-abbrev-commit`.
2022 Set the default date-time mode for the 'log' command.
2023 Setting a value for log.date is similar to using 'git log''s
2024 `--date` option. See linkgit:git-log[1] for details.
2027 Print out the ref names of any commits that are shown by the log
2028 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2029 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2030 specified, the full ref name (including prefix) will be printed.
2031 If 'auto' is specified, then if the output is going to a terminal,
2032 the ref names are shown as if 'short' were given, otherwise no ref
2033 names are shown. This is the same as the `--decorate` option
2037 If `true`, `git log` will act as if the `--follow` option was used when
2038 a single <path> is given. This has the same limitations as `--follow`,
2039 i.e. it cannot be used to follow multiple files and does not work well
2040 on non-linear history.
2043 A list of colors, separated by commas, that can be used to draw
2044 history lines in `git log --graph`.
2047 If true, the initial commit will be shown as a big creation event.
2048 This is equivalent to a diff against an empty tree.
2049 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2050 normally hide the root commit will now show it. True by default.
2053 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2054 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2057 If true, makes linkgit:git-mailinfo[1] (and therefore
2058 linkgit:git-am[1]) act by default as if the --scissors option
2059 was provided on the command-line. When active, this features
2060 removes everything from the message body before a scissors
2061 line (i.e. consisting mainly of ">8", "8<" and "-").
2064 The location of an augmenting mailmap file. The default
2065 mailmap, located in the root of the repository, is loaded
2066 first, then the mailmap file pointed to by this variable.
2067 The location of the mailmap file may be in a repository
2068 subdirectory, or somewhere outside of the repository itself.
2069 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2072 Like `mailmap.file`, but consider the value as a reference to a
2073 blob in the repository. If both `mailmap.file` and
2074 `mailmap.blob` are given, both are parsed, with entries from
2075 `mailmap.file` taking precedence. In a bare repository, this
2076 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2080 Specify the programs that may be used to display help in the
2081 'man' format. See linkgit:git-help[1].
2084 Specify the command to invoke the specified man viewer. The
2085 specified command is evaluated in shell with the man page
2086 passed as argument. (See linkgit:git-help[1].)
2089 Override the path for the given tool that may be used to
2090 display help in the 'man' format. See linkgit:git-help[1].
2092 include::merge-config.txt[]
2094 mergetool.<tool>.path::
2095 Override the path for the given tool. This is useful in case
2096 your tool is not in the PATH.
2098 mergetool.<tool>.cmd::
2099 Specify the command to invoke the specified merge tool. The
2100 specified command is evaluated in shell with the following
2101 variables available: 'BASE' is the name of a temporary file
2102 containing the common base of the files to be merged, if available;
2103 'LOCAL' is the name of a temporary file containing the contents of
2104 the file on the current branch; 'REMOTE' is the name of a temporary
2105 file containing the contents of the file from the branch being
2106 merged; 'MERGED' contains the name of the file to which the merge
2107 tool should write the results of a successful merge.
2109 mergetool.<tool>.trustExitCode::
2110 For a custom merge command, specify whether the exit code of
2111 the merge command can be used to determine whether the merge was
2112 successful. If this is not set to true then the merge target file
2113 timestamp is checked and the merge assumed to have been successful
2114 if the file has been updated, otherwise the user is prompted to
2115 indicate the success of the merge.
2117 mergetool.meld.hasOutput::
2118 Older versions of `meld` do not support the `--output` option.
2119 Git will attempt to detect whether `meld` supports `--output`
2120 by inspecting the output of `meld --help`. Configuring
2121 `mergetool.meld.hasOutput` will make Git skip these checks and
2122 use the configured value instead. Setting `mergetool.meld.hasOutput`
2123 to `true` tells Git to unconditionally use the `--output` option,
2124 and `false` avoids using `--output`.
2126 mergetool.keepBackup::
2127 After performing a merge, the original file with conflict markers
2128 can be saved as a file with a `.orig` extension. If this variable
2129 is set to `false` then this file is not preserved. Defaults to
2130 `true` (i.e. keep the backup files).
2132 mergetool.keepTemporaries::
2133 When invoking a custom merge tool, Git uses a set of temporary
2134 files to pass to the tool. If the tool returns an error and this
2135 variable is set to `true`, then these temporary files will be
2136 preserved, otherwise they will be removed after the tool has
2137 exited. Defaults to `false`.
2139 mergetool.writeToTemp::
2140 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2141 conflicting files in the worktree by default. Git will attempt
2142 to use a temporary directory for these files when set `true`.
2143 Defaults to `false`.
2146 Prompt before each invocation of the merge resolution program.
2148 notes.mergeStrategy::
2149 Which merge strategy to choose by default when resolving notes
2150 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2151 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2152 section of linkgit:git-notes[1] for more information on each strategy.
2154 notes.<name>.mergeStrategy::
2155 Which merge strategy to choose when doing a notes merge into
2156 refs/notes/<name>. This overrides the more general
2157 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2158 linkgit:git-notes[1] for more information on the available strategies.
2161 The (fully qualified) refname from which to show notes when
2162 showing commit messages. The value of this variable can be set
2163 to a glob, in which case notes from all matching refs will be
2164 shown. You may also specify this configuration variable
2165 several times. A warning will be issued for refs that do not
2166 exist, but a glob that does not match any refs is silently
2169 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2170 environment variable, which must be a colon separated list of refs or
2173 The effective value of "core.notesRef" (possibly overridden by
2174 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2177 notes.rewrite.<command>::
2178 When rewriting commits with <command> (currently `amend` or
2179 `rebase`) and this variable is set to `true`, Git
2180 automatically copies your notes from the original to the
2181 rewritten commit. Defaults to `true`, but see
2182 "notes.rewriteRef" below.
2185 When copying notes during a rewrite (see the
2186 "notes.rewrite.<command>" option), determines what to do if
2187 the target commit already has a note. Must be one of
2188 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2189 Defaults to `concatenate`.
2191 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2192 environment variable.
2195 When copying notes during a rewrite, specifies the (fully
2196 qualified) ref whose notes should be copied. The ref may be a
2197 glob, in which case notes in all matching refs will be copied.
2198 You may also specify this configuration several times.
2200 Does not have a default value; you must configure this variable to
2201 enable note rewriting. Set it to `refs/notes/commits` to enable
2202 rewriting for the default commit notes.
2204 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2205 environment variable, which must be a colon separated list of refs or
2209 The size of the window used by linkgit:git-pack-objects[1] when no
2210 window size is given on the command line. Defaults to 10.
2213 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2214 maximum depth is given on the command line. Defaults to 50.
2217 The maximum size of memory that is consumed by each thread
2218 in linkgit:git-pack-objects[1] for pack window memory when
2219 no limit is given on the command line. The value can be
2220 suffixed with "k", "m", or "g". When left unconfigured (or
2221 set explicitly to 0), there will be no limit.
2224 An integer -1..9, indicating the compression level for objects
2225 in a pack file. -1 is the zlib default. 0 means no
2226 compression, and 1..9 are various speed/size tradeoffs, 9 being
2227 slowest. If not set, defaults to core.compression. If that is
2228 not set, defaults to -1, the zlib default, which is "a default
2229 compromise between speed and compression (currently equivalent
2232 Note that changing the compression level will not automatically recompress
2233 all existing objects. You can force recompression by passing the -F option
2234 to linkgit:git-repack[1].
2236 pack.deltaCacheSize::
2237 The maximum memory in bytes used for caching deltas in
2238 linkgit:git-pack-objects[1] before writing them out to a pack.
2239 This cache is used to speed up the writing object phase by not
2240 having to recompute the final delta result once the best match
2241 for all objects is found. Repacking large repositories on machines
2242 which are tight with memory might be badly impacted by this though,
2243 especially if this cache pushes the system into swapping.
2244 A value of 0 means no limit. The smallest size of 1 byte may be
2245 used to virtually disable this cache. Defaults to 256 MiB.
2247 pack.deltaCacheLimit::
2248 The maximum size of a delta, that is cached in
2249 linkgit:git-pack-objects[1]. This cache is used to speed up the
2250 writing object phase by not having to recompute the final delta
2251 result once the best match for all objects is found. Defaults to 1000.
2254 Specifies the number of threads to spawn when searching for best
2255 delta matches. This requires that linkgit:git-pack-objects[1]
2256 be compiled with pthreads otherwise this option is ignored with a
2257 warning. This is meant to reduce packing time on multiprocessor
2258 machines. The required amount of memory for the delta search window
2259 is however multiplied by the number of threads.
2260 Specifying 0 will cause Git to auto-detect the number of CPU's
2261 and set the number of threads accordingly.
2264 Specify the default pack index version. Valid values are 1 for
2265 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2266 the new pack index with capabilities for packs larger than 4 GB
2267 as well as proper protection against the repacking of corrupted
2268 packs. Version 2 is the default. Note that version 2 is enforced
2269 and this config option ignored whenever the corresponding pack is
2272 If you have an old Git that does not understand the version 2 `*.idx` file,
2273 cloning or fetching over a non native protocol (e.g. "http")
2274 that will copy both `*.pack` file and corresponding `*.idx` file from the
2275 other side may give you a repository that cannot be accessed with your
2276 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2277 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2280 pack.packSizeLimit::
2281 The maximum size of a pack. This setting only affects
2282 packing to a file when repacking, i.e. the git:// protocol
2283 is unaffected. It can be overridden by the `--max-pack-size`
2284 option of linkgit:git-repack[1]. Reaching this limit results
2285 in the creation of multiple packfiles; which in turn prevents
2286 bitmaps from being created.
2287 The minimum size allowed is limited to 1 MiB.
2288 The default is unlimited.
2289 Common unit suffixes of 'k', 'm', or 'g' are
2293 When true, git will use pack bitmaps (if available) when packing
2294 to stdout (e.g., during the server side of a fetch). Defaults to
2295 true. You should not generally need to turn this off unless
2296 you are debugging pack bitmaps.
2298 pack.writeBitmaps (deprecated)::
2299 This is a deprecated synonym for `repack.writeBitmaps`.
2301 pack.writeBitmapHashCache::
2302 When true, git will include a "hash cache" section in the bitmap
2303 index (if one is written). This cache can be used to feed git's
2304 delta heuristics, potentially leading to better deltas between
2305 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2306 between an older, bitmapped pack and objects that have been
2307 pushed since the last gc). The downside is that it consumes 4
2308 bytes per object of disk space, and that JGit's bitmap
2309 implementation does not understand it, causing it to complain if
2310 Git and JGit are used on the same repository. Defaults to false.
2313 If the value is boolean, turns on or off pagination of the
2314 output of a particular Git subcommand when writing to a tty.
2315 Otherwise, turns on pagination for the subcommand using the
2316 pager specified by the value of `pager.<cmd>`. If `--paginate`
2317 or `--no-pager` is specified on the command line, it takes
2318 precedence over this option. To disable pagination for all
2319 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2322 Alias for a --pretty= format string, as specified in
2323 linkgit:git-log[1]. Any aliases defined here can be used just
2324 as the built-in pretty formats could. For example,
2325 running `git config pretty.changelog "format:* %H %s"`
2326 would cause the invocation `git log --pretty=changelog`
2327 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2328 Note that an alias with the same name as a built-in format
2329 will be silently ignored.
2332 If set, provide a user defined default policy for all protocols which
2333 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2334 if unset, known-safe protocols (http, https, git, ssh, file) have a
2335 default policy of `always`, known-dangerous protocols (ext) have a
2336 default policy of `never`, and all other protocols have a default
2337 policy of `user`. Supported policies:
2341 * `always` - protocol is always able to be used.
2343 * `never` - protocol is never able to be used.
2345 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2346 either unset or has a value of 1. This policy should be used when you want a
2347 protocol to be directly usable by the user but don't want it used by commands which
2348 execute clone/fetch/push commands without user input, e.g. recursive
2349 submodule initialization.
2353 protocol.<name>.allow::
2354 Set a policy to be used by protocol `<name>` with clone/fetch/push
2355 commands. See `protocol.allow` above for the available policies.
2357 The protocol names currently used by git are:
2360 - `file`: any local file-based path (including `file://` URLs,
2363 - `git`: the anonymous git protocol over a direct TCP
2364 connection (or proxy, if configured)
2366 - `ssh`: git over ssh (including `host:path` syntax,
2369 - `http`: git over http, both "smart http" and "dumb http".
2370 Note that this does _not_ include `https`; if you want to configure
2371 both, you must do so individually.
2373 - any external helpers are named by their protocol (e.g., use
2374 `hg` to allow the `git-remote-hg` helper)
2378 By default, Git does not create an extra merge commit when merging
2379 a commit that is a descendant of the current commit. Instead, the
2380 tip of the current branch is fast-forwarded. When set to `false`,
2381 this variable tells Git to create an extra merge commit in such
2382 a case (equivalent to giving the `--no-ff` option from the command
2383 line). When set to `only`, only such fast-forward merges are
2384 allowed (equivalent to giving the `--ff-only` option from the
2385 command line). This setting overrides `merge.ff` when pulling.
2388 When true, rebase branches on top of the fetched branch, instead
2389 of merging the default branch from the default remote when "git
2390 pull" is run. See "branch.<name>.rebase" for setting this on a
2393 When preserve, also pass `--preserve-merges` along to 'git rebase'
2394 so that locally committed merge commits will not be flattened
2395 by running 'git pull'.
2397 When the value is `interactive`, the rebase is run in interactive mode.
2399 *NOTE*: this is a possibly dangerous operation; do *not* use
2400 it unless you understand the implications (see linkgit:git-rebase[1]
2404 The default merge strategy to use when pulling multiple branches
2408 The default merge strategy to use when pulling a single branch.
2411 Defines the action `git push` should take if no refspec is
2412 explicitly given. Different values are well-suited for
2413 specific workflows; for instance, in a purely central workflow
2414 (i.e. the fetch source is equal to the push destination),
2415 `upstream` is probably what you want. Possible values are:
2419 * `nothing` - do not push anything (error out) unless a refspec is
2420 explicitly given. This is primarily meant for people who want to
2421 avoid mistakes by always being explicit.
2423 * `current` - push the current branch to update a branch with the same
2424 name on the receiving end. Works in both central and non-central
2427 * `upstream` - push the current branch back to the branch whose
2428 changes are usually integrated into the current branch (which is
2429 called `@{upstream}`). This mode only makes sense if you are
2430 pushing to the same repository you would normally pull from
2431 (i.e. central workflow).
2433 * `simple` - in centralized workflow, work like `upstream` with an
2434 added safety to refuse to push if the upstream branch's name is
2435 different from the local one.
2437 When pushing to a remote that is different from the remote you normally
2438 pull from, work as `current`. This is the safest option and is suited
2441 This mode has become the default in Git 2.0.
2443 * `matching` - push all branches having the same name on both ends.
2444 This makes the repository you are pushing to remember the set of
2445 branches that will be pushed out (e.g. if you always push 'maint'
2446 and 'master' there and no other branches, the repository you push
2447 to will have these two branches, and your local 'maint' and
2448 'master' will be pushed there).
2450 To use this mode effectively, you have to make sure _all_ the
2451 branches you would push out are ready to be pushed out before
2452 running 'git push', as the whole point of this mode is to allow you
2453 to push all of the branches in one go. If you usually finish work
2454 on only one branch and push out the result, while other branches are
2455 unfinished, this mode is not for you. Also this mode is not
2456 suitable for pushing into a shared central repository, as other
2457 people may add new branches there, or update the tip of existing
2458 branches outside your control.
2460 This used to be the default, but not since Git 2.0 (`simple` is the
2466 If set to true enable `--follow-tags` option by default. You
2467 may override this configuration at time of push by specifying
2471 May be set to a boolean value, or the string 'if-asked'. A true
2472 value causes all pushes to be GPG signed, as if `--signed` is
2473 passed to linkgit:git-push[1]. The string 'if-asked' causes
2474 pushes to be signed if the server supports it, as if
2475 `--signed=if-asked` is passed to 'git push'. A false value may
2476 override a value from a lower-priority config file. An explicit
2477 command-line flag always overrides this config option.
2479 push.recurseSubmodules::
2480 Make sure all submodule commits used by the revisions to be pushed
2481 are available on a remote-tracking branch. If the value is 'check'
2482 then Git will verify that all submodule commits that changed in the
2483 revisions to be pushed are available on at least one remote of the
2484 submodule. If any commits are missing, the push will be aborted and
2485 exit with non-zero status. If the value is 'on-demand' then all
2486 submodules that changed in the revisions to be pushed will be
2487 pushed. If on-demand was not able to push all necessary revisions
2488 it will also be aborted and exit with non-zero status. If the value
2489 is 'no' then default behavior of ignoring submodules when pushing
2490 is retained. You may override this configuration at time of push by
2491 specifying '--recurse-submodules=check|on-demand|no'.
2494 Whether to show a diffstat of what changed upstream since the last
2495 rebase. False by default.
2498 If set to true enable `--autosquash` option by default.
2501 When set to true, automatically create a temporary stash
2502 before the operation begins, and apply it after the operation
2503 ends. This means that you can run rebase on a dirty worktree.
2504 However, use with care: the final stash application after a
2505 successful rebase might result in non-trivial conflicts.
2508 rebase.missingCommitsCheck::
2509 If set to "warn", git rebase -i will print a warning if some
2510 commits are removed (e.g. a line was deleted), however the
2511 rebase will still proceed. If set to "error", it will print
2512 the previous warning and stop the rebase, 'git rebase
2513 --edit-todo' can then be used to correct the error. If set to
2514 "ignore", no checking is done.
2515 To drop a commit without warning or error, use the `drop`
2516 command in the todo-list.
2517 Defaults to "ignore".
2519 rebase.instructionFormat::
2520 A format string, as specified in linkgit:git-log[1], to be used for
2521 the instruction list during an interactive rebase. The format will automatically
2522 have the long commit hash prepended to the format.
2524 receive.advertiseAtomic::
2525 By default, git-receive-pack will advertise the atomic push
2526 capability to its clients. If you don't want to advertise this
2527 capability, set this variable to false.
2529 receive.advertisePushOptions::
2530 By default, git-receive-pack will advertise the push options
2531 capability to its clients. If you don't want to advertise this
2532 capability, set this variable to false.
2535 By default, git-receive-pack will run "git-gc --auto" after
2536 receiving data from git-push and updating refs. You can stop
2537 it by setting this variable to false.
2539 receive.certNonceSeed::
2540 By setting this variable to a string, `git receive-pack`
2541 will accept a `git push --signed` and verifies it by using
2542 a "nonce" protected by HMAC using this string as a secret
2545 receive.certNonceSlop::
2546 When a `git push --signed` sent a push certificate with a
2547 "nonce" that was issued by a receive-pack serving the same
2548 repository within this many seconds, export the "nonce"
2549 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2550 hooks (instead of what the receive-pack asked the sending
2551 side to include). This may allow writing checks in
2552 `pre-receive` and `post-receive` a bit easier. Instead of
2553 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2554 that records by how many seconds the nonce is stale to
2555 decide if they want to accept the certificate, they only
2556 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2558 receive.fsckObjects::
2559 If it is set to true, git-receive-pack will check all received
2560 objects. It will abort in the case of a malformed object or a
2561 broken link. The result of an abort are only dangling objects.
2562 Defaults to false. If not set, the value of `transfer.fsckObjects`
2565 receive.fsck.<msg-id>::
2566 When `receive.fsckObjects` is set to true, errors can be switched
2567 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2568 setting where the `<msg-id>` is the fsck message ID and the value
2569 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2570 the error/warning with the message ID, e.g. "missingEmail: invalid
2571 author/committer line - missing email" means that setting
2572 `receive.fsck.missingEmail = ignore` will hide that issue.
2574 This feature is intended to support working with legacy repositories
2575 which would not pass pushing when `receive.fsckObjects = true`, allowing
2576 the host to accept repositories with certain known issues but still catch
2579 receive.fsck.skipList::
2580 The path to a sorted list of object names (i.e. one SHA-1 per
2581 line) that are known to be broken in a non-fatal way and should
2582 be ignored. This feature is useful when an established project
2583 should be accepted despite early commits containing errors that
2584 can be safely ignored such as invalid committer email addresses.
2585 Note: corrupt objects cannot be skipped with this setting.
2588 After receiving the pack from the client, `receive-pack` may
2589 produce no output (if `--quiet` was specified) while processing
2590 the pack, causing some networks to drop the TCP connection.
2591 With this option set, if `receive-pack` does not transmit
2592 any data in this phase for `receive.keepAlive` seconds, it will
2593 send a short keepalive packet. The default is 5 seconds; set
2594 to 0 to disable keepalives entirely.
2596 receive.unpackLimit::
2597 If the number of objects received in a push is below this
2598 limit then the objects will be unpacked into loose object
2599 files. However if the number of received objects equals or
2600 exceeds this limit then the received pack will be stored as
2601 a pack, after adding any missing delta bases. Storing the
2602 pack from a push can make the push operation complete faster,
2603 especially on slow filesystems. If not set, the value of
2604 `transfer.unpackLimit` is used instead.
2606 receive.maxInputSize::
2607 If the size of the incoming pack stream is larger than this
2608 limit, then git-receive-pack will error out, instead of
2609 accepting the pack file. If not set or set to 0, then the size
2612 receive.denyDeletes::
2613 If set to true, git-receive-pack will deny a ref update that deletes
2614 the ref. Use this to prevent such a ref deletion via a push.
2616 receive.denyDeleteCurrent::
2617 If set to true, git-receive-pack will deny a ref update that
2618 deletes the currently checked out branch of a non-bare repository.
2620 receive.denyCurrentBranch::
2621 If set to true or "refuse", git-receive-pack will deny a ref update
2622 to the currently checked out branch of a non-bare repository.
2623 Such a push is potentially dangerous because it brings the HEAD
2624 out of sync with the index and working tree. If set to "warn",
2625 print a warning of such a push to stderr, but allow the push to
2626 proceed. If set to false or "ignore", allow such pushes with no
2627 message. Defaults to "refuse".
2629 Another option is "updateInstead" which will update the working
2630 tree if pushing into the current branch. This option is
2631 intended for synchronizing working directories when one side is not easily
2632 accessible via interactive ssh (e.g. a live web site, hence the requirement
2633 that the working directory be clean). This mode also comes in handy when
2634 developing inside a VM to test and fix code on different Operating Systems.
2636 By default, "updateInstead" will refuse the push if the working tree or
2637 the index have any difference from the HEAD, but the `push-to-checkout`
2638 hook can be used to customize this. See linkgit:githooks[5].
2640 receive.denyNonFastForwards::
2641 If set to true, git-receive-pack will deny a ref update which is
2642 not a fast-forward. Use this to prevent such an update via a push,
2643 even if that push is forced. This configuration variable is
2644 set when initializing a shared repository.
2647 This variable is the same as `transfer.hideRefs`, but applies
2648 only to `receive-pack` (and so affects pushes, but not fetches).
2649 An attempt to update or delete a hidden ref by `git push` is
2652 receive.updateServerInfo::
2653 If set to true, git-receive-pack will run git-update-server-info
2654 after receiving data from git-push and updating refs.
2656 receive.shallowUpdate::
2657 If set to true, .git/shallow can be updated when new refs
2658 require new shallow roots. Otherwise those refs are rejected.
2660 remote.pushDefault::
2661 The remote to push to by default. Overrides
2662 `branch.<name>.remote` for all branches, and is overridden by
2663 `branch.<name>.pushRemote` for specific branches.
2666 The URL of a remote repository. See linkgit:git-fetch[1] or
2667 linkgit:git-push[1].
2669 remote.<name>.pushurl::
2670 The push URL of a remote repository. See linkgit:git-push[1].
2672 remote.<name>.proxy::
2673 For remotes that require curl (http, https and ftp), the URL to
2674 the proxy to use for that remote. Set to the empty string to
2675 disable proxying for that remote.
2677 remote.<name>.proxyAuthMethod::
2678 For remotes that require curl (http, https and ftp), the method to use for
2679 authenticating against the proxy in use (probably set in
2680 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2682 remote.<name>.fetch::
2683 The default set of "refspec" for linkgit:git-fetch[1]. See
2684 linkgit:git-fetch[1].
2686 remote.<name>.push::
2687 The default set of "refspec" for linkgit:git-push[1]. See
2688 linkgit:git-push[1].
2690 remote.<name>.mirror::
2691 If true, pushing to this remote will automatically behave
2692 as if the `--mirror` option was given on the command line.
2694 remote.<name>.skipDefaultUpdate::
2695 If true, this remote will be skipped by default when updating
2696 using linkgit:git-fetch[1] or the `update` subcommand of
2697 linkgit:git-remote[1].
2699 remote.<name>.skipFetchAll::
2700 If true, this remote will be skipped by default when updating
2701 using linkgit:git-fetch[1] or the `update` subcommand of
2702 linkgit:git-remote[1].
2704 remote.<name>.receivepack::
2705 The default program to execute on the remote side when pushing. See
2706 option --receive-pack of linkgit:git-push[1].
2708 remote.<name>.uploadpack::
2709 The default program to execute on the remote side when fetching. See
2710 option --upload-pack of linkgit:git-fetch-pack[1].
2712 remote.<name>.tagOpt::
2713 Setting this value to --no-tags disables automatic tag following when
2714 fetching from remote <name>. Setting it to --tags will fetch every
2715 tag from remote <name>, even if they are not reachable from remote
2716 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2717 override this setting. See options --tags and --no-tags of
2718 linkgit:git-fetch[1].
2721 Setting this to a value <vcs> will cause Git to interact with
2722 the remote with the git-remote-<vcs> helper.
2724 remote.<name>.prune::
2725 When set to true, fetching from this remote by default will also
2726 remove any remote-tracking references that no longer exist on the
2727 remote (as if the `--prune` option was given on the command line).
2728 Overrides `fetch.prune` settings, if any.
2731 The list of remotes which are fetched by "git remote update
2732 <group>". See linkgit:git-remote[1].
2734 repack.useDeltaBaseOffset::
2735 By default, linkgit:git-repack[1] creates packs that use
2736 delta-base offset. If you need to share your repository with
2737 Git older than version 1.4.4, either directly or via a dumb
2738 protocol such as http, then you need to set this option to
2739 "false" and repack. Access from old Git versions over the
2740 native protocol are unaffected by this option.
2742 repack.packKeptObjects::
2743 If set to true, makes `git repack` act as if
2744 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2745 details. Defaults to `false` normally, but `true` if a bitmap
2746 index is being written (either via `--write-bitmap-index` or
2747 `repack.writeBitmaps`).
2749 repack.writeBitmaps::
2750 When true, git will write a bitmap index when packing all
2751 objects to disk (e.g., when `git repack -a` is run). This
2752 index can speed up the "counting objects" phase of subsequent
2753 packs created for clones and fetches, at the cost of some disk
2754 space and extra time spent on the initial repack. This has
2755 no effect if multiple packfiles are created.
2759 When set to true, `git-rerere` updates the index with the
2760 resulting contents after it cleanly resolves conflicts using
2761 previously recorded resolution. Defaults to false.
2764 Activate recording of resolved conflicts, so that identical
2765 conflict hunks can be resolved automatically, should they be
2766 encountered again. By default, linkgit:git-rerere[1] is
2767 enabled if there is an `rr-cache` directory under the
2768 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2771 sendemail.identity::
2772 A configuration identity. When given, causes values in the
2773 'sendemail.<identity>' subsection to take precedence over
2774 values in the 'sendemail' section. The default identity is
2775 the value of `sendemail.identity`.
2777 sendemail.smtpEncryption::
2778 See linkgit:git-send-email[1] for description. Note that this
2779 setting is not subject to the 'identity' mechanism.
2781 sendemail.smtpssl (deprecated)::
2782 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2784 sendemail.smtpsslcertpath::
2785 Path to ca-certificates (either a directory or a single file).
2786 Set it to an empty string to disable certificate verification.
2788 sendemail.<identity>.*::
2789 Identity-specific versions of the 'sendemail.*' parameters
2790 found below, taking precedence over those when the this
2791 identity is selected, through command-line or
2792 `sendemail.identity`.
2794 sendemail.aliasesFile::
2795 sendemail.aliasFileType::
2796 sendemail.annotate::
2800 sendemail.chainReplyTo::
2802 sendemail.envelopeSender::
2804 sendemail.multiEdit::
2805 sendemail.signedoffbycc::
2806 sendemail.smtpPass::
2807 sendemail.suppresscc::
2808 sendemail.suppressFrom::
2810 sendemail.smtpDomain::
2811 sendemail.smtpServer::
2812 sendemail.smtpServerPort::
2813 sendemail.smtpServerOption::
2814 sendemail.smtpUser::
2816 sendemail.transferEncoding::
2817 sendemail.validate::
2819 See linkgit:git-send-email[1] for description.
2821 sendemail.signedoffcc (deprecated)::
2822 Deprecated alias for `sendemail.signedoffbycc`.
2824 showbranch.default::
2825 The default set of branches for linkgit:git-show-branch[1].
2826 See linkgit:git-show-branch[1].
2828 status.relativePaths::
2829 By default, linkgit:git-status[1] shows paths relative to the
2830 current directory. Setting this variable to `false` shows paths
2831 relative to the repository root (this was the default for Git
2835 Set to true to enable --short by default in linkgit:git-status[1].
2836 The option --no-short takes precedence over this variable.
2839 Set to true to enable --branch by default in linkgit:git-status[1].
2840 The option --no-branch takes precedence over this variable.
2842 status.displayCommentPrefix::
2843 If set to true, linkgit:git-status[1] will insert a comment
2844 prefix before each output line (starting with
2845 `core.commentChar`, i.e. `#` by default). This was the
2846 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2849 status.showUntrackedFiles::
2850 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2851 files which are not currently tracked by Git. Directories which
2852 contain only untracked files, are shown with the directory name
2853 only. Showing untracked files means that Git needs to lstat() all
2854 the files in the whole repository, which might be slow on some
2855 systems. So, this variable controls how the commands displays
2856 the untracked files. Possible values are:
2859 * `no` - Show no untracked files.
2860 * `normal` - Show untracked files and directories.
2861 * `all` - Show also individual files in untracked directories.
2864 If this variable is not specified, it defaults to 'normal'.
2865 This variable can be overridden with the -u|--untracked-files option
2866 of linkgit:git-status[1] and linkgit:git-commit[1].
2868 status.submoduleSummary::
2870 If this is set to a non zero number or true (identical to -1 or an
2871 unlimited number), the submodule summary will be enabled and a
2872 summary of commits for modified submodules will be shown (see
2873 --summary-limit option of linkgit:git-submodule[1]). Please note
2874 that the summary output command will be suppressed for all
2875 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2876 for those submodules where `submodule.<name>.ignore=all`. The only
2877 exception to that rule is that status and commit will show staged
2878 submodule changes. To
2879 also view the summary for ignored submodules you can either use
2880 the --ignore-submodules=dirty command-line option or the 'git
2881 submodule summary' command, which shows a similar output but does
2882 not honor these settings.
2885 If this is set to true, the `git stash show` command without an
2886 option will show the stash in patch form. Defaults to false.
2887 See description of 'show' command in linkgit:git-stash[1].
2890 If this is set to true, the `git stash show` command without an
2891 option will show diffstat of the stash. Defaults to true.
2892 See description of 'show' command in linkgit:git-stash[1].
2894 submodule.<name>.url::
2895 The URL for a submodule. This variable is copied from the .gitmodules
2896 file to the git config via 'git submodule init'. The user can change
2897 the configured URL before obtaining the submodule via 'git submodule
2898 update'. After obtaining the submodule, the presence of this variable
2899 is used as a sign whether the submodule is of interest to git commands.
2900 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2902 submodule.<name>.update::
2903 The default update procedure for a submodule. This variable
2904 is populated by `git submodule init` from the
2905 linkgit:gitmodules[5] file. See description of 'update'
2906 command in linkgit:git-submodule[1].
2908 submodule.<name>.branch::
2909 The remote branch name for a submodule, used by `git submodule
2910 update --remote`. Set this option to override the value found in
2911 the `.gitmodules` file. See linkgit:git-submodule[1] and
2912 linkgit:gitmodules[5] for details.
2914 submodule.<name>.fetchRecurseSubmodules::
2915 This option can be used to control recursive fetching of this
2916 submodule. It can be overridden by using the --[no-]recurse-submodules
2917 command-line option to "git fetch" and "git pull".
2918 This setting will override that from in the linkgit:gitmodules[5]
2921 submodule.<name>.ignore::
2922 Defines under what circumstances "git status" and the diff family show
2923 a submodule as modified. When set to "all", it will never be considered
2924 modified (but it will nonetheless show up in the output of status and
2925 commit when it has been staged), "dirty" will ignore all changes
2926 to the submodules work tree and
2927 takes only differences between the HEAD of the submodule and the commit
2928 recorded in the superproject into account. "untracked" will additionally
2929 let submodules with modified tracked files in their work tree show up.
2930 Using "none" (the default when this option is not set) also shows
2931 submodules that have untracked files in their work tree as changed.
2932 This setting overrides any setting made in .gitmodules for this submodule,
2933 both settings can be overridden on the command line by using the
2934 "--ignore-submodules" option. The 'git submodule' commands are not
2935 affected by this setting.
2937 submodule.fetchJobs::
2938 Specifies how many submodules are fetched/cloned at the same time.
2939 A positive integer allows up to that number of submodules fetched
2940 in parallel. A value of 0 will give some reasonable default.
2941 If unset, it defaults to 1.
2943 submodule.alternateLocation::
2944 Specifies how the submodules obtain alternates when submodules are
2945 cloned. Possible values are `no`, `superproject`.
2946 By default `no` is assumed, which doesn't add references. When the
2947 value is set to `superproject` the submodule to be cloned computes
2948 its alternates location relative to the superprojects alternate.
2950 submodule.alternateErrorStrategy
2951 Specifies how to treat errors with the alternates for a submodule
2952 as computed via `submodule.alternateLocation`. Possible values are
2953 `ignore`, `info`, `die`. Default is `die`.
2955 tag.forceSignAnnotated::
2956 A boolean to specify whether annotated tags created should be GPG signed.
2957 If `--annotate` is specified on the command line, it takes
2958 precedence over this option.
2961 This variable controls the sort ordering of tags when displayed by
2962 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2963 value of this variable will be used as the default.
2966 This variable can be used to restrict the permission bits of
2967 tar archive entries. The default is 0002, which turns off the
2968 world write bit. The special value "user" indicates that the
2969 archiving user's umask will be used instead. See umask(2) and
2970 linkgit:git-archive[1].
2972 transfer.fsckObjects::
2973 When `fetch.fsckObjects` or `receive.fsckObjects` are
2974 not set, the value of this variable is used instead.
2978 String(s) `receive-pack` and `upload-pack` use to decide which
2979 refs to omit from their initial advertisements. Use more than
2980 one definition to specify multiple prefix strings. A ref that is
2981 under the hierarchies listed in the value of this variable is
2982 excluded, and is hidden when responding to `git push` or `git
2983 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2984 program-specific versions of this config.
2986 You may also include a `!` in front of the ref name to negate the entry,
2987 explicitly exposing it, even if an earlier entry marked it as hidden.
2988 If you have multiple hideRefs values, later entries override earlier ones
2989 (and entries in more-specific config files override less-specific ones).
2991 If a namespace is in use, the namespace prefix is stripped from each
2992 reference before it is matched against `transfer.hiderefs` patterns.
2993 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2994 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2995 is omitted from the advertisements but `refs/heads/master` and
2996 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2997 "have" lines. In order to match refs before stripping, add a `^` in front of
2998 the ref name. If you combine `!` and `^`, `!` must be specified first.
3000 Even if you hide refs, a client may still be able to steal the target
3001 objects via the techniques described in the "SECURITY" section of the
3002 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3003 separate repository.
3005 transfer.unpackLimit::
3006 When `fetch.unpackLimit` or `receive.unpackLimit` are
3007 not set, the value of this variable is used instead.
3008 The default value is 100.
3010 uploadarchive.allowUnreachable::
3011 If true, allow clients to use `git archive --remote` to request
3012 any tree, whether reachable from the ref tips or not. See the
3013 discussion in the "SECURITY" section of
3014 linkgit:git-upload-archive[1] for more details. Defaults to
3017 uploadpack.hideRefs::
3018 This variable is the same as `transfer.hideRefs`, but applies
3019 only to `upload-pack` (and so affects only fetches, not pushes).
3020 An attempt to fetch a hidden ref by `git fetch` will fail. See
3021 also `uploadpack.allowTipSHA1InWant`.
3023 uploadpack.allowTipSHA1InWant::
3024 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3025 to accept a fetch request that asks for an object at the tip
3026 of a hidden ref (by default, such a request is rejected).
3027 See also `uploadpack.hideRefs`. Even if this is false, a client
3028 may be able to steal objects via the techniques described in the
3029 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3030 best to keep private data in a separate repository.
3032 uploadpack.allowReachableSHA1InWant::
3033 Allow `upload-pack` to accept a fetch request that asks for an
3034 object that is reachable from any ref tip. However, note that
3035 calculating object reachability is computationally expensive.
3036 Defaults to `false`. Even if this is false, a client may be able
3037 to steal objects via the techniques described in the "SECURITY"
3038 section of the linkgit:gitnamespaces[7] man page; it's best to
3039 keep private data in a separate repository.
3041 uploadpack.allowAnySHA1InWant::
3042 Allow `upload-pack` to accept a fetch request that asks for any
3044 Defaults to `false`.
3046 uploadpack.keepAlive::
3047 When `upload-pack` has started `pack-objects`, there may be a
3048 quiet period while `pack-objects` prepares the pack. Normally
3049 it would output progress information, but if `--quiet` was used
3050 for the fetch, `pack-objects` will output nothing at all until
3051 the pack data begins. Some clients and networks may consider
3052 the server to be hung and give up. Setting this option instructs
3053 `upload-pack` to send an empty keepalive packet every
3054 `uploadpack.keepAlive` seconds. Setting this option to 0
3055 disables keepalive packets entirely. The default is 5 seconds.
3057 uploadpack.packObjectsHook::
3058 If this option is set, when `upload-pack` would run
3059 `git pack-objects` to create a packfile for a client, it will
3060 run this shell command instead. The `pack-objects` command and
3061 arguments it _would_ have run (including the `git pack-objects`
3062 at the beginning) are appended to the shell command. The stdin
3063 and stdout of the hook are treated as if `pack-objects` itself
3064 was run. I.e., `upload-pack` will feed input intended for
3065 `pack-objects` to the hook, and expects a completed packfile on
3068 Note that this configuration variable is ignored if it is seen in the
3069 repository-level config (this is a safety measure against fetching from
3070 untrusted repositories).
3072 url.<base>.insteadOf::
3073 Any URL that starts with this value will be rewritten to
3074 start, instead, with <base>. In cases where some site serves a
3075 large number of repositories, and serves them with multiple
3076 access methods, and some users need to use different access
3077 methods, this feature allows people to specify any of the
3078 equivalent URLs and have Git automatically rewrite the URL to
3079 the best alternative for the particular user, even for a
3080 never-before-seen repository on the site. When more than one
3081 insteadOf strings match a given URL, the longest match is used.
3083 url.<base>.pushInsteadOf::
3084 Any URL that starts with this value will not be pushed to;
3085 instead, it will be rewritten to start with <base>, and the
3086 resulting URL will be pushed to. In cases where some site serves
3087 a large number of repositories, and serves them with multiple
3088 access methods, some of which do not allow push, this feature
3089 allows people to specify a pull-only URL and have Git
3090 automatically use an appropriate URL to push, even for a
3091 never-before-seen repository on the site. When more than one
3092 pushInsteadOf strings match a given URL, the longest match is
3093 used. If a remote has an explicit pushurl, Git will ignore this
3094 setting for that remote.
3097 Your email address to be recorded in any newly created commits.
3098 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3099 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3102 Your full name to be recorded in any newly created commits.
3103 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3104 environment variables. See linkgit:git-commit-tree[1].
3106 user.useConfigOnly::
3107 Instruct Git to avoid trying to guess defaults for `user.email`
3108 and `user.name`, and instead retrieve the values only from the
3109 configuration. For example, if you have multiple email addresses
3110 and would like to use a different one for each repository, then
3111 with this configuration option set to `true` in the global config
3112 along with a name, Git will prompt you to set up an email before
3113 making new commits in a newly cloned repository.
3114 Defaults to `false`.
3117 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3118 key you want it to automatically when creating a signed tag or
3119 commit, you can override the default selection with this variable.
3120 This option is passed unchanged to gpg's --local-user parameter,
3121 so you may specify a key using any method that gpg supports.
3123 versionsort.prereleaseSuffix (deprecated)::
3124 Deprecated alias for `versionsort.suffix`. Ignored if
3125 `versionsort.suffix` is set.
3127 versionsort.suffix::
3128 Even when version sort is used in linkgit:git-tag[1], tagnames
3129 with the same base version but different suffixes are still sorted
3130 lexicographically, resulting e.g. in prerelease tags appearing
3131 after the main release (e.g. "1.0-rc1" after "1.0"). This
3132 variable can be specified to determine the sorting order of tags
3133 with different suffixes.
3135 By specifying a single suffix in this variable, any tagname containing
3136 that suffix will appear before the corresponding main release. E.g. if
3137 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3138 "1.0". If specified multiple times, once per suffix, then the order of
3139 suffixes in the configuration will determine the sorting order of tagnames
3140 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3141 configuration, then all "1.0-preX" tags will be listed before any
3142 "1.0-rcX" tags. The placement of the main release tag relative to tags
3143 with various suffixes can be determined by specifying the empty suffix
3144 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3145 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3146 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3149 If more than one suffixes match the same tagname, then that tagname will
3150 be sorted according to the suffix which starts at the earliest position in
3151 the tagname. If more than one different matching suffixes start at
3152 that earliest position, then that tagname will be sorted according to the
3153 longest of those suffixes.
3154 The sorting order between different suffixes is undefined if they are
3155 in multiple config files.
3158 Specify a web browser that may be used by some commands.
3159 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]