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.
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored. The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables. A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins. Section names are not case sensitive. Only alphanumeric
29 characters, `-` and `.` are allowed in section names. Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections. To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
38 [section "subsection"]
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively). Section headers cannot span multiple
45 lines. Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'. If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character. There can be more
60 than one value for a given variable; we say then that the variable is
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean. Boolean values may be given as yes/no,
68 1/0, true/false or on/off. Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS). Other char escape sequences (including octal
82 escape sequences) are invalid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
107 ; Don't trust file modes
112 external = /usr/local/bin/diff-wrapper
117 merge = refs/heads/devel
121 gitProxy="ssh" for "kernel.org"
122 gitProxy=default-proxy ; for the rest
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page.
136 Other git-related tools may and do use their own variables. When
137 inventing new variables for use in your own tool, make sure their
138 names do not conflict with those that are used by Git itself and
139 other popular tools, and describe them in your documentation.
143 These variables control various optional help messages designed to
144 aid new users. All 'advice.*' variables default to 'true', and you
145 can tell Git that you do not need help by setting these to 'false':
149 Set this variable to 'false' if you want to disable
151 'pushNonFFMatching', 'pushAlreadyExists',
152 'pushFetchFirst', and 'pushNeedsForce'
155 Advice shown when linkgit:git-push[1] fails due to a
156 non-fast-forward update to the current branch.
158 Advice shown when you ran linkgit:git-push[1] and pushed
159 'matching refs' explicitly (i.e. you used ':', or
160 specified a refspec that isn't your current branch) and
161 it resulted in a non-fast-forward error.
163 Shown when linkgit:git-push[1] rejects an update that
164 does not qualify for fast-forwarding (e.g., a tag.)
166 Shown when linkgit:git-push[1] rejects an update that
167 tries to overwrite a remote ref that points at an
168 object we do not have.
170 Shown when linkgit:git-push[1] rejects an update that
171 tries to overwrite a remote ref that points at an
172 object that is not a commit-ish, or make the remote
173 ref point at an object that is not a commit-ish.
175 Show directions on how to proceed from the current
176 state in the output of linkgit:git-status[1], in
177 the template shown when writing commit messages in
178 linkgit:git-commit[1], and in the help message shown
179 by linkgit:git-checkout[1] when switching branch.
181 Advise to consider using the `-u` option to linkgit:git-status[1]
182 when the command takes more than 2 seconds to enumerate untracked
185 Advice shown when linkgit:git-merge[1] refuses to
186 merge to avoid overwriting local changes.
188 Advice shown by various commands when conflicts
189 prevent the operation from being performed.
191 Advice on how to set your identity configuration when
192 your information is guessed from the system username and
195 Advice shown when you used linkgit:git-checkout[1] to
196 move to the detach HEAD state, to instruct how to create
197 a local branch after the fact.
199 Advice that shows the location of the patch file when
200 linkgit:git-am[1] fails to apply it.
202 In case of failure in the output of linkgit:git-rm[1],
203 show directions on how to proceed from the current state.
207 Tells Git if the executable bit of files in the working tree
210 Some filesystems lose the executable bit when a file that is
211 marked as executable is checked out, or checks out an
212 non-executable file with executable bit on.
213 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
214 to see if it handles the executable bit correctly
215 and this variable is automatically set as necessary.
217 A repository, however, may be on a filesystem that handles
218 the filemode correctly, and this variable is set to 'true'
219 when created, but later may be made accessible from another
220 environment that loses the filemode (e.g. exporting ext4 via
221 CIFS mount, visiting a Cygwin created repository with
222 Git for Windows or Eclipse).
223 In such a case it may be necessary to set this variable to 'false'.
224 See linkgit:git-update-index[1].
226 The default is true (when core.filemode is not specified in the config file).
229 If true, this option enables various workarounds to enable
230 Git to work better on filesystems that are not case sensitive,
231 like FAT. For example, if a directory listing finds
232 "makefile" when Git expects "Makefile", Git will assume
233 it is really the same file, and continue to remember it as
236 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
237 will probe and set core.ignorecase true if appropriate when the repository
240 core.precomposeunicode::
241 This option is only used by Mac OS implementation of Git.
242 When core.precomposeunicode=true, Git reverts the unicode decomposition
243 of filenames done by Mac OS. This is useful when sharing a repository
244 between Mac OS and Linux or Windows.
245 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
246 When false, file names are handled fully transparent by Git,
247 which is backward compatible with older versions of Git.
250 If set to true, do not allow checkout of paths that would
251 be considered equivalent to `.git` on an HFS+ filesystem.
252 Defaults to `true` on Mac OS, and `false` elsewhere.
255 If set to true, do not allow checkout of paths that would
256 cause problems with the NTFS filesystem, e.g. conflict with
258 Defaults to `true` on Windows, and `false` elsewhere.
261 If false, the ctime differences between the index and the
262 working tree are ignored; useful when the inode change time
263 is regularly modified by something outside Git (file system
264 crawlers and some backup systems).
265 See linkgit:git-update-index[1]. True by default.
268 Determines which stat fields to match between the index
269 and work tree. The user can set this to 'default' or
270 'minimal'. Default (or explicitly 'default'), is to check
271 all fields, including the sub-second part of mtime and ctime.
274 The commands that output paths (e.g. 'ls-files',
275 'diff'), when not given the `-z` option, will quote
276 "unusual" characters in the pathname by enclosing the
277 pathname in a double-quote pair and with backslashes the
278 same way strings in C source code are quoted. If this
279 variable is set to false, the bytes higher than 0x80 are
280 not quoted but output as verbatim. Note that double
281 quote, backslash and control characters are always
282 quoted without `-z` regardless of the setting of this
286 Sets the line ending type to use in the working directory for
287 files that have the `text` property set. Alternatives are
288 'lf', 'crlf' and 'native', which uses the platform's native
289 line ending. The default value is `native`. See
290 linkgit:gitattributes[5] for more information on end-of-line
294 If true, makes Git check if converting `CRLF` is reversible when
295 end-of-line conversion is active. Git will verify if a command
296 modifies a file in the work tree either directly or indirectly.
297 For example, committing a file followed by checking out the
298 same file should yield the original file in the work tree. If
299 this is not the case for the current setting of
300 `core.autocrlf`, Git will reject the file. The variable can
301 be set to "warn", in which case Git will only warn about an
302 irreversible conversion but continue the operation.
304 CRLF conversion bears a slight chance of corrupting data.
305 When it is enabled, Git will convert CRLF to LF during commit and LF to
306 CRLF during checkout. A file that contains a mixture of LF and
307 CRLF before the commit cannot be recreated by Git. For text
308 files this is the right thing to do: it corrects line endings
309 such that we have only LF line endings in the repository.
310 But for binary files that are accidentally classified as text the
311 conversion can corrupt data.
313 If you recognize such corruption early you can easily fix it by
314 setting the conversion type explicitly in .gitattributes. Right
315 after committing you still have the original file in your work
316 tree and this file is not yet corrupted. You can explicitly tell
317 Git that this file is binary and Git will handle the file
320 Unfortunately, the desired effect of cleaning up text files with
321 mixed line endings and the undesired effect of corrupting binary
322 files cannot be distinguished. In both cases CRLFs are removed
323 in an irreversible way. For text files this is the right thing
324 to do because CRLFs are line endings, while for binary files
325 converting CRLFs corrupts data.
327 Note, this safety check does not mean that a checkout will generate a
328 file identical to the original file for a different setting of
329 `core.eol` and `core.autocrlf`, but only for the current one. For
330 example, a text file with `LF` would be accepted with `core.eol=lf`
331 and could later be checked out with `core.eol=crlf`, in which case the
332 resulting file would contain `CRLF`, although the original file
333 contained `LF`. However, in both work trees the line endings would be
334 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
335 file with mixed line endings would be reported by the `core.safecrlf`
339 Setting this variable to "true" is almost the same as setting
340 the `text` attribute to "auto" on all files except that text
341 files are not guaranteed to be normalized: files that contain
342 `CRLF` in the repository will not be touched. Use this
343 setting if you want to have `CRLF` line endings in your
344 working directory even though the repository does not have
345 normalized line endings. This variable can be set to 'input',
346 in which case no output conversion is performed.
349 If false, symbolic links are checked out as small plain files that
350 contain the link text. linkgit:git-update-index[1] and
351 linkgit:git-add[1] will not change the recorded type to regular
352 file. Useful on filesystems like FAT that do not support
355 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
356 will probe and set core.symlinks false if appropriate when the repository
360 A "proxy command" to execute (as 'command host port') instead
361 of establishing direct connection to the remote server when
362 using the Git protocol for fetching. If the variable value is
363 in the "COMMAND for DOMAIN" format, the command is applied only
364 on hostnames ending with the specified domain string. This variable
365 may be set multiple times and is matched in the given order;
366 the first match wins.
368 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
369 (which always applies universally, without the special "for"
372 The special string `none` can be used as the proxy command to
373 specify that no proxy be used for a given domain pattern.
374 This is useful for excluding servers inside a firewall from
375 proxy use, while defaulting to a common proxy for external domains.
378 If true, Git will avoid using lstat() calls to detect if files have
379 changed by setting the "assume-unchanged" bit for those tracked files
380 which it has updated identically in both the index and working tree.
382 When files are modified outside of Git, the user will need to stage
383 the modified files explicitly (e.g. see 'Examples' section in
384 linkgit:git-update-index[1]).
385 Git will not normally detect changes to those files.
387 This is useful on systems where lstat() calls are very slow, such as
388 CIFS/Microsoft Windows.
392 core.preferSymlinkRefs::
393 Instead of the default "symref" format for HEAD
394 and other symbolic reference files, use symbolic links.
395 This is sometimes needed to work with old scripts that
396 expect HEAD to be a symbolic link.
399 If true this repository is assumed to be 'bare' and has no
400 working directory associated with it. If this is the case a
401 number of commands that require a working directory will be
402 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
404 This setting is automatically guessed by linkgit:git-clone[1] or
405 linkgit:git-init[1] when the repository was created. By default a
406 repository that ends in "/.git" is assumed to be not bare (bare =
407 false), while all other repositories are assumed to be bare (bare
411 Set the path to the root of the working tree.
412 This can be overridden by the GIT_WORK_TREE environment
413 variable and the '--work-tree' command-line option.
414 The value can be an absolute path or relative to the path to
415 the .git directory, which is either specified by --git-dir
416 or GIT_DIR, or automatically discovered.
417 If --git-dir or GIT_DIR is specified but none of
418 --work-tree, GIT_WORK_TREE and core.worktree is specified,
419 the current working directory is regarded as the top level
420 of your working tree.
422 Note that this variable is honored even when set in a configuration
423 file in a ".git" subdirectory of a directory and its value differs
424 from the latter directory (e.g. "/path/to/.git/config" has
425 core.worktree set to "/different/path"), which is most likely a
426 misconfiguration. Running Git commands in the "/path/to" directory will
427 still use "/different/path" as the root of the work tree and can cause
428 confusion unless you know what you are doing (e.g. you are creating a
429 read-only snapshot of the same index to a location different from the
430 repository's usual working tree).
432 core.logAllRefUpdates::
433 Enable the reflog. Updates to a ref <ref> is logged to the file
434 "$GIT_DIR/logs/<ref>", by appending the new and old
435 SHA-1, the date/time and the reason of the update, but
436 only when the file exists. If this configuration
437 variable is set to true, missing "$GIT_DIR/logs/<ref>"
438 file is automatically created for branch heads (i.e. under
439 refs/heads/), remote refs (i.e. under refs/remotes/),
440 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
442 This information can be used to determine what commit
443 was the tip of a branch "2 days ago".
445 This value is true by default in a repository that has
446 a working directory associated with it, and false by
447 default in a bare repository.
449 core.repositoryFormatVersion::
450 Internal variable identifying the repository format and layout
453 core.sharedRepository::
454 When 'group' (or 'true'), the repository is made shareable between
455 several users in a group (making sure all the files and objects are
456 group-writable). When 'all' (or 'world' or 'everybody'), the
457 repository will be readable by all users, additionally to being
458 group-shareable. When 'umask' (or 'false'), Git will use permissions
459 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
460 files in the repository will have this mode value. '0xxx' will override
461 user's umask value (whereas the other options will only override
462 requested parts of the user's umask value). Examples: '0660' will make
463 the repo read/write-able for the owner and group, but inaccessible to
464 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
465 repository that is group-readable but not group-writable.
466 See linkgit:git-init[1]. False by default.
468 core.warnAmbiguousRefs::
469 If true, Git will warn you if the ref name you passed it is ambiguous
470 and might match multiple refs in the repository. True by default.
473 An integer -1..9, indicating a default compression level.
474 -1 is the zlib default. 0 means no compression,
475 and 1..9 are various speed/size tradeoffs, 9 being slowest.
476 If set, this provides a default to other compression variables,
477 such as 'core.loosecompression' and 'pack.compression'.
479 core.loosecompression::
480 An integer -1..9, indicating the compression level for objects that
481 are not in a pack file. -1 is the zlib default. 0 means no
482 compression, and 1..9 are various speed/size tradeoffs, 9 being
483 slowest. If not set, defaults to core.compression. If that is
484 not set, defaults to 1 (best speed).
486 core.packedGitWindowSize::
487 Number of bytes of a pack file to map into memory in a
488 single mapping operation. Larger window sizes may allow
489 your system to process a smaller number of large pack files
490 more quickly. Smaller window sizes will negatively affect
491 performance due to increased calls to the operating system's
492 memory manager, but may improve performance when accessing
493 a large number of large pack files.
495 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
496 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
497 be reasonable for all users/operating systems. You probably do
498 not need to adjust this value.
500 Common unit suffixes of 'k', 'm', or 'g' are supported.
502 core.packedGitLimit::
503 Maximum number of bytes to map simultaneously into memory
504 from pack files. If Git needs to access more than this many
505 bytes at once to complete an operation it will unmap existing
506 regions to reclaim virtual address space within the process.
508 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
509 This should be reasonable for all users/operating systems, except on
510 the largest projects. You probably do not need to adjust this value.
512 Common unit suffixes of 'k', 'm', or 'g' are supported.
514 core.deltaBaseCacheLimit::
515 Maximum number of bytes to reserve for caching base objects
516 that may be referenced by multiple deltified objects. By storing the
517 entire decompressed base objects in a cache Git is able
518 to avoid unpacking and decompressing frequently used base
519 objects multiple times.
521 Default is 96 MiB on all platforms. This should be reasonable
522 for all users/operating systems, except on the largest projects.
523 You probably do not need to adjust this value.
525 Common unit suffixes of 'k', 'm', or 'g' are supported.
527 core.bigFileThreshold::
528 Files larger than this size are stored deflated, without
529 attempting delta compression. Storing large files without
530 delta compression avoids excessive memory usage, at the
531 slight expense of increased disk usage. Additionally files
532 larger than this size are always treated as binary.
534 Default is 512 MiB on all platforms. This should be reasonable
535 for most projects as source code and other text files can still
536 be delta compressed, but larger binary media files won't be.
538 Common unit suffixes of 'k', 'm', or 'g' are supported.
541 In addition to '.gitignore' (per-directory) and
542 '.git/info/exclude', Git looks into this file for patterns
543 of files which are not meant to be tracked. "`~/`" is expanded
544 to the value of `$HOME` and "`~user/`" to the specified user's
545 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
546 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
547 is used instead. See linkgit:gitignore[5].
550 Some commands (e.g. svn and http interfaces) that interactively
551 ask for a password can be told to use an external program given
552 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
553 environment variable. If not set, fall back to the value of the
554 'SSH_ASKPASS' environment variable or, failing that, a simple password
555 prompt. The external program shall be given a suitable prompt as
556 command-line argument and write the password on its STDOUT.
558 core.attributesfile::
559 In addition to '.gitattributes' (per-directory) and
560 '.git/info/attributes', Git looks into this file for attributes
561 (see linkgit:gitattributes[5]). Path expansions are made the same
562 way as for `core.excludesfile`. Its default value is
563 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
564 set or empty, $HOME/.config/git/attributes is used instead.
567 Commands such as `commit` and `tag` that lets you edit
568 messages by launching an editor uses the value of this
569 variable when it is set, and the environment variable
570 `GIT_EDITOR` is not set. See linkgit:git-var[1].
573 Commands such as `commit` and `tag` that lets you edit
574 messages consider a line that begins with this character
575 commented, and removes them after the editor returns
578 If set to "auto", `git-commit` would select a character that is not
579 the beginning character of any line in existing commit messages.
582 Text editor used by `git rebase -i` for editing the rebase instruction file.
583 The value is meant to be interpreted by the shell when it is used.
584 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
585 When not configured the default commit message editor is used instead.
588 Text viewer for use by Git commands (e.g., 'less'). The value
589 is meant to be interpreted by the shell. The order of preference
590 is the `$GIT_PAGER` environment variable, then `core.pager`
591 configuration, then `$PAGER`, and then the default chosen at
592 compile time (usually 'less').
594 When the `LESS` environment variable is unset, Git sets it to `FRX`
595 (if `LESS` environment variable is set, Git does not change it at
596 all). If you want to selectively override Git's default setting
597 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
598 be passed to the shell by Git, which will translate the final
599 command to `LESS=FRX less -S`. The environment does not set the
600 `S` option but the command line does, instructing less to truncate
601 long lines. Similarly, setting `core.pager` to `less -+F` will
602 deactivate the `F` option specified by the environment from the
603 command-line, deactivating the "quit if one screen" behavior of
604 `less`. One can specifically activate some flags for particular
605 commands: for example, setting `pager.blame` to `less -S` enables
606 line truncation only for `git blame`.
608 Likewise, when the `LV` environment variable is unset, Git sets it
609 to `-c`. You can override this setting by exporting `LV` with
610 another value or setting `core.pager` to `lv +c`.
613 A comma separated list of common whitespace problems to
614 notice. 'git diff' will use `color.diff.whitespace` to
615 highlight them, and 'git apply --whitespace=error' will
616 consider them as errors. You can prefix `-` to disable
617 any of them (e.g. `-trailing-space`):
619 * `blank-at-eol` treats trailing whitespaces at the end of the line
620 as an error (enabled by default).
621 * `space-before-tab` treats a space character that appears immediately
622 before a tab character in the initial indent part of the line as an
623 error (enabled by default).
624 * `indent-with-non-tab` treats a line that is indented with space
625 characters instead of the equivalent tabs as an error (not enabled by
627 * `tab-in-indent` treats a tab character in the initial indent part of
628 the line as an error (not enabled by default).
629 * `blank-at-eof` treats blank lines added at the end of file as an error
630 (enabled by default).
631 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
633 * `cr-at-eol` treats a carriage-return at the end of line as
634 part of the line terminator, i.e. with it, `trailing-space`
635 does not trigger if the character before such a carriage-return
636 is not a whitespace (not enabled by default).
637 * `tabwidth=<n>` tells how many character positions a tab occupies; this
638 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
639 errors. The default tab width is 8. Allowed values are 1 to 63.
641 core.fsyncobjectfiles::
642 This boolean will enable 'fsync()' when writing object files.
644 This is a total waste of time and effort on a filesystem that orders
645 data writes properly, but can be useful for filesystems that do not use
646 journalling (traditional UNIX filesystems) or that only journal metadata
647 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
650 Enable parallel index preload for operations like 'git diff'
652 This can speed up operations like 'git diff' and 'git status' especially
653 on filesystems like NFS that have weak caching semantics and thus
654 relatively high IO latencies. When enabled, Git will do the
655 index comparison to the filesystem data in parallel, allowing
656 overlapping IO's. Defaults to true.
659 You can set this to 'link', in which case a hardlink followed by
660 a delete of the source are used to make sure that object creation
661 will not overwrite existing objects.
663 On some file system/operating system combinations, this is unreliable.
664 Set this config setting to 'rename' there; However, This will remove the
665 check that makes sure that existing object files will not get overwritten.
668 When showing commit messages, also show notes which are stored in
669 the given ref. The ref must be fully qualified. If the given
670 ref does not exist, it is not an error but means that no
671 notes should be printed.
673 This setting defaults to "refs/notes/commits", and it can be overridden by
674 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
676 core.sparseCheckout::
677 Enable "sparse checkout" feature. See section "Sparse checkout" in
678 linkgit:git-read-tree[1] for more information.
681 Set the length object names are abbreviated to. If unspecified,
682 many commands abbreviate to 7 hexdigits, which may not be enough
683 for abbreviated object names to stay unique for sufficiently long
688 Tells 'git add' to continue adding files when some files cannot be
689 added due to indexing errors. Equivalent to the '--ignore-errors'
690 option of linkgit:git-add[1]. Older versions of Git accept only
691 `add.ignore-errors`, which does not follow the usual naming
692 convention for configuration variables. Newer versions of Git
693 honor `add.ignoreErrors` as well.
696 Command aliases for the linkgit:git[1] command wrapper - e.g.
697 after defining "alias.last = cat-file commit HEAD", the invocation
698 "git last" is equivalent to "git cat-file commit HEAD". To avoid
699 confusion and troubles with script usage, aliases that
700 hide existing Git commands are ignored. Arguments are split by
701 spaces, the usual shell quoting and escaping is supported.
702 A quote pair or a backslash can be used to quote them.
704 If the alias expansion is prefixed with an exclamation point,
705 it will be treated as a shell command. For example, defining
706 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
707 "git new" is equivalent to running the shell command
708 "gitk --all --not ORIG_HEAD". Note that shell commands will be
709 executed from the top-level directory of a repository, which may
710 not necessarily be the current directory.
711 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
712 from the original current directory. See linkgit:git-rev-parse[1].
715 If true, git-am will call git-mailsplit for patches in mbox format
716 with parameter '--keep-cr'. In this case git-mailsplit will
717 not remove `\r` from lines ending with `\r\n`. Can be overridden
718 by giving '--no-keep-cr' from the command line.
719 See linkgit:git-am[1], linkgit:git-mailsplit[1].
721 apply.ignorewhitespace::
722 When set to 'change', tells 'git apply' to ignore changes in
723 whitespace, in the same way as the '--ignore-space-change'
725 When set to one of: no, none, never, false tells 'git apply' to
726 respect all whitespace differences.
727 See linkgit:git-apply[1].
730 Tells 'git apply' how to handle whitespaces, in the same way
731 as the '--whitespace' option. See linkgit:git-apply[1].
733 branch.autosetupmerge::
734 Tells 'git branch' and 'git checkout' to set up new branches
735 so that linkgit:git-pull[1] will appropriately merge from the
736 starting point branch. Note that even if this option is not set,
737 this behavior can be chosen per-branch using the `--track`
738 and `--no-track` options. The valid settings are: `false` -- no
739 automatic setup is done; `true` -- automatic setup is done when the
740 starting point is a remote-tracking branch; `always` --
741 automatic setup is done when the starting point is either a
742 local branch or remote-tracking
743 branch. This option defaults to true.
745 branch.autosetuprebase::
746 When a new branch is created with 'git branch' or 'git checkout'
747 that tracks another branch, this variable tells Git to set
748 up pull to rebase instead of merge (see "branch.<name>.rebase").
749 When `never`, rebase is never automatically set to true.
750 When `local`, rebase is set to true for tracked branches of
751 other local branches.
752 When `remote`, rebase is set to true for tracked branches of
753 remote-tracking branches.
754 When `always`, rebase will be set to true for all tracking
756 See "branch.autosetupmerge" for details on how to set up a
757 branch to track another branch.
758 This option defaults to never.
760 branch.<name>.remote::
761 When on branch <name>, it tells 'git fetch' and 'git push'
762 which remote to fetch from/push to. The remote to push to
763 may be overridden with `remote.pushdefault` (for all branches).
764 The remote to push to, for the current branch, may be further
765 overridden by `branch.<name>.pushremote`. If no remote is
766 configured, or if you are not on any branch, it defaults to
767 `origin` for fetching and `remote.pushdefault` for pushing.
768 Additionally, `.` (a period) is the current local repository
769 (a dot-repository), see `branch.<name>.merge`'s final note below.
771 branch.<name>.pushremote::
772 When on branch <name>, it overrides `branch.<name>.remote` for
773 pushing. It also overrides `remote.pushdefault` for pushing
774 from branch <name>. When you pull from one place (e.g. your
775 upstream) and push to another place (e.g. your own publishing
776 repository), you would want to set `remote.pushdefault` to
777 specify the remote to push to for all branches, and use this
778 option to override it for a specific branch.
780 branch.<name>.merge::
781 Defines, together with branch.<name>.remote, the upstream branch
782 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
783 branch to merge and can also affect 'git push' (see push.default).
784 When in branch <name>, it tells 'git fetch' the default
785 refspec to be marked for merging in FETCH_HEAD. The value is
786 handled like the remote part of a refspec, and must match a
787 ref which is fetched from the remote given by
788 "branch.<name>.remote".
789 The merge information is used by 'git pull' (which at first calls
790 'git fetch') to lookup the default branch for merging. Without
791 this option, 'git pull' defaults to merge the first refspec fetched.
792 Specify multiple values to get an octopus merge.
793 If you wish to setup 'git pull' so that it merges into <name> from
794 another branch in the local repository, you can point
795 branch.<name>.merge to the desired branch, and use the relative path
796 setting `.` (a period) for branch.<name>.remote.
798 branch.<name>.mergeoptions::
799 Sets default options for merging into branch <name>. The syntax and
800 supported options are the same as those of linkgit:git-merge[1], but
801 option values containing whitespace characters are currently not
804 branch.<name>.rebase::
805 When true, rebase the branch <name> on top of the fetched branch,
806 instead of merging the default branch from the default remote when
807 "git pull" is run. See "pull.rebase" for doing this in a non
808 branch-specific manner.
810 When preserve, also pass `--preserve-merges` along to 'git rebase'
811 so that locally committed merge commits will not be flattened
812 by running 'git pull'.
814 *NOTE*: this is a possibly dangerous operation; do *not* use
815 it unless you understand the implications (see linkgit:git-rebase[1]
818 branch.<name>.description::
819 Branch description, can be edited with
820 `git branch --edit-description`. Branch description is
821 automatically added in the format-patch cover letter or
822 request-pull summary.
825 Specify the command to invoke the specified browser. The
826 specified command is evaluated in shell with the URLs passed
827 as arguments. (See linkgit:git-web{litdd}browse[1].)
829 browser.<tool>.path::
830 Override the path for the given tool that may be used to
831 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
832 working repository in gitweb (see linkgit:git-instaweb[1]).
835 A boolean to make git-clean do nothing unless given -f,
836 -i or -n. Defaults to true.
839 A boolean to enable/disable color in the output of
840 linkgit:git-branch[1]. May be set to `always`,
841 `false` (or `never`) or `auto` (or `true`), in which case colors are used
842 only when the output is to a terminal. Defaults to false.
844 color.branch.<slot>::
845 Use customized color for branch coloration. `<slot>` is one of
846 `current` (the current branch), `local` (a local branch),
847 `remote` (a remote-tracking branch in refs/remotes/),
848 `upstream` (upstream tracking branch), `plain` (other
851 The value for these configuration variables is a list of colors (at most
852 two) and attributes (at most one), separated by spaces. The colors
853 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
854 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
855 `blink` and `reverse`. The first color given is the foreground; the
856 second is the background. The position of the attribute, if any,
857 doesn't matter. Attributes may be turned off specifically by prefixing
858 them with `no` (e.g., `noreverse`, `noul`, etc).
860 Colors (foreground and background) may also be given as numbers between
861 0 and 255; these use ANSI 256-color mode (but note that not all
862 terminals may support this). If your terminal supports it, you may also
863 specify 24-bit RGB values as hex, like `#ff0ab3`.
866 Whether to use ANSI escape sequences to add color to patches.
867 If this is set to `always`, linkgit:git-diff[1],
868 linkgit:git-log[1], and linkgit:git-show[1] will use color
869 for all patches. If it is set to `true` or `auto`, those
870 commands will only use color when output is to the terminal.
873 This does not affect linkgit:git-format-patch[1] or the
874 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
875 command line with the `--color[=<when>]` option.
878 Use customized color for diff colorization. `<slot>` specifies
879 which part of the patch to use the specified color, and is one
880 of `plain` (context text), `meta` (metainformation), `frag`
881 (hunk header), 'func' (function in hunk header), `old` (removed lines),
882 `new` (added lines), `commit` (commit headers), or `whitespace`
883 (highlighting whitespace errors). The values of these variables may be
884 specified as in color.branch.<slot>.
886 color.decorate.<slot>::
887 Use customized color for 'git log --decorate' output. `<slot>` is one
888 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
889 branches, remote-tracking branches, tags, stash and HEAD, respectively.
892 When set to `always`, always highlight matches. When `false` (or
893 `never`), never. When set to `true` or `auto`, use color only
894 when the output is written to the terminal. Defaults to `false`.
897 Use customized color for grep colorization. `<slot>` specifies which
898 part of the line to use the specified color, and is one of
902 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
904 filename prefix (when not using `-h`)
906 function name lines (when using `-p`)
908 line number prefix (when using `-n`)
910 matching text (same as setting `matchContext` and `matchSelected`)
912 matching text in context lines
914 matching text in selected lines
916 non-matching text in selected lines
918 separators between fields on a line (`:`, `-`, and `=`)
919 and between hunks (`--`)
922 The values of these variables may be specified as in color.branch.<slot>.
925 When set to `always`, always use colors for interactive prompts
926 and displays (such as those used by "git-add --interactive" and
927 "git-clean --interactive"). When false (or `never`), never.
928 When set to `true` or `auto`, use colors only when the output is
929 to the terminal. Defaults to false.
931 color.interactive.<slot>::
932 Use customized color for 'git add --interactive' and 'git clean
933 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
934 or `error`, for four distinct types of normal output from
935 interactive commands. The values of these variables may be
936 specified as in color.branch.<slot>.
939 A boolean to enable/disable colored output when the pager is in
940 use (default is true).
943 A boolean to enable/disable color in the output of
944 linkgit:git-show-branch[1]. May be set to `always`,
945 `false` (or `never`) or `auto` (or `true`), in which case colors are used
946 only when the output is to a terminal. Defaults to false.
949 A boolean to enable/disable color in the output of
950 linkgit:git-status[1]. May be set to `always`,
951 `false` (or `never`) or `auto` (or `true`), in which case colors are used
952 only when the output is to a terminal. Defaults to false.
954 color.status.<slot>::
955 Use customized color for status colorization. `<slot>` is
956 one of `header` (the header text of the status message),
957 `added` or `updated` (files which are added but not committed),
958 `changed` (files which are changed but not added in the index),
959 `untracked` (files which are not tracked by Git),
960 `branch` (the current branch),
961 `nobranch` (the color the 'no branch' warning is shown in, defaulting
963 `unmerged` (files which have unmerged changes).
964 The values of these variables may be specified as in
968 This variable determines the default value for variables such
969 as `color.diff` and `color.grep` that control the use of color
970 per command family. Its scope will expand as more commands learn
971 configuration to set a default for the `--color` option. Set it
972 to `false` or `never` if you prefer Git commands not to use
973 color unless enabled explicitly with some other configuration
974 or the `--color` option. Set it to `always` if you want all
975 output not intended for machine consumption to use color, to
976 `true` or `auto` (this is the default since Git 1.8.4) if you
977 want such output to use color when written to the terminal.
980 Specify whether supported commands should output in columns.
981 This variable consists of a list of tokens separated by spaces
984 These options control when the feature should be enabled
985 (defaults to 'never'):
989 always show in columns
991 never show in columns
993 show in columns if the output is to the terminal
996 These options control layout (defaults to 'column'). Setting any
997 of these implies 'always' if none of 'always', 'never', or 'auto' are
1002 fill columns before rows
1004 fill rows before columns
1009 Finally, these options can be combined with a layout option (defaults
1014 make unequal size columns to utilize more space
1016 make equal size columns
1020 Specify whether to output branch listing in `git branch` in columns.
1021 See `column.ui` for details.
1024 Specify the layout when list items in `git clean -i`, which always
1025 shows files and directories in columns. See `column.ui` for details.
1028 Specify whether to output untracked files in `git status` in columns.
1029 See `column.ui` for details.
1032 Specify whether to output tag listing in `git tag` in columns.
1033 See `column.ui` for details.
1036 This setting overrides the default of the `--cleanup` option in
1037 `git commit`. See linkgit:git-commit[1] for details. Changing the
1038 default can be useful when you always want to keep lines that begin
1039 with comment character `#` in your log message, in which case you
1040 would do `git config commit.cleanup whitespace` (note that you will
1041 have to remove the help lines that begin with `#` in the commit log
1042 template yourself, if you do this).
1046 A boolean to specify whether all commits should be GPG signed.
1047 Use of this option when doing operations such as rebase can
1048 result in a large number of commits being signed. It may be
1049 convenient to use an agent to avoid typing your GPG passphrase
1053 A boolean to enable/disable inclusion of status information in the
1054 commit message template when using an editor to prepare the commit
1055 message. Defaults to true.
1058 Specify a file to use as the template for new commit messages.
1059 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1060 specified user's home directory.
1063 Specify an external helper to be called when a username or
1064 password credential is needed; the helper may consult external
1065 storage to avoid prompting the user for the credentials. See
1066 linkgit:gitcredentials[7] for details.
1068 credential.useHttpPath::
1069 When acquiring credentials, consider the "path" component of an http
1070 or https URL to be important. Defaults to false. See
1071 linkgit:gitcredentials[7] for more information.
1073 credential.username::
1074 If no username is set for a network authentication, use this username
1075 by default. See credential.<context>.* below, and
1076 linkgit:gitcredentials[7].
1078 credential.<url>.*::
1079 Any of the credential.* options above can be applied selectively to
1080 some credentials. For example "credential.https://example.com.username"
1081 would set the default username only for https connections to
1082 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1085 include::diff-config.txt[]
1087 difftool.<tool>.path::
1088 Override the path for the given tool. This is useful in case
1089 your tool is not in the PATH.
1091 difftool.<tool>.cmd::
1092 Specify the command to invoke the specified diff tool.
1093 The specified command is evaluated in shell with the following
1094 variables available: 'LOCAL' is set to the name of the temporary
1095 file containing the contents of the diff pre-image and 'REMOTE'
1096 is set to the name of the temporary file containing the contents
1097 of the diff post-image.
1100 Prompt before each invocation of the diff tool.
1102 fetch.recurseSubmodules::
1103 This option can be either set to a boolean value or to 'on-demand'.
1104 Setting it to a boolean changes the behavior of fetch and pull to
1105 unconditionally recurse into submodules when set to true or to not
1106 recurse at all when set to false. When set to 'on-demand' (the default
1107 value), fetch and pull will only recurse into a populated submodule
1108 when its superproject retrieves a commit that updates the submodule's
1112 If it is set to true, git-fetch-pack will check all fetched
1113 objects. It will abort in the case of a malformed object or a
1114 broken link. The result of an abort are only dangling objects.
1115 Defaults to false. If not set, the value of `transfer.fsckObjects`
1119 If the number of objects fetched over the Git native
1120 transfer is below this
1121 limit, then the objects will be unpacked into loose object
1122 files. However if the number of received objects equals or
1123 exceeds this limit then the received pack will be stored as
1124 a pack, after adding any missing delta bases. Storing the
1125 pack from a push can make the push operation complete faster,
1126 especially on slow filesystems. If not set, the value of
1127 `transfer.unpackLimit` is used instead.
1130 If true, fetch will automatically behave as if the `--prune`
1131 option was given on the command line. See also `remote.<name>.prune`.
1134 Enable multipart/mixed attachments as the default for
1135 'format-patch'. The value can also be a double quoted string
1136 which will enable attachments as the default and set the
1137 value as the boundary. See the --attach option in
1138 linkgit:git-format-patch[1].
1141 A boolean which can enable or disable sequence numbers in patch
1142 subjects. It defaults to "auto" which enables it only if there
1143 is more than one patch. It can be enabled or disabled for all
1144 messages by setting it to "true" or "false". See --numbered
1145 option in linkgit:git-format-patch[1].
1148 Additional email headers to include in a patch to be submitted
1149 by mail. See linkgit:git-format-patch[1].
1153 Additional recipients to include in a patch to be submitted
1154 by mail. See the --to and --cc options in
1155 linkgit:git-format-patch[1].
1157 format.subjectprefix::
1158 The default for format-patch is to output files with the '[PATCH]'
1159 subject prefix. Use this variable to change that prefix.
1162 The default for format-patch is to output a signature containing
1163 the Git version number. Use this variable to change that default.
1164 Set this variable to the empty string ("") to suppress
1165 signature generation.
1167 format.signaturefile::
1168 Works just like format.signature except the contents of the
1169 file specified by this variable will be used as the signature.
1172 The default for format-patch is to output files with the suffix
1173 `.patch`. Use this variable to change that suffix (make sure to
1174 include the dot if you want it).
1177 The default pretty format for log/show/whatchanged command,
1178 See linkgit:git-log[1], linkgit:git-show[1],
1179 linkgit:git-whatchanged[1].
1182 The default threading style for 'git format-patch'. Can be
1183 a boolean value, or `shallow` or `deep`. `shallow` threading
1184 makes every mail a reply to the head of the series,
1185 where the head is chosen from the cover letter, the
1186 `--in-reply-to`, and the first patch mail, in this order.
1187 `deep` threading makes every mail a reply to the previous one.
1188 A true boolean value is the same as `shallow`, and a false
1189 value disables threading.
1192 A boolean value which lets you enable the `-s/--signoff` option of
1193 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1194 patch should be a conscious act and means that you certify you have
1195 the rights to submit this work under the same open source license.
1196 Please see the 'SubmittingPatches' document for further discussion.
1198 format.coverLetter::
1199 A boolean that controls whether to generate a cover-letter when
1200 format-patch is invoked, but in addition can be set to "auto", to
1201 generate a cover-letter only when there's more than one patch.
1203 filter.<driver>.clean::
1204 The command which is used to convert the content of a worktree
1205 file to a blob upon checkin. See linkgit:gitattributes[5] for
1208 filter.<driver>.smudge::
1209 The command which is used to convert the content of a blob
1210 object to a worktree file upon checkout. See
1211 linkgit:gitattributes[5] for details.
1213 gc.aggressiveDepth::
1214 The depth parameter used in the delta compression
1215 algorithm used by 'git gc --aggressive'. This defaults
1218 gc.aggressiveWindow::
1219 The window size parameter used in the delta compression
1220 algorithm used by 'git gc --aggressive'. This defaults
1224 When there are approximately more than this many loose
1225 objects in the repository, `git gc --auto` will pack them.
1226 Some Porcelain commands use this command to perform a
1227 light-weight garbage collection from time to time. The
1228 default value is 6700. Setting this to 0 disables it.
1231 When there are more than this many packs that are not
1232 marked with `*.keep` file in the repository, `git gc
1233 --auto` consolidates them into one larger pack. The
1234 default value is 50. Setting this to 0 disables it.
1237 Make `git gc --auto` return immediately and run in background
1238 if the system supports it. Default is true.
1241 Running `git pack-refs` in a repository renders it
1242 unclonable by Git versions prior to 1.5.1.2 over dumb
1243 transports such as HTTP. This variable determines whether
1244 'git gc' runs `git pack-refs`. This can be set to `notbare`
1245 to enable it within all non-bare repos or it can be set to a
1246 boolean value. The default is `true`.
1249 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1250 Override the grace period with this config variable. The value
1251 "now" may be used to disable this grace period and always prune
1252 unreachable objects immediately.
1255 gc.<pattern>.reflogexpire::
1256 'git reflog expire' removes reflog entries older than
1257 this time; defaults to 90 days. With "<pattern>" (e.g.
1258 "refs/stash") in the middle the setting applies only to
1259 the refs that match the <pattern>.
1261 gc.reflogexpireunreachable::
1262 gc.<ref>.reflogexpireunreachable::
1263 'git reflog expire' removes reflog entries older than
1264 this time and are not reachable from the current tip;
1265 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1266 in the middle, the setting applies only to the refs that
1267 match the <pattern>.
1270 Records of conflicted merge you resolved earlier are
1271 kept for this many days when 'git rerere gc' is run.
1272 The default is 60 days. See linkgit:git-rerere[1].
1274 gc.rerereunresolved::
1275 Records of conflicted merge you have not resolved are
1276 kept for this many days when 'git rerere gc' is run.
1277 The default is 15 days. See linkgit:git-rerere[1].
1279 gitcvs.commitmsgannotation::
1280 Append this string to each commit message. Set to empty string
1281 to disable this feature. Defaults to "via git-CVS emulator".
1284 Whether the CVS server interface is enabled for this repository.
1285 See linkgit:git-cvsserver[1].
1288 Path to a log file where the CVS server interface well... logs
1289 various stuff. See linkgit:git-cvsserver[1].
1291 gitcvs.usecrlfattr::
1292 If true, the server will look up the end-of-line conversion
1293 attributes for files to determine the '-k' modes to use. If
1294 the attributes force Git to treat a file as text,
1295 the '-k' mode will be left blank so CVS clients will
1296 treat it as text. If they suppress text conversion, the file
1297 will be set with '-kb' mode, which suppresses any newline munging
1298 the client might otherwise do. If the attributes do not allow
1299 the file type to be determined, then 'gitcvs.allbinary' is
1300 used. See linkgit:gitattributes[5].
1303 This is used if 'gitcvs.usecrlfattr' does not resolve
1304 the correct '-kb' mode to use. If true, all
1305 unresolved files are sent to the client in
1306 mode '-kb'. This causes the client to treat them
1307 as binary files, which suppresses any newline munging it
1308 otherwise might do. Alternatively, if it is set to "guess",
1309 then the contents of the file are examined to decide if
1310 it is binary, similar to 'core.autocrlf'.
1313 Database used by git-cvsserver to cache revision information
1314 derived from the Git repository. The exact meaning depends on the
1315 used database driver, for SQLite (which is the default driver) this
1316 is a filename. Supports variable substitution (see
1317 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1318 Default: '%Ggitcvs.%m.sqlite'
1321 Used Perl DBI driver. You can specify any available driver
1322 for this here, but it might not work. git-cvsserver is tested
1323 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1324 reported *not* to work with 'DBD::mysql'. Experimental feature.
1325 May not contain double colons (`:`). Default: 'SQLite'.
1326 See linkgit:git-cvsserver[1].
1328 gitcvs.dbuser, gitcvs.dbpass::
1329 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1330 since SQLite has no concept of database users and/or passwords.
1331 'gitcvs.dbuser' supports variable substitution (see
1332 linkgit:git-cvsserver[1] for details).
1334 gitcvs.dbTableNamePrefix::
1335 Database table name prefix. Prepended to the names of any
1336 database tables used, allowing a single database to be used
1337 for several repositories. Supports variable substitution (see
1338 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1339 characters will be replaced with underscores.
1341 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1342 'gitcvs.allbinary' can also be specified as
1343 'gitcvs.<access_method>.<varname>' (where 'access_method'
1344 is one of "ext" and "pserver") to make them apply only for the given
1348 gitweb.description::
1351 See linkgit:gitweb[1] for description.
1359 gitweb.remote_heads::
1362 See linkgit:gitweb.conf[5] for description.
1365 If set to true, enable '-n' option by default.
1368 Set the default matching behavior. Using a value of 'basic', 'extended',
1369 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1370 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1371 value 'default' will return to the default matching behavior.
1373 grep.extendedRegexp::
1374 If set to true, enable '--extended-regexp' option by default. This
1375 option is ignored when the 'grep.patternType' option is set to a value
1376 other than 'default'.
1379 Use this custom program instead of "gpg" found on $PATH when
1380 making or verifying a PGP signature. The program must support the
1381 same command-line interface as GPG, namely, to verify a detached
1382 signature, "gpg --verify $file - <$signature" is run, and the
1383 program is expected to signal a good signature by exiting with
1384 code 0, and to generate an ASCII-armored detached signature, the
1385 standard input of "gpg -bsau $key" is fed with the contents to be
1386 signed, and the program is expected to send the result to its
1389 gui.commitmsgwidth::
1390 Defines how wide the commit message window is in the
1391 linkgit:git-gui[1]. "75" is the default.
1394 Specifies how many context lines should be used in calls to diff
1395 made by the linkgit:git-gui[1]. The default is "5".
1397 gui.displayuntracked::
1398 Determines if linkgit::git-gui[1] shows untracked files
1399 in the file list. The default is "true".
1402 Specifies the default encoding to use for displaying of
1403 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1404 It can be overridden by setting the 'encoding' attribute
1405 for relevant files (see linkgit:gitattributes[5]).
1406 If this option is not set, the tools default to the
1409 gui.matchtrackingbranch::
1410 Determines if new branches created with linkgit:git-gui[1] should
1411 default to tracking remote branches with matching names or
1412 not. Default: "false".
1414 gui.newbranchtemplate::
1415 Is used as suggested name when creating new branches using the
1418 gui.pruneduringfetch::
1419 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1420 performing a fetch. The default value is "false".
1423 Determines if linkgit:git-gui[1] should trust the file modification
1424 timestamp or not. By default the timestamps are not trusted.
1426 gui.spellingdictionary::
1427 Specifies the dictionary used for spell checking commit messages in
1428 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1432 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1433 location detection. It makes blame significantly faster on huge
1434 repositories at the expense of less thorough copy detection.
1436 gui.copyblamethreshold::
1437 Specifies the threshold to use in 'git gui blame' original location
1438 detection, measured in alphanumeric characters. See the
1439 linkgit:git-blame[1] manual for more information on copy detection.
1441 gui.blamehistoryctx::
1442 Specifies the radius of history context in days to show in
1443 linkgit:gitk[1] for the selected commit, when the `Show History
1444 Context` menu item is invoked from 'git gui blame'. If this
1445 variable is set to zero, the whole history is shown.
1447 guitool.<name>.cmd::
1448 Specifies the shell command line to execute when the corresponding item
1449 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1450 mandatory for every tool. The command is executed from the root of
1451 the working directory, and in the environment it receives the name of
1452 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1453 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1454 the head is detached, 'CUR_BRANCH' is empty).
1456 guitool.<name>.needsfile::
1457 Run the tool only if a diff is selected in the GUI. It guarantees
1458 that 'FILENAME' is not empty.
1460 guitool.<name>.noconsole::
1461 Run the command silently, without creating a window to display its
1464 guitool.<name>.norescan::
1465 Don't rescan the working directory for changes after the tool
1468 guitool.<name>.confirm::
1469 Show a confirmation dialog before actually running the tool.
1471 guitool.<name>.argprompt::
1472 Request a string argument from the user, and pass it to the tool
1473 through the 'ARGS' environment variable. Since requesting an
1474 argument implies confirmation, the 'confirm' option has no effect
1475 if this is enabled. If the option is set to 'true', 'yes', or '1',
1476 the dialog uses a built-in generic prompt; otherwise the exact
1477 value of the variable is used.
1479 guitool.<name>.revprompt::
1480 Request a single valid revision from the user, and set the
1481 'REVISION' environment variable. In other aspects this option
1482 is similar to 'argprompt', and can be used together with it.
1484 guitool.<name>.revunmerged::
1485 Show only unmerged branches in the 'revprompt' subdialog.
1486 This is useful for tools similar to merge or rebase, but not
1487 for things like checkout or reset.
1489 guitool.<name>.title::
1490 Specifies the title to use for the prompt dialog. The default
1493 guitool.<name>.prompt::
1494 Specifies the general prompt string to display at the top of
1495 the dialog, before subsections for 'argprompt' and 'revprompt'.
1496 The default value includes the actual command.
1499 Specify the browser that will be used to display help in the
1500 'web' format. See linkgit:git-help[1].
1503 Override the default help format used by linkgit:git-help[1].
1504 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1505 the default. 'web' and 'html' are the same.
1508 Automatically correct and execute mistyped commands after
1509 waiting for the given number of deciseconds (0.1 sec). If more
1510 than one command can be deduced from the entered text, nothing
1511 will be executed. If the value of this option is negative,
1512 the corrected command will be executed immediately. If the
1513 value is 0 - the command will be just shown but not executed.
1514 This is the default.
1517 Specify the path where the HTML documentation resides. File system paths
1518 and URLs are supported. HTML pages will be prefixed with this path when
1519 help is displayed in the 'web' format. This defaults to the documentation
1520 path of your Git installation.
1523 Override the HTTP proxy, normally configured using the 'http_proxy',
1524 'https_proxy', and 'all_proxy' environment variables (see
1525 `curl(1)`). This can be overridden on a per-remote basis; see
1529 File containing previously stored cookie lines which should be used
1530 in the Git http session, if they match the server. The file format
1531 of the file to read cookies from should be plain HTTP headers or
1532 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1533 NOTE that the file specified with http.cookiefile is only used as
1534 input unless http.saveCookies is set.
1537 If set, store cookies received during requests to the file specified by
1538 http.cookiefile. Has no effect if http.cookiefile is unset.
1541 Whether to verify the SSL certificate when fetching or pushing
1542 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1546 File containing the SSL certificate when fetching or pushing
1547 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1551 File containing the SSL private key when fetching or pushing
1552 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1555 http.sslCertPasswordProtected::
1556 Enable Git's password prompt for the SSL certificate. Otherwise
1557 OpenSSL will prompt the user, possibly many times, if the
1558 certificate or private key is encrypted. Can be overridden by the
1559 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1562 File containing the certificates to verify the peer with when
1563 fetching or pushing over HTTPS. Can be overridden by the
1564 'GIT_SSL_CAINFO' environment variable.
1567 Path containing files with the CA certificates to verify the peer
1568 with when fetching or pushing over HTTPS. Can be overridden
1569 by the 'GIT_SSL_CAPATH' environment variable.
1572 Attempt to use AUTH SSL/TLS and encrypted data transfers
1573 when connecting via regular FTP protocol. This might be needed
1574 if the FTP server requires it for security reasons or you wish
1575 to connect securely whenever remote FTP server supports it.
1576 Default is false since it might trigger certificate verification
1577 errors on misconfigured servers.
1580 How many HTTP requests to launch in parallel. Can be overridden
1581 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1584 The number of curl sessions (counted across slots) to be kept across
1585 requests. They will not be ended with curl_easy_cleanup() until
1586 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1587 value will be capped at 1. Defaults to 1.
1590 Maximum size in bytes of the buffer used by smart HTTP
1591 transports when POSTing data to the remote system.
1592 For requests larger than this buffer size, HTTP/1.1 and
1593 Transfer-Encoding: chunked is used to avoid creating a
1594 massive pack file locally. Default is 1 MiB, which is
1595 sufficient for most requests.
1597 http.lowSpeedLimit, http.lowSpeedTime::
1598 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1599 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1600 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1601 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1604 A boolean which disables using of EPSV ftp command by curl.
1605 This can helpful with some "poor" ftp servers which don't
1606 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1607 environment variable. Default is false (curl will use EPSV).
1610 The HTTP USER_AGENT string presented to an HTTP server. The default
1611 value represents the version of the client Git such as git/1.7.1.
1612 This option allows you to override this value to a more common value
1613 such as Mozilla/4.0. This may be necessary, for instance, if
1614 connecting through a firewall that restricts HTTP connections to a set
1615 of common USER_AGENT strings (but not including those like git/1.7.1).
1616 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1619 Any of the http.* options above can be applied selectively to some URLs.
1620 For a config key to match a URL, each element of the config key is
1621 compared to that of the URL, in the following order:
1624 . Scheme (e.g., `https` in `https://example.com/`). This field
1625 must match exactly between the config key and the URL.
1627 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1628 This field must match exactly between the config key and the URL.
1630 . Port number (e.g., `8080` in `http://example.com:8080/`).
1631 This field must match exactly between the config key and the URL.
1632 Omitted port numbers are automatically converted to the correct
1633 default for the scheme before matching.
1635 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1636 path field of the config key must match the path field of the URL
1637 either exactly or as a prefix of slash-delimited path elements. This means
1638 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1639 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1640 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1641 key with just path `foo/`).
1643 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1644 the config key has a user name it must match the user name in the
1645 URL exactly. If the config key does not have a user name, that
1646 config key will match a URL with any user name (including none),
1647 but at a lower precedence than a config key with a user name.
1650 The list above is ordered by decreasing precedence; a URL that matches
1651 a config key's path is preferred to one that matches its user name. For example,
1652 if the URL is `https://user@example.com/foo/bar` a config key match of
1653 `https://example.com/foo` will be preferred over a config key match of
1654 `https://user@example.com`.
1656 All URLs are normalized before attempting any matching (the password part,
1657 if embedded in the URL, is always ignored for matching purposes) so that
1658 equivalent URLs that are simply spelled differently will match properly.
1659 Environment variable settings always override any matches. The URLs that are
1660 matched against are those given directly to Git commands. This means any URLs
1661 visited as a result of a redirection do not participate in matching.
1663 i18n.commitEncoding::
1664 Character encoding the commit messages are stored in; Git itself
1665 does not care per se, but this information is necessary e.g. when
1666 importing commits from emails or in the gitk graphical history
1667 browser (and possibly at other places in the future or in other
1668 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1670 i18n.logOutputEncoding::
1671 Character encoding the commit messages are converted to when
1672 running 'git log' and friends.
1675 The configuration variables in the 'imap' section are described
1676 in linkgit:git-imap-send[1].
1679 Specify the version with which new index files should be
1680 initialized. This does not affect existing repositories.
1683 Specify the directory from which templates will be copied.
1684 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1687 Specify the program that will be used to browse your working
1688 repository in gitweb. See linkgit:git-instaweb[1].
1691 The HTTP daemon command-line to start gitweb on your working
1692 repository. See linkgit:git-instaweb[1].
1695 If true the web server started by linkgit:git-instaweb[1] will
1696 be bound to the local IP (127.0.0.1).
1698 instaweb.modulepath::
1699 The default module path for linkgit:git-instaweb[1] to use
1700 instead of /usr/lib/apache2/modules. Only used if httpd
1704 The port number to bind the gitweb httpd to. See
1705 linkgit:git-instaweb[1].
1707 interactive.singlekey::
1708 In interactive commands, allow the user to provide one-letter
1709 input with a single key (i.e., without hitting enter).
1710 Currently this is used by the `--patch` mode of
1711 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1712 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1713 setting is silently ignored if portable keystroke input
1714 is not available; requires the Perl module Term::ReadKey.
1717 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1718 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1719 override this option with `--no-abbrev-commit`.
1722 Set the default date-time mode for the 'log' command.
1723 Setting a value for log.date is similar to using 'git log''s
1724 `--date` option. Possible values are `relative`, `local`,
1725 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1729 Print out the ref names of any commits that are shown by the log
1730 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1731 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1732 specified, the full ref name (including prefix) will be printed.
1733 This is the same as the log commands '--decorate' option.
1736 If true, the initial commit will be shown as a big creation event.
1737 This is equivalent to a diff against an empty tree.
1738 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1739 normally hide the root commit will now show it. True by default.
1742 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1743 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1746 The location of an augmenting mailmap file. The default
1747 mailmap, located in the root of the repository, is loaded
1748 first, then the mailmap file pointed to by this variable.
1749 The location of the mailmap file may be in a repository
1750 subdirectory, or somewhere outside of the repository itself.
1751 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1754 Like `mailmap.file`, but consider the value as a reference to a
1755 blob in the repository. If both `mailmap.file` and
1756 `mailmap.blob` are given, both are parsed, with entries from
1757 `mailmap.file` taking precedence. In a bare repository, this
1758 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1762 Specify the programs that may be used to display help in the
1763 'man' format. See linkgit:git-help[1].
1766 Specify the command to invoke the specified man viewer. The
1767 specified command is evaluated in shell with the man page
1768 passed as argument. (See linkgit:git-help[1].)
1771 Override the path for the given tool that may be used to
1772 display help in the 'man' format. See linkgit:git-help[1].
1774 include::merge-config.txt[]
1776 mergetool.<tool>.path::
1777 Override the path for the given tool. This is useful in case
1778 your tool is not in the PATH.
1780 mergetool.<tool>.cmd::
1781 Specify the command to invoke the specified merge tool. The
1782 specified command is evaluated in shell with the following
1783 variables available: 'BASE' is the name of a temporary file
1784 containing the common base of the files to be merged, if available;
1785 'LOCAL' is the name of a temporary file containing the contents of
1786 the file on the current branch; 'REMOTE' is the name of a temporary
1787 file containing the contents of the file from the branch being
1788 merged; 'MERGED' contains the name of the file to which the merge
1789 tool should write the results of a successful merge.
1791 mergetool.<tool>.trustExitCode::
1792 For a custom merge command, specify whether the exit code of
1793 the merge command can be used to determine whether the merge was
1794 successful. If this is not set to true then the merge target file
1795 timestamp is checked and the merge assumed to have been successful
1796 if the file has been updated, otherwise the user is prompted to
1797 indicate the success of the merge.
1799 mergetool.meld.hasOutput::
1800 Older versions of `meld` do not support the `--output` option.
1801 Git will attempt to detect whether `meld` supports `--output`
1802 by inspecting the output of `meld --help`. Configuring
1803 `mergetool.meld.hasOutput` will make Git skip these checks and
1804 use the configured value instead. Setting `mergetool.meld.hasOutput`
1805 to `true` tells Git to unconditionally use the `--output` option,
1806 and `false` avoids using `--output`.
1808 mergetool.keepBackup::
1809 After performing a merge, the original file with conflict markers
1810 can be saved as a file with a `.orig` extension. If this variable
1811 is set to `false` then this file is not preserved. Defaults to
1812 `true` (i.e. keep the backup files).
1814 mergetool.keepTemporaries::
1815 When invoking a custom merge tool, Git uses a set of temporary
1816 files to pass to the tool. If the tool returns an error and this
1817 variable is set to `true`, then these temporary files will be
1818 preserved, otherwise they will be removed after the tool has
1819 exited. Defaults to `false`.
1821 mergetool.writeToTemp::
1822 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1823 conflicting files in the worktree by default. Git will attempt
1824 to use a temporary directory for these files when set `true`.
1825 Defaults to `false`.
1828 Prompt before each invocation of the merge resolution program.
1831 The (fully qualified) refname from which to show notes when
1832 showing commit messages. The value of this variable can be set
1833 to a glob, in which case notes from all matching refs will be
1834 shown. You may also specify this configuration variable
1835 several times. A warning will be issued for refs that do not
1836 exist, but a glob that does not match any refs is silently
1839 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1840 environment variable, which must be a colon separated list of refs or
1843 The effective value of "core.notesRef" (possibly overridden by
1844 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1847 notes.rewrite.<command>::
1848 When rewriting commits with <command> (currently `amend` or
1849 `rebase`) and this variable is set to `true`, Git
1850 automatically copies your notes from the original to the
1851 rewritten commit. Defaults to `true`, but see
1852 "notes.rewriteRef" below.
1855 When copying notes during a rewrite (see the
1856 "notes.rewrite.<command>" option), determines what to do if
1857 the target commit already has a note. Must be one of
1858 `overwrite`, `concatenate`, or `ignore`. Defaults to
1861 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1862 environment variable.
1865 When copying notes during a rewrite, specifies the (fully
1866 qualified) ref whose notes should be copied. The ref may be a
1867 glob, in which case notes in all matching refs will be copied.
1868 You may also specify this configuration several times.
1870 Does not have a default value; you must configure this variable to
1871 enable note rewriting. Set it to `refs/notes/commits` to enable
1872 rewriting for the default commit notes.
1874 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1875 environment variable, which must be a colon separated list of refs or
1879 The size of the window used by linkgit:git-pack-objects[1] when no
1880 window size is given on the command line. Defaults to 10.
1883 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1884 maximum depth is given on the command line. Defaults to 50.
1887 The maximum size of memory that is consumed by each thread
1888 in linkgit:git-pack-objects[1] for pack window memory when
1889 no limit is given on the command line. The value can be
1890 suffixed with "k", "m", or "g". When left unconfigured (or
1891 set explicitly to 0), there will be no limit.
1894 An integer -1..9, indicating the compression level for objects
1895 in a pack file. -1 is the zlib default. 0 means no
1896 compression, and 1..9 are various speed/size tradeoffs, 9 being
1897 slowest. If not set, defaults to core.compression. If that is
1898 not set, defaults to -1, the zlib default, which is "a default
1899 compromise between speed and compression (currently equivalent
1902 Note that changing the compression level will not automatically recompress
1903 all existing objects. You can force recompression by passing the -F option
1904 to linkgit:git-repack[1].
1906 pack.deltaCacheSize::
1907 The maximum memory in bytes used for caching deltas in
1908 linkgit:git-pack-objects[1] before writing them out to a pack.
1909 This cache is used to speed up the writing object phase by not
1910 having to recompute the final delta result once the best match
1911 for all objects is found. Repacking large repositories on machines
1912 which are tight with memory might be badly impacted by this though,
1913 especially if this cache pushes the system into swapping.
1914 A value of 0 means no limit. The smallest size of 1 byte may be
1915 used to virtually disable this cache. Defaults to 256 MiB.
1917 pack.deltaCacheLimit::
1918 The maximum size of a delta, that is cached in
1919 linkgit:git-pack-objects[1]. This cache is used to speed up the
1920 writing object phase by not having to recompute the final delta
1921 result once the best match for all objects is found. Defaults to 1000.
1924 Specifies the number of threads to spawn when searching for best
1925 delta matches. This requires that linkgit:git-pack-objects[1]
1926 be compiled with pthreads otherwise this option is ignored with a
1927 warning. This is meant to reduce packing time on multiprocessor
1928 machines. The required amount of memory for the delta search window
1929 is however multiplied by the number of threads.
1930 Specifying 0 will cause Git to auto-detect the number of CPU's
1931 and set the number of threads accordingly.
1934 Specify the default pack index version. Valid values are 1 for
1935 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1936 the new pack index with capabilities for packs larger than 4 GB
1937 as well as proper protection against the repacking of corrupted
1938 packs. Version 2 is the default. Note that version 2 is enforced
1939 and this config option ignored whenever the corresponding pack is
1942 If you have an old Git that does not understand the version 2 `*.idx` file,
1943 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1944 that will copy both `*.pack` file and corresponding `*.idx` file from the
1945 other side may give you a repository that cannot be accessed with your
1946 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1947 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1950 pack.packSizeLimit::
1951 The maximum size of a pack. This setting only affects
1952 packing to a file when repacking, i.e. the git:// protocol
1953 is unaffected. It can be overridden by the `--max-pack-size`
1954 option of linkgit:git-repack[1]. The minimum size allowed is
1955 limited to 1 MiB. The default is unlimited.
1956 Common unit suffixes of 'k', 'm', or 'g' are
1960 When true, git will use pack bitmaps (if available) when packing
1961 to stdout (e.g., during the server side of a fetch). Defaults to
1962 true. You should not generally need to turn this off unless
1963 you are debugging pack bitmaps.
1966 This is a deprecated synonym for `repack.writeBitmaps`.
1968 pack.writeBitmapHashCache::
1969 When true, git will include a "hash cache" section in the bitmap
1970 index (if one is written). This cache can be used to feed git's
1971 delta heuristics, potentially leading to better deltas between
1972 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1973 between an older, bitmapped pack and objects that have been
1974 pushed since the last gc). The downside is that it consumes 4
1975 bytes per object of disk space, and that JGit's bitmap
1976 implementation does not understand it, causing it to complain if
1977 Git and JGit are used on the same repository. Defaults to false.
1980 If the value is boolean, turns on or off pagination of the
1981 output of a particular Git subcommand when writing to a tty.
1982 Otherwise, turns on pagination for the subcommand using the
1983 pager specified by the value of `pager.<cmd>`. If `--paginate`
1984 or `--no-pager` is specified on the command line, it takes
1985 precedence over this option. To disable pagination for all
1986 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1989 Alias for a --pretty= format string, as specified in
1990 linkgit:git-log[1]. Any aliases defined here can be used just
1991 as the built-in pretty formats could. For example,
1992 running `git config pretty.changelog "format:* %H %s"`
1993 would cause the invocation `git log --pretty=changelog`
1994 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1995 Note that an alias with the same name as a built-in format
1996 will be silently ignored.
1999 By default, Git does not create an extra merge commit when merging
2000 a commit that is a descendant of the current commit. Instead, the
2001 tip of the current branch is fast-forwarded. When set to `false`,
2002 this variable tells Git to create an extra merge commit in such
2003 a case (equivalent to giving the `--no-ff` option from the command
2004 line). When set to `only`, only such fast-forward merges are
2005 allowed (equivalent to giving the `--ff-only` option from the
2009 When true, rebase branches on top of the fetched branch, instead
2010 of merging the default branch from the default remote when "git
2011 pull" is run. See "branch.<name>.rebase" for setting this on a
2014 When preserve, also pass `--preserve-merges` along to 'git rebase'
2015 so that locally committed merge commits will not be flattened
2016 by running 'git pull'.
2018 *NOTE*: this is a possibly dangerous operation; do *not* use
2019 it unless you understand the implications (see linkgit:git-rebase[1]
2023 The default merge strategy to use when pulling multiple branches
2027 The default merge strategy to use when pulling a single branch.
2030 Defines the action `git push` should take if no refspec is
2031 explicitly given. Different values are well-suited for
2032 specific workflows; for instance, in a purely central workflow
2033 (i.e. the fetch source is equal to the push destination),
2034 `upstream` is probably what you want. Possible values are:
2038 * `nothing` - do not push anything (error out) unless a refspec is
2039 explicitly given. This is primarily meant for people who want to
2040 avoid mistakes by always being explicit.
2042 * `current` - push the current branch to update a branch with the same
2043 name on the receiving end. Works in both central and non-central
2046 * `upstream` - push the current branch back to the branch whose
2047 changes are usually integrated into the current branch (which is
2048 called `@{upstream}`). This mode only makes sense if you are
2049 pushing to the same repository you would normally pull from
2050 (i.e. central workflow).
2052 * `simple` - in centralized workflow, work like `upstream` with an
2053 added safety to refuse to push if the upstream branch's name is
2054 different from the local one.
2056 When pushing to a remote that is different from the remote you normally
2057 pull from, work as `current`. This is the safest option and is suited
2060 This mode has become the default in Git 2.0.
2062 * `matching` - push all branches having the same name on both ends.
2063 This makes the repository you are pushing to remember the set of
2064 branches that will be pushed out (e.g. if you always push 'maint'
2065 and 'master' there and no other branches, the repository you push
2066 to will have these two branches, and your local 'maint' and
2067 'master' will be pushed there).
2069 To use this mode effectively, you have to make sure _all_ the
2070 branches you would push out are ready to be pushed out before
2071 running 'git push', as the whole point of this mode is to allow you
2072 to push all of the branches in one go. If you usually finish work
2073 on only one branch and push out the result, while other branches are
2074 unfinished, this mode is not for you. Also this mode is not
2075 suitable for pushing into a shared central repository, as other
2076 people may add new branches there, or update the tip of existing
2077 branches outside your control.
2079 This used to be the default, but not since Git 2.0 (`simple` is the
2085 Whether to show a diffstat of what changed upstream since the last
2086 rebase. False by default.
2089 If set to true enable '--autosquash' option by default.
2092 When set to true, automatically create a temporary stash
2093 before the operation begins, and apply it after the operation
2094 ends. This means that you can run rebase on a dirty worktree.
2095 However, use with care: the final stash application after a
2096 successful rebase might result in non-trivial conflicts.
2100 By default, git-receive-pack will run "git-gc --auto" after
2101 receiving data from git-push and updating refs. You can stop
2102 it by setting this variable to false.
2104 receive.certnonceseed::
2105 By setting this variable to a string, `git receive-pack`
2106 will accept a `git push --signed` and verifies it by using
2107 a "nonce" protected by HMAC using this string as a secret
2110 receive.certnonceslop::
2111 When a `git push --signed` sent a push certificate with a
2112 "nonce" that was issued by a receive-pack serving the same
2113 repository within this many seconds, export the "nonce"
2114 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2115 hooks (instead of what the receive-pack asked the sending
2116 side to include). This may allow writing checks in
2117 `pre-receive` and `post-receive` a bit easier. Instead of
2118 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2119 that records by how many seconds the nonce is stale to
2120 decide if they want to accept the certificate, they only
2121 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2123 receive.fsckObjects::
2124 If it is set to true, git-receive-pack will check all received
2125 objects. It will abort in the case of a malformed object or a
2126 broken link. The result of an abort are only dangling objects.
2127 Defaults to false. If not set, the value of `transfer.fsckObjects`
2130 receive.unpackLimit::
2131 If the number of objects received in a push is below this
2132 limit then the objects will be unpacked into loose object
2133 files. However if the number of received objects equals or
2134 exceeds this limit then the received pack will be stored as
2135 a pack, after adding any missing delta bases. Storing the
2136 pack from a push can make the push operation complete faster,
2137 especially on slow filesystems. If not set, the value of
2138 `transfer.unpackLimit` is used instead.
2140 receive.denyDeletes::
2141 If set to true, git-receive-pack will deny a ref update that deletes
2142 the ref. Use this to prevent such a ref deletion via a push.
2144 receive.denyDeleteCurrent::
2145 If set to true, git-receive-pack will deny a ref update that
2146 deletes the currently checked out branch of a non-bare repository.
2148 receive.denyCurrentBranch::
2149 If set to true or "refuse", git-receive-pack will deny a ref update
2150 to the currently checked out branch of a non-bare repository.
2151 Such a push is potentially dangerous because it brings the HEAD
2152 out of sync with the index and working tree. If set to "warn",
2153 print a warning of such a push to stderr, but allow the push to
2154 proceed. If set to false or "ignore", allow such pushes with no
2155 message. Defaults to "refuse".
2157 Another option is "updateInstead" which will update the working
2158 directory (must be clean) if pushing into the current branch. This option is
2159 intended for synchronizing working directories when one side is not easily
2160 accessible via interactive ssh (e.g. a live web site, hence the requirement
2161 that the working directory be clean). This mode also comes in handy when
2162 developing inside a VM to test and fix code on different Operating Systems.
2164 receive.denyNonFastForwards::
2165 If set to true, git-receive-pack will deny a ref update which is
2166 not a fast-forward. Use this to prevent such an update via a push,
2167 even if that push is forced. This configuration variable is
2168 set when initializing a shared repository.
2171 String(s) `receive-pack` uses to decide which refs to omit
2172 from its initial advertisement. Use more than one
2173 definitions to specify multiple prefix strings. A ref that
2174 are under the hierarchies listed on the value of this
2175 variable is excluded, and is hidden when responding to `git
2176 push`, and an attempt to update or delete a hidden ref by
2177 `git push` is rejected.
2179 receive.updateserverinfo::
2180 If set to true, git-receive-pack will run git-update-server-info
2181 after receiving data from git-push and updating refs.
2183 receive.shallowupdate::
2184 If set to true, .git/shallow can be updated when new refs
2185 require new shallow roots. Otherwise those refs are rejected.
2187 remote.pushdefault::
2188 The remote to push to by default. Overrides
2189 `branch.<name>.remote` for all branches, and is overridden by
2190 `branch.<name>.pushremote` for specific branches.
2193 The URL of a remote repository. See linkgit:git-fetch[1] or
2194 linkgit:git-push[1].
2196 remote.<name>.pushurl::
2197 The push URL of a remote repository. See linkgit:git-push[1].
2199 remote.<name>.proxy::
2200 For remotes that require curl (http, https and ftp), the URL to
2201 the proxy to use for that remote. Set to the empty string to
2202 disable proxying for that remote.
2204 remote.<name>.fetch::
2205 The default set of "refspec" for linkgit:git-fetch[1]. See
2206 linkgit:git-fetch[1].
2208 remote.<name>.push::
2209 The default set of "refspec" for linkgit:git-push[1]. See
2210 linkgit:git-push[1].
2212 remote.<name>.mirror::
2213 If true, pushing to this remote will automatically behave
2214 as if the `--mirror` option was given on the command line.
2216 remote.<name>.skipDefaultUpdate::
2217 If true, this remote will be skipped by default when updating
2218 using linkgit:git-fetch[1] or the `update` subcommand of
2219 linkgit:git-remote[1].
2221 remote.<name>.skipFetchAll::
2222 If true, this remote will be skipped by default when updating
2223 using linkgit:git-fetch[1] or the `update` subcommand of
2224 linkgit:git-remote[1].
2226 remote.<name>.receivepack::
2227 The default program to execute on the remote side when pushing. See
2228 option \--receive-pack of linkgit:git-push[1].
2230 remote.<name>.uploadpack::
2231 The default program to execute on the remote side when fetching. See
2232 option \--upload-pack of linkgit:git-fetch-pack[1].
2234 remote.<name>.tagopt::
2235 Setting this value to \--no-tags disables automatic tag following when
2236 fetching from remote <name>. Setting it to \--tags will fetch every
2237 tag from remote <name>, even if they are not reachable from remote
2238 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2239 override this setting. See options \--tags and \--no-tags of
2240 linkgit:git-fetch[1].
2243 Setting this to a value <vcs> will cause Git to interact with
2244 the remote with the git-remote-<vcs> helper.
2246 remote.<name>.prune::
2247 When set to true, fetching from this remote by default will also
2248 remove any remote-tracking references that no longer exist on the
2249 remote (as if the `--prune` option was given on the command line).
2250 Overrides `fetch.prune` settings, if any.
2253 The list of remotes which are fetched by "git remote update
2254 <group>". See linkgit:git-remote[1].
2256 repack.usedeltabaseoffset::
2257 By default, linkgit:git-repack[1] creates packs that use
2258 delta-base offset. If you need to share your repository with
2259 Git older than version 1.4.4, either directly or via a dumb
2260 protocol such as http, then you need to set this option to
2261 "false" and repack. Access from old Git versions over the
2262 native protocol are unaffected by this option.
2264 repack.packKeptObjects::
2265 If set to true, makes `git repack` act as if
2266 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2267 details. Defaults to `false` normally, but `true` if a bitmap
2268 index is being written (either via `--write-bitmap-index` or
2269 `repack.writeBitmaps`).
2271 repack.writeBitmaps::
2272 When true, git will write a bitmap index when packing all
2273 objects to disk (e.g., when `git repack -a` is run). This
2274 index can speed up the "counting objects" phase of subsequent
2275 packs created for clones and fetches, at the cost of some disk
2276 space and extra time spent on the initial repack. Defaults to
2280 When set to true, `git-rerere` updates the index with the
2281 resulting contents after it cleanly resolves conflicts using
2282 previously recorded resolution. Defaults to false.
2285 Activate recording of resolved conflicts, so that identical
2286 conflict hunks can be resolved automatically, should they be
2287 encountered again. By default, linkgit:git-rerere[1] is
2288 enabled if there is an `rr-cache` directory under the
2289 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2292 sendemail.identity::
2293 A configuration identity. When given, causes values in the
2294 'sendemail.<identity>' subsection to take precedence over
2295 values in the 'sendemail' section. The default identity is
2296 the value of 'sendemail.identity'.
2298 sendemail.smtpencryption::
2299 See linkgit:git-send-email[1] for description. Note that this
2300 setting is not subject to the 'identity' mechanism.
2303 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2305 sendemail.smtpsslcertpath::
2306 Path to ca-certificates (either a directory or a single file).
2307 Set it to an empty string to disable certificate verification.
2309 sendemail.<identity>.*::
2310 Identity-specific versions of the 'sendemail.*' parameters
2311 found below, taking precedence over those when the this
2312 identity is selected, through command-line or
2313 'sendemail.identity'.
2315 sendemail.aliasesfile::
2316 sendemail.aliasfiletype::
2317 sendemail.annotate::
2321 sendemail.chainreplyto::
2323 sendemail.envelopesender::
2325 sendemail.multiedit::
2326 sendemail.signedoffbycc::
2327 sendemail.smtppass::
2328 sendemail.suppresscc::
2329 sendemail.suppressfrom::
2331 sendemail.smtpdomain::
2332 sendemail.smtpserver::
2333 sendemail.smtpserverport::
2334 sendemail.smtpserveroption::
2335 sendemail.smtpuser::
2337 sendemail.transferencoding::
2338 sendemail.validate::
2340 See linkgit:git-send-email[1] for description.
2342 sendemail.signedoffcc::
2343 Deprecated alias for 'sendemail.signedoffbycc'.
2345 showbranch.default::
2346 The default set of branches for linkgit:git-show-branch[1].
2347 See linkgit:git-show-branch[1].
2349 status.relativePaths::
2350 By default, linkgit:git-status[1] shows paths relative to the
2351 current directory. Setting this variable to `false` shows paths
2352 relative to the repository root (this was the default for Git
2356 Set to true to enable --short by default in linkgit:git-status[1].
2357 The option --no-short takes precedence over this variable.
2360 Set to true to enable --branch by default in linkgit:git-status[1].
2361 The option --no-branch takes precedence over this variable.
2363 status.displayCommentPrefix::
2364 If set to true, linkgit:git-status[1] will insert a comment
2365 prefix before each output line (starting with
2366 `core.commentChar`, i.e. `#` by default). This was the
2367 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2370 status.showUntrackedFiles::
2371 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2372 files which are not currently tracked by Git. Directories which
2373 contain only untracked files, are shown with the directory name
2374 only. Showing untracked files means that Git needs to lstat() all
2375 the files in the whole repository, which might be slow on some
2376 systems. So, this variable controls how the commands displays
2377 the untracked files. Possible values are:
2380 * `no` - Show no untracked files.
2381 * `normal` - Show untracked files and directories.
2382 * `all` - Show also individual files in untracked directories.
2385 If this variable is not specified, it defaults to 'normal'.
2386 This variable can be overridden with the -u|--untracked-files option
2387 of linkgit:git-status[1] and linkgit:git-commit[1].
2389 status.submodulesummary::
2391 If this is set to a non zero number or true (identical to -1 or an
2392 unlimited number), the submodule summary will be enabled and a
2393 summary of commits for modified submodules will be shown (see
2394 --summary-limit option of linkgit:git-submodule[1]). Please note
2395 that the summary output command will be suppressed for all
2396 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2397 for those submodules where `submodule.<name>.ignore=all`. The only
2398 exception to that rule is that status and commit will show staged
2399 submodule changes. To
2400 also view the summary for ignored submodules you can either use
2401 the --ignore-submodules=dirty command-line option or the 'git
2402 submodule summary' command, which shows a similar output but does
2403 not honor these settings.
2405 submodule.<name>.path::
2406 submodule.<name>.url::
2407 submodule.<name>.update::
2408 The path within this project, URL, and the updating strategy
2409 for a submodule. These variables are initially populated
2410 by 'git submodule init'; edit them to override the
2411 URL and other values found in the `.gitmodules` file. See
2412 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2414 submodule.<name>.branch::
2415 The remote branch name for a submodule, used by `git submodule
2416 update --remote`. Set this option to override the value found in
2417 the `.gitmodules` file. See linkgit:git-submodule[1] and
2418 linkgit:gitmodules[5] for details.
2420 submodule.<name>.fetchRecurseSubmodules::
2421 This option can be used to control recursive fetching of this
2422 submodule. It can be overridden by using the --[no-]recurse-submodules
2423 command-line option to "git fetch" and "git pull".
2424 This setting will override that from in the linkgit:gitmodules[5]
2427 submodule.<name>.ignore::
2428 Defines under what circumstances "git status" and the diff family show
2429 a submodule as modified. When set to "all", it will never be considered
2430 modified (but it will nonetheless show up in the output of status and
2431 commit when it has been staged), "dirty" will ignore all changes
2432 to the submodules work tree and
2433 takes only differences between the HEAD of the submodule and the commit
2434 recorded in the superproject into account. "untracked" will additionally
2435 let submodules with modified tracked files in their work tree show up.
2436 Using "none" (the default when this option is not set) also shows
2437 submodules that have untracked files in their work tree as changed.
2438 This setting overrides any setting made in .gitmodules for this submodule,
2439 both settings can be overridden on the command line by using the
2440 "--ignore-submodules" option. The 'git submodule' commands are not
2441 affected by this setting.
2444 This variable controls the sort ordering of tags when displayed by
2445 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2446 value of this variable will be used as the default.
2449 This variable can be used to restrict the permission bits of
2450 tar archive entries. The default is 0002, which turns off the
2451 world write bit. The special value "user" indicates that the
2452 archiving user's umask will be used instead. See umask(2) and
2453 linkgit:git-archive[1].
2455 transfer.fsckObjects::
2456 When `fetch.fsckObjects` or `receive.fsckObjects` are
2457 not set, the value of this variable is used instead.
2461 This variable can be used to set both `receive.hiderefs`
2462 and `uploadpack.hiderefs` at the same time to the same
2463 values. See entries for these other variables.
2465 transfer.unpackLimit::
2466 When `fetch.unpackLimit` or `receive.unpackLimit` are
2467 not set, the value of this variable is used instead.
2468 The default value is 100.
2470 uploadarchive.allowUnreachable::
2471 If true, allow clients to use `git archive --remote` to request
2472 any tree, whether reachable from the ref tips or not. See the
2473 discussion in the `SECURITY` section of
2474 linkgit:git-upload-archive[1] for more details. Defaults to
2477 uploadpack.hiderefs::
2478 String(s) `upload-pack` uses to decide which refs to omit
2479 from its initial advertisement. Use more than one
2480 definitions to specify multiple prefix strings. A ref that
2481 are under the hierarchies listed on the value of this
2482 variable is excluded, and is hidden from `git ls-remote`,
2483 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2484 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2486 uploadpack.allowtipsha1inwant::
2487 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2488 to accept a fetch request that asks for an object at the tip
2489 of a hidden ref (by default, such a request is rejected).
2490 see also `uploadpack.hiderefs`.
2492 uploadpack.keepalive::
2493 When `upload-pack` has started `pack-objects`, there may be a
2494 quiet period while `pack-objects` prepares the pack. Normally
2495 it would output progress information, but if `--quiet` was used
2496 for the fetch, `pack-objects` will output nothing at all until
2497 the pack data begins. Some clients and networks may consider
2498 the server to be hung and give up. Setting this option instructs
2499 `upload-pack` to send an empty keepalive packet every
2500 `uploadpack.keepalive` seconds. Setting this option to 0
2501 disables keepalive packets entirely. The default is 5 seconds.
2503 url.<base>.insteadOf::
2504 Any URL that starts with this value will be rewritten to
2505 start, instead, with <base>. In cases where some site serves a
2506 large number of repositories, and serves them with multiple
2507 access methods, and some users need to use different access
2508 methods, this feature allows people to specify any of the
2509 equivalent URLs and have Git automatically rewrite the URL to
2510 the best alternative for the particular user, even for a
2511 never-before-seen repository on the site. When more than one
2512 insteadOf strings match a given URL, the longest match is used.
2514 url.<base>.pushInsteadOf::
2515 Any URL that starts with this value will not be pushed to;
2516 instead, it will be rewritten to start with <base>, and the
2517 resulting URL will be pushed to. In cases where some site serves
2518 a large number of repositories, and serves them with multiple
2519 access methods, some of which do not allow push, this feature
2520 allows people to specify a pull-only URL and have Git
2521 automatically use an appropriate URL to push, even for a
2522 never-before-seen repository on the site. When more than one
2523 pushInsteadOf strings match a given URL, the longest match is
2524 used. If a remote has an explicit pushurl, Git will ignore this
2525 setting for that remote.
2528 Your email address to be recorded in any newly created commits.
2529 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2530 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2533 Your full name to be recorded in any newly created commits.
2534 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2535 environment variables. See linkgit:git-commit-tree[1].
2538 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2539 key you want it to automatically when creating a signed tag or
2540 commit, you can override the default selection with this variable.
2541 This option is passed unchanged to gpg's --local-user parameter,
2542 so you may specify a key using any method that gpg supports.
2545 Specify a web browser that may be used by some commands.
2546 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]