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>.updatemode::
889 When `git update` is run, this determines if it would either merge or
890 rebase the fetched branch. The possible values are 'merge',
891 'rebase', and 'rebase-preserve'.
892 If 'ff-only' is specified, the merge will only succeed if it's
895 When 'rebase-preserve', also pass '--preserve-merges' along to
896 'git rebase' so that locally committed merge commits will not be
897 flattened by running `git update`.
899 See "update.mode" for doing this in a non branch-specific manner.
901 branch.<name>.description::
902 Branch description, can be edited with
903 `git branch --edit-description`. Branch description is
904 automatically added in the format-patch cover letter or
905 request-pull summary.
908 Specify the command to invoke the specified browser. The
909 specified command is evaluated in shell with the URLs passed
910 as arguments. (See linkgit:git-web{litdd}browse[1].)
912 browser.<tool>.path::
913 Override the path for the given tool that may be used to
914 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
915 working repository in gitweb (see linkgit:git-instaweb[1]).
918 A boolean to make git-clean do nothing unless given -f,
919 -i or -n. Defaults to true.
922 A boolean to enable/disable color in the output of
923 linkgit:git-branch[1]. May be set to `always`,
924 `false` (or `never`) or `auto` (or `true`), in which case colors are used
925 only when the output is to a terminal. Defaults to false.
927 color.branch.<slot>::
928 Use customized color for branch coloration. `<slot>` is one of
929 `current` (the current branch), `local` (a local branch),
930 `remote` (a remote-tracking branch in refs/remotes/),
931 `upstream` (upstream tracking branch), `plain` (other
935 Whether to use ANSI escape sequences to add color to patches.
936 If this is set to `always`, linkgit:git-diff[1],
937 linkgit:git-log[1], and linkgit:git-show[1] will use color
938 for all patches. If it is set to `true` or `auto`, those
939 commands will only use color when output is to the terminal.
942 This does not affect linkgit:git-format-patch[1] or the
943 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
944 command line with the `--color[=<when>]` option.
947 Use customized color for diff colorization. `<slot>` specifies
948 which part of the patch to use the specified color, and is one
949 of `context` (context text - `plain` is a historical synonym),
950 `meta` (metainformation), `frag`
951 (hunk header), 'func' (function in hunk header), `old` (removed lines),
952 `new` (added lines), `commit` (commit headers), or `whitespace`
953 (highlighting whitespace errors).
955 color.decorate.<slot>::
956 Use customized color for 'git log --decorate' output. `<slot>` is one
957 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
958 branches, remote-tracking branches, tags, stash and HEAD, respectively.
961 When set to `always`, always highlight matches. When `false` (or
962 `never`), never. When set to `true` or `auto`, use color only
963 when the output is written to the terminal. Defaults to `false`.
966 Use customized color for grep colorization. `<slot>` specifies which
967 part of the line to use the specified color, and is one of
971 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
973 filename prefix (when not using `-h`)
975 function name lines (when using `-p`)
977 line number prefix (when using `-n`)
979 matching text (same as setting `matchContext` and `matchSelected`)
981 matching text in context lines
983 matching text in selected lines
985 non-matching text in selected lines
987 separators between fields on a line (`:`, `-`, and `=`)
988 and between hunks (`--`)
992 When set to `always`, always use colors for interactive prompts
993 and displays (such as those used by "git-add --interactive" and
994 "git-clean --interactive"). When false (or `never`), never.
995 When set to `true` or `auto`, use colors only when the output is
996 to the terminal. Defaults to false.
998 color.interactive.<slot>::
999 Use customized color for 'git add --interactive' and 'git clean
1000 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1001 or `error`, for four distinct types of normal output from
1002 interactive commands.
1005 A boolean to enable/disable colored output when the pager is in
1006 use (default is true).
1009 A boolean to enable/disable color in the output of
1010 linkgit:git-show-branch[1]. May be set to `always`,
1011 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1012 only when the output is to a terminal. Defaults to false.
1015 A boolean to enable/disable color in the output of
1016 linkgit:git-status[1]. May be set to `always`,
1017 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1018 only when the output is to a terminal. Defaults to false.
1020 color.status.<slot>::
1021 Use customized color for status colorization. `<slot>` is
1022 one of `header` (the header text of the status message),
1023 `added` or `updated` (files which are added but not committed),
1024 `changed` (files which are changed but not added in the index),
1025 `untracked` (files which are not tracked by Git),
1026 `branch` (the current branch),
1027 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1029 `unmerged` (files which have unmerged changes).
1032 This variable determines the default value for variables such
1033 as `color.diff` and `color.grep` that control the use of color
1034 per command family. Its scope will expand as more commands learn
1035 configuration to set a default for the `--color` option. Set it
1036 to `false` or `never` if you prefer Git commands not to use
1037 color unless enabled explicitly with some other configuration
1038 or the `--color` option. Set it to `always` if you want all
1039 output not intended for machine consumption to use color, to
1040 `true` or `auto` (this is the default since Git 1.8.4) if you
1041 want such output to use color when written to the terminal.
1044 Specify whether supported commands should output in columns.
1045 This variable consists of a list of tokens separated by spaces
1048 These options control when the feature should be enabled
1049 (defaults to 'never'):
1053 always show in columns
1055 never show in columns
1057 show in columns if the output is to the terminal
1060 These options control layout (defaults to 'column'). Setting any
1061 of these implies 'always' if none of 'always', 'never', or 'auto' are
1066 fill columns before rows
1068 fill rows before columns
1073 Finally, these options can be combined with a layout option (defaults
1078 make unequal size columns to utilize more space
1080 make equal size columns
1084 Specify whether to output branch listing in `git branch` in columns.
1085 See `column.ui` for details.
1088 Specify the layout when list items in `git clean -i`, which always
1089 shows files and directories in columns. See `column.ui` for details.
1092 Specify whether to output untracked files in `git status` in columns.
1093 See `column.ui` for details.
1096 Specify whether to output tag listing in `git tag` in columns.
1097 See `column.ui` for details.
1100 This setting overrides the default of the `--cleanup` option in
1101 `git commit`. See linkgit:git-commit[1] for details. Changing the
1102 default can be useful when you always want to keep lines that begin
1103 with comment character `#` in your log message, in which case you
1104 would do `git config commit.cleanup whitespace` (note that you will
1105 have to remove the help lines that begin with `#` in the commit log
1106 template yourself, if you do this).
1110 A boolean to specify whether all commits should be GPG signed.
1111 Use of this option when doing operations such as rebase can
1112 result in a large number of commits being signed. It may be
1113 convenient to use an agent to avoid typing your GPG passphrase
1117 A boolean to enable/disable inclusion of status information in the
1118 commit message template when using an editor to prepare the commit
1119 message. Defaults to true.
1122 Specify a file to use as the template for new commit messages.
1123 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1124 specified user's home directory.
1127 Specify an external helper to be called when a username or
1128 password credential is needed; the helper may consult external
1129 storage to avoid prompting the user for the credentials. See
1130 linkgit:gitcredentials[7] for details.
1132 credential.useHttpPath::
1133 When acquiring credentials, consider the "path" component of an http
1134 or https URL to be important. Defaults to false. See
1135 linkgit:gitcredentials[7] for more information.
1137 credential.username::
1138 If no username is set for a network authentication, use this username
1139 by default. See credential.<context>.* below, and
1140 linkgit:gitcredentials[7].
1142 credential.<url>.*::
1143 Any of the credential.* options above can be applied selectively to
1144 some credentials. For example "credential.https://example.com.username"
1145 would set the default username only for https connections to
1146 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1149 credentialCache.ignoreSIGHUP::
1150 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1152 include::diff-config.txt[]
1154 difftool.<tool>.path::
1155 Override the path for the given tool. This is useful in case
1156 your tool is not in the PATH.
1158 difftool.<tool>.cmd::
1159 Specify the command to invoke the specified diff tool.
1160 The specified command is evaluated in shell with the following
1161 variables available: 'LOCAL' is set to the name of the temporary
1162 file containing the contents of the diff pre-image and 'REMOTE'
1163 is set to the name of the temporary file containing the contents
1164 of the diff post-image.
1167 Prompt before each invocation of the diff tool.
1169 fetch.recurseSubmodules::
1170 This option can be either set to a boolean value or to 'on-demand'.
1171 Setting it to a boolean changes the behavior of fetch and pull to
1172 unconditionally recurse into submodules when set to true or to not
1173 recurse at all when set to false. When set to 'on-demand' (the default
1174 value), fetch and pull will only recurse into a populated submodule
1175 when its superproject retrieves a commit that updates the submodule's
1179 If it is set to true, git-fetch-pack will check all fetched
1180 objects. It will abort in the case of a malformed object or a
1181 broken link. The result of an abort are only dangling objects.
1182 Defaults to false. If not set, the value of `transfer.fsckObjects`
1186 If the number of objects fetched over the Git native
1187 transfer is below this
1188 limit, then the objects will be unpacked into loose object
1189 files. However if the number of received objects equals or
1190 exceeds this limit then the received pack will be stored as
1191 a pack, after adding any missing delta bases. Storing the
1192 pack from a push can make the push operation complete faster,
1193 especially on slow filesystems. If not set, the value of
1194 `transfer.unpackLimit` is used instead.
1197 If true, fetch will automatically behave as if the `--prune`
1198 option was given on the command line. See also `remote.<name>.prune`.
1201 Enable multipart/mixed attachments as the default for
1202 'format-patch'. The value can also be a double quoted string
1203 which will enable attachments as the default and set the
1204 value as the boundary. See the --attach option in
1205 linkgit:git-format-patch[1].
1208 A boolean which can enable or disable sequence numbers in patch
1209 subjects. It defaults to "auto" which enables it only if there
1210 is more than one patch. It can be enabled or disabled for all
1211 messages by setting it to "true" or "false". See --numbered
1212 option in linkgit:git-format-patch[1].
1215 Additional email headers to include in a patch to be submitted
1216 by mail. See linkgit:git-format-patch[1].
1220 Additional recipients to include in a patch to be submitted
1221 by mail. See the --to and --cc options in
1222 linkgit:git-format-patch[1].
1224 format.subjectPrefix::
1225 The default for format-patch is to output files with the '[PATCH]'
1226 subject prefix. Use this variable to change that prefix.
1229 The default for format-patch is to output a signature containing
1230 the Git version number. Use this variable to change that default.
1231 Set this variable to the empty string ("") to suppress
1232 signature generation.
1234 format.signatureFile::
1235 Works just like format.signature except the contents of the
1236 file specified by this variable will be used as the signature.
1239 The default for format-patch is to output files with the suffix
1240 `.patch`. Use this variable to change that suffix (make sure to
1241 include the dot if you want it).
1244 The default pretty format for log/show/whatchanged command,
1245 See linkgit:git-log[1], linkgit:git-show[1],
1246 linkgit:git-whatchanged[1].
1249 The default threading style for 'git format-patch'. Can be
1250 a boolean value, or `shallow` or `deep`. `shallow` threading
1251 makes every mail a reply to the head of the series,
1252 where the head is chosen from the cover letter, the
1253 `--in-reply-to`, and the first patch mail, in this order.
1254 `deep` threading makes every mail a reply to the previous one.
1255 A true boolean value is the same as `shallow`, and a false
1256 value disables threading.
1259 A boolean value which lets you enable the `-s/--signoff` option of
1260 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1261 patch should be a conscious act and means that you certify you have
1262 the rights to submit this work under the same open source license.
1263 Please see the 'SubmittingPatches' document for further discussion.
1265 format.coverLetter::
1266 A boolean that controls whether to generate a cover-letter when
1267 format-patch is invoked, but in addition can be set to "auto", to
1268 generate a cover-letter only when there's more than one patch.
1270 format.outputDirectory::
1271 Set a custom directory to store the resulting files instead of the
1272 current working directory.
1274 filter.<driver>.clean::
1275 The command which is used to convert the content of a worktree
1276 file to a blob upon checkin. See linkgit:gitattributes[5] for
1279 filter.<driver>.smudge::
1280 The command which is used to convert the content of a blob
1281 object to a worktree file upon checkout. See
1282 linkgit:gitattributes[5] for details.
1285 Allows overriding the message type (error, warn or ignore) of a
1286 specific message ID such as `missingEmail`.
1288 For convenience, fsck prefixes the error/warning with the message ID,
1289 e.g. "missingEmail: invalid author/committer line - missing email" means
1290 that setting `fsck.missingEmail = ignore` will hide that issue.
1292 This feature is intended to support working with legacy repositories
1293 which cannot be repaired without disruptive changes.
1296 The path to a sorted list of object names (i.e. one SHA-1 per
1297 line) that are known to be broken in a non-fatal way and should
1298 be ignored. This feature is useful when an established project
1299 should be accepted despite early commits containing errors that
1300 can be safely ignored such as invalid committer email addresses.
1301 Note: corrupt objects cannot be skipped with this setting.
1303 gc.aggressiveDepth::
1304 The depth parameter used in the delta compression
1305 algorithm used by 'git gc --aggressive'. This defaults
1308 gc.aggressiveWindow::
1309 The window size parameter used in the delta compression
1310 algorithm used by 'git gc --aggressive'. This defaults
1314 When there are approximately more than this many loose
1315 objects in the repository, `git gc --auto` will pack them.
1316 Some Porcelain commands use this command to perform a
1317 light-weight garbage collection from time to time. The
1318 default value is 6700. Setting this to 0 disables it.
1321 When there are more than this many packs that are not
1322 marked with `*.keep` file in the repository, `git gc
1323 --auto` consolidates them into one larger pack. The
1324 default value is 50. Setting this to 0 disables it.
1327 Make `git gc --auto` return immediately and run in background
1328 if the system supports it. Default is true.
1331 Running `git pack-refs` in a repository renders it
1332 unclonable by Git versions prior to 1.5.1.2 over dumb
1333 transports such as HTTP. This variable determines whether
1334 'git gc' runs `git pack-refs`. This can be set to `notbare`
1335 to enable it within all non-bare repos or it can be set to a
1336 boolean value. The default is `true`.
1339 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1340 Override the grace period with this config variable. The value
1341 "now" may be used to disable this grace period and always prune
1342 unreachable objects immediately, or "never" may be used to
1345 gc.worktreePruneExpire::
1346 When 'git gc' is run, it calls
1347 'git worktree prune --expire 3.months.ago'.
1348 This config variable can be used to set a different grace
1349 period. The value "now" may be used to disable the grace
1350 period and prune $GIT_DIR/worktrees immediately, or "never"
1351 may be used to suppress pruning.
1354 gc.<pattern>.reflogExpire::
1355 'git reflog expire' removes reflog entries older than
1356 this time; defaults to 90 days. The value "now" expires all
1357 entries immediately, and "never" suppresses expiration
1358 altogether. With "<pattern>" (e.g.
1359 "refs/stash") in the middle the setting applies only to
1360 the refs that match the <pattern>.
1362 gc.reflogExpireUnreachable::
1363 gc.<pattern>.reflogExpireUnreachable::
1364 'git reflog expire' removes reflog entries older than
1365 this time and are not reachable from the current tip;
1366 defaults to 30 days. The value "now" expires all entries
1367 immediately, and "never" suppresses expiration altogether.
1368 With "<pattern>" (e.g. "refs/stash")
1369 in the middle, the setting applies only to the refs that
1370 match the <pattern>.
1373 Records of conflicted merge you resolved earlier are
1374 kept for this many days when 'git rerere gc' is run.
1375 The default is 60 days. See linkgit:git-rerere[1].
1377 gc.rerereUnresolved::
1378 Records of conflicted merge you have not resolved are
1379 kept for this many days when 'git rerere gc' is run.
1380 The default is 15 days. See linkgit:git-rerere[1].
1382 gitcvs.commitMsgAnnotation::
1383 Append this string to each commit message. Set to empty string
1384 to disable this feature. Defaults to "via git-CVS emulator".
1387 Whether the CVS server interface is enabled for this repository.
1388 See linkgit:git-cvsserver[1].
1391 Path to a log file where the CVS server interface well... logs
1392 various stuff. See linkgit:git-cvsserver[1].
1394 gitcvs.usecrlfattr::
1395 If true, the server will look up the end-of-line conversion
1396 attributes for files to determine the '-k' modes to use. If
1397 the attributes force Git to treat a file as text,
1398 the '-k' mode will be left blank so CVS clients will
1399 treat it as text. If they suppress text conversion, the file
1400 will be set with '-kb' mode, which suppresses any newline munging
1401 the client might otherwise do. If the attributes do not allow
1402 the file type to be determined, then 'gitcvs.allBinary' is
1403 used. See linkgit:gitattributes[5].
1406 This is used if 'gitcvs.usecrlfattr' does not resolve
1407 the correct '-kb' mode to use. If true, all
1408 unresolved files are sent to the client in
1409 mode '-kb'. This causes the client to treat them
1410 as binary files, which suppresses any newline munging it
1411 otherwise might do. Alternatively, if it is set to "guess",
1412 then the contents of the file are examined to decide if
1413 it is binary, similar to 'core.autocrlf'.
1416 Database used by git-cvsserver to cache revision information
1417 derived from the Git repository. The exact meaning depends on the
1418 used database driver, for SQLite (which is the default driver) this
1419 is a filename. Supports variable substitution (see
1420 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1421 Default: '%Ggitcvs.%m.sqlite'
1424 Used Perl DBI driver. You can specify any available driver
1425 for this here, but it might not work. git-cvsserver is tested
1426 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1427 reported *not* to work with 'DBD::mysql'. Experimental feature.
1428 May not contain double colons (`:`). Default: 'SQLite'.
1429 See linkgit:git-cvsserver[1].
1431 gitcvs.dbUser, gitcvs.dbPass::
1432 Database user and password. Only useful if setting 'gitcvs.dbDriver',
1433 since SQLite has no concept of database users and/or passwords.
1434 'gitcvs.dbUser' supports variable substitution (see
1435 linkgit:git-cvsserver[1] for details).
1437 gitcvs.dbTableNamePrefix::
1438 Database table name prefix. Prepended to the names of any
1439 database tables used, allowing a single database to be used
1440 for several repositories. Supports variable substitution (see
1441 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1442 characters will be replaced with underscores.
1444 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1445 'gitcvs.allBinary' can also be specified as
1446 'gitcvs.<access_method>.<varname>' (where 'access_method'
1447 is one of "ext" and "pserver") to make them apply only for the given
1451 gitweb.description::
1454 See linkgit:gitweb[1] for description.
1462 gitweb.remote_heads::
1465 See linkgit:gitweb.conf[5] for description.
1468 If set to true, enable '-n' option by default.
1471 Set the default matching behavior. Using a value of 'basic', 'extended',
1472 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1473 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1474 value 'default' will return to the default matching behavior.
1476 grep.extendedRegexp::
1477 If set to true, enable '--extended-regexp' option by default. This
1478 option is ignored when the 'grep.patternType' option is set to a value
1479 other than 'default'.
1482 Number of grep worker threads to use.
1483 See `grep.threads` in linkgit:git-grep[1] for more information.
1485 grep.fallbackToNoIndex::
1486 If set to true, fall back to git grep --no-index if git grep
1487 is executed outside of a git repository. Defaults to false.
1490 Use this custom program instead of "gpg" found on $PATH when
1491 making or verifying a PGP signature. The program must support the
1492 same command-line interface as GPG, namely, to verify a detached
1493 signature, "gpg --verify $file - <$signature" is run, and the
1494 program is expected to signal a good signature by exiting with
1495 code 0, and to generate an ASCII-armored detached signature, the
1496 standard input of "gpg -bsau $key" is fed with the contents to be
1497 signed, and the program is expected to send the result to its
1500 gui.commitMsgWidth::
1501 Defines how wide the commit message window is in the
1502 linkgit:git-gui[1]. "75" is the default.
1505 Specifies how many context lines should be used in calls to diff
1506 made by the linkgit:git-gui[1]. The default is "5".
1508 gui.displayUntracked::
1509 Determines if linkgit::git-gui[1] shows untracked files
1510 in the file list. The default is "true".
1513 Specifies the default encoding to use for displaying of
1514 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1515 It can be overridden by setting the 'encoding' attribute
1516 for relevant files (see linkgit:gitattributes[5]).
1517 If this option is not set, the tools default to the
1520 gui.matchTrackingBranch::
1521 Determines if new branches created with linkgit:git-gui[1] should
1522 default to tracking remote branches with matching names or
1523 not. Default: "false".
1525 gui.newBranchTemplate::
1526 Is used as suggested name when creating new branches using the
1529 gui.pruneDuringFetch::
1530 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1531 performing a fetch. The default value is "false".
1534 Determines if linkgit:git-gui[1] should trust the file modification
1535 timestamp or not. By default the timestamps are not trusted.
1537 gui.spellingDictionary::
1538 Specifies the dictionary used for spell checking commit messages in
1539 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1543 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1544 location detection. It makes blame significantly faster on huge
1545 repositories at the expense of less thorough copy detection.
1547 gui.copyBlameThreshold::
1548 Specifies the threshold to use in 'git gui blame' original location
1549 detection, measured in alphanumeric characters. See the
1550 linkgit:git-blame[1] manual for more information on copy detection.
1552 gui.blamehistoryctx::
1553 Specifies the radius of history context in days to show in
1554 linkgit:gitk[1] for the selected commit, when the `Show History
1555 Context` menu item is invoked from 'git gui blame'. If this
1556 variable is set to zero, the whole history is shown.
1558 guitool.<name>.cmd::
1559 Specifies the shell command line to execute when the corresponding item
1560 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1561 mandatory for every tool. The command is executed from the root of
1562 the working directory, and in the environment it receives the name of
1563 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1564 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1565 the head is detached, 'CUR_BRANCH' is empty).
1567 guitool.<name>.needsFile::
1568 Run the tool only if a diff is selected in the GUI. It guarantees
1569 that 'FILENAME' is not empty.
1571 guitool.<name>.noConsole::
1572 Run the command silently, without creating a window to display its
1575 guitool.<name>.noRescan::
1576 Don't rescan the working directory for changes after the tool
1579 guitool.<name>.confirm::
1580 Show a confirmation dialog before actually running the tool.
1582 guitool.<name>.argPrompt::
1583 Request a string argument from the user, and pass it to the tool
1584 through the 'ARGS' environment variable. Since requesting an
1585 argument implies confirmation, the 'confirm' option has no effect
1586 if this is enabled. If the option is set to 'true', 'yes', or '1',
1587 the dialog uses a built-in generic prompt; otherwise the exact
1588 value of the variable is used.
1590 guitool.<name>.revPrompt::
1591 Request a single valid revision from the user, and set the
1592 'REVISION' environment variable. In other aspects this option
1593 is similar to 'argPrompt', and can be used together with it.
1595 guitool.<name>.revUnmerged::
1596 Show only unmerged branches in the 'revPrompt' subdialog.
1597 This is useful for tools similar to merge or rebase, but not
1598 for things like checkout or reset.
1600 guitool.<name>.title::
1601 Specifies the title to use for the prompt dialog. The default
1604 guitool.<name>.prompt::
1605 Specifies the general prompt string to display at the top of
1606 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1607 The default value includes the actual command.
1610 Specify the browser that will be used to display help in the
1611 'web' format. See linkgit:git-help[1].
1614 Override the default help format used by linkgit:git-help[1].
1615 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1616 the default. 'web' and 'html' are the same.
1619 Automatically correct and execute mistyped commands after
1620 waiting for the given number of deciseconds (0.1 sec). If more
1621 than one command can be deduced from the entered text, nothing
1622 will be executed. If the value of this option is negative,
1623 the corrected command will be executed immediately. If the
1624 value is 0 - the command will be just shown but not executed.
1625 This is the default.
1628 Specify the path where the HTML documentation resides. File system paths
1629 and URLs are supported. HTML pages will be prefixed with this path when
1630 help is displayed in the 'web' format. This defaults to the documentation
1631 path of your Git installation.
1634 Override the HTTP proxy, normally configured using the 'http_proxy',
1635 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1636 addition to the syntax understood by curl, it is possible to specify a
1637 proxy string with a user name but no password, in which case git will
1638 attempt to acquire one in the same way it does for other credentials. See
1639 linkgit:gitcredentials[7] for more information. The syntax thus is
1640 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1641 on a per-remote basis; see remote.<name>.proxy
1643 http.proxyAuthMethod::
1644 Set the method with which to authenticate against the HTTP proxy. This
1645 only takes effect if the configured proxy string contains a user name part
1646 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1647 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1648 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1649 variable. Possible values are:
1652 * `anyauth` - Automatically pick a suitable authentication method. It is
1653 assumed that the proxy answers an unauthenticated request with a 407
1654 status code and one or more Proxy-authenticate headers with supported
1655 authentication methods. This is the default.
1656 * `basic` - HTTP Basic authentication
1657 * `digest` - HTTP Digest authentication; this prevents the password from being
1658 transmitted to the proxy in clear text
1659 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1661 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1665 Attempt authentication without seeking a username or password. This
1666 can be used to attempt GSS-Negotiate authentication without specifying
1667 a username in the URL, as libcurl normally requires a username for
1671 File containing previously stored cookie lines which should be used
1672 in the Git http session, if they match the server. The file format
1673 of the file to read cookies from should be plain HTTP headers or
1674 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1675 NOTE that the file specified with http.cookieFile is only used as
1676 input unless http.saveCookies is set.
1679 If set, store cookies received during requests to the file specified by
1680 http.cookieFile. Has no effect if http.cookieFile is unset.
1683 The SSL version to use when negotiating an SSL connection, if you
1684 want to force the default. The available and default version
1685 depend on whether libcurl was built against NSS or OpenSSL and the
1686 particular configuration of the crypto library in use. Internally
1687 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1688 documentation for more details on the format of this option and
1689 for the ssl version supported. Actually the possible values of
1700 Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1701 To force git to use libcurl's default ssl version and ignore any
1702 explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1705 http.sslCipherList::
1706 A list of SSL ciphers to use when negotiating an SSL connection.
1707 The available ciphers depend on whether libcurl was built against
1708 NSS or OpenSSL and the particular configuration of the crypto
1709 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1710 option; see the libcurl documentation for more details on the format
1713 Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1714 To force git to use libcurl's default cipher list and ignore any
1715 explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1719 Whether to verify the SSL certificate when fetching or pushing
1720 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1724 File containing the SSL certificate when fetching or pushing
1725 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1729 File containing the SSL private key when fetching or pushing
1730 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1733 http.sslCertPasswordProtected::
1734 Enable Git's password prompt for the SSL certificate. Otherwise
1735 OpenSSL will prompt the user, possibly many times, if the
1736 certificate or private key is encrypted. Can be overridden by the
1737 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1740 File containing the certificates to verify the peer with when
1741 fetching or pushing over HTTPS. Can be overridden by the
1742 'GIT_SSL_CAINFO' environment variable.
1745 Path containing files with the CA certificates to verify the peer
1746 with when fetching or pushing over HTTPS. Can be overridden
1747 by the 'GIT_SSL_CAPATH' environment variable.
1750 Public key of the https service. It may either be the filename of
1751 a PEM or DER encoded public key file or a string starting with
1752 'sha256//' followed by the base64 encoded sha256 hash of the
1753 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1754 exit with an error if this option is set but not supported by
1758 Attempt to use AUTH SSL/TLS and encrypted data transfers
1759 when connecting via regular FTP protocol. This might be needed
1760 if the FTP server requires it for security reasons or you wish
1761 to connect securely whenever remote FTP server supports it.
1762 Default is false since it might trigger certificate verification
1763 errors on misconfigured servers.
1766 How many HTTP requests to launch in parallel. Can be overridden
1767 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1770 The number of curl sessions (counted across slots) to be kept across
1771 requests. They will not be ended with curl_easy_cleanup() until
1772 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1773 value will be capped at 1. Defaults to 1.
1776 Maximum size in bytes of the buffer used by smart HTTP
1777 transports when POSTing data to the remote system.
1778 For requests larger than this buffer size, HTTP/1.1 and
1779 Transfer-Encoding: chunked is used to avoid creating a
1780 massive pack file locally. Default is 1 MiB, which is
1781 sufficient for most requests.
1783 http.lowSpeedLimit, http.lowSpeedTime::
1784 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1785 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1786 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1787 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1790 A boolean which disables using of EPSV ftp command by curl.
1791 This can helpful with some "poor" ftp servers which don't
1792 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1793 environment variable. Default is false (curl will use EPSV).
1796 The HTTP USER_AGENT string presented to an HTTP server. The default
1797 value represents the version of the client Git such as git/1.7.1.
1798 This option allows you to override this value to a more common value
1799 such as Mozilla/4.0. This may be necessary, for instance, if
1800 connecting through a firewall that restricts HTTP connections to a set
1801 of common USER_AGENT strings (but not including those like git/1.7.1).
1802 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1805 Any of the http.* options above can be applied selectively to some URLs.
1806 For a config key to match a URL, each element of the config key is
1807 compared to that of the URL, in the following order:
1810 . Scheme (e.g., `https` in `https://example.com/`). This field
1811 must match exactly between the config key and the URL.
1813 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1814 This field must match exactly between the config key and the URL.
1816 . Port number (e.g., `8080` in `http://example.com:8080/`).
1817 This field must match exactly between the config key and the URL.
1818 Omitted port numbers are automatically converted to the correct
1819 default for the scheme before matching.
1821 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1822 path field of the config key must match the path field of the URL
1823 either exactly or as a prefix of slash-delimited path elements. This means
1824 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1825 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1826 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1827 key with just path `foo/`).
1829 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1830 the config key has a user name it must match the user name in the
1831 URL exactly. If the config key does not have a user name, that
1832 config key will match a URL with any user name (including none),
1833 but at a lower precedence than a config key with a user name.
1836 The list above is ordered by decreasing precedence; a URL that matches
1837 a config key's path is preferred to one that matches its user name. For example,
1838 if the URL is `https://user@example.com/foo/bar` a config key match of
1839 `https://example.com/foo` will be preferred over a config key match of
1840 `https://user@example.com`.
1842 All URLs are normalized before attempting any matching (the password part,
1843 if embedded in the URL, is always ignored for matching purposes) so that
1844 equivalent URLs that are simply spelled differently will match properly.
1845 Environment variable settings always override any matches. The URLs that are
1846 matched against are those given directly to Git commands. This means any URLs
1847 visited as a result of a redirection do not participate in matching.
1849 i18n.commitEncoding::
1850 Character encoding the commit messages are stored in; Git itself
1851 does not care per se, but this information is necessary e.g. when
1852 importing commits from emails or in the gitk graphical history
1853 browser (and possibly at other places in the future or in other
1854 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1856 i18n.logOutputEncoding::
1857 Character encoding the commit messages are converted to when
1858 running 'git log' and friends.
1861 The configuration variables in the 'imap' section are described
1862 in linkgit:git-imap-send[1].
1865 Specify the version with which new index files should be
1866 initialized. This does not affect existing repositories.
1869 Specify the directory from which templates will be copied.
1870 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1873 Specify the program that will be used to browse your working
1874 repository in gitweb. See linkgit:git-instaweb[1].
1877 The HTTP daemon command-line to start gitweb on your working
1878 repository. See linkgit:git-instaweb[1].
1881 If true the web server started by linkgit:git-instaweb[1] will
1882 be bound to the local IP (127.0.0.1).
1884 instaweb.modulePath::
1885 The default module path for linkgit:git-instaweb[1] to use
1886 instead of /usr/lib/apache2/modules. Only used if httpd
1890 The port number to bind the gitweb httpd to. See
1891 linkgit:git-instaweb[1].
1893 interactive.singleKey::
1894 In interactive commands, allow the user to provide one-letter
1895 input with a single key (i.e., without hitting enter).
1896 Currently this is used by the `--patch` mode of
1897 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1898 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1899 setting is silently ignored if portable keystroke input
1900 is not available; requires the Perl module Term::ReadKey.
1903 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1904 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1905 override this option with `--no-abbrev-commit`.
1908 Set the default date-time mode for the 'log' command.
1909 Setting a value for log.date is similar to using 'git log''s
1910 `--date` option. See linkgit:git-log[1] for details.
1913 Print out the ref names of any commits that are shown by the log
1914 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1915 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1916 specified, the full ref name (including prefix) will be printed.
1917 This is the same as the log commands '--decorate' option.
1920 If `true`, `git log` will act as if the `--follow` option was used when
1921 a single <path> is given. This has the same limitations as `--follow`,
1922 i.e. it cannot be used to follow multiple files and does not work well
1923 on non-linear history.
1926 If true, the initial commit will be shown as a big creation event.
1927 This is equivalent to a diff against an empty tree.
1928 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1929 normally hide the root commit will now show it. True by default.
1932 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1933 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1936 If true, makes linkgit:git-mailinfo[1] (and therefore
1937 linkgit:git-am[1]) act by default as if the --scissors option
1938 was provided on the command-line. When active, this features
1939 removes everything from the message body before a scissors
1940 line (i.e. consisting mainly of ">8", "8<" and "-").
1943 The location of an augmenting mailmap file. The default
1944 mailmap, located in the root of the repository, is loaded
1945 first, then the mailmap file pointed to by this variable.
1946 The location of the mailmap file may be in a repository
1947 subdirectory, or somewhere outside of the repository itself.
1948 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1951 Like `mailmap.file`, but consider the value as a reference to a
1952 blob in the repository. If both `mailmap.file` and
1953 `mailmap.blob` are given, both are parsed, with entries from
1954 `mailmap.file` taking precedence. In a bare repository, this
1955 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1959 Specify the programs that may be used to display help in the
1960 'man' format. See linkgit:git-help[1].
1963 Specify the command to invoke the specified man viewer. The
1964 specified command is evaluated in shell with the man page
1965 passed as argument. (See linkgit:git-help[1].)
1968 Override the path for the given tool that may be used to
1969 display help in the 'man' format. See linkgit:git-help[1].
1971 include::merge-config.txt[]
1973 mergetool.<tool>.path::
1974 Override the path for the given tool. This is useful in case
1975 your tool is not in the PATH.
1977 mergetool.<tool>.cmd::
1978 Specify the command to invoke the specified merge tool. The
1979 specified command is evaluated in shell with the following
1980 variables available: 'BASE' is the name of a temporary file
1981 containing the common base of the files to be merged, if available;
1982 'LOCAL' is the name of a temporary file containing the contents of
1983 the file on the current branch; 'REMOTE' is the name of a temporary
1984 file containing the contents of the file from the branch being
1985 merged; 'MERGED' contains the name of the file to which the merge
1986 tool should write the results of a successful merge.
1988 mergetool.<tool>.trustExitCode::
1989 For a custom merge command, specify whether the exit code of
1990 the merge command can be used to determine whether the merge was
1991 successful. If this is not set to true then the merge target file
1992 timestamp is checked and the merge assumed to have been successful
1993 if the file has been updated, otherwise the user is prompted to
1994 indicate the success of the merge.
1996 mergetool.meld.hasOutput::
1997 Older versions of `meld` do not support the `--output` option.
1998 Git will attempt to detect whether `meld` supports `--output`
1999 by inspecting the output of `meld --help`. Configuring
2000 `mergetool.meld.hasOutput` will make Git skip these checks and
2001 use the configured value instead. Setting `mergetool.meld.hasOutput`
2002 to `true` tells Git to unconditionally use the `--output` option,
2003 and `false` avoids using `--output`.
2005 mergetool.keepBackup::
2006 After performing a merge, the original file with conflict markers
2007 can be saved as a file with a `.orig` extension. If this variable
2008 is set to `false` then this file is not preserved. Defaults to
2009 `true` (i.e. keep the backup files).
2011 mergetool.keepTemporaries::
2012 When invoking a custom merge tool, Git uses a set of temporary
2013 files to pass to the tool. If the tool returns an error and this
2014 variable is set to `true`, then these temporary files will be
2015 preserved, otherwise they will be removed after the tool has
2016 exited. Defaults to `false`.
2018 mergetool.writeToTemp::
2019 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2020 conflicting files in the worktree by default. Git will attempt
2021 to use a temporary directory for these files when set `true`.
2022 Defaults to `false`.
2025 Prompt before each invocation of the merge resolution program.
2027 notes.mergeStrategy::
2028 Which merge strategy to choose by default when resolving notes
2029 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2030 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2031 section of linkgit:git-notes[1] for more information on each strategy.
2033 notes.<name>.mergeStrategy::
2034 Which merge strategy to choose when doing a notes merge into
2035 refs/notes/<name>. This overrides the more general
2036 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2037 linkgit:git-notes[1] for more information on the available strategies.
2040 The (fully qualified) refname from which to show notes when
2041 showing commit messages. The value of this variable can be set
2042 to a glob, in which case notes from all matching refs will be
2043 shown. You may also specify this configuration variable
2044 several times. A warning will be issued for refs that do not
2045 exist, but a glob that does not match any refs is silently
2048 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2049 environment variable, which must be a colon separated list of refs or
2052 The effective value of "core.notesRef" (possibly overridden by
2053 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2056 notes.rewrite.<command>::
2057 When rewriting commits with <command> (currently `amend` or
2058 `rebase`) and this variable is set to `true`, Git
2059 automatically copies your notes from the original to the
2060 rewritten commit. Defaults to `true`, but see
2061 "notes.rewriteRef" below.
2064 When copying notes during a rewrite (see the
2065 "notes.rewrite.<command>" option), determines what to do if
2066 the target commit already has a note. Must be one of
2067 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2068 Defaults to `concatenate`.
2070 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2071 environment variable.
2074 When copying notes during a rewrite, specifies the (fully
2075 qualified) ref whose notes should be copied. The ref may be a
2076 glob, in which case notes in all matching refs will be copied.
2077 You may also specify this configuration several times.
2079 Does not have a default value; you must configure this variable to
2080 enable note rewriting. Set it to `refs/notes/commits` to enable
2081 rewriting for the default commit notes.
2083 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2084 environment variable, which must be a colon separated list of refs or
2088 The size of the window used by linkgit:git-pack-objects[1] when no
2089 window size is given on the command line. Defaults to 10.
2092 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2093 maximum depth is given on the command line. Defaults to 50.
2096 The maximum size of memory that is consumed by each thread
2097 in linkgit:git-pack-objects[1] for pack window memory when
2098 no limit is given on the command line. The value can be
2099 suffixed with "k", "m", or "g". When left unconfigured (or
2100 set explicitly to 0), there will be no limit.
2103 An integer -1..9, indicating the compression level for objects
2104 in a pack file. -1 is the zlib default. 0 means no
2105 compression, and 1..9 are various speed/size tradeoffs, 9 being
2106 slowest. If not set, defaults to core.compression. If that is
2107 not set, defaults to -1, the zlib default, which is "a default
2108 compromise between speed and compression (currently equivalent
2111 Note that changing the compression level will not automatically recompress
2112 all existing objects. You can force recompression by passing the -F option
2113 to linkgit:git-repack[1].
2115 pack.deltaCacheSize::
2116 The maximum memory in bytes used for caching deltas in
2117 linkgit:git-pack-objects[1] before writing them out to a pack.
2118 This cache is used to speed up the writing object phase by not
2119 having to recompute the final delta result once the best match
2120 for all objects is found. Repacking large repositories on machines
2121 which are tight with memory might be badly impacted by this though,
2122 especially if this cache pushes the system into swapping.
2123 A value of 0 means no limit. The smallest size of 1 byte may be
2124 used to virtually disable this cache. Defaults to 256 MiB.
2126 pack.deltaCacheLimit::
2127 The maximum size of a delta, that is cached in
2128 linkgit:git-pack-objects[1]. This cache is used to speed up the
2129 writing object phase by not having to recompute the final delta
2130 result once the best match for all objects is found. Defaults to 1000.
2133 Specifies the number of threads to spawn when searching for best
2134 delta matches. This requires that linkgit:git-pack-objects[1]
2135 be compiled with pthreads otherwise this option is ignored with a
2136 warning. This is meant to reduce packing time on multiprocessor
2137 machines. The required amount of memory for the delta search window
2138 is however multiplied by the number of threads.
2139 Specifying 0 will cause Git to auto-detect the number of CPU's
2140 and set the number of threads accordingly.
2143 Specify the default pack index version. Valid values are 1 for
2144 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2145 the new pack index with capabilities for packs larger than 4 GB
2146 as well as proper protection against the repacking of corrupted
2147 packs. Version 2 is the default. Note that version 2 is enforced
2148 and this config option ignored whenever the corresponding pack is
2151 If you have an old Git that does not understand the version 2 `*.idx` file,
2152 cloning or fetching over a non native protocol (e.g. "http")
2153 that will copy both `*.pack` file and corresponding `*.idx` file from the
2154 other side may give you a repository that cannot be accessed with your
2155 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2156 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2159 pack.packSizeLimit::
2160 The maximum size of a pack. This setting only affects
2161 packing to a file when repacking, i.e. the git:// protocol
2162 is unaffected. It can be overridden by the `--max-pack-size`
2163 option of linkgit:git-repack[1]. The minimum size allowed is
2164 limited to 1 MiB. The default is unlimited.
2165 Common unit suffixes of 'k', 'm', or 'g' are
2169 When true, git will use pack bitmaps (if available) when packing
2170 to stdout (e.g., during the server side of a fetch). Defaults to
2171 true. You should not generally need to turn this off unless
2172 you are debugging pack bitmaps.
2174 pack.writeBitmaps (deprecated)::
2175 This is a deprecated synonym for `repack.writeBitmaps`.
2177 pack.writeBitmapHashCache::
2178 When true, git will include a "hash cache" section in the bitmap
2179 index (if one is written). This cache can be used to feed git's
2180 delta heuristics, potentially leading to better deltas between
2181 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2182 between an older, bitmapped pack and objects that have been
2183 pushed since the last gc). The downside is that it consumes 4
2184 bytes per object of disk space, and that JGit's bitmap
2185 implementation does not understand it, causing it to complain if
2186 Git and JGit are used on the same repository. Defaults to false.
2189 If the value is boolean, turns on or off pagination of the
2190 output of a particular Git subcommand when writing to a tty.
2191 Otherwise, turns on pagination for the subcommand using the
2192 pager specified by the value of `pager.<cmd>`. If `--paginate`
2193 or `--no-pager` is specified on the command line, it takes
2194 precedence over this option. To disable pagination for all
2195 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2198 Alias for a --pretty= format string, as specified in
2199 linkgit:git-log[1]. Any aliases defined here can be used just
2200 as the built-in pretty formats could. For example,
2201 running `git config pretty.changelog "format:* %H %s"`
2202 would cause the invocation `git log --pretty=changelog`
2203 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2204 Note that an alias with the same name as a built-in format
2205 will be silently ignored.
2208 By default, Git does not create an extra merge commit when merging
2209 a commit that is a descendant of the current commit. Instead, the
2210 tip of the current branch is fast-forwarded. When set to `false`,
2211 this variable tells Git to create an extra merge commit in such
2212 a case (equivalent to giving the `--no-ff` option from the command
2213 line). When set to `only`, only such fast-forward merges are
2214 allowed (equivalent to giving the `--ff-only` option from the
2215 command line). This setting overrides `merge.ff` when pulling.
2218 When true, rebase branches on top of the fetched branch, instead
2219 of merging the default branch from the default remote when "git
2220 pull" is run. See "branch.<name>.rebase" for setting this on a
2223 When preserve, also pass `--preserve-merges` along to 'git rebase'
2224 so that locally committed merge commits will not be flattened
2225 by running 'git pull'.
2227 When the value is `interactive`, the rebase is run in interactive mode.
2229 *NOTE*: this is a possibly dangerous operation; do *not* use
2230 it unless you understand the implications (see linkgit:git-rebase[1]
2234 When `git update` is run, this determines if it would either merge or
2235 rebase the fetched branch. The possible values are 'merge',
2236 'rebase', 'ff-only', and 'rebase-preserve'.
2237 If 'ff-only' is specified, the merge will only succeed if it's
2240 When 'rebase-preserve', also pass '--preserve-merges' along to
2241 'git rebase' so that locally committed merge commits will not be
2242 flattened by running `git update`.
2244 See "branch.<name>.updatemode" for doing this in a branch-specific
2248 The default merge strategy to use when pulling multiple branches
2252 The default merge strategy to use when pulling a single branch.
2255 Defines the action `git push` should take if no refspec is
2256 explicitly given. Different values are well-suited for
2257 specific workflows; for instance, in a purely central workflow
2258 (i.e. the fetch source is equal to the push destination),
2259 `upstream` is probably what you want. Possible values are:
2263 * `nothing` - do not push anything (error out) unless a refspec is
2264 explicitly given. This is primarily meant for people who want to
2265 avoid mistakes by always being explicit.
2267 * `current` - push the current branch to update a branch with the same
2268 name on the receiving end. Works in both central and non-central
2271 * `upstream` - push the current branch back to the branch whose
2272 changes are usually integrated into the current branch (which is
2273 called `@{upstream}`). This mode only makes sense if you are
2274 pushing to the same repository you would normally pull from
2275 (i.e. central workflow).
2277 * `simple` - in centralized workflow, work like `upstream` with an
2278 added safety to refuse to push if the upstream branch's name is
2279 different from the local one.
2281 When pushing to a remote that is different from the remote you normally
2282 pull from, work as `current`. This is the safest option and is suited
2285 This mode has become the default in Git 2.0.
2287 * `matching` - push all branches having the same name on both ends.
2288 This makes the repository you are pushing to remember the set of
2289 branches that will be pushed out (e.g. if you always push 'maint'
2290 and 'master' there and no other branches, the repository you push
2291 to will have these two branches, and your local 'maint' and
2292 'master' will be pushed there).
2294 To use this mode effectively, you have to make sure _all_ the
2295 branches you would push out are ready to be pushed out before
2296 running 'git push', as the whole point of this mode is to allow you
2297 to push all of the branches in one go. If you usually finish work
2298 on only one branch and push out the result, while other branches are
2299 unfinished, this mode is not for you. Also this mode is not
2300 suitable for pushing into a shared central repository, as other
2301 people may add new branches there, or update the tip of existing
2302 branches outside your control.
2304 This used to be the default, but not since Git 2.0 (`simple` is the
2310 If set to true enable '--follow-tags' option by default. You
2311 may override this configuration at time of push by specifying
2315 May be set to a boolean value, or the string 'if-asked'. A true
2316 value causes all pushes to be GPG signed, as if '--signed' is
2317 passed to linkgit:git-push[1]. The string 'if-asked' causes
2318 pushes to be signed if the server supports it, as if
2319 '--signed=if-asked' is passed to 'git push'. A false value may
2320 override a value from a lower-priority config file. An explicit
2321 command-line flag always overrides this config option.
2323 push.recurseSubmodules::
2324 Make sure all submodule commits used by the revisions to be pushed
2325 are available on a remote-tracking branch. If the value is 'check'
2326 then Git will verify that all submodule commits that changed in the
2327 revisions to be pushed are available on at least one remote of the
2328 submodule. If any commits are missing, the push will be aborted and
2329 exit with non-zero status. If the value is 'on-demand' then all
2330 submodules that changed in the revisions to be pushed will be
2331 pushed. If on-demand was not able to push all necessary revisions
2332 it will also be aborted and exit with non-zero status. If the value
2333 is 'no' then default behavior of ignoring submodules when pushing
2334 is retained. You may override this configuration at time of push by
2335 specifying '--recurse-submodules=check|on-demand|no'.
2338 Whether to show a diffstat of what changed upstream since the last
2339 rebase. False by default.
2342 If set to true enable '--autosquash' option by default.
2345 When set to true, automatically create a temporary stash
2346 before the operation begins, and apply it after the operation
2347 ends. This means that you can run rebase on a dirty worktree.
2348 However, use with care: the final stash application after a
2349 successful rebase might result in non-trivial conflicts.
2352 rebase.missingCommitsCheck::
2353 If set to "warn", git rebase -i will print a warning if some
2354 commits are removed (e.g. a line was deleted), however the
2355 rebase will still proceed. If set to "error", it will print
2356 the previous warning and stop the rebase, 'git rebase
2357 --edit-todo' can then be used to correct the error. If set to
2358 "ignore", no checking is done.
2359 To drop a commit without warning or error, use the `drop`
2360 command in the todo-list.
2361 Defaults to "ignore".
2363 rebase.instructionFormat
2364 A format string, as specified in linkgit:git-log[1], to be used for
2365 the instruction list during an interactive rebase. The format will automatically
2366 have the long commit hash prepended to the format.
2368 receive.advertiseAtomic::
2369 By default, git-receive-pack will advertise the atomic push
2370 capability to its clients. If you don't want to this capability
2371 to be advertised, set this variable to false.
2374 By default, git-receive-pack will run "git-gc --auto" after
2375 receiving data from git-push and updating refs. You can stop
2376 it by setting this variable to false.
2378 receive.certNonceSeed::
2379 By setting this variable to a string, `git receive-pack`
2380 will accept a `git push --signed` and verifies it by using
2381 a "nonce" protected by HMAC using this string as a secret
2384 receive.certNonceSlop::
2385 When a `git push --signed` sent a push certificate with a
2386 "nonce" that was issued by a receive-pack serving the same
2387 repository within this many seconds, export the "nonce"
2388 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2389 hooks (instead of what the receive-pack asked the sending
2390 side to include). This may allow writing checks in
2391 `pre-receive` and `post-receive` a bit easier. Instead of
2392 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2393 that records by how many seconds the nonce is stale to
2394 decide if they want to accept the certificate, they only
2395 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2397 receive.fsckObjects::
2398 If it is set to true, git-receive-pack will check all received
2399 objects. It will abort in the case of a malformed object or a
2400 broken link. The result of an abort are only dangling objects.
2401 Defaults to false. If not set, the value of `transfer.fsckObjects`
2404 receive.fsck.<msg-id>::
2405 When `receive.fsckObjects` is set to true, errors can be switched
2406 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2407 setting where the `<msg-id>` is the fsck message ID and the value
2408 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2409 the error/warning with the message ID, e.g. "missingEmail: invalid
2410 author/committer line - missing email" means that setting
2411 `receive.fsck.missingEmail = ignore` will hide that issue.
2413 This feature is intended to support working with legacy repositories
2414 which would not pass pushing when `receive.fsckObjects = true`, allowing
2415 the host to accept repositories with certain known issues but still catch
2418 receive.fsck.skipList::
2419 The path to a sorted list of object names (i.e. one SHA-1 per
2420 line) that are known to be broken in a non-fatal way and should
2421 be ignored. This feature is useful when an established project
2422 should be accepted despite early commits containing errors that
2423 can be safely ignored such as invalid committer email addresses.
2424 Note: corrupt objects cannot be skipped with this setting.
2426 receive.unpackLimit::
2427 If the number of objects received in a push is below this
2428 limit then the objects will be unpacked into loose object
2429 files. However if the number of received objects equals or
2430 exceeds this limit then the received pack will be stored as
2431 a pack, after adding any missing delta bases. Storing the
2432 pack from a push can make the push operation complete faster,
2433 especially on slow filesystems. If not set, the value of
2434 `transfer.unpackLimit` is used instead.
2436 receive.denyDeletes::
2437 If set to true, git-receive-pack will deny a ref update that deletes
2438 the ref. Use this to prevent such a ref deletion via a push.
2440 receive.denyDeleteCurrent::
2441 If set to true, git-receive-pack will deny a ref update that
2442 deletes the currently checked out branch of a non-bare repository.
2444 receive.denyCurrentBranch::
2445 If set to true or "refuse", git-receive-pack will deny a ref update
2446 to the currently checked out branch of a non-bare repository.
2447 Such a push is potentially dangerous because it brings the HEAD
2448 out of sync with the index and working tree. If set to "warn",
2449 print a warning of such a push to stderr, but allow the push to
2450 proceed. If set to false or "ignore", allow such pushes with no
2451 message. Defaults to "refuse".
2453 Another option is "updateInstead" which will update the working
2454 tree if pushing into the current branch. This option is
2455 intended for synchronizing working directories when one side is not easily
2456 accessible via interactive ssh (e.g. a live web site, hence the requirement
2457 that the working directory be clean). This mode also comes in handy when
2458 developing inside a VM to test and fix code on different Operating Systems.
2460 By default, "updateInstead" will refuse the push if the working tree or
2461 the index have any difference from the HEAD, but the `push-to-checkout`
2462 hook can be used to customize this. See linkgit:githooks[5].
2464 receive.denyNonFastForwards::
2465 If set to true, git-receive-pack will deny a ref update which is
2466 not a fast-forward. Use this to prevent such an update via a push,
2467 even if that push is forced. This configuration variable is
2468 set when initializing a shared repository.
2471 This variable is the same as `transfer.hideRefs`, but applies
2472 only to `receive-pack` (and so affects pushes, but not fetches).
2473 An attempt to update or delete a hidden ref by `git push` is
2476 receive.updateServerInfo::
2477 If set to true, git-receive-pack will run git-update-server-info
2478 after receiving data from git-push and updating refs.
2480 receive.shallowUpdate::
2481 If set to true, .git/shallow can be updated when new refs
2482 require new shallow roots. Otherwise those refs are rejected.
2484 remote.pushDefault::
2485 The remote to push to by default. Overrides
2486 `branch.<name>.remote` for all branches, and is overridden by
2487 `branch.<name>.pushRemote` for specific branches.
2490 The URL of a remote repository. See linkgit:git-fetch[1] or
2491 linkgit:git-push[1].
2493 remote.<name>.pushurl::
2494 The push URL of a remote repository. See linkgit:git-push[1].
2496 remote.<name>.proxy::
2497 For remotes that require curl (http, https and ftp), the URL to
2498 the proxy to use for that remote. Set to the empty string to
2499 disable proxying for that remote.
2501 remote.<name>.proxyAuthMethod::
2502 For remotes that require curl (http, https and ftp), the method to use for
2503 authenticating against the proxy in use (probably set in
2504 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2506 remote.<name>.fetch::
2507 The default set of "refspec" for linkgit:git-fetch[1]. See
2508 linkgit:git-fetch[1].
2510 remote.<name>.push::
2511 The default set of "refspec" for linkgit:git-push[1]. See
2512 linkgit:git-push[1].
2514 remote.<name>.mirror::
2515 If true, pushing to this remote will automatically behave
2516 as if the `--mirror` option was given on the command line.
2518 remote.<name>.skipDefaultUpdate::
2519 If true, this remote will be skipped by default when updating
2520 using linkgit:git-fetch[1] or the `update` subcommand of
2521 linkgit:git-remote[1].
2523 remote.<name>.skipFetchAll::
2524 If true, this remote will be skipped by default when updating
2525 using linkgit:git-fetch[1] or the `update` subcommand of
2526 linkgit:git-remote[1].
2528 remote.<name>.receivepack::
2529 The default program to execute on the remote side when pushing. See
2530 option --receive-pack of linkgit:git-push[1].
2532 remote.<name>.uploadpack::
2533 The default program to execute on the remote side when fetching. See
2534 option --upload-pack of linkgit:git-fetch-pack[1].
2536 remote.<name>.tagOpt::
2537 Setting this value to --no-tags disables automatic tag following when
2538 fetching from remote <name>. Setting it to --tags will fetch every
2539 tag from remote <name>, even if they are not reachable from remote
2540 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2541 override this setting. See options --tags and --no-tags of
2542 linkgit:git-fetch[1].
2545 Setting this to a value <vcs> will cause Git to interact with
2546 the remote with the git-remote-<vcs> helper.
2548 remote.<name>.prune::
2549 When set to true, fetching from this remote by default will also
2550 remove any remote-tracking references that no longer exist on the
2551 remote (as if the `--prune` option was given on the command line).
2552 Overrides `fetch.prune` settings, if any.
2555 The list of remotes which are fetched by "git remote update
2556 <group>". See linkgit:git-remote[1].
2558 repack.useDeltaBaseOffset::
2559 By default, linkgit:git-repack[1] creates packs that use
2560 delta-base offset. If you need to share your repository with
2561 Git older than version 1.4.4, either directly or via a dumb
2562 protocol such as http, then you need to set this option to
2563 "false" and repack. Access from old Git versions over the
2564 native protocol are unaffected by this option.
2566 repack.packKeptObjects::
2567 If set to true, makes `git repack` act as if
2568 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2569 details. Defaults to `false` normally, but `true` if a bitmap
2570 index is being written (either via `--write-bitmap-index` or
2571 `repack.writeBitmaps`).
2573 repack.writeBitmaps::
2574 When true, git will write a bitmap index when packing all
2575 objects to disk (e.g., when `git repack -a` is run). This
2576 index can speed up the "counting objects" phase of subsequent
2577 packs created for clones and fetches, at the cost of some disk
2578 space and extra time spent on the initial repack. Defaults to
2582 When set to true, `git-rerere` updates the index with the
2583 resulting contents after it cleanly resolves conflicts using
2584 previously recorded resolution. Defaults to false.
2587 Activate recording of resolved conflicts, so that identical
2588 conflict hunks can be resolved automatically, should they be
2589 encountered again. By default, linkgit:git-rerere[1] is
2590 enabled if there is an `rr-cache` directory under the
2591 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2594 sendemail.identity::
2595 A configuration identity. When given, causes values in the
2596 'sendemail.<identity>' subsection to take precedence over
2597 values in the 'sendemail' section. The default identity is
2598 the value of 'sendemail.identity'.
2600 sendemail.smtpEncryption::
2601 See linkgit:git-send-email[1] for description. Note that this
2602 setting is not subject to the 'identity' mechanism.
2604 sendemail.smtpssl (deprecated)::
2605 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2607 sendemail.smtpsslcertpath::
2608 Path to ca-certificates (either a directory or a single file).
2609 Set it to an empty string to disable certificate verification.
2611 sendemail.<identity>.*::
2612 Identity-specific versions of the 'sendemail.*' parameters
2613 found below, taking precedence over those when the this
2614 identity is selected, through command-line or
2615 'sendemail.identity'.
2617 sendemail.aliasesFile::
2618 sendemail.aliasFileType::
2619 sendemail.annotate::
2623 sendemail.chainReplyTo::
2625 sendemail.envelopeSender::
2627 sendemail.multiEdit::
2628 sendemail.signedoffbycc::
2629 sendemail.smtpPass::
2630 sendemail.suppresscc::
2631 sendemail.suppressFrom::
2633 sendemail.smtpDomain::
2634 sendemail.smtpServer::
2635 sendemail.smtpServerPort::
2636 sendemail.smtpServerOption::
2637 sendemail.smtpUser::
2639 sendemail.transferEncoding::
2640 sendemail.validate::
2642 See linkgit:git-send-email[1] for description.
2644 sendemail.signedoffcc (deprecated)::
2645 Deprecated alias for 'sendemail.signedoffbycc'.
2647 showbranch.default::
2648 The default set of branches for linkgit:git-show-branch[1].
2649 See linkgit:git-show-branch[1].
2651 status.relativePaths::
2652 By default, linkgit:git-status[1] shows paths relative to the
2653 current directory. Setting this variable to `false` shows paths
2654 relative to the repository root (this was the default for Git
2658 Set to true to enable --short by default in linkgit:git-status[1].
2659 The option --no-short takes precedence over this variable.
2662 Set to true to enable --branch by default in linkgit:git-status[1].
2663 The option --no-branch takes precedence over this variable.
2665 status.displayCommentPrefix::
2666 If set to true, linkgit:git-status[1] will insert a comment
2667 prefix before each output line (starting with
2668 `core.commentChar`, i.e. `#` by default). This was the
2669 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2672 status.showUntrackedFiles::
2673 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2674 files which are not currently tracked by Git. Directories which
2675 contain only untracked files, are shown with the directory name
2676 only. Showing untracked files means that Git needs to lstat() all
2677 the files in the whole repository, which might be slow on some
2678 systems. So, this variable controls how the commands displays
2679 the untracked files. Possible values are:
2682 * `no` - Show no untracked files.
2683 * `normal` - Show untracked files and directories.
2684 * `all` - Show also individual files in untracked directories.
2687 If this variable is not specified, it defaults to 'normal'.
2688 This variable can be overridden with the -u|--untracked-files option
2689 of linkgit:git-status[1] and linkgit:git-commit[1].
2691 status.submoduleSummary::
2693 If this is set to a non zero number or true (identical to -1 or an
2694 unlimited number), the submodule summary will be enabled and a
2695 summary of commits for modified submodules will be shown (see
2696 --summary-limit option of linkgit:git-submodule[1]). Please note
2697 that the summary output command will be suppressed for all
2698 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2699 for those submodules where `submodule.<name>.ignore=all`. The only
2700 exception to that rule is that status and commit will show staged
2701 submodule changes. To
2702 also view the summary for ignored submodules you can either use
2703 the --ignore-submodules=dirty command-line option or the 'git
2704 submodule summary' command, which shows a similar output but does
2705 not honor these settings.
2708 If this is set to true, the `git stash show` command without an
2709 option will show the stash in patch form. Defaults to false.
2710 See description of 'show' command in linkgit:git-stash[1].
2713 If this is set to true, the `git stash show` command without an
2714 option will show diffstat of the stash. Defaults to true.
2715 See description of 'show' command in linkgit:git-stash[1].
2717 submodule.<name>.path::
2718 submodule.<name>.url::
2719 The path within this project and URL for a submodule. These
2720 variables are initially populated by 'git submodule init'. See
2721 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2724 submodule.<name>.update::
2725 The default update procedure for a submodule. This variable
2726 is populated by `git submodule init` from the
2727 linkgit:gitmodules[5] file. See description of 'update'
2728 command in linkgit:git-submodule[1].
2730 submodule.<name>.branch::
2731 The remote branch name for a submodule, used by `git submodule
2732 update --remote`. Set this option to override the value found in
2733 the `.gitmodules` file. See linkgit:git-submodule[1] and
2734 linkgit:gitmodules[5] for details.
2736 submodule.<name>.fetchRecurseSubmodules::
2737 This option can be used to control recursive fetching of this
2738 submodule. It can be overridden by using the --[no-]recurse-submodules
2739 command-line option to "git fetch" and "git pull".
2740 This setting will override that from in the linkgit:gitmodules[5]
2743 submodule.<name>.ignore::
2744 Defines under what circumstances "git status" and the diff family show
2745 a submodule as modified. When set to "all", it will never be considered
2746 modified (but it will nonetheless show up in the output of status and
2747 commit when it has been staged), "dirty" will ignore all changes
2748 to the submodules work tree and
2749 takes only differences between the HEAD of the submodule and the commit
2750 recorded in the superproject into account. "untracked" will additionally
2751 let submodules with modified tracked files in their work tree show up.
2752 Using "none" (the default when this option is not set) also shows
2753 submodules that have untracked files in their work tree as changed.
2754 This setting overrides any setting made in .gitmodules for this submodule,
2755 both settings can be overridden on the command line by using the
2756 "--ignore-submodules" option. The 'git submodule' commands are not
2757 affected by this setting.
2760 This variable controls the sort ordering of tags when displayed by
2761 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2762 value of this variable will be used as the default.
2765 This variable can be used to restrict the permission bits of
2766 tar archive entries. The default is 0002, which turns off the
2767 world write bit. The special value "user" indicates that the
2768 archiving user's umask will be used instead. See umask(2) and
2769 linkgit:git-archive[1].
2771 transfer.fsckObjects::
2772 When `fetch.fsckObjects` or `receive.fsckObjects` are
2773 not set, the value of this variable is used instead.
2777 String(s) `receive-pack` and `upload-pack` use to decide which
2778 refs to omit from their initial advertisements. Use more than
2779 one definition to specify multiple prefix strings. A ref that is
2780 under the hierarchies listed in the value of this variable is
2781 excluded, and is hidden when responding to `git push` or `git
2782 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2783 program-specific versions of this config.
2785 You may also include a `!` in front of the ref name to negate the entry,
2786 explicitly exposing it, even if an earlier entry marked it as hidden.
2787 If you have multiple hideRefs values, later entries override earlier ones
2788 (and entries in more-specific config files override less-specific ones).
2790 If a namespace is in use, the namespace prefix is stripped from each
2791 reference before it is matched against `transfer.hiderefs` patterns.
2792 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2793 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2794 is omitted from the advertisements but `refs/heads/master` and
2795 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2796 "have" lines. In order to match refs before stripping, add a `^` in front of
2797 the ref name. If you combine `!` and `^`, `!` must be specified first.
2799 transfer.unpackLimit::
2800 When `fetch.unpackLimit` or `receive.unpackLimit` are
2801 not set, the value of this variable is used instead.
2802 The default value is 100.
2804 uploadarchive.allowUnreachable::
2805 If true, allow clients to use `git archive --remote` to request
2806 any tree, whether reachable from the ref tips or not. See the
2807 discussion in the `SECURITY` section of
2808 linkgit:git-upload-archive[1] for more details. Defaults to
2811 uploadpack.hideRefs::
2812 This variable is the same as `transfer.hideRefs`, but applies
2813 only to `upload-pack` (and so affects only fetches, not pushes).
2814 An attempt to fetch a hidden ref by `git fetch` will fail. See
2815 also `uploadpack.allowTipSHA1InWant`.
2817 uploadpack.allowTipSHA1InWant::
2818 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2819 to accept a fetch request that asks for an object at the tip
2820 of a hidden ref (by default, such a request is rejected).
2821 see also `uploadpack.hideRefs`.
2823 uploadpack.allowReachableSHA1InWant::
2824 Allow `upload-pack` to accept a fetch request that asks for an
2825 object that is reachable from any ref tip. However, note that
2826 calculating object reachability is computationally expensive.
2827 Defaults to `false`.
2829 uploadpack.keepAlive::
2830 When `upload-pack` has started `pack-objects`, there may be a
2831 quiet period while `pack-objects` prepares the pack. Normally
2832 it would output progress information, but if `--quiet` was used
2833 for the fetch, `pack-objects` will output nothing at all until
2834 the pack data begins. Some clients and networks may consider
2835 the server to be hung and give up. Setting this option instructs
2836 `upload-pack` to send an empty keepalive packet every
2837 `uploadpack.keepAlive` seconds. Setting this option to 0
2838 disables keepalive packets entirely. The default is 5 seconds.
2840 url.<base>.insteadOf::
2841 Any URL that starts with this value will be rewritten to
2842 start, instead, with <base>. In cases where some site serves a
2843 large number of repositories, and serves them with multiple
2844 access methods, and some users need to use different access
2845 methods, this feature allows people to specify any of the
2846 equivalent URLs and have Git automatically rewrite the URL to
2847 the best alternative for the particular user, even for a
2848 never-before-seen repository on the site. When more than one
2849 insteadOf strings match a given URL, the longest match is used.
2851 url.<base>.pushInsteadOf::
2852 Any URL that starts with this value will not be pushed to;
2853 instead, it will be rewritten to start with <base>, and the
2854 resulting URL will be pushed to. In cases where some site serves
2855 a large number of repositories, and serves them with multiple
2856 access methods, some of which do not allow push, this feature
2857 allows people to specify a pull-only URL and have Git
2858 automatically use an appropriate URL to push, even for a
2859 never-before-seen repository on the site. When more than one
2860 pushInsteadOf strings match a given URL, the longest match is
2861 used. If a remote has an explicit pushurl, Git will ignore this
2862 setting for that remote.
2865 Your email address to be recorded in any newly created commits.
2866 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2867 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2870 Your full name to be recorded in any newly created commits.
2871 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2872 environment variables. See linkgit:git-commit-tree[1].
2874 user.useConfigOnly::
2875 Instruct Git to avoid trying to guess defaults for 'user.email'
2876 and 'user.name', and instead retrieve the values only from the
2877 configuration. For example, if you have multiple email addresses
2878 and would like to use a different one for each repository, then
2879 with this configuration option set to `true` in the global config
2880 along with a name, Git will prompt you to set up an email before
2881 making new commits in a newly cloned repository.
2882 Defaults to `false`.
2885 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2886 key you want it to automatically when creating a signed tag or
2887 commit, you can override the default selection with this variable.
2888 This option is passed unchanged to gpg's --local-user parameter,
2889 so you may specify a key using any method that gpg supports.
2891 versionsort.prereleaseSuffix::
2892 When version sort is used in linkgit:git-tag[1], prerelease
2893 tags (e.g. "1.0-rc1") may appear after the main release
2894 "1.0". By specifying the suffix "-rc" in this variable,
2895 "1.0-rc1" will appear before "1.0".
2897 This variable can be specified multiple times, once per suffix. The
2898 order of suffixes in the config file determines the sorting order
2899 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2900 is sorted before 1.0-rcXX). The sorting order between different
2901 suffixes is undefined if they are in multiple config files.
2904 Specify a web browser that may be used by some commands.
2905 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]