4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times; we say then that the variable is
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored. The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
27 The file consists of sections and variables. A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins. Section names are case-insensitive. Only alphanumeric
30 characters, `-` and `.` are allowed in section names. Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
34 Sections can be further divided into subsections. To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
39 [section "subsection"]
43 Subsection names are case sensitive and can contain any characters except
44 newline (doublequote `"` and backslash can be included by escaping them
45 as `\"` and `\\`, respectively). Section headers cannot span multiple
46 lines. Variables may belong directly to a section or to a given subsection.
47 You can have `[section]` if you have `[section "subsection"]`, but you
50 There is also a deprecated `[section.subsection]` syntax. With this
51 syntax, the subsection name is converted to lower-case and is also
52 compared case sensitively. These subsection names follow the same
53 restrictions as section names.
55 All the other lines (and the remainder of the line after the section
56 header) are recognized as setting variables, in the form
57 'name = value' (or just 'name', which is a short-hand to say that
58 the variable is the boolean "true").
59 The variable names are case-insensitive, allow only alphanumeric characters
60 and `-`, and must start with an alphabetic character.
62 A line that defines a value can be continued to the next line by
63 ending it with a `\`; the backquote and the end-of-line are
64 stripped. Leading whitespaces after 'name =', the remainder of the
65 line after the first comment character '#' or ';', and trailing
66 whitespaces of the line are discarded unless they are enclosed in
67 double quotes. Internal whitespaces within the value are retained
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
73 The following escape sequences (beside `\"` and `\\`) are recognized:
74 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
75 and `\b` for backspace (BS). Other char escape sequences (including octal
76 escape sequences) are invalid.
82 You can include one config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 variable takes a pathname as its value, and is subject to tilde
88 included file is expanded immediately, as if its contents had been
89 found at the location of the include directive. If the value of the
90 `include.path` variable is a relative path, the path is considered to be
91 relative to the configuration file in which the include directive was
92 found. See below for examples.
100 ; Don't trust file modes
105 external = /usr/local/bin/diff-wrapper
110 merge = refs/heads/devel
114 gitProxy="ssh" for "kernel.org"
115 gitProxy=default-proxy ; for the rest
118 path = /path/to/foo.inc ; include by absolute path
119 path = foo ; expand "foo" relative to the current file
120 path = ~/foo ; expand "foo" in your `$HOME` directory
126 Values of many variables are treated as a simple string, but there
127 are variables that take values of specific types and there are rules
128 as to how to spell them.
132 When a variable is said to take a boolean value, many
133 synonyms are accepted for 'true' and 'false'; these are all
136 true;; Boolean true can be spelled as `yes`, `on`, `true`,
137 or `1`. Also, a variable defined without `= <value>`
140 false;; Boolean false can be spelled as `no`, `off`,
143 When converting value to the canonical form using '--bool' type
144 specifier; 'git config' will ensure that the output is "true" or
145 "false" (spelled in lowercase).
148 The value for many variables that specify various sizes can
149 be suffixed with `k`, `M`,... to mean "scale the number by
150 1024", "by 1024x1024", etc.
153 The value for a variables that takes a color is a list of
154 colors (at most two) and attributes (at most one), separated
155 by spaces. The colors accepted are `normal`, `black`,
156 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
157 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
158 `reverse`. The first color given is the foreground; the
159 second is the background. The position of the attribute, if
160 any, doesn't matter. Attributes may be turned off specifically
161 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
163 Colors (foreground and background) may also be given as numbers between
164 0 and 255; these use ANSI 256-color mode (but note that not all
165 terminals may support this). If your terminal supports it, you may also
166 specify 24-bit RGB values as hex, like `#ff0ab3`.
168 The attributes are meant to be reset at the beginning of each item
169 in the colored output, so setting color.decorate.branch to `black`
170 will paint that branch name in a plain `black`, even if the previous
171 thing on the same output line (e.g. opening parenthesis before the
172 list of branch names in `log --decorate` output) is set to be
173 painted with `bold` or some other attribute.
176 A variable that takes a pathname value can be given a
177 string that begins with "`~/`" or "`~user/`", and the usual
178 tilde expansion happens to such a string: `~/`
179 is expanded to the value of `$HOME`, and `~user/` to the
180 specified user's home directory.
186 Note that this list is non-comprehensive and not necessarily complete.
187 For command-specific variables, you will find a more detailed description
188 in the appropriate manual page.
190 Other git-related tools may and do use their own variables. When
191 inventing new variables for use in your own tool, make sure their
192 names do not conflict with those that are used by Git itself and
193 other popular tools, and describe them in your documentation.
197 These variables control various optional help messages designed to
198 aid new users. All 'advice.*' variables default to 'true', and you
199 can tell Git that you do not need help by setting these to 'false':
203 Set this variable to 'false' if you want to disable
205 'pushNonFFMatching', 'pushAlreadyExists',
206 'pushFetchFirst', and 'pushNeedsForce'
209 Advice shown when linkgit:git-push[1] fails due to a
210 non-fast-forward update to the current branch.
212 Advice shown when you ran linkgit:git-push[1] and pushed
213 'matching refs' explicitly (i.e. you used ':', or
214 specified a refspec that isn't your current branch) and
215 it resulted in a non-fast-forward error.
217 Shown when linkgit:git-push[1] rejects an update that
218 does not qualify for fast-forwarding (e.g., a tag.)
220 Shown when linkgit:git-push[1] rejects an update that
221 tries to overwrite a remote ref that points at an
222 object we do not have.
224 Shown when linkgit:git-push[1] rejects an update that
225 tries to overwrite a remote ref that points at an
226 object that is not a commit-ish, or make the remote
227 ref point at an object that is not a commit-ish.
229 Show directions on how to proceed from the current
230 state in the output of linkgit:git-status[1], in
231 the template shown when writing commit messages in
232 linkgit:git-commit[1], and in the help message shown
233 by linkgit:git-checkout[1] when switching branch.
235 Advise to consider using the `-u` option to linkgit:git-status[1]
236 when the command takes more than 2 seconds to enumerate untracked
239 Advice shown when linkgit:git-merge[1] refuses to
240 merge to avoid overwriting local changes.
242 Advice shown by various commands when conflicts
243 prevent the operation from being performed.
245 Advice on how to set your identity configuration when
246 your information is guessed from the system username and
249 Advice shown when you used linkgit:git-checkout[1] to
250 move to the detach HEAD state, to instruct how to create
251 a local branch after the fact.
253 Advice that shows the location of the patch file when
254 linkgit:git-am[1] fails to apply it.
256 In case of failure in the output of linkgit:git-rm[1],
257 show directions on how to proceed from the current state.
261 Tells Git if the executable bit of files in the working tree
264 Some filesystems lose the executable bit when a file that is
265 marked as executable is checked out, or checks out an
266 non-executable file with executable bit on.
267 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
268 to see if it handles the executable bit correctly
269 and this variable is automatically set as necessary.
271 A repository, however, may be on a filesystem that handles
272 the filemode correctly, and this variable is set to 'true'
273 when created, but later may be made accessible from another
274 environment that loses the filemode (e.g. exporting ext4 via
275 CIFS mount, visiting a Cygwin created repository with
276 Git for Windows or Eclipse).
277 In such a case it may be necessary to set this variable to 'false'.
278 See linkgit:git-update-index[1].
280 The default is true (when core.filemode is not specified in the config file).
283 If true, this option enables various workarounds to enable
284 Git to work better on filesystems that are not case sensitive,
285 like FAT. For example, if a directory listing finds
286 "makefile" when Git expects "Makefile", Git will assume
287 it is really the same file, and continue to remember it as
290 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
291 will probe and set core.ignoreCase true if appropriate when the repository
294 core.precomposeUnicode::
295 This option is only used by Mac OS implementation of Git.
296 When core.precomposeUnicode=true, Git reverts the unicode decomposition
297 of filenames done by Mac OS. This is useful when sharing a repository
298 between Mac OS and Linux or Windows.
299 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
300 When false, file names are handled fully transparent by Git,
301 which is backward compatible with older versions of Git.
304 If set to true, do not allow checkout of paths that would
305 be considered equivalent to `.git` on an HFS+ filesystem.
306 Defaults to `true` on Mac OS, and `false` elsewhere.
309 If set to true, do not allow checkout of paths that would
310 cause problems with the NTFS filesystem, e.g. conflict with
312 Defaults to `true` on Windows, and `false` elsewhere.
315 If false, the ctime differences between the index and the
316 working tree are ignored; useful when the inode change time
317 is regularly modified by something outside Git (file system
318 crawlers and some backup systems).
319 See linkgit:git-update-index[1]. True by default.
321 core.untrackedCache::
322 Determines what to do about the untracked cache feature of the
323 index. It will be kept, if this variable is unset or set to
324 `keep`. It will automatically be added if set to `true`. And
325 it will automatically be removed, if set to `false`. Before
326 setting it to `true`, you should check that mtime is working
327 properly on your system.
328 See linkgit:git-update-index[1]. `keep` by default.
331 Determines which stat fields to match between the index
332 and work tree. The user can set this to 'default' or
333 'minimal'. Default (or explicitly 'default'), is to check
334 all fields, including the sub-second part of mtime and ctime.
337 The commands that output paths (e.g. 'ls-files',
338 'diff'), when not given the `-z` option, will quote
339 "unusual" characters in the pathname by enclosing the
340 pathname in a double-quote pair and with backslashes the
341 same way strings in C source code are quoted. If this
342 variable is set to false, the bytes higher than 0x80 are
343 not quoted but output as verbatim. Note that double
344 quote, backslash and control characters are always
345 quoted without `-z` regardless of the setting of this
349 Sets the line ending type to use in the working directory for
350 files that have the `text` property set. Alternatives are
351 'lf', 'crlf' and 'native', which uses the platform's native
352 line ending. The default value is `native`. See
353 linkgit:gitattributes[5] for more information on end-of-line
357 If true, makes Git check if converting `CRLF` is reversible when
358 end-of-line conversion is active. Git will verify if a command
359 modifies a file in the work tree either directly or indirectly.
360 For example, committing a file followed by checking out the
361 same file should yield the original file in the work tree. If
362 this is not the case for the current setting of
363 `core.autocrlf`, Git will reject the file. The variable can
364 be set to "warn", in which case Git will only warn about an
365 irreversible conversion but continue the operation.
367 CRLF conversion bears a slight chance of corrupting data.
368 When it is enabled, Git will convert CRLF to LF during commit and LF to
369 CRLF during checkout. A file that contains a mixture of LF and
370 CRLF before the commit cannot be recreated by Git. For text
371 files this is the right thing to do: it corrects line endings
372 such that we have only LF line endings in the repository.
373 But for binary files that are accidentally classified as text the
374 conversion can corrupt data.
376 If you recognize such corruption early you can easily fix it by
377 setting the conversion type explicitly in .gitattributes. Right
378 after committing you still have the original file in your work
379 tree and this file is not yet corrupted. You can explicitly tell
380 Git that this file is binary and Git will handle the file
383 Unfortunately, the desired effect of cleaning up text files with
384 mixed line endings and the undesired effect of corrupting binary
385 files cannot be distinguished. In both cases CRLFs are removed
386 in an irreversible way. For text files this is the right thing
387 to do because CRLFs are line endings, while for binary files
388 converting CRLFs corrupts data.
390 Note, this safety check does not mean that a checkout will generate a
391 file identical to the original file for a different setting of
392 `core.eol` and `core.autocrlf`, but only for the current one. For
393 example, a text file with `LF` would be accepted with `core.eol=lf`
394 and could later be checked out with `core.eol=crlf`, in which case the
395 resulting file would contain `CRLF`, although the original file
396 contained `LF`. However, in both work trees the line endings would be
397 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
398 file with mixed line endings would be reported by the `core.safecrlf`
402 Setting this variable to "true" is almost the same as setting
403 the `text` attribute to "auto" on all files except that text
404 files are not guaranteed to be normalized: files that contain
405 `CRLF` in the repository will not be touched. Use this
406 setting if you want to have `CRLF` line endings in your
407 working directory even though the repository does not have
408 normalized line endings. This variable can be set to 'input',
409 in which case no output conversion is performed.
412 If false, symbolic links are checked out as small plain files that
413 contain the link text. linkgit:git-update-index[1] and
414 linkgit:git-add[1] will not change the recorded type to regular
415 file. Useful on filesystems like FAT that do not support
418 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
419 will probe and set core.symlinks false if appropriate when the repository
423 A "proxy command" to execute (as 'command host port') instead
424 of establishing direct connection to the remote server when
425 using the Git protocol for fetching. If the variable value is
426 in the "COMMAND for DOMAIN" format, the command is applied only
427 on hostnames ending with the specified domain string. This variable
428 may be set multiple times and is matched in the given order;
429 the first match wins.
431 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
432 (which always applies universally, without the special "for"
435 The special string `none` can be used as the proxy command to
436 specify that no proxy be used for a given domain pattern.
437 This is useful for excluding servers inside a firewall from
438 proxy use, while defaulting to a common proxy for external domains.
441 If true, Git will avoid using lstat() calls to detect if files have
442 changed by setting the "assume-unchanged" bit for those tracked files
443 which it has updated identically in both the index and working tree.
445 When files are modified outside of Git, the user will need to stage
446 the modified files explicitly (e.g. see 'Examples' section in
447 linkgit:git-update-index[1]).
448 Git will not normally detect changes to those files.
450 This is useful on systems where lstat() calls are very slow, such as
451 CIFS/Microsoft Windows.
455 core.preferSymlinkRefs::
456 Instead of the default "symref" format for HEAD
457 and other symbolic reference files, use symbolic links.
458 This is sometimes needed to work with old scripts that
459 expect HEAD to be a symbolic link.
462 If true this repository is assumed to be 'bare' and has no
463 working directory associated with it. If this is the case a
464 number of commands that require a working directory will be
465 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
467 This setting is automatically guessed by linkgit:git-clone[1] or
468 linkgit:git-init[1] when the repository was created. By default a
469 repository that ends in "/.git" is assumed to be not bare (bare =
470 false), while all other repositories are assumed to be bare (bare
474 Set the path to the root of the working tree.
475 If GIT_COMMON_DIR environment variable is set, core.worktree
476 is ignored and not used for determining the root of working tree.
477 This can be overridden by the GIT_WORK_TREE environment
478 variable and the '--work-tree' command-line option.
479 The value can be an absolute path or relative to the path to
480 the .git directory, which is either specified by --git-dir
481 or GIT_DIR, or automatically discovered.
482 If --git-dir or GIT_DIR is specified but none of
483 --work-tree, GIT_WORK_TREE and core.worktree is specified,
484 the current working directory is regarded as the top level
485 of your working tree.
487 Note that this variable is honored even when set in a configuration
488 file in a ".git" subdirectory of a directory and its value differs
489 from the latter directory (e.g. "/path/to/.git/config" has
490 core.worktree set to "/different/path"), which is most likely a
491 misconfiguration. Running Git commands in the "/path/to" directory will
492 still use "/different/path" as the root of the work tree and can cause
493 confusion unless you know what you are doing (e.g. you are creating a
494 read-only snapshot of the same index to a location different from the
495 repository's usual working tree).
497 core.logAllRefUpdates::
498 Enable the reflog. Updates to a ref <ref> is logged to the file
499 "`$GIT_DIR/logs/<ref>`", by appending the new and old
500 SHA-1, the date/time and the reason of the update, but
501 only when the file exists. If this configuration
502 variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
503 file is automatically created for branch heads (i.e. under
504 refs/heads/), remote refs (i.e. under refs/remotes/),
505 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
507 This information can be used to determine what commit
508 was the tip of a branch "2 days ago".
510 This value is true by default in a repository that has
511 a working directory associated with it, and false by
512 default in a bare repository.
514 core.repositoryFormatVersion::
515 Internal variable identifying the repository format and layout
518 core.sharedRepository::
519 When 'group' (or 'true'), the repository is made shareable between
520 several users in a group (making sure all the files and objects are
521 group-writable). When 'all' (or 'world' or 'everybody'), the
522 repository will be readable by all users, additionally to being
523 group-shareable. When 'umask' (or 'false'), Git will use permissions
524 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
525 files in the repository will have this mode value. '0xxx' will override
526 user's umask value (whereas the other options will only override
527 requested parts of the user's umask value). Examples: '0660' will make
528 the repo read/write-able for the owner and group, but inaccessible to
529 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
530 repository that is group-readable but not group-writable.
531 See linkgit:git-init[1]. False by default.
533 core.warnAmbiguousRefs::
534 If true, Git will warn you if the ref name you passed it is ambiguous
535 and might match multiple refs in the repository. True by default.
538 An integer -1..9, indicating a default compression level.
539 -1 is the zlib default. 0 means no compression,
540 and 1..9 are various speed/size tradeoffs, 9 being slowest.
541 If set, this provides a default to other compression variables,
542 such as 'core.looseCompression' and 'pack.compression'.
544 core.looseCompression::
545 An integer -1..9, indicating the compression level for objects that
546 are not in a pack file. -1 is the zlib default. 0 means no
547 compression, and 1..9 are various speed/size tradeoffs, 9 being
548 slowest. If not set, defaults to core.compression. If that is
549 not set, defaults to 1 (best speed).
551 core.packedGitWindowSize::
552 Number of bytes of a pack file to map into memory in a
553 single mapping operation. Larger window sizes may allow
554 your system to process a smaller number of large pack files
555 more quickly. Smaller window sizes will negatively affect
556 performance due to increased calls to the operating system's
557 memory manager, but may improve performance when accessing
558 a large number of large pack files.
560 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
561 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
562 be reasonable for all users/operating systems. You probably do
563 not need to adjust this value.
565 Common unit suffixes of 'k', 'm', or 'g' are supported.
567 core.packedGitLimit::
568 Maximum number of bytes to map simultaneously into memory
569 from pack files. If Git needs to access more than this many
570 bytes at once to complete an operation it will unmap existing
571 regions to reclaim virtual address space within the process.
573 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
574 This should be reasonable for all users/operating systems, except on
575 the largest projects. You probably do not need to adjust this value.
577 Common unit suffixes of 'k', 'm', or 'g' are supported.
579 core.deltaBaseCacheLimit::
580 Maximum number of bytes to reserve for caching base objects
581 that may be referenced by multiple deltified objects. By storing the
582 entire decompressed base objects in a cache Git is able
583 to avoid unpacking and decompressing frequently used base
584 objects multiple times.
586 Default is 96 MiB on all platforms. This should be reasonable
587 for all users/operating systems, except on the largest projects.
588 You probably do not need to adjust this value.
590 Common unit suffixes of 'k', 'm', or 'g' are supported.
592 core.bigFileThreshold::
593 Files larger than this size are stored deflated, without
594 attempting delta compression. Storing large files without
595 delta compression avoids excessive memory usage, at the
596 slight expense of increased disk usage. Additionally files
597 larger than this size are always treated as binary.
599 Default is 512 MiB on all platforms. This should be reasonable
600 for most projects as source code and other text files can still
601 be delta compressed, but larger binary media files won't be.
603 Common unit suffixes of 'k', 'm', or 'g' are supported.
606 Specifies the pathname to the file that contains patterns to
607 describe paths that are not meant to be tracked, in addition
608 to '.gitignore' (per-directory) and '.git/info/exclude'.
609 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
610 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
611 is used instead. See linkgit:gitignore[5].
614 Some commands (e.g. svn and http interfaces) that interactively
615 ask for a password can be told to use an external program given
616 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
617 environment variable. If not set, fall back to the value of the
618 'SSH_ASKPASS' environment variable or, failing that, a simple password
619 prompt. The external program shall be given a suitable prompt as
620 command-line argument and write the password on its STDOUT.
622 core.attributesFile::
623 In addition to '.gitattributes' (per-directory) and
624 '.git/info/attributes', Git looks into this file for attributes
625 (see linkgit:gitattributes[5]). Path expansions are made the same
626 way as for `core.excludesFile`. Its default value is
627 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
628 set or empty, `$HOME/.config/git/attributes` is used instead.
631 Commands such as `commit` and `tag` that lets you edit
632 messages by launching an editor uses the value of this
633 variable when it is set, and the environment variable
634 `GIT_EDITOR` is not set. See linkgit:git-var[1].
637 Commands such as `commit` and `tag` that lets you edit
638 messages consider a line that begins with this character
639 commented, and removes them after the editor returns
642 If set to "auto", `git-commit` would select a character that is not
643 the beginning character of any line in existing commit messages.
645 core.packedRefsTimeout::
646 The length of time, in milliseconds, to retry when trying to
647 lock the `packed-refs` file. Value 0 means not to retry at
648 all; -1 means to try indefinitely. Default is 1000 (i.e.,
652 Text editor used by `git rebase -i` for editing the rebase instruction file.
653 The value is meant to be interpreted by the shell when it is used.
654 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
655 When not configured the default commit message editor is used instead.
658 Text viewer for use by Git commands (e.g., 'less'). The value
659 is meant to be interpreted by the shell. The order of preference
660 is the `$GIT_PAGER` environment variable, then `core.pager`
661 configuration, then `$PAGER`, and then the default chosen at
662 compile time (usually 'less').
664 When the `LESS` environment variable is unset, Git sets it to `FRX`
665 (if `LESS` environment variable is set, Git does not change it at
666 all). If you want to selectively override Git's default setting
667 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
668 be passed to the shell by Git, which will translate the final
669 command to `LESS=FRX less -S`. The environment does not set the
670 `S` option but the command line does, instructing less to truncate
671 long lines. Similarly, setting `core.pager` to `less -+F` will
672 deactivate the `F` option specified by the environment from the
673 command-line, deactivating the "quit if one screen" behavior of
674 `less`. One can specifically activate some flags for particular
675 commands: for example, setting `pager.blame` to `less -S` enables
676 line truncation only for `git blame`.
678 Likewise, when the `LV` environment variable is unset, Git sets it
679 to `-c`. You can override this setting by exporting `LV` with
680 another value or setting `core.pager` to `lv +c`.
683 A comma separated list of common whitespace problems to
684 notice. 'git diff' will use `color.diff.whitespace` to
685 highlight them, and 'git apply --whitespace=error' will
686 consider them as errors. You can prefix `-` to disable
687 any of them (e.g. `-trailing-space`):
689 * `blank-at-eol` treats trailing whitespaces at the end of the line
690 as an error (enabled by default).
691 * `space-before-tab` treats a space character that appears immediately
692 before a tab character in the initial indent part of the line as an
693 error (enabled by default).
694 * `indent-with-non-tab` treats a line that is indented with space
695 characters instead of the equivalent tabs as an error (not enabled by
697 * `tab-in-indent` treats a tab character in the initial indent part of
698 the line as an error (not enabled by default).
699 * `blank-at-eof` treats blank lines added at the end of file as an error
700 (enabled by default).
701 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
703 * `cr-at-eol` treats a carriage-return at the end of line as
704 part of the line terminator, i.e. with it, `trailing-space`
705 does not trigger if the character before such a carriage-return
706 is not a whitespace (not enabled by default).
707 * `tabwidth=<n>` tells how many character positions a tab occupies; this
708 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
709 errors. The default tab width is 8. Allowed values are 1 to 63.
711 core.fsyncObjectFiles::
712 This boolean will enable 'fsync()' when writing object files.
714 This is a total waste of time and effort on a filesystem that orders
715 data writes properly, but can be useful for filesystems that do not use
716 journalling (traditional UNIX filesystems) or that only journal metadata
717 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
720 Enable parallel index preload for operations like 'git diff'
722 This can speed up operations like 'git diff' and 'git status' especially
723 on filesystems like NFS that have weak caching semantics and thus
724 relatively high IO latencies. When enabled, Git will do the
725 index comparison to the filesystem data in parallel, allowing
726 overlapping IO's. Defaults to true.
729 You can set this to 'link', in which case a hardlink followed by
730 a delete of the source are used to make sure that object creation
731 will not overwrite existing objects.
733 On some file system/operating system combinations, this is unreliable.
734 Set this config setting to 'rename' there; However, This will remove the
735 check that makes sure that existing object files will not get overwritten.
738 When showing commit messages, also show notes which are stored in
739 the given ref. The ref must be fully qualified. If the given
740 ref does not exist, it is not an error but means that no
741 notes should be printed.
743 This setting defaults to "refs/notes/commits", and it can be overridden by
744 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
746 core.sparseCheckout::
747 Enable "sparse checkout" feature. See section "Sparse checkout" in
748 linkgit:git-read-tree[1] for more information.
751 Set the length object names are abbreviated to. If unspecified,
752 many commands abbreviate to 7 hexdigits, which may not be enough
753 for abbreviated object names to stay unique for sufficiently long
757 add.ignore-errors (deprecated)::
758 Tells 'git add' to continue adding files when some files cannot be
759 added due to indexing errors. Equivalent to the '--ignore-errors'
760 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
761 as it does not follow the usual naming convention for configuration
765 Command aliases for the linkgit:git[1] command wrapper - e.g.
766 after defining "alias.last = cat-file commit HEAD", the invocation
767 "git last" is equivalent to "git cat-file commit HEAD". To avoid
768 confusion and troubles with script usage, aliases that
769 hide existing Git commands are ignored. Arguments are split by
770 spaces, the usual shell quoting and escaping is supported.
771 A quote pair or a backslash can be used to quote them.
773 If the alias expansion is prefixed with an exclamation point,
774 it will be treated as a shell command. For example, defining
775 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
776 "git new" is equivalent to running the shell command
777 "gitk --all --not ORIG_HEAD". Note that shell commands will be
778 executed from the top-level directory of a repository, which may
779 not necessarily be the current directory.
780 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
781 from the original current directory. See linkgit:git-rev-parse[1].
784 If true, git-am will call git-mailsplit for patches in mbox format
785 with parameter '--keep-cr'. In this case git-mailsplit will
786 not remove `\r` from lines ending with `\r\n`. Can be overridden
787 by giving '--no-keep-cr' from the command line.
788 See linkgit:git-am[1], linkgit:git-mailsplit[1].
791 By default, `git am` will fail if the patch does not apply cleanly. When
792 set to true, this setting tells `git am` to fall back on 3-way merge if
793 the patch records the identity of blobs it is supposed to apply to and
794 we have those blobs available locally (equivalent to giving the `--3way`
795 option from the command line). Defaults to `false`.
796 See linkgit:git-am[1].
798 apply.ignoreWhitespace::
799 When set to 'change', tells 'git apply' to ignore changes in
800 whitespace, in the same way as the '--ignore-space-change'
802 When set to one of: no, none, never, false tells 'git apply' to
803 respect all whitespace differences.
804 See linkgit:git-apply[1].
807 Tells 'git apply' how to handle whitespaces, in the same way
808 as the '--whitespace' option. See linkgit:git-apply[1].
810 branch.autoSetupMerge::
811 Tells 'git branch' and 'git checkout' to set up new branches
812 so that linkgit:git-pull[1] will appropriately merge from the
813 starting point branch. Note that even if this option is not set,
814 this behavior can be chosen per-branch using the `--track`
815 and `--no-track` options. The valid settings are: `false` -- no
816 automatic setup is done; `true` -- automatic setup is done when the
817 starting point is a remote-tracking branch; `always` --
818 automatic setup is done when the starting point is either a
819 local branch or remote-tracking
820 branch. This option defaults to true.
822 branch.autoSetupRebase::
823 When a new branch is created with 'git branch' or 'git checkout'
824 that tracks another branch, this variable tells Git to set
825 up pull to rebase instead of merge (see "branch.<name>.rebase").
826 When `never`, rebase is never automatically set to true.
827 When `local`, rebase is set to true for tracked branches of
828 other local branches.
829 When `remote`, rebase is set to true for tracked branches of
830 remote-tracking branches.
831 When `always`, rebase will be set to true for all tracking
833 See "branch.autoSetupMerge" for details on how to set up a
834 branch to track another branch.
835 This option defaults to never.
837 branch.<name>.remote::
838 When on branch <name>, it tells 'git fetch' and 'git push'
839 which remote to fetch from/push to. The remote to push to
840 may be overridden with `remote.pushDefault` (for all branches).
841 The remote to push to, for the current branch, may be further
842 overridden by `branch.<name>.pushRemote`. If no remote is
843 configured, or if you are not on any branch, it defaults to
844 `origin` for fetching and `remote.pushDefault` for pushing.
845 Additionally, `.` (a period) is the current local repository
846 (a dot-repository), see `branch.<name>.merge`'s final note below.
848 branch.<name>.pushRemote::
849 When on branch <name>, it overrides `branch.<name>.remote` for
850 pushing. It also overrides `remote.pushDefault` for pushing
851 from branch <name>. When you pull from one place (e.g. your
852 upstream) and push to another place (e.g. your own publishing
853 repository), you would want to set `remote.pushDefault` to
854 specify the remote to push to for all branches, and use this
855 option to override it for a specific branch.
857 branch.<name>.merge::
858 Defines, together with branch.<name>.remote, the upstream branch
859 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
860 branch to merge and can also affect 'git push' (see push.default).
861 When in branch <name>, it tells 'git fetch' the default
862 refspec to be marked for merging in FETCH_HEAD. The value is
863 handled like the remote part of a refspec, and must match a
864 ref which is fetched from the remote given by
865 "branch.<name>.remote".
866 The merge information is used by 'git pull' (which at first calls
867 'git fetch') to lookup the default branch for merging. Without
868 this option, 'git pull' defaults to merge the first refspec fetched.
869 Specify multiple values to get an octopus merge.
870 If you wish to setup 'git pull' so that it merges into <name> from
871 another branch in the local repository, you can point
872 branch.<name>.merge to the desired branch, and use the relative path
873 setting `.` (a period) for branch.<name>.remote.
875 branch.<name>.mergeOptions::
876 Sets default options for merging into branch <name>. The syntax and
877 supported options are the same as those of linkgit:git-merge[1], but
878 option values containing whitespace characters are currently not
881 branch.<name>.rebase::
882 When true, rebase the branch <name> on top of the fetched branch,
883 instead of merging the default branch from the default remote when
884 "git pull" is run. See "pull.rebase" for doing this in a non
885 branch-specific manner.
887 When preserve, also pass `--preserve-merges` along to 'git rebase'
888 so that locally committed merge commits will not be flattened
889 by running 'git pull'.
891 When the value is `interactive`, the rebase is run in interactive mode.
893 *NOTE*: this is a possibly dangerous operation; do *not* use
894 it unless you understand the implications (see linkgit:git-rebase[1]
897 branch.<name>.description::
898 Branch description, can be edited with
899 `git branch --edit-description`. Branch description is
900 automatically added in the format-patch cover letter or
901 request-pull summary.
904 Specify the command to invoke the specified browser. The
905 specified command is evaluated in shell with the URLs passed
906 as arguments. (See linkgit:git-web{litdd}browse[1].)
908 browser.<tool>.path::
909 Override the path for the given tool that may be used to
910 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
911 working repository in gitweb (see linkgit:git-instaweb[1]).
914 A boolean to make git-clean do nothing unless given -f,
915 -i or -n. Defaults to true.
918 A boolean to enable/disable color in the output of
919 linkgit:git-branch[1]. May be set to `always`,
920 `false` (or `never`) or `auto` (or `true`), in which case colors are used
921 only when the output is to a terminal. Defaults to false.
923 color.branch.<slot>::
924 Use customized color for branch coloration. `<slot>` is one of
925 `current` (the current branch), `local` (a local branch),
926 `remote` (a remote-tracking branch in refs/remotes/),
927 `upstream` (upstream tracking branch), `plain` (other
931 Whether to use ANSI escape sequences to add color to patches.
932 If this is set to `always`, linkgit:git-diff[1],
933 linkgit:git-log[1], and linkgit:git-show[1] will use color
934 for all patches. If it is set to `true` or `auto`, those
935 commands will only use color when output is to the terminal.
938 This does not affect linkgit:git-format-patch[1] or the
939 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
940 command line with the `--color[=<when>]` option.
943 Use customized color for diff colorization. `<slot>` specifies
944 which part of the patch to use the specified color, and is one
945 of `context` (context text - `plain` is a historical synonym),
946 `meta` (metainformation), `frag`
947 (hunk header), 'func' (function in hunk header), `old` (removed lines),
948 `new` (added lines), `commit` (commit headers), or `whitespace`
949 (highlighting whitespace errors).
951 color.decorate.<slot>::
952 Use customized color for 'git log --decorate' output. `<slot>` is one
953 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
954 branches, remote-tracking branches, tags, stash and HEAD, respectively.
957 When set to `always`, always highlight matches. When `false` (or
958 `never`), never. When set to `true` or `auto`, use color only
959 when the output is written to the terminal. Defaults to `false`.
962 Use customized color for grep colorization. `<slot>` specifies which
963 part of the line to use the specified color, and is one of
967 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
969 filename prefix (when not using `-h`)
971 function name lines (when using `-p`)
973 line number prefix (when using `-n`)
975 matching text (same as setting `matchContext` and `matchSelected`)
977 matching text in context lines
979 matching text in selected lines
981 non-matching text in selected lines
983 separators between fields on a line (`:`, `-`, and `=`)
984 and between hunks (`--`)
988 When set to `always`, always use colors for interactive prompts
989 and displays (such as those used by "git-add --interactive" and
990 "git-clean --interactive"). When false (or `never`), never.
991 When set to `true` or `auto`, use colors only when the output is
992 to the terminal. Defaults to false.
994 color.interactive.<slot>::
995 Use customized color for 'git add --interactive' and 'git clean
996 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
997 or `error`, for four distinct types of normal output from
998 interactive commands.
1001 A boolean to enable/disable colored output when the pager is in
1002 use (default is true).
1005 A boolean to enable/disable color in the output of
1006 linkgit:git-show-branch[1]. May be set to `always`,
1007 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1008 only when the output is to a terminal. Defaults to false.
1011 A boolean to enable/disable color in the output of
1012 linkgit:git-status[1]. May be set to `always`,
1013 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1014 only when the output is to a terminal. Defaults to false.
1016 color.status.<slot>::
1017 Use customized color for status colorization. `<slot>` is
1018 one of `header` (the header text of the status message),
1019 `added` or `updated` (files which are added but not committed),
1020 `changed` (files which are changed but not added in the index),
1021 `untracked` (files which are not tracked by Git),
1022 `branch` (the current branch),
1023 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1025 `unmerged` (files which have unmerged changes).
1028 This variable determines the default value for variables such
1029 as `color.diff` and `color.grep` that control the use of color
1030 per command family. Its scope will expand as more commands learn
1031 configuration to set a default for the `--color` option. Set it
1032 to `false` or `never` if you prefer Git commands not to use
1033 color unless enabled explicitly with some other configuration
1034 or the `--color` option. Set it to `always` if you want all
1035 output not intended for machine consumption to use color, to
1036 `true` or `auto` (this is the default since Git 1.8.4) if you
1037 want such output to use color when written to the terminal.
1040 Specify whether supported commands should output in columns.
1041 This variable consists of a list of tokens separated by spaces
1044 These options control when the feature should be enabled
1045 (defaults to 'never'):
1049 always show in columns
1051 never show in columns
1053 show in columns if the output is to the terminal
1056 These options control layout (defaults to 'column'). Setting any
1057 of these implies 'always' if none of 'always', 'never', or 'auto' are
1062 fill columns before rows
1064 fill rows before columns
1069 Finally, these options can be combined with a layout option (defaults
1074 make unequal size columns to utilize more space
1076 make equal size columns
1080 Specify whether to output branch listing in `git branch` in columns.
1081 See `column.ui` for details.
1084 Specify the layout when list items in `git clean -i`, which always
1085 shows files and directories in columns. See `column.ui` for details.
1088 Specify whether to output untracked files in `git status` in columns.
1089 See `column.ui` for details.
1092 Specify whether to output tag listing in `git tag` in columns.
1093 See `column.ui` for details.
1096 This setting overrides the default of the `--cleanup` option in
1097 `git commit`. See linkgit:git-commit[1] for details. Changing the
1098 default can be useful when you always want to keep lines that begin
1099 with comment character `#` in your log message, in which case you
1100 would do `git config commit.cleanup whitespace` (note that you will
1101 have to remove the help lines that begin with `#` in the commit log
1102 template yourself, if you do this).
1106 A boolean to specify whether all commits should be GPG signed.
1107 Use of this option when doing operations such as rebase can
1108 result in a large number of commits being signed. It may be
1109 convenient to use an agent to avoid typing your GPG passphrase
1113 A boolean to enable/disable inclusion of status information in the
1114 commit message template when using an editor to prepare the commit
1115 message. Defaults to true.
1118 Specify the pathname of a file to use as the template for
1119 new commit messages.
1122 Specify an external helper to be called when a username or
1123 password credential is needed; the helper may consult external
1124 storage to avoid prompting the user for the credentials. See
1125 linkgit:gitcredentials[7] for details.
1127 credential.useHttpPath::
1128 When acquiring credentials, consider the "path" component of an http
1129 or https URL to be important. Defaults to false. See
1130 linkgit:gitcredentials[7] for more information.
1132 credential.username::
1133 If no username is set for a network authentication, use this username
1134 by default. See credential.<context>.* below, and
1135 linkgit:gitcredentials[7].
1137 credential.<url>.*::
1138 Any of the credential.* options above can be applied selectively to
1139 some credentials. For example "credential.https://example.com.username"
1140 would set the default username only for https connections to
1141 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1144 credentialCache.ignoreSIGHUP::
1145 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1147 include::diff-config.txt[]
1149 difftool.<tool>.path::
1150 Override the path for the given tool. This is useful in case
1151 your tool is not in the PATH.
1153 difftool.<tool>.cmd::
1154 Specify the command to invoke the specified diff tool.
1155 The specified command is evaluated in shell with the following
1156 variables available: 'LOCAL' is set to the name of the temporary
1157 file containing the contents of the diff pre-image and 'REMOTE'
1158 is set to the name of the temporary file containing the contents
1159 of the diff post-image.
1162 Prompt before each invocation of the diff tool.
1164 fetch.recurseSubmodules::
1165 This option can be either set to a boolean value or to 'on-demand'.
1166 Setting it to a boolean changes the behavior of fetch and pull to
1167 unconditionally recurse into submodules when set to true or to not
1168 recurse at all when set to false. When set to 'on-demand' (the default
1169 value), fetch and pull will only recurse into a populated submodule
1170 when its superproject retrieves a commit that updates the submodule's
1174 If it is set to true, git-fetch-pack will check all fetched
1175 objects. It will abort in the case of a malformed object or a
1176 broken link. The result of an abort are only dangling objects.
1177 Defaults to false. If not set, the value of `transfer.fsckObjects`
1181 If the number of objects fetched over the Git native
1182 transfer is below this
1183 limit, then the objects will be unpacked into loose object
1184 files. However if the number of received objects equals or
1185 exceeds this limit then the received pack will be stored as
1186 a pack, after adding any missing delta bases. Storing the
1187 pack from a push can make the push operation complete faster,
1188 especially on slow filesystems. If not set, the value of
1189 `transfer.unpackLimit` is used instead.
1192 If true, fetch will automatically behave as if the `--prune`
1193 option was given on the command line. See also `remote.<name>.prune`.
1196 Enable multipart/mixed attachments as the default for
1197 'format-patch'. The value can also be a double quoted string
1198 which will enable attachments as the default and set the
1199 value as the boundary. See the --attach option in
1200 linkgit:git-format-patch[1].
1203 A boolean which can enable or disable sequence numbers in patch
1204 subjects. It defaults to "auto" which enables it only if there
1205 is more than one patch. It can be enabled or disabled for all
1206 messages by setting it to "true" or "false". See --numbered
1207 option in linkgit:git-format-patch[1].
1210 Additional email headers to include in a patch to be submitted
1211 by mail. See linkgit:git-format-patch[1].
1215 Additional recipients to include in a patch to be submitted
1216 by mail. See the --to and --cc options in
1217 linkgit:git-format-patch[1].
1219 format.subjectPrefix::
1220 The default for format-patch is to output files with the '[PATCH]'
1221 subject prefix. Use this variable to change that prefix.
1224 The default for format-patch is to output a signature containing
1225 the Git version number. Use this variable to change that default.
1226 Set this variable to the empty string ("") to suppress
1227 signature generation.
1229 format.signatureFile::
1230 Works just like format.signature except the contents of the
1231 file specified by this variable will be used as the signature.
1234 The default for format-patch is to output files with the suffix
1235 `.patch`. Use this variable to change that suffix (make sure to
1236 include the dot if you want it).
1239 The default pretty format for log/show/whatchanged command,
1240 See linkgit:git-log[1], linkgit:git-show[1],
1241 linkgit:git-whatchanged[1].
1244 The default threading style for 'git format-patch'. Can be
1245 a boolean value, or `shallow` or `deep`. `shallow` threading
1246 makes every mail a reply to the head of the series,
1247 where the head is chosen from the cover letter, the
1248 `--in-reply-to`, and the first patch mail, in this order.
1249 `deep` threading makes every mail a reply to the previous one.
1250 A true boolean value is the same as `shallow`, and a false
1251 value disables threading.
1254 A boolean value which lets you enable the `-s/--signoff` option of
1255 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1256 patch should be a conscious act and means that you certify you have
1257 the rights to submit this work under the same open source license.
1258 Please see the 'SubmittingPatches' document for further discussion.
1260 format.coverLetter::
1261 A boolean that controls whether to generate a cover-letter when
1262 format-patch is invoked, but in addition can be set to "auto", to
1263 generate a cover-letter only when there's more than one patch.
1265 format.outputDirectory::
1266 Set a custom directory to store the resulting files instead of the
1267 current working directory.
1269 filter.<driver>.clean::
1270 The command which is used to convert the content of a worktree
1271 file to a blob upon checkin. See linkgit:gitattributes[5] for
1274 filter.<driver>.smudge::
1275 The command which is used to convert the content of a blob
1276 object to a worktree file upon checkout. See
1277 linkgit:gitattributes[5] for details.
1280 Allows overriding the message type (error, warn or ignore) of a
1281 specific message ID such as `missingEmail`.
1283 For convenience, fsck prefixes the error/warning with the message ID,
1284 e.g. "missingEmail: invalid author/committer line - missing email" means
1285 that setting `fsck.missingEmail = ignore` will hide that issue.
1287 This feature is intended to support working with legacy repositories
1288 which cannot be repaired without disruptive changes.
1291 The path to a sorted list of object names (i.e. one SHA-1 per
1292 line) that are known to be broken in a non-fatal way and should
1293 be ignored. This feature is useful when an established project
1294 should be accepted despite early commits containing errors that
1295 can be safely ignored such as invalid committer email addresses.
1296 Note: corrupt objects cannot be skipped with this setting.
1298 gc.aggressiveDepth::
1299 The depth parameter used in the delta compression
1300 algorithm used by 'git gc --aggressive'. This defaults
1303 gc.aggressiveWindow::
1304 The window size parameter used in the delta compression
1305 algorithm used by 'git gc --aggressive'. This defaults
1309 When there are approximately more than this many loose
1310 objects in the repository, `git gc --auto` will pack them.
1311 Some Porcelain commands use this command to perform a
1312 light-weight garbage collection from time to time. The
1313 default value is 6700. Setting this to 0 disables it.
1316 When there are more than this many packs that are not
1317 marked with `*.keep` file in the repository, `git gc
1318 --auto` consolidates them into one larger pack. The
1319 default value is 50. Setting this to 0 disables it.
1322 Make `git gc --auto` return immediately and run in background
1323 if the system supports it. Default is true.
1326 Running `git pack-refs` in a repository renders it
1327 unclonable by Git versions prior to 1.5.1.2 over dumb
1328 transports such as HTTP. This variable determines whether
1329 'git gc' runs `git pack-refs`. This can be set to `notbare`
1330 to enable it within all non-bare repos or it can be set to a
1331 boolean value. The default is `true`.
1334 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1335 Override the grace period with this config variable. The value
1336 "now" may be used to disable this grace period and always prune
1337 unreachable objects immediately, or "never" may be used to
1340 gc.worktreePruneExpire::
1341 When 'git gc' is run, it calls
1342 'git worktree prune --expire 3.months.ago'.
1343 This config variable can be used to set a different grace
1344 period. The value "now" may be used to disable the grace
1345 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1346 may be used to suppress pruning.
1349 gc.<pattern>.reflogExpire::
1350 'git reflog expire' removes reflog entries older than
1351 this time; defaults to 90 days. The value "now" expires all
1352 entries immediately, and "never" suppresses expiration
1353 altogether. With "<pattern>" (e.g.
1354 "refs/stash") in the middle the setting applies only to
1355 the refs that match the <pattern>.
1357 gc.reflogExpireUnreachable::
1358 gc.<pattern>.reflogExpireUnreachable::
1359 'git reflog expire' removes reflog entries older than
1360 this time and are not reachable from the current tip;
1361 defaults to 30 days. The value "now" expires all entries
1362 immediately, and "never" suppresses expiration altogether.
1363 With "<pattern>" (e.g. "refs/stash")
1364 in the middle, the setting applies only to the refs that
1365 match the <pattern>.
1368 Records of conflicted merge you resolved earlier are
1369 kept for this many days when 'git rerere gc' is run.
1370 The default is 60 days. See linkgit:git-rerere[1].
1372 gc.rerereUnresolved::
1373 Records of conflicted merge you have not resolved are
1374 kept for this many days when 'git rerere gc' is run.
1375 The default is 15 days. See linkgit:git-rerere[1].
1377 gitcvs.commitMsgAnnotation::
1378 Append this string to each commit message. Set to empty string
1379 to disable this feature. Defaults to "via git-CVS emulator".
1382 Whether the CVS server interface is enabled for this repository.
1383 See linkgit:git-cvsserver[1].
1386 Path to a log file where the CVS server interface well... logs
1387 various stuff. See linkgit:git-cvsserver[1].
1389 gitcvs.usecrlfattr::
1390 If true, the server will look up the end-of-line conversion
1391 attributes for files to determine the '-k' modes to use. If
1392 the attributes force Git to treat a file as text,
1393 the '-k' mode will be left blank so CVS clients will
1394 treat it as text. If they suppress text conversion, the file
1395 will be set with '-kb' mode, which suppresses any newline munging
1396 the client might otherwise do. If the attributes do not allow
1397 the file type to be determined, then 'gitcvs.allBinary' is
1398 used. See linkgit:gitattributes[5].
1401 This is used if 'gitcvs.usecrlfattr' does not resolve
1402 the correct '-kb' mode to use. If true, all
1403 unresolved files are sent to the client in
1404 mode '-kb'. This causes the client to treat them
1405 as binary files, which suppresses any newline munging it
1406 otherwise might do. Alternatively, if it is set to "guess",
1407 then the contents of the file are examined to decide if
1408 it is binary, similar to 'core.autocrlf'.
1411 Database used by git-cvsserver to cache revision information
1412 derived from the Git repository. The exact meaning depends on the
1413 used database driver, for SQLite (which is the default driver) this
1414 is a filename. Supports variable substitution (see
1415 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1416 Default: '%Ggitcvs.%m.sqlite'
1419 Used Perl DBI driver. You can specify any available driver
1420 for this here, but it might not work. git-cvsserver is tested
1421 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1422 reported *not* to work with 'DBD::mysql'. Experimental feature.
1423 May not contain double colons (`:`). Default: 'SQLite'.
1424 See linkgit:git-cvsserver[1].
1426 gitcvs.dbUser, gitcvs.dbPass::
1427 Database user and password. Only useful if setting 'gitcvs.dbDriver',
1428 since SQLite has no concept of database users and/or passwords.
1429 'gitcvs.dbUser' supports variable substitution (see
1430 linkgit:git-cvsserver[1] for details).
1432 gitcvs.dbTableNamePrefix::
1433 Database table name prefix. Prepended to the names of any
1434 database tables used, allowing a single database to be used
1435 for several repositories. Supports variable substitution (see
1436 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1437 characters will be replaced with underscores.
1439 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1440 'gitcvs.allBinary' can also be specified as
1441 'gitcvs.<access_method>.<varname>' (where 'access_method'
1442 is one of "ext" and "pserver") to make them apply only for the given
1446 gitweb.description::
1449 See linkgit:gitweb[1] for description.
1457 gitweb.remote_heads::
1460 See linkgit:gitweb.conf[5] for description.
1463 If set to true, enable '-n' option by default.
1466 Set the default matching behavior. Using a value of 'basic', 'extended',
1467 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1468 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1469 value 'default' will return to the default matching behavior.
1471 grep.extendedRegexp::
1472 If set to true, enable '--extended-regexp' option by default. This
1473 option is ignored when the 'grep.patternType' option is set to a value
1474 other than 'default'.
1477 Number of grep worker threads to use.
1478 See `grep.threads` in linkgit:git-grep[1] for more information.
1480 grep.fallbackToNoIndex::
1481 If set to true, fall back to git grep --no-index if git grep
1482 is executed outside of a git repository. Defaults to false.
1485 Use this custom program instead of "`gpg`" found on `$PATH` when
1486 making or verifying a PGP signature. The program must support the
1487 same command-line interface as GPG, namely, to verify a detached
1488 signature, "`gpg --verify $file - <$signature`" is run, and the
1489 program is expected to signal a good signature by exiting with
1490 code 0, and to generate an ASCII-armored detached signature, the
1491 standard input of "`gpg -bsau $key`" is fed with the contents to be
1492 signed, and the program is expected to send the result to its
1495 gui.commitMsgWidth::
1496 Defines how wide the commit message window is in the
1497 linkgit:git-gui[1]. "75" is the default.
1500 Specifies how many context lines should be used in calls to diff
1501 made by the linkgit:git-gui[1]. The default is "5".
1503 gui.displayUntracked::
1504 Determines if linkgit::git-gui[1] shows untracked files
1505 in the file list. The default is "true".
1508 Specifies the default encoding to use for displaying of
1509 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1510 It can be overridden by setting the 'encoding' attribute
1511 for relevant files (see linkgit:gitattributes[5]).
1512 If this option is not set, the tools default to the
1515 gui.matchTrackingBranch::
1516 Determines if new branches created with linkgit:git-gui[1] should
1517 default to tracking remote branches with matching names or
1518 not. Default: "false".
1520 gui.newBranchTemplate::
1521 Is used as suggested name when creating new branches using the
1524 gui.pruneDuringFetch::
1525 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1526 performing a fetch. The default value is "false".
1529 Determines if linkgit:git-gui[1] should trust the file modification
1530 timestamp or not. By default the timestamps are not trusted.
1532 gui.spellingDictionary::
1533 Specifies the dictionary used for spell checking commit messages in
1534 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1538 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1539 location detection. It makes blame significantly faster on huge
1540 repositories at the expense of less thorough copy detection.
1542 gui.copyBlameThreshold::
1543 Specifies the threshold to use in 'git gui blame' original location
1544 detection, measured in alphanumeric characters. See the
1545 linkgit:git-blame[1] manual for more information on copy detection.
1547 gui.blamehistoryctx::
1548 Specifies the radius of history context in days to show in
1549 linkgit:gitk[1] for the selected commit, when the `Show History
1550 Context` menu item is invoked from 'git gui blame'. If this
1551 variable is set to zero, the whole history is shown.
1553 guitool.<name>.cmd::
1554 Specifies the shell command line to execute when the corresponding item
1555 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1556 mandatory for every tool. The command is executed from the root of
1557 the working directory, and in the environment it receives the name of
1558 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1559 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1560 the head is detached, 'CUR_BRANCH' is empty).
1562 guitool.<name>.needsFile::
1563 Run the tool only if a diff is selected in the GUI. It guarantees
1564 that 'FILENAME' is not empty.
1566 guitool.<name>.noConsole::
1567 Run the command silently, without creating a window to display its
1570 guitool.<name>.noRescan::
1571 Don't rescan the working directory for changes after the tool
1574 guitool.<name>.confirm::
1575 Show a confirmation dialog before actually running the tool.
1577 guitool.<name>.argPrompt::
1578 Request a string argument from the user, and pass it to the tool
1579 through the 'ARGS' environment variable. Since requesting an
1580 argument implies confirmation, the 'confirm' option has no effect
1581 if this is enabled. If the option is set to 'true', 'yes', or '1',
1582 the dialog uses a built-in generic prompt; otherwise the exact
1583 value of the variable is used.
1585 guitool.<name>.revPrompt::
1586 Request a single valid revision from the user, and set the
1587 'REVISION' environment variable. In other aspects this option
1588 is similar to 'argPrompt', and can be used together with it.
1590 guitool.<name>.revUnmerged::
1591 Show only unmerged branches in the 'revPrompt' subdialog.
1592 This is useful for tools similar to merge or rebase, but not
1593 for things like checkout or reset.
1595 guitool.<name>.title::
1596 Specifies the title to use for the prompt dialog. The default
1599 guitool.<name>.prompt::
1600 Specifies the general prompt string to display at the top of
1601 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1602 The default value includes the actual command.
1605 Specify the browser that will be used to display help in the
1606 'web' format. See linkgit:git-help[1].
1609 Override the default help format used by linkgit:git-help[1].
1610 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1611 the default. 'web' and 'html' are the same.
1614 Automatically correct and execute mistyped commands after
1615 waiting for the given number of deciseconds (0.1 sec). If more
1616 than one command can be deduced from the entered text, nothing
1617 will be executed. If the value of this option is negative,
1618 the corrected command will be executed immediately. If the
1619 value is 0 - the command will be just shown but not executed.
1620 This is the default.
1623 Specify the path where the HTML documentation resides. File system paths
1624 and URLs are supported. HTML pages will be prefixed with this path when
1625 help is displayed in the 'web' format. This defaults to the documentation
1626 path of your Git installation.
1629 Override the HTTP proxy, normally configured using the 'http_proxy',
1630 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1631 addition to the syntax understood by curl, it is possible to specify a
1632 proxy string with a user name but no password, in which case git will
1633 attempt to acquire one in the same way it does for other credentials. See
1634 linkgit:gitcredentials[7] for more information. The syntax thus is
1635 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1636 on a per-remote basis; see remote.<name>.proxy
1638 http.proxyAuthMethod::
1639 Set the method with which to authenticate against the HTTP proxy. This
1640 only takes effect if the configured proxy string contains a user name part
1641 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1642 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1643 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1644 variable. Possible values are:
1647 * `anyauth` - Automatically pick a suitable authentication method. It is
1648 assumed that the proxy answers an unauthenticated request with a 407
1649 status code and one or more Proxy-authenticate headers with supported
1650 authentication methods. This is the default.
1651 * `basic` - HTTP Basic authentication
1652 * `digest` - HTTP Digest authentication; this prevents the password from being
1653 transmitted to the proxy in clear text
1654 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1656 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1660 Attempt authentication without seeking a username or password. This
1661 can be used to attempt GSS-Negotiate authentication without specifying
1662 a username in the URL, as libcurl normally requires a username for
1666 File containing previously stored cookie lines which should be used
1667 in the Git http session, if they match the server. The file format
1668 of the file to read cookies from should be plain HTTP headers or
1669 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1670 NOTE that the file specified with http.cookieFile is only used as
1671 input unless http.saveCookies is set.
1674 If set, store cookies received during requests to the file specified by
1675 http.cookieFile. Has no effect if http.cookieFile is unset.
1678 The SSL version to use when negotiating an SSL connection, if you
1679 want to force the default. The available and default version
1680 depend on whether libcurl was built against NSS or OpenSSL and the
1681 particular configuration of the crypto library in use. Internally
1682 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1683 documentation for more details on the format of this option and
1684 for the ssl version supported. Actually the possible values of
1695 Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1696 To force git to use libcurl's default ssl version and ignore any
1697 explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1700 http.sslCipherList::
1701 A list of SSL ciphers to use when negotiating an SSL connection.
1702 The available ciphers depend on whether libcurl was built against
1703 NSS or OpenSSL and the particular configuration of the crypto
1704 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1705 option; see the libcurl documentation for more details on the format
1708 Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1709 To force git to use libcurl's default cipher list and ignore any
1710 explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1714 Whether to verify the SSL certificate when fetching or pushing
1715 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1719 File containing the SSL certificate when fetching or pushing
1720 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1724 File containing the SSL private key when fetching or pushing
1725 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1728 http.sslCertPasswordProtected::
1729 Enable Git's password prompt for the SSL certificate. Otherwise
1730 OpenSSL will prompt the user, possibly many times, if the
1731 certificate or private key is encrypted. Can be overridden by the
1732 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1735 File containing the certificates to verify the peer with when
1736 fetching or pushing over HTTPS. Can be overridden by the
1737 'GIT_SSL_CAINFO' environment variable.
1740 Path containing files with the CA certificates to verify the peer
1741 with when fetching or pushing over HTTPS. Can be overridden
1742 by the 'GIT_SSL_CAPATH' environment variable.
1745 Public key of the https service. It may either be the filename of
1746 a PEM or DER encoded public key file or a string starting with
1747 'sha256//' followed by the base64 encoded sha256 hash of the
1748 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1749 exit with an error if this option is set but not supported by
1753 Attempt to use AUTH SSL/TLS and encrypted data transfers
1754 when connecting via regular FTP protocol. This might be needed
1755 if the FTP server requires it for security reasons or you wish
1756 to connect securely whenever remote FTP server supports it.
1757 Default is false since it might trigger certificate verification
1758 errors on misconfigured servers.
1761 How many HTTP requests to launch in parallel. Can be overridden
1762 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1765 The number of curl sessions (counted across slots) to be kept across
1766 requests. They will not be ended with curl_easy_cleanup() until
1767 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1768 value will be capped at 1. Defaults to 1.
1771 Maximum size in bytes of the buffer used by smart HTTP
1772 transports when POSTing data to the remote system.
1773 For requests larger than this buffer size, HTTP/1.1 and
1774 Transfer-Encoding: chunked is used to avoid creating a
1775 massive pack file locally. Default is 1 MiB, which is
1776 sufficient for most requests.
1778 http.lowSpeedLimit, http.lowSpeedTime::
1779 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1780 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1781 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1782 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1785 A boolean which disables using of EPSV ftp command by curl.
1786 This can helpful with some "poor" ftp servers which don't
1787 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1788 environment variable. Default is false (curl will use EPSV).
1791 The HTTP USER_AGENT string presented to an HTTP server. The default
1792 value represents the version of the client Git such as git/1.7.1.
1793 This option allows you to override this value to a more common value
1794 such as Mozilla/4.0. This may be necessary, for instance, if
1795 connecting through a firewall that restricts HTTP connections to a set
1796 of common USER_AGENT strings (but not including those like git/1.7.1).
1797 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1800 Any of the http.* options above can be applied selectively to some URLs.
1801 For a config key to match a URL, each element of the config key is
1802 compared to that of the URL, in the following order:
1805 . Scheme (e.g., `https` in `https://example.com/`). This field
1806 must match exactly between the config key and the URL.
1808 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1809 This field must match exactly between the config key and the URL.
1811 . Port number (e.g., `8080` in `http://example.com:8080/`).
1812 This field must match exactly between the config key and the URL.
1813 Omitted port numbers are automatically converted to the correct
1814 default for the scheme before matching.
1816 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1817 path field of the config key must match the path field of the URL
1818 either exactly or as a prefix of slash-delimited path elements. This means
1819 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1820 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1821 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1822 key with just path `foo/`).
1824 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1825 the config key has a user name it must match the user name in the
1826 URL exactly. If the config key does not have a user name, that
1827 config key will match a URL with any user name (including none),
1828 but at a lower precedence than a config key with a user name.
1831 The list above is ordered by decreasing precedence; a URL that matches
1832 a config key's path is preferred to one that matches its user name. For example,
1833 if the URL is `https://user@example.com/foo/bar` a config key match of
1834 `https://example.com/foo` will be preferred over a config key match of
1835 `https://user@example.com`.
1837 All URLs are normalized before attempting any matching (the password part,
1838 if embedded in the URL, is always ignored for matching purposes) so that
1839 equivalent URLs that are simply spelled differently will match properly.
1840 Environment variable settings always override any matches. The URLs that are
1841 matched against are those given directly to Git commands. This means any URLs
1842 visited as a result of a redirection do not participate in matching.
1844 i18n.commitEncoding::
1845 Character encoding the commit messages are stored in; Git itself
1846 does not care per se, but this information is necessary e.g. when
1847 importing commits from emails or in the gitk graphical history
1848 browser (and possibly at other places in the future or in other
1849 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1851 i18n.logOutputEncoding::
1852 Character encoding the commit messages are converted to when
1853 running 'git log' and friends.
1856 The configuration variables in the 'imap' section are described
1857 in linkgit:git-imap-send[1].
1860 Specify the version with which new index files should be
1861 initialized. This does not affect existing repositories.
1864 Specify the directory from which templates will be copied.
1865 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1868 Specify the program that will be used to browse your working
1869 repository in gitweb. See linkgit:git-instaweb[1].
1872 The HTTP daemon command-line to start gitweb on your working
1873 repository. See linkgit:git-instaweb[1].
1876 If true the web server started by linkgit:git-instaweb[1] will
1877 be bound to the local IP (127.0.0.1).
1879 instaweb.modulePath::
1880 The default module path for linkgit:git-instaweb[1] to use
1881 instead of /usr/lib/apache2/modules. Only used if httpd
1885 The port number to bind the gitweb httpd to. See
1886 linkgit:git-instaweb[1].
1888 interactive.singleKey::
1889 In interactive commands, allow the user to provide one-letter
1890 input with a single key (i.e., without hitting enter).
1891 Currently this is used by the `--patch` mode of
1892 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1893 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1894 setting is silently ignored if portable keystroke input
1895 is not available; requires the Perl module Term::ReadKey.
1898 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1899 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1900 override this option with `--no-abbrev-commit`.
1903 Set the default date-time mode for the 'log' command.
1904 Setting a value for log.date is similar to using 'git log''s
1905 `--date` option. See linkgit:git-log[1] for details.
1908 Print out the ref names of any commits that are shown by the log
1909 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1910 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1911 specified, the full ref name (including prefix) will be printed.
1912 This is the same as the log commands '--decorate' option.
1915 If `true`, `git log` will act as if the `--follow` option was used when
1916 a single <path> is given. This has the same limitations as `--follow`,
1917 i.e. it cannot be used to follow multiple files and does not work well
1918 on non-linear history.
1921 If true, the initial commit will be shown as a big creation event.
1922 This is equivalent to a diff against an empty tree.
1923 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1924 normally hide the root commit will now show it. True by default.
1927 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1928 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1931 If true, makes linkgit:git-mailinfo[1] (and therefore
1932 linkgit:git-am[1]) act by default as if the --scissors option
1933 was provided on the command-line. When active, this features
1934 removes everything from the message body before a scissors
1935 line (i.e. consisting mainly of ">8", "8<" and "-").
1938 The location of an augmenting mailmap file. The default
1939 mailmap, located in the root of the repository, is loaded
1940 first, then the mailmap file pointed to by this variable.
1941 The location of the mailmap file may be in a repository
1942 subdirectory, or somewhere outside of the repository itself.
1943 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1946 Like `mailmap.file`, but consider the value as a reference to a
1947 blob in the repository. If both `mailmap.file` and
1948 `mailmap.blob` are given, both are parsed, with entries from
1949 `mailmap.file` taking precedence. In a bare repository, this
1950 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1954 Specify the programs that may be used to display help in the
1955 'man' format. See linkgit:git-help[1].
1958 Specify the command to invoke the specified man viewer. The
1959 specified command is evaluated in shell with the man page
1960 passed as argument. (See linkgit:git-help[1].)
1963 Override the path for the given tool that may be used to
1964 display help in the 'man' format. See linkgit:git-help[1].
1966 include::merge-config.txt[]
1968 mergetool.<tool>.path::
1969 Override the path for the given tool. This is useful in case
1970 your tool is not in the PATH.
1972 mergetool.<tool>.cmd::
1973 Specify the command to invoke the specified merge tool. The
1974 specified command is evaluated in shell with the following
1975 variables available: 'BASE' is the name of a temporary file
1976 containing the common base of the files to be merged, if available;
1977 'LOCAL' is the name of a temporary file containing the contents of
1978 the file on the current branch; 'REMOTE' is the name of a temporary
1979 file containing the contents of the file from the branch being
1980 merged; 'MERGED' contains the name of the file to which the merge
1981 tool should write the results of a successful merge.
1983 mergetool.<tool>.trustExitCode::
1984 For a custom merge command, specify whether the exit code of
1985 the merge command can be used to determine whether the merge was
1986 successful. If this is not set to true then the merge target file
1987 timestamp is checked and the merge assumed to have been successful
1988 if the file has been updated, otherwise the user is prompted to
1989 indicate the success of the merge.
1991 mergetool.meld.hasOutput::
1992 Older versions of `meld` do not support the `--output` option.
1993 Git will attempt to detect whether `meld` supports `--output`
1994 by inspecting the output of `meld --help`. Configuring
1995 `mergetool.meld.hasOutput` will make Git skip these checks and
1996 use the configured value instead. Setting `mergetool.meld.hasOutput`
1997 to `true` tells Git to unconditionally use the `--output` option,
1998 and `false` avoids using `--output`.
2000 mergetool.keepBackup::
2001 After performing a merge, the original file with conflict markers
2002 can be saved as a file with a `.orig` extension. If this variable
2003 is set to `false` then this file is not preserved. Defaults to
2004 `true` (i.e. keep the backup files).
2006 mergetool.keepTemporaries::
2007 When invoking a custom merge tool, Git uses a set of temporary
2008 files to pass to the tool. If the tool returns an error and this
2009 variable is set to `true`, then these temporary files will be
2010 preserved, otherwise they will be removed after the tool has
2011 exited. Defaults to `false`.
2013 mergetool.writeToTemp::
2014 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2015 conflicting files in the worktree by default. Git will attempt
2016 to use a temporary directory for these files when set `true`.
2017 Defaults to `false`.
2020 Prompt before each invocation of the merge resolution program.
2022 notes.mergeStrategy::
2023 Which merge strategy to choose by default when resolving notes
2024 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2025 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2026 section of linkgit:git-notes[1] for more information on each strategy.
2028 notes.<name>.mergeStrategy::
2029 Which merge strategy to choose when doing a notes merge into
2030 refs/notes/<name>. This overrides the more general
2031 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2032 linkgit:git-notes[1] for more information on the available strategies.
2035 The (fully qualified) refname from which to show notes when
2036 showing commit messages. The value of this variable can be set
2037 to a glob, in which case notes from all matching refs will be
2038 shown. You may also specify this configuration variable
2039 several times. A warning will be issued for refs that do not
2040 exist, but a glob that does not match any refs is silently
2043 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2044 environment variable, which must be a colon separated list of refs or
2047 The effective value of "core.notesRef" (possibly overridden by
2048 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2051 notes.rewrite.<command>::
2052 When rewriting commits with <command> (currently `amend` or
2053 `rebase`) and this variable is set to `true`, Git
2054 automatically copies your notes from the original to the
2055 rewritten commit. Defaults to `true`, but see
2056 "notes.rewriteRef" below.
2059 When copying notes during a rewrite (see the
2060 "notes.rewrite.<command>" option), determines what to do if
2061 the target commit already has a note. Must be one of
2062 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2063 Defaults to `concatenate`.
2065 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2066 environment variable.
2069 When copying notes during a rewrite, specifies the (fully
2070 qualified) ref whose notes should be copied. The ref may be a
2071 glob, in which case notes in all matching refs will be copied.
2072 You may also specify this configuration several times.
2074 Does not have a default value; you must configure this variable to
2075 enable note rewriting. Set it to `refs/notes/commits` to enable
2076 rewriting for the default commit notes.
2078 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2079 environment variable, which must be a colon separated list of refs or
2083 The size of the window used by linkgit:git-pack-objects[1] when no
2084 window size is given on the command line. Defaults to 10.
2087 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2088 maximum depth is given on the command line. Defaults to 50.
2091 The maximum size of memory that is consumed by each thread
2092 in linkgit:git-pack-objects[1] for pack window memory when
2093 no limit is given on the command line. The value can be
2094 suffixed with "k", "m", or "g". When left unconfigured (or
2095 set explicitly to 0), there will be no limit.
2098 An integer -1..9, indicating the compression level for objects
2099 in a pack file. -1 is the zlib default. 0 means no
2100 compression, and 1..9 are various speed/size tradeoffs, 9 being
2101 slowest. If not set, defaults to core.compression. If that is
2102 not set, defaults to -1, the zlib default, which is "a default
2103 compromise between speed and compression (currently equivalent
2106 Note that changing the compression level will not automatically recompress
2107 all existing objects. You can force recompression by passing the -F option
2108 to linkgit:git-repack[1].
2110 pack.deltaCacheSize::
2111 The maximum memory in bytes used for caching deltas in
2112 linkgit:git-pack-objects[1] before writing them out to a pack.
2113 This cache is used to speed up the writing object phase by not
2114 having to recompute the final delta result once the best match
2115 for all objects is found. Repacking large repositories on machines
2116 which are tight with memory might be badly impacted by this though,
2117 especially if this cache pushes the system into swapping.
2118 A value of 0 means no limit. The smallest size of 1 byte may be
2119 used to virtually disable this cache. Defaults to 256 MiB.
2121 pack.deltaCacheLimit::
2122 The maximum size of a delta, that is cached in
2123 linkgit:git-pack-objects[1]. This cache is used to speed up the
2124 writing object phase by not having to recompute the final delta
2125 result once the best match for all objects is found. Defaults to 1000.
2128 Specifies the number of threads to spawn when searching for best
2129 delta matches. This requires that linkgit:git-pack-objects[1]
2130 be compiled with pthreads otherwise this option is ignored with a
2131 warning. This is meant to reduce packing time on multiprocessor
2132 machines. The required amount of memory for the delta search window
2133 is however multiplied by the number of threads.
2134 Specifying 0 will cause Git to auto-detect the number of CPU's
2135 and set the number of threads accordingly.
2138 Specify the default pack index version. Valid values are 1 for
2139 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2140 the new pack index with capabilities for packs larger than 4 GB
2141 as well as proper protection against the repacking of corrupted
2142 packs. Version 2 is the default. Note that version 2 is enforced
2143 and this config option ignored whenever the corresponding pack is
2146 If you have an old Git that does not understand the version 2 `*.idx` file,
2147 cloning or fetching over a non native protocol (e.g. "http")
2148 that will copy both `*.pack` file and corresponding `*.idx` file from the
2149 other side may give you a repository that cannot be accessed with your
2150 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2151 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2154 pack.packSizeLimit::
2155 The maximum size of a pack. This setting only affects
2156 packing to a file when repacking, i.e. the git:// protocol
2157 is unaffected. It can be overridden by the `--max-pack-size`
2158 option of linkgit:git-repack[1]. Reaching this limit results
2159 in the creation of multiple packfiles; which in turn prevents
2160 bitmaps from being created.
2161 The minimum size allowed is limited to 1 MiB.
2162 The default is unlimited.
2163 Common unit suffixes of 'k', 'm', or 'g' are
2167 When true, git will use pack bitmaps (if available) when packing
2168 to stdout (e.g., during the server side of a fetch). Defaults to
2169 true. You should not generally need to turn this off unless
2170 you are debugging pack bitmaps.
2172 pack.writeBitmaps (deprecated)::
2173 This is a deprecated synonym for `repack.writeBitmaps`.
2175 pack.writeBitmapHashCache::
2176 When true, git will include a "hash cache" section in the bitmap
2177 index (if one is written). This cache can be used to feed git's
2178 delta heuristics, potentially leading to better deltas between
2179 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2180 between an older, bitmapped pack and objects that have been
2181 pushed since the last gc). The downside is that it consumes 4
2182 bytes per object of disk space, and that JGit's bitmap
2183 implementation does not understand it, causing it to complain if
2184 Git and JGit are used on the same repository. Defaults to false.
2187 If the value is boolean, turns on or off pagination of the
2188 output of a particular Git subcommand when writing to a tty.
2189 Otherwise, turns on pagination for the subcommand using the
2190 pager specified by the value of `pager.<cmd>`. If `--paginate`
2191 or `--no-pager` is specified on the command line, it takes
2192 precedence over this option. To disable pagination for all
2193 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2196 Alias for a --pretty= format string, as specified in
2197 linkgit:git-log[1]. Any aliases defined here can be used just
2198 as the built-in pretty formats could. For example,
2199 running `git config pretty.changelog "format:* %H %s"`
2200 would cause the invocation `git log --pretty=changelog`
2201 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2202 Note that an alias with the same name as a built-in format
2203 will be silently ignored.
2206 By default, Git does not create an extra merge commit when merging
2207 a commit that is a descendant of the current commit. Instead, the
2208 tip of the current branch is fast-forwarded. When set to `false`,
2209 this variable tells Git to create an extra merge commit in such
2210 a case (equivalent to giving the `--no-ff` option from the command
2211 line). When set to `only`, only such fast-forward merges are
2212 allowed (equivalent to giving the `--ff-only` option from the
2213 command line). This setting overrides `merge.ff` when pulling.
2216 When true, rebase branches on top of the fetched branch, instead
2217 of merging the default branch from the default remote when "git
2218 pull" is run. See "branch.<name>.rebase" for setting this on a
2221 When preserve, also pass `--preserve-merges` along to 'git rebase'
2222 so that locally committed merge commits will not be flattened
2223 by running 'git pull'.
2225 When the value is `interactive`, the rebase is run in interactive mode.
2227 *NOTE*: this is a possibly dangerous operation; do *not* use
2228 it unless you understand the implications (see linkgit:git-rebase[1]
2232 The default merge strategy to use when pulling multiple branches
2236 The default merge strategy to use when pulling a single branch.
2239 Defines the action `git push` should take if no refspec is
2240 explicitly given. Different values are well-suited for
2241 specific workflows; for instance, in a purely central workflow
2242 (i.e. the fetch source is equal to the push destination),
2243 `upstream` is probably what you want. Possible values are:
2247 * `nothing` - do not push anything (error out) unless a refspec is
2248 explicitly given. This is primarily meant for people who want to
2249 avoid mistakes by always being explicit.
2251 * `current` - push the current branch to update a branch with the same
2252 name on the receiving end. Works in both central and non-central
2255 * `upstream` - push the current branch back to the branch whose
2256 changes are usually integrated into the current branch (which is
2257 called `@{upstream}`). This mode only makes sense if you are
2258 pushing to the same repository you would normally pull from
2259 (i.e. central workflow).
2261 * `simple` - in centralized workflow, work like `upstream` with an
2262 added safety to refuse to push if the upstream branch's name is
2263 different from the local one.
2265 When pushing to a remote that is different from the remote you normally
2266 pull from, work as `current`. This is the safest option and is suited
2269 This mode has become the default in Git 2.0.
2271 * `matching` - push all branches having the same name on both ends.
2272 This makes the repository you are pushing to remember the set of
2273 branches that will be pushed out (e.g. if you always push 'maint'
2274 and 'master' there and no other branches, the repository you push
2275 to will have these two branches, and your local 'maint' and
2276 'master' will be pushed there).
2278 To use this mode effectively, you have to make sure _all_ the
2279 branches you would push out are ready to be pushed out before
2280 running 'git push', as the whole point of this mode is to allow you
2281 to push all of the branches in one go. If you usually finish work
2282 on only one branch and push out the result, while other branches are
2283 unfinished, this mode is not for you. Also this mode is not
2284 suitable for pushing into a shared central repository, as other
2285 people may add new branches there, or update the tip of existing
2286 branches outside your control.
2288 This used to be the default, but not since Git 2.0 (`simple` is the
2294 If set to true enable '--follow-tags' option by default. You
2295 may override this configuration at time of push by specifying
2299 May be set to a boolean value, or the string 'if-asked'. A true
2300 value causes all pushes to be GPG signed, as if '--signed' is
2301 passed to linkgit:git-push[1]. The string 'if-asked' causes
2302 pushes to be signed if the server supports it, as if
2303 '--signed=if-asked' is passed to 'git push'. A false value may
2304 override a value from a lower-priority config file. An explicit
2305 command-line flag always overrides this config option.
2307 push.recurseSubmodules::
2308 Make sure all submodule commits used by the revisions to be pushed
2309 are available on a remote-tracking branch. If the value is 'check'
2310 then Git will verify that all submodule commits that changed in the
2311 revisions to be pushed are available on at least one remote of the
2312 submodule. If any commits are missing, the push will be aborted and
2313 exit with non-zero status. If the value is 'on-demand' then all
2314 submodules that changed in the revisions to be pushed will be
2315 pushed. If on-demand was not able to push all necessary revisions
2316 it will also be aborted and exit with non-zero status. If the value
2317 is 'no' then default behavior of ignoring submodules when pushing
2318 is retained. You may override this configuration at time of push by
2319 specifying '--recurse-submodules=check|on-demand|no'.
2322 Whether to show a diffstat of what changed upstream since the last
2323 rebase. False by default.
2326 If set to true enable '--autosquash' option by default.
2329 When set to true, automatically create a temporary stash
2330 before the operation begins, and apply it after the operation
2331 ends. This means that you can run rebase on a dirty worktree.
2332 However, use with care: the final stash application after a
2333 successful rebase might result in non-trivial conflicts.
2336 rebase.missingCommitsCheck::
2337 If set to "warn", git rebase -i will print a warning if some
2338 commits are removed (e.g. a line was deleted), however the
2339 rebase will still proceed. If set to "error", it will print
2340 the previous warning and stop the rebase, 'git rebase
2341 --edit-todo' can then be used to correct the error. If set to
2342 "ignore", no checking is done.
2343 To drop a commit without warning or error, use the `drop`
2344 command in the todo-list.
2345 Defaults to "ignore".
2347 rebase.instructionFormat
2348 A format string, as specified in linkgit:git-log[1], to be used for
2349 the instruction list during an interactive rebase. The format will automatically
2350 have the long commit hash prepended to the format.
2352 receive.advertiseAtomic::
2353 By default, git-receive-pack will advertise the atomic push
2354 capability to its clients. If you don't want to this capability
2355 to be advertised, set this variable to false.
2358 By default, git-receive-pack will run "git-gc --auto" after
2359 receiving data from git-push and updating refs. You can stop
2360 it by setting this variable to false.
2362 receive.certNonceSeed::
2363 By setting this variable to a string, `git receive-pack`
2364 will accept a `git push --signed` and verifies it by using
2365 a "nonce" protected by HMAC using this string as a secret
2368 receive.certNonceSlop::
2369 When a `git push --signed` sent a push certificate with a
2370 "nonce" that was issued by a receive-pack serving the same
2371 repository within this many seconds, export the "nonce"
2372 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2373 hooks (instead of what the receive-pack asked the sending
2374 side to include). This may allow writing checks in
2375 `pre-receive` and `post-receive` a bit easier. Instead of
2376 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2377 that records by how many seconds the nonce is stale to
2378 decide if they want to accept the certificate, they only
2379 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2381 receive.fsckObjects::
2382 If it is set to true, git-receive-pack will check all received
2383 objects. It will abort in the case of a malformed object or a
2384 broken link. The result of an abort are only dangling objects.
2385 Defaults to false. If not set, the value of `transfer.fsckObjects`
2388 receive.fsck.<msg-id>::
2389 When `receive.fsckObjects` is set to true, errors can be switched
2390 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2391 setting where the `<msg-id>` is the fsck message ID and the value
2392 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2393 the error/warning with the message ID, e.g. "missingEmail: invalid
2394 author/committer line - missing email" means that setting
2395 `receive.fsck.missingEmail = ignore` will hide that issue.
2397 This feature is intended to support working with legacy repositories
2398 which would not pass pushing when `receive.fsckObjects = true`, allowing
2399 the host to accept repositories with certain known issues but still catch
2402 receive.fsck.skipList::
2403 The path to a sorted list of object names (i.e. one SHA-1 per
2404 line) that are known to be broken in a non-fatal way and should
2405 be ignored. This feature is useful when an established project
2406 should be accepted despite early commits containing errors that
2407 can be safely ignored such as invalid committer email addresses.
2408 Note: corrupt objects cannot be skipped with this setting.
2410 receive.unpackLimit::
2411 If the number of objects received in a push is below this
2412 limit then the objects will be unpacked into loose object
2413 files. However if the number of received objects equals or
2414 exceeds this limit then the received pack will be stored as
2415 a pack, after adding any missing delta bases. Storing the
2416 pack from a push can make the push operation complete faster,
2417 especially on slow filesystems. If not set, the value of
2418 `transfer.unpackLimit` is used instead.
2420 receive.denyDeletes::
2421 If set to true, git-receive-pack will deny a ref update that deletes
2422 the ref. Use this to prevent such a ref deletion via a push.
2424 receive.denyDeleteCurrent::
2425 If set to true, git-receive-pack will deny a ref update that
2426 deletes the currently checked out branch of a non-bare repository.
2428 receive.denyCurrentBranch::
2429 If set to true or "refuse", git-receive-pack will deny a ref update
2430 to the currently checked out branch of a non-bare repository.
2431 Such a push is potentially dangerous because it brings the HEAD
2432 out of sync with the index and working tree. If set to "warn",
2433 print a warning of such a push to stderr, but allow the push to
2434 proceed. If set to false or "ignore", allow such pushes with no
2435 message. Defaults to "refuse".
2437 Another option is "updateInstead" which will update the working
2438 tree if pushing into the current branch. This option is
2439 intended for synchronizing working directories when one side is not easily
2440 accessible via interactive ssh (e.g. a live web site, hence the requirement
2441 that the working directory be clean). This mode also comes in handy when
2442 developing inside a VM to test and fix code on different Operating Systems.
2444 By default, "updateInstead" will refuse the push if the working tree or
2445 the index have any difference from the HEAD, but the `push-to-checkout`
2446 hook can be used to customize this. See linkgit:githooks[5].
2448 receive.denyNonFastForwards::
2449 If set to true, git-receive-pack will deny a ref update which is
2450 not a fast-forward. Use this to prevent such an update via a push,
2451 even if that push is forced. This configuration variable is
2452 set when initializing a shared repository.
2455 This variable is the same as `transfer.hideRefs`, but applies
2456 only to `receive-pack` (and so affects pushes, but not fetches).
2457 An attempt to update or delete a hidden ref by `git push` is
2460 receive.updateServerInfo::
2461 If set to true, git-receive-pack will run git-update-server-info
2462 after receiving data from git-push and updating refs.
2464 receive.shallowUpdate::
2465 If set to true, .git/shallow can be updated when new refs
2466 require new shallow roots. Otherwise those refs are rejected.
2468 remote.pushDefault::
2469 The remote to push to by default. Overrides
2470 `branch.<name>.remote` for all branches, and is overridden by
2471 `branch.<name>.pushRemote` for specific branches.
2474 The URL of a remote repository. See linkgit:git-fetch[1] or
2475 linkgit:git-push[1].
2477 remote.<name>.pushurl::
2478 The push URL of a remote repository. See linkgit:git-push[1].
2480 remote.<name>.proxy::
2481 For remotes that require curl (http, https and ftp), the URL to
2482 the proxy to use for that remote. Set to the empty string to
2483 disable proxying for that remote.
2485 remote.<name>.proxyAuthMethod::
2486 For remotes that require curl (http, https and ftp), the method to use for
2487 authenticating against the proxy in use (probably set in
2488 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2490 remote.<name>.fetch::
2491 The default set of "refspec" for linkgit:git-fetch[1]. See
2492 linkgit:git-fetch[1].
2494 remote.<name>.push::
2495 The default set of "refspec" for linkgit:git-push[1]. See
2496 linkgit:git-push[1].
2498 remote.<name>.mirror::
2499 If true, pushing to this remote will automatically behave
2500 as if the `--mirror` option was given on the command line.
2502 remote.<name>.skipDefaultUpdate::
2503 If true, this remote will be skipped by default when updating
2504 using linkgit:git-fetch[1] or the `update` subcommand of
2505 linkgit:git-remote[1].
2507 remote.<name>.skipFetchAll::
2508 If true, this remote will be skipped by default when updating
2509 using linkgit:git-fetch[1] or the `update` subcommand of
2510 linkgit:git-remote[1].
2512 remote.<name>.receivepack::
2513 The default program to execute on the remote side when pushing. See
2514 option --receive-pack of linkgit:git-push[1].
2516 remote.<name>.uploadpack::
2517 The default program to execute on the remote side when fetching. See
2518 option --upload-pack of linkgit:git-fetch-pack[1].
2520 remote.<name>.tagOpt::
2521 Setting this value to --no-tags disables automatic tag following when
2522 fetching from remote <name>. Setting it to --tags will fetch every
2523 tag from remote <name>, even if they are not reachable from remote
2524 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2525 override this setting. See options --tags and --no-tags of
2526 linkgit:git-fetch[1].
2529 Setting this to a value <vcs> will cause Git to interact with
2530 the remote with the git-remote-<vcs> helper.
2532 remote.<name>.prune::
2533 When set to true, fetching from this remote by default will also
2534 remove any remote-tracking references that no longer exist on the
2535 remote (as if the `--prune` option was given on the command line).
2536 Overrides `fetch.prune` settings, if any.
2539 The list of remotes which are fetched by "git remote update
2540 <group>". See linkgit:git-remote[1].
2542 repack.useDeltaBaseOffset::
2543 By default, linkgit:git-repack[1] creates packs that use
2544 delta-base offset. If you need to share your repository with
2545 Git older than version 1.4.4, either directly or via a dumb
2546 protocol such as http, then you need to set this option to
2547 "false" and repack. Access from old Git versions over the
2548 native protocol are unaffected by this option.
2550 repack.packKeptObjects::
2551 If set to true, makes `git repack` act as if
2552 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2553 details. Defaults to `false` normally, but `true` if a bitmap
2554 index is being written (either via `--write-bitmap-index` or
2555 `repack.writeBitmaps`).
2557 repack.writeBitmaps::
2558 When true, git will write a bitmap index when packing all
2559 objects to disk (e.g., when `git repack -a` is run). This
2560 index can speed up the "counting objects" phase of subsequent
2561 packs created for clones and fetches, at the cost of some disk
2562 space and extra time spent on the initial repack. This has
2563 no effect if multiple packfiles are created.
2567 When set to true, `git-rerere` updates the index with the
2568 resulting contents after it cleanly resolves conflicts using
2569 previously recorded resolution. Defaults to false.
2572 Activate recording of resolved conflicts, so that identical
2573 conflict hunks can be resolved automatically, should they be
2574 encountered again. By default, linkgit:git-rerere[1] is
2575 enabled if there is an `rr-cache` directory under the
2576 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2579 sendemail.identity::
2580 A configuration identity. When given, causes values in the
2581 'sendemail.<identity>' subsection to take precedence over
2582 values in the 'sendemail' section. The default identity is
2583 the value of 'sendemail.identity'.
2585 sendemail.smtpEncryption::
2586 See linkgit:git-send-email[1] for description. Note that this
2587 setting is not subject to the 'identity' mechanism.
2589 sendemail.smtpssl (deprecated)::
2590 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2592 sendemail.smtpsslcertpath::
2593 Path to ca-certificates (either a directory or a single file).
2594 Set it to an empty string to disable certificate verification.
2596 sendemail.<identity>.*::
2597 Identity-specific versions of the 'sendemail.*' parameters
2598 found below, taking precedence over those when the this
2599 identity is selected, through command-line or
2600 'sendemail.identity'.
2602 sendemail.aliasesFile::
2603 sendemail.aliasFileType::
2604 sendemail.annotate::
2608 sendemail.chainReplyTo::
2610 sendemail.envelopeSender::
2612 sendemail.multiEdit::
2613 sendemail.signedoffbycc::
2614 sendemail.smtpPass::
2615 sendemail.suppresscc::
2616 sendemail.suppressFrom::
2618 sendemail.smtpDomain::
2619 sendemail.smtpServer::
2620 sendemail.smtpServerPort::
2621 sendemail.smtpServerOption::
2622 sendemail.smtpUser::
2624 sendemail.transferEncoding::
2625 sendemail.validate::
2627 See linkgit:git-send-email[1] for description.
2629 sendemail.signedoffcc (deprecated)::
2630 Deprecated alias for 'sendemail.signedoffbycc'.
2632 showbranch.default::
2633 The default set of branches for linkgit:git-show-branch[1].
2634 See linkgit:git-show-branch[1].
2636 status.relativePaths::
2637 By default, linkgit:git-status[1] shows paths relative to the
2638 current directory. Setting this variable to `false` shows paths
2639 relative to the repository root (this was the default for Git
2643 Set to true to enable --short by default in linkgit:git-status[1].
2644 The option --no-short takes precedence over this variable.
2647 Set to true to enable --branch by default in linkgit:git-status[1].
2648 The option --no-branch takes precedence over this variable.
2650 status.displayCommentPrefix::
2651 If set to true, linkgit:git-status[1] will insert a comment
2652 prefix before each output line (starting with
2653 `core.commentChar`, i.e. `#` by default). This was the
2654 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2657 status.showUntrackedFiles::
2658 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2659 files which are not currently tracked by Git. Directories which
2660 contain only untracked files, are shown with the directory name
2661 only. Showing untracked files means that Git needs to lstat() all
2662 the files in the whole repository, which might be slow on some
2663 systems. So, this variable controls how the commands displays
2664 the untracked files. Possible values are:
2667 * `no` - Show no untracked files.
2668 * `normal` - Show untracked files and directories.
2669 * `all` - Show also individual files in untracked directories.
2672 If this variable is not specified, it defaults to 'normal'.
2673 This variable can be overridden with the -u|--untracked-files option
2674 of linkgit:git-status[1] and linkgit:git-commit[1].
2676 status.submoduleSummary::
2678 If this is set to a non zero number or true (identical to -1 or an
2679 unlimited number), the submodule summary will be enabled and a
2680 summary of commits for modified submodules will be shown (see
2681 --summary-limit option of linkgit:git-submodule[1]). Please note
2682 that the summary output command will be suppressed for all
2683 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2684 for those submodules where `submodule.<name>.ignore=all`. The only
2685 exception to that rule is that status and commit will show staged
2686 submodule changes. To
2687 also view the summary for ignored submodules you can either use
2688 the --ignore-submodules=dirty command-line option or the 'git
2689 submodule summary' command, which shows a similar output but does
2690 not honor these settings.
2693 If this is set to true, the `git stash show` command without an
2694 option will show the stash in patch form. Defaults to false.
2695 See description of 'show' command in linkgit:git-stash[1].
2698 If this is set to true, the `git stash show` command without an
2699 option will show diffstat of the stash. Defaults to true.
2700 See description of 'show' command in linkgit:git-stash[1].
2702 submodule.<name>.path::
2703 submodule.<name>.url::
2704 The path within this project and URL for a submodule. These
2705 variables are initially populated by 'git submodule init'. See
2706 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2709 submodule.<name>.update::
2710 The default update procedure for a submodule. This variable
2711 is populated by `git submodule init` from the
2712 linkgit:gitmodules[5] file. See description of 'update'
2713 command in linkgit:git-submodule[1].
2715 submodule.<name>.branch::
2716 The remote branch name for a submodule, used by `git submodule
2717 update --remote`. Set this option to override the value found in
2718 the `.gitmodules` file. See linkgit:git-submodule[1] and
2719 linkgit:gitmodules[5] for details.
2721 submodule.<name>.fetchRecurseSubmodules::
2722 This option can be used to control recursive fetching of this
2723 submodule. It can be overridden by using the --[no-]recurse-submodules
2724 command-line option to "git fetch" and "git pull".
2725 This setting will override that from in the linkgit:gitmodules[5]
2728 submodule.<name>.ignore::
2729 Defines under what circumstances "git status" and the diff family show
2730 a submodule as modified. When set to "all", it will never be considered
2731 modified (but it will nonetheless show up in the output of status and
2732 commit when it has been staged), "dirty" will ignore all changes
2733 to the submodules work tree and
2734 takes only differences between the HEAD of the submodule and the commit
2735 recorded in the superproject into account. "untracked" will additionally
2736 let submodules with modified tracked files in their work tree show up.
2737 Using "none" (the default when this option is not set) also shows
2738 submodules that have untracked files in their work tree as changed.
2739 This setting overrides any setting made in .gitmodules for this submodule,
2740 both settings can be overridden on the command line by using the
2741 "--ignore-submodules" option. The 'git submodule' commands are not
2742 affected by this setting.
2745 This variable controls the sort ordering of tags when displayed by
2746 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2747 value of this variable will be used as the default.
2750 This variable can be used to restrict the permission bits of
2751 tar archive entries. The default is 0002, which turns off the
2752 world write bit. The special value "user" indicates that the
2753 archiving user's umask will be used instead. See umask(2) and
2754 linkgit:git-archive[1].
2756 transfer.fsckObjects::
2757 When `fetch.fsckObjects` or `receive.fsckObjects` are
2758 not set, the value of this variable is used instead.
2762 String(s) `receive-pack` and `upload-pack` use to decide which
2763 refs to omit from their initial advertisements. Use more than
2764 one definition to specify multiple prefix strings. A ref that is
2765 under the hierarchies listed in the value of this variable is
2766 excluded, and is hidden when responding to `git push` or `git
2767 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2768 program-specific versions of this config.
2770 You may also include a `!` in front of the ref name to negate the entry,
2771 explicitly exposing it, even if an earlier entry marked it as hidden.
2772 If you have multiple hideRefs values, later entries override earlier ones
2773 (and entries in more-specific config files override less-specific ones).
2775 If a namespace is in use, the namespace prefix is stripped from each
2776 reference before it is matched against `transfer.hiderefs` patterns.
2777 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2778 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2779 is omitted from the advertisements but `refs/heads/master` and
2780 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2781 "have" lines. In order to match refs before stripping, add a `^` in front of
2782 the ref name. If you combine `!` and `^`, `!` must be specified first.
2784 transfer.unpackLimit::
2785 When `fetch.unpackLimit` or `receive.unpackLimit` are
2786 not set, the value of this variable is used instead.
2787 The default value is 100.
2789 uploadarchive.allowUnreachable::
2790 If true, allow clients to use `git archive --remote` to request
2791 any tree, whether reachable from the ref tips or not. See the
2792 discussion in the `SECURITY` section of
2793 linkgit:git-upload-archive[1] for more details. Defaults to
2796 uploadpack.hideRefs::
2797 This variable is the same as `transfer.hideRefs`, but applies
2798 only to `upload-pack` (and so affects only fetches, not pushes).
2799 An attempt to fetch a hidden ref by `git fetch` will fail. See
2800 also `uploadpack.allowTipSHA1InWant`.
2802 uploadpack.allowTipSHA1InWant::
2803 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2804 to accept a fetch request that asks for an object at the tip
2805 of a hidden ref (by default, such a request is rejected).
2806 see also `uploadpack.hideRefs`.
2808 uploadpack.allowReachableSHA1InWant::
2809 Allow `upload-pack` to accept a fetch request that asks for an
2810 object that is reachable from any ref tip. However, note that
2811 calculating object reachability is computationally expensive.
2812 Defaults to `false`.
2814 uploadpack.keepAlive::
2815 When `upload-pack` has started `pack-objects`, there may be a
2816 quiet period while `pack-objects` prepares the pack. Normally
2817 it would output progress information, but if `--quiet` was used
2818 for the fetch, `pack-objects` will output nothing at all until
2819 the pack data begins. Some clients and networks may consider
2820 the server to be hung and give up. Setting this option instructs
2821 `upload-pack` to send an empty keepalive packet every
2822 `uploadpack.keepAlive` seconds. Setting this option to 0
2823 disables keepalive packets entirely. The default is 5 seconds.
2825 url.<base>.insteadOf::
2826 Any URL that starts with this value will be rewritten to
2827 start, instead, with <base>. In cases where some site serves a
2828 large number of repositories, and serves them with multiple
2829 access methods, and some users need to use different access
2830 methods, this feature allows people to specify any of the
2831 equivalent URLs and have Git automatically rewrite the URL to
2832 the best alternative for the particular user, even for a
2833 never-before-seen repository on the site. When more than one
2834 insteadOf strings match a given URL, the longest match is used.
2836 url.<base>.pushInsteadOf::
2837 Any URL that starts with this value will not be pushed to;
2838 instead, it will be rewritten to start with <base>, and the
2839 resulting URL will be pushed to. In cases where some site serves
2840 a large number of repositories, and serves them with multiple
2841 access methods, some of which do not allow push, this feature
2842 allows people to specify a pull-only URL and have Git
2843 automatically use an appropriate URL to push, even for a
2844 never-before-seen repository on the site. When more than one
2845 pushInsteadOf strings match a given URL, the longest match is
2846 used. If a remote has an explicit pushurl, Git will ignore this
2847 setting for that remote.
2850 Your email address to be recorded in any newly created commits.
2851 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2852 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2855 Your full name to be recorded in any newly created commits.
2856 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2857 environment variables. See linkgit:git-commit-tree[1].
2859 user.useConfigOnly::
2860 Instruct Git to avoid trying to guess defaults for 'user.email'
2861 and 'user.name', and instead retrieve the values only from the
2862 configuration. For example, if you have multiple email addresses
2863 and would like to use a different one for each repository, then
2864 with this configuration option set to `true` in the global config
2865 along with a name, Git will prompt you to set up an email before
2866 making new commits in a newly cloned repository.
2867 Defaults to `false`.
2870 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2871 key you want it to automatically when creating a signed tag or
2872 commit, you can override the default selection with this variable.
2873 This option is passed unchanged to gpg's --local-user parameter,
2874 so you may specify a key using any method that gpg supports.
2876 versionsort.prereleaseSuffix::
2877 When version sort is used in linkgit:git-tag[1], prerelease
2878 tags (e.g. "1.0-rc1") may appear after the main release
2879 "1.0". By specifying the suffix "-rc" in this variable,
2880 "1.0-rc1" will appear before "1.0".
2882 This variable can be specified multiple times, once per suffix. The
2883 order of suffixes in the config file determines the sorting order
2884 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2885 is sorted before 1.0-rcXX). The sorting order between different
2886 suffixes is undefined if they are in multiple config files.
2889 Specify a web browser that may be used by some commands.
2890 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]