4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times.
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored. The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables. A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins. Section names are not case sensitive. Only alphanumeric
29 characters, `-` and `.` are allowed in section names. Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections. To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
38 [section "subsection"]
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively). Section headers cannot span multiple
45 lines. Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'. If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character. There can be more
60 than one value for a given variable; we say then that the variable is
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean. Boolean values may be given as yes/no,
68 1/0, true/false or on/off. Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS). Other char escape sequences (including octal
82 escape sequences) are invalid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
107 ; Don't trust file modes
112 external = /usr/local/bin/diff-wrapper
117 merge = refs/heads/devel
121 gitProxy="ssh" for "kernel.org"
122 gitProxy=default-proxy ; for the rest
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page.
136 Other git-related tools may and do use their own variables. When
137 inventing new variables for use in your own tool, make sure their
138 names do not conflict with those that are used by Git itself and
139 other popular tools, and describe them in your documentation.
143 These variables control various optional help messages designed to
144 aid new users. All 'advice.*' variables default to 'true', and you
145 can tell Git that you do not need help by setting these to 'false':
149 Set this variable to 'false' if you want to disable
151 'pushNonFFMatching', 'pushAlreadyExists',
152 'pushFetchFirst', and 'pushNeedsForce'
155 Advice shown when linkgit:git-push[1] fails due to a
156 non-fast-forward update to the current branch.
158 Advice shown when you ran linkgit:git-push[1] and pushed
159 'matching refs' explicitly (i.e. you used ':', or
160 specified a refspec that isn't your current branch) and
161 it resulted in a non-fast-forward error.
163 Shown when linkgit:git-push[1] rejects an update that
164 does not qualify for fast-forwarding (e.g., a tag.)
166 Shown when linkgit:git-push[1] rejects an update that
167 tries to overwrite a remote ref that points at an
168 object we do not have.
170 Shown when linkgit:git-push[1] rejects an update that
171 tries to overwrite a remote ref that points at an
172 object that is not a commit-ish, or make the remote
173 ref point at an object that is not a commit-ish.
175 Show directions on how to proceed from the current
176 state in the output of linkgit:git-status[1], in
177 the template shown when writing commit messages in
178 linkgit:git-commit[1], and in the help message shown
179 by linkgit:git-checkout[1] when switching branch.
181 Advise to consider using the `-u` option to linkgit:git-status[1]
182 when the command takes more than 2 seconds to enumerate untracked
185 Advice shown when linkgit:git-merge[1] refuses to
186 merge to avoid overwriting local changes.
188 Advice shown by various commands when conflicts
189 prevent the operation from being performed.
191 Advice on how to set your identity configuration when
192 your information is guessed from the system username and
195 Advice shown when you used linkgit:git-checkout[1] to
196 move to the detach HEAD state, to instruct how to create
197 a local branch after the fact.
199 Advice that shows the location of the patch file when
200 linkgit:git-am[1] fails to apply it.
202 In case of failure in the output of linkgit:git-rm[1],
203 show directions on how to proceed from the current state.
207 If false, the executable bit differences between the index and
208 the working tree are ignored; useful on broken filesystems like FAT.
209 See linkgit:git-update-index[1].
211 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
212 will probe and set core.fileMode false if appropriate when the
213 repository is created.
216 If true, this option enables various workarounds to enable
217 Git to work better on filesystems that are not case sensitive,
218 like FAT. For example, if a directory listing finds
219 "makefile" when Git expects "Makefile", Git will assume
220 it is really the same file, and continue to remember it as
223 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
224 will probe and set core.ignorecase true if appropriate when the repository
227 core.precomposeunicode::
228 This option is only used by Mac OS implementation of Git.
229 When core.precomposeunicode=true, Git reverts the unicode decomposition
230 of filenames done by Mac OS. This is useful when sharing a repository
231 between Mac OS and Linux or Windows.
232 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
233 When false, file names are handled fully transparent by Git,
234 which is backward compatible with older versions of Git.
237 If set to true, do not allow checkout of paths that would
238 be considered equivalent to `.git` on an HFS+ filesystem.
239 Defaults to `true` on Mac OS, and `false` elsewhere.
242 If set to true, do not allow checkout of paths that would
243 cause problems with the NTFS filesystem, e.g. conflict with
245 Defaults to `true` on Windows, and `false` elsewhere.
248 If false, the ctime differences between the index and the
249 working tree are ignored; useful when the inode change time
250 is regularly modified by something outside Git (file system
251 crawlers and some backup systems).
252 See linkgit:git-update-index[1]. True by default.
255 Determines which stat fields to match between the index
256 and work tree. The user can set this to 'default' or
257 'minimal'. Default (or explicitly 'default'), is to check
258 all fields, including the sub-second part of mtime and ctime.
261 The commands that output paths (e.g. 'ls-files',
262 'diff'), when not given the `-z` option, will quote
263 "unusual" characters in the pathname by enclosing the
264 pathname in a double-quote pair and with backslashes the
265 same way strings in C source code are quoted. If this
266 variable is set to false, the bytes higher than 0x80 are
267 not quoted but output as verbatim. Note that double
268 quote, backslash and control characters are always
269 quoted without `-z` regardless of the setting of this
273 Sets the line ending type to use in the working directory for
274 files that have the `text` property set. Alternatives are
275 'lf', 'crlf' and 'native', which uses the platform's native
276 line ending. The default value is `native`. See
277 linkgit:gitattributes[5] for more information on end-of-line
281 If true, makes Git check if converting `CRLF` is reversible when
282 end-of-line conversion is active. Git will verify if a command
283 modifies a file in the work tree either directly or indirectly.
284 For example, committing a file followed by checking out the
285 same file should yield the original file in the work tree. If
286 this is not the case for the current setting of
287 `core.autocrlf`, Git will reject the file. The variable can
288 be set to "warn", in which case Git will only warn about an
289 irreversible conversion but continue the operation.
291 CRLF conversion bears a slight chance of corrupting data.
292 When it is enabled, Git will convert CRLF to LF during commit and LF to
293 CRLF during checkout. A file that contains a mixture of LF and
294 CRLF before the commit cannot be recreated by Git. For text
295 files this is the right thing to do: it corrects line endings
296 such that we have only LF line endings in the repository.
297 But for binary files that are accidentally classified as text the
298 conversion can corrupt data.
300 If you recognize such corruption early you can easily fix it by
301 setting the conversion type explicitly in .gitattributes. Right
302 after committing you still have the original file in your work
303 tree and this file is not yet corrupted. You can explicitly tell
304 Git that this file is binary and Git will handle the file
307 Unfortunately, the desired effect of cleaning up text files with
308 mixed line endings and the undesired effect of corrupting binary
309 files cannot be distinguished. In both cases CRLFs are removed
310 in an irreversible way. For text files this is the right thing
311 to do because CRLFs are line endings, while for binary files
312 converting CRLFs corrupts data.
314 Note, this safety check does not mean that a checkout will generate a
315 file identical to the original file for a different setting of
316 `core.eol` and `core.autocrlf`, but only for the current one. For
317 example, a text file with `LF` would be accepted with `core.eol=lf`
318 and could later be checked out with `core.eol=crlf`, in which case the
319 resulting file would contain `CRLF`, although the original file
320 contained `LF`. However, in both work trees the line endings would be
321 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
322 file with mixed line endings would be reported by the `core.safecrlf`
326 Setting this variable to "true" is almost the same as setting
327 the `text` attribute to "auto" on all files except that text
328 files are not guaranteed to be normalized: files that contain
329 `CRLF` in the repository will not be touched. Use this
330 setting if you want to have `CRLF` line endings in your
331 working directory even though the repository does not have
332 normalized line endings. This variable can be set to 'input',
333 in which case no output conversion is performed.
336 If false, symbolic links are checked out as small plain files that
337 contain the link text. linkgit:git-update-index[1] and
338 linkgit:git-add[1] will not change the recorded type to regular
339 file. Useful on filesystems like FAT that do not support
342 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
343 will probe and set core.symlinks false if appropriate when the repository
347 A "proxy command" to execute (as 'command host port') instead
348 of establishing direct connection to the remote server when
349 using the Git protocol for fetching. If the variable value is
350 in the "COMMAND for DOMAIN" format, the command is applied only
351 on hostnames ending with the specified domain string. This variable
352 may be set multiple times and is matched in the given order;
353 the first match wins.
355 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
356 (which always applies universally, without the special "for"
359 The special string `none` can be used as the proxy command to
360 specify that no proxy be used for a given domain pattern.
361 This is useful for excluding servers inside a firewall from
362 proxy use, while defaulting to a common proxy for external domains.
365 If true, commands which modify both the working tree and the index
366 will mark the updated paths with the "assume unchanged" bit in the
367 index. These marked files are then assumed to stay unchanged in the
368 working tree, until you mark them otherwise manually - Git will not
369 detect the file changes by lstat() calls. This is useful on systems
370 where those are very slow, such as Microsoft Windows.
371 See linkgit:git-update-index[1].
374 core.preferSymlinkRefs::
375 Instead of the default "symref" format for HEAD
376 and other symbolic reference files, use symbolic links.
377 This is sometimes needed to work with old scripts that
378 expect HEAD to be a symbolic link.
381 If true this repository is assumed to be 'bare' and has no
382 working directory associated with it. If this is the case a
383 number of commands that require a working directory will be
384 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
386 This setting is automatically guessed by linkgit:git-clone[1] or
387 linkgit:git-init[1] when the repository was created. By default a
388 repository that ends in "/.git" is assumed to be not bare (bare =
389 false), while all other repositories are assumed to be bare (bare
393 Set the path to the root of the working tree.
394 This can be overridden by the GIT_WORK_TREE environment
395 variable and the '--work-tree' command-line option.
396 The value can be an absolute path or relative to the path to
397 the .git directory, which is either specified by --git-dir
398 or GIT_DIR, or automatically discovered.
399 If --git-dir or GIT_DIR is specified but none of
400 --work-tree, GIT_WORK_TREE and core.worktree is specified,
401 the current working directory is regarded as the top level
402 of your working tree.
404 Note that this variable is honored even when set in a configuration
405 file in a ".git" subdirectory of a directory and its value differs
406 from the latter directory (e.g. "/path/to/.git/config" has
407 core.worktree set to "/different/path"), which is most likely a
408 misconfiguration. Running Git commands in the "/path/to" directory will
409 still use "/different/path" as the root of the work tree and can cause
410 confusion unless you know what you are doing (e.g. you are creating a
411 read-only snapshot of the same index to a location different from the
412 repository's usual working tree).
414 core.logAllRefUpdates::
415 Enable the reflog. Updates to a ref <ref> is logged to the file
416 "$GIT_DIR/logs/<ref>", by appending the new and old
417 SHA-1, the date/time and the reason of the update, but
418 only when the file exists. If this configuration
419 variable is set to true, missing "$GIT_DIR/logs/<ref>"
420 file is automatically created for branch heads (i.e. under
421 refs/heads/), remote refs (i.e. under refs/remotes/),
422 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
424 This information can be used to determine what commit
425 was the tip of a branch "2 days ago".
427 This value is true by default in a repository that has
428 a working directory associated with it, and false by
429 default in a bare repository.
431 core.repositoryFormatVersion::
432 Internal variable identifying the repository format and layout
435 core.sharedRepository::
436 When 'group' (or 'true'), the repository is made shareable between
437 several users in a group (making sure all the files and objects are
438 group-writable). When 'all' (or 'world' or 'everybody'), the
439 repository will be readable by all users, additionally to being
440 group-shareable. When 'umask' (or 'false'), Git will use permissions
441 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
442 files in the repository will have this mode value. '0xxx' will override
443 user's umask value (whereas the other options will only override
444 requested parts of the user's umask value). Examples: '0660' will make
445 the repo read/write-able for the owner and group, but inaccessible to
446 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
447 repository that is group-readable but not group-writable.
448 See linkgit:git-init[1]. False by default.
450 core.warnAmbiguousRefs::
451 If true, Git will warn you if the ref name you passed it is ambiguous
452 and might match multiple refs in the repository. True by default.
455 An integer -1..9, indicating a default compression level.
456 -1 is the zlib default. 0 means no compression,
457 and 1..9 are various speed/size tradeoffs, 9 being slowest.
458 If set, this provides a default to other compression variables,
459 such as 'core.loosecompression' and 'pack.compression'.
461 core.loosecompression::
462 An integer -1..9, indicating the compression level for objects that
463 are not in a pack file. -1 is the zlib default. 0 means no
464 compression, and 1..9 are various speed/size tradeoffs, 9 being
465 slowest. If not set, defaults to core.compression. If that is
466 not set, defaults to 1 (best speed).
468 core.packedGitWindowSize::
469 Number of bytes of a pack file to map into memory in a
470 single mapping operation. Larger window sizes may allow
471 your system to process a smaller number of large pack files
472 more quickly. Smaller window sizes will negatively affect
473 performance due to increased calls to the operating system's
474 memory manager, but may improve performance when accessing
475 a large number of large pack files.
477 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
478 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
479 be reasonable for all users/operating systems. You probably do
480 not need to adjust this value.
482 Common unit suffixes of 'k', 'm', or 'g' are supported.
484 core.packedGitLimit::
485 Maximum number of bytes to map simultaneously into memory
486 from pack files. If Git needs to access more than this many
487 bytes at once to complete an operation it will unmap existing
488 regions to reclaim virtual address space within the process.
490 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
491 This should be reasonable for all users/operating systems, except on
492 the largest projects. You probably do not need to adjust this value.
494 Common unit suffixes of 'k', 'm', or 'g' are supported.
496 core.deltaBaseCacheLimit::
497 Maximum number of bytes to reserve for caching base objects
498 that may be referenced by multiple deltified objects. By storing the
499 entire decompressed base objects in a cache Git is able
500 to avoid unpacking and decompressing frequently used base
501 objects multiple times.
503 Default is 96 MiB on all platforms. This should be reasonable
504 for all users/operating systems, except on the largest projects.
505 You probably do not need to adjust this value.
507 Common unit suffixes of 'k', 'm', or 'g' are supported.
509 core.bigFileThreshold::
510 Files larger than this size are stored deflated, without
511 attempting delta compression. Storing large files without
512 delta compression avoids excessive memory usage, at the
513 slight expense of increased disk usage.
515 Default is 512 MiB on all platforms. This should be reasonable
516 for most projects as source code and other text files can still
517 be delta compressed, but larger binary media files won't be.
519 Common unit suffixes of 'k', 'm', or 'g' are supported.
522 In addition to '.gitignore' (per-directory) and
523 '.git/info/exclude', Git looks into this file for patterns
524 of files which are not meant to be tracked. "`~/`" is expanded
525 to the value of `$HOME` and "`~user/`" to the specified user's
526 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
527 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
528 is used instead. See linkgit:gitignore[5].
531 Some commands (e.g. svn and http interfaces) that interactively
532 ask for a password can be told to use an external program given
533 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
534 environment variable. If not set, fall back to the value of the
535 'SSH_ASKPASS' environment variable or, failing that, a simple password
536 prompt. The external program shall be given a suitable prompt as
537 command-line argument and write the password on its STDOUT.
539 core.attributesfile::
540 In addition to '.gitattributes' (per-directory) and
541 '.git/info/attributes', Git looks into this file for attributes
542 (see linkgit:gitattributes[5]). Path expansions are made the same
543 way as for `core.excludesfile`. Its default value is
544 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
545 set or empty, $HOME/.config/git/attributes is used instead.
548 Commands such as `commit` and `tag` that lets you edit
549 messages by launching an editor uses the value of this
550 variable when it is set, and the environment variable
551 `GIT_EDITOR` is not set. See linkgit:git-var[1].
554 Commands such as `commit` and `tag` that lets you edit
555 messages consider a line that begins with this character
556 commented, and removes them after the editor returns
559 If set to "auto", `git-commit` would select a character that is not
560 the beginning character of any line in existing commit messages.
563 Text editor used by `git rebase -i` for editing the rebase instruction file.
564 The value is meant to be interpreted by the shell when it is used.
565 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
566 When not configured the default commit message editor is used instead.
569 Text viewer for use by Git commands (e.g., 'less'). The value
570 is meant to be interpreted by the shell. The order of preference
571 is the `$GIT_PAGER` environment variable, then `core.pager`
572 configuration, then `$PAGER`, and then the default chosen at
573 compile time (usually 'less').
575 When the `LESS` environment variable is unset, Git sets it to `FRX`
576 (if `LESS` environment variable is set, Git does not change it at
577 all). If you want to selectively override Git's default setting
578 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
579 be passed to the shell by Git, which will translate the final
580 command to `LESS=FRX less -S`. The environment does not set the
581 `S` option but the command line does, instructing less to truncate
582 long lines. Similarly, setting `core.pager` to `less -+F` will
583 deactivate the `F` option specified by the environment from the
584 command-line, deactivating the "quit if one screen" behavior of
585 `less`. One can specifically activate some flags for particular
586 commands: for example, setting `pager.blame` to `less -S` enables
587 line truncation only for `git blame`.
589 Likewise, when the `LV` environment variable is unset, Git sets it
590 to `-c`. You can override this setting by exporting `LV` with
591 another value or setting `core.pager` to `lv +c`.
594 A comma separated list of common whitespace problems to
595 notice. 'git diff' will use `color.diff.whitespace` to
596 highlight them, and 'git apply --whitespace=error' will
597 consider them as errors. You can prefix `-` to disable
598 any of them (e.g. `-trailing-space`):
600 * `blank-at-eol` treats trailing whitespaces at the end of the line
601 as an error (enabled by default).
602 * `space-before-tab` treats a space character that appears immediately
603 before a tab character in the initial indent part of the line as an
604 error (enabled by default).
605 * `indent-with-non-tab` treats a line that is indented with space
606 characters instead of the equivalent tabs as an error (not enabled by
608 * `tab-in-indent` treats a tab character in the initial indent part of
609 the line as an error (not enabled by default).
610 * `blank-at-eof` treats blank lines added at the end of file as an error
611 (enabled by default).
612 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
614 * `cr-at-eol` treats a carriage-return at the end of line as
615 part of the line terminator, i.e. with it, `trailing-space`
616 does not trigger if the character before such a carriage-return
617 is not a whitespace (not enabled by default).
618 * `tabwidth=<n>` tells how many character positions a tab occupies; this
619 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
620 errors. The default tab width is 8. Allowed values are 1 to 63.
622 core.fsyncobjectfiles::
623 This boolean will enable 'fsync()' when writing object files.
625 This is a total waste of time and effort on a filesystem that orders
626 data writes properly, but can be useful for filesystems that do not use
627 journalling (traditional UNIX filesystems) or that only journal metadata
628 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
631 Enable parallel index preload for operations like 'git diff'
633 This can speed up operations like 'git diff' and 'git status' especially
634 on filesystems like NFS that have weak caching semantics and thus
635 relatively high IO latencies. When enabled, Git will do the
636 index comparison to the filesystem data in parallel, allowing
637 overlapping IO's. Defaults to true.
640 You can set this to 'link', in which case a hardlink followed by
641 a delete of the source are used to make sure that object creation
642 will not overwrite existing objects.
644 On some file system/operating system combinations, this is unreliable.
645 Set this config setting to 'rename' there; However, This will remove the
646 check that makes sure that existing object files will not get overwritten.
649 When showing commit messages, also show notes which are stored in
650 the given ref. The ref must be fully qualified. If the given
651 ref does not exist, it is not an error but means that no
652 notes should be printed.
654 This setting defaults to "refs/notes/commits", and it can be overridden by
655 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
657 core.sparseCheckout::
658 Enable "sparse checkout" feature. See section "Sparse checkout" in
659 linkgit:git-read-tree[1] for more information.
662 Set the length object names are abbreviated to. If unspecified,
663 many commands abbreviate to 7 hexdigits, which may not be enough
664 for abbreviated object names to stay unique for sufficiently long
669 Tells 'git add' to continue adding files when some files cannot be
670 added due to indexing errors. Equivalent to the '--ignore-errors'
671 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
672 as it does not follow the usual naming convention for configuration
676 Command aliases for the linkgit:git[1] command wrapper - e.g.
677 after defining "alias.last = cat-file commit HEAD", the invocation
678 "git last" is equivalent to "git cat-file commit HEAD". To avoid
679 confusion and troubles with script usage, aliases that
680 hide existing Git commands are ignored. Arguments are split by
681 spaces, the usual shell quoting and escaping is supported.
682 A quote pair or a backslash can be used to quote them.
684 If the alias expansion is prefixed with an exclamation point,
685 it will be treated as a shell command. For example, defining
686 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
687 "git new" is equivalent to running the shell command
688 "gitk --all --not ORIG_HEAD". Note that shell commands will be
689 executed from the top-level directory of a repository, which may
690 not necessarily be the current directory.
691 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
692 from the original current directory. See linkgit:git-rev-parse[1].
695 If true, git-am will call git-mailsplit for patches in mbox format
696 with parameter '--keep-cr'. In this case git-mailsplit will
697 not remove `\r` from lines ending with `\r\n`. Can be overridden
698 by giving '--no-keep-cr' from the command line.
699 See linkgit:git-am[1], linkgit:git-mailsplit[1].
701 apply.ignorewhitespace::
702 When set to 'change', tells 'git apply' to ignore changes in
703 whitespace, in the same way as the '--ignore-space-change'
705 When set to one of: no, none, never, false tells 'git apply' to
706 respect all whitespace differences.
707 See linkgit:git-apply[1].
710 Tells 'git apply' how to handle whitespaces, in the same way
711 as the '--whitespace' option. See linkgit:git-apply[1].
713 branch.autosetupmerge::
714 Tells 'git branch' and 'git checkout' to set up new branches
715 so that linkgit:git-pull[1] will appropriately merge from the
716 starting point branch. Note that even if this option is not set,
717 this behavior can be chosen per-branch using the `--track`
718 and `--no-track` options. The valid settings are: `false` -- no
719 automatic setup is done; `true` -- automatic setup is done when the
720 starting point is a remote-tracking branch; `always` --
721 automatic setup is done when the starting point is either a
722 local branch or remote-tracking
723 branch. This option defaults to true.
725 branch.autosetuprebase::
726 When a new branch is created with 'git branch' or 'git checkout'
727 that tracks another branch, this variable tells Git to set
728 up pull to rebase instead of merge (see "branch.<name>.rebase").
729 When `never`, rebase is never automatically set to true.
730 When `local`, rebase is set to true for tracked branches of
731 other local branches.
732 When `remote`, rebase is set to true for tracked branches of
733 remote-tracking branches.
734 When `always`, rebase will be set to true for all tracking
736 See "branch.autosetupmerge" for details on how to set up a
737 branch to track another branch.
738 This option defaults to never.
740 branch.<name>.remote::
741 When on branch <name>, it tells 'git fetch' and 'git push'
742 which remote to fetch from/push to. The remote to push to
743 may be overridden with `remote.pushdefault` (for all branches).
744 The remote to push to, for the current branch, may be further
745 overridden by `branch.<name>.pushremote`. If no remote is
746 configured, or if you are not on any branch, it defaults to
747 `origin` for fetching and `remote.pushdefault` for pushing.
748 Additionally, `.` (a period) is the current local repository
749 (a dot-repository), see `branch.<name>.merge`'s final note below.
751 branch.<name>.pushremote::
752 When on branch <name>, it overrides `branch.<name>.remote` for
753 pushing. It also overrides `remote.pushdefault` for pushing
754 from branch <name>. When you pull from one place (e.g. your
755 upstream) and push to another place (e.g. your own publishing
756 repository), you would want to set `remote.pushdefault` to
757 specify the remote to push to for all branches, and use this
758 option to override it for a specific branch.
760 branch.<name>.merge::
761 Defines, together with branch.<name>.remote, the upstream branch
762 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
763 branch to merge and can also affect 'git push' (see push.default).
764 When in branch <name>, it tells 'git fetch' the default
765 refspec to be marked for merging in FETCH_HEAD. The value is
766 handled like the remote part of a refspec, and must match a
767 ref which is fetched from the remote given by
768 "branch.<name>.remote".
769 The merge information is used by 'git pull' (which at first calls
770 'git fetch') to lookup the default branch for merging. Without
771 this option, 'git pull' defaults to merge the first refspec fetched.
772 Specify multiple values to get an octopus merge.
773 If you wish to setup 'git pull' so that it merges into <name> from
774 another branch in the local repository, you can point
775 branch.<name>.merge to the desired branch, and use the relative path
776 setting `.` (a period) for branch.<name>.remote.
778 branch.<name>.mergeoptions::
779 Sets default options for merging into branch <name>. The syntax and
780 supported options are the same as those of linkgit:git-merge[1], but
781 option values containing whitespace characters are currently not
784 branch.<name>.rebase::
785 When true, rebase the branch <name> on top of the fetched branch,
786 instead of merging the default branch from the default remote when
787 "git pull" is run. See "pull.rebase" for doing this in a non
788 branch-specific manner.
790 When preserve, also pass `--preserve-merges` along to 'git rebase'
791 so that locally committed merge commits will not be flattened
792 by running 'git pull'.
794 *NOTE*: this is a possibly dangerous operation; do *not* use
795 it unless you understand the implications (see linkgit:git-rebase[1]
798 branch.<name>.description::
799 Branch description, can be edited with
800 `git branch --edit-description`. Branch description is
801 automatically added in the format-patch cover letter or
802 request-pull summary.
805 Specify the command to invoke the specified browser. The
806 specified command is evaluated in shell with the URLs passed
807 as arguments. (See linkgit:git-web{litdd}browse[1].)
809 browser.<tool>.path::
810 Override the path for the given tool that may be used to
811 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
812 working repository in gitweb (see linkgit:git-instaweb[1]).
815 A boolean to make git-clean do nothing unless given -f,
816 -i or -n. Defaults to true.
819 A boolean to enable/disable color in the output of
820 linkgit:git-branch[1]. May be set to `always`,
821 `false` (or `never`) or `auto` (or `true`), in which case colors are used
822 only when the output is to a terminal. Defaults to false.
824 color.branch.<slot>::
825 Use customized color for branch coloration. `<slot>` is one of
826 `current` (the current branch), `local` (a local branch),
827 `remote` (a remote-tracking branch in refs/remotes/),
828 `upstream` (upstream tracking branch), `plain` (other
831 The value for these configuration variables is a list of colors (at most
832 two) and attributes (at most one), separated by spaces. The colors
833 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
834 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
835 `blink` and `reverse`. The first color given is the foreground; the
836 second is the background. The position of the attribute, if any,
840 Whether to use ANSI escape sequences to add color to patches.
841 If this is set to `always`, linkgit:git-diff[1],
842 linkgit:git-log[1], and linkgit:git-show[1] will use color
843 for all patches. If it is set to `true` or `auto`, those
844 commands will only use color when output is to the terminal.
847 This does not affect linkgit:git-format-patch[1] or the
848 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
849 command line with the `--color[=<when>]` option.
852 Use customized color for diff colorization. `<slot>` specifies
853 which part of the patch to use the specified color, and is one
854 of `plain` (context text), `meta` (metainformation), `frag`
855 (hunk header), 'func' (function in hunk header), `old` (removed lines),
856 `new` (added lines), `commit` (commit headers), or `whitespace`
857 (highlighting whitespace errors). The values of these variables may be
858 specified as in color.branch.<slot>.
860 color.decorate.<slot>::
861 Use customized color for 'git log --decorate' output. `<slot>` is one
862 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
863 branches, remote-tracking branches, tags, stash and HEAD, respectively.
866 When set to `always`, always highlight matches. When `false` (or
867 `never`), never. When set to `true` or `auto`, use color only
868 when the output is written to the terminal. Defaults to `false`.
871 Use customized color for grep colorization. `<slot>` specifies which
872 part of the line to use the specified color, and is one of
876 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
878 filename prefix (when not using `-h`)
880 function name lines (when using `-p`)
882 line number prefix (when using `-n`)
886 non-matching text in selected lines
888 separators between fields on a line (`:`, `-`, and `=`)
889 and between hunks (`--`)
892 The values of these variables may be specified as in color.branch.<slot>.
895 When set to `always`, always use colors for interactive prompts
896 and displays (such as those used by "git-add --interactive" and
897 "git-clean --interactive"). When false (or `never`), never.
898 When set to `true` or `auto`, use colors only when the output is
899 to the terminal. Defaults to false.
901 color.interactive.<slot>::
902 Use customized color for 'git add --interactive' and 'git clean
903 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
904 or `error`, for four distinct types of normal output from
905 interactive commands. The values of these variables may be
906 specified as in color.branch.<slot>.
909 A boolean to enable/disable colored output when the pager is in
910 use (default is true).
913 A boolean to enable/disable color in the output of
914 linkgit:git-show-branch[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.
919 A boolean to enable/disable color in the output of
920 linkgit:git-status[1]. May be set to `always`,
921 `false` (or `never`) or `auto` (or `true`), in which case colors are used
922 only when the output is to a terminal. Defaults to false.
924 color.status.<slot>::
925 Use customized color for status colorization. `<slot>` is
926 one of `header` (the header text of the status message),
927 `added` or `updated` (files which are added but not committed),
928 `changed` (files which are changed but not added in the index),
929 `untracked` (files which are not tracked by Git),
930 `branch` (the current branch), or
931 `nobranch` (the color the 'no branch' warning is shown in, defaulting
932 to red). The values of these variables may be specified as in
936 This variable determines the default value for variables such
937 as `color.diff` and `color.grep` that control the use of color
938 per command family. Its scope will expand as more commands learn
939 configuration to set a default for the `--color` option. Set it
940 to `false` or `never` if you prefer Git commands not to use
941 color unless enabled explicitly with some other configuration
942 or the `--color` option. Set it to `always` if you want all
943 output not intended for machine consumption to use color, to
944 `true` or `auto` (this is the default since Git 1.8.4) if you
945 want such output to use color when written to the terminal.
948 Specify whether supported commands should output in columns.
949 This variable consists of a list of tokens separated by spaces
952 These options control when the feature should be enabled
953 (defaults to 'never'):
957 always show in columns
959 never show in columns
961 show in columns if the output is to the terminal
964 These options control layout (defaults to 'column'). Setting any
965 of these implies 'always' if none of 'always', 'never', or 'auto' are
970 fill columns before rows
972 fill rows before columns
977 Finally, these options can be combined with a layout option (defaults
982 make unequal size columns to utilize more space
984 make equal size columns
988 Specify whether to output branch listing in `git branch` in columns.
989 See `column.ui` for details.
992 Specify the layout when list items in `git clean -i`, which always
993 shows files and directories in columns. See `column.ui` for details.
996 Specify whether to output untracked files in `git status` in columns.
997 See `column.ui` for details.
1000 Specify whether to output tag listing in `git tag` in columns.
1001 See `column.ui` for details.
1004 This setting overrides the default of the `--cleanup` option in
1005 `git commit`. See linkgit:git-commit[1] for details. Changing the
1006 default can be useful when you always want to keep lines that begin
1007 with comment character `#` in your log message, in which case you
1008 would do `git config commit.cleanup whitespace` (note that you will
1009 have to remove the help lines that begin with `#` in the commit log
1010 template yourself, if you do this).
1014 A boolean to specify whether all commits should be GPG signed.
1015 Use of this option when doing operations such as rebase can
1016 result in a large number of commits being signed. It may be
1017 convenient to use an agent to avoid typing your GPG passphrase
1021 A boolean to enable/disable inclusion of status information in the
1022 commit message template when using an editor to prepare the commit
1023 message. Defaults to true.
1026 Specify a file to use as the template for new commit messages.
1027 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1028 specified user's home directory.
1031 Specify an external helper to be called when a username or
1032 password credential is needed; the helper may consult external
1033 storage to avoid prompting the user for the credentials. See
1034 linkgit:gitcredentials[7] for details.
1036 credential.useHttpPath::
1037 When acquiring credentials, consider the "path" component of an http
1038 or https URL to be important. Defaults to false. See
1039 linkgit:gitcredentials[7] for more information.
1041 credential.username::
1042 If no username is set for a network authentication, use this username
1043 by default. See credential.<context>.* below, and
1044 linkgit:gitcredentials[7].
1046 credential.<url>.*::
1047 Any of the credential.* options above can be applied selectively to
1048 some credentials. For example "credential.https://example.com.username"
1049 would set the default username only for https connections to
1050 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1053 include::diff-config.txt[]
1055 difftool.<tool>.path::
1056 Override the path for the given tool. This is useful in case
1057 your tool is not in the PATH.
1059 difftool.<tool>.cmd::
1060 Specify the command to invoke the specified diff tool.
1061 The specified command is evaluated in shell with the following
1062 variables available: 'LOCAL' is set to the name of the temporary
1063 file containing the contents of the diff pre-image and 'REMOTE'
1064 is set to the name of the temporary file containing the contents
1065 of the diff post-image.
1068 Prompt before each invocation of the diff tool.
1070 fetch.recurseSubmodules::
1071 This option can be either set to a boolean value or to 'on-demand'.
1072 Setting it to a boolean changes the behavior of fetch and pull to
1073 unconditionally recurse into submodules when set to true or to not
1074 recurse at all when set to false. When set to 'on-demand' (the default
1075 value), fetch and pull will only recurse into a populated submodule
1076 when its superproject retrieves a commit that updates the submodule's
1080 If it is set to true, git-fetch-pack will check all fetched
1081 objects. It will abort in the case of a malformed object or a
1082 broken link. The result of an abort are only dangling objects.
1083 Defaults to false. If not set, the value of `transfer.fsckObjects`
1087 If the number of objects fetched over the Git native
1088 transfer is below this
1089 limit, then the objects will be unpacked into loose object
1090 files. However if the number of received objects equals or
1091 exceeds this limit then the received pack will be stored as
1092 a pack, after adding any missing delta bases. Storing the
1093 pack from a push can make the push operation complete faster,
1094 especially on slow filesystems. If not set, the value of
1095 `transfer.unpackLimit` is used instead.
1098 If true, fetch will automatically behave as if the `--prune`
1099 option was given on the command line. See also `remote.<name>.prune`.
1102 Enable multipart/mixed attachments as the default for
1103 'format-patch'. The value can also be a double quoted string
1104 which will enable attachments as the default and set the
1105 value as the boundary. See the --attach option in
1106 linkgit:git-format-patch[1].
1109 A boolean which can enable or disable sequence numbers in patch
1110 subjects. It defaults to "auto" which enables it only if there
1111 is more than one patch. It can be enabled or disabled for all
1112 messages by setting it to "true" or "false". See --numbered
1113 option in linkgit:git-format-patch[1].
1116 Additional email headers to include in a patch to be submitted
1117 by mail. See linkgit:git-format-patch[1].
1121 Additional recipients to include in a patch to be submitted
1122 by mail. See the --to and --cc options in
1123 linkgit:git-format-patch[1].
1125 format.subjectprefix::
1126 The default for format-patch is to output files with the '[PATCH]'
1127 subject prefix. Use this variable to change that prefix.
1130 The default for format-patch is to output a signature containing
1131 the Git version number. Use this variable to change that default.
1132 Set this variable to the empty string ("") to suppress
1133 signature generation.
1135 format.signaturefile::
1136 Works just like format.signature except the contents of the
1137 file specified by this variable will be used as the signature.
1140 The default for format-patch is to output files with the suffix
1141 `.patch`. Use this variable to change that suffix (make sure to
1142 include the dot if you want it).
1145 The default pretty format for log/show/whatchanged command,
1146 See linkgit:git-log[1], linkgit:git-show[1],
1147 linkgit:git-whatchanged[1].
1150 The default threading style for 'git format-patch'. Can be
1151 a boolean value, or `shallow` or `deep`. `shallow` threading
1152 makes every mail a reply to the head of the series,
1153 where the head is chosen from the cover letter, the
1154 `--in-reply-to`, and the first patch mail, in this order.
1155 `deep` threading makes every mail a reply to the previous one.
1156 A true boolean value is the same as `shallow`, and a false
1157 value disables threading.
1160 A boolean value which lets you enable the `-s/--signoff` option of
1161 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1162 patch should be a conscious act and means that you certify you have
1163 the rights to submit this work under the same open source license.
1164 Please see the 'SubmittingPatches' document for further discussion.
1166 format.coverLetter::
1167 A boolean that controls whether to generate a cover-letter when
1168 format-patch is invoked, but in addition can be set to "auto", to
1169 generate a cover-letter only when there's more than one patch.
1171 filter.<driver>.clean::
1172 The command which is used to convert the content of a worktree
1173 file to a blob upon checkin. See linkgit:gitattributes[5] for
1176 filter.<driver>.smudge::
1177 The command which is used to convert the content of a blob
1178 object to a worktree file upon checkout. See
1179 linkgit:gitattributes[5] for details.
1181 gc.aggressiveDepth::
1182 The depth parameter used in the delta compression
1183 algorithm used by 'git gc --aggressive'. This defaults
1186 gc.aggressiveWindow::
1187 The window size parameter used in the delta compression
1188 algorithm used by 'git gc --aggressive'. This defaults
1192 When there are approximately more than this many loose
1193 objects in the repository, `git gc --auto` will pack them.
1194 Some Porcelain commands use this command to perform a
1195 light-weight garbage collection from time to time. The
1196 default value is 6700. Setting this to 0 disables it.
1199 When there are more than this many packs that are not
1200 marked with `*.keep` file in the repository, `git gc
1201 --auto` consolidates them into one larger pack. The
1202 default value is 50. Setting this to 0 disables it.
1205 Make `git gc --auto` return immediately andrun in background
1206 if the system supports it. Default is true.
1209 Running `git pack-refs` in a repository renders it
1210 unclonable by Git versions prior to 1.5.1.2 over dumb
1211 transports such as HTTP. This variable determines whether
1212 'git gc' runs `git pack-refs`. This can be set to `notbare`
1213 to enable it within all non-bare repos or it can be set to a
1214 boolean value. The default is `true`.
1217 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1218 Override the grace period with this config variable. The value
1219 "now" may be used to disable this grace period and always prune
1220 unreachable objects immediately.
1223 gc.<pattern>.reflogexpire::
1224 'git reflog expire' removes reflog entries older than
1225 this time; defaults to 90 days. With "<pattern>" (e.g.
1226 "refs/stash") in the middle the setting applies only to
1227 the refs that match the <pattern>.
1229 gc.reflogexpireunreachable::
1230 gc.<ref>.reflogexpireunreachable::
1231 'git reflog expire' removes reflog entries older than
1232 this time and are not reachable from the current tip;
1233 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1234 in the middle, the setting applies only to the refs that
1235 match the <pattern>.
1238 Records of conflicted merge you resolved earlier are
1239 kept for this many days when 'git rerere gc' is run.
1240 The default is 60 days. See linkgit:git-rerere[1].
1242 gc.rerereunresolved::
1243 Records of conflicted merge you have not resolved are
1244 kept for this many days when 'git rerere gc' is run.
1245 The default is 15 days. See linkgit:git-rerere[1].
1247 gitcvs.commitmsgannotation::
1248 Append this string to each commit message. Set to empty string
1249 to disable this feature. Defaults to "via git-CVS emulator".
1252 Whether the CVS server interface is enabled for this repository.
1253 See linkgit:git-cvsserver[1].
1256 Path to a log file where the CVS server interface well... logs
1257 various stuff. See linkgit:git-cvsserver[1].
1259 gitcvs.usecrlfattr::
1260 If true, the server will look up the end-of-line conversion
1261 attributes for files to determine the '-k' modes to use. If
1262 the attributes force Git to treat a file as text,
1263 the '-k' mode will be left blank so CVS clients will
1264 treat it as text. If they suppress text conversion, the file
1265 will be set with '-kb' mode, which suppresses any newline munging
1266 the client might otherwise do. If the attributes do not allow
1267 the file type to be determined, then 'gitcvs.allbinary' is
1268 used. See linkgit:gitattributes[5].
1271 This is used if 'gitcvs.usecrlfattr' does not resolve
1272 the correct '-kb' mode to use. If true, all
1273 unresolved files are sent to the client in
1274 mode '-kb'. This causes the client to treat them
1275 as binary files, which suppresses any newline munging it
1276 otherwise might do. Alternatively, if it is set to "guess",
1277 then the contents of the file are examined to decide if
1278 it is binary, similar to 'core.autocrlf'.
1281 Database used by git-cvsserver to cache revision information
1282 derived from the Git repository. The exact meaning depends on the
1283 used database driver, for SQLite (which is the default driver) this
1284 is a filename. Supports variable substitution (see
1285 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1286 Default: '%Ggitcvs.%m.sqlite'
1289 Used Perl DBI driver. You can specify any available driver
1290 for this here, but it might not work. git-cvsserver is tested
1291 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1292 reported *not* to work with 'DBD::mysql'. Experimental feature.
1293 May not contain double colons (`:`). Default: 'SQLite'.
1294 See linkgit:git-cvsserver[1].
1296 gitcvs.dbuser, gitcvs.dbpass::
1297 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1298 since SQLite has no concept of database users and/or passwords.
1299 'gitcvs.dbuser' supports variable substitution (see
1300 linkgit:git-cvsserver[1] for details).
1302 gitcvs.dbTableNamePrefix::
1303 Database table name prefix. Prepended to the names of any
1304 database tables used, allowing a single database to be used
1305 for several repositories. Supports variable substitution (see
1306 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1307 characters will be replaced with underscores.
1309 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1310 'gitcvs.allbinary' can also be specified as
1311 'gitcvs.<access_method>.<varname>' (where 'access_method'
1312 is one of "ext" and "pserver") to make them apply only for the given
1316 gitweb.description::
1319 See linkgit:gitweb[1] for description.
1327 gitweb.remote_heads::
1330 See linkgit:gitweb.conf[5] for description.
1333 If set to true, enable '-n' option by default.
1336 Set the default matching behavior. Using a value of 'basic', 'extended',
1337 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1338 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1339 value 'default' will return to the default matching behavior.
1341 grep.extendedRegexp::
1342 If set to true, enable '--extended-regexp' option by default. This
1343 option is ignored when the 'grep.patternType' option is set to a value
1344 other than 'default'.
1347 Use this custom program instead of "gpg" found on $PATH when
1348 making or verifying a PGP signature. The program must support the
1349 same command-line interface as GPG, namely, to verify a detached
1350 signature, "gpg --verify $file - <$signature" is run, and the
1351 program is expected to signal a good signature by exiting with
1352 code 0, and to generate an ascii-armored detached signature, the
1353 standard input of "gpg -bsau $key" is fed with the contents to be
1354 signed, and the program is expected to send the result to its
1357 gui.commitmsgwidth::
1358 Defines how wide the commit message window is in the
1359 linkgit:git-gui[1]. "75" is the default.
1362 Specifies how many context lines should be used in calls to diff
1363 made by the linkgit:git-gui[1]. The default is "5".
1365 gui.displayuntracked::
1366 Determines if linkgit::git-gui[1] shows untracked files
1367 in the file list. The default is "true".
1370 Specifies the default encoding to use for displaying of
1371 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1372 It can be overridden by setting the 'encoding' attribute
1373 for relevant files (see linkgit:gitattributes[5]).
1374 If this option is not set, the tools default to the
1377 gui.matchtrackingbranch::
1378 Determines if new branches created with linkgit:git-gui[1] should
1379 default to tracking remote branches with matching names or
1380 not. Default: "false".
1382 gui.newbranchtemplate::
1383 Is used as suggested name when creating new branches using the
1386 gui.pruneduringfetch::
1387 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1388 performing a fetch. The default value is "false".
1391 Determines if linkgit:git-gui[1] should trust the file modification
1392 timestamp or not. By default the timestamps are not trusted.
1394 gui.spellingdictionary::
1395 Specifies the dictionary used for spell checking commit messages in
1396 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1400 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1401 location detection. It makes blame significantly faster on huge
1402 repositories at the expense of less thorough copy detection.
1404 gui.copyblamethreshold::
1405 Specifies the threshold to use in 'git gui blame' original location
1406 detection, measured in alphanumeric characters. See the
1407 linkgit:git-blame[1] manual for more information on copy detection.
1409 gui.blamehistoryctx::
1410 Specifies the radius of history context in days to show in
1411 linkgit:gitk[1] for the selected commit, when the `Show History
1412 Context` menu item is invoked from 'git gui blame'. If this
1413 variable is set to zero, the whole history is shown.
1415 guitool.<name>.cmd::
1416 Specifies the shell command line to execute when the corresponding item
1417 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1418 mandatory for every tool. The command is executed from the root of
1419 the working directory, and in the environment it receives the name of
1420 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1421 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1422 the head is detached, 'CUR_BRANCH' is empty).
1424 guitool.<name>.needsfile::
1425 Run the tool only if a diff is selected in the GUI. It guarantees
1426 that 'FILENAME' is not empty.
1428 guitool.<name>.noconsole::
1429 Run the command silently, without creating a window to display its
1432 guitool.<name>.norescan::
1433 Don't rescan the working directory for changes after the tool
1436 guitool.<name>.confirm::
1437 Show a confirmation dialog before actually running the tool.
1439 guitool.<name>.argprompt::
1440 Request a string argument from the user, and pass it to the tool
1441 through the 'ARGS' environment variable. Since requesting an
1442 argument implies confirmation, the 'confirm' option has no effect
1443 if this is enabled. If the option is set to 'true', 'yes', or '1',
1444 the dialog uses a built-in generic prompt; otherwise the exact
1445 value of the variable is used.
1447 guitool.<name>.revprompt::
1448 Request a single valid revision from the user, and set the
1449 'REVISION' environment variable. In other aspects this option
1450 is similar to 'argprompt', and can be used together with it.
1452 guitool.<name>.revunmerged::
1453 Show only unmerged branches in the 'revprompt' subdialog.
1454 This is useful for tools similar to merge or rebase, but not
1455 for things like checkout or reset.
1457 guitool.<name>.title::
1458 Specifies the title to use for the prompt dialog. The default
1461 guitool.<name>.prompt::
1462 Specifies the general prompt string to display at the top of
1463 the dialog, before subsections for 'argprompt' and 'revprompt'.
1464 The default value includes the actual command.
1467 Specify the browser that will be used to display help in the
1468 'web' format. See linkgit:git-help[1].
1471 Override the default help format used by linkgit:git-help[1].
1472 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1473 the default. 'web' and 'html' are the same.
1476 Automatically correct and execute mistyped commands after
1477 waiting for the given number of deciseconds (0.1 sec). If more
1478 than one command can be deduced from the entered text, nothing
1479 will be executed. If the value of this option is negative,
1480 the corrected command will be executed immediately. If the
1481 value is 0 - the command will be just shown but not executed.
1482 This is the default.
1485 Specify the path where the HTML documentation resides. File system paths
1486 and URLs are supported. HTML pages will be prefixed with this path when
1487 help is displayed in the 'web' format. This defaults to the documentation
1488 path of your Git installation.
1491 Override the HTTP proxy, normally configured using the 'http_proxy',
1492 'https_proxy', and 'all_proxy' environment variables (see
1493 `curl(1)`). This can be overridden on a per-remote basis; see
1497 File containing previously stored cookie lines which should be used
1498 in the Git http session, if they match the server. The file format
1499 of the file to read cookies from should be plain HTTP headers or
1500 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1501 NOTE that the file specified with http.cookiefile is only used as
1502 input unless http.saveCookies is set.
1505 If set, store cookies received during requests to the file specified by
1506 http.cookiefile. Has no effect if http.cookiefile is unset.
1509 Whether to verify the SSL certificate when fetching or pushing
1510 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1514 File containing the SSL certificate when fetching or pushing
1515 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1519 File containing the SSL private key when fetching or pushing
1520 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1523 http.sslCertPasswordProtected::
1524 Enable Git's password prompt for the SSL certificate. Otherwise
1525 OpenSSL will prompt the user, possibly many times, if the
1526 certificate or private key is encrypted. Can be overridden by the
1527 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1530 File containing the certificates to verify the peer with when
1531 fetching or pushing over HTTPS. Can be overridden by the
1532 'GIT_SSL_CAINFO' environment variable.
1535 Path containing files with the CA certificates to verify the peer
1536 with when fetching or pushing over HTTPS. Can be overridden
1537 by the 'GIT_SSL_CAPATH' environment variable.
1540 Attempt to use AUTH SSL/TLS and encrypted data transfers
1541 when connecting via regular FTP protocol. This might be needed
1542 if the FTP server requires it for security reasons or you wish
1543 to connect securely whenever remote FTP server supports it.
1544 Default is false since it might trigger certificate verification
1545 errors on misconfigured servers.
1548 How many HTTP requests to launch in parallel. Can be overridden
1549 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1552 The number of curl sessions (counted across slots) to be kept across
1553 requests. They will not be ended with curl_easy_cleanup() until
1554 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1555 value will be capped at 1. Defaults to 1.
1558 Maximum size in bytes of the buffer used by smart HTTP
1559 transports when POSTing data to the remote system.
1560 For requests larger than this buffer size, HTTP/1.1 and
1561 Transfer-Encoding: chunked is used to avoid creating a
1562 massive pack file locally. Default is 1 MiB, which is
1563 sufficient for most requests.
1565 http.lowSpeedLimit, http.lowSpeedTime::
1566 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1567 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1568 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1569 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1572 A boolean which disables using of EPSV ftp command by curl.
1573 This can helpful with some "poor" ftp servers which don't
1574 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1575 environment variable. Default is false (curl will use EPSV).
1578 The HTTP USER_AGENT string presented to an HTTP server. The default
1579 value represents the version of the client Git such as git/1.7.1.
1580 This option allows you to override this value to a more common value
1581 such as Mozilla/4.0. This may be necessary, for instance, if
1582 connecting through a firewall that restricts HTTP connections to a set
1583 of common USER_AGENT strings (but not including those like git/1.7.1).
1584 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1587 Any of the http.* options above can be applied selectively to some urls.
1588 For a config key to match a URL, each element of the config key is
1589 compared to that of the URL, in the following order:
1592 . Scheme (e.g., `https` in `https://example.com/`). This field
1593 must match exactly between the config key and the URL.
1595 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1596 This field must match exactly between the config key and the URL.
1598 . Port number (e.g., `8080` in `http://example.com:8080/`).
1599 This field must match exactly between the config key and the URL.
1600 Omitted port numbers are automatically converted to the correct
1601 default for the scheme before matching.
1603 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1604 path field of the config key must match the path field of the URL
1605 either exactly or as a prefix of slash-delimited path elements. This means
1606 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1607 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1608 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1609 key with just path `foo/`).
1611 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1612 the config key has a user name it must match the user name in the
1613 URL exactly. If the config key does not have a user name, that
1614 config key will match a URL with any user name (including none),
1615 but at a lower precedence than a config key with a user name.
1618 The list above is ordered by decreasing precedence; a URL that matches
1619 a config key's path is preferred to one that matches its user name. For example,
1620 if the URL is `https://user@example.com/foo/bar` a config key match of
1621 `https://example.com/foo` will be preferred over a config key match of
1622 `https://user@example.com`.
1624 All URLs are normalized before attempting any matching (the password part,
1625 if embedded in the URL, is always ignored for matching purposes) so that
1626 equivalent urls that are simply spelled differently will match properly.
1627 Environment variable settings always override any matches. The urls that are
1628 matched against are those given directly to Git commands. This means any URLs
1629 visited as a result of a redirection do not participate in matching.
1631 i18n.commitEncoding::
1632 Character encoding the commit messages are stored in; Git itself
1633 does not care per se, but this information is necessary e.g. when
1634 importing commits from emails or in the gitk graphical history
1635 browser (and possibly at other places in the future or in other
1636 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1638 i18n.logOutputEncoding::
1639 Character encoding the commit messages are converted to when
1640 running 'git log' and friends.
1643 The configuration variables in the 'imap' section are described
1644 in linkgit:git-imap-send[1].
1647 Specify the version with which new index files should be
1648 initialized. This does not affect existing repositories.
1651 Specify the directory from which templates will be copied.
1652 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1655 Specify the program that will be used to browse your working
1656 repository in gitweb. See linkgit:git-instaweb[1].
1659 The HTTP daemon command-line to start gitweb on your working
1660 repository. See linkgit:git-instaweb[1].
1663 If true the web server started by linkgit:git-instaweb[1] will
1664 be bound to the local IP (127.0.0.1).
1666 instaweb.modulepath::
1667 The default module path for linkgit:git-instaweb[1] to use
1668 instead of /usr/lib/apache2/modules. Only used if httpd
1672 The port number to bind the gitweb httpd to. See
1673 linkgit:git-instaweb[1].
1675 interactive.singlekey::
1676 In interactive commands, allow the user to provide one-letter
1677 input with a single key (i.e., without hitting enter).
1678 Currently this is used by the `--patch` mode of
1679 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1680 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1681 setting is silently ignored if portable keystroke input
1682 is not available; requires the Perl module Term::ReadKey.
1685 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1686 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1687 override this option with `--no-abbrev-commit`.
1690 Set the default date-time mode for the 'log' command.
1691 Setting a value for log.date is similar to using 'git log''s
1692 `--date` option. Possible values are `relative`, `local`,
1693 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1697 Print out the ref names of any commits that are shown by the log
1698 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1699 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1700 specified, the full ref name (including prefix) will be printed.
1701 This is the same as the log commands '--decorate' option.
1704 If true, the initial commit will be shown as a big creation event.
1705 This is equivalent to a diff against an empty tree.
1706 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1707 normally hide the root commit will now show it. True by default.
1710 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1711 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1714 The location of an augmenting mailmap file. The default
1715 mailmap, located in the root of the repository, is loaded
1716 first, then the mailmap file pointed to by this variable.
1717 The location of the mailmap file may be in a repository
1718 subdirectory, or somewhere outside of the repository itself.
1719 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1722 Like `mailmap.file`, but consider the value as a reference to a
1723 blob in the repository. If both `mailmap.file` and
1724 `mailmap.blob` are given, both are parsed, with entries from
1725 `mailmap.file` taking precedence. In a bare repository, this
1726 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1730 Specify the programs that may be used to display help in the
1731 'man' format. See linkgit:git-help[1].
1734 Specify the command to invoke the specified man viewer. The
1735 specified command is evaluated in shell with the man page
1736 passed as argument. (See linkgit:git-help[1].)
1739 Override the path for the given tool that may be used to
1740 display help in the 'man' format. See linkgit:git-help[1].
1742 include::merge-config.txt[]
1744 mergetool.<tool>.path::
1745 Override the path for the given tool. This is useful in case
1746 your tool is not in the PATH.
1748 mergetool.<tool>.cmd::
1749 Specify the command to invoke the specified merge tool. The
1750 specified command is evaluated in shell with the following
1751 variables available: 'BASE' is the name of a temporary file
1752 containing the common base of the files to be merged, if available;
1753 'LOCAL' is the name of a temporary file containing the contents of
1754 the file on the current branch; 'REMOTE' is the name of a temporary
1755 file containing the contents of the file from the branch being
1756 merged; 'MERGED' contains the name of the file to which the merge
1757 tool should write the results of a successful merge.
1759 mergetool.<tool>.trustExitCode::
1760 For a custom merge command, specify whether the exit code of
1761 the merge command can be used to determine whether the merge was
1762 successful. If this is not set to true then the merge target file
1763 timestamp is checked and the merge assumed to have been successful
1764 if the file has been updated, otherwise the user is prompted to
1765 indicate the success of the merge.
1767 mergetool.meld.hasOutput::
1768 Older versions of `meld` do not support the `--output` option.
1769 Git will attempt to detect whether `meld` supports `--output`
1770 by inspecting the output of `meld --help`. Configuring
1771 `mergetool.meld.hasOutput` will make Git skip these checks and
1772 use the configured value instead. Setting `mergetool.meld.hasOutput`
1773 to `true` tells Git to unconditionally use the `--output` option,
1774 and `false` avoids using `--output`.
1776 mergetool.keepBackup::
1777 After performing a merge, the original file with conflict markers
1778 can be saved as a file with a `.orig` extension. If this variable
1779 is set to `false` then this file is not preserved. Defaults to
1780 `true` (i.e. keep the backup files).
1782 mergetool.keepTemporaries::
1783 When invoking a custom merge tool, Git uses a set of temporary
1784 files to pass to the tool. If the tool returns an error and this
1785 variable is set to `true`, then these temporary files will be
1786 preserved, otherwise they will be removed after the tool has
1787 exited. Defaults to `false`.
1790 Prompt before each invocation of the merge resolution program.
1793 The (fully qualified) refname from which to show notes when
1794 showing commit messages. The value of this variable can be set
1795 to a glob, in which case notes from all matching refs will be
1796 shown. You may also specify this configuration variable
1797 several times. A warning will be issued for refs that do not
1798 exist, but a glob that does not match any refs is silently
1801 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1802 environment variable, which must be a colon separated list of refs or
1805 The effective value of "core.notesRef" (possibly overridden by
1806 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1809 notes.rewrite.<command>::
1810 When rewriting commits with <command> (currently `amend` or
1811 `rebase`) and this variable is set to `true`, Git
1812 automatically copies your notes from the original to the
1813 rewritten commit. Defaults to `true`, but see
1814 "notes.rewriteRef" below.
1817 When copying notes during a rewrite (see the
1818 "notes.rewrite.<command>" option), determines what to do if
1819 the target commit already has a note. Must be one of
1820 `overwrite`, `concatenate`, or `ignore`. Defaults to
1823 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1824 environment variable.
1827 When copying notes during a rewrite, specifies the (fully
1828 qualified) ref whose notes should be copied. The ref may be a
1829 glob, in which case notes in all matching refs will be copied.
1830 You may also specify this configuration several times.
1832 Does not have a default value; you must configure this variable to
1833 enable note rewriting. Set it to `refs/notes/commits` to enable
1834 rewriting for the default commit notes.
1836 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1837 environment variable, which must be a colon separated list of refs or
1841 The size of the window used by linkgit:git-pack-objects[1] when no
1842 window size is given on the command line. Defaults to 10.
1845 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1846 maximum depth is given on the command line. Defaults to 50.
1849 The window memory size limit used by linkgit:git-pack-objects[1]
1850 when no limit is given on the command line. The value can be
1851 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1855 An integer -1..9, indicating the compression level for objects
1856 in a pack file. -1 is the zlib default. 0 means no
1857 compression, and 1..9 are various speed/size tradeoffs, 9 being
1858 slowest. If not set, defaults to core.compression. If that is
1859 not set, defaults to -1, the zlib default, which is "a default
1860 compromise between speed and compression (currently equivalent
1863 Note that changing the compression level will not automatically recompress
1864 all existing objects. You can force recompression by passing the -F option
1865 to linkgit:git-repack[1].
1867 pack.deltaCacheSize::
1868 The maximum memory in bytes used for caching deltas in
1869 linkgit:git-pack-objects[1] before writing them out to a pack.
1870 This cache is used to speed up the writing object phase by not
1871 having to recompute the final delta result once the best match
1872 for all objects is found. Repacking large repositories on machines
1873 which are tight with memory might be badly impacted by this though,
1874 especially if this cache pushes the system into swapping.
1875 A value of 0 means no limit. The smallest size of 1 byte may be
1876 used to virtually disable this cache. Defaults to 256 MiB.
1878 pack.deltaCacheLimit::
1879 The maximum size of a delta, that is cached in
1880 linkgit:git-pack-objects[1]. This cache is used to speed up the
1881 writing object phase by not having to recompute the final delta
1882 result once the best match for all objects is found. Defaults to 1000.
1885 Specifies the number of threads to spawn when searching for best
1886 delta matches. This requires that linkgit:git-pack-objects[1]
1887 be compiled with pthreads otherwise this option is ignored with a
1888 warning. This is meant to reduce packing time on multiprocessor
1889 machines. The required amount of memory for the delta search window
1890 is however multiplied by the number of threads.
1891 Specifying 0 will cause Git to auto-detect the number of CPU's
1892 and set the number of threads accordingly.
1895 Specify the default pack index version. Valid values are 1 for
1896 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1897 the new pack index with capabilities for packs larger than 4 GB
1898 as well as proper protection against the repacking of corrupted
1899 packs. Version 2 is the default. Note that version 2 is enforced
1900 and this config option ignored whenever the corresponding pack is
1903 If you have an old Git that does not understand the version 2 `*.idx` file,
1904 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1905 that will copy both `*.pack` file and corresponding `*.idx` file from the
1906 other side may give you a repository that cannot be accessed with your
1907 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1908 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1911 pack.packSizeLimit::
1912 The maximum size of a pack. This setting only affects
1913 packing to a file when repacking, i.e. the git:// protocol
1914 is unaffected. It can be overridden by the `--max-pack-size`
1915 option of linkgit:git-repack[1]. The minimum size allowed is
1916 limited to 1 MiB. The default is unlimited.
1917 Common unit suffixes of 'k', 'm', or 'g' are
1921 When true, git will use pack bitmaps (if available) when packing
1922 to stdout (e.g., during the server side of a fetch). Defaults to
1923 true. You should not generally need to turn this off unless
1924 you are debugging pack bitmaps.
1927 This is a deprecated synonym for `repack.writeBitmaps`.
1929 pack.writeBitmapHashCache::
1930 When true, git will include a "hash cache" section in the bitmap
1931 index (if one is written). This cache can be used to feed git's
1932 delta heuristics, potentially leading to better deltas between
1933 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1934 between an older, bitmapped pack and objects that have been
1935 pushed since the last gc). The downside is that it consumes 4
1936 bytes per object of disk space, and that JGit's bitmap
1937 implementation does not understand it, causing it to complain if
1938 Git and JGit are used on the same repository. Defaults to false.
1941 If the value is boolean, turns on or off pagination of the
1942 output of a particular Git subcommand when writing to a tty.
1943 Otherwise, turns on pagination for the subcommand using the
1944 pager specified by the value of `pager.<cmd>`. If `--paginate`
1945 or `--no-pager` is specified on the command line, it takes
1946 precedence over this option. To disable pagination for all
1947 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1950 Alias for a --pretty= format string, as specified in
1951 linkgit:git-log[1]. Any aliases defined here can be used just
1952 as the built-in pretty formats could. For example,
1953 running `git config pretty.changelog "format:* %H %s"`
1954 would cause the invocation `git log --pretty=changelog`
1955 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1956 Note that an alias with the same name as a built-in format
1957 will be silently ignored.
1960 By default, Git does not create an extra merge commit when merging
1961 a commit that is a descendant of the current commit. Instead, the
1962 tip of the current branch is fast-forwarded. When set to `false`,
1963 this variable tells Git to create an extra merge commit in such
1964 a case (equivalent to giving the `--no-ff` option from the command
1965 line). When set to `only`, only such fast-forward merges are
1966 allowed (equivalent to giving the `--ff-only` option from the
1970 When true, rebase branches on top of the fetched branch, instead
1971 of merging the default branch from the default remote when "git
1972 pull" is run. See "branch.<name>.rebase" for setting this on a
1975 When preserve, also pass `--preserve-merges` along to 'git rebase'
1976 so that locally committed merge commits will not be flattened
1977 by running 'git pull'.
1979 *NOTE*: this is a possibly dangerous operation; do *not* use
1980 it unless you understand the implications (see linkgit:git-rebase[1]
1984 The default merge strategy to use when pulling multiple branches
1988 The default merge strategy to use when pulling a single branch.
1991 Defines the action `git push` should take if no refspec is
1992 explicitly given. Different values are well-suited for
1993 specific workflows; for instance, in a purely central workflow
1994 (i.e. the fetch source is equal to the push destination),
1995 `upstream` is probably what you want. Possible values are:
1999 * `nothing` - do not push anything (error out) unless a refspec is
2000 explicitly given. This is primarily meant for people who want to
2001 avoid mistakes by always being explicit.
2003 * `current` - push the current branch to update a branch with the same
2004 name on the receiving end. Works in both central and non-central
2007 * `upstream` - push the current branch back to the branch whose
2008 changes are usually integrated into the current branch (which is
2009 called `@{upstream}`). This mode only makes sense if you are
2010 pushing to the same repository you would normally pull from
2011 (i.e. central workflow).
2013 * `simple` - in centralized workflow, work like `upstream` with an
2014 added safety to refuse to push if the upstream branch's name is
2015 different from the local one.
2017 When pushing to a remote that is different from the remote you normally
2018 pull from, work as `current`. This is the safest option and is suited
2021 This mode has become the default in Git 2.0.
2023 * `matching` - push all branches having the same name on both ends.
2024 This makes the repository you are pushing to remember the set of
2025 branches that will be pushed out (e.g. if you always push 'maint'
2026 and 'master' there and no other branches, the repository you push
2027 to will have these two branches, and your local 'maint' and
2028 'master' will be pushed there).
2030 To use this mode effectively, you have to make sure _all_ the
2031 branches you would push out are ready to be pushed out before
2032 running 'git push', as the whole point of this mode is to allow you
2033 to push all of the branches in one go. If you usually finish work
2034 on only one branch and push out the result, while other branches are
2035 unfinished, this mode is not for you. Also this mode is not
2036 suitable for pushing into a shared central repository, as other
2037 people may add new branches there, or update the tip of existing
2038 branches outside your control.
2040 This used to be the default, but not since Git 2.0 (`simple` is the
2046 Whether to show a diffstat of what changed upstream since the last
2047 rebase. False by default.
2050 If set to true enable '--autosquash' option by default.
2053 When set to true, automatically create a temporary stash
2054 before the operation begins, and apply it after the operation
2055 ends. This means that you can run rebase on a dirty worktree.
2056 However, use with care: the final stash application after a
2057 successful rebase might result in non-trivial conflicts.
2061 By default, git-receive-pack will run "git-gc --auto" after
2062 receiving data from git-push and updating refs. You can stop
2063 it by setting this variable to false.
2065 receive.fsckObjects::
2066 If it is set to true, git-receive-pack will check all received
2067 objects. It will abort in the case of a malformed object or a
2068 broken link. The result of an abort are only dangling objects.
2069 Defaults to false. If not set, the value of `transfer.fsckObjects`
2072 receive.unpackLimit::
2073 If the number of objects received in a push is below this
2074 limit then the objects will be unpacked into loose object
2075 files. However if the number of received objects equals or
2076 exceeds this limit then the received pack will be stored as
2077 a pack, after adding any missing delta bases. Storing the
2078 pack from a push can make the push operation complete faster,
2079 especially on slow filesystems. If not set, the value of
2080 `transfer.unpackLimit` is used instead.
2082 receive.denyDeletes::
2083 If set to true, git-receive-pack will deny a ref update that deletes
2084 the ref. Use this to prevent such a ref deletion via a push.
2086 receive.denyDeleteCurrent::
2087 If set to true, git-receive-pack will deny a ref update that
2088 deletes the currently checked out branch of a non-bare repository.
2090 receive.denyCurrentBranch::
2091 If set to true or "refuse", git-receive-pack will deny a ref update
2092 to the currently checked out branch of a non-bare repository.
2093 Such a push is potentially dangerous because it brings the HEAD
2094 out of sync with the index and working tree. If set to "warn",
2095 print a warning of such a push to stderr, but allow the push to
2096 proceed. If set to false or "ignore", allow such pushes with no
2097 message. Defaults to "refuse".
2099 receive.denyNonFastForwards::
2100 If set to true, git-receive-pack will deny a ref update which is
2101 not a fast-forward. Use this to prevent such an update via a push,
2102 even if that push is forced. This configuration variable is
2103 set when initializing a shared repository.
2106 String(s) `receive-pack` uses to decide which refs to omit
2107 from its initial advertisement. Use more than one
2108 definitions to specify multiple prefix strings. A ref that
2109 are under the hierarchies listed on the value of this
2110 variable is excluded, and is hidden when responding to `git
2111 push`, and an attempt to update or delete a hidden ref by
2112 `git push` is rejected.
2114 receive.updateserverinfo::
2115 If set to true, git-receive-pack will run git-update-server-info
2116 after receiving data from git-push and updating refs.
2118 receive.shallowupdate::
2119 If set to true, .git/shallow can be updated when new refs
2120 require new shallow roots. Otherwise those refs are rejected.
2122 remote.pushdefault::
2123 The remote to push to by default. Overrides
2124 `branch.<name>.remote` for all branches, and is overridden by
2125 `branch.<name>.pushremote` for specific branches.
2128 The URL of a remote repository. See linkgit:git-fetch[1] or
2129 linkgit:git-push[1].
2131 remote.<name>.pushurl::
2132 The push URL of a remote repository. See linkgit:git-push[1].
2134 remote.<name>.proxy::
2135 For remotes that require curl (http, https and ftp), the URL to
2136 the proxy to use for that remote. Set to the empty string to
2137 disable proxying for that remote.
2139 remote.<name>.fetch::
2140 The default set of "refspec" for linkgit:git-fetch[1]. See
2141 linkgit:git-fetch[1].
2143 remote.<name>.push::
2144 The default set of "refspec" for linkgit:git-push[1]. See
2145 linkgit:git-push[1].
2147 remote.<name>.mirror::
2148 If true, pushing to this remote will automatically behave
2149 as if the `--mirror` option was given on the command line.
2151 remote.<name>.skipDefaultUpdate::
2152 If true, this remote will be skipped by default when updating
2153 using linkgit:git-fetch[1] or the `update` subcommand of
2154 linkgit:git-remote[1].
2156 remote.<name>.skipFetchAll::
2157 If true, this remote will be skipped by default when updating
2158 using linkgit:git-fetch[1] or the `update` subcommand of
2159 linkgit:git-remote[1].
2161 remote.<name>.receivepack::
2162 The default program to execute on the remote side when pushing. See
2163 option \--receive-pack of linkgit:git-push[1].
2165 remote.<name>.uploadpack::
2166 The default program to execute on the remote side when fetching. See
2167 option \--upload-pack of linkgit:git-fetch-pack[1].
2169 remote.<name>.tagopt::
2170 Setting this value to \--no-tags disables automatic tag following when
2171 fetching from remote <name>. Setting it to \--tags will fetch every
2172 tag from remote <name>, even if they are not reachable from remote
2173 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2174 override this setting. See options \--tags and \--no-tags of
2175 linkgit:git-fetch[1].
2178 Setting this to a value <vcs> will cause Git to interact with
2179 the remote with the git-remote-<vcs> helper.
2181 remote.<name>.prune::
2182 When set to true, fetching from this remote by default will also
2183 remove any remote-tracking references that no longer exist on the
2184 remote (as if the `--prune` option was given on the command line).
2185 Overrides `fetch.prune` settings, if any.
2188 The list of remotes which are fetched by "git remote update
2189 <group>". See linkgit:git-remote[1].
2191 repack.usedeltabaseoffset::
2192 By default, linkgit:git-repack[1] creates packs that use
2193 delta-base offset. If you need to share your repository with
2194 Git older than version 1.4.4, either directly or via a dumb
2195 protocol such as http, then you need to set this option to
2196 "false" and repack. Access from old Git versions over the
2197 native protocol are unaffected by this option.
2199 repack.packKeptObjects::
2200 If set to true, makes `git repack` act as if
2201 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2202 details. Defaults to `false` normally, but `true` if a bitmap
2203 index is being written (either via `--write-bitmap-index` or
2204 `repack.writeBitmaps`).
2206 repack.writeBitmaps::
2207 When true, git will write a bitmap index when packing all
2208 objects to disk (e.g., when `git repack -a` is run). This
2209 index can speed up the "counting objects" phase of subsequent
2210 packs created for clones and fetches, at the cost of some disk
2211 space and extra time spent on the initial repack. Defaults to
2215 When set to true, `git-rerere` updates the index with the
2216 resulting contents after it cleanly resolves conflicts using
2217 previously recorded resolution. Defaults to false.
2220 Activate recording of resolved conflicts, so that identical
2221 conflict hunks can be resolved automatically, should they be
2222 encountered again. By default, linkgit:git-rerere[1] is
2223 enabled if there is an `rr-cache` directory under the
2224 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2227 sendemail.identity::
2228 A configuration identity. When given, causes values in the
2229 'sendemail.<identity>' subsection to take precedence over
2230 values in the 'sendemail' section. The default identity is
2231 the value of 'sendemail.identity'.
2233 sendemail.smtpencryption::
2234 See linkgit:git-send-email[1] for description. Note that this
2235 setting is not subject to the 'identity' mechanism.
2238 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2240 sendemail.smtpsslcertpath::
2241 Path to ca-certificates (either a directory or a single file).
2242 Set it to an empty string to disable certificate verification.
2244 sendemail.<identity>.*::
2245 Identity-specific versions of the 'sendemail.*' parameters
2246 found below, taking precedence over those when the this
2247 identity is selected, through command-line or
2248 'sendemail.identity'.
2250 sendemail.aliasesfile::
2251 sendemail.aliasfiletype::
2252 sendemail.annotate::
2256 sendemail.chainreplyto::
2258 sendemail.envelopesender::
2260 sendemail.multiedit::
2261 sendemail.signedoffbycc::
2262 sendemail.smtppass::
2263 sendemail.suppresscc::
2264 sendemail.suppressfrom::
2266 sendemail.smtpdomain::
2267 sendemail.smtpserver::
2268 sendemail.smtpserverport::
2269 sendemail.smtpserveroption::
2270 sendemail.smtpuser::
2272 sendemail.validate::
2273 See linkgit:git-send-email[1] for description.
2275 sendemail.signedoffcc::
2276 Deprecated alias for 'sendemail.signedoffbycc'.
2278 showbranch.default::
2279 The default set of branches for linkgit:git-show-branch[1].
2280 See linkgit:git-show-branch[1].
2282 status.relativePaths::
2283 By default, linkgit:git-status[1] shows paths relative to the
2284 current directory. Setting this variable to `false` shows paths
2285 relative to the repository root (this was the default for Git
2289 Set to true to enable --short by default in linkgit:git-status[1].
2290 The option --no-short takes precedence over this variable.
2293 Set to true to enable --branch by default in linkgit:git-status[1].
2294 The option --no-branch takes precedence over this variable.
2296 status.displayCommentPrefix::
2297 If set to true, linkgit:git-status[1] will insert a comment
2298 prefix before each output line (starting with
2299 `core.commentChar`, i.e. `#` by default). This was the
2300 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2303 status.showUntrackedFiles::
2304 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2305 files which are not currently tracked by Git. Directories which
2306 contain only untracked files, are shown with the directory name
2307 only. Showing untracked files means that Git needs to lstat() all
2308 the files in the whole repository, which might be slow on some
2309 systems. So, this variable controls how the commands displays
2310 the untracked files. Possible values are:
2313 * `no` - Show no untracked files.
2314 * `normal` - Show untracked files and directories.
2315 * `all` - Show also individual files in untracked directories.
2318 If this variable is not specified, it defaults to 'normal'.
2319 This variable can be overridden with the -u|--untracked-files option
2320 of linkgit:git-status[1] and linkgit:git-commit[1].
2322 status.submodulesummary::
2324 If this is set to a non zero number or true (identical to -1 or an
2325 unlimited number), the submodule summary will be enabled and a
2326 summary of commits for modified submodules will be shown (see
2327 --summary-limit option of linkgit:git-submodule[1]). Please note
2328 that the summary output command will be suppressed for all
2329 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2330 for those submodules where `submodule.<name>.ignore=all`. The only
2331 exception to that rule is that status and commit will show staged
2332 submodule changes. To
2333 also view the summary for ignored submodules you can either use
2334 the --ignore-submodules=dirty command-line option or the 'git
2335 submodule summary' command, which shows a similar output but does
2336 not honor these settings.
2338 submodule.<name>.path::
2339 submodule.<name>.url::
2340 submodule.<name>.update::
2341 The path within this project, URL, and the updating strategy
2342 for a submodule. These variables are initially populated
2343 by 'git submodule init'; edit them to override the
2344 URL and other values found in the `.gitmodules` file. See
2345 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2347 submodule.<name>.branch::
2348 The remote branch name for a submodule, used by `git submodule
2349 update --remote`. Set this option to override the value found in
2350 the `.gitmodules` file. See linkgit:git-submodule[1] and
2351 linkgit:gitmodules[5] for details.
2353 submodule.<name>.fetchRecurseSubmodules::
2354 This option can be used to control recursive fetching of this
2355 submodule. It can be overridden by using the --[no-]recurse-submodules
2356 command-line option to "git fetch" and "git pull".
2357 This setting will override that from in the linkgit:gitmodules[5]
2360 submodule.<name>.ignore::
2361 Defines under what circumstances "git status" and the diff family show
2362 a submodule as modified. When set to "all", it will never be considered
2363 modified (but it will nonetheless show up in the output of status and
2364 commit when it has been staged), "dirty" will ignore all changes
2365 to the submodules work tree and
2366 takes only differences between the HEAD of the submodule and the commit
2367 recorded in the superproject into account. "untracked" will additionally
2368 let submodules with modified tracked files in their work tree show up.
2369 Using "none" (the default when this option is not set) also shows
2370 submodules that have untracked files in their work tree as changed.
2371 This setting overrides any setting made in .gitmodules for this submodule,
2372 both settings can be overridden on the command line by using the
2373 "--ignore-submodules" option. The 'git submodule' commands are not
2374 affected by this setting.
2377 This variable controls the sort ordering of tags when displayed by
2378 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2379 value of this variable will be used as the default.
2382 This variable can be used to restrict the permission bits of
2383 tar archive entries. The default is 0002, which turns off the
2384 world write bit. The special value "user" indicates that the
2385 archiving user's umask will be used instead. See umask(2) and
2386 linkgit:git-archive[1].
2388 transfer.fsckObjects::
2389 When `fetch.fsckObjects` or `receive.fsckObjects` are
2390 not set, the value of this variable is used instead.
2394 This variable can be used to set both `receive.hiderefs`
2395 and `uploadpack.hiderefs` at the same time to the same
2396 values. See entries for these other variables.
2398 transfer.unpackLimit::
2399 When `fetch.unpackLimit` or `receive.unpackLimit` are
2400 not set, the value of this variable is used instead.
2401 The default value is 100.
2403 uploadarchive.allowUnreachable::
2404 If true, allow clients to use `git archive --remote` to request
2405 any tree, whether reachable from the ref tips or not. See the
2406 discussion in the `SECURITY` section of
2407 linkgit:git-upload-archive[1] for more details. Defaults to
2410 uploadpack.hiderefs::
2411 String(s) `upload-pack` uses to decide which refs to omit
2412 from its initial advertisement. Use more than one
2413 definitions to specify multiple prefix strings. A ref that
2414 are under the hierarchies listed on the value of this
2415 variable is excluded, and is hidden from `git ls-remote`,
2416 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2417 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2419 uploadpack.allowtipsha1inwant::
2420 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2421 to accept a fetch request that asks for an object at the tip
2422 of a hidden ref (by default, such a request is rejected).
2423 see also `uploadpack.hiderefs`.
2425 uploadpack.keepalive::
2426 When `upload-pack` has started `pack-objects`, there may be a
2427 quiet period while `pack-objects` prepares the pack. Normally
2428 it would output progress information, but if `--quiet` was used
2429 for the fetch, `pack-objects` will output nothing at all until
2430 the pack data begins. Some clients and networks may consider
2431 the server to be hung and give up. Setting this option instructs
2432 `upload-pack` to send an empty keepalive packet every
2433 `uploadpack.keepalive` seconds. Setting this option to 0
2434 disables keepalive packets entirely. The default is 5 seconds.
2436 url.<base>.insteadOf::
2437 Any URL that starts with this value will be rewritten to
2438 start, instead, with <base>. In cases where some site serves a
2439 large number of repositories, and serves them with multiple
2440 access methods, and some users need to use different access
2441 methods, this feature allows people to specify any of the
2442 equivalent URLs and have Git automatically rewrite the URL to
2443 the best alternative for the particular user, even for a
2444 never-before-seen repository on the site. When more than one
2445 insteadOf strings match a given URL, the longest match is used.
2447 url.<base>.pushInsteadOf::
2448 Any URL that starts with this value will not be pushed to;
2449 instead, it will be rewritten to start with <base>, and the
2450 resulting URL will be pushed to. In cases where some site serves
2451 a large number of repositories, and serves them with multiple
2452 access methods, some of which do not allow push, this feature
2453 allows people to specify a pull-only URL and have Git
2454 automatically use an appropriate URL to push, even for a
2455 never-before-seen repository on the site. When more than one
2456 pushInsteadOf strings match a given URL, the longest match is
2457 used. If a remote has an explicit pushurl, Git will ignore this
2458 setting for that remote.
2461 Your email address to be recorded in any newly created commits.
2462 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2463 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2466 Your full name to be recorded in any newly created commits.
2467 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2468 environment variables. See linkgit:git-commit-tree[1].
2471 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2472 key you want it to automatically when creating a signed tag or
2473 commit, you can override the default selection with this variable.
2474 This option is passed unchanged to gpg's --local-user parameter,
2475 so you may specify a key using any method that gpg supports.
2478 Specify a web browser that may be used by some commands.
2479 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]