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. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
138 These variables control various optional help messages designed to
139 aid new users. All 'advice.*' variables default to 'true', and you
140 can tell Git that you do not need help by setting these to 'false':
144 Set this variable to 'false' if you want to disable
145 'pushNonFFCurrent', 'pushNonFFDefault',
146 'pushNonFFMatching', 'pushAlreadyExists',
147 'pushFetchFirst', and 'pushNeedsForce'
150 Advice shown when linkgit:git-push[1] fails due to a
151 non-fast-forward update to the current branch.
153 Advice to set 'push.default' to 'upstream' or 'current'
154 when you ran linkgit:git-push[1] and pushed 'matching
155 refs' by default (i.e. you did not provide an explicit
156 refspec, and no 'push.default' configuration was set)
157 and it resulted in a non-fast-forward error.
159 Advice shown when you ran linkgit:git-push[1] and pushed
160 'matching refs' explicitly (i.e. you used ':', or
161 specified a refspec that isn't your current branch) and
162 it resulted in a non-fast-forward error.
164 Shown when linkgit:git-push[1] rejects an update that
165 does not qualify for fast-forwarding (e.g., a tag.)
167 Shown when linkgit:git-push[1] rejects an update that
168 tries to overwrite a remote ref that points at an
169 object we do not have.
171 Shown when linkgit:git-push[1] rejects an update that
172 tries to overwrite a remote ref that points at an
173 object that is not a commit-ish, or make the remote
174 ref point at an object that is not a commit-ish.
176 Show directions on how to proceed from the current
177 state in the output of linkgit:git-status[1], in
178 the template shown when writing commit messages in
179 linkgit:git-commit[1], and in the help message shown
180 by linkgit:git-checkout[1] when switching branch.
182 Advise to consider using the `-u` option to linkgit:git-status[1]
183 when the command takes more than 2 seconds to enumerate untracked
186 Advice shown when linkgit:git-merge[1] refuses to
187 merge to avoid overwriting local changes.
189 Advice shown by various commands when conflicts
190 prevent the operation from being performed.
192 Advice on how to set your identity configuration when
193 your information is guessed from the system username and
196 Advice shown when you used linkgit:git-checkout[1] to
197 move to the detach HEAD state, to instruct how to create
198 a local branch after the fact.
200 Advice that shows the location of the patch file when
201 linkgit:git-am[1] fails to apply it.
203 In case of failure in the output of linkgit:git-rm[1],
204 show directions on how to proceed from the current state.
208 If false, the executable bit differences between the index and
209 the working tree are ignored; useful on broken filesystems like FAT.
210 See linkgit:git-update-index[1].
212 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
213 will probe and set core.fileMode false if appropriate when the
214 repository is created.
217 If true, this option enables various workarounds to enable
218 Git to work better on filesystems that are not case sensitive,
219 like FAT. For example, if a directory listing finds
220 "makefile" when Git expects "Makefile", Git will assume
221 it is really the same file, and continue to remember it as
224 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
225 will probe and set core.ignorecase true if appropriate when the repository
228 core.precomposeunicode::
229 This option is only used by Mac OS implementation of Git.
230 When core.precomposeunicode=true, Git reverts the unicode decomposition
231 of filenames done by Mac OS. This is useful when sharing a repository
232 between Mac OS and Linux or Windows.
233 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
234 When false, file names are handled fully transparent by Git,
235 which is backward compatible with older versions of Git.
238 If set to true, do not allow checkout of paths that would
239 be considered equivalent to `.git` on an HFS+ filesystem.
240 Defaults to `true` on Mac OS, and `false` elsewhere.
243 If set to true, do not allow checkout of paths that would
244 cause problems with the NTFS filesystem, e.g. conflict with
246 Defaults to `true` on Windows, and `false` elsewhere.
249 If false, the ctime differences between the index and the
250 working tree are ignored; useful when the inode change time
251 is regularly modified by something outside Git (file system
252 crawlers and some backup systems).
253 See linkgit:git-update-index[1]. True by default.
256 Determines which stat fields to match between the index
257 and work tree. The user can set this to 'default' or
258 'minimal'. Default (or explicitly 'default'), is to check
259 all fields, including the sub-second part of mtime and ctime.
262 The commands that output paths (e.g. 'ls-files',
263 'diff'), when not given the `-z` option, will quote
264 "unusual" characters in the pathname by enclosing the
265 pathname in a double-quote pair and with backslashes the
266 same way strings in C source code are quoted. If this
267 variable is set to false, the bytes higher than 0x80 are
268 not quoted but output as verbatim. Note that double
269 quote, backslash and control characters are always
270 quoted without `-z` regardless of the setting of this
274 Sets the line ending type to use in the working directory for
275 files that have the `text` property set. Alternatives are
276 'lf', 'crlf' and 'native', which uses the platform's native
277 line ending. The default value is `native`. See
278 linkgit:gitattributes[5] for more information on end-of-line
282 If true, makes Git check if converting `CRLF` is reversible when
283 end-of-line conversion is active. Git will verify if a command
284 modifies a file in the work tree either directly or indirectly.
285 For example, committing a file followed by checking out the
286 same file should yield the original file in the work tree. If
287 this is not the case for the current setting of
288 `core.autocrlf`, Git will reject the file. The variable can
289 be set to "warn", in which case Git will only warn about an
290 irreversible conversion but continue the operation.
292 CRLF conversion bears a slight chance of corrupting data.
293 When it is enabled, Git will convert CRLF to LF during commit and LF to
294 CRLF during checkout. A file that contains a mixture of LF and
295 CRLF before the commit cannot be recreated by Git. For text
296 files this is the right thing to do: it corrects line endings
297 such that we have only LF line endings in the repository.
298 But for binary files that are accidentally classified as text the
299 conversion can corrupt data.
301 If you recognize such corruption early you can easily fix it by
302 setting the conversion type explicitly in .gitattributes. Right
303 after committing you still have the original file in your work
304 tree and this file is not yet corrupted. You can explicitly tell
305 Git that this file is binary and Git will handle the file
308 Unfortunately, the desired effect of cleaning up text files with
309 mixed line endings and the undesired effect of corrupting binary
310 files cannot be distinguished. In both cases CRLFs are removed
311 in an irreversible way. For text files this is the right thing
312 to do because CRLFs are line endings, while for binary files
313 converting CRLFs corrupts data.
315 Note, this safety check does not mean that a checkout will generate a
316 file identical to the original file for a different setting of
317 `core.eol` and `core.autocrlf`, but only for the current one. For
318 example, a text file with `LF` would be accepted with `core.eol=lf`
319 and could later be checked out with `core.eol=crlf`, in which case the
320 resulting file would contain `CRLF`, although the original file
321 contained `LF`. However, in both work trees the line endings would be
322 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
323 file with mixed line endings would be reported by the `core.safecrlf`
327 Setting this variable to "true" is almost the same as setting
328 the `text` attribute to "auto" on all files except that text
329 files are not guaranteed to be normalized: files that contain
330 `CRLF` in the repository will not be touched. Use this
331 setting if you want to have `CRLF` line endings in your
332 working directory even though the repository does not have
333 normalized line endings. This variable can be set to 'input',
334 in which case no output conversion is performed.
337 If false, symbolic links are checked out as small plain files that
338 contain the link text. linkgit:git-update-index[1] and
339 linkgit:git-add[1] will not change the recorded type to regular
340 file. Useful on filesystems like FAT that do not support
343 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
344 will probe and set core.symlinks false if appropriate when the repository
348 A "proxy command" to execute (as 'command host port') instead
349 of establishing direct connection to the remote server when
350 using the Git protocol for fetching. If the variable value is
351 in the "COMMAND for DOMAIN" format, the command is applied only
352 on hostnames ending with the specified domain string. This variable
353 may be set multiple times and is matched in the given order;
354 the first match wins.
356 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
357 (which always applies universally, without the special "for"
360 The special string `none` can be used as the proxy command to
361 specify that no proxy be used for a given domain pattern.
362 This is useful for excluding servers inside a firewall from
363 proxy use, while defaulting to a common proxy for external domains.
366 If true, commands which modify both the working tree and the index
367 will mark the updated paths with the "assume unchanged" bit in the
368 index. These marked files are then assumed to stay unchanged in the
369 working tree, until you mark them otherwise manually - Git will not
370 detect the file changes by lstat() calls. This is useful on systems
371 where those are very slow, such as Microsoft Windows.
372 See linkgit:git-update-index[1].
375 core.preferSymlinkRefs::
376 Instead of the default "symref" format for HEAD
377 and other symbolic reference files, use symbolic links.
378 This is sometimes needed to work with old scripts that
379 expect HEAD to be a symbolic link.
382 If true this repository is assumed to be 'bare' and has no
383 working directory associated with it. If this is the case a
384 number of commands that require a working directory will be
385 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
387 This setting is automatically guessed by linkgit:git-clone[1] or
388 linkgit:git-init[1] when the repository was created. By default a
389 repository that ends in "/.git" is assumed to be not bare (bare =
390 false), while all other repositories are assumed to be bare (bare
394 Set the path to the root of the working tree.
395 This can be overridden by the GIT_WORK_TREE environment
396 variable and the '--work-tree' command line option.
397 The value can be an absolute path or relative to the path to
398 the .git directory, which is either specified by --git-dir
399 or GIT_DIR, or automatically discovered.
400 If --git-dir or GIT_DIR is specified but none of
401 --work-tree, GIT_WORK_TREE and core.worktree is specified,
402 the current working directory is regarded as the top level
403 of your working tree.
405 Note that this variable is honored even when set in a configuration
406 file in a ".git" subdirectory of a directory and its value differs
407 from the latter directory (e.g. "/path/to/.git/config" has
408 core.worktree set to "/different/path"), which is most likely a
409 misconfiguration. Running Git commands in the "/path/to" directory will
410 still use "/different/path" as the root of the work tree and can cause
411 confusion unless you know what you are doing (e.g. you are creating a
412 read-only snapshot of the same index to a location different from the
413 repository's usual working tree).
415 core.logAllRefUpdates::
416 Enable the reflog. Updates to a ref <ref> is logged to the file
417 "$GIT_DIR/logs/<ref>", by appending the new and old
418 SHA-1, the date/time and the reason of the update, but
419 only when the file exists. If this configuration
420 variable is set to true, missing "$GIT_DIR/logs/<ref>"
421 file is automatically created for branch heads (i.e. under
422 refs/heads/), remote refs (i.e. under refs/remotes/),
423 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
425 This information can be used to determine what commit
426 was the tip of a branch "2 days ago".
428 This value is true by default in a repository that has
429 a working directory associated with it, and false by
430 default in a bare repository.
432 core.repositoryFormatVersion::
433 Internal variable identifying the repository format and layout
436 core.sharedRepository::
437 When 'group' (or 'true'), the repository is made shareable between
438 several users in a group (making sure all the files and objects are
439 group-writable). When 'all' (or 'world' or 'everybody'), the
440 repository will be readable by all users, additionally to being
441 group-shareable. When 'umask' (or 'false'), Git will use permissions
442 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
443 files in the repository will have this mode value. '0xxx' will override
444 user's umask value (whereas the other options will only override
445 requested parts of the user's umask value). Examples: '0660' will make
446 the repo read/write-able for the owner and group, but inaccessible to
447 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
448 repository that is group-readable but not group-writable.
449 See linkgit:git-init[1]. False by default.
451 core.warnAmbiguousRefs::
452 If true, Git will warn you if the ref name you passed it is ambiguous
453 and might match multiple refs in the repository. True by default.
456 An integer -1..9, indicating a default compression level.
457 -1 is the zlib default. 0 means no compression,
458 and 1..9 are various speed/size tradeoffs, 9 being slowest.
459 If set, this provides a default to other compression variables,
460 such as 'core.loosecompression' and 'pack.compression'.
462 core.loosecompression::
463 An integer -1..9, indicating the compression level for objects that
464 are not in a pack file. -1 is the zlib default. 0 means no
465 compression, and 1..9 are various speed/size tradeoffs, 9 being
466 slowest. If not set, defaults to core.compression. If that is
467 not set, defaults to 1 (best speed).
469 core.packedGitWindowSize::
470 Number of bytes of a pack file to map into memory in a
471 single mapping operation. Larger window sizes may allow
472 your system to process a smaller number of large pack files
473 more quickly. Smaller window sizes will negatively affect
474 performance due to increased calls to the operating system's
475 memory manager, but may improve performance when accessing
476 a large number of large pack files.
478 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
479 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
480 be reasonable for all users/operating systems. You probably do
481 not need to adjust this value.
483 Common unit suffixes of 'k', 'm', or 'g' are supported.
485 core.packedGitLimit::
486 Maximum number of bytes to map simultaneously into memory
487 from pack files. If Git needs to access more than this many
488 bytes at once to complete an operation it will unmap existing
489 regions to reclaim virtual address space within the process.
491 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
492 This should be reasonable for all users/operating systems, except on
493 the largest projects. You probably do not need to adjust this value.
495 Common unit suffixes of 'k', 'm', or 'g' are supported.
497 core.deltaBaseCacheLimit::
498 Maximum number of bytes to reserve for caching base objects
499 that may be referenced by multiple deltified objects. By storing the
500 entire decompressed base objects in a cache Git is able
501 to avoid unpacking and decompressing frequently used base
502 objects multiple times.
504 Default is 16 MiB on all platforms. This should be reasonable
505 for all users/operating systems, except on the largest projects.
506 You probably do not need to adjust this value.
508 Common unit suffixes of 'k', 'm', or 'g' are supported.
510 core.bigFileThreshold::
511 Files larger than this size are stored deflated, without
512 attempting delta compression. Storing large files without
513 delta compression avoids excessive memory usage, at the
514 slight expense of increased disk usage.
516 Default is 512 MiB on all platforms. This should be reasonable
517 for most projects as source code and other text files can still
518 be delta compressed, but larger binary media files won't be.
520 Common unit suffixes of 'k', 'm', or 'g' are supported.
523 In addition to '.gitignore' (per-directory) and
524 '.git/info/exclude', Git looks into this file for patterns
525 of files which are not meant to be tracked. "`~/`" is expanded
526 to the value of `$HOME` and "`~user/`" to the specified user's
527 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
528 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
529 is used instead. See linkgit:gitignore[5].
532 Some commands (e.g. svn and http interfaces) that interactively
533 ask for a password can be told to use an external program given
534 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
535 environment variable. If not set, fall back to the value of the
536 'SSH_ASKPASS' environment variable or, failing that, a simple password
537 prompt. The external program shall be given a suitable prompt as
538 command line argument and write the password on its STDOUT.
540 core.attributesfile::
541 In addition to '.gitattributes' (per-directory) and
542 '.git/info/attributes', Git looks into this file for attributes
543 (see linkgit:gitattributes[5]). Path expansions are made the same
544 way as for `core.excludesfile`. Its default value is
545 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
546 set or empty, $HOME/.config/git/attributes is used instead.
549 Commands such as `commit` and `tag` that lets you edit
550 messages by launching an editor uses the value of this
551 variable when it is set, and the environment variable
552 `GIT_EDITOR` is not set. See linkgit:git-var[1].
555 Commands such as `commit` and `tag` that lets you edit
556 messages consider a line that begins with this character
557 commented, and removes them after the editor returns
561 Text editor used by `git rebase -i` for editing the rebase instruction file.
562 The value is meant to be interpreted by the shell when it is used.
563 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
564 When not configured the default commit message editor is used instead.
567 Text viewer for use by Git commands (e.g., 'less'). The value
568 is meant to be interpreted by the shell. The order of preference
569 is the `$GIT_PAGER` environment variable, then `core.pager`
570 configuration, then `$PAGER`, and then the default chosen at
571 compile time (usually 'less').
573 When the `LESS` environment variable is unset, Git sets it to `FRSX`
574 (if `LESS` environment variable is set, Git does not change it at
575 all). If you want to selectively override Git's default setting
576 for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
577 be passed to the shell by Git, which will translate the final
578 command to `LESS=FRSX less -+S`. The environment tells the command
579 to set the `S` option to chop long lines but the command line
580 resets it to the default to fold long lines.
582 Likewise, when the `LV` environment variable is unset, Git sets it
583 to `-c`. You can override this setting by exporting `LV` with
584 another value or setting `core.pager` to `lv +c`.
587 A comma separated list of common whitespace problems to
588 notice. 'git diff' will use `color.diff.whitespace` to
589 highlight them, and 'git apply --whitespace=error' will
590 consider them as errors. You can prefix `-` to disable
591 any of them (e.g. `-trailing-space`):
593 * `blank-at-eol` treats trailing whitespaces at the end of the line
594 as an error (enabled by default).
595 * `space-before-tab` treats a space character that appears immediately
596 before a tab character in the initial indent part of the line as an
597 error (enabled by default).
598 * `indent-with-non-tab` treats a line that is indented with space
599 characters instead of the equivalent tabs as an error (not enabled by
601 * `tab-in-indent` treats a tab character in the initial indent part of
602 the line as an error (not enabled by default).
603 * `blank-at-eof` treats blank lines added at the end of file as an error
604 (enabled by default).
605 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
607 * `cr-at-eol` treats a carriage-return at the end of line as
608 part of the line terminator, i.e. with it, `trailing-space`
609 does not trigger if the character before such a carriage-return
610 is not a whitespace (not enabled by default).
611 * `tabwidth=<n>` tells how many character positions a tab occupies; this
612 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
613 errors. The default tab width is 8. Allowed values are 1 to 63.
615 core.fsyncobjectfiles::
616 This boolean will enable 'fsync()' when writing object files.
618 This is a total waste of time and effort on a filesystem that orders
619 data writes properly, but can be useful for filesystems that do not use
620 journalling (traditional UNIX filesystems) or that only journal metadata
621 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
624 Enable parallel index preload for operations like 'git diff'
626 This can speed up operations like 'git diff' and 'git status' especially
627 on filesystems like NFS that have weak caching semantics and thus
628 relatively high IO latencies. With this set to 'true', Git will do the
629 index comparison to the filesystem data in parallel, allowing
633 You can set this to 'link', in which case a hardlink followed by
634 a delete of the source are used to make sure that object creation
635 will not overwrite existing objects.
637 On some file system/operating system combinations, this is unreliable.
638 Set this config setting to 'rename' there; However, This will remove the
639 check that makes sure that existing object files will not get overwritten.
642 When showing commit messages, also show notes which are stored in
643 the given ref. The ref must be fully qualified. If the given
644 ref does not exist, it is not an error but means that no
645 notes should be printed.
647 This setting defaults to "refs/notes/commits", and it can be overridden by
648 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
650 core.sparseCheckout::
651 Enable "sparse checkout" feature. See section "Sparse checkout" in
652 linkgit:git-read-tree[1] for more information.
655 Set the length object names are abbreviated to. If unspecified,
656 many commands abbreviate to 7 hexdigits, which may not be enough
657 for abbreviated object names to stay unique for sufficiently long
662 Tells 'git add' to continue adding files when some files cannot be
663 added due to indexing errors. Equivalent to the '--ignore-errors'
664 option of linkgit:git-add[1]. Older versions of Git accept only
665 `add.ignore-errors`, which does not follow the usual naming
666 convention for configuration variables. Newer versions of Git
667 honor `add.ignoreErrors` as well.
670 Command aliases for the linkgit:git[1] command wrapper - e.g.
671 after defining "alias.last = cat-file commit HEAD", the invocation
672 "git last" is equivalent to "git cat-file commit HEAD". To avoid
673 confusion and troubles with script usage, aliases that
674 hide existing Git commands are ignored. Arguments are split by
675 spaces, the usual shell quoting and escaping is supported.
676 quote pair and a backslash can be used to quote them.
678 If the alias expansion is prefixed with an exclamation point,
679 it will be treated as a shell command. For example, defining
680 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
681 "git new" is equivalent to running the shell command
682 "gitk --all --not ORIG_HEAD". Note that shell commands will be
683 executed from the top-level directory of a repository, which may
684 not necessarily be the current directory.
685 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
686 from the original current directory. See linkgit:git-rev-parse[1].
689 If true, git-am will call git-mailsplit for patches in mbox format
690 with parameter '--keep-cr'. In this case git-mailsplit will
691 not remove `\r` from lines ending with `\r\n`. Can be overridden
692 by giving '--no-keep-cr' from the command line.
693 See linkgit:git-am[1], linkgit:git-mailsplit[1].
695 apply.ignorewhitespace::
696 When set to 'change', tells 'git apply' to ignore changes in
697 whitespace, in the same way as the '--ignore-space-change'
699 When set to one of: no, none, never, false tells 'git apply' to
700 respect all whitespace differences.
701 See linkgit:git-apply[1].
704 Tells 'git apply' how to handle whitespaces, in the same way
705 as the '--whitespace' option. See linkgit:git-apply[1].
707 branch.autosetupmerge::
708 Tells 'git branch' and 'git checkout' to set up new branches
709 so that linkgit:git-pull[1] will appropriately merge from the
710 starting point branch. Note that even if this option is not set,
711 this behavior can be chosen per-branch using the `--track`
712 and `--no-track` options. The valid settings are: `false` -- no
713 automatic setup is done; `true` -- automatic setup is done when the
714 starting point is a remote-tracking branch; `always` --
715 automatic setup is done when the starting point is either a
716 local branch or remote-tracking
717 branch. This option defaults to true.
719 branch.autosetuprebase::
720 When a new branch is created with 'git branch' or 'git checkout'
721 that tracks another branch, this variable tells Git to set
722 up pull to rebase instead of merge (see "branch.<name>.rebase").
723 When `never`, rebase is never automatically set to true.
724 When `local`, rebase is set to true for tracked branches of
725 other local branches.
726 When `remote`, rebase is set to true for tracked branches of
727 remote-tracking branches.
728 When `always`, rebase will be set to true for all tracking
730 See "branch.autosetupmerge" for details on how to set up a
731 branch to track another branch.
732 This option defaults to never.
734 branch.<name>.remote::
735 When on branch <name>, it tells 'git fetch' and 'git push'
736 which remote to fetch from/push to. The remote to push to
737 may be overridden with `remote.pushdefault` (for all branches).
738 The remote to push to, for the current branch, may be further
739 overridden by `branch.<name>.pushremote`. If no remote is
740 configured, or if you are not on any branch, it defaults to
741 `origin` for fetching and `remote.pushdefault` for pushing.
742 Additionally, `.` (a period) is the current local repository
743 (a dot-repository), see `branch.<name>.merge`'s final note below.
745 branch.<name>.pushremote::
746 When on branch <name>, it overrides `branch.<name>.remote` for
747 pushing. It also overrides `remote.pushdefault` for pushing
748 from branch <name>. When you pull from one place (e.g. your
749 upstream) and push to another place (e.g. your own publishing
750 repository), you would want to set `remote.pushdefault` to
751 specify the remote to push to for all branches, and use this
752 option to override it for a specific branch.
754 branch.<name>.merge::
755 Defines, together with branch.<name>.remote, the upstream branch
756 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
757 branch to merge and can also affect 'git push' (see push.default).
758 When in branch <name>, it tells 'git fetch' the default
759 refspec to be marked for merging in FETCH_HEAD. The value is
760 handled like the remote part of a refspec, and must match a
761 ref which is fetched from the remote given by
762 "branch.<name>.remote".
763 The merge information is used by 'git pull' (which at first calls
764 'git fetch') to lookup the default branch for merging. Without
765 this option, 'git pull' defaults to merge the first refspec fetched.
766 Specify multiple values to get an octopus merge.
767 If you wish to setup 'git pull' so that it merges into <name> from
768 another branch in the local repository, you can point
769 branch.<name>.merge to the desired branch, and use the relative path
770 setting `.` (a period) for branch.<name>.remote.
772 branch.<name>.mergeoptions::
773 Sets default options for merging into branch <name>. The syntax and
774 supported options are the same as those of linkgit:git-merge[1], but
775 option values containing whitespace characters are currently not
778 branch.<name>.rebase::
779 When true, rebase the branch <name> on top of the fetched branch,
780 instead of merging the default branch from the default remote when
781 "git pull" is run. See "pull.rebase" for doing this in a non
782 branch-specific manner.
784 When preserve, also pass `--preserve-merges` along to 'git rebase'
785 so that locally committed merge commits will not be flattened
786 by running 'git pull'.
788 *NOTE*: this is a possibly dangerous operation; do *not* use
789 it unless you understand the implications (see linkgit:git-rebase[1]
792 branch.<name>.description::
793 Branch description, can be edited with
794 `git branch --edit-description`. Branch description is
795 automatically added in the format-patch cover letter or
796 request-pull summary.
799 Specify the command to invoke the specified browser. The
800 specified command is evaluated in shell with the URLs passed
801 as arguments. (See linkgit:git-web{litdd}browse[1].)
803 browser.<tool>.path::
804 Override the path for the given tool that may be used to
805 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
806 working repository in gitweb (see linkgit:git-instaweb[1]).
809 A boolean to make git-clean do nothing unless given -f,
810 -i or -n. Defaults to true.
813 A boolean to enable/disable color in the output of
814 linkgit:git-branch[1]. May be set to `always`,
815 `false` (or `never`) or `auto` (or `true`), in which case colors are used
816 only when the output is to a terminal. Defaults to false.
818 color.branch.<slot>::
819 Use customized color for branch coloration. `<slot>` is one of
820 `current` (the current branch), `local` (a local branch),
821 `remote` (a remote-tracking branch in refs/remotes/),
822 `upstream` (upstream tracking branch), `plain` (other
825 The value for these configuration variables is a list of colors (at most
826 two) and attributes (at most one), separated by spaces. The colors
827 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
828 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
829 `blink` and `reverse`. The first color given is the foreground; the
830 second is the background. The position of the attribute, if any,
834 Whether to use ANSI escape sequences to add color to patches.
835 If this is set to `always`, linkgit:git-diff[1],
836 linkgit:git-log[1], and linkgit:git-show[1] will use color
837 for all patches. If it is set to `true` or `auto`, those
838 commands will only use color when output is to the terminal.
841 This does not affect linkgit:git-format-patch[1] or the
842 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
843 command line with the `--color[=<when>]` option.
846 Use customized color for diff colorization. `<slot>` specifies
847 which part of the patch to use the specified color, and is one
848 of `plain` (context text), `meta` (metainformation), `frag`
849 (hunk header), 'func' (function in hunk header), `old` (removed lines),
850 `new` (added lines), `commit` (commit headers), or `whitespace`
851 (highlighting whitespace errors). The values of these variables may be
852 specified as in color.branch.<slot>.
854 color.decorate.<slot>::
855 Use customized color for 'git log --decorate' output. `<slot>` is one
856 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
857 branches, remote-tracking branches, tags, stash and HEAD, respectively.
860 When set to `always`, always highlight matches. When `false` (or
861 `never`), never. When set to `true` or `auto`, use color only
862 when the output is written to the terminal. Defaults to `false`.
865 Use customized color for grep colorization. `<slot>` specifies which
866 part of the line to use the specified color, and is one of
870 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
872 filename prefix (when not using `-h`)
874 function name lines (when using `-p`)
876 line number prefix (when using `-n`)
880 non-matching text in selected lines
882 separators between fields on a line (`:`, `-`, and `=`)
883 and between hunks (`--`)
886 The values of these variables may be specified as in color.branch.<slot>.
889 When set to `always`, always use colors for interactive prompts
890 and displays (such as those used by "git-add --interactive" and
891 "git-clean --interactive"). When false (or `never`), never.
892 When set to `true` or `auto`, use colors only when the output is
893 to the terminal. Defaults to false.
895 color.interactive.<slot>::
896 Use customized color for 'git add --interactive' and 'git clean
897 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
898 or `error`, for four distinct types of normal output from
899 interactive commands. The values of these variables may be
900 specified as in color.branch.<slot>.
903 A boolean to enable/disable colored output when the pager is in
904 use (default is true).
907 A boolean to enable/disable color in the output of
908 linkgit:git-show-branch[1]. May be set to `always`,
909 `false` (or `never`) or `auto` (or `true`), in which case colors are used
910 only when the output is to a terminal. Defaults to false.
913 A boolean to enable/disable color in the output of
914 linkgit:git-status[1]. May be set to `always`,
915 `false` (or `never`) or `auto` (or `true`), in which case colors are used
916 only when the output is to a terminal. Defaults to false.
918 color.status.<slot>::
919 Use customized color for status colorization. `<slot>` is
920 one of `header` (the header text of the status message),
921 `added` or `updated` (files which are added but not committed),
922 `changed` (files which are changed but not added in the index),
923 `untracked` (files which are not tracked by Git),
924 `branch` (the current branch), or
925 `nobranch` (the color the 'no branch' warning is shown in, defaulting
926 to red). The values of these variables may be specified as in
930 This variable determines the default value for variables such
931 as `color.diff` and `color.grep` that control the use of color
932 per command family. Its scope will expand as more commands learn
933 configuration to set a default for the `--color` option. Set it
934 to `false` or `never` if you prefer Git commands not to use
935 color unless enabled explicitly with some other configuration
936 or the `--color` option. Set it to `always` if you want all
937 output not intended for machine consumption to use color, to
938 `true` or `auto` (this is the default since Git 1.8.4) if you
939 want such output to use color when written to the terminal.
942 Specify whether supported commands should output in columns.
943 This variable consists of a list of tokens separated by spaces
946 These options control when the feature should be enabled
947 (defaults to 'never'):
951 always show in columns
953 never show in columns
955 show in columns if the output is to the terminal
958 These options control layout (defaults to 'column'). Setting any
959 of these implies 'always' if none of 'always', 'never', or 'auto' are
964 fill columns before rows
966 fill rows before columns
971 Finally, these options can be combined with a layout option (defaults
976 make unequal size columns to utilize more space
978 make equal size columns
982 Specify whether to output branch listing in `git branch` in columns.
983 See `column.ui` for details.
986 Specify the layout when list items in `git clean -i`, which always
987 shows files and directories in columns. See `column.ui` for details.
990 Specify whether to output untracked files in `git status` in columns.
991 See `column.ui` for details.
994 Specify whether to output tag listing in `git tag` in columns.
995 See `column.ui` for details.
998 This setting overrides the default of the `--cleanup` option in
999 `git commit`. See linkgit:git-commit[1] for details. Changing the
1000 default can be useful when you always want to keep lines that begin
1001 with comment character `#` in your log message, in which case you
1002 would do `git config commit.cleanup whitespace` (note that you will
1003 have to remove the help lines that begin with `#` in the commit log
1004 template yourself, if you do this).
1007 A boolean to enable/disable inclusion of status information in the
1008 commit message template when using an editor to prepare the commit
1009 message. Defaults to true.
1012 Specify a file to use as the template for new commit messages.
1013 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1014 specified user's home directory.
1017 Specify an external helper to be called when a username or
1018 password credential is needed; the helper may consult external
1019 storage to avoid prompting the user for the credentials. See
1020 linkgit:gitcredentials[7] for details.
1022 credential.useHttpPath::
1023 When acquiring credentials, consider the "path" component of an http
1024 or https URL to be important. Defaults to false. See
1025 linkgit:gitcredentials[7] for more information.
1027 credential.username::
1028 If no username is set for a network authentication, use this username
1029 by default. See credential.<context>.* below, and
1030 linkgit:gitcredentials[7].
1032 credential.<url>.*::
1033 Any of the credential.* options above can be applied selectively to
1034 some credentials. For example "credential.https://example.com.username"
1035 would set the default username only for https connections to
1036 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1039 include::diff-config.txt[]
1041 difftool.<tool>.path::
1042 Override the path for the given tool. This is useful in case
1043 your tool is not in the PATH.
1045 difftool.<tool>.cmd::
1046 Specify the command to invoke the specified diff tool.
1047 The specified command is evaluated in shell with the following
1048 variables available: 'LOCAL' is set to the name of the temporary
1049 file containing the contents of the diff pre-image and 'REMOTE'
1050 is set to the name of the temporary file containing the contents
1051 of the diff post-image.
1054 Prompt before each invocation of the diff tool.
1056 fetch.recurseSubmodules::
1057 This option can be either set to a boolean value or to 'on-demand'.
1058 Setting it to a boolean changes the behavior of fetch and pull to
1059 unconditionally recurse into submodules when set to true or to not
1060 recurse at all when set to false. When set to 'on-demand' (the default
1061 value), fetch and pull will only recurse into a populated submodule
1062 when its superproject retrieves a commit that updates the submodule's
1066 If it is set to true, git-fetch-pack will check all fetched
1067 objects. It will abort in the case of a malformed object or a
1068 broken link. The result of an abort are only dangling objects.
1069 Defaults to false. If not set, the value of `transfer.fsckObjects`
1073 If the number of objects fetched over the Git native
1074 transfer is below this
1075 limit, then the objects will be unpacked into loose object
1076 files. However if the number of received objects equals or
1077 exceeds this limit then the received pack will be stored as
1078 a pack, after adding any missing delta bases. Storing the
1079 pack from a push can make the push operation complete faster,
1080 especially on slow filesystems. If not set, the value of
1081 `transfer.unpackLimit` is used instead.
1084 If true, fetch will automatically behave as if the `--prune`
1085 option was given on the command line. See also `remote.<name>.prune`.
1088 Enable multipart/mixed attachments as the default for
1089 'format-patch'. The value can also be a double quoted string
1090 which will enable attachments as the default and set the
1091 value as the boundary. See the --attach option in
1092 linkgit:git-format-patch[1].
1095 A boolean which can enable or disable sequence numbers in patch
1096 subjects. It defaults to "auto" which enables it only if there
1097 is more than one patch. It can be enabled or disabled for all
1098 messages by setting it to "true" or "false". See --numbered
1099 option in linkgit:git-format-patch[1].
1102 Additional email headers to include in a patch to be submitted
1103 by mail. See linkgit:git-format-patch[1].
1107 Additional recipients to include in a patch to be submitted
1108 by mail. See the --to and --cc options in
1109 linkgit:git-format-patch[1].
1111 format.subjectprefix::
1112 The default for format-patch is to output files with the '[PATCH]'
1113 subject prefix. Use this variable to change that prefix.
1116 The default for format-patch is to output a signature containing
1117 the Git version number. Use this variable to change that default.
1118 Set this variable to the empty string ("") to suppress
1119 signature generation.
1122 The default for format-patch is to output files with the suffix
1123 `.patch`. Use this variable to change that suffix (make sure to
1124 include the dot if you want it).
1127 The default pretty format for log/show/whatchanged command,
1128 See linkgit:git-log[1], linkgit:git-show[1],
1129 linkgit:git-whatchanged[1].
1132 The default threading style for 'git format-patch'. Can be
1133 a boolean value, or `shallow` or `deep`. `shallow` threading
1134 makes every mail a reply to the head of the series,
1135 where the head is chosen from the cover letter, the
1136 `--in-reply-to`, and the first patch mail, in this order.
1137 `deep` threading makes every mail a reply to the previous one.
1138 A true boolean value is the same as `shallow`, and a false
1139 value disables threading.
1142 A boolean value which lets you enable the `-s/--signoff` option of
1143 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1144 patch should be a conscious act and means that you certify you have
1145 the rights to submit this work under the same open source license.
1146 Please see the 'SubmittingPatches' document for further discussion.
1148 format.coverLetter::
1149 A boolean that controls whether to generate a cover-letter when
1150 format-patch is invoked, but in addition can be set to "auto", to
1151 generate a cover-letter only when there's more than one patch.
1153 filter.<driver>.clean::
1154 The command which is used to convert the content of a worktree
1155 file to a blob upon checkin. See linkgit:gitattributes[5] for
1158 filter.<driver>.smudge::
1159 The command which is used to convert the content of a blob
1160 object to a worktree file upon checkout. See
1161 linkgit:gitattributes[5] for details.
1163 gc.aggressiveWindow::
1164 The window size parameter used in the delta compression
1165 algorithm used by 'git gc --aggressive'. This defaults
1169 When there are approximately more than this many loose
1170 objects in the repository, `git gc --auto` will pack them.
1171 Some Porcelain commands use this command to perform a
1172 light-weight garbage collection from time to time. The
1173 default value is 6700. Setting this to 0 disables it.
1176 When there are more than this many packs that are not
1177 marked with `*.keep` file in the repository, `git gc
1178 --auto` consolidates them into one larger pack. The
1179 default value is 50. Setting this to 0 disables it.
1182 Running `git pack-refs` in a repository renders it
1183 unclonable by Git versions prior to 1.5.1.2 over dumb
1184 transports such as HTTP. This variable determines whether
1185 'git gc' runs `git pack-refs`. This can be set to `notbare`
1186 to enable it within all non-bare repos or it can be set to a
1187 boolean value. The default is `true`.
1190 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1191 Override the grace period with this config variable. The value
1192 "now" may be used to disable this grace period and always prune
1193 unreachable objects immediately.
1196 gc.<pattern>.reflogexpire::
1197 'git reflog expire' removes reflog entries older than
1198 this time; defaults to 90 days. With "<pattern>" (e.g.
1199 "refs/stash") in the middle the setting applies only to
1200 the refs that match the <pattern>.
1202 gc.reflogexpireunreachable::
1203 gc.<ref>.reflogexpireunreachable::
1204 'git reflog expire' removes reflog entries older than
1205 this time and are not reachable from the current tip;
1206 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1207 in the middle, the setting applies only to the refs that
1208 match the <pattern>.
1211 Records of conflicted merge you resolved earlier are
1212 kept for this many days when 'git rerere gc' is run.
1213 The default is 60 days. See linkgit:git-rerere[1].
1215 gc.rerereunresolved::
1216 Records of conflicted merge you have not resolved are
1217 kept for this many days when 'git rerere gc' is run.
1218 The default is 15 days. See linkgit:git-rerere[1].
1220 gitcvs.commitmsgannotation::
1221 Append this string to each commit message. Set to empty string
1222 to disable this feature. Defaults to "via git-CVS emulator".
1225 Whether the CVS server interface is enabled for this repository.
1226 See linkgit:git-cvsserver[1].
1229 Path to a log file where the CVS server interface well... logs
1230 various stuff. See linkgit:git-cvsserver[1].
1232 gitcvs.usecrlfattr::
1233 If true, the server will look up the end-of-line conversion
1234 attributes for files to determine the '-k' modes to use. If
1235 the attributes force Git to treat a file as text,
1236 the '-k' mode will be left blank so CVS clients will
1237 treat it as text. If they suppress text conversion, the file
1238 will be set with '-kb' mode, which suppresses any newline munging
1239 the client might otherwise do. If the attributes do not allow
1240 the file type to be determined, then 'gitcvs.allbinary' is
1241 used. See linkgit:gitattributes[5].
1244 This is used if 'gitcvs.usecrlfattr' does not resolve
1245 the correct '-kb' mode to use. If true, all
1246 unresolved files are sent to the client in
1247 mode '-kb'. This causes the client to treat them
1248 as binary files, which suppresses any newline munging it
1249 otherwise might do. Alternatively, if it is set to "guess",
1250 then the contents of the file are examined to decide if
1251 it is binary, similar to 'core.autocrlf'.
1254 Database used by git-cvsserver to cache revision information
1255 derived from the Git repository. The exact meaning depends on the
1256 used database driver, for SQLite (which is the default driver) this
1257 is a filename. Supports variable substitution (see
1258 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1259 Default: '%Ggitcvs.%m.sqlite'
1262 Used Perl DBI driver. You can specify any available driver
1263 for this here, but it might not work. git-cvsserver is tested
1264 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1265 reported *not* to work with 'DBD::mysql'. Experimental feature.
1266 May not contain double colons (`:`). Default: 'SQLite'.
1267 See linkgit:git-cvsserver[1].
1269 gitcvs.dbuser, gitcvs.dbpass::
1270 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1271 since SQLite has no concept of database users and/or passwords.
1272 'gitcvs.dbuser' supports variable substitution (see
1273 linkgit:git-cvsserver[1] for details).
1275 gitcvs.dbTableNamePrefix::
1276 Database table name prefix. Prepended to the names of any
1277 database tables used, allowing a single database to be used
1278 for several repositories. Supports variable substitution (see
1279 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1280 characters will be replaced with underscores.
1282 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1283 'gitcvs.allbinary' can also be specified as
1284 'gitcvs.<access_method>.<varname>' (where 'access_method'
1285 is one of "ext" and "pserver") to make them apply only for the given
1289 gitweb.description::
1292 See linkgit:gitweb[1] for description.
1300 gitweb.remote_heads::
1303 See linkgit:gitweb.conf[5] for description.
1306 If set to true, enable '-n' option by default.
1309 Set the default matching behavior. Using a value of 'basic', 'extended',
1310 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1311 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1312 value 'default' will return to the default matching behavior.
1314 grep.extendedRegexp::
1315 If set to true, enable '--extended-regexp' option by default. This
1316 option is ignored when the 'grep.patternType' option is set to a value
1317 other than 'default'.
1320 Use this custom program instead of "gpg" found on $PATH when
1321 making or verifying a PGP signature. The program must support the
1322 same command line interface as GPG, namely, to verify a detached
1323 signature, "gpg --verify $file - <$signature" is run, and the
1324 program is expected to signal a good signature by exiting with
1325 code 0, and to generate an ascii-armored detached signature, the
1326 standard input of "gpg -bsau $key" is fed with the contents to be
1327 signed, and the program is expected to send the result to its
1330 gui.commitmsgwidth::
1331 Defines how wide the commit message window is in the
1332 linkgit:git-gui[1]. "75" is the default.
1335 Specifies how many context lines should be used in calls to diff
1336 made by the linkgit:git-gui[1]. The default is "5".
1339 Specifies the default encoding to use for displaying of
1340 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1341 It can be overridden by setting the 'encoding' attribute
1342 for relevant files (see linkgit:gitattributes[5]).
1343 If this option is not set, the tools default to the
1346 gui.matchtrackingbranch::
1347 Determines if new branches created with linkgit:git-gui[1] should
1348 default to tracking remote branches with matching names or
1349 not. Default: "false".
1351 gui.newbranchtemplate::
1352 Is used as suggested name when creating new branches using the
1355 gui.pruneduringfetch::
1356 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1357 performing a fetch. The default value is "false".
1360 Determines if linkgit:git-gui[1] should trust the file modification
1361 timestamp or not. By default the timestamps are not trusted.
1363 gui.spellingdictionary::
1364 Specifies the dictionary used for spell checking commit messages in
1365 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1369 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1370 location detection. It makes blame significantly faster on huge
1371 repositories at the expense of less thorough copy detection.
1373 gui.copyblamethreshold::
1374 Specifies the threshold to use in 'git gui blame' original location
1375 detection, measured in alphanumeric characters. See the
1376 linkgit:git-blame[1] manual for more information on copy detection.
1378 gui.blamehistoryctx::
1379 Specifies the radius of history context in days to show in
1380 linkgit:gitk[1] for the selected commit, when the `Show History
1381 Context` menu item is invoked from 'git gui blame'. If this
1382 variable is set to zero, the whole history is shown.
1384 guitool.<name>.cmd::
1385 Specifies the shell command line to execute when the corresponding item
1386 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1387 mandatory for every tool. The command is executed from the root of
1388 the working directory, and in the environment it receives the name of
1389 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1390 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1391 the head is detached, 'CUR_BRANCH' is empty).
1393 guitool.<name>.needsfile::
1394 Run the tool only if a diff is selected in the GUI. It guarantees
1395 that 'FILENAME' is not empty.
1397 guitool.<name>.noconsole::
1398 Run the command silently, without creating a window to display its
1401 guitool.<name>.norescan::
1402 Don't rescan the working directory for changes after the tool
1405 guitool.<name>.confirm::
1406 Show a confirmation dialog before actually running the tool.
1408 guitool.<name>.argprompt::
1409 Request a string argument from the user, and pass it to the tool
1410 through the 'ARGS' environment variable. Since requesting an
1411 argument implies confirmation, the 'confirm' option has no effect
1412 if this is enabled. If the option is set to 'true', 'yes', or '1',
1413 the dialog uses a built-in generic prompt; otherwise the exact
1414 value of the variable is used.
1416 guitool.<name>.revprompt::
1417 Request a single valid revision from the user, and set the
1418 'REVISION' environment variable. In other aspects this option
1419 is similar to 'argprompt', and can be used together with it.
1421 guitool.<name>.revunmerged::
1422 Show only unmerged branches in the 'revprompt' subdialog.
1423 This is useful for tools similar to merge or rebase, but not
1424 for things like checkout or reset.
1426 guitool.<name>.title::
1427 Specifies the title to use for the prompt dialog. The default
1430 guitool.<name>.prompt::
1431 Specifies the general prompt string to display at the top of
1432 the dialog, before subsections for 'argprompt' and 'revprompt'.
1433 The default value includes the actual command.
1436 Specify the browser that will be used to display help in the
1437 'web' format. See linkgit:git-help[1].
1440 Override the default help format used by linkgit:git-help[1].
1441 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1442 the default. 'web' and 'html' are the same.
1445 Automatically correct and execute mistyped commands after
1446 waiting for the given number of deciseconds (0.1 sec). If more
1447 than one command can be deduced from the entered text, nothing
1448 will be executed. If the value of this option is negative,
1449 the corrected command will be executed immediately. If the
1450 value is 0 - the command will be just shown but not executed.
1451 This is the default.
1454 Specify the path where the HTML documentation resides. File system paths
1455 and URLs are supported. HTML pages will be prefixed with this path when
1456 help is displayed in the 'web' format. This defaults to the documentation
1457 path of your Git installation.
1460 Override the HTTP proxy, normally configured using the 'http_proxy',
1461 'https_proxy', and 'all_proxy' environment variables (see
1462 `curl(1)`). This can be overridden on a per-remote basis; see
1466 File containing previously stored cookie lines which should be used
1467 in the Git http session, if they match the server. The file format
1468 of the file to read cookies from should be plain HTTP headers or
1469 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1470 NOTE that the file specified with http.cookiefile is only used as
1471 input unless http.saveCookies is set.
1474 If set, store cookies received during requests to the file specified by
1475 http.cookiefile. Has no effect if http.cookiefile is unset.
1478 Whether to verify the SSL certificate when fetching or pushing
1479 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1483 File containing the SSL certificate when fetching or pushing
1484 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1488 File containing the SSL private key when fetching or pushing
1489 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1492 http.sslCertPasswordProtected::
1493 Enable Git's password prompt for the SSL certificate. Otherwise
1494 OpenSSL will prompt the user, possibly many times, if the
1495 certificate or private key is encrypted. Can be overridden by the
1496 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1499 File containing the certificates to verify the peer with when
1500 fetching or pushing over HTTPS. Can be overridden by the
1501 'GIT_SSL_CAINFO' environment variable.
1504 Path containing files with the CA certificates to verify the peer
1505 with when fetching or pushing over HTTPS. Can be overridden
1506 by the 'GIT_SSL_CAPATH' environment variable.
1509 Attempt to use AUTH SSL/TLS and encrypted data transfers
1510 when connecting via regular FTP protocol. This might be needed
1511 if the FTP server requires it for security reasons or you wish
1512 to connect securely whenever remote FTP server supports it.
1513 Default is false since it might trigger certificate verification
1514 errors on misconfigured servers.
1517 How many HTTP requests to launch in parallel. Can be overridden
1518 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1521 The number of curl sessions (counted across slots) to be kept across
1522 requests. They will not be ended with curl_easy_cleanup() until
1523 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1524 value will be capped at 1. Defaults to 1.
1527 Maximum size in bytes of the buffer used by smart HTTP
1528 transports when POSTing data to the remote system.
1529 For requests larger than this buffer size, HTTP/1.1 and
1530 Transfer-Encoding: chunked is used to avoid creating a
1531 massive pack file locally. Default is 1 MiB, which is
1532 sufficient for most requests.
1534 http.lowSpeedLimit, http.lowSpeedTime::
1535 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1536 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1537 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1538 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1541 A boolean which disables using of EPSV ftp command by curl.
1542 This can helpful with some "poor" ftp servers which don't
1543 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1544 environment variable. Default is false (curl will use EPSV).
1547 The HTTP USER_AGENT string presented to an HTTP server. The default
1548 value represents the version of the client Git such as git/1.7.1.
1549 This option allows you to override this value to a more common value
1550 such as Mozilla/4.0. This may be necessary, for instance, if
1551 connecting through a firewall that restricts HTTP connections to a set
1552 of common USER_AGENT strings (but not including those like git/1.7.1).
1553 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1556 Any of the http.* options above can be applied selectively to some urls.
1557 For a config key to match a URL, each element of the config key is
1558 compared to that of the URL, in the following order:
1561 . Scheme (e.g., `https` in `https://example.com/`). This field
1562 must match exactly between the config key and the URL.
1564 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1565 This field must match exactly between the config key and the URL.
1567 . Port number (e.g., `8080` in `http://example.com:8080/`).
1568 This field must match exactly between the config key and the URL.
1569 Omitted port numbers are automatically converted to the correct
1570 default for the scheme before matching.
1572 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1573 path field of the config key must match the path field of the URL
1574 either exactly or as a prefix of slash-delimited path elements. This means
1575 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1576 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1577 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1578 key with just path `foo/`).
1580 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1581 the config key has a user name it must match the user name in the
1582 URL exactly. If the config key does not have a user name, that
1583 config key will match a URL with any user name (including none),
1584 but at a lower precedence than a config key with a user name.
1587 The list above is ordered by decreasing precedence; a URL that matches
1588 a config key's path is preferred to one that matches its user name. For example,
1589 if the URL is `https://user@example.com/foo/bar` a config key match of
1590 `https://example.com/foo` will be preferred over a config key match of
1591 `https://user@example.com`.
1593 All URLs are normalized before attempting any matching (the password part,
1594 if embedded in the URL, is always ignored for matching purposes) so that
1595 equivalent urls that are simply spelled differently will match properly.
1596 Environment variable settings always override any matches. The urls that are
1597 matched against are those given directly to Git commands. This means any URLs
1598 visited as a result of a redirection do not participate in matching.
1600 i18n.commitEncoding::
1601 Character encoding the commit messages are stored in; Git itself
1602 does not care per se, but this information is necessary e.g. when
1603 importing commits from emails or in the gitk graphical history
1604 browser (and possibly at other places in the future or in other
1605 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1607 i18n.logOutputEncoding::
1608 Character encoding the commit messages are converted to when
1609 running 'git log' and friends.
1612 The configuration variables in the 'imap' section are described
1613 in linkgit:git-imap-send[1].
1616 Specify the directory from which templates will be copied.
1617 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1620 Specify the program that will be used to browse your working
1621 repository in gitweb. See linkgit:git-instaweb[1].
1624 The HTTP daemon command-line to start gitweb on your working
1625 repository. See linkgit:git-instaweb[1].
1628 If true the web server started by linkgit:git-instaweb[1] will
1629 be bound to the local IP (127.0.0.1).
1631 instaweb.modulepath::
1632 The default module path for linkgit:git-instaweb[1] to use
1633 instead of /usr/lib/apache2/modules. Only used if httpd
1637 The port number to bind the gitweb httpd to. See
1638 linkgit:git-instaweb[1].
1640 interactive.singlekey::
1641 In interactive commands, allow the user to provide one-letter
1642 input with a single key (i.e., without hitting enter).
1643 Currently this is used by the `--patch` mode of
1644 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1645 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1646 setting is silently ignored if portable keystroke input
1650 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1651 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1652 override this option with `--no-abbrev-commit`.
1655 Set the default date-time mode for the 'log' command.
1656 Setting a value for log.date is similar to using 'git log''s
1657 `--date` option. Possible values are `relative`, `local`,
1658 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1662 Print out the ref names of any commits that are shown by the log
1663 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1664 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1665 specified, the full ref name (including prefix) will be printed.
1666 This is the same as the log commands '--decorate' option.
1669 If true, the initial commit will be shown as a big creation event.
1670 This is equivalent to a diff against an empty tree.
1671 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1672 normally hide the root commit will now show it. True by default.
1675 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1676 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1679 The location of an augmenting mailmap file. The default
1680 mailmap, located in the root of the repository, is loaded
1681 first, then the mailmap file pointed to by this variable.
1682 The location of the mailmap file may be in a repository
1683 subdirectory, or somewhere outside of the repository itself.
1684 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1687 Like `mailmap.file`, but consider the value as a reference to a
1688 blob in the repository. If both `mailmap.file` and
1689 `mailmap.blob` are given, both are parsed, with entries from
1690 `mailmap.file` taking precedence. In a bare repository, this
1691 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1695 Specify the programs that may be used to display help in the
1696 'man' format. See linkgit:git-help[1].
1699 Specify the command to invoke the specified man viewer. The
1700 specified command is evaluated in shell with the man page
1701 passed as argument. (See linkgit:git-help[1].)
1704 Override the path for the given tool that may be used to
1705 display help in the 'man' format. See linkgit:git-help[1].
1707 include::merge-config.txt[]
1709 mergetool.<tool>.path::
1710 Override the path for the given tool. This is useful in case
1711 your tool is not in the PATH.
1713 mergetool.<tool>.cmd::
1714 Specify the command to invoke the specified merge tool. The
1715 specified command is evaluated in shell with the following
1716 variables available: 'BASE' is the name of a temporary file
1717 containing the common base of the files to be merged, if available;
1718 'LOCAL' is the name of a temporary file containing the contents of
1719 the file on the current branch; 'REMOTE' is the name of a temporary
1720 file containing the contents of the file from the branch being
1721 merged; 'MERGED' contains the name of the file to which the merge
1722 tool should write the results of a successful merge.
1724 mergetool.<tool>.trustExitCode::
1725 For a custom merge command, specify whether the exit code of
1726 the merge command can be used to determine whether the merge was
1727 successful. If this is not set to true then the merge target file
1728 timestamp is checked and the merge assumed to have been successful
1729 if the file has been updated, otherwise the user is prompted to
1730 indicate the success of the merge.
1732 mergetool.keepBackup::
1733 After performing a merge, the original file with conflict markers
1734 can be saved as a file with a `.orig` extension. If this variable
1735 is set to `false` then this file is not preserved. Defaults to
1736 `true` (i.e. keep the backup files).
1738 mergetool.keepTemporaries::
1739 When invoking a custom merge tool, Git uses a set of temporary
1740 files to pass to the tool. If the tool returns an error and this
1741 variable is set to `true`, then these temporary files will be
1742 preserved, otherwise they will be removed after the tool has
1743 exited. Defaults to `false`.
1746 Prompt before each invocation of the merge resolution program.
1749 The (fully qualified) refname from which to show notes when
1750 showing commit messages. The value of this variable can be set
1751 to a glob, in which case notes from all matching refs will be
1752 shown. You may also specify this configuration variable
1753 several times. A warning will be issued for refs that do not
1754 exist, but a glob that does not match any refs is silently
1757 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1758 environment variable, which must be a colon separated list of refs or
1761 The effective value of "core.notesRef" (possibly overridden by
1762 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1765 notes.rewrite.<command>::
1766 When rewriting commits with <command> (currently `amend` or
1767 `rebase`) and this variable is set to `true`, Git
1768 automatically copies your notes from the original to the
1769 rewritten commit. Defaults to `true`, but see
1770 "notes.rewriteRef" below.
1773 When copying notes during a rewrite (see the
1774 "notes.rewrite.<command>" option), determines what to do if
1775 the target commit already has a note. Must be one of
1776 `overwrite`, `concatenate`, or `ignore`. Defaults to
1779 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1780 environment variable.
1783 When copying notes during a rewrite, specifies the (fully
1784 qualified) ref whose notes should be copied. The ref may be a
1785 glob, in which case notes in all matching refs will be copied.
1786 You may also specify this configuration several times.
1788 Does not have a default value; you must configure this variable to
1789 enable note rewriting. Set it to `refs/notes/commits` to enable
1790 rewriting for the default commit notes.
1792 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1793 environment variable, which must be a colon separated list of refs or
1797 The size of the window used by linkgit:git-pack-objects[1] when no
1798 window size is given on the command line. Defaults to 10.
1801 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1802 maximum depth is given on the command line. Defaults to 50.
1805 The window memory size limit used by linkgit:git-pack-objects[1]
1806 when no limit is given on the command line. The value can be
1807 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1811 An integer -1..9, indicating the compression level for objects
1812 in a pack file. -1 is the zlib default. 0 means no
1813 compression, and 1..9 are various speed/size tradeoffs, 9 being
1814 slowest. If not set, defaults to core.compression. If that is
1815 not set, defaults to -1, the zlib default, which is "a default
1816 compromise between speed and compression (currently equivalent
1819 Note that changing the compression level will not automatically recompress
1820 all existing objects. You can force recompression by passing the -F option
1821 to linkgit:git-repack[1].
1823 pack.deltaCacheSize::
1824 The maximum memory in bytes used for caching deltas in
1825 linkgit:git-pack-objects[1] before writing them out to a pack.
1826 This cache is used to speed up the writing object phase by not
1827 having to recompute the final delta result once the best match
1828 for all objects is found. Repacking large repositories on machines
1829 which are tight with memory might be badly impacted by this though,
1830 especially if this cache pushes the system into swapping.
1831 A value of 0 means no limit. The smallest size of 1 byte may be
1832 used to virtually disable this cache. Defaults to 256 MiB.
1834 pack.deltaCacheLimit::
1835 The maximum size of a delta, that is cached in
1836 linkgit:git-pack-objects[1]. This cache is used to speed up the
1837 writing object phase by not having to recompute the final delta
1838 result once the best match for all objects is found. Defaults to 1000.
1841 Specifies the number of threads to spawn when searching for best
1842 delta matches. This requires that linkgit:git-pack-objects[1]
1843 be compiled with pthreads otherwise this option is ignored with a
1844 warning. This is meant to reduce packing time on multiprocessor
1845 machines. The required amount of memory for the delta search window
1846 is however multiplied by the number of threads.
1847 Specifying 0 will cause Git to auto-detect the number of CPU's
1848 and set the number of threads accordingly.
1851 Specify the default pack index version. Valid values are 1 for
1852 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1853 the new pack index with capabilities for packs larger than 4 GB
1854 as well as proper protection against the repacking of corrupted
1855 packs. Version 2 is the default. Note that version 2 is enforced
1856 and this config option ignored whenever the corresponding pack is
1859 If you have an old Git that does not understand the version 2 `*.idx` file,
1860 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1861 that will copy both `*.pack` file and corresponding `*.idx` file from the
1862 other side may give you a repository that cannot be accessed with your
1863 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1864 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1867 pack.packSizeLimit::
1868 The maximum size of a pack. This setting only affects
1869 packing to a file when repacking, i.e. the git:// protocol
1870 is unaffected. It can be overridden by the `--max-pack-size`
1871 option of linkgit:git-repack[1]. The minimum size allowed is
1872 limited to 1 MiB. The default is unlimited.
1873 Common unit suffixes of 'k', 'm', or 'g' are
1877 If the value is boolean, turns on or off pagination of the
1878 output of a particular Git subcommand when writing to a tty.
1879 Otherwise, turns on pagination for the subcommand using the
1880 pager specified by the value of `pager.<cmd>`. If `--paginate`
1881 or `--no-pager` is specified on the command line, it takes
1882 precedence over this option. To disable pagination for all
1883 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1886 Alias for a --pretty= format string, as specified in
1887 linkgit:git-log[1]. Any aliases defined here can be used just
1888 as the built-in pretty formats could. For example,
1889 running `git config pretty.changelog "format:* %H %s"`
1890 would cause the invocation `git log --pretty=changelog`
1891 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1892 Note that an alias with the same name as a built-in format
1893 will be silently ignored.
1896 When true, rebase branches on top of the fetched branch, instead
1897 of merging the default branch from the default remote when "git
1898 pull" is run. See "branch.<name>.rebase" for setting this on a
1901 When preserve, also pass `--preserve-merges` along to 'git rebase'
1902 so that locally committed merge commits will not be flattened
1903 by running 'git pull'.
1905 *NOTE*: this is a possibly dangerous operation; do *not* use
1906 it unless you understand the implications (see linkgit:git-rebase[1]
1910 The default merge strategy to use when pulling multiple branches
1914 The default merge strategy to use when pulling a single branch.
1917 Defines the action `git push` should take if no refspec is
1918 explicitly given. Different values are well-suited for
1919 specific workflows; for instance, in a purely central workflow
1920 (i.e. the fetch source is equal to the push destination),
1921 `upstream` is probably what you want. Possible values are:
1925 * `nothing` - do not push anything (error out) unless a refspec is
1926 explicitly given. This is primarily meant for people who want to
1927 avoid mistakes by always being explicit.
1929 * `current` - push the current branch to update a branch with the same
1930 name on the receiving end. Works in both central and non-central
1933 * `upstream` - push the current branch back to the branch whose
1934 changes are usually integrated into the current branch (which is
1935 called `@{upstream}`). This mode only makes sense if you are
1936 pushing to the same repository you would normally pull from
1937 (i.e. central workflow).
1939 * `simple` - in centralized workflow, work like `upstream` with an
1940 added safety to refuse to push if the upstream branch's name is
1941 different from the local one.
1943 When pushing to a remote that is different from the remote you normally
1944 pull from, work as `current`. This is the safest option and is suited
1947 This mode will become the default in Git 2.0.
1949 * `matching` - push all branches having the same name on both ends.
1950 This makes the repository you are pushing to remember the set of
1951 branches that will be pushed out (e.g. if you always push 'maint'
1952 and 'master' there and no other branches, the repository you push
1953 to will have these two branches, and your local 'maint' and
1954 'master' will be pushed there).
1956 To use this mode effectively, you have to make sure _all_ the
1957 branches you would push out are ready to be pushed out before
1958 running 'git push', as the whole point of this mode is to allow you
1959 to push all of the branches in one go. If you usually finish work
1960 on only one branch and push out the result, while other branches are
1961 unfinished, this mode is not for you. Also this mode is not
1962 suitable for pushing into a shared central repository, as other
1963 people may add new branches there, or update the tip of existing
1964 branches outside your control.
1966 This is currently the default, but Git 2.0 will change the default
1972 Whether to show a diffstat of what changed upstream since the last
1973 rebase. False by default.
1976 If set to true enable '--autosquash' option by default.
1979 When set to true, automatically create a temporary stash
1980 before the operation begins, and apply it after the operation
1981 ends. This means that you can run rebase on a dirty worktree.
1982 However, use with care: the final stash application after a
1983 successful rebase might result in non-trivial conflicts.
1987 By default, git-receive-pack will run "git-gc --auto" after
1988 receiving data from git-push and updating refs. You can stop
1989 it by setting this variable to false.
1991 receive.fsckObjects::
1992 If it is set to true, git-receive-pack will check all received
1993 objects. It will abort in the case of a malformed object or a
1994 broken link. The result of an abort are only dangling objects.
1995 Defaults to false. If not set, the value of `transfer.fsckObjects`
1998 receive.unpackLimit::
1999 If the number of objects received in a push is below this
2000 limit then the objects will be unpacked into loose object
2001 files. However if the number of received objects equals or
2002 exceeds this limit then the received pack will be stored as
2003 a pack, after adding any missing delta bases. Storing the
2004 pack from a push can make the push operation complete faster,
2005 especially on slow filesystems. If not set, the value of
2006 `transfer.unpackLimit` is used instead.
2008 receive.denyDeletes::
2009 If set to true, git-receive-pack will deny a ref update that deletes
2010 the ref. Use this to prevent such a ref deletion via a push.
2012 receive.denyDeleteCurrent::
2013 If set to true, git-receive-pack will deny a ref update that
2014 deletes the currently checked out branch of a non-bare repository.
2016 receive.denyCurrentBranch::
2017 If set to true or "refuse", git-receive-pack will deny a ref update
2018 to the currently checked out branch of a non-bare repository.
2019 Such a push is potentially dangerous because it brings the HEAD
2020 out of sync with the index and working tree. If set to "warn",
2021 print a warning of such a push to stderr, but allow the push to
2022 proceed. If set to false or "ignore", allow such pushes with no
2023 message. Defaults to "refuse".
2025 receive.denyNonFastForwards::
2026 If set to true, git-receive-pack will deny a ref update which is
2027 not a fast-forward. Use this to prevent such an update via a push,
2028 even if that push is forced. This configuration variable is
2029 set when initializing a shared repository.
2032 String(s) `receive-pack` uses to decide which refs to omit
2033 from its initial advertisement. Use more than one
2034 definitions to specify multiple prefix strings. A ref that
2035 are under the hierarchies listed on the value of this
2036 variable is excluded, and is hidden when responding to `git
2037 push`, and an attempt to update or delete a hidden ref by
2038 `git push` is rejected.
2040 receive.updateserverinfo::
2041 If set to true, git-receive-pack will run git-update-server-info
2042 after receiving data from git-push and updating refs.
2044 receive.shallowupdate::
2045 If set to true, .git/shallow can be updated when new refs
2046 require new shallow roots. Otherwise those refs are rejected.
2048 remote.pushdefault::
2049 The remote to push to by default. Overrides
2050 `branch.<name>.remote` for all branches, and is overridden by
2051 `branch.<name>.pushremote` for specific branches.
2054 The URL of a remote repository. See linkgit:git-fetch[1] or
2055 linkgit:git-push[1].
2057 remote.<name>.pushurl::
2058 The push URL of a remote repository. See linkgit:git-push[1].
2060 remote.<name>.proxy::
2061 For remotes that require curl (http, https and ftp), the URL to
2062 the proxy to use for that remote. Set to the empty string to
2063 disable proxying for that remote.
2065 remote.<name>.fetch::
2066 The default set of "refspec" for linkgit:git-fetch[1]. See
2067 linkgit:git-fetch[1].
2069 remote.<name>.push::
2070 The default set of "refspec" for linkgit:git-push[1]. See
2071 linkgit:git-push[1].
2073 remote.<name>.mirror::
2074 If true, pushing to this remote will automatically behave
2075 as if the `--mirror` option was given on the command line.
2077 remote.<name>.skipDefaultUpdate::
2078 If true, this remote will be skipped by default when updating
2079 using linkgit:git-fetch[1] or the `update` subcommand of
2080 linkgit:git-remote[1].
2082 remote.<name>.skipFetchAll::
2083 If true, this remote will be skipped by default when updating
2084 using linkgit:git-fetch[1] or the `update` subcommand of
2085 linkgit:git-remote[1].
2087 remote.<name>.receivepack::
2088 The default program to execute on the remote side when pushing. See
2089 option \--receive-pack of linkgit:git-push[1].
2091 remote.<name>.uploadpack::
2092 The default program to execute on the remote side when fetching. See
2093 option \--upload-pack of linkgit:git-fetch-pack[1].
2095 remote.<name>.tagopt::
2096 Setting this value to \--no-tags disables automatic tag following when
2097 fetching from remote <name>. Setting it to \--tags will fetch every
2098 tag from remote <name>, even if they are not reachable from remote
2099 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2100 override this setting. See options \--tags and \--no-tags of
2101 linkgit:git-fetch[1].
2104 Setting this to a value <vcs> will cause Git to interact with
2105 the remote with the git-remote-<vcs> helper.
2107 remote.<name>.prune::
2108 When set to true, fetching from this remote by default will also
2109 remove any remote-tracking references that no longer exist on the
2110 remote (as if the `--prune` option was given on the command line).
2111 Overrides `fetch.prune` settings, if any.
2114 The list of remotes which are fetched by "git remote update
2115 <group>". See linkgit:git-remote[1].
2117 repack.usedeltabaseoffset::
2118 By default, linkgit:git-repack[1] creates packs that use
2119 delta-base offset. If you need to share your repository with
2120 Git older than version 1.4.4, either directly or via a dumb
2121 protocol such as http, then you need to set this option to
2122 "false" and repack. Access from old Git versions over the
2123 native protocol are unaffected by this option.
2126 When set to true, `git-rerere` updates the index with the
2127 resulting contents after it cleanly resolves conflicts using
2128 previously recorded resolution. Defaults to false.
2131 Activate recording of resolved conflicts, so that identical
2132 conflict hunks can be resolved automatically, should they be
2133 encountered again. By default, linkgit:git-rerere[1] is
2134 enabled if there is an `rr-cache` directory under the
2135 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2138 sendemail.identity::
2139 A configuration identity. When given, causes values in the
2140 'sendemail.<identity>' subsection to take precedence over
2141 values in the 'sendemail' section. The default identity is
2142 the value of 'sendemail.identity'.
2144 sendemail.smtpencryption::
2145 See linkgit:git-send-email[1] for description. Note that this
2146 setting is not subject to the 'identity' mechanism.
2149 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2151 sendemail.smtpsslcertpath::
2152 Path to ca-certificates (either a directory or a single file).
2153 Set it to an empty string to disable certificate verification.
2155 sendemail.<identity>.*::
2156 Identity-specific versions of the 'sendemail.*' parameters
2157 found below, taking precedence over those when the this
2158 identity is selected, through command-line or
2159 'sendemail.identity'.
2161 sendemail.aliasesfile::
2162 sendemail.aliasfiletype::
2163 sendemail.annotate::
2167 sendemail.chainreplyto::
2169 sendemail.envelopesender::
2171 sendemail.multiedit::
2172 sendemail.signedoffbycc::
2173 sendemail.smtppass::
2174 sendemail.suppresscc::
2175 sendemail.suppressfrom::
2177 sendemail.smtpdomain::
2178 sendemail.smtpserver::
2179 sendemail.smtpserverport::
2180 sendemail.smtpserveroption::
2181 sendemail.smtpuser::
2183 sendemail.validate::
2184 See linkgit:git-send-email[1] for description.
2186 sendemail.signedoffcc::
2187 Deprecated alias for 'sendemail.signedoffbycc'.
2189 showbranch.default::
2190 The default set of branches for linkgit:git-show-branch[1].
2191 See linkgit:git-show-branch[1].
2193 status.relativePaths::
2194 By default, linkgit:git-status[1] shows paths relative to the
2195 current directory. Setting this variable to `false` shows paths
2196 relative to the repository root (this was the default for Git
2200 Set to true to enable --short by default in linkgit:git-status[1].
2201 The option --no-short takes precedence over this variable.
2204 Set to true to enable --branch by default in linkgit:git-status[1].
2205 The option --no-branch takes precedence over this variable.
2207 status.displayCommentPrefix::
2208 If set to true, linkgit:git-status[1] will insert a comment
2209 prefix before each output line (starting with
2210 `core.commentChar`, i.e. `#` by default). This was the
2211 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2214 status.showUntrackedFiles::
2215 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2216 files which are not currently tracked by Git. Directories which
2217 contain only untracked files, are shown with the directory name
2218 only. Showing untracked files means that Git needs to lstat() all
2219 all the files in the whole repository, which might be slow on some
2220 systems. So, this variable controls how the commands displays
2221 the untracked files. Possible values are:
2224 * `no` - Show no untracked files.
2225 * `normal` - Show untracked files and directories.
2226 * `all` - Show also individual files in untracked directories.
2229 If this variable is not specified, it defaults to 'normal'.
2230 This variable can be overridden with the -u|--untracked-files option
2231 of linkgit:git-status[1] and linkgit:git-commit[1].
2233 status.submodulesummary::
2235 If this is set to a non zero number or true (identical to -1 or an
2236 unlimited number), the submodule summary will be enabled and a
2237 summary of commits for modified submodules will be shown (see
2238 --summary-limit option of linkgit:git-submodule[1]). Please note
2239 that the summary output command will be suppressed for all
2240 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2241 for those submodules where `submodule.<name>.ignore=all`. To
2242 also view the summary for ignored submodules you can either use
2243 the --ignore-submodules=dirty command line option or the 'git
2244 submodule summary' command, which shows a similar output but does
2245 not honor these settings.
2247 submodule.<name>.path::
2248 submodule.<name>.url::
2249 submodule.<name>.update::
2250 The path within this project, URL, and the updating strategy
2251 for a submodule. These variables are initially populated
2252 by 'git submodule init'; edit them to override the
2253 URL and other values found in the `.gitmodules` file. See
2254 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2256 submodule.<name>.branch::
2257 The remote branch name for a submodule, used by `git submodule
2258 update --remote`. Set this option to override the value found in
2259 the `.gitmodules` file. See linkgit:git-submodule[1] and
2260 linkgit:gitmodules[5] for details.
2262 submodule.<name>.fetchRecurseSubmodules::
2263 This option can be used to control recursive fetching of this
2264 submodule. It can be overridden by using the --[no-]recurse-submodules
2265 command line option to "git fetch" and "git pull".
2266 This setting will override that from in the linkgit:gitmodules[5]
2269 submodule.<name>.ignore::
2270 Defines under what circumstances "git status" and the diff family show
2271 a submodule as modified. When set to "all", it will never be considered
2272 modified, "dirty" will ignore all changes to the submodules work tree and
2273 takes only differences between the HEAD of the submodule and the commit
2274 recorded in the superproject into account. "untracked" will additionally
2275 let submodules with modified tracked files in their work tree show up.
2276 Using "none" (the default when this option is not set) also shows
2277 submodules that have untracked files in their work tree as changed.
2278 This setting overrides any setting made in .gitmodules for this submodule,
2279 both settings can be overridden on the command line by using the
2280 "--ignore-submodules" option. The 'git submodule' commands are not
2281 affected by this setting.
2284 This variable can be used to restrict the permission bits of
2285 tar archive entries. The default is 0002, which turns off the
2286 world write bit. The special value "user" indicates that the
2287 archiving user's umask will be used instead. See umask(2) and
2288 linkgit:git-archive[1].
2290 transfer.fsckObjects::
2291 When `fetch.fsckObjects` or `receive.fsckObjects` are
2292 not set, the value of this variable is used instead.
2296 This variable can be used to set both `receive.hiderefs`
2297 and `uploadpack.hiderefs` at the same time to the same
2298 values. See entries for these other variables.
2300 transfer.unpackLimit::
2301 When `fetch.unpackLimit` or `receive.unpackLimit` are
2302 not set, the value of this variable is used instead.
2303 The default value is 100.
2305 uploadpack.hiderefs::
2306 String(s) `upload-pack` uses to decide which refs to omit
2307 from its initial advertisement. Use more than one
2308 definitions to specify multiple prefix strings. A ref that
2309 are under the hierarchies listed on the value of this
2310 variable is excluded, and is hidden from `git ls-remote`,
2311 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2312 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2314 uploadpack.allowtipsha1inwant::
2315 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2316 to accept a fetch request that asks for an object at the tip
2317 of a hidden ref (by default, such a request is rejected).
2318 see also `uploadpack.hiderefs`.
2320 uploadpack.keepalive::
2321 When `upload-pack` has started `pack-objects`, there may be a
2322 quiet period while `pack-objects` prepares the pack. Normally
2323 it would output progress information, but if `--quiet` was used
2324 for the fetch, `pack-objects` will output nothing at all until
2325 the pack data begins. Some clients and networks may consider
2326 the server to be hung and give up. Setting this option instructs
2327 `upload-pack` to send an empty keepalive packet every
2328 `uploadpack.keepalive` seconds. Setting this option to 0
2329 disables keepalive packets entirely. The default is 5 seconds.
2331 url.<base>.insteadOf::
2332 Any URL that starts with this value will be rewritten to
2333 start, instead, with <base>. In cases where some site serves a
2334 large number of repositories, and serves them with multiple
2335 access methods, and some users need to use different access
2336 methods, this feature allows people to specify any of the
2337 equivalent URLs and have Git automatically rewrite the URL to
2338 the best alternative for the particular user, even for a
2339 never-before-seen repository on the site. When more than one
2340 insteadOf strings match a given URL, the longest match is used.
2342 url.<base>.pushInsteadOf::
2343 Any URL that starts with this value will not be pushed to;
2344 instead, it will be rewritten to start with <base>, and the
2345 resulting URL will be pushed to. In cases where some site serves
2346 a large number of repositories, and serves them with multiple
2347 access methods, some of which do not allow push, this feature
2348 allows people to specify a pull-only URL and have Git
2349 automatically use an appropriate URL to push, even for a
2350 never-before-seen repository on the site. When more than one
2351 pushInsteadOf strings match a given URL, the longest match is
2352 used. If a remote has an explicit pushurl, Git will ignore this
2353 setting for that remote.
2356 Your email address to be recorded in any newly created commits.
2357 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2358 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2361 Your full name to be recorded in any newly created commits.
2362 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2363 environment variables. See linkgit:git-commit-tree[1].
2366 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2367 key you want it to automatically when creating a signed tag or
2368 commit, you can override the default selection with this variable.
2369 This option is passed unchanged to gpg's --local-user parameter,
2370 so you may specify a key using any method that gpg supports.
2373 Specify a web browser that may be used by some commands.
2374 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]