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 included file is expanded immediately, as if its contents had been
85 found at the location of the include directive. If the value of the
86 `include.path` variable is a relative path, the path is considered to be
87 relative to the configuration file in which the include directive was
88 found. The value of `include.path` is subject to tilde expansion: `~/`
89 is expanded to the value of `$HOME`, and `~user/` to the specified
90 user's home directory. See below for examples.
97 ; Don't trust file modes
102 external = /usr/local/bin/diff-wrapper
107 merge = refs/heads/devel
111 gitProxy="ssh" for "kernel.org"
112 gitProxy=default-proxy ; for the rest
115 path = /path/to/foo.inc ; include by absolute path
116 path = foo ; expand "foo" relative to the current file
117 path = ~/foo ; expand "foo" in your $HOME directory
123 Values of many variables are treated as a simple string, but there
124 are variables that take values of specific types and there are rules
125 as to how to spell them.
129 When a variable is said to take a boolean value, many
130 synonyms are accepted for 'true' and 'false'; these are all
133 true;; Boolean true can be spelled as `yes`, `on`, `true`,
134 or `1`. Also, a variable defined without `= <value>`
137 false;; Boolean false can be spelled as `no`, `off`,
140 When converting value to the canonical form using '--bool' type
141 specifier; 'git config' will ensure that the output is "true" or
142 "false" (spelled in lowercase).
145 The value for many variables that specify various sizes can
146 be suffixed with `k`, `M`,... to mean "scale the number by
147 1024", "by 1024x1024", etc.
150 The value for a variables that takes a color is a list of
151 colors (at most two) and attributes (at most one), separated
152 by spaces. The colors accepted are `normal`, `black`,
153 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
154 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
155 `reverse`. The first color given is the foreground; the
156 second is the background. The position of the attribute, if
157 any, doesn't matter. Attributes may be turned off specifically
158 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
160 Colors (foreground and background) may also be given as numbers between
161 0 and 255; these use ANSI 256-color mode (but note that not all
162 terminals may support this). If your terminal supports it, you may also
163 specify 24-bit RGB values as hex, like `#ff0ab3`.
165 The attributes are meant to be reset at the beginning of each item
166 in the colored output, so setting color.decorate.branch to `black`
167 will paint that branch name in a plain `black`, even if the previous
168 thing on the same output line (e.g. opening parenthesis before the
169 list of branch names in `log --decorate` output) is set to be
170 painted with `bold` or some other attribute.
176 Note that this list is non-comprehensive and not necessarily complete.
177 For command-specific variables, you will find a more detailed description
178 in the appropriate manual page.
180 Other git-related tools may and do use their own variables. When
181 inventing new variables for use in your own tool, make sure their
182 names do not conflict with those that are used by Git itself and
183 other popular tools, and describe them in your documentation.
187 These variables control various optional help messages designed to
188 aid new users. All 'advice.*' variables default to 'true', and you
189 can tell Git that you do not need help by setting these to 'false':
193 Set this variable to 'false' if you want to disable
195 'pushNonFFMatching', 'pushAlreadyExists',
196 'pushFetchFirst', and 'pushNeedsForce'
199 Advice shown when linkgit:git-push[1] fails due to a
200 non-fast-forward update to the current branch.
202 Advice shown when you ran linkgit:git-push[1] and pushed
203 'matching refs' explicitly (i.e. you used ':', or
204 specified a refspec that isn't your current branch) and
205 it resulted in a non-fast-forward error.
207 Shown when linkgit:git-push[1] rejects an update that
208 does not qualify for fast-forwarding (e.g., a tag.)
210 Shown when linkgit:git-push[1] rejects an update that
211 tries to overwrite a remote ref that points at an
212 object we do not have.
214 Shown when linkgit:git-push[1] rejects an update that
215 tries to overwrite a remote ref that points at an
216 object that is not a commit-ish, or make the remote
217 ref point at an object that is not a commit-ish.
219 Show directions on how to proceed from the current
220 state in the output of linkgit:git-status[1], in
221 the template shown when writing commit messages in
222 linkgit:git-commit[1], and in the help message shown
223 by linkgit:git-checkout[1] when switching branch.
225 Advise to consider using the `-u` option to linkgit:git-status[1]
226 when the command takes more than 2 seconds to enumerate untracked
229 Advice shown when linkgit:git-merge[1] refuses to
230 merge to avoid overwriting local changes.
232 Advice shown by various commands when conflicts
233 prevent the operation from being performed.
235 Advice on how to set your identity configuration when
236 your information is guessed from the system username and
239 Advice shown when you used linkgit:git-checkout[1] to
240 move to the detach HEAD state, to instruct how to create
241 a local branch after the fact.
243 Advice that shows the location of the patch file when
244 linkgit:git-am[1] fails to apply it.
246 In case of failure in the output of linkgit:git-rm[1],
247 show directions on how to proceed from the current state.
251 Tells Git if the executable bit of files in the working tree
254 Some filesystems lose the executable bit when a file that is
255 marked as executable is checked out, or checks out an
256 non-executable file with executable bit on.
257 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
258 to see if it handles the executable bit correctly
259 and this variable is automatically set as necessary.
261 A repository, however, may be on a filesystem that handles
262 the filemode correctly, and this variable is set to 'true'
263 when created, but later may be made accessible from another
264 environment that loses the filemode (e.g. exporting ext4 via
265 CIFS mount, visiting a Cygwin created repository with
266 Git for Windows or Eclipse).
267 In such a case it may be necessary to set this variable to 'false'.
268 See linkgit:git-update-index[1].
270 The default is true (when core.filemode is not specified in the config file).
273 If true, this option enables various workarounds to enable
274 Git to work better on filesystems that are not case sensitive,
275 like FAT. For example, if a directory listing finds
276 "makefile" when Git expects "Makefile", Git will assume
277 it is really the same file, and continue to remember it as
280 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
281 will probe and set core.ignoreCase true if appropriate when the repository
284 core.precomposeUnicode::
285 This option is only used by Mac OS implementation of Git.
286 When core.precomposeUnicode=true, Git reverts the unicode decomposition
287 of filenames done by Mac OS. This is useful when sharing a repository
288 between Mac OS and Linux or Windows.
289 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
290 When false, file names are handled fully transparent by Git,
291 which is backward compatible with older versions of Git.
294 If set to true, do not allow checkout of paths that would
295 be considered equivalent to `.git` on an HFS+ filesystem.
296 Defaults to `true` on Mac OS, and `false` elsewhere.
299 If set to true, do not allow checkout of paths that would
300 cause problems with the NTFS filesystem, e.g. conflict with
302 Defaults to `true` on Windows, and `false` elsewhere.
305 If false, the ctime differences between the index and the
306 working tree are ignored; useful when the inode change time
307 is regularly modified by something outside Git (file system
308 crawlers and some backup systems).
309 See linkgit:git-update-index[1]. True by default.
311 core.untrackedCache::
312 Determines what to do about the untracked cache feature of the
313 index. It will be kept, if this variable is unset or set to
314 `keep`. It will automatically be added if set to `true`. And
315 it will automatically be removed, if set to `false`. Before
316 setting it to `true`, you should check that mtime is working
317 properly on your system.
318 See linkgit:git-update-index[1]. `keep` by default.
321 Determines which stat fields to match between the index
322 and work tree. The user can set this to 'default' or
323 'minimal'. Default (or explicitly 'default'), is to check
324 all fields, including the sub-second part of mtime and ctime.
327 The commands that output paths (e.g. 'ls-files',
328 'diff'), when not given the `-z` option, will quote
329 "unusual" characters in the pathname by enclosing the
330 pathname in a double-quote pair and with backslashes the
331 same way strings in C source code are quoted. If this
332 variable is set to false, the bytes higher than 0x80 are
333 not quoted but output as verbatim. Note that double
334 quote, backslash and control characters are always
335 quoted without `-z` regardless of the setting of this
339 Sets the line ending type to use in the working directory for
340 files that have the `text` property set. Alternatives are
341 'lf', 'crlf' and 'native', which uses the platform's native
342 line ending. The default value is `native`. See
343 linkgit:gitattributes[5] for more information on end-of-line
347 If true, makes Git check if converting `CRLF` is reversible when
348 end-of-line conversion is active. Git will verify if a command
349 modifies a file in the work tree either directly or indirectly.
350 For example, committing a file followed by checking out the
351 same file should yield the original file in the work tree. If
352 this is not the case for the current setting of
353 `core.autocrlf`, Git will reject the file. The variable can
354 be set to "warn", in which case Git will only warn about an
355 irreversible conversion but continue the operation.
357 CRLF conversion bears a slight chance of corrupting data.
358 When it is enabled, Git will convert CRLF to LF during commit and LF to
359 CRLF during checkout. A file that contains a mixture of LF and
360 CRLF before the commit cannot be recreated by Git. For text
361 files this is the right thing to do: it corrects line endings
362 such that we have only LF line endings in the repository.
363 But for binary files that are accidentally classified as text the
364 conversion can corrupt data.
366 If you recognize such corruption early you can easily fix it by
367 setting the conversion type explicitly in .gitattributes. Right
368 after committing you still have the original file in your work
369 tree and this file is not yet corrupted. You can explicitly tell
370 Git that this file is binary and Git will handle the file
373 Unfortunately, the desired effect of cleaning up text files with
374 mixed line endings and the undesired effect of corrupting binary
375 files cannot be distinguished. In both cases CRLFs are removed
376 in an irreversible way. For text files this is the right thing
377 to do because CRLFs are line endings, while for binary files
378 converting CRLFs corrupts data.
380 Note, this safety check does not mean that a checkout will generate a
381 file identical to the original file for a different setting of
382 `core.eol` and `core.autocrlf`, but only for the current one. For
383 example, a text file with `LF` would be accepted with `core.eol=lf`
384 and could later be checked out with `core.eol=crlf`, in which case the
385 resulting file would contain `CRLF`, although the original file
386 contained `LF`. However, in both work trees the line endings would be
387 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
388 file with mixed line endings would be reported by the `core.safecrlf`
392 Setting this variable to "true" is almost the same as setting
393 the `text` attribute to "auto" on all files except that text
394 files are not guaranteed to be normalized: files that contain
395 `CRLF` in the repository will not be touched. Use this
396 setting if you want to have `CRLF` line endings in your
397 working directory even though the repository does not have
398 normalized line endings. This variable can be set to 'input',
399 in which case no output conversion is performed.
402 If false, symbolic links are checked out as small plain files that
403 contain the link text. linkgit:git-update-index[1] and
404 linkgit:git-add[1] will not change the recorded type to regular
405 file. Useful on filesystems like FAT that do not support
408 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
409 will probe and set core.symlinks false if appropriate when the repository
413 A "proxy command" to execute (as 'command host port') instead
414 of establishing direct connection to the remote server when
415 using the Git protocol for fetching. If the variable value is
416 in the "COMMAND for DOMAIN" format, the command is applied only
417 on hostnames ending with the specified domain string. This variable
418 may be set multiple times and is matched in the given order;
419 the first match wins.
421 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
422 (which always applies universally, without the special "for"
425 The special string `none` can be used as the proxy command to
426 specify that no proxy be used for a given domain pattern.
427 This is useful for excluding servers inside a firewall from
428 proxy use, while defaulting to a common proxy for external domains.
431 If true, Git will avoid using lstat() calls to detect if files have
432 changed by setting the "assume-unchanged" bit for those tracked files
433 which it has updated identically in both the index and working tree.
435 When files are modified outside of Git, the user will need to stage
436 the modified files explicitly (e.g. see 'Examples' section in
437 linkgit:git-update-index[1]).
438 Git will not normally detect changes to those files.
440 This is useful on systems where lstat() calls are very slow, such as
441 CIFS/Microsoft Windows.
445 core.preferSymlinkRefs::
446 Instead of the default "symref" format for HEAD
447 and other symbolic reference files, use symbolic links.
448 This is sometimes needed to work with old scripts that
449 expect HEAD to be a symbolic link.
452 If true this repository is assumed to be 'bare' and has no
453 working directory associated with it. If this is the case a
454 number of commands that require a working directory will be
455 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
457 This setting is automatically guessed by linkgit:git-clone[1] or
458 linkgit:git-init[1] when the repository was created. By default a
459 repository that ends in "/.git" is assumed to be not bare (bare =
460 false), while all other repositories are assumed to be bare (bare
464 Set the path to the root of the working tree.
465 If GIT_COMMON_DIR environment variable is set, core.worktree
466 is ignored and not used for determining the root of working tree.
467 This can be overridden by the GIT_WORK_TREE environment
468 variable and the '--work-tree' command-line option.
469 The value can be an absolute path or relative to the path to
470 the .git directory, which is either specified by --git-dir
471 or GIT_DIR, or automatically discovered.
472 If --git-dir or GIT_DIR is specified but none of
473 --work-tree, GIT_WORK_TREE and core.worktree is specified,
474 the current working directory is regarded as the top level
475 of your working tree.
477 Note that this variable is honored even when set in a configuration
478 file in a ".git" subdirectory of a directory and its value differs
479 from the latter directory (e.g. "/path/to/.git/config" has
480 core.worktree set to "/different/path"), which is most likely a
481 misconfiguration. Running Git commands in the "/path/to" directory will
482 still use "/different/path" as the root of the work tree and can cause
483 confusion unless you know what you are doing (e.g. you are creating a
484 read-only snapshot of the same index to a location different from the
485 repository's usual working tree).
487 core.logAllRefUpdates::
488 Enable the reflog. Updates to a ref <ref> is logged to the file
489 "$GIT_DIR/logs/<ref>", by appending the new and old
490 SHA-1, the date/time and the reason of the update, but
491 only when the file exists. If this configuration
492 variable is set to true, missing "$GIT_DIR/logs/<ref>"
493 file is automatically created for branch heads (i.e. under
494 refs/heads/), remote refs (i.e. under refs/remotes/),
495 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
497 This information can be used to determine what commit
498 was the tip of a branch "2 days ago".
500 This value is true by default in a repository that has
501 a working directory associated with it, and false by
502 default in a bare repository.
504 core.repositoryFormatVersion::
505 Internal variable identifying the repository format and layout
508 core.sharedRepository::
509 When 'group' (or 'true'), the repository is made shareable between
510 several users in a group (making sure all the files and objects are
511 group-writable). When 'all' (or 'world' or 'everybody'), the
512 repository will be readable by all users, additionally to being
513 group-shareable. When 'umask' (or 'false'), Git will use permissions
514 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
515 files in the repository will have this mode value. '0xxx' will override
516 user's umask value (whereas the other options will only override
517 requested parts of the user's umask value). Examples: '0660' will make
518 the repo read/write-able for the owner and group, but inaccessible to
519 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
520 repository that is group-readable but not group-writable.
521 See linkgit:git-init[1]. False by default.
523 core.warnAmbiguousRefs::
524 If true, Git will warn you if the ref name you passed it is ambiguous
525 and might match multiple refs in the repository. True by default.
528 An integer -1..9, indicating a default compression level.
529 -1 is the zlib default. 0 means no compression,
530 and 1..9 are various speed/size tradeoffs, 9 being slowest.
531 If set, this provides a default to other compression variables,
532 such as 'core.looseCompression' and 'pack.compression'.
534 core.looseCompression::
535 An integer -1..9, indicating the compression level for objects that
536 are not in a pack file. -1 is the zlib default. 0 means no
537 compression, and 1..9 are various speed/size tradeoffs, 9 being
538 slowest. If not set, defaults to core.compression. If that is
539 not set, defaults to 1 (best speed).
541 core.packedGitWindowSize::
542 Number of bytes of a pack file to map into memory in a
543 single mapping operation. Larger window sizes may allow
544 your system to process a smaller number of large pack files
545 more quickly. Smaller window sizes will negatively affect
546 performance due to increased calls to the operating system's
547 memory manager, but may improve performance when accessing
548 a large number of large pack files.
550 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
551 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
552 be reasonable for all users/operating systems. You probably do
553 not need to adjust this value.
555 Common unit suffixes of 'k', 'm', or 'g' are supported.
557 core.packedGitLimit::
558 Maximum number of bytes to map simultaneously into memory
559 from pack files. If Git needs to access more than this many
560 bytes at once to complete an operation it will unmap existing
561 regions to reclaim virtual address space within the process.
563 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
564 This should be reasonable for all users/operating systems, except on
565 the largest projects. You probably do not need to adjust this value.
567 Common unit suffixes of 'k', 'm', or 'g' are supported.
569 core.deltaBaseCacheLimit::
570 Maximum number of bytes to reserve for caching base objects
571 that may be referenced by multiple deltified objects. By storing the
572 entire decompressed base objects in a cache Git is able
573 to avoid unpacking and decompressing frequently used base
574 objects multiple times.
576 Default is 96 MiB on all platforms. This should be reasonable
577 for all users/operating systems, except on the largest projects.
578 You probably do not need to adjust this value.
580 Common unit suffixes of 'k', 'm', or 'g' are supported.
582 core.bigFileThreshold::
583 Files larger than this size are stored deflated, without
584 attempting delta compression. Storing large files without
585 delta compression avoids excessive memory usage, at the
586 slight expense of increased disk usage. Additionally files
587 larger than this size are always treated as binary.
589 Default is 512 MiB on all platforms. This should be reasonable
590 for most projects as source code and other text files can still
591 be delta compressed, but larger binary media files won't be.
593 Common unit suffixes of 'k', 'm', or 'g' are supported.
596 In addition to '.gitignore' (per-directory) and
597 '.git/info/exclude', Git looks into this file for patterns
598 of files which are not meant to be tracked. "`~/`" is expanded
599 to the value of `$HOME` and "`~user/`" to the specified user's
600 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
601 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
602 is used instead. See linkgit:gitignore[5].
605 Some commands (e.g. svn and http interfaces) that interactively
606 ask for a password can be told to use an external program given
607 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
608 environment variable. If not set, fall back to the value of the
609 'SSH_ASKPASS' environment variable or, failing that, a simple password
610 prompt. The external program shall be given a suitable prompt as
611 command-line argument and write the password on its STDOUT.
613 core.attributesFile::
614 In addition to '.gitattributes' (per-directory) and
615 '.git/info/attributes', Git looks into this file for attributes
616 (see linkgit:gitattributes[5]). Path expansions are made the same
617 way as for `core.excludesFile`. Its default value is
618 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
619 set or empty, $HOME/.config/git/attributes is used instead.
622 Commands such as `commit` and `tag` that lets you edit
623 messages by launching an editor uses the value of this
624 variable when it is set, and the environment variable
625 `GIT_EDITOR` is not set. See linkgit:git-var[1].
628 Commands such as `commit` and `tag` that lets you edit
629 messages consider a line that begins with this character
630 commented, and removes them after the editor returns
633 If set to "auto", `git-commit` would select a character that is not
634 the beginning character of any line in existing commit messages.
636 core.packedRefsTimeout::
637 The length of time, in milliseconds, to retry when trying to
638 lock the `packed-refs` file. Value 0 means not to retry at
639 all; -1 means to try indefinitely. Default is 1000 (i.e.,
643 Text editor used by `git rebase -i` for editing the rebase instruction file.
644 The value is meant to be interpreted by the shell when it is used.
645 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
646 When not configured the default commit message editor is used instead.
649 Text viewer for use by Git commands (e.g., 'less'). The value
650 is meant to be interpreted by the shell. The order of preference
651 is the `$GIT_PAGER` environment variable, then `core.pager`
652 configuration, then `$PAGER`, and then the default chosen at
653 compile time (usually 'less').
655 When the `LESS` environment variable is unset, Git sets it to `FRX`
656 (if `LESS` environment variable is set, Git does not change it at
657 all). If you want to selectively override Git's default setting
658 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
659 be passed to the shell by Git, which will translate the final
660 command to `LESS=FRX less -S`. The environment does not set the
661 `S` option but the command line does, instructing less to truncate
662 long lines. Similarly, setting `core.pager` to `less -+F` will
663 deactivate the `F` option specified by the environment from the
664 command-line, deactivating the "quit if one screen" behavior of
665 `less`. One can specifically activate some flags for particular
666 commands: for example, setting `pager.blame` to `less -S` enables
667 line truncation only for `git blame`.
669 Likewise, when the `LV` environment variable is unset, Git sets it
670 to `-c`. You can override this setting by exporting `LV` with
671 another value or setting `core.pager` to `lv +c`.
674 A comma separated list of common whitespace problems to
675 notice. 'git diff' will use `color.diff.whitespace` to
676 highlight them, and 'git apply --whitespace=error' will
677 consider them as errors. You can prefix `-` to disable
678 any of them (e.g. `-trailing-space`):
680 * `blank-at-eol` treats trailing whitespaces at the end of the line
681 as an error (enabled by default).
682 * `space-before-tab` treats a space character that appears immediately
683 before a tab character in the initial indent part of the line as an
684 error (enabled by default).
685 * `indent-with-non-tab` treats a line that is indented with space
686 characters instead of the equivalent tabs as an error (not enabled by
688 * `tab-in-indent` treats a tab character in the initial indent part of
689 the line as an error (not enabled by default).
690 * `blank-at-eof` treats blank lines added at the end of file as an error
691 (enabled by default).
692 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
694 * `cr-at-eol` treats a carriage-return at the end of line as
695 part of the line terminator, i.e. with it, `trailing-space`
696 does not trigger if the character before such a carriage-return
697 is not a whitespace (not enabled by default).
698 * `tabwidth=<n>` tells how many character positions a tab occupies; this
699 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
700 errors. The default tab width is 8. Allowed values are 1 to 63.
702 core.fsyncObjectFiles::
703 This boolean will enable 'fsync()' when writing object files.
705 This is a total waste of time and effort on a filesystem that orders
706 data writes properly, but can be useful for filesystems that do not use
707 journalling (traditional UNIX filesystems) or that only journal metadata
708 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
711 Enable parallel index preload for operations like 'git diff'
713 This can speed up operations like 'git diff' and 'git status' especially
714 on filesystems like NFS that have weak caching semantics and thus
715 relatively high IO latencies. When enabled, Git will do the
716 index comparison to the filesystem data in parallel, allowing
717 overlapping IO's. Defaults to true.
720 You can set this to 'link', in which case a hardlink followed by
721 a delete of the source are used to make sure that object creation
722 will not overwrite existing objects.
724 On some file system/operating system combinations, this is unreliable.
725 Set this config setting to 'rename' there; However, This will remove the
726 check that makes sure that existing object files will not get overwritten.
729 When showing commit messages, also show notes which are stored in
730 the given ref. The ref must be fully qualified. If the given
731 ref does not exist, it is not an error but means that no
732 notes should be printed.
734 This setting defaults to "refs/notes/commits", and it can be overridden by
735 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
737 core.sparseCheckout::
738 Enable "sparse checkout" feature. See section "Sparse checkout" in
739 linkgit:git-read-tree[1] for more information.
742 Set the length object names are abbreviated to. If unspecified,
743 many commands abbreviate to 7 hexdigits, which may not be enough
744 for abbreviated object names to stay unique for sufficiently long
748 add.ignore-errors (deprecated)::
749 Tells 'git add' to continue adding files when some files cannot be
750 added due to indexing errors. Equivalent to the '--ignore-errors'
751 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
752 as it does not follow the usual naming convention for configuration
756 Command aliases for the linkgit:git[1] command wrapper - e.g.
757 after defining "alias.last = cat-file commit HEAD", the invocation
758 "git last" is equivalent to "git cat-file commit HEAD". To avoid
759 confusion and troubles with script usage, aliases that
760 hide existing Git commands are ignored. Arguments are split by
761 spaces, the usual shell quoting and escaping is supported.
762 A quote pair or a backslash can be used to quote them.
764 If the alias expansion is prefixed with an exclamation point,
765 it will be treated as a shell command. For example, defining
766 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
767 "git new" is equivalent to running the shell command
768 "gitk --all --not ORIG_HEAD". Note that shell commands will be
769 executed from the top-level directory of a repository, which may
770 not necessarily be the current directory.
771 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
772 from the original current directory. See linkgit:git-rev-parse[1].
775 If true, git-am will call git-mailsplit for patches in mbox format
776 with parameter '--keep-cr'. In this case git-mailsplit will
777 not remove `\r` from lines ending with `\r\n`. Can be overridden
778 by giving '--no-keep-cr' from the command line.
779 See linkgit:git-am[1], linkgit:git-mailsplit[1].
782 By default, `git am` will fail if the patch does not apply cleanly. When
783 set to true, this setting tells `git am` to fall back on 3-way merge if
784 the patch records the identity of blobs it is supposed to apply to and
785 we have those blobs available locally (equivalent to giving the `--3way`
786 option from the command line). Defaults to `false`.
787 See linkgit:git-am[1].
789 apply.ignoreWhitespace::
790 When set to 'change', tells 'git apply' to ignore changes in
791 whitespace, in the same way as the '--ignore-space-change'
793 When set to one of: no, none, never, false tells 'git apply' to
794 respect all whitespace differences.
795 See linkgit:git-apply[1].
798 Tells 'git apply' how to handle whitespaces, in the same way
799 as the '--whitespace' option. See linkgit:git-apply[1].
801 branch.autoSetupMerge::
802 Tells 'git branch' and 'git checkout' to set up new branches
803 so that linkgit:git-pull[1] will appropriately merge from the
804 starting point branch. Note that even if this option is not set,
805 this behavior can be chosen per-branch using the `--track`
806 and `--no-track` options. The valid settings are: `false` -- no
807 automatic setup is done; `true` -- automatic setup is done when the
808 starting point is a remote-tracking branch; `always` --
809 automatic setup is done when the starting point is either a
810 local branch or remote-tracking
811 branch. This option defaults to true.
813 branch.autoSetupRebase::
814 When a new branch is created with 'git branch' or 'git checkout'
815 that tracks another branch, this variable tells Git to set
816 up pull to rebase instead of merge (see "branch.<name>.rebase").
817 When `never`, rebase is never automatically set to true.
818 When `local`, rebase is set to true for tracked branches of
819 other local branches.
820 When `remote`, rebase is set to true for tracked branches of
821 remote-tracking branches.
822 When `always`, rebase will be set to true for all tracking
824 See "branch.autoSetupMerge" for details on how to set up a
825 branch to track another branch.
826 This option defaults to never.
828 branch.<name>.remote::
829 When on branch <name>, it tells 'git fetch' and 'git push'
830 which remote to fetch from/push to. The remote to push to
831 may be overridden with `remote.pushDefault` (for all branches).
832 The remote to push to, for the current branch, may be further
833 overridden by `branch.<name>.pushRemote`. If no remote is
834 configured, or if you are not on any branch, it defaults to
835 `origin` for fetching and `remote.pushDefault` for pushing.
836 Additionally, `.` (a period) is the current local repository
837 (a dot-repository), see `branch.<name>.merge`'s final note below.
839 branch.<name>.pushRemote::
840 When on branch <name>, it overrides `branch.<name>.remote` for
841 pushing. It also overrides `remote.pushDefault` for pushing
842 from branch <name>. When you pull from one place (e.g. your
843 upstream) and push to another place (e.g. your own publishing
844 repository), you would want to set `remote.pushDefault` to
845 specify the remote to push to for all branches, and use this
846 option to override it for a specific branch.
848 branch.<name>.merge::
849 Defines, together with branch.<name>.remote, the upstream branch
850 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
851 branch to merge and can also affect 'git push' (see push.default).
852 When in branch <name>, it tells 'git fetch' the default
853 refspec to be marked for merging in FETCH_HEAD. The value is
854 handled like the remote part of a refspec, and must match a
855 ref which is fetched from the remote given by
856 "branch.<name>.remote".
857 The merge information is used by 'git pull' (which at first calls
858 'git fetch') to lookup the default branch for merging. Without
859 this option, 'git pull' defaults to merge the first refspec fetched.
860 Specify multiple values to get an octopus merge.
861 If you wish to setup 'git pull' so that it merges into <name> from
862 another branch in the local repository, you can point
863 branch.<name>.merge to the desired branch, and use the relative path
864 setting `.` (a period) for branch.<name>.remote.
866 branch.<name>.mergeOptions::
867 Sets default options for merging into branch <name>. The syntax and
868 supported options are the same as those of linkgit:git-merge[1], but
869 option values containing whitespace characters are currently not
872 branch.<name>.rebase::
873 When true, rebase the branch <name> on top of the fetched branch,
874 instead of merging the default branch from the default remote when
875 "git pull" is run. See "pull.rebase" for doing this in a non
876 branch-specific manner.
878 When preserve, also pass `--preserve-merges` along to 'git rebase'
879 so that locally committed merge commits will not be flattened
880 by running 'git pull'.
882 When the value is `interactive`, the rebase is run in interactive mode.
884 *NOTE*: this is a possibly dangerous operation; do *not* use
885 it unless you understand the implications (see linkgit:git-rebase[1]
888 branch.<name>.description::
889 Branch description, can be edited with
890 `git branch --edit-description`. Branch description is
891 automatically added in the format-patch cover letter or
892 request-pull summary.
895 Specify the command to invoke the specified browser. The
896 specified command is evaluated in shell with the URLs passed
897 as arguments. (See linkgit:git-web{litdd}browse[1].)
899 browser.<tool>.path::
900 Override the path for the given tool that may be used to
901 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
902 working repository in gitweb (see linkgit:git-instaweb[1]).
905 A boolean to make git-clean do nothing unless given -f,
906 -i or -n. Defaults to true.
909 A boolean to enable/disable color in the output of
910 linkgit:git-branch[1]. May be set to `always`,
911 `false` (or `never`) or `auto` (or `true`), in which case colors are used
912 only when the output is to a terminal. Defaults to false.
914 color.branch.<slot>::
915 Use customized color for branch coloration. `<slot>` is one of
916 `current` (the current branch), `local` (a local branch),
917 `remote` (a remote-tracking branch in refs/remotes/),
918 `upstream` (upstream tracking branch), `plain` (other
922 Whether to use ANSI escape sequences to add color to patches.
923 If this is set to `always`, linkgit:git-diff[1],
924 linkgit:git-log[1], and linkgit:git-show[1] will use color
925 for all patches. If it is set to `true` or `auto`, those
926 commands will only use color when output is to the terminal.
929 This does not affect linkgit:git-format-patch[1] or the
930 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
931 command line with the `--color[=<when>]` option.
934 Use customized color for diff colorization. `<slot>` specifies
935 which part of the patch to use the specified color, and is one
936 of `context` (context text - `plain` is a historical synonym),
937 `meta` (metainformation), `frag`
938 (hunk header), 'func' (function in hunk header), `old` (removed lines),
939 `new` (added lines), `commit` (commit headers), or `whitespace`
940 (highlighting whitespace errors).
942 color.decorate.<slot>::
943 Use customized color for 'git log --decorate' output. `<slot>` is one
944 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
945 branches, remote-tracking branches, tags, stash and HEAD, respectively.
948 When set to `always`, always highlight matches. When `false` (or
949 `never`), never. When set to `true` or `auto`, use color only
950 when the output is written to the terminal. Defaults to `false`.
953 Use customized color for grep colorization. `<slot>` specifies which
954 part of the line to use the specified color, and is one of
958 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
960 filename prefix (when not using `-h`)
962 function name lines (when using `-p`)
964 line number prefix (when using `-n`)
966 matching text (same as setting `matchContext` and `matchSelected`)
968 matching text in context lines
970 matching text in selected lines
972 non-matching text in selected lines
974 separators between fields on a line (`:`, `-`, and `=`)
975 and between hunks (`--`)
979 When set to `always`, always use colors for interactive prompts
980 and displays (such as those used by "git-add --interactive" and
981 "git-clean --interactive"). When false (or `never`), never.
982 When set to `true` or `auto`, use colors only when the output is
983 to the terminal. Defaults to false.
985 color.interactive.<slot>::
986 Use customized color for 'git add --interactive' and 'git clean
987 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
988 or `error`, for four distinct types of normal output from
989 interactive commands.
992 A boolean to enable/disable colored output when the pager is in
993 use (default is true).
996 A boolean to enable/disable color in the output of
997 linkgit:git-show-branch[1]. May be set to `always`,
998 `false` (or `never`) or `auto` (or `true`), in which case colors are used
999 only when the output is to a terminal. Defaults to false.
1002 A boolean to enable/disable color in the output of
1003 linkgit:git-status[1]. May be set to `always`,
1004 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1005 only when the output is to a terminal. Defaults to false.
1007 color.status.<slot>::
1008 Use customized color for status colorization. `<slot>` is
1009 one of `header` (the header text of the status message),
1010 `added` or `updated` (files which are added but not committed),
1011 `changed` (files which are changed but not added in the index),
1012 `untracked` (files which are not tracked by Git),
1013 `branch` (the current branch),
1014 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1016 `unmerged` (files which have unmerged changes).
1019 This variable determines the default value for variables such
1020 as `color.diff` and `color.grep` that control the use of color
1021 per command family. Its scope will expand as more commands learn
1022 configuration to set a default for the `--color` option. Set it
1023 to `false` or `never` if you prefer Git commands not to use
1024 color unless enabled explicitly with some other configuration
1025 or the `--color` option. Set it to `always` if you want all
1026 output not intended for machine consumption to use color, to
1027 `true` or `auto` (this is the default since Git 1.8.4) if you
1028 want such output to use color when written to the terminal.
1031 Specify whether supported commands should output in columns.
1032 This variable consists of a list of tokens separated by spaces
1035 These options control when the feature should be enabled
1036 (defaults to 'never'):
1040 always show in columns
1042 never show in columns
1044 show in columns if the output is to the terminal
1047 These options control layout (defaults to 'column'). Setting any
1048 of these implies 'always' if none of 'always', 'never', or 'auto' are
1053 fill columns before rows
1055 fill rows before columns
1060 Finally, these options can be combined with a layout option (defaults
1065 make unequal size columns to utilize more space
1067 make equal size columns
1071 Specify whether to output branch listing in `git branch` in columns.
1072 See `column.ui` for details.
1075 Specify the layout when list items in `git clean -i`, which always
1076 shows files and directories in columns. See `column.ui` for details.
1079 Specify whether to output untracked files in `git status` in columns.
1080 See `column.ui` for details.
1083 Specify whether to output tag listing in `git tag` in columns.
1084 See `column.ui` for details.
1087 This setting overrides the default of the `--cleanup` option in
1088 `git commit`. See linkgit:git-commit[1] for details. Changing the
1089 default can be useful when you always want to keep lines that begin
1090 with comment character `#` in your log message, in which case you
1091 would do `git config commit.cleanup whitespace` (note that you will
1092 have to remove the help lines that begin with `#` in the commit log
1093 template yourself, if you do this).
1097 A boolean to specify whether all commits should be GPG signed.
1098 Use of this option when doing operations such as rebase can
1099 result in a large number of commits being signed. It may be
1100 convenient to use an agent to avoid typing your GPG passphrase
1104 A boolean to enable/disable inclusion of status information in the
1105 commit message template when using an editor to prepare the commit
1106 message. Defaults to true.
1109 Specify a file to use as the template for new commit messages.
1110 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1111 specified user's home directory.
1114 Specify an external helper to be called when a username or
1115 password credential is needed; the helper may consult external
1116 storage to avoid prompting the user for the credentials. See
1117 linkgit:gitcredentials[7] for details.
1119 credential.useHttpPath::
1120 When acquiring credentials, consider the "path" component of an http
1121 or https URL to be important. Defaults to false. See
1122 linkgit:gitcredentials[7] for more information.
1124 credential.username::
1125 If no username is set for a network authentication, use this username
1126 by default. See credential.<context>.* below, and
1127 linkgit:gitcredentials[7].
1129 credential.<url>.*::
1130 Any of the credential.* options above can be applied selectively to
1131 some credentials. For example "credential.https://example.com.username"
1132 would set the default username only for https connections to
1133 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1136 credentialCache.ignoreSIGHUP::
1137 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1139 include::diff-config.txt[]
1141 difftool.<tool>.path::
1142 Override the path for the given tool. This is useful in case
1143 your tool is not in the PATH.
1145 difftool.<tool>.cmd::
1146 Specify the command to invoke the specified diff tool.
1147 The specified command is evaluated in shell with the following
1148 variables available: 'LOCAL' is set to the name of the temporary
1149 file containing the contents of the diff pre-image and 'REMOTE'
1150 is set to the name of the temporary file containing the contents
1151 of the diff post-image.
1154 Prompt before each invocation of the diff tool.
1156 fastimport.unpackLimit::
1157 If the number of objects imported by linkgit:git-fast-import[1]
1158 is below this limit, then the objects will be unpacked into
1159 loose object files. However if the number of imported objects
1160 equals or exceeds this limit then the pack will be stored as a
1161 pack. Storing the pack from a fast-import can make the import
1162 operation complete faster, especially on slow filesystems. If
1163 not set, the value of `transfer.unpackLimit` is used instead.
1165 fetch.recurseSubmodules::
1166 This option can be either set to a boolean value or to 'on-demand'.
1167 Setting it to a boolean changes the behavior of fetch and pull to
1168 unconditionally recurse into submodules when set to true or to not
1169 recurse at all when set to false. When set to 'on-demand' (the default
1170 value), fetch and pull will only recurse into a populated submodule
1171 when its superproject retrieves a commit that updates the submodule's
1175 If it is set to true, git-fetch-pack will check all fetched
1176 objects. It will abort in the case of a malformed object or a
1177 broken link. The result of an abort are only dangling objects.
1178 Defaults to false. If not set, the value of `transfer.fsckObjects`
1182 If the number of objects fetched over the Git native
1183 transfer is below this
1184 limit, then the objects will be unpacked into loose object
1185 files. However if the number of received objects equals or
1186 exceeds this limit then the received pack will be stored as
1187 a pack, after adding any missing delta bases. Storing the
1188 pack from a push can make the push operation complete faster,
1189 especially on slow filesystems. If not set, the value of
1190 `transfer.unpackLimit` is used instead.
1193 If true, fetch will automatically behave as if the `--prune`
1194 option was given on the command line. See also `remote.<name>.prune`.
1197 Enable multipart/mixed attachments as the default for
1198 'format-patch'. The value can also be a double quoted string
1199 which will enable attachments as the default and set the
1200 value as the boundary. See the --attach option in
1201 linkgit:git-format-patch[1].
1204 A boolean which can enable or disable sequence numbers in patch
1205 subjects. It defaults to "auto" which enables it only if there
1206 is more than one patch. It can be enabled or disabled for all
1207 messages by setting it to "true" or "false". See --numbered
1208 option in linkgit:git-format-patch[1].
1211 Additional email headers to include in a patch to be submitted
1212 by mail. See linkgit:git-format-patch[1].
1216 Additional recipients to include in a patch to be submitted
1217 by mail. See the --to and --cc options in
1218 linkgit:git-format-patch[1].
1220 format.subjectPrefix::
1221 The default for format-patch is to output files with the '[PATCH]'
1222 subject prefix. Use this variable to change that prefix.
1225 The default for format-patch is to output a signature containing
1226 the Git version number. Use this variable to change that default.
1227 Set this variable to the empty string ("") to suppress
1228 signature generation.
1230 format.signatureFile::
1231 Works just like format.signature except the contents of the
1232 file specified by this variable will be used as the signature.
1235 The default for format-patch is to output files with the suffix
1236 `.patch`. Use this variable to change that suffix (make sure to
1237 include the dot if you want it).
1240 The default pretty format for log/show/whatchanged command,
1241 See linkgit:git-log[1], linkgit:git-show[1],
1242 linkgit:git-whatchanged[1].
1245 The default threading style for 'git format-patch'. Can be
1246 a boolean value, or `shallow` or `deep`. `shallow` threading
1247 makes every mail a reply to the head of the series,
1248 where the head is chosen from the cover letter, the
1249 `--in-reply-to`, and the first patch mail, in this order.
1250 `deep` threading makes every mail a reply to the previous one.
1251 A true boolean value is the same as `shallow`, and a false
1252 value disables threading.
1255 A boolean value which lets you enable the `-s/--signoff` option of
1256 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1257 patch should be a conscious act and means that you certify you have
1258 the rights to submit this work under the same open source license.
1259 Please see the 'SubmittingPatches' document for further discussion.
1261 format.coverLetter::
1262 A boolean that controls whether to generate a cover-letter when
1263 format-patch is invoked, but in addition can be set to "auto", to
1264 generate a cover-letter only when there's more than one patch.
1266 format.outputDirectory::
1267 Set a custom directory to store the resulting files instead of the
1268 current working directory.
1270 filter.<driver>.clean::
1271 The command which is used to convert the content of a worktree
1272 file to a blob upon checkin. See linkgit:gitattributes[5] for
1275 filter.<driver>.smudge::
1276 The command which is used to convert the content of a blob
1277 object to a worktree file upon checkout. See
1278 linkgit:gitattributes[5] for details.
1281 Allows overriding the message type (error, warn or ignore) of a
1282 specific message ID such as `missingEmail`.
1284 For convenience, fsck prefixes the error/warning with the message ID,
1285 e.g. "missingEmail: invalid author/committer line - missing email" means
1286 that setting `fsck.missingEmail = ignore` will hide that issue.
1288 This feature is intended to support working with legacy repositories
1289 which cannot be repaired without disruptive changes.
1292 The path to a sorted list of object names (i.e. one SHA-1 per
1293 line) that are known to be broken in a non-fatal way and should
1294 be ignored. This feature is useful when an established project
1295 should be accepted despite early commits containing errors that
1296 can be safely ignored such as invalid committer email addresses.
1297 Note: corrupt objects cannot be skipped with this setting.
1299 gc.aggressiveDepth::
1300 The depth parameter used in the delta compression
1301 algorithm used by 'git gc --aggressive'. This defaults
1304 gc.aggressiveWindow::
1305 The window size parameter used in the delta compression
1306 algorithm used by 'git gc --aggressive'. This defaults
1310 When there are approximately more than this many loose
1311 objects in the repository, `git gc --auto` will pack them.
1312 Some Porcelain commands use this command to perform a
1313 light-weight garbage collection from time to time. The
1314 default value is 6700. Setting this to 0 disables it.
1317 When there are more than this many packs that are not
1318 marked with `*.keep` file in the repository, `git gc
1319 --auto` consolidates them into one larger pack. The
1320 default value is 50. Setting this to 0 disables it.
1323 Make `git gc --auto` return immediately and run in background
1324 if the system supports it. Default is true.
1327 Running `git pack-refs` in a repository renders it
1328 unclonable by Git versions prior to 1.5.1.2 over dumb
1329 transports such as HTTP. This variable determines whether
1330 'git gc' runs `git pack-refs`. This can be set to `notbare`
1331 to enable it within all non-bare repos or it can be set to a
1332 boolean value. The default is `true`.
1335 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1336 Override the grace period with this config variable. The value
1337 "now" may be used to disable this grace period and always prune
1338 unreachable objects immediately, or "never" may be used to
1341 gc.worktreePruneExpire::
1342 When 'git gc' is run, it calls
1343 'git worktree prune --expire 3.months.ago'.
1344 This config variable can be used to set a different grace
1345 period. The value "now" may be used to disable the grace
1346 period and prune $GIT_DIR/worktrees immediately, or "never"
1347 may be used to suppress pruning.
1350 gc.<pattern>.reflogExpire::
1351 'git reflog expire' removes reflog entries older than
1352 this time; defaults to 90 days. The value "now" expires all
1353 entries immediately, and "never" suppresses expiration
1354 altogether. With "<pattern>" (e.g.
1355 "refs/stash") in the middle the setting applies only to
1356 the refs that match the <pattern>.
1358 gc.reflogExpireUnreachable::
1359 gc.<pattern>.reflogExpireUnreachable::
1360 'git reflog expire' removes reflog entries older than
1361 this time and are not reachable from the current tip;
1362 defaults to 30 days. The value "now" expires all entries
1363 immediately, and "never" suppresses expiration altogether.
1364 With "<pattern>" (e.g. "refs/stash")
1365 in the middle, the setting applies only to the refs that
1366 match the <pattern>.
1369 Records of conflicted merge you resolved earlier are
1370 kept for this many days when 'git rerere gc' is run.
1371 The default is 60 days. See linkgit:git-rerere[1].
1373 gc.rerereUnresolved::
1374 Records of conflicted merge you have not resolved are
1375 kept for this many days when 'git rerere gc' is run.
1376 The default is 15 days. See linkgit:git-rerere[1].
1378 gitcvs.commitMsgAnnotation::
1379 Append this string to each commit message. Set to empty string
1380 to disable this feature. Defaults to "via git-CVS emulator".
1383 Whether the CVS server interface is enabled for this repository.
1384 See linkgit:git-cvsserver[1].
1387 Path to a log file where the CVS server interface well... logs
1388 various stuff. See linkgit:git-cvsserver[1].
1390 gitcvs.usecrlfattr::
1391 If true, the server will look up the end-of-line conversion
1392 attributes for files to determine the '-k' modes to use. If
1393 the attributes force Git to treat a file as text,
1394 the '-k' mode will be left blank so CVS clients will
1395 treat it as text. If they suppress text conversion, the file
1396 will be set with '-kb' mode, which suppresses any newline munging
1397 the client might otherwise do. If the attributes do not allow
1398 the file type to be determined, then 'gitcvs.allBinary' is
1399 used. See linkgit:gitattributes[5].
1402 This is used if 'gitcvs.usecrlfattr' does not resolve
1403 the correct '-kb' mode to use. If true, all
1404 unresolved files are sent to the client in
1405 mode '-kb'. This causes the client to treat them
1406 as binary files, which suppresses any newline munging it
1407 otherwise might do. Alternatively, if it is set to "guess",
1408 then the contents of the file are examined to decide if
1409 it is binary, similar to 'core.autocrlf'.
1412 Database used by git-cvsserver to cache revision information
1413 derived from the Git repository. The exact meaning depends on the
1414 used database driver, for SQLite (which is the default driver) this
1415 is a filename. Supports variable substitution (see
1416 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1417 Default: '%Ggitcvs.%m.sqlite'
1420 Used Perl DBI driver. You can specify any available driver
1421 for this here, but it might not work. git-cvsserver is tested
1422 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1423 reported *not* to work with 'DBD::mysql'. Experimental feature.
1424 May not contain double colons (`:`). Default: 'SQLite'.
1425 See linkgit:git-cvsserver[1].
1427 gitcvs.dbUser, gitcvs.dbPass::
1428 Database user and password. Only useful if setting 'gitcvs.dbDriver',
1429 since SQLite has no concept of database users and/or passwords.
1430 'gitcvs.dbUser' supports variable substitution (see
1431 linkgit:git-cvsserver[1] for details).
1433 gitcvs.dbTableNamePrefix::
1434 Database table name prefix. Prepended to the names of any
1435 database tables used, allowing a single database to be used
1436 for several repositories. Supports variable substitution (see
1437 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1438 characters will be replaced with underscores.
1440 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1441 'gitcvs.allBinary' can also be specified as
1442 'gitcvs.<access_method>.<varname>' (where 'access_method'
1443 is one of "ext" and "pserver") to make them apply only for the given
1447 gitweb.description::
1450 See linkgit:gitweb[1] for description.
1458 gitweb.remote_heads::
1461 See linkgit:gitweb.conf[5] for description.
1464 If set to true, enable '-n' option by default.
1467 Set the default matching behavior. Using a value of 'basic', 'extended',
1468 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1469 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1470 value 'default' will return to the default matching behavior.
1472 grep.extendedRegexp::
1473 If set to true, enable '--extended-regexp' option by default. This
1474 option is ignored when the 'grep.patternType' option is set to a value
1475 other than 'default'.
1478 Number of grep worker threads to use.
1479 See `grep.threads` in linkgit:git-grep[1] for more information.
1481 grep.fallbackToNoIndex::
1482 If set to true, fall back to git grep --no-index if git grep
1483 is executed outside of a git repository. Defaults to false.
1486 Use this custom program instead of "gpg" found on $PATH when
1487 making or verifying a PGP signature. The program must support the
1488 same command-line interface as GPG, namely, to verify a detached
1489 signature, "gpg --verify $file - <$signature" is run, and the
1490 program is expected to signal a good signature by exiting with
1491 code 0, and to generate an ASCII-armored detached signature, the
1492 standard input of "gpg -bsau $key" is fed with the contents to be
1493 signed, and the program is expected to send the result to its
1496 gui.commitMsgWidth::
1497 Defines how wide the commit message window is in the
1498 linkgit:git-gui[1]. "75" is the default.
1501 Specifies how many context lines should be used in calls to diff
1502 made by the linkgit:git-gui[1]. The default is "5".
1504 gui.displayUntracked::
1505 Determines if linkgit::git-gui[1] shows untracked files
1506 in the file list. The default is "true".
1509 Specifies the default encoding to use for displaying of
1510 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1511 It can be overridden by setting the 'encoding' attribute
1512 for relevant files (see linkgit:gitattributes[5]).
1513 If this option is not set, the tools default to the
1516 gui.matchTrackingBranch::
1517 Determines if new branches created with linkgit:git-gui[1] should
1518 default to tracking remote branches with matching names or
1519 not. Default: "false".
1521 gui.newBranchTemplate::
1522 Is used as suggested name when creating new branches using the
1525 gui.pruneDuringFetch::
1526 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1527 performing a fetch. The default value is "false".
1530 Determines if linkgit:git-gui[1] should trust the file modification
1531 timestamp or not. By default the timestamps are not trusted.
1533 gui.spellingDictionary::
1534 Specifies the dictionary used for spell checking commit messages in
1535 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1539 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1540 location detection. It makes blame significantly faster on huge
1541 repositories at the expense of less thorough copy detection.
1543 gui.copyBlameThreshold::
1544 Specifies the threshold to use in 'git gui blame' original location
1545 detection, measured in alphanumeric characters. See the
1546 linkgit:git-blame[1] manual for more information on copy detection.
1548 gui.blamehistoryctx::
1549 Specifies the radius of history context in days to show in
1550 linkgit:gitk[1] for the selected commit, when the `Show History
1551 Context` menu item is invoked from 'git gui blame'. If this
1552 variable is set to zero, the whole history is shown.
1554 guitool.<name>.cmd::
1555 Specifies the shell command line to execute when the corresponding item
1556 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1557 mandatory for every tool. The command is executed from the root of
1558 the working directory, and in the environment it receives the name of
1559 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1560 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1561 the head is detached, 'CUR_BRANCH' is empty).
1563 guitool.<name>.needsFile::
1564 Run the tool only if a diff is selected in the GUI. It guarantees
1565 that 'FILENAME' is not empty.
1567 guitool.<name>.noConsole::
1568 Run the command silently, without creating a window to display its
1571 guitool.<name>.noRescan::
1572 Don't rescan the working directory for changes after the tool
1575 guitool.<name>.confirm::
1576 Show a confirmation dialog before actually running the tool.
1578 guitool.<name>.argPrompt::
1579 Request a string argument from the user, and pass it to the tool
1580 through the 'ARGS' environment variable. Since requesting an
1581 argument implies confirmation, the 'confirm' option has no effect
1582 if this is enabled. If the option is set to 'true', 'yes', or '1',
1583 the dialog uses a built-in generic prompt; otherwise the exact
1584 value of the variable is used.
1586 guitool.<name>.revPrompt::
1587 Request a single valid revision from the user, and set the
1588 'REVISION' environment variable. In other aspects this option
1589 is similar to 'argPrompt', and can be used together with it.
1591 guitool.<name>.revUnmerged::
1592 Show only unmerged branches in the 'revPrompt' subdialog.
1593 This is useful for tools similar to merge or rebase, but not
1594 for things like checkout or reset.
1596 guitool.<name>.title::
1597 Specifies the title to use for the prompt dialog. The default
1600 guitool.<name>.prompt::
1601 Specifies the general prompt string to display at the top of
1602 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1603 The default value includes the actual command.
1606 Specify the browser that will be used to display help in the
1607 'web' format. See linkgit:git-help[1].
1610 Override the default help format used by linkgit:git-help[1].
1611 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1612 the default. 'web' and 'html' are the same.
1615 Automatically correct and execute mistyped commands after
1616 waiting for the given number of deciseconds (0.1 sec). If more
1617 than one command can be deduced from the entered text, nothing
1618 will be executed. If the value of this option is negative,
1619 the corrected command will be executed immediately. If the
1620 value is 0 - the command will be just shown but not executed.
1621 This is the default.
1624 Specify the path where the HTML documentation resides. File system paths
1625 and URLs are supported. HTML pages will be prefixed with this path when
1626 help is displayed in the 'web' format. This defaults to the documentation
1627 path of your Git installation.
1630 Override the HTTP proxy, normally configured using the 'http_proxy',
1631 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1632 addition to the syntax understood by curl, it is possible to specify a
1633 proxy string with a user name but no password, in which case git will
1634 attempt to acquire one in the same way it does for other credentials. See
1635 linkgit:gitcredentials[7] for more information. The syntax thus is
1636 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1637 on a per-remote basis; see remote.<name>.proxy
1639 http.proxyAuthMethod::
1640 Set the method with which to authenticate against the HTTP proxy. This
1641 only takes effect if the configured proxy string contains a user name part
1642 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1643 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1644 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1645 variable. Possible values are:
1648 * `anyauth` - Automatically pick a suitable authentication method. It is
1649 assumed that the proxy answers an unauthenticated request with a 407
1650 status code and one or more Proxy-authenticate headers with supported
1651 authentication methods. This is the default.
1652 * `basic` - HTTP Basic authentication
1653 * `digest` - HTTP Digest authentication; this prevents the password from being
1654 transmitted to the proxy in clear text
1655 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1657 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1661 Attempt authentication without seeking a username or password. This
1662 can be used to attempt GSS-Negotiate authentication without specifying
1663 a username in the URL, as libcurl normally requires a username for
1667 File containing previously stored cookie lines which should be used
1668 in the Git http session, if they match the server. The file format
1669 of the file to read cookies from should be plain HTTP headers or
1670 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1671 NOTE that the file specified with http.cookieFile is only used as
1672 input unless http.saveCookies is set.
1675 If set, store cookies received during requests to the file specified by
1676 http.cookieFile. Has no effect if http.cookieFile is unset.
1679 The SSL version to use when negotiating an SSL connection, if you
1680 want to force the default. The available and default version
1681 depend on whether libcurl was built against NSS or OpenSSL and the
1682 particular configuration of the crypto library in use. Internally
1683 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1684 documentation for more details on the format of this option and
1685 for the ssl version supported. Actually the possible values of
1696 Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1697 To force git to use libcurl's default ssl version and ignore any
1698 explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1701 http.sslCipherList::
1702 A list of SSL ciphers to use when negotiating an SSL connection.
1703 The available ciphers depend on whether libcurl was built against
1704 NSS or OpenSSL and the particular configuration of the crypto
1705 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1706 option; see the libcurl documentation for more details on the format
1709 Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1710 To force git to use libcurl's default cipher list and ignore any
1711 explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1715 Whether to verify the SSL certificate when fetching or pushing
1716 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1720 File containing the SSL certificate when fetching or pushing
1721 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1725 File containing the SSL private key when fetching or pushing
1726 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1729 http.sslCertPasswordProtected::
1730 Enable Git's password prompt for the SSL certificate. Otherwise
1731 OpenSSL will prompt the user, possibly many times, if the
1732 certificate or private key is encrypted. Can be overridden by the
1733 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1736 File containing the certificates to verify the peer with when
1737 fetching or pushing over HTTPS. Can be overridden by the
1738 'GIT_SSL_CAINFO' environment variable.
1741 Path containing files with the CA certificates to verify the peer
1742 with when fetching or pushing over HTTPS. Can be overridden
1743 by the 'GIT_SSL_CAPATH' environment variable.
1746 Public key of the https service. It may either be the filename of
1747 a PEM or DER encoded public key file or a string starting with
1748 'sha256//' followed by the base64 encoded sha256 hash of the
1749 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1750 exit with an error if this option is set but not supported by
1754 Attempt to use AUTH SSL/TLS and encrypted data transfers
1755 when connecting via regular FTP protocol. This might be needed
1756 if the FTP server requires it for security reasons or you wish
1757 to connect securely whenever remote FTP server supports it.
1758 Default is false since it might trigger certificate verification
1759 errors on misconfigured servers.
1762 How many HTTP requests to launch in parallel. Can be overridden
1763 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1766 The number of curl sessions (counted across slots) to be kept across
1767 requests. They will not be ended with curl_easy_cleanup() until
1768 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1769 value will be capped at 1. Defaults to 1.
1772 Maximum size in bytes of the buffer used by smart HTTP
1773 transports when POSTing data to the remote system.
1774 For requests larger than this buffer size, HTTP/1.1 and
1775 Transfer-Encoding: chunked is used to avoid creating a
1776 massive pack file locally. Default is 1 MiB, which is
1777 sufficient for most requests.
1779 http.lowSpeedLimit, http.lowSpeedTime::
1780 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1781 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1782 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1783 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1786 A boolean which disables using of EPSV ftp command by curl.
1787 This can helpful with some "poor" ftp servers which don't
1788 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1789 environment variable. Default is false (curl will use EPSV).
1792 The HTTP USER_AGENT string presented to an HTTP server. The default
1793 value represents the version of the client Git such as git/1.7.1.
1794 This option allows you to override this value to a more common value
1795 such as Mozilla/4.0. This may be necessary, for instance, if
1796 connecting through a firewall that restricts HTTP connections to a set
1797 of common USER_AGENT strings (but not including those like git/1.7.1).
1798 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1801 Any of the http.* options above can be applied selectively to some URLs.
1802 For a config key to match a URL, each element of the config key is
1803 compared to that of the URL, in the following order:
1806 . Scheme (e.g., `https` in `https://example.com/`). This field
1807 must match exactly between the config key and the URL.
1809 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1810 This field must match exactly between the config key and the URL.
1812 . Port number (e.g., `8080` in `http://example.com:8080/`).
1813 This field must match exactly between the config key and the URL.
1814 Omitted port numbers are automatically converted to the correct
1815 default for the scheme before matching.
1817 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1818 path field of the config key must match the path field of the URL
1819 either exactly or as a prefix of slash-delimited path elements. This means
1820 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1821 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1822 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1823 key with just path `foo/`).
1825 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1826 the config key has a user name it must match the user name in the
1827 URL exactly. If the config key does not have a user name, that
1828 config key will match a URL with any user name (including none),
1829 but at a lower precedence than a config key with a user name.
1832 The list above is ordered by decreasing precedence; a URL that matches
1833 a config key's path is preferred to one that matches its user name. For example,
1834 if the URL is `https://user@example.com/foo/bar` a config key match of
1835 `https://example.com/foo` will be preferred over a config key match of
1836 `https://user@example.com`.
1838 All URLs are normalized before attempting any matching (the password part,
1839 if embedded in the URL, is always ignored for matching purposes) so that
1840 equivalent URLs that are simply spelled differently will match properly.
1841 Environment variable settings always override any matches. The URLs that are
1842 matched against are those given directly to Git commands. This means any URLs
1843 visited as a result of a redirection do not participate in matching.
1845 i18n.commitEncoding::
1846 Character encoding the commit messages are stored in; Git itself
1847 does not care per se, but this information is necessary e.g. when
1848 importing commits from emails or in the gitk graphical history
1849 browser (and possibly at other places in the future or in other
1850 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1852 i18n.logOutputEncoding::
1853 Character encoding the commit messages are converted to when
1854 running 'git log' and friends.
1857 The configuration variables in the 'imap' section are described
1858 in linkgit:git-imap-send[1].
1861 Specify the version with which new index files should be
1862 initialized. This does not affect existing repositories.
1865 Specify the directory from which templates will be copied.
1866 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1869 Specify the program that will be used to browse your working
1870 repository in gitweb. See linkgit:git-instaweb[1].
1873 The HTTP daemon command-line to start gitweb on your working
1874 repository. See linkgit:git-instaweb[1].
1877 If true the web server started by linkgit:git-instaweb[1] will
1878 be bound to the local IP (127.0.0.1).
1880 instaweb.modulePath::
1881 The default module path for linkgit:git-instaweb[1] to use
1882 instead of /usr/lib/apache2/modules. Only used if httpd
1886 The port number to bind the gitweb httpd to. See
1887 linkgit:git-instaweb[1].
1889 interactive.singleKey::
1890 In interactive commands, allow the user to provide one-letter
1891 input with a single key (i.e., without hitting enter).
1892 Currently this is used by the `--patch` mode of
1893 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1894 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1895 setting is silently ignored if portable keystroke input
1896 is not available; requires the Perl module Term::ReadKey.
1899 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1900 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1901 override this option with `--no-abbrev-commit`.
1904 Set the default date-time mode for the 'log' command.
1905 Setting a value for log.date is similar to using 'git log''s
1906 `--date` option. See linkgit:git-log[1] for details.
1909 Print out the ref names of any commits that are shown by the log
1910 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1911 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1912 specified, the full ref name (including prefix) will be printed.
1913 This is the same as the log commands '--decorate' option.
1916 If `true`, `git log` will act as if the `--follow` option was used when
1917 a single <path> is given. This has the same limitations as `--follow`,
1918 i.e. it cannot be used to follow multiple files and does not work well
1919 on non-linear history.
1922 If true, the initial commit will be shown as a big creation event.
1923 This is equivalent to a diff against an empty tree.
1924 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1925 normally hide the root commit will now show it. True by default.
1928 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1929 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1932 If true, makes linkgit:git-mailinfo[1] (and therefore
1933 linkgit:git-am[1]) act by default as if the --scissors option
1934 was provided on the command-line. When active, this features
1935 removes everything from the message body before a scissors
1936 line (i.e. consisting mainly of ">8", "8<" and "-").
1939 The location of an augmenting mailmap file. The default
1940 mailmap, located in the root of the repository, is loaded
1941 first, then the mailmap file pointed to by this variable.
1942 The location of the mailmap file may be in a repository
1943 subdirectory, or somewhere outside of the repository itself.
1944 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1947 Like `mailmap.file`, but consider the value as a reference to a
1948 blob in the repository. If both `mailmap.file` and
1949 `mailmap.blob` are given, both are parsed, with entries from
1950 `mailmap.file` taking precedence. In a bare repository, this
1951 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1955 Specify the programs that may be used to display help in the
1956 'man' format. See linkgit:git-help[1].
1959 Specify the command to invoke the specified man viewer. The
1960 specified command is evaluated in shell with the man page
1961 passed as argument. (See linkgit:git-help[1].)
1964 Override the path for the given tool that may be used to
1965 display help in the 'man' format. See linkgit:git-help[1].
1967 include::merge-config.txt[]
1969 mergetool.<tool>.path::
1970 Override the path for the given tool. This is useful in case
1971 your tool is not in the PATH.
1973 mergetool.<tool>.cmd::
1974 Specify the command to invoke the specified merge tool. The
1975 specified command is evaluated in shell with the following
1976 variables available: 'BASE' is the name of a temporary file
1977 containing the common base of the files to be merged, if available;
1978 'LOCAL' is the name of a temporary file containing the contents of
1979 the file on the current branch; 'REMOTE' is the name of a temporary
1980 file containing the contents of the file from the branch being
1981 merged; 'MERGED' contains the name of the file to which the merge
1982 tool should write the results of a successful merge.
1984 mergetool.<tool>.trustExitCode::
1985 For a custom merge command, specify whether the exit code of
1986 the merge command can be used to determine whether the merge was
1987 successful. If this is not set to true then the merge target file
1988 timestamp is checked and the merge assumed to have been successful
1989 if the file has been updated, otherwise the user is prompted to
1990 indicate the success of the merge.
1992 mergetool.meld.hasOutput::
1993 Older versions of `meld` do not support the `--output` option.
1994 Git will attempt to detect whether `meld` supports `--output`
1995 by inspecting the output of `meld --help`. Configuring
1996 `mergetool.meld.hasOutput` will make Git skip these checks and
1997 use the configured value instead. Setting `mergetool.meld.hasOutput`
1998 to `true` tells Git to unconditionally use the `--output` option,
1999 and `false` avoids using `--output`.
2001 mergetool.keepBackup::
2002 After performing a merge, the original file with conflict markers
2003 can be saved as a file with a `.orig` extension. If this variable
2004 is set to `false` then this file is not preserved. Defaults to
2005 `true` (i.e. keep the backup files).
2007 mergetool.keepTemporaries::
2008 When invoking a custom merge tool, Git uses a set of temporary
2009 files to pass to the tool. If the tool returns an error and this
2010 variable is set to `true`, then these temporary files will be
2011 preserved, otherwise they will be removed after the tool has
2012 exited. Defaults to `false`.
2014 mergetool.writeToTemp::
2015 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2016 conflicting files in the worktree by default. Git will attempt
2017 to use a temporary directory for these files when set `true`.
2018 Defaults to `false`.
2021 Prompt before each invocation of the merge resolution program.
2023 notes.mergeStrategy::
2024 Which merge strategy to choose by default when resolving notes
2025 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2026 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2027 section of linkgit:git-notes[1] for more information on each strategy.
2029 notes.<name>.mergeStrategy::
2030 Which merge strategy to choose when doing a notes merge into
2031 refs/notes/<name>. This overrides the more general
2032 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2033 linkgit:git-notes[1] for more information on the available strategies.
2036 The (fully qualified) refname from which to show notes when
2037 showing commit messages. The value of this variable can be set
2038 to a glob, in which case notes from all matching refs will be
2039 shown. You may also specify this configuration variable
2040 several times. A warning will be issued for refs that do not
2041 exist, but a glob that does not match any refs is silently
2044 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2045 environment variable, which must be a colon separated list of refs or
2048 The effective value of "core.notesRef" (possibly overridden by
2049 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2052 notes.rewrite.<command>::
2053 When rewriting commits with <command> (currently `amend` or
2054 `rebase`) and this variable is set to `true`, Git
2055 automatically copies your notes from the original to the
2056 rewritten commit. Defaults to `true`, but see
2057 "notes.rewriteRef" below.
2060 When copying notes during a rewrite (see the
2061 "notes.rewrite.<command>" option), determines what to do if
2062 the target commit already has a note. Must be one of
2063 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2064 Defaults to `concatenate`.
2066 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2067 environment variable.
2070 When copying notes during a rewrite, specifies the (fully
2071 qualified) ref whose notes should be copied. The ref may be a
2072 glob, in which case notes in all matching refs will be copied.
2073 You may also specify this configuration several times.
2075 Does not have a default value; you must configure this variable to
2076 enable note rewriting. Set it to `refs/notes/commits` to enable
2077 rewriting for the default commit notes.
2079 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2080 environment variable, which must be a colon separated list of refs or
2084 The size of the window used by linkgit:git-pack-objects[1] when no
2085 window size is given on the command line. Defaults to 10.
2088 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2089 maximum depth is given on the command line. Defaults to 50.
2092 The maximum size of memory that is consumed by each thread
2093 in linkgit:git-pack-objects[1] for pack window memory when
2094 no limit is given on the command line. The value can be
2095 suffixed with "k", "m", or "g". When left unconfigured (or
2096 set explicitly to 0), there will be no limit.
2099 An integer -1..9, indicating the compression level for objects
2100 in a pack file. -1 is the zlib default. 0 means no
2101 compression, and 1..9 are various speed/size tradeoffs, 9 being
2102 slowest. If not set, defaults to core.compression. If that is
2103 not set, defaults to -1, the zlib default, which is "a default
2104 compromise between speed and compression (currently equivalent
2107 Note that changing the compression level will not automatically recompress
2108 all existing objects. You can force recompression by passing the -F option
2109 to linkgit:git-repack[1].
2111 pack.deltaCacheSize::
2112 The maximum memory in bytes used for caching deltas in
2113 linkgit:git-pack-objects[1] before writing them out to a pack.
2114 This cache is used to speed up the writing object phase by not
2115 having to recompute the final delta result once the best match
2116 for all objects is found. Repacking large repositories on machines
2117 which are tight with memory might be badly impacted by this though,
2118 especially if this cache pushes the system into swapping.
2119 A value of 0 means no limit. The smallest size of 1 byte may be
2120 used to virtually disable this cache. Defaults to 256 MiB.
2122 pack.deltaCacheLimit::
2123 The maximum size of a delta, that is cached in
2124 linkgit:git-pack-objects[1]. This cache is used to speed up the
2125 writing object phase by not having to recompute the final delta
2126 result once the best match for all objects is found. Defaults to 1000.
2129 Specifies the number of threads to spawn when searching for best
2130 delta matches. This requires that linkgit:git-pack-objects[1]
2131 be compiled with pthreads otherwise this option is ignored with a
2132 warning. This is meant to reduce packing time on multiprocessor
2133 machines. The required amount of memory for the delta search window
2134 is however multiplied by the number of threads.
2135 Specifying 0 will cause Git to auto-detect the number of CPU's
2136 and set the number of threads accordingly.
2139 Specify the default pack index version. Valid values are 1 for
2140 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2141 the new pack index with capabilities for packs larger than 4 GB
2142 as well as proper protection against the repacking of corrupted
2143 packs. Version 2 is the default. Note that version 2 is enforced
2144 and this config option ignored whenever the corresponding pack is
2147 If you have an old Git that does not understand the version 2 `*.idx` file,
2148 cloning or fetching over a non native protocol (e.g. "http")
2149 that will copy both `*.pack` file and corresponding `*.idx` file from the
2150 other side may give you a repository that cannot be accessed with your
2151 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2152 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2155 pack.packSizeLimit::
2156 The maximum size of a pack. This setting only affects
2157 packing to a file when repacking, i.e. the git:// protocol
2158 is unaffected. It can be overridden by the `--max-pack-size`
2159 option of linkgit:git-repack[1]. The minimum size allowed is
2160 limited to 1 MiB. The default is unlimited.
2161 Common unit suffixes of 'k', 'm', or 'g' are
2165 When true, git will use pack bitmaps (if available) when packing
2166 to stdout (e.g., during the server side of a fetch). Defaults to
2167 true. You should not generally need to turn this off unless
2168 you are debugging pack bitmaps.
2170 pack.writeBitmaps (deprecated)::
2171 This is a deprecated synonym for `repack.writeBitmaps`.
2173 pack.writeBitmapHashCache::
2174 When true, git will include a "hash cache" section in the bitmap
2175 index (if one is written). This cache can be used to feed git's
2176 delta heuristics, potentially leading to better deltas between
2177 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2178 between an older, bitmapped pack and objects that have been
2179 pushed since the last gc). The downside is that it consumes 4
2180 bytes per object of disk space, and that JGit's bitmap
2181 implementation does not understand it, causing it to complain if
2182 Git and JGit are used on the same repository. Defaults to false.
2185 If the value is boolean, turns on or off pagination of the
2186 output of a particular Git subcommand when writing to a tty.
2187 Otherwise, turns on pagination for the subcommand using the
2188 pager specified by the value of `pager.<cmd>`. If `--paginate`
2189 or `--no-pager` is specified on the command line, it takes
2190 precedence over this option. To disable pagination for all
2191 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2194 Alias for a --pretty= format string, as specified in
2195 linkgit:git-log[1]. Any aliases defined here can be used just
2196 as the built-in pretty formats could. For example,
2197 running `git config pretty.changelog "format:* %H %s"`
2198 would cause the invocation `git log --pretty=changelog`
2199 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2200 Note that an alias with the same name as a built-in format
2201 will be silently ignored.
2204 By default, Git does not create an extra merge commit when merging
2205 a commit that is a descendant of the current commit. Instead, the
2206 tip of the current branch is fast-forwarded. When set to `false`,
2207 this variable tells Git to create an extra merge commit in such
2208 a case (equivalent to giving the `--no-ff` option from the command
2209 line). When set to `only`, only such fast-forward merges are
2210 allowed (equivalent to giving the `--ff-only` option from the
2211 command line). This setting overrides `merge.ff` when pulling.
2214 When true, rebase branches on top of the fetched branch, instead
2215 of merging the default branch from the default remote when "git
2216 pull" is run. See "branch.<name>.rebase" for setting this on a
2219 When preserve, also pass `--preserve-merges` along to 'git rebase'
2220 so that locally committed merge commits will not be flattened
2221 by running 'git pull'.
2223 When the value is `interactive`, the rebase is run in interactive mode.
2225 *NOTE*: this is a possibly dangerous operation; do *not* use
2226 it unless you understand the implications (see linkgit:git-rebase[1]
2230 The default merge strategy to use when pulling multiple branches
2234 The default merge strategy to use when pulling a single branch.
2237 Defines the action `git push` should take if no refspec is
2238 explicitly given. Different values are well-suited for
2239 specific workflows; for instance, in a purely central workflow
2240 (i.e. the fetch source is equal to the push destination),
2241 `upstream` is probably what you want. Possible values are:
2245 * `nothing` - do not push anything (error out) unless a refspec is
2246 explicitly given. This is primarily meant for people who want to
2247 avoid mistakes by always being explicit.
2249 * `current` - push the current branch to update a branch with the same
2250 name on the receiving end. Works in both central and non-central
2253 * `upstream` - push the current branch back to the branch whose
2254 changes are usually integrated into the current branch (which is
2255 called `@{upstream}`). This mode only makes sense if you are
2256 pushing to the same repository you would normally pull from
2257 (i.e. central workflow).
2259 * `simple` - in centralized workflow, work like `upstream` with an
2260 added safety to refuse to push if the upstream branch's name is
2261 different from the local one.
2263 When pushing to a remote that is different from the remote you normally
2264 pull from, work as `current`. This is the safest option and is suited
2267 This mode has become the default in Git 2.0.
2269 * `matching` - push all branches having the same name on both ends.
2270 This makes the repository you are pushing to remember the set of
2271 branches that will be pushed out (e.g. if you always push 'maint'
2272 and 'master' there and no other branches, the repository you push
2273 to will have these two branches, and your local 'maint' and
2274 'master' will be pushed there).
2276 To use this mode effectively, you have to make sure _all_ the
2277 branches you would push out are ready to be pushed out before
2278 running 'git push', as the whole point of this mode is to allow you
2279 to push all of the branches in one go. If you usually finish work
2280 on only one branch and push out the result, while other branches are
2281 unfinished, this mode is not for you. Also this mode is not
2282 suitable for pushing into a shared central repository, as other
2283 people may add new branches there, or update the tip of existing
2284 branches outside your control.
2286 This used to be the default, but not since Git 2.0 (`simple` is the
2292 If set to true enable '--follow-tags' option by default. You
2293 may override this configuration at time of push by specifying
2297 May be set to a boolean value, or the string 'if-asked'. A true
2298 value causes all pushes to be GPG signed, as if '--signed' is
2299 passed to linkgit:git-push[1]. The string 'if-asked' causes
2300 pushes to be signed if the server supports it, as if
2301 '--signed=if-asked' is passed to 'git push'. A false value may
2302 override a value from a lower-priority config file. An explicit
2303 command-line flag always overrides this config option.
2305 push.recurseSubmodules::
2306 Make sure all submodule commits used by the revisions to be pushed
2307 are available on a remote-tracking branch. If the value is 'check'
2308 then Git will verify that all submodule commits that changed in the
2309 revisions to be pushed are available on at least one remote of the
2310 submodule. If any commits are missing, the push will be aborted and
2311 exit with non-zero status. If the value is 'on-demand' then all
2312 submodules that changed in the revisions to be pushed will be
2313 pushed. If on-demand was not able to push all necessary revisions
2314 it will also be aborted and exit with non-zero status. If the value
2315 is 'no' then default behavior of ignoring submodules when pushing
2316 is retained. You may override this configuration at time of push by
2317 specifying '--recurse-submodules=check|on-demand|no'.
2320 Whether to show a diffstat of what changed upstream since the last
2321 rebase. False by default.
2324 If set to true enable '--autosquash' option by default.
2327 When set to true, automatically create a temporary stash
2328 before the operation begins, and apply it after the operation
2329 ends. This means that you can run rebase on a dirty worktree.
2330 However, use with care: the final stash application after a
2331 successful rebase might result in non-trivial conflicts.
2334 rebase.missingCommitsCheck::
2335 If set to "warn", git rebase -i will print a warning if some
2336 commits are removed (e.g. a line was deleted), however the
2337 rebase will still proceed. If set to "error", it will print
2338 the previous warning and stop the rebase, 'git rebase
2339 --edit-todo' can then be used to correct the error. If set to
2340 "ignore", no checking is done.
2341 To drop a commit without warning or error, use the `drop`
2342 command in the todo-list.
2343 Defaults to "ignore".
2345 rebase.instructionFormat
2346 A format string, as specified in linkgit:git-log[1], to be used for
2347 the instruction list during an interactive rebase. The format will automatically
2348 have the long commit hash prepended to the format.
2350 receive.advertiseAtomic::
2351 By default, git-receive-pack will advertise the atomic push
2352 capability to its clients. If you don't want to this capability
2353 to be advertised, set this variable to false.
2356 By default, git-receive-pack will run "git-gc --auto" after
2357 receiving data from git-push and updating refs. You can stop
2358 it by setting this variable to false.
2360 receive.certNonceSeed::
2361 By setting this variable to a string, `git receive-pack`
2362 will accept a `git push --signed` and verifies it by using
2363 a "nonce" protected by HMAC using this string as a secret
2366 receive.certNonceSlop::
2367 When a `git push --signed` sent a push certificate with a
2368 "nonce" that was issued by a receive-pack serving the same
2369 repository within this many seconds, export the "nonce"
2370 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2371 hooks (instead of what the receive-pack asked the sending
2372 side to include). This may allow writing checks in
2373 `pre-receive` and `post-receive` a bit easier. Instead of
2374 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2375 that records by how many seconds the nonce is stale to
2376 decide if they want to accept the certificate, they only
2377 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2379 receive.fsckObjects::
2380 If it is set to true, git-receive-pack will check all received
2381 objects. It will abort in the case of a malformed object or a
2382 broken link. The result of an abort are only dangling objects.
2383 Defaults to false. If not set, the value of `transfer.fsckObjects`
2386 receive.fsck.<msg-id>::
2387 When `receive.fsckObjects` is set to true, errors can be switched
2388 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2389 setting where the `<msg-id>` is the fsck message ID and the value
2390 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2391 the error/warning with the message ID, e.g. "missingEmail: invalid
2392 author/committer line - missing email" means that setting
2393 `receive.fsck.missingEmail = ignore` will hide that issue.
2395 This feature is intended to support working with legacy repositories
2396 which would not pass pushing when `receive.fsckObjects = true`, allowing
2397 the host to accept repositories with certain known issues but still catch
2400 receive.fsck.skipList::
2401 The path to a sorted list of object names (i.e. one SHA-1 per
2402 line) that are known to be broken in a non-fatal way and should
2403 be ignored. This feature is useful when an established project
2404 should be accepted despite early commits containing errors that
2405 can be safely ignored such as invalid committer email addresses.
2406 Note: corrupt objects cannot be skipped with this setting.
2408 receive.unpackLimit::
2409 If the number of objects received in a push is below this
2410 limit then the objects will be unpacked into loose object
2411 files. However if the number of received objects equals or
2412 exceeds this limit then the received pack will be stored as
2413 a pack, after adding any missing delta bases. Storing the
2414 pack from a push can make the push operation complete faster,
2415 especially on slow filesystems. If not set, the value of
2416 `transfer.unpackLimit` is used instead.
2418 receive.denyDeletes::
2419 If set to true, git-receive-pack will deny a ref update that deletes
2420 the ref. Use this to prevent such a ref deletion via a push.
2422 receive.denyDeleteCurrent::
2423 If set to true, git-receive-pack will deny a ref update that
2424 deletes the currently checked out branch of a non-bare repository.
2426 receive.denyCurrentBranch::
2427 If set to true or "refuse", git-receive-pack will deny a ref update
2428 to the currently checked out branch of a non-bare repository.
2429 Such a push is potentially dangerous because it brings the HEAD
2430 out of sync with the index and working tree. If set to "warn",
2431 print a warning of such a push to stderr, but allow the push to
2432 proceed. If set to false or "ignore", allow such pushes with no
2433 message. Defaults to "refuse".
2435 Another option is "updateInstead" which will update the working
2436 tree if pushing into the current branch. This option is
2437 intended for synchronizing working directories when one side is not easily
2438 accessible via interactive ssh (e.g. a live web site, hence the requirement
2439 that the working directory be clean). This mode also comes in handy when
2440 developing inside a VM to test and fix code on different Operating Systems.
2442 By default, "updateInstead" will refuse the push if the working tree or
2443 the index have any difference from the HEAD, but the `push-to-checkout`
2444 hook can be used to customize this. See linkgit:githooks[5].
2446 receive.denyNonFastForwards::
2447 If set to true, git-receive-pack will deny a ref update which is
2448 not a fast-forward. Use this to prevent such an update via a push,
2449 even if that push is forced. This configuration variable is
2450 set when initializing a shared repository.
2453 This variable is the same as `transfer.hideRefs`, but applies
2454 only to `receive-pack` (and so affects pushes, but not fetches).
2455 An attempt to update or delete a hidden ref by `git push` is
2458 receive.updateServerInfo::
2459 If set to true, git-receive-pack will run git-update-server-info
2460 after receiving data from git-push and updating refs.
2462 receive.shallowUpdate::
2463 If set to true, .git/shallow can be updated when new refs
2464 require new shallow roots. Otherwise those refs are rejected.
2466 remote.pushDefault::
2467 The remote to push to by default. Overrides
2468 `branch.<name>.remote` for all branches, and is overridden by
2469 `branch.<name>.pushRemote` for specific branches.
2472 The URL of a remote repository. See linkgit:git-fetch[1] or
2473 linkgit:git-push[1].
2475 remote.<name>.pushurl::
2476 The push URL of a remote repository. See linkgit:git-push[1].
2478 remote.<name>.proxy::
2479 For remotes that require curl (http, https and ftp), the URL to
2480 the proxy to use for that remote. Set to the empty string to
2481 disable proxying for that remote.
2483 remote.<name>.proxyAuthMethod::
2484 For remotes that require curl (http, https and ftp), the method to use for
2485 authenticating against the proxy in use (probably set in
2486 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2488 remote.<name>.fetch::
2489 The default set of "refspec" for linkgit:git-fetch[1]. See
2490 linkgit:git-fetch[1].
2492 remote.<name>.push::
2493 The default set of "refspec" for linkgit:git-push[1]. See
2494 linkgit:git-push[1].
2496 remote.<name>.mirror::
2497 If true, pushing to this remote will automatically behave
2498 as if the `--mirror` option was given on the command line.
2500 remote.<name>.skipDefaultUpdate::
2501 If true, this remote will be skipped by default when updating
2502 using linkgit:git-fetch[1] or the `update` subcommand of
2503 linkgit:git-remote[1].
2505 remote.<name>.skipFetchAll::
2506 If true, this remote will be skipped by default when updating
2507 using linkgit:git-fetch[1] or the `update` subcommand of
2508 linkgit:git-remote[1].
2510 remote.<name>.receivepack::
2511 The default program to execute on the remote side when pushing. See
2512 option --receive-pack of linkgit:git-push[1].
2514 remote.<name>.uploadpack::
2515 The default program to execute on the remote side when fetching. See
2516 option --upload-pack of linkgit:git-fetch-pack[1].
2518 remote.<name>.tagOpt::
2519 Setting this value to --no-tags disables automatic tag following when
2520 fetching from remote <name>. Setting it to --tags will fetch every
2521 tag from remote <name>, even if they are not reachable from remote
2522 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2523 override this setting. See options --tags and --no-tags of
2524 linkgit:git-fetch[1].
2527 Setting this to a value <vcs> will cause Git to interact with
2528 the remote with the git-remote-<vcs> helper.
2530 remote.<name>.prune::
2531 When set to true, fetching from this remote by default will also
2532 remove any remote-tracking references that no longer exist on the
2533 remote (as if the `--prune` option was given on the command line).
2534 Overrides `fetch.prune` settings, if any.
2537 The list of remotes which are fetched by "git remote update
2538 <group>". See linkgit:git-remote[1].
2540 repack.useDeltaBaseOffset::
2541 By default, linkgit:git-repack[1] creates packs that use
2542 delta-base offset. If you need to share your repository with
2543 Git older than version 1.4.4, either directly or via a dumb
2544 protocol such as http, then you need to set this option to
2545 "false" and repack. Access from old Git versions over the
2546 native protocol are unaffected by this option.
2548 repack.packKeptObjects::
2549 If set to true, makes `git repack` act as if
2550 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2551 details. Defaults to `false` normally, but `true` if a bitmap
2552 index is being written (either via `--write-bitmap-index` or
2553 `repack.writeBitmaps`).
2555 repack.writeBitmaps::
2556 When true, git will write a bitmap index when packing all
2557 objects to disk (e.g., when `git repack -a` is run). This
2558 index can speed up the "counting objects" phase of subsequent
2559 packs created for clones and fetches, at the cost of some disk
2560 space and extra time spent on the initial repack. Defaults to
2564 When set to true, `git-rerere` updates the index with the
2565 resulting contents after it cleanly resolves conflicts using
2566 previously recorded resolution. Defaults to false.
2569 Activate recording of resolved conflicts, so that identical
2570 conflict hunks can be resolved automatically, should they be
2571 encountered again. By default, linkgit:git-rerere[1] is
2572 enabled if there is an `rr-cache` directory under the
2573 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2576 sendemail.identity::
2577 A configuration identity. When given, causes values in the
2578 'sendemail.<identity>' subsection to take precedence over
2579 values in the 'sendemail' section. The default identity is
2580 the value of 'sendemail.identity'.
2582 sendemail.smtpEncryption::
2583 See linkgit:git-send-email[1] for description. Note that this
2584 setting is not subject to the 'identity' mechanism.
2586 sendemail.smtpssl (deprecated)::
2587 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2589 sendemail.smtpsslcertpath::
2590 Path to ca-certificates (either a directory or a single file).
2591 Set it to an empty string to disable certificate verification.
2593 sendemail.<identity>.*::
2594 Identity-specific versions of the 'sendemail.*' parameters
2595 found below, taking precedence over those when the this
2596 identity is selected, through command-line or
2597 'sendemail.identity'.
2599 sendemail.aliasesFile::
2600 sendemail.aliasFileType::
2601 sendemail.annotate::
2605 sendemail.chainReplyTo::
2607 sendemail.envelopeSender::
2609 sendemail.multiEdit::
2610 sendemail.signedoffbycc::
2611 sendemail.smtpPass::
2612 sendemail.suppresscc::
2613 sendemail.suppressFrom::
2615 sendemail.smtpDomain::
2616 sendemail.smtpServer::
2617 sendemail.smtpServerPort::
2618 sendemail.smtpServerOption::
2619 sendemail.smtpUser::
2621 sendemail.transferEncoding::
2622 sendemail.validate::
2624 See linkgit:git-send-email[1] for description.
2626 sendemail.signedoffcc (deprecated)::
2627 Deprecated alias for 'sendemail.signedoffbycc'.
2629 showbranch.default::
2630 The default set of branches for linkgit:git-show-branch[1].
2631 See linkgit:git-show-branch[1].
2633 status.relativePaths::
2634 By default, linkgit:git-status[1] shows paths relative to the
2635 current directory. Setting this variable to `false` shows paths
2636 relative to the repository root (this was the default for Git
2640 Set to true to enable --short by default in linkgit:git-status[1].
2641 The option --no-short takes precedence over this variable.
2644 Set to true to enable --branch by default in linkgit:git-status[1].
2645 The option --no-branch takes precedence over this variable.
2647 status.displayCommentPrefix::
2648 If set to true, linkgit:git-status[1] will insert a comment
2649 prefix before each output line (starting with
2650 `core.commentChar`, i.e. `#` by default). This was the
2651 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2654 status.showUntrackedFiles::
2655 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2656 files which are not currently tracked by Git. Directories which
2657 contain only untracked files, are shown with the directory name
2658 only. Showing untracked files means that Git needs to lstat() all
2659 the files in the whole repository, which might be slow on some
2660 systems. So, this variable controls how the commands displays
2661 the untracked files. Possible values are:
2664 * `no` - Show no untracked files.
2665 * `normal` - Show untracked files and directories.
2666 * `all` - Show also individual files in untracked directories.
2669 If this variable is not specified, it defaults to 'normal'.
2670 This variable can be overridden with the -u|--untracked-files option
2671 of linkgit:git-status[1] and linkgit:git-commit[1].
2673 status.submoduleSummary::
2675 If this is set to a non zero number or true (identical to -1 or an
2676 unlimited number), the submodule summary will be enabled and a
2677 summary of commits for modified submodules will be shown (see
2678 --summary-limit option of linkgit:git-submodule[1]). Please note
2679 that the summary output command will be suppressed for all
2680 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2681 for those submodules where `submodule.<name>.ignore=all`. The only
2682 exception to that rule is that status and commit will show staged
2683 submodule changes. To
2684 also view the summary for ignored submodules you can either use
2685 the --ignore-submodules=dirty command-line option or the 'git
2686 submodule summary' command, which shows a similar output but does
2687 not honor these settings.
2690 If this is set to true, the `git stash show` command without an
2691 option will show the stash in patch form. Defaults to false.
2692 See description of 'show' command in linkgit:git-stash[1].
2695 If this is set to true, the `git stash show` command without an
2696 option will show diffstat of the stash. Defaults to true.
2697 See description of 'show' command in linkgit:git-stash[1].
2699 submodule.<name>.path::
2700 submodule.<name>.url::
2701 The path within this project and URL for a submodule. These
2702 variables are initially populated by 'git submodule init'. See
2703 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2706 submodule.<name>.update::
2707 The default update procedure for a submodule. This variable
2708 is populated by `git submodule init` from the
2709 linkgit:gitmodules[5] file. See description of 'update'
2710 command in linkgit:git-submodule[1].
2712 submodule.<name>.branch::
2713 The remote branch name for a submodule, used by `git submodule
2714 update --remote`. Set this option to override the value found in
2715 the `.gitmodules` file. See linkgit:git-submodule[1] and
2716 linkgit:gitmodules[5] for details.
2718 submodule.<name>.fetchRecurseSubmodules::
2719 This option can be used to control recursive fetching of this
2720 submodule. It can be overridden by using the --[no-]recurse-submodules
2721 command-line option to "git fetch" and "git pull".
2722 This setting will override that from in the linkgit:gitmodules[5]
2725 submodule.<name>.ignore::
2726 Defines under what circumstances "git status" and the diff family show
2727 a submodule as modified. When set to "all", it will never be considered
2728 modified (but it will nonetheless show up in the output of status and
2729 commit when it has been staged), "dirty" will ignore all changes
2730 to the submodules work tree and
2731 takes only differences between the HEAD of the submodule and the commit
2732 recorded in the superproject into account. "untracked" will additionally
2733 let submodules with modified tracked files in their work tree show up.
2734 Using "none" (the default when this option is not set) also shows
2735 submodules that have untracked files in their work tree as changed.
2736 This setting overrides any setting made in .gitmodules for this submodule,
2737 both settings can be overridden on the command line by using the
2738 "--ignore-submodules" option. The 'git submodule' commands are not
2739 affected by this setting.
2742 This variable controls the sort ordering of tags when displayed by
2743 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2744 value of this variable will be used as the default.
2747 This variable can be used to restrict the permission bits of
2748 tar archive entries. The default is 0002, which turns off the
2749 world write bit. The special value "user" indicates that the
2750 archiving user's umask will be used instead. See umask(2) and
2751 linkgit:git-archive[1].
2753 transfer.fsckObjects::
2754 When `fetch.fsckObjects` or `receive.fsckObjects` are
2755 not set, the value of this variable is used instead.
2759 String(s) `receive-pack` and `upload-pack` use to decide which
2760 refs to omit from their initial advertisements. Use more than
2761 one definition to specify multiple prefix strings. A ref that is
2762 under the hierarchies listed in the value of this variable is
2763 excluded, and is hidden when responding to `git push` or `git
2764 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2765 program-specific versions of this config.
2767 You may also include a `!` in front of the ref name to negate the entry,
2768 explicitly exposing it, even if an earlier entry marked it as hidden.
2769 If you have multiple hideRefs values, later entries override earlier ones
2770 (and entries in more-specific config files override less-specific ones).
2772 If a namespace is in use, the namespace prefix is stripped from each
2773 reference before it is matched against `transfer.hiderefs` patterns.
2774 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2775 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2776 is omitted from the advertisements but `refs/heads/master` and
2777 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2778 "have" lines. In order to match refs before stripping, add a `^` in front of
2779 the ref name. If you combine `!` and `^`, `!` must be specified first.
2781 transfer.unpackLimit::
2782 When `fetch.unpackLimit` or `receive.unpackLimit` are
2783 not set, the value of this variable is used instead.
2784 The default value is 100.
2786 uploadarchive.allowUnreachable::
2787 If true, allow clients to use `git archive --remote` to request
2788 any tree, whether reachable from the ref tips or not. See the
2789 discussion in the `SECURITY` section of
2790 linkgit:git-upload-archive[1] for more details. Defaults to
2793 uploadpack.hideRefs::
2794 This variable is the same as `transfer.hideRefs`, but applies
2795 only to `upload-pack` (and so affects only fetches, not pushes).
2796 An attempt to fetch a hidden ref by `git fetch` will fail. See
2797 also `uploadpack.allowTipSHA1InWant`.
2799 uploadpack.allowTipSHA1InWant::
2800 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2801 to accept a fetch request that asks for an object at the tip
2802 of a hidden ref (by default, such a request is rejected).
2803 see also `uploadpack.hideRefs`.
2805 uploadpack.allowReachableSHA1InWant::
2806 Allow `upload-pack` to accept a fetch request that asks for an
2807 object that is reachable from any ref tip. However, note that
2808 calculating object reachability is computationally expensive.
2809 Defaults to `false`.
2811 uploadpack.keepAlive::
2812 When `upload-pack` has started `pack-objects`, there may be a
2813 quiet period while `pack-objects` prepares the pack. Normally
2814 it would output progress information, but if `--quiet` was used
2815 for the fetch, `pack-objects` will output nothing at all until
2816 the pack data begins. Some clients and networks may consider
2817 the server to be hung and give up. Setting this option instructs
2818 `upload-pack` to send an empty keepalive packet every
2819 `uploadpack.keepAlive` seconds. Setting this option to 0
2820 disables keepalive packets entirely. The default is 5 seconds.
2822 url.<base>.insteadOf::
2823 Any URL that starts with this value will be rewritten to
2824 start, instead, with <base>. In cases where some site serves a
2825 large number of repositories, and serves them with multiple
2826 access methods, and some users need to use different access
2827 methods, this feature allows people to specify any of the
2828 equivalent URLs and have Git automatically rewrite the URL to
2829 the best alternative for the particular user, even for a
2830 never-before-seen repository on the site. When more than one
2831 insteadOf strings match a given URL, the longest match is used.
2833 url.<base>.pushInsteadOf::
2834 Any URL that starts with this value will not be pushed to;
2835 instead, it will be rewritten to start with <base>, and the
2836 resulting URL will be pushed to. In cases where some site serves
2837 a large number of repositories, and serves them with multiple
2838 access methods, some of which do not allow push, this feature
2839 allows people to specify a pull-only URL and have Git
2840 automatically use an appropriate URL to push, even for a
2841 never-before-seen repository on the site. When more than one
2842 pushInsteadOf strings match a given URL, the longest match is
2843 used. If a remote has an explicit pushurl, Git will ignore this
2844 setting for that remote.
2847 Your email address to be recorded in any newly created commits.
2848 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2849 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2852 Your full name to be recorded in any newly created commits.
2853 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2854 environment variables. See linkgit:git-commit-tree[1].
2856 user.useConfigOnly::
2857 Instruct Git to avoid trying to guess defaults for 'user.email'
2858 and 'user.name', and instead retrieve the values only from the
2859 configuration. For example, if you have multiple email addresses
2860 and would like to use a different one for each repository, then
2861 with this configuration option set to `true` in the global config
2862 along with a name, Git will prompt you to set up an email before
2863 making new commits in a newly cloned repository.
2864 Defaults to `false`.
2867 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2868 key you want it to automatically when creating a signed tag or
2869 commit, you can override the default selection with this variable.
2870 This option is passed unchanged to gpg's --local-user parameter,
2871 so you may specify a key using any method that gpg supports.
2873 versionsort.prereleaseSuffix::
2874 When version sort is used in linkgit:git-tag[1], prerelease
2875 tags (e.g. "1.0-rc1") may appear after the main release
2876 "1.0". By specifying the suffix "-rc" in this variable,
2877 "1.0-rc1" will appear before "1.0".
2879 This variable can be specified multiple times, once per suffix. The
2880 order of suffixes in the config file determines the sorting order
2881 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2882 is sorted before 1.0-rcXX). The sorting order between different
2883 suffixes is undefined if they are in multiple config files.
2886 Specify a web browser that may be used by some commands.
2887 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]