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