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 false, the ctime differences between the index and the
251 working tree are ignored; useful when the inode change time
252 is regularly modified by something outside Git (file system
253 crawlers and some backup systems).
254 See linkgit:git-update-index[1]. True by default.
257 Determines which stat fields to match between the index
258 and work tree. The user can set this to 'default' or
259 'minimal'. Default (or explicitly 'default'), is to check
260 all fields, including the sub-second part of mtime and ctime.
263 The commands that output paths (e.g. 'ls-files',
264 'diff'), when not given the `-z` option, will quote
265 "unusual" characters in the pathname by enclosing the
266 pathname in a double-quote pair and with backslashes the
267 same way strings in C source code are quoted. If this
268 variable is set to false, the bytes higher than 0x80 are
269 not quoted but output as verbatim. Note that double
270 quote, backslash and control characters are always
271 quoted without `-z` regardless of the setting of this
275 Sets the line ending type to use in the working directory for
276 files that have the `text` property set. Alternatives are
277 'lf', 'crlf' and 'native', which uses the platform's native
278 line ending. The default value is `native`. See
279 linkgit:gitattributes[5] for more information on end-of-line
283 If true, makes Git check if converting `CRLF` is reversible when
284 end-of-line conversion is active. Git will verify if a command
285 modifies a file in the work tree either directly or indirectly.
286 For example, committing a file followed by checking out the
287 same file should yield the original file in the work tree. If
288 this is not the case for the current setting of
289 `core.autocrlf`, Git will reject the file. The variable can
290 be set to "warn", in which case Git will only warn about an
291 irreversible conversion but continue the operation.
293 CRLF conversion bears a slight chance of corrupting data.
294 When it is enabled, Git will convert CRLF to LF during commit and LF to
295 CRLF during checkout. A file that contains a mixture of LF and
296 CRLF before the commit cannot be recreated by Git. For text
297 files this is the right thing to do: it corrects line endings
298 such that we have only LF line endings in the repository.
299 But for binary files that are accidentally classified as text the
300 conversion can corrupt data.
302 If you recognize such corruption early you can easily fix it by
303 setting the conversion type explicitly in .gitattributes. Right
304 after committing you still have the original file in your work
305 tree and this file is not yet corrupted. You can explicitly tell
306 Git that this file is binary and Git will handle the file
309 Unfortunately, the desired effect of cleaning up text files with
310 mixed line endings and the undesired effect of corrupting binary
311 files cannot be distinguished. In both cases CRLFs are removed
312 in an irreversible way. For text files this is the right thing
313 to do because CRLFs are line endings, while for binary files
314 converting CRLFs corrupts data.
316 Note, this safety check does not mean that a checkout will generate a
317 file identical to the original file for a different setting of
318 `core.eol` and `core.autocrlf`, but only for the current one. For
319 example, a text file with `LF` would be accepted with `core.eol=lf`
320 and could later be checked out with `core.eol=crlf`, in which case the
321 resulting file would contain `CRLF`, although the original file
322 contained `LF`. However, in both work trees the line endings would be
323 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
324 file with mixed line endings would be reported by the `core.safecrlf`
328 Setting this variable to "true" is almost the same as setting
329 the `text` attribute to "auto" on all files except that text
330 files are not guaranteed to be normalized: files that contain
331 `CRLF` in the repository will not be touched. Use this
332 setting if you want to have `CRLF` line endings in your
333 working directory even though the repository does not have
334 normalized line endings. This variable can be set to 'input',
335 in which case no output conversion is performed.
338 If false, symbolic links are checked out as small plain files that
339 contain the link text. linkgit:git-update-index[1] and
340 linkgit:git-add[1] will not change the recorded type to regular
341 file. Useful on filesystems like FAT that do not support
344 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
345 will probe and set core.symlinks false if appropriate when the repository
349 A "proxy command" to execute (as 'command host port') instead
350 of establishing direct connection to the remote server when
351 using the Git protocol for fetching. If the variable value is
352 in the "COMMAND for DOMAIN" format, the command is applied only
353 on hostnames ending with the specified domain string. This variable
354 may be set multiple times and is matched in the given order;
355 the first match wins.
357 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
358 (which always applies universally, without the special "for"
361 The special string `none` can be used as the proxy command to
362 specify that no proxy be used for a given domain pattern.
363 This is useful for excluding servers inside a firewall from
364 proxy use, while defaulting to a common proxy for external domains.
367 If true, Git will avoid using lstat() calls to detect if files have
368 changed by setting the "assume-unchanged" bit for those tracked files
369 which it has updated identically in both the index and working tree.
371 When files are modified outside of Git, the user will need to stage
372 the modified files explicitly (e.g. see 'Examples' section in
373 linkgit:git-update-index[1]).
374 Git will not normally detect changes to those files.
376 This is useful on systems where lstat() calls are very slow, such as
377 CIFS/Microsoft Windows.
381 core.preferSymlinkRefs::
382 Instead of the default "symref" format for HEAD
383 and other symbolic reference files, use symbolic links.
384 This is sometimes needed to work with old scripts that
385 expect HEAD to be a symbolic link.
388 If true this repository is assumed to be 'bare' and has no
389 working directory associated with it. If this is the case a
390 number of commands that require a working directory will be
391 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
393 This setting is automatically guessed by linkgit:git-clone[1] or
394 linkgit:git-init[1] when the repository was created. By default a
395 repository that ends in "/.git" is assumed to be not bare (bare =
396 false), while all other repositories are assumed to be bare (bare
400 Set the path to the root of the working tree.
401 This can be overridden by the GIT_WORK_TREE environment
402 variable and the '--work-tree' command-line option.
403 The value can be an absolute path or relative to the path to
404 the .git directory, which is either specified by --git-dir
405 or GIT_DIR, or automatically discovered.
406 If --git-dir or GIT_DIR is specified but none of
407 --work-tree, GIT_WORK_TREE and core.worktree is specified,
408 the current working directory is regarded as the top level
409 of your working tree.
411 Note that this variable is honored even when set in a configuration
412 file in a ".git" subdirectory of a directory and its value differs
413 from the latter directory (e.g. "/path/to/.git/config" has
414 core.worktree set to "/different/path"), which is most likely a
415 misconfiguration. Running Git commands in the "/path/to" directory will
416 still use "/different/path" as the root of the work tree and can cause
417 confusion unless you know what you are doing (e.g. you are creating a
418 read-only snapshot of the same index to a location different from the
419 repository's usual working tree).
421 core.logAllRefUpdates::
422 Enable the reflog. Updates to a ref <ref> is logged to the file
423 "$GIT_DIR/logs/<ref>", by appending the new and old
424 SHA-1, the date/time and the reason of the update, but
425 only when the file exists. If this configuration
426 variable is set to true, missing "$GIT_DIR/logs/<ref>"
427 file is automatically created for branch heads (i.e. under
428 refs/heads/), remote refs (i.e. under refs/remotes/),
429 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
431 This information can be used to determine what commit
432 was the tip of a branch "2 days ago".
434 This value is true by default in a repository that has
435 a working directory associated with it, and false by
436 default in a bare repository.
438 core.repositoryFormatVersion::
439 Internal variable identifying the repository format and layout
442 core.sharedRepository::
443 When 'group' (or 'true'), the repository is made shareable between
444 several users in a group (making sure all the files and objects are
445 group-writable). When 'all' (or 'world' or 'everybody'), the
446 repository will be readable by all users, additionally to being
447 group-shareable. When 'umask' (or 'false'), Git will use permissions
448 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
449 files in the repository will have this mode value. '0xxx' will override
450 user's umask value (whereas the other options will only override
451 requested parts of the user's umask value). Examples: '0660' will make
452 the repo read/write-able for the owner and group, but inaccessible to
453 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
454 repository that is group-readable but not group-writable.
455 See linkgit:git-init[1]. False by default.
457 core.warnAmbiguousRefs::
458 If true, Git will warn you if the ref name you passed it is ambiguous
459 and might match multiple refs in the repository. True by default.
462 An integer -1..9, indicating a default compression level.
463 -1 is the zlib default. 0 means no compression,
464 and 1..9 are various speed/size tradeoffs, 9 being slowest.
465 If set, this provides a default to other compression variables,
466 such as 'core.loosecompression' and 'pack.compression'.
468 core.loosecompression::
469 An integer -1..9, indicating the compression level for objects that
470 are not in a pack file. -1 is the zlib default. 0 means no
471 compression, and 1..9 are various speed/size tradeoffs, 9 being
472 slowest. If not set, defaults to core.compression. If that is
473 not set, defaults to 1 (best speed).
475 core.packedGitWindowSize::
476 Number of bytes of a pack file to map into memory in a
477 single mapping operation. Larger window sizes may allow
478 your system to process a smaller number of large pack files
479 more quickly. Smaller window sizes will negatively affect
480 performance due to increased calls to the operating system's
481 memory manager, but may improve performance when accessing
482 a large number of large pack files.
484 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
485 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
486 be reasonable for all users/operating systems. You probably do
487 not need to adjust this value.
489 Common unit suffixes of 'k', 'm', or 'g' are supported.
491 core.packedGitLimit::
492 Maximum number of bytes to map simultaneously into memory
493 from pack files. If Git needs to access more than this many
494 bytes at once to complete an operation it will unmap existing
495 regions to reclaim virtual address space within the process.
497 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
498 This should be reasonable for all users/operating systems, except on
499 the largest projects. You probably do not need to adjust this value.
501 Common unit suffixes of 'k', 'm', or 'g' are supported.
503 core.deltaBaseCacheLimit::
504 Maximum number of bytes to reserve for caching base objects
505 that may be referenced by multiple deltified objects. By storing the
506 entire decompressed base objects in a cache Git is able
507 to avoid unpacking and decompressing frequently used base
508 objects multiple times.
510 Default is 96 MiB on all platforms. This should be reasonable
511 for all users/operating systems, except on the largest projects.
512 You probably do not need to adjust this value.
514 Common unit suffixes of 'k', 'm', or 'g' are supported.
516 core.bigFileThreshold::
517 Files larger than this size are stored deflated, without
518 attempting delta compression. Storing large files without
519 delta compression avoids excessive memory usage, at the
520 slight expense of increased disk usage. Additionally files
521 larger than this size are always treated as binary.
523 Default is 512 MiB on all platforms. This should be reasonable
524 for most projects as source code and other text files can still
525 be delta compressed, but larger binary media files won't be.
527 Common unit suffixes of 'k', 'm', or 'g' are supported.
530 In addition to '.gitignore' (per-directory) and
531 '.git/info/exclude', Git looks into this file for patterns
532 of files which are not meant to be tracked. "`~/`" is expanded
533 to the value of `$HOME` and "`~user/`" to the specified user's
534 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
535 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
536 is used instead. See linkgit:gitignore[5].
539 Some commands (e.g. svn and http interfaces) that interactively
540 ask for a password can be told to use an external program given
541 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
542 environment variable. If not set, fall back to the value of the
543 'SSH_ASKPASS' environment variable or, failing that, a simple password
544 prompt. The external program shall be given a suitable prompt as
545 command-line argument and write the password on its STDOUT.
547 core.attributesfile::
548 In addition to '.gitattributes' (per-directory) and
549 '.git/info/attributes', Git looks into this file for attributes
550 (see linkgit:gitattributes[5]). Path expansions are made the same
551 way as for `core.excludesfile`. Its default value is
552 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
553 set or empty, $HOME/.config/git/attributes is used instead.
556 Commands such as `commit` and `tag` that lets you edit
557 messages by launching an editor uses the value of this
558 variable when it is set, and the environment variable
559 `GIT_EDITOR` is not set. See linkgit:git-var[1].
562 Commands such as `commit` and `tag` that lets you edit
563 messages consider a line that begins with this character
564 commented, and removes them after the editor returns
567 If set to "auto", `git-commit` would select a character that is not
568 the beginning character of any line in existing commit messages.
571 Text editor used by `git rebase -i` for editing the rebase instruction file.
572 The value is meant to be interpreted by the shell when it is used.
573 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
574 When not configured the default commit message editor is used instead.
577 Text viewer for use by Git commands (e.g., 'less'). The value
578 is meant to be interpreted by the shell. The order of preference
579 is the `$GIT_PAGER` environment variable, then `core.pager`
580 configuration, then `$PAGER`, and then the default chosen at
581 compile time (usually 'less').
583 When the `LESS` environment variable is unset, Git sets it to `FRX`
584 (if `LESS` environment variable is set, Git does not change it at
585 all). If you want to selectively override Git's default setting
586 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
587 be passed to the shell by Git, which will translate the final
588 command to `LESS=FRX less -S`. The environment does not set the
589 `S` option but the command line does, instructing less to truncate
590 long lines. Similarly, setting `core.pager` to `less -+F` will
591 deactivate the `F` option specified by the environment from the
592 command-line, deactivating the "quit if one screen" behavior of
593 `less`. One can specifically activate some flags for particular
594 commands: for example, setting `pager.blame` to `less -S` enables
595 line truncation only for `git blame`.
597 Likewise, when the `LV` environment variable is unset, Git sets it
598 to `-c`. You can override this setting by exporting `LV` with
599 another value or setting `core.pager` to `lv +c`.
602 A comma separated list of common whitespace problems to
603 notice. 'git diff' will use `color.diff.whitespace` to
604 highlight them, and 'git apply --whitespace=error' will
605 consider them as errors. You can prefix `-` to disable
606 any of them (e.g. `-trailing-space`):
608 * `blank-at-eol` treats trailing whitespaces at the end of the line
609 as an error (enabled by default).
610 * `space-before-tab` treats a space character that appears immediately
611 before a tab character in the initial indent part of the line as an
612 error (enabled by default).
613 * `indent-with-non-tab` treats a line that is indented with space
614 characters instead of the equivalent tabs as an error (not enabled by
616 * `tab-in-indent` treats a tab character in the initial indent part of
617 the line as an error (not enabled by default).
618 * `blank-at-eof` treats blank lines added at the end of file as an error
619 (enabled by default).
620 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
622 * `cr-at-eol` treats a carriage-return at the end of line as
623 part of the line terminator, i.e. with it, `trailing-space`
624 does not trigger if the character before such a carriage-return
625 is not a whitespace (not enabled by default).
626 * `tabwidth=<n>` tells how many character positions a tab occupies; this
627 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
628 errors. The default tab width is 8. Allowed values are 1 to 63.
630 core.fsyncobjectfiles::
631 This boolean will enable 'fsync()' when writing object files.
633 This is a total waste of time and effort on a filesystem that orders
634 data writes properly, but can be useful for filesystems that do not use
635 journalling (traditional UNIX filesystems) or that only journal metadata
636 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
639 Enable parallel index preload for operations like 'git diff'
641 This can speed up operations like 'git diff' and 'git status' especially
642 on filesystems like NFS that have weak caching semantics and thus
643 relatively high IO latencies. When enabled, Git will do the
644 index comparison to the filesystem data in parallel, allowing
645 overlapping IO's. Defaults to true.
648 You can set this to 'link', in which case a hardlink followed by
649 a delete of the source are used to make sure that object creation
650 will not overwrite existing objects.
652 On some file system/operating system combinations, this is unreliable.
653 Set this config setting to 'rename' there; However, This will remove the
654 check that makes sure that existing object files will not get overwritten.
657 When showing commit messages, also show notes which are stored in
658 the given ref. The ref must be fully qualified. If the given
659 ref does not exist, it is not an error but means that no
660 notes should be printed.
662 This setting defaults to "refs/notes/commits", and it can be overridden by
663 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
665 core.sparseCheckout::
666 Enable "sparse checkout" feature. See section "Sparse checkout" in
667 linkgit:git-read-tree[1] for more information.
670 Set the length object names are abbreviated to. If unspecified,
671 many commands abbreviate to 7 hexdigits, which may not be enough
672 for abbreviated object names to stay unique for sufficiently long
677 Tells 'git add' to continue adding files when some files cannot be
678 added due to indexing errors. Equivalent to the '--ignore-errors'
679 option of linkgit:git-add[1]. Older versions of Git accept only
680 `add.ignore-errors`, which does not follow the usual naming
681 convention for configuration variables. Newer versions of Git
682 honor `add.ignoreErrors` as well.
685 Command aliases for the linkgit:git[1] command wrapper - e.g.
686 after defining "alias.last = cat-file commit HEAD", the invocation
687 "git last" is equivalent to "git cat-file commit HEAD". To avoid
688 confusion and troubles with script usage, aliases that
689 hide existing Git commands are ignored. Arguments are split by
690 spaces, the usual shell quoting and escaping is supported.
691 A quote pair or a backslash can be used to quote them.
693 If the alias expansion is prefixed with an exclamation point,
694 it will be treated as a shell command. For example, defining
695 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
696 "git new" is equivalent to running the shell command
697 "gitk --all --not ORIG_HEAD". Note that shell commands will be
698 executed from the top-level directory of a repository, which may
699 not necessarily be the current directory.
700 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
701 from the original current directory. See linkgit:git-rev-parse[1].
704 If true, git-am will call git-mailsplit for patches in mbox format
705 with parameter '--keep-cr'. In this case git-mailsplit will
706 not remove `\r` from lines ending with `\r\n`. Can be overridden
707 by giving '--no-keep-cr' from the command line.
708 See linkgit:git-am[1], linkgit:git-mailsplit[1].
710 apply.ignorewhitespace::
711 When set to 'change', tells 'git apply' to ignore changes in
712 whitespace, in the same way as the '--ignore-space-change'
714 When set to one of: no, none, never, false tells 'git apply' to
715 respect all whitespace differences.
716 See linkgit:git-apply[1].
719 Tells 'git apply' how to handle whitespaces, in the same way
720 as the '--whitespace' option. See linkgit:git-apply[1].
722 branch.autosetupmerge::
723 Tells 'git branch' and 'git checkout' to set up new branches
724 so that linkgit:git-pull[1] will appropriately merge from the
725 starting point branch. Note that even if this option is not set,
726 this behavior can be chosen per-branch using the `--track`
727 and `--no-track` options. The valid settings are: `false` -- no
728 automatic setup is done; `true` -- automatic setup is done when the
729 starting point is a remote-tracking branch; `always` --
730 automatic setup is done when the starting point is either a
731 local branch or remote-tracking
732 branch. This option defaults to true.
734 branch.autosetuprebase::
735 When a new branch is created with 'git branch' or 'git checkout'
736 that tracks another branch, this variable tells Git to set
737 up pull to rebase instead of merge (see "branch.<name>.rebase").
738 When `never`, rebase is never automatically set to true.
739 When `local`, rebase is set to true for tracked branches of
740 other local branches.
741 When `remote`, rebase is set to true for tracked branches of
742 remote-tracking branches.
743 When `always`, rebase will be set to true for all tracking
745 See "branch.autosetupmerge" for details on how to set up a
746 branch to track another branch.
747 This option defaults to never.
749 branch.<name>.remote::
750 When on branch <name>, it tells 'git fetch' and 'git push'
751 which remote to fetch from/push to. The remote to push to
752 may be overridden with `remote.pushdefault` (for all branches).
753 The remote to push to, for the current branch, may be further
754 overridden by `branch.<name>.pushremote`. If no remote is
755 configured, or if you are not on any branch, it defaults to
756 `origin` for fetching and `remote.pushdefault` for pushing.
757 Additionally, `.` (a period) is the current local repository
758 (a dot-repository), see `branch.<name>.merge`'s final note below.
760 branch.<name>.pushremote::
761 When on branch <name>, it overrides `branch.<name>.remote` for
762 pushing. It also overrides `remote.pushdefault` for pushing
763 from branch <name>. When you pull from one place (e.g. your
764 upstream) and push to another place (e.g. your own publishing
765 repository), you would want to set `remote.pushdefault` to
766 specify the remote to push to for all branches, and use this
767 option to override it for a specific branch.
769 branch.<name>.merge::
770 Defines, together with branch.<name>.remote, the upstream branch
771 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
772 branch to merge and can also affect 'git push' (see push.default).
773 When in branch <name>, it tells 'git fetch' the default
774 refspec to be marked for merging in FETCH_HEAD. The value is
775 handled like the remote part of a refspec, and must match a
776 ref which is fetched from the remote given by
777 "branch.<name>.remote".
778 The merge information is used by 'git pull' (which at first calls
779 'git fetch') to lookup the default branch for merging. Without
780 this option, 'git pull' defaults to merge the first refspec fetched.
781 Specify multiple values to get an octopus merge.
782 If you wish to setup 'git pull' so that it merges into <name> from
783 another branch in the local repository, you can point
784 branch.<name>.merge to the desired branch, and use the relative path
785 setting `.` (a period) for branch.<name>.remote.
787 branch.<name>.mergeoptions::
788 Sets default options for merging into branch <name>. The syntax and
789 supported options are the same as those of linkgit:git-merge[1], but
790 option values containing whitespace characters are currently not
793 branch.<name>.rebase::
794 When true, rebase the branch <name> on top of the fetched branch,
795 instead of merging the default branch from the default remote when
796 "git pull" is run. See "pull.rebase" for doing this in a non
797 branch-specific manner.
799 When preserve, also pass `--preserve-merges` along to 'git rebase'
800 so that locally committed merge commits will not be flattened
801 by running 'git pull'.
803 *NOTE*: this is a possibly dangerous operation; do *not* use
804 it unless you understand the implications (see linkgit:git-rebase[1]
807 branch.<name>.description::
808 Branch description, can be edited with
809 `git branch --edit-description`. Branch description is
810 automatically added in the format-patch cover letter or
811 request-pull summary.
814 Specify the command to invoke the specified browser. The
815 specified command is evaluated in shell with the URLs passed
816 as arguments. (See linkgit:git-web{litdd}browse[1].)
818 browser.<tool>.path::
819 Override the path for the given tool that may be used to
820 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
821 working repository in gitweb (see linkgit:git-instaweb[1]).
824 A boolean to make git-clean do nothing unless given -f,
825 -i or -n. Defaults to true.
828 A boolean to enable/disable color in the output of
829 linkgit:git-branch[1]. May be set to `always`,
830 `false` (or `never`) or `auto` (or `true`), in which case colors are used
831 only when the output is to a terminal. Defaults to false.
833 color.branch.<slot>::
834 Use customized color for branch coloration. `<slot>` is one of
835 `current` (the current branch), `local` (a local branch),
836 `remote` (a remote-tracking branch in refs/remotes/),
837 `upstream` (upstream tracking branch), `plain` (other
840 The value for these configuration variables is a list of colors (at most
841 two) and attributes (at most one), separated by spaces. The colors
842 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
843 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
844 `blink` and `reverse`. The first color given is the foreground; the
845 second is the background. The position of the attribute, if any,
848 Colors (foreground and background) may also be given as numbers between
849 0 and 255; these use ANSI 256-color mode (but note that not all
850 terminals may support this).
853 Whether to use ANSI escape sequences to add color to patches.
854 If this is set to `always`, linkgit:git-diff[1],
855 linkgit:git-log[1], and linkgit:git-show[1] will use color
856 for all patches. If it is set to `true` or `auto`, those
857 commands will only use color when output is to the terminal.
860 This does not affect linkgit:git-format-patch[1] or the
861 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
862 command line with the `--color[=<when>]` option.
865 Use customized color for diff colorization. `<slot>` specifies
866 which part of the patch to use the specified color, and is one
867 of `plain` (context text), `meta` (metainformation), `frag`
868 (hunk header), 'func' (function in hunk header), `old` (removed lines),
869 `new` (added lines), `commit` (commit headers), or `whitespace`
870 (highlighting whitespace errors). The values of these variables may be
871 specified as in color.branch.<slot>.
873 color.decorate.<slot>::
874 Use customized color for 'git log --decorate' output. `<slot>` is one
875 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
876 branches, remote-tracking branches, tags, stash and HEAD, respectively.
879 When set to `always`, always highlight matches. When `false` (or
880 `never`), never. When set to `true` or `auto`, use color only
881 when the output is written to the terminal. Defaults to `false`.
884 Use customized color for grep colorization. `<slot>` specifies which
885 part of the line to use the specified color, and is one of
889 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
891 filename prefix (when not using `-h`)
893 function name lines (when using `-p`)
895 line number prefix (when using `-n`)
897 matching text (same as setting `matchContext` and `matchSelected`)
899 matching text in context lines
901 matching text in selected lines
903 non-matching text in selected lines
905 separators between fields on a line (`:`, `-`, and `=`)
906 and between hunks (`--`)
909 The values of these variables may be specified as in color.branch.<slot>.
912 When set to `always`, always use colors for interactive prompts
913 and displays (such as those used by "git-add --interactive" and
914 "git-clean --interactive"). When false (or `never`), never.
915 When set to `true` or `auto`, use colors only when the output is
916 to the terminal. Defaults to false.
918 color.interactive.<slot>::
919 Use customized color for 'git add --interactive' and 'git clean
920 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
921 or `error`, for four distinct types of normal output from
922 interactive commands. The values of these variables may be
923 specified as in color.branch.<slot>.
926 A boolean to enable/disable colored output when the pager is in
927 use (default is true).
930 A boolean to enable/disable color in the output of
931 linkgit:git-show-branch[1]. May be set to `always`,
932 `false` (or `never`) or `auto` (or `true`), in which case colors are used
933 only when the output is to a terminal. Defaults to false.
936 A boolean to enable/disable color in the output of
937 linkgit:git-status[1]. May be set to `always`,
938 `false` (or `never`) or `auto` (or `true`), in which case colors are used
939 only when the output is to a terminal. Defaults to false.
941 color.status.<slot>::
942 Use customized color for status colorization. `<slot>` is
943 one of `header` (the header text of the status message),
944 `added` or `updated` (files which are added but not committed),
945 `changed` (files which are changed but not added in the index),
946 `untracked` (files which are not tracked by Git),
947 `branch` (the current branch), or
948 `nobranch` (the color the 'no branch' warning is shown in, defaulting
949 to red). The values of these variables may be specified as in
953 This variable determines the default value for variables such
954 as `color.diff` and `color.grep` that control the use of color
955 per command family. Its scope will expand as more commands learn
956 configuration to set a default for the `--color` option. Set it
957 to `false` or `never` if you prefer Git commands not to use
958 color unless enabled explicitly with some other configuration
959 or the `--color` option. Set it to `always` if you want all
960 output not intended for machine consumption to use color, to
961 `true` or `auto` (this is the default since Git 1.8.4) if you
962 want such output to use color when written to the terminal.
965 Specify whether supported commands should output in columns.
966 This variable consists of a list of tokens separated by spaces
969 These options control when the feature should be enabled
970 (defaults to 'never'):
974 always show in columns
976 never show in columns
978 show in columns if the output is to the terminal
981 These options control layout (defaults to 'column'). Setting any
982 of these implies 'always' if none of 'always', 'never', or 'auto' are
987 fill columns before rows
989 fill rows before columns
994 Finally, these options can be combined with a layout option (defaults
999 make unequal size columns to utilize more space
1001 make equal size columns
1005 Specify whether to output branch listing in `git branch` in columns.
1006 See `column.ui` for details.
1009 Specify the layout when list items in `git clean -i`, which always
1010 shows files and directories in columns. See `column.ui` for details.
1013 Specify whether to output untracked files in `git status` in columns.
1014 See `column.ui` for details.
1017 Specify whether to output tag listing in `git tag` in columns.
1018 See `column.ui` for details.
1021 This setting overrides the default of the `--cleanup` option in
1022 `git commit`. See linkgit:git-commit[1] for details. Changing the
1023 default can be useful when you always want to keep lines that begin
1024 with comment character `#` in your log message, in which case you
1025 would do `git config commit.cleanup whitespace` (note that you will
1026 have to remove the help lines that begin with `#` in the commit log
1027 template yourself, if you do this).
1031 A boolean to specify whether all commits should be GPG signed.
1032 Use of this option when doing operations such as rebase can
1033 result in a large number of commits being signed. It may be
1034 convenient to use an agent to avoid typing your GPG passphrase
1038 A boolean to enable/disable inclusion of status information in the
1039 commit message template when using an editor to prepare the commit
1040 message. Defaults to true.
1043 Specify a file to use as the template for new commit messages.
1044 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1045 specified user's home directory.
1048 Specify an external helper to be called when a username or
1049 password credential is needed; the helper may consult external
1050 storage to avoid prompting the user for the credentials. See
1051 linkgit:gitcredentials[7] for details.
1053 credential.useHttpPath::
1054 When acquiring credentials, consider the "path" component of an http
1055 or https URL to be important. Defaults to false. See
1056 linkgit:gitcredentials[7] for more information.
1058 credential.username::
1059 If no username is set for a network authentication, use this username
1060 by default. See credential.<context>.* below, and
1061 linkgit:gitcredentials[7].
1063 credential.<url>.*::
1064 Any of the credential.* options above can be applied selectively to
1065 some credentials. For example "credential.https://example.com.username"
1066 would set the default username only for https connections to
1067 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1070 include::diff-config.txt[]
1072 difftool.<tool>.path::
1073 Override the path for the given tool. This is useful in case
1074 your tool is not in the PATH.
1076 difftool.<tool>.cmd::
1077 Specify the command to invoke the specified diff tool.
1078 The specified command is evaluated in shell with the following
1079 variables available: 'LOCAL' is set to the name of the temporary
1080 file containing the contents of the diff pre-image and 'REMOTE'
1081 is set to the name of the temporary file containing the contents
1082 of the diff post-image.
1085 Prompt before each invocation of the diff tool.
1087 fetch.recurseSubmodules::
1088 This option can be either set to a boolean value or to 'on-demand'.
1089 Setting it to a boolean changes the behavior of fetch and pull to
1090 unconditionally recurse into submodules when set to true or to not
1091 recurse at all when set to false. When set to 'on-demand' (the default
1092 value), fetch and pull will only recurse into a populated submodule
1093 when its superproject retrieves a commit that updates the submodule's
1097 If it is set to true, git-fetch-pack will check all fetched
1098 objects. It will abort in the case of a malformed object or a
1099 broken link. The result of an abort are only dangling objects.
1100 Defaults to false. If not set, the value of `transfer.fsckObjects`
1104 If the number of objects fetched over the Git native
1105 transfer is below this
1106 limit, then the objects will be unpacked into loose object
1107 files. However if the number of received objects equals or
1108 exceeds this limit then the received pack will be stored as
1109 a pack, after adding any missing delta bases. Storing the
1110 pack from a push can make the push operation complete faster,
1111 especially on slow filesystems. If not set, the value of
1112 `transfer.unpackLimit` is used instead.
1115 If true, fetch will automatically behave as if the `--prune`
1116 option was given on the command line. See also `remote.<name>.prune`.
1119 Enable multipart/mixed attachments as the default for
1120 'format-patch'. The value can also be a double quoted string
1121 which will enable attachments as the default and set the
1122 value as the boundary. See the --attach option in
1123 linkgit:git-format-patch[1].
1126 A boolean which can enable or disable sequence numbers in patch
1127 subjects. It defaults to "auto" which enables it only if there
1128 is more than one patch. It can be enabled or disabled for all
1129 messages by setting it to "true" or "false". See --numbered
1130 option in linkgit:git-format-patch[1].
1133 Additional email headers to include in a patch to be submitted
1134 by mail. See linkgit:git-format-patch[1].
1138 Additional recipients to include in a patch to be submitted
1139 by mail. See the --to and --cc options in
1140 linkgit:git-format-patch[1].
1142 format.subjectprefix::
1143 The default for format-patch is to output files with the '[PATCH]'
1144 subject prefix. Use this variable to change that prefix.
1147 The default for format-patch is to output a signature containing
1148 the Git version number. Use this variable to change that default.
1149 Set this variable to the empty string ("") to suppress
1150 signature generation.
1152 format.signaturefile::
1153 Works just like format.signature except the contents of the
1154 file specified by this variable will be used as the signature.
1157 The default for format-patch is to output files with the suffix
1158 `.patch`. Use this variable to change that suffix (make sure to
1159 include the dot if you want it).
1162 The default pretty format for log/show/whatchanged command,
1163 See linkgit:git-log[1], linkgit:git-show[1],
1164 linkgit:git-whatchanged[1].
1167 The default threading style for 'git format-patch'. Can be
1168 a boolean value, or `shallow` or `deep`. `shallow` threading
1169 makes every mail a reply to the head of the series,
1170 where the head is chosen from the cover letter, the
1171 `--in-reply-to`, and the first patch mail, in this order.
1172 `deep` threading makes every mail a reply to the previous one.
1173 A true boolean value is the same as `shallow`, and a false
1174 value disables threading.
1177 A boolean value which lets you enable the `-s/--signoff` option of
1178 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1179 patch should be a conscious act and means that you certify you have
1180 the rights to submit this work under the same open source license.
1181 Please see the 'SubmittingPatches' document for further discussion.
1183 format.coverLetter::
1184 A boolean that controls whether to generate a cover-letter when
1185 format-patch is invoked, but in addition can be set to "auto", to
1186 generate a cover-letter only when there's more than one patch.
1188 filter.<driver>.clean::
1189 The command which is used to convert the content of a worktree
1190 file to a blob upon checkin. See linkgit:gitattributes[5] for
1193 filter.<driver>.smudge::
1194 The command which is used to convert the content of a blob
1195 object to a worktree file upon checkout. See
1196 linkgit:gitattributes[5] for details.
1198 gc.aggressiveDepth::
1199 The depth parameter used in the delta compression
1200 algorithm used by 'git gc --aggressive'. This defaults
1203 gc.aggressiveWindow::
1204 The window size parameter used in the delta compression
1205 algorithm used by 'git gc --aggressive'. This defaults
1209 When there are approximately more than this many loose
1210 objects in the repository, `git gc --auto` will pack them.
1211 Some Porcelain commands use this command to perform a
1212 light-weight garbage collection from time to time. The
1213 default value is 6700. Setting this to 0 disables it.
1216 When there are more than this many packs that are not
1217 marked with `*.keep` file in the repository, `git gc
1218 --auto` consolidates them into one larger pack. The
1219 default value is 50. Setting this to 0 disables it.
1222 Make `git gc --auto` return immediately and run in background
1223 if the system supports it. Default is true.
1226 Running `git pack-refs` in a repository renders it
1227 unclonable by Git versions prior to 1.5.1.2 over dumb
1228 transports such as HTTP. This variable determines whether
1229 'git gc' runs `git pack-refs`. This can be set to `notbare`
1230 to enable it within all non-bare repos or it can be set to a
1231 boolean value. The default is `true`.
1234 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1235 Override the grace period with this config variable. The value
1236 "now" may be used to disable this grace period and always prune
1237 unreachable objects immediately.
1240 gc.<pattern>.reflogexpire::
1241 'git reflog expire' removes reflog entries older than
1242 this time; defaults to 90 days. With "<pattern>" (e.g.
1243 "refs/stash") in the middle the setting applies only to
1244 the refs that match the <pattern>.
1246 gc.reflogexpireunreachable::
1247 gc.<ref>.reflogexpireunreachable::
1248 'git reflog expire' removes reflog entries older than
1249 this time and are not reachable from the current tip;
1250 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1251 in the middle, the setting applies only to the refs that
1252 match the <pattern>.
1255 Records of conflicted merge you resolved earlier are
1256 kept for this many days when 'git rerere gc' is run.
1257 The default is 60 days. See linkgit:git-rerere[1].
1259 gc.rerereunresolved::
1260 Records of conflicted merge you have not resolved are
1261 kept for this many days when 'git rerere gc' is run.
1262 The default is 15 days. See linkgit:git-rerere[1].
1264 gitcvs.commitmsgannotation::
1265 Append this string to each commit message. Set to empty string
1266 to disable this feature. Defaults to "via git-CVS emulator".
1269 Whether the CVS server interface is enabled for this repository.
1270 See linkgit:git-cvsserver[1].
1273 Path to a log file where the CVS server interface well... logs
1274 various stuff. See linkgit:git-cvsserver[1].
1276 gitcvs.usecrlfattr::
1277 If true, the server will look up the end-of-line conversion
1278 attributes for files to determine the '-k' modes to use. If
1279 the attributes force Git to treat a file as text,
1280 the '-k' mode will be left blank so CVS clients will
1281 treat it as text. If they suppress text conversion, the file
1282 will be set with '-kb' mode, which suppresses any newline munging
1283 the client might otherwise do. If the attributes do not allow
1284 the file type to be determined, then 'gitcvs.allbinary' is
1285 used. See linkgit:gitattributes[5].
1288 This is used if 'gitcvs.usecrlfattr' does not resolve
1289 the correct '-kb' mode to use. If true, all
1290 unresolved files are sent to the client in
1291 mode '-kb'. This causes the client to treat them
1292 as binary files, which suppresses any newline munging it
1293 otherwise might do. Alternatively, if it is set to "guess",
1294 then the contents of the file are examined to decide if
1295 it is binary, similar to 'core.autocrlf'.
1298 Database used by git-cvsserver to cache revision information
1299 derived from the Git repository. The exact meaning depends on the
1300 used database driver, for SQLite (which is the default driver) this
1301 is a filename. Supports variable substitution (see
1302 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1303 Default: '%Ggitcvs.%m.sqlite'
1306 Used Perl DBI driver. You can specify any available driver
1307 for this here, but it might not work. git-cvsserver is tested
1308 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1309 reported *not* to work with 'DBD::mysql'. Experimental feature.
1310 May not contain double colons (`:`). Default: 'SQLite'.
1311 See linkgit:git-cvsserver[1].
1313 gitcvs.dbuser, gitcvs.dbpass::
1314 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1315 since SQLite has no concept of database users and/or passwords.
1316 'gitcvs.dbuser' supports variable substitution (see
1317 linkgit:git-cvsserver[1] for details).
1319 gitcvs.dbTableNamePrefix::
1320 Database table name prefix. Prepended to the names of any
1321 database tables used, allowing a single database to be used
1322 for several repositories. Supports variable substitution (see
1323 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1324 characters will be replaced with underscores.
1326 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1327 'gitcvs.allbinary' can also be specified as
1328 'gitcvs.<access_method>.<varname>' (where 'access_method'
1329 is one of "ext" and "pserver") to make them apply only for the given
1333 gitweb.description::
1336 See linkgit:gitweb[1] for description.
1344 gitweb.remote_heads::
1347 See linkgit:gitweb.conf[5] for description.
1350 If set to true, enable '-n' option by default.
1353 Set the default matching behavior. Using a value of 'basic', 'extended',
1354 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1355 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1356 value 'default' will return to the default matching behavior.
1358 grep.extendedRegexp::
1359 If set to true, enable '--extended-regexp' option by default. This
1360 option is ignored when the 'grep.patternType' option is set to a value
1361 other than 'default'.
1364 Use this custom program instead of "gpg" found on $PATH when
1365 making or verifying a PGP signature. The program must support the
1366 same command-line interface as GPG, namely, to verify a detached
1367 signature, "gpg --verify $file - <$signature" is run, and the
1368 program is expected to signal a good signature by exiting with
1369 code 0, and to generate an ASCII-armored detached signature, the
1370 standard input of "gpg -bsau $key" is fed with the contents to be
1371 signed, and the program is expected to send the result to its
1374 gui.commitmsgwidth::
1375 Defines how wide the commit message window is in the
1376 linkgit:git-gui[1]. "75" is the default.
1379 Specifies how many context lines should be used in calls to diff
1380 made by the linkgit:git-gui[1]. The default is "5".
1382 gui.displayuntracked::
1383 Determines if linkgit::git-gui[1] shows untracked files
1384 in the file list. The default is "true".
1387 Specifies the default encoding to use for displaying of
1388 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1389 It can be overridden by setting the 'encoding' attribute
1390 for relevant files (see linkgit:gitattributes[5]).
1391 If this option is not set, the tools default to the
1394 gui.matchtrackingbranch::
1395 Determines if new branches created with linkgit:git-gui[1] should
1396 default to tracking remote branches with matching names or
1397 not. Default: "false".
1399 gui.newbranchtemplate::
1400 Is used as suggested name when creating new branches using the
1403 gui.pruneduringfetch::
1404 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1405 performing a fetch. The default value is "false".
1408 Determines if linkgit:git-gui[1] should trust the file modification
1409 timestamp or not. By default the timestamps are not trusted.
1411 gui.spellingdictionary::
1412 Specifies the dictionary used for spell checking commit messages in
1413 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1417 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1418 location detection. It makes blame significantly faster on huge
1419 repositories at the expense of less thorough copy detection.
1421 gui.copyblamethreshold::
1422 Specifies the threshold to use in 'git gui blame' original location
1423 detection, measured in alphanumeric characters. See the
1424 linkgit:git-blame[1] manual for more information on copy detection.
1426 gui.blamehistoryctx::
1427 Specifies the radius of history context in days to show in
1428 linkgit:gitk[1] for the selected commit, when the `Show History
1429 Context` menu item is invoked from 'git gui blame'. If this
1430 variable is set to zero, the whole history is shown.
1432 guitool.<name>.cmd::
1433 Specifies the shell command line to execute when the corresponding item
1434 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1435 mandatory for every tool. The command is executed from the root of
1436 the working directory, and in the environment it receives the name of
1437 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1438 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1439 the head is detached, 'CUR_BRANCH' is empty).
1441 guitool.<name>.needsfile::
1442 Run the tool only if a diff is selected in the GUI. It guarantees
1443 that 'FILENAME' is not empty.
1445 guitool.<name>.noconsole::
1446 Run the command silently, without creating a window to display its
1449 guitool.<name>.norescan::
1450 Don't rescan the working directory for changes after the tool
1453 guitool.<name>.confirm::
1454 Show a confirmation dialog before actually running the tool.
1456 guitool.<name>.argprompt::
1457 Request a string argument from the user, and pass it to the tool
1458 through the 'ARGS' environment variable. Since requesting an
1459 argument implies confirmation, the 'confirm' option has no effect
1460 if this is enabled. If the option is set to 'true', 'yes', or '1',
1461 the dialog uses a built-in generic prompt; otherwise the exact
1462 value of the variable is used.
1464 guitool.<name>.revprompt::
1465 Request a single valid revision from the user, and set the
1466 'REVISION' environment variable. In other aspects this option
1467 is similar to 'argprompt', and can be used together with it.
1469 guitool.<name>.revunmerged::
1470 Show only unmerged branches in the 'revprompt' subdialog.
1471 This is useful for tools similar to merge or rebase, but not
1472 for things like checkout or reset.
1474 guitool.<name>.title::
1475 Specifies the title to use for the prompt dialog. The default
1478 guitool.<name>.prompt::
1479 Specifies the general prompt string to display at the top of
1480 the dialog, before subsections for 'argprompt' and 'revprompt'.
1481 The default value includes the actual command.
1484 Specify the browser that will be used to display help in the
1485 'web' format. See linkgit:git-help[1].
1488 Override the default help format used by linkgit:git-help[1].
1489 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1490 the default. 'web' and 'html' are the same.
1493 Automatically correct and execute mistyped commands after
1494 waiting for the given number of deciseconds (0.1 sec). If more
1495 than one command can be deduced from the entered text, nothing
1496 will be executed. If the value of this option is negative,
1497 the corrected command will be executed immediately. If the
1498 value is 0 - the command will be just shown but not executed.
1499 This is the default.
1502 Specify the path where the HTML documentation resides. File system paths
1503 and URLs are supported. HTML pages will be prefixed with this path when
1504 help is displayed in the 'web' format. This defaults to the documentation
1505 path of your Git installation.
1508 Override the HTTP proxy, normally configured using the 'http_proxy',
1509 'https_proxy', and 'all_proxy' environment variables (see
1510 `curl(1)`). This can be overridden on a per-remote basis; see
1514 File containing previously stored cookie lines which should be used
1515 in the Git http session, if they match the server. The file format
1516 of the file to read cookies from should be plain HTTP headers or
1517 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1518 NOTE that the file specified with http.cookiefile is only used as
1519 input unless http.saveCookies is set.
1522 If set, store cookies received during requests to the file specified by
1523 http.cookiefile. Has no effect if http.cookiefile is unset.
1526 Whether to verify the SSL certificate when fetching or pushing
1527 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1531 File containing the SSL certificate when fetching or pushing
1532 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1536 File containing the SSL private key when fetching or pushing
1537 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1540 http.sslCertPasswordProtected::
1541 Enable Git's password prompt for the SSL certificate. Otherwise
1542 OpenSSL will prompt the user, possibly many times, if the
1543 certificate or private key is encrypted. Can be overridden by the
1544 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1547 File containing the certificates to verify the peer with when
1548 fetching or pushing over HTTPS. Can be overridden by the
1549 'GIT_SSL_CAINFO' environment variable.
1552 Path containing files with the CA certificates to verify the peer
1553 with when fetching or pushing over HTTPS. Can be overridden
1554 by the 'GIT_SSL_CAPATH' environment variable.
1557 Attempt to use AUTH SSL/TLS and encrypted data transfers
1558 when connecting via regular FTP protocol. This might be needed
1559 if the FTP server requires it for security reasons or you wish
1560 to connect securely whenever remote FTP server supports it.
1561 Default is false since it might trigger certificate verification
1562 errors on misconfigured servers.
1565 How many HTTP requests to launch in parallel. Can be overridden
1566 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1569 The number of curl sessions (counted across slots) to be kept across
1570 requests. They will not be ended with curl_easy_cleanup() until
1571 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1572 value will be capped at 1. Defaults to 1.
1575 Maximum size in bytes of the buffer used by smart HTTP
1576 transports when POSTing data to the remote system.
1577 For requests larger than this buffer size, HTTP/1.1 and
1578 Transfer-Encoding: chunked is used to avoid creating a
1579 massive pack file locally. Default is 1 MiB, which is
1580 sufficient for most requests.
1582 http.lowSpeedLimit, http.lowSpeedTime::
1583 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1584 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1585 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1586 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1589 A boolean which disables using of EPSV ftp command by curl.
1590 This can helpful with some "poor" ftp servers which don't
1591 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1592 environment variable. Default is false (curl will use EPSV).
1595 The HTTP USER_AGENT string presented to an HTTP server. The default
1596 value represents the version of the client Git such as git/1.7.1.
1597 This option allows you to override this value to a more common value
1598 such as Mozilla/4.0. This may be necessary, for instance, if
1599 connecting through a firewall that restricts HTTP connections to a set
1600 of common USER_AGENT strings (but not including those like git/1.7.1).
1601 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1604 Any of the http.* options above can be applied selectively to some URLs.
1605 For a config key to match a URL, each element of the config key is
1606 compared to that of the URL, in the following order:
1609 . Scheme (e.g., `https` in `https://example.com/`). This field
1610 must match exactly between the config key and the URL.
1612 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1613 This field must match exactly between the config key and the URL.
1615 . Port number (e.g., `8080` in `http://example.com:8080/`).
1616 This field must match exactly between the config key and the URL.
1617 Omitted port numbers are automatically converted to the correct
1618 default for the scheme before matching.
1620 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1621 path field of the config key must match the path field of the URL
1622 either exactly or as a prefix of slash-delimited path elements. This means
1623 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1624 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1625 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1626 key with just path `foo/`).
1628 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1629 the config key has a user name it must match the user name in the
1630 URL exactly. If the config key does not have a user name, that
1631 config key will match a URL with any user name (including none),
1632 but at a lower precedence than a config key with a user name.
1635 The list above is ordered by decreasing precedence; a URL that matches
1636 a config key's path is preferred to one that matches its user name. For example,
1637 if the URL is `https://user@example.com/foo/bar` a config key match of
1638 `https://example.com/foo` will be preferred over a config key match of
1639 `https://user@example.com`.
1641 All URLs are normalized before attempting any matching (the password part,
1642 if embedded in the URL, is always ignored for matching purposes) so that
1643 equivalent URLs that are simply spelled differently will match properly.
1644 Environment variable settings always override any matches. The URLs that are
1645 matched against are those given directly to Git commands. This means any URLs
1646 visited as a result of a redirection do not participate in matching.
1648 i18n.commitEncoding::
1649 Character encoding the commit messages are stored in; Git itself
1650 does not care per se, but this information is necessary e.g. when
1651 importing commits from emails or in the gitk graphical history
1652 browser (and possibly at other places in the future or in other
1653 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1655 i18n.logOutputEncoding::
1656 Character encoding the commit messages are converted to when
1657 running 'git log' and friends.
1660 The configuration variables in the 'imap' section are described
1661 in linkgit:git-imap-send[1].
1664 Specify the version with which new index files should be
1665 initialized. This does not affect existing repositories.
1668 Specify the directory from which templates will be copied.
1669 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1672 Specify the program that will be used to browse your working
1673 repository in gitweb. See linkgit:git-instaweb[1].
1676 The HTTP daemon command-line to start gitweb on your working
1677 repository. See linkgit:git-instaweb[1].
1680 If true the web server started by linkgit:git-instaweb[1] will
1681 be bound to the local IP (127.0.0.1).
1683 instaweb.modulepath::
1684 The default module path for linkgit:git-instaweb[1] to use
1685 instead of /usr/lib/apache2/modules. Only used if httpd
1689 The port number to bind the gitweb httpd to. See
1690 linkgit:git-instaweb[1].
1692 interactive.singlekey::
1693 In interactive commands, allow the user to provide one-letter
1694 input with a single key (i.e., without hitting enter).
1695 Currently this is used by the `--patch` mode of
1696 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1697 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1698 setting is silently ignored if portable keystroke input
1699 is not available; requires the Perl module Term::ReadKey.
1702 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1703 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1704 override this option with `--no-abbrev-commit`.
1707 Set the default date-time mode for the 'log' command.
1708 Setting a value for log.date is similar to using 'git log''s
1709 `--date` option. Possible values are `relative`, `local`,
1710 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1714 Print out the ref names of any commits that are shown by the log
1715 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1716 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1717 specified, the full ref name (including prefix) will be printed.
1718 This is the same as the log commands '--decorate' option.
1721 If true, the initial commit will be shown as a big creation event.
1722 This is equivalent to a diff against an empty tree.
1723 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1724 normally hide the root commit will now show it. True by default.
1727 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1728 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1731 The location of an augmenting mailmap file. The default
1732 mailmap, located in the root of the repository, is loaded
1733 first, then the mailmap file pointed to by this variable.
1734 The location of the mailmap file may be in a repository
1735 subdirectory, or somewhere outside of the repository itself.
1736 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1739 Like `mailmap.file`, but consider the value as a reference to a
1740 blob in the repository. If both `mailmap.file` and
1741 `mailmap.blob` are given, both are parsed, with entries from
1742 `mailmap.file` taking precedence. In a bare repository, this
1743 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1747 Specify the programs that may be used to display help in the
1748 'man' format. See linkgit:git-help[1].
1751 Specify the command to invoke the specified man viewer. The
1752 specified command is evaluated in shell with the man page
1753 passed as argument. (See linkgit:git-help[1].)
1756 Override the path for the given tool that may be used to
1757 display help in the 'man' format. See linkgit:git-help[1].
1759 include::merge-config.txt[]
1761 mergetool.<tool>.path::
1762 Override the path for the given tool. This is useful in case
1763 your tool is not in the PATH.
1765 mergetool.<tool>.cmd::
1766 Specify the command to invoke the specified merge tool. The
1767 specified command is evaluated in shell with the following
1768 variables available: 'BASE' is the name of a temporary file
1769 containing the common base of the files to be merged, if available;
1770 'LOCAL' is the name of a temporary file containing the contents of
1771 the file on the current branch; 'REMOTE' is the name of a temporary
1772 file containing the contents of the file from the branch being
1773 merged; 'MERGED' contains the name of the file to which the merge
1774 tool should write the results of a successful merge.
1776 mergetool.<tool>.trustExitCode::
1777 For a custom merge command, specify whether the exit code of
1778 the merge command can be used to determine whether the merge was
1779 successful. If this is not set to true then the merge target file
1780 timestamp is checked and the merge assumed to have been successful
1781 if the file has been updated, otherwise the user is prompted to
1782 indicate the success of the merge.
1784 mergetool.meld.hasOutput::
1785 Older versions of `meld` do not support the `--output` option.
1786 Git will attempt to detect whether `meld` supports `--output`
1787 by inspecting the output of `meld --help`. Configuring
1788 `mergetool.meld.hasOutput` will make Git skip these checks and
1789 use the configured value instead. Setting `mergetool.meld.hasOutput`
1790 to `true` tells Git to unconditionally use the `--output` option,
1791 and `false` avoids using `--output`.
1793 mergetool.keepBackup::
1794 After performing a merge, the original file with conflict markers
1795 can be saved as a file with a `.orig` extension. If this variable
1796 is set to `false` then this file is not preserved. Defaults to
1797 `true` (i.e. keep the backup files).
1799 mergetool.keepTemporaries::
1800 When invoking a custom merge tool, Git uses a set of temporary
1801 files to pass to the tool. If the tool returns an error and this
1802 variable is set to `true`, then these temporary files will be
1803 preserved, otherwise they will be removed after the tool has
1804 exited. Defaults to `false`.
1806 mergetool.writeToTemp::
1807 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1808 conflicting files in the worktree by default. Git will attempt
1809 to use a temporary directory for these files when set `true`.
1810 Defaults to `false`.
1813 Prompt before each invocation of the merge resolution program.
1816 The (fully qualified) refname from which to show notes when
1817 showing commit messages. The value of this variable can be set
1818 to a glob, in which case notes from all matching refs will be
1819 shown. You may also specify this configuration variable
1820 several times. A warning will be issued for refs that do not
1821 exist, but a glob that does not match any refs is silently
1824 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1825 environment variable, which must be a colon separated list of refs or
1828 The effective value of "core.notesRef" (possibly overridden by
1829 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1832 notes.rewrite.<command>::
1833 When rewriting commits with <command> (currently `amend` or
1834 `rebase`) and this variable is set to `true`, Git
1835 automatically copies your notes from the original to the
1836 rewritten commit. Defaults to `true`, but see
1837 "notes.rewriteRef" below.
1840 When copying notes during a rewrite (see the
1841 "notes.rewrite.<command>" option), determines what to do if
1842 the target commit already has a note. Must be one of
1843 `overwrite`, `concatenate`, or `ignore`. Defaults to
1846 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1847 environment variable.
1850 When copying notes during a rewrite, specifies the (fully
1851 qualified) ref whose notes should be copied. The ref may be a
1852 glob, in which case notes in all matching refs will be copied.
1853 You may also specify this configuration several times.
1855 Does not have a default value; you must configure this variable to
1856 enable note rewriting. Set it to `refs/notes/commits` to enable
1857 rewriting for the default commit notes.
1859 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1860 environment variable, which must be a colon separated list of refs or
1864 The size of the window used by linkgit:git-pack-objects[1] when no
1865 window size is given on the command line. Defaults to 10.
1868 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1869 maximum depth is given on the command line. Defaults to 50.
1872 The maximum size of memory that is consumed by each thread
1873 in linkgit:git-pack-objects[1] for pack window memory when
1874 no limit is given on the command line. The value can be
1875 suffixed with "k", "m", or "g". When left unconfigured (or
1876 set explicitly to 0), there will be no limit.
1879 An integer -1..9, indicating the compression level for objects
1880 in a pack file. -1 is the zlib default. 0 means no
1881 compression, and 1..9 are various speed/size tradeoffs, 9 being
1882 slowest. If not set, defaults to core.compression. If that is
1883 not set, defaults to -1, the zlib default, which is "a default
1884 compromise between speed and compression (currently equivalent
1887 Note that changing the compression level will not automatically recompress
1888 all existing objects. You can force recompression by passing the -F option
1889 to linkgit:git-repack[1].
1891 pack.deltaCacheSize::
1892 The maximum memory in bytes used for caching deltas in
1893 linkgit:git-pack-objects[1] before writing them out to a pack.
1894 This cache is used to speed up the writing object phase by not
1895 having to recompute the final delta result once the best match
1896 for all objects is found. Repacking large repositories on machines
1897 which are tight with memory might be badly impacted by this though,
1898 especially if this cache pushes the system into swapping.
1899 A value of 0 means no limit. The smallest size of 1 byte may be
1900 used to virtually disable this cache. Defaults to 256 MiB.
1902 pack.deltaCacheLimit::
1903 The maximum size of a delta, that is cached in
1904 linkgit:git-pack-objects[1]. This cache is used to speed up the
1905 writing object phase by not having to recompute the final delta
1906 result once the best match for all objects is found. Defaults to 1000.
1909 Specifies the number of threads to spawn when searching for best
1910 delta matches. This requires that linkgit:git-pack-objects[1]
1911 be compiled with pthreads otherwise this option is ignored with a
1912 warning. This is meant to reduce packing time on multiprocessor
1913 machines. The required amount of memory for the delta search window
1914 is however multiplied by the number of threads.
1915 Specifying 0 will cause Git to auto-detect the number of CPU's
1916 and set the number of threads accordingly.
1919 Specify the default pack index version. Valid values are 1 for
1920 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1921 the new pack index with capabilities for packs larger than 4 GB
1922 as well as proper protection against the repacking of corrupted
1923 packs. Version 2 is the default. Note that version 2 is enforced
1924 and this config option ignored whenever the corresponding pack is
1927 If you have an old Git that does not understand the version 2 `*.idx` file,
1928 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1929 that will copy both `*.pack` file and corresponding `*.idx` file from the
1930 other side may give you a repository that cannot be accessed with your
1931 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1932 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1935 pack.packSizeLimit::
1936 The maximum size of a pack. This setting only affects
1937 packing to a file when repacking, i.e. the git:// protocol
1938 is unaffected. It can be overridden by the `--max-pack-size`
1939 option of linkgit:git-repack[1]. The minimum size allowed is
1940 limited to 1 MiB. The default is unlimited.
1941 Common unit suffixes of 'k', 'm', or 'g' are
1945 When true, git will use pack bitmaps (if available) when packing
1946 to stdout (e.g., during the server side of a fetch). Defaults to
1947 true. You should not generally need to turn this off unless
1948 you are debugging pack bitmaps.
1951 This is a deprecated synonym for `repack.writeBitmaps`.
1953 pack.writeBitmapHashCache::
1954 When true, git will include a "hash cache" section in the bitmap
1955 index (if one is written). This cache can be used to feed git's
1956 delta heuristics, potentially leading to better deltas between
1957 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1958 between an older, bitmapped pack and objects that have been
1959 pushed since the last gc). The downside is that it consumes 4
1960 bytes per object of disk space, and that JGit's bitmap
1961 implementation does not understand it, causing it to complain if
1962 Git and JGit are used on the same repository. Defaults to false.
1965 If the value is boolean, turns on or off pagination of the
1966 output of a particular Git subcommand when writing to a tty.
1967 Otherwise, turns on pagination for the subcommand using the
1968 pager specified by the value of `pager.<cmd>`. If `--paginate`
1969 or `--no-pager` is specified on the command line, it takes
1970 precedence over this option. To disable pagination for all
1971 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1974 Alias for a --pretty= format string, as specified in
1975 linkgit:git-log[1]. Any aliases defined here can be used just
1976 as the built-in pretty formats could. For example,
1977 running `git config pretty.changelog "format:* %H %s"`
1978 would cause the invocation `git log --pretty=changelog`
1979 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1980 Note that an alias with the same name as a built-in format
1981 will be silently ignored.
1984 By default, Git does not create an extra merge commit when merging
1985 a commit that is a descendant of the current commit. Instead, the
1986 tip of the current branch is fast-forwarded. When set to `false`,
1987 this variable tells Git to create an extra merge commit in such
1988 a case (equivalent to giving the `--no-ff` option from the command
1989 line). When set to `only`, only such fast-forward merges are
1990 allowed (equivalent to giving the `--ff-only` option from the
1994 When true, rebase branches on top of the fetched branch, instead
1995 of merging the default branch from the default remote when "git
1996 pull" is run. See "branch.<name>.rebase" for setting this on a
1999 When preserve, also pass `--preserve-merges` along to 'git rebase'
2000 so that locally committed merge commits will not be flattened
2001 by running 'git pull'.
2003 *NOTE*: this is a possibly dangerous operation; do *not* use
2004 it unless you understand the implications (see linkgit:git-rebase[1]
2008 The default merge strategy to use when pulling multiple branches
2012 The default merge strategy to use when pulling a single branch.
2015 Defines the action `git push` should take if no refspec is
2016 explicitly given. Different values are well-suited for
2017 specific workflows; for instance, in a purely central workflow
2018 (i.e. the fetch source is equal to the push destination),
2019 `upstream` is probably what you want. Possible values are:
2023 * `nothing` - do not push anything (error out) unless a refspec is
2024 explicitly given. This is primarily meant for people who want to
2025 avoid mistakes by always being explicit.
2027 * `current` - push the current branch to update a branch with the same
2028 name on the receiving end. Works in both central and non-central
2031 * `upstream` - push the current branch back to the branch whose
2032 changes are usually integrated into the current branch (which is
2033 called `@{upstream}`). This mode only makes sense if you are
2034 pushing to the same repository you would normally pull from
2035 (i.e. central workflow).
2037 * `simple` - in centralized workflow, work like `upstream` with an
2038 added safety to refuse to push if the upstream branch's name is
2039 different from the local one.
2041 When pushing to a remote that is different from the remote you normally
2042 pull from, work as `current`. This is the safest option and is suited
2045 This mode has become the default in Git 2.0.
2047 * `matching` - push all branches having the same name on both ends.
2048 This makes the repository you are pushing to remember the set of
2049 branches that will be pushed out (e.g. if you always push 'maint'
2050 and 'master' there and no other branches, the repository you push
2051 to will have these two branches, and your local 'maint' and
2052 'master' will be pushed there).
2054 To use this mode effectively, you have to make sure _all_ the
2055 branches you would push out are ready to be pushed out before
2056 running 'git push', as the whole point of this mode is to allow you
2057 to push all of the branches in one go. If you usually finish work
2058 on only one branch and push out the result, while other branches are
2059 unfinished, this mode is not for you. Also this mode is not
2060 suitable for pushing into a shared central repository, as other
2061 people may add new branches there, or update the tip of existing
2062 branches outside your control.
2064 This used to be the default, but not since Git 2.0 (`simple` is the
2070 Whether to show a diffstat of what changed upstream since the last
2071 rebase. False by default.
2074 If set to true enable '--autosquash' option by default.
2077 When set to true, automatically create a temporary stash
2078 before the operation begins, and apply it after the operation
2079 ends. This means that you can run rebase on a dirty worktree.
2080 However, use with care: the final stash application after a
2081 successful rebase might result in non-trivial conflicts.
2085 By default, git-receive-pack will run "git-gc --auto" after
2086 receiving data from git-push and updating refs. You can stop
2087 it by setting this variable to false.
2089 receive.certnonceseed::
2090 By setting this variable to a string, `git receive-pack`
2091 will accept a `git push --signed` and verifies it by using
2092 a "nonce" protected by HMAC using this string as a secret
2095 receive.certnonceslop::
2096 When a `git push --signed` sent a push certificate with a
2097 "nonce" that was issued by a receive-pack serving the same
2098 repository within this many seconds, export the "nonce"
2099 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2100 hooks (instead of what the receive-pack asked the sending
2101 side to include). This may allow writing checks in
2102 `pre-receive` and `post-receive` a bit easier. Instead of
2103 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2104 that records by how many seconds the nonce is stale to
2105 decide if they want to accept the certificate, they only
2106 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2108 receive.fsckObjects::
2109 If it is set to true, git-receive-pack will check all received
2110 objects. It will abort in the case of a malformed object or a
2111 broken link. The result of an abort are only dangling objects.
2112 Defaults to false. If not set, the value of `transfer.fsckObjects`
2115 receive.unpackLimit::
2116 If the number of objects received in a push is below this
2117 limit then the objects will be unpacked into loose object
2118 files. However if the number of received objects equals or
2119 exceeds this limit then the received pack will be stored as
2120 a pack, after adding any missing delta bases. Storing the
2121 pack from a push can make the push operation complete faster,
2122 especially on slow filesystems. If not set, the value of
2123 `transfer.unpackLimit` is used instead.
2125 receive.denyDeletes::
2126 If set to true, git-receive-pack will deny a ref update that deletes
2127 the ref. Use this to prevent such a ref deletion via a push.
2129 receive.denyDeleteCurrent::
2130 If set to true, git-receive-pack will deny a ref update that
2131 deletes the currently checked out branch of a non-bare repository.
2133 receive.denyCurrentBranch::
2134 If set to true or "refuse", git-receive-pack will deny a ref update
2135 to the currently checked out branch of a non-bare repository.
2136 Such a push is potentially dangerous because it brings the HEAD
2137 out of sync with the index and working tree. If set to "warn",
2138 print a warning of such a push to stderr, but allow the push to
2139 proceed. If set to false or "ignore", allow such pushes with no
2140 message. Defaults to "refuse".
2142 receive.denyNonFastForwards::
2143 If set to true, git-receive-pack will deny a ref update which is
2144 not a fast-forward. Use this to prevent such an update via a push,
2145 even if that push is forced. This configuration variable is
2146 set when initializing a shared repository.
2149 String(s) `receive-pack` uses to decide which refs to omit
2150 from its initial advertisement. Use more than one
2151 definitions to specify multiple prefix strings. A ref that
2152 are under the hierarchies listed on the value of this
2153 variable is excluded, and is hidden when responding to `git
2154 push`, and an attempt to update or delete a hidden ref by
2155 `git push` is rejected.
2157 receive.updateserverinfo::
2158 If set to true, git-receive-pack will run git-update-server-info
2159 after receiving data from git-push and updating refs.
2161 receive.shallowupdate::
2162 If set to true, .git/shallow can be updated when new refs
2163 require new shallow roots. Otherwise those refs are rejected.
2165 remote.pushdefault::
2166 The remote to push to by default. Overrides
2167 `branch.<name>.remote` for all branches, and is overridden by
2168 `branch.<name>.pushremote` for specific branches.
2171 The URL of a remote repository. See linkgit:git-fetch[1] or
2172 linkgit:git-push[1].
2174 remote.<name>.pushurl::
2175 The push URL of a remote repository. See linkgit:git-push[1].
2177 remote.<name>.proxy::
2178 For remotes that require curl (http, https and ftp), the URL to
2179 the proxy to use for that remote. Set to the empty string to
2180 disable proxying for that remote.
2182 remote.<name>.fetch::
2183 The default set of "refspec" for linkgit:git-fetch[1]. See
2184 linkgit:git-fetch[1].
2186 remote.<name>.push::
2187 The default set of "refspec" for linkgit:git-push[1]. See
2188 linkgit:git-push[1].
2190 remote.<name>.mirror::
2191 If true, pushing to this remote will automatically behave
2192 as if the `--mirror` option was given on the command line.
2194 remote.<name>.skipDefaultUpdate::
2195 If true, this remote will be skipped by default when updating
2196 using linkgit:git-fetch[1] or the `update` subcommand of
2197 linkgit:git-remote[1].
2199 remote.<name>.skipFetchAll::
2200 If true, this remote will be skipped by default when updating
2201 using linkgit:git-fetch[1] or the `update` subcommand of
2202 linkgit:git-remote[1].
2204 remote.<name>.receivepack::
2205 The default program to execute on the remote side when pushing. See
2206 option \--receive-pack of linkgit:git-push[1].
2208 remote.<name>.uploadpack::
2209 The default program to execute on the remote side when fetching. See
2210 option \--upload-pack of linkgit:git-fetch-pack[1].
2212 remote.<name>.tagopt::
2213 Setting this value to \--no-tags disables automatic tag following when
2214 fetching from remote <name>. Setting it to \--tags will fetch every
2215 tag from remote <name>, even if they are not reachable from remote
2216 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2217 override this setting. See options \--tags and \--no-tags of
2218 linkgit:git-fetch[1].
2221 Setting this to a value <vcs> will cause Git to interact with
2222 the remote with the git-remote-<vcs> helper.
2224 remote.<name>.prune::
2225 When set to true, fetching from this remote by default will also
2226 remove any remote-tracking references that no longer exist on the
2227 remote (as if the `--prune` option was given on the command line).
2228 Overrides `fetch.prune` settings, if any.
2231 The list of remotes which are fetched by "git remote update
2232 <group>". See linkgit:git-remote[1].
2234 repack.usedeltabaseoffset::
2235 By default, linkgit:git-repack[1] creates packs that use
2236 delta-base offset. If you need to share your repository with
2237 Git older than version 1.4.4, either directly or via a dumb
2238 protocol such as http, then you need to set this option to
2239 "false" and repack. Access from old Git versions over the
2240 native protocol are unaffected by this option.
2242 repack.packKeptObjects::
2243 If set to true, makes `git repack` act as if
2244 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2245 details. Defaults to `false` normally, but `true` if a bitmap
2246 index is being written (either via `--write-bitmap-index` or
2247 `repack.writeBitmaps`).
2249 repack.writeBitmaps::
2250 When true, git will write a bitmap index when packing all
2251 objects to disk (e.g., when `git repack -a` is run). This
2252 index can speed up the "counting objects" phase of subsequent
2253 packs created for clones and fetches, at the cost of some disk
2254 space and extra time spent on the initial repack. Defaults to
2258 When set to true, `git-rerere` updates the index with the
2259 resulting contents after it cleanly resolves conflicts using
2260 previously recorded resolution. Defaults to false.
2263 Activate recording of resolved conflicts, so that identical
2264 conflict hunks can be resolved automatically, should they be
2265 encountered again. By default, linkgit:git-rerere[1] is
2266 enabled if there is an `rr-cache` directory under the
2267 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2270 sendemail.identity::
2271 A configuration identity. When given, causes values in the
2272 'sendemail.<identity>' subsection to take precedence over
2273 values in the 'sendemail' section. The default identity is
2274 the value of 'sendemail.identity'.
2276 sendemail.smtpencryption::
2277 See linkgit:git-send-email[1] for description. Note that this
2278 setting is not subject to the 'identity' mechanism.
2281 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2283 sendemail.smtpsslcertpath::
2284 Path to ca-certificates (either a directory or a single file).
2285 Set it to an empty string to disable certificate verification.
2287 sendemail.<identity>.*::
2288 Identity-specific versions of the 'sendemail.*' parameters
2289 found below, taking precedence over those when the this
2290 identity is selected, through command-line or
2291 'sendemail.identity'.
2293 sendemail.aliasesfile::
2294 sendemail.aliasfiletype::
2295 sendemail.annotate::
2299 sendemail.chainreplyto::
2301 sendemail.envelopesender::
2303 sendemail.multiedit::
2304 sendemail.signedoffbycc::
2305 sendemail.smtppass::
2306 sendemail.suppresscc::
2307 sendemail.suppressfrom::
2309 sendemail.smtpdomain::
2310 sendemail.smtpserver::
2311 sendemail.smtpserverport::
2312 sendemail.smtpserveroption::
2313 sendemail.smtpuser::
2315 sendemail.validate::
2316 See linkgit:git-send-email[1] for description.
2318 sendemail.signedoffcc::
2319 Deprecated alias for 'sendemail.signedoffbycc'.
2321 showbranch.default::
2322 The default set of branches for linkgit:git-show-branch[1].
2323 See linkgit:git-show-branch[1].
2325 status.relativePaths::
2326 By default, linkgit:git-status[1] shows paths relative to the
2327 current directory. Setting this variable to `false` shows paths
2328 relative to the repository root (this was the default for Git
2332 Set to true to enable --short by default in linkgit:git-status[1].
2333 The option --no-short takes precedence over this variable.
2336 Set to true to enable --branch by default in linkgit:git-status[1].
2337 The option --no-branch takes precedence over this variable.
2339 status.displayCommentPrefix::
2340 If set to true, linkgit:git-status[1] will insert a comment
2341 prefix before each output line (starting with
2342 `core.commentChar`, i.e. `#` by default). This was the
2343 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2346 status.showUntrackedFiles::
2347 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2348 files which are not currently tracked by Git. Directories which
2349 contain only untracked files, are shown with the directory name
2350 only. Showing untracked files means that Git needs to lstat() all
2351 the files in the whole repository, which might be slow on some
2352 systems. So, this variable controls how the commands displays
2353 the untracked files. Possible values are:
2356 * `no` - Show no untracked files.
2357 * `normal` - Show untracked files and directories.
2358 * `all` - Show also individual files in untracked directories.
2361 If this variable is not specified, it defaults to 'normal'.
2362 This variable can be overridden with the -u|--untracked-files option
2363 of linkgit:git-status[1] and linkgit:git-commit[1].
2365 status.submodulesummary::
2367 If this is set to a non zero number or true (identical to -1 or an
2368 unlimited number), the submodule summary will be enabled and a
2369 summary of commits for modified submodules will be shown (see
2370 --summary-limit option of linkgit:git-submodule[1]). Please note
2371 that the summary output command will be suppressed for all
2372 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2373 for those submodules where `submodule.<name>.ignore=all`. The only
2374 exception to that rule is that status and commit will show staged
2375 submodule changes. To
2376 also view the summary for ignored submodules you can either use
2377 the --ignore-submodules=dirty command-line option or the 'git
2378 submodule summary' command, which shows a similar output but does
2379 not honor these settings.
2381 submodule.<name>.path::
2382 submodule.<name>.url::
2383 submodule.<name>.update::
2384 The path within this project, URL, and the updating strategy
2385 for a submodule. These variables are initially populated
2386 by 'git submodule init'; edit them to override the
2387 URL and other values found in the `.gitmodules` file. See
2388 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2390 submodule.<name>.branch::
2391 The remote branch name for a submodule, used by `git submodule
2392 update --remote`. Set this option to override the value found in
2393 the `.gitmodules` file. See linkgit:git-submodule[1] and
2394 linkgit:gitmodules[5] for details.
2396 submodule.<name>.fetchRecurseSubmodules::
2397 This option can be used to control recursive fetching of this
2398 submodule. It can be overridden by using the --[no-]recurse-submodules
2399 command-line option to "git fetch" and "git pull".
2400 This setting will override that from in the linkgit:gitmodules[5]
2403 submodule.<name>.ignore::
2404 Defines under what circumstances "git status" and the diff family show
2405 a submodule as modified. When set to "all", it will never be considered
2406 modified (but it will nonetheless show up in the output of status and
2407 commit when it has been staged), "dirty" will ignore all changes
2408 to the submodules work tree and
2409 takes only differences between the HEAD of the submodule and the commit
2410 recorded in the superproject into account. "untracked" will additionally
2411 let submodules with modified tracked files in their work tree show up.
2412 Using "none" (the default when this option is not set) also shows
2413 submodules that have untracked files in their work tree as changed.
2414 This setting overrides any setting made in .gitmodules for this submodule,
2415 both settings can be overridden on the command line by using the
2416 "--ignore-submodules" option. The 'git submodule' commands are not
2417 affected by this setting.
2420 This variable controls the sort ordering of tags when displayed by
2421 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2422 value of this variable will be used as the default.
2425 This variable can be used to restrict the permission bits of
2426 tar archive entries. The default is 0002, which turns off the
2427 world write bit. The special value "user" indicates that the
2428 archiving user's umask will be used instead. See umask(2) and
2429 linkgit:git-archive[1].
2431 transfer.fsckObjects::
2432 When `fetch.fsckObjects` or `receive.fsckObjects` are
2433 not set, the value of this variable is used instead.
2437 This variable can be used to set both `receive.hiderefs`
2438 and `uploadpack.hiderefs` at the same time to the same
2439 values. See entries for these other variables.
2441 transfer.unpackLimit::
2442 When `fetch.unpackLimit` or `receive.unpackLimit` are
2443 not set, the value of this variable is used instead.
2444 The default value is 100.
2446 uploadarchive.allowUnreachable::
2447 If true, allow clients to use `git archive --remote` to request
2448 any tree, whether reachable from the ref tips or not. See the
2449 discussion in the `SECURITY` section of
2450 linkgit:git-upload-archive[1] for more details. Defaults to
2453 uploadpack.hiderefs::
2454 String(s) `upload-pack` uses to decide which refs to omit
2455 from its initial advertisement. Use more than one
2456 definitions to specify multiple prefix strings. A ref that
2457 are under the hierarchies listed on the value of this
2458 variable is excluded, and is hidden from `git ls-remote`,
2459 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2460 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2462 uploadpack.allowtipsha1inwant::
2463 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2464 to accept a fetch request that asks for an object at the tip
2465 of a hidden ref (by default, such a request is rejected).
2466 see also `uploadpack.hiderefs`.
2468 uploadpack.keepalive::
2469 When `upload-pack` has started `pack-objects`, there may be a
2470 quiet period while `pack-objects` prepares the pack. Normally
2471 it would output progress information, but if `--quiet` was used
2472 for the fetch, `pack-objects` will output nothing at all until
2473 the pack data begins. Some clients and networks may consider
2474 the server to be hung and give up. Setting this option instructs
2475 `upload-pack` to send an empty keepalive packet every
2476 `uploadpack.keepalive` seconds. Setting this option to 0
2477 disables keepalive packets entirely. The default is 5 seconds.
2479 url.<base>.insteadOf::
2480 Any URL that starts with this value will be rewritten to
2481 start, instead, with <base>. In cases where some site serves a
2482 large number of repositories, and serves them with multiple
2483 access methods, and some users need to use different access
2484 methods, this feature allows people to specify any of the
2485 equivalent URLs and have Git automatically rewrite the URL to
2486 the best alternative for the particular user, even for a
2487 never-before-seen repository on the site. When more than one
2488 insteadOf strings match a given URL, the longest match is used.
2490 url.<base>.pushInsteadOf::
2491 Any URL that starts with this value will not be pushed to;
2492 instead, it will be rewritten to start with <base>, and the
2493 resulting URL will be pushed to. In cases where some site serves
2494 a large number of repositories, and serves them with multiple
2495 access methods, some of which do not allow push, this feature
2496 allows people to specify a pull-only URL and have Git
2497 automatically use an appropriate URL to push, even for a
2498 never-before-seen repository on the site. When more than one
2499 pushInsteadOf strings match a given URL, the longest match is
2500 used. If a remote has an explicit pushurl, Git will ignore this
2501 setting for that remote.
2504 Your email address to be recorded in any newly created commits.
2505 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2506 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2509 Your full name to be recorded in any newly created commits.
2510 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2511 environment variables. See linkgit:git-commit-tree[1].
2514 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2515 key you want it to automatically when creating a signed tag or
2516 commit, you can override the default selection with this variable.
2517 This option is passed unchanged to gpg's --local-user parameter,
2518 so you may specify a key using any method that gpg supports.
2521 Specify a web browser that may be used by some commands.
2522 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]