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 (Windows-only) If true (which is the default), mark newly-created
217 directories and files whose name starts with a dot as hidden.
218 If 'dotGitOnly', only the .git/ directory is hidden, but no other
219 files starting with a dot.
222 If true, this option enables various workarounds to enable
223 Git to work better on filesystems that are not case sensitive,
224 like FAT. For example, if a directory listing finds
225 "makefile" when Git expects "Makefile", Git will assume
226 it is really the same file, and continue to remember it as
229 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
230 will probe and set core.ignorecase true if appropriate when the repository
233 core.precomposeunicode::
234 This option is only used by Mac OS implementation of Git.
235 When core.precomposeunicode=true, Git reverts the unicode decomposition
236 of filenames done by Mac OS. This is useful when sharing a repository
237 between Mac OS and Linux or Windows.
238 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
239 When false, file names are handled fully transparent by Git,
240 which is backward compatible with older versions of Git.
243 If false, the ctime differences between the index and the
244 working tree are ignored; useful when the inode change time
245 is regularly modified by something outside Git (file system
246 crawlers and some backup systems).
247 See linkgit:git-update-index[1]. True by default.
250 Determines which stat fields to match between the index
251 and work tree. The user can set this to 'default' or
252 'minimal'. Default (or explicitly 'default'), is to check
253 all fields, including the sub-second part of mtime and ctime.
256 The commands that output paths (e.g. 'ls-files',
257 'diff'), when not given the `-z` option, will quote
258 "unusual" characters in the pathname by enclosing the
259 pathname in a double-quote pair and with backslashes the
260 same way strings in C source code are quoted. If this
261 variable is set to false, the bytes higher than 0x80 are
262 not quoted but output as verbatim. Note that double
263 quote, backslash and control characters are always
264 quoted without `-z` regardless of the setting of this
268 Sets the line ending type to use in the working directory for
269 files that have the `text` property set. Alternatives are
270 'lf', 'crlf' and 'native', which uses the platform's native
271 line ending. The default value is `native`. See
272 linkgit:gitattributes[5] for more information on end-of-line
276 If true, makes Git check if converting `CRLF` is reversible when
277 end-of-line conversion is active. Git will verify if a command
278 modifies a file in the work tree either directly or indirectly.
279 For example, committing a file followed by checking out the
280 same file should yield the original file in the work tree. If
281 this is not the case for the current setting of
282 `core.autocrlf`, Git will reject the file. The variable can
283 be set to "warn", in which case Git will only warn about an
284 irreversible conversion but continue the operation.
286 CRLF conversion bears a slight chance of corrupting data.
287 When it is enabled, Git will convert CRLF to LF during commit and LF to
288 CRLF during checkout. A file that contains a mixture of LF and
289 CRLF before the commit cannot be recreated by Git. For text
290 files this is the right thing to do: it corrects line endings
291 such that we have only LF line endings in the repository.
292 But for binary files that are accidentally classified as text the
293 conversion can corrupt data.
295 If you recognize such corruption early you can easily fix it by
296 setting the conversion type explicitly in .gitattributes. Right
297 after committing you still have the original file in your work
298 tree and this file is not yet corrupted. You can explicitly tell
299 Git that this file is binary and Git will handle the file
302 Unfortunately, the desired effect of cleaning up text files with
303 mixed line endings and the undesired effect of corrupting binary
304 files cannot be distinguished. In both cases CRLFs are removed
305 in an irreversible way. For text files this is the right thing
306 to do because CRLFs are line endings, while for binary files
307 converting CRLFs corrupts data.
309 Note, this safety check does not mean that a checkout will generate a
310 file identical to the original file for a different setting of
311 `core.eol` and `core.autocrlf`, but only for the current one. For
312 example, a text file with `LF` would be accepted with `core.eol=lf`
313 and could later be checked out with `core.eol=crlf`, in which case the
314 resulting file would contain `CRLF`, although the original file
315 contained `LF`. However, in both work trees the line endings would be
316 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
317 file with mixed line endings would be reported by the `core.safecrlf`
321 Setting this variable to "true" is almost the same as setting
322 the `text` attribute to "auto" on all files except that text
323 files are not guaranteed to be normalized: files that contain
324 `CRLF` in the repository will not be touched. Use this
325 setting if you want to have `CRLF` line endings in your
326 working directory even though the repository does not have
327 normalized line endings. This variable can be set to 'input',
328 in which case no output conversion is performed.
331 If false, symbolic links are checked out as small plain files that
332 contain the link text. linkgit:git-update-index[1] and
333 linkgit:git-add[1] will not change the recorded type to regular
334 file. Useful on filesystems like FAT that do not support
337 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
338 will probe and set core.symlinks false if appropriate when the repository
342 A "proxy command" to execute (as 'command host port') instead
343 of establishing direct connection to the remote server when
344 using the Git protocol for fetching. If the variable value is
345 in the "COMMAND for DOMAIN" format, the command is applied only
346 on hostnames ending with the specified domain string. This variable
347 may be set multiple times and is matched in the given order;
348 the first match wins.
350 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
351 (which always applies universally, without the special "for"
354 The special string `none` can be used as the proxy command to
355 specify that no proxy be used for a given domain pattern.
356 This is useful for excluding servers inside a firewall from
357 proxy use, while defaulting to a common proxy for external domains.
360 If true, commands which modify both the working tree and the index
361 will mark the updated paths with the "assume unchanged" bit in the
362 index. These marked files are then assumed to stay unchanged in the
363 working tree, until you mark them otherwise manually - Git will not
364 detect the file changes by lstat() calls. This is useful on systems
365 where those are very slow, such as Microsoft Windows.
366 See linkgit:git-update-index[1].
369 core.preferSymlinkRefs::
370 Instead of the default "symref" format for HEAD
371 and other symbolic reference files, use symbolic links.
372 This is sometimes needed to work with old scripts that
373 expect HEAD to be a symbolic link.
376 If true this repository is assumed to be 'bare' and has no
377 working directory associated with it. If this is the case a
378 number of commands that require a working directory will be
379 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
381 This setting is automatically guessed by linkgit:git-clone[1] or
382 linkgit:git-init[1] when the repository was created. By default a
383 repository that ends in "/.git" is assumed to be not bare (bare =
384 false), while all other repositories are assumed to be bare (bare
388 Set the path to the root of the working tree.
389 This can be overridden by the GIT_WORK_TREE environment
390 variable and the '--work-tree' command line option.
391 The value can be an absolute path or relative to the path to
392 the .git directory, which is either specified by --git-dir
393 or GIT_DIR, or automatically discovered.
394 If --git-dir or GIT_DIR is specified but none of
395 --work-tree, GIT_WORK_TREE and core.worktree is specified,
396 the current working directory is regarded as the top level
397 of your working tree.
399 Note that this variable is honored even when set in a configuration
400 file in a ".git" subdirectory of a directory and its value differs
401 from the latter directory (e.g. "/path/to/.git/config" has
402 core.worktree set to "/different/path"), which is most likely a
403 misconfiguration. Running Git commands in the "/path/to" directory will
404 still use "/different/path" as the root of the work tree and can cause
405 confusion unless you know what you are doing (e.g. you are creating a
406 read-only snapshot of the same index to a location different from the
407 repository's usual working tree).
409 core.logAllRefUpdates::
410 Enable the reflog. Updates to a ref <ref> is logged to the file
411 "$GIT_DIR/logs/<ref>", by appending the new and old
412 SHA-1, the date/time and the reason of the update, but
413 only when the file exists. If this configuration
414 variable is set to true, missing "$GIT_DIR/logs/<ref>"
415 file is automatically created for branch heads (i.e. under
416 refs/heads/), remote refs (i.e. under refs/remotes/),
417 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
419 This information can be used to determine what commit
420 was the tip of a branch "2 days ago".
422 This value is true by default in a repository that has
423 a working directory associated with it, and false by
424 default in a bare repository.
426 core.repositoryFormatVersion::
427 Internal variable identifying the repository format and layout
430 core.sharedRepository::
431 When 'group' (or 'true'), the repository is made shareable between
432 several users in a group (making sure all the files and objects are
433 group-writable). When 'all' (or 'world' or 'everybody'), the
434 repository will be readable by all users, additionally to being
435 group-shareable. When 'umask' (or 'false'), Git will use permissions
436 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
437 files in the repository will have this mode value. '0xxx' will override
438 user's umask value (whereas the other options will only override
439 requested parts of the user's umask value). Examples: '0660' will make
440 the repo read/write-able for the owner and group, but inaccessible to
441 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
442 repository that is group-readable but not group-writable.
443 See linkgit:git-init[1]. False by default.
445 core.warnAmbiguousRefs::
446 If true, Git will warn you if the ref name you passed it is ambiguous
447 and might match multiple refs in the repository. True by default.
450 An integer -1..9, indicating a default compression level.
451 -1 is the zlib default. 0 means no compression,
452 and 1..9 are various speed/size tradeoffs, 9 being slowest.
453 If set, this provides a default to other compression variables,
454 such as 'core.loosecompression' and 'pack.compression'.
456 core.loosecompression::
457 An integer -1..9, indicating the compression level for objects that
458 are not in a pack file. -1 is the zlib default. 0 means no
459 compression, and 1..9 are various speed/size tradeoffs, 9 being
460 slowest. If not set, defaults to core.compression. If that is
461 not set, defaults to 1 (best speed).
463 core.packedGitWindowSize::
464 Number of bytes of a pack file to map into memory in a
465 single mapping operation. Larger window sizes may allow
466 your system to process a smaller number of large pack files
467 more quickly. Smaller window sizes will negatively affect
468 performance due to increased calls to the operating system's
469 memory manager, but may improve performance when accessing
470 a large number of large pack files.
472 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
473 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
474 be reasonable for all users/operating systems. You probably do
475 not need to adjust this value.
477 Common unit suffixes of 'k', 'm', or 'g' are supported.
479 core.packedGitLimit::
480 Maximum number of bytes to map simultaneously into memory
481 from pack files. If Git needs to access more than this many
482 bytes at once to complete an operation it will unmap existing
483 regions to reclaim virtual address space within the process.
485 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
486 This should be reasonable for all users/operating systems, except on
487 the largest projects. You probably do not need to adjust this value.
489 Common unit suffixes of 'k', 'm', or 'g' are supported.
491 core.deltaBaseCacheLimit::
492 Maximum number of bytes to reserve for caching base objects
493 that may be referenced by multiple deltified objects. By storing the
494 entire decompressed base objects in a cache Git is able
495 to avoid unpacking and decompressing frequently used base
496 objects multiple times.
498 Default is 16 MiB on all platforms. This should be reasonable
499 for all users/operating systems, except on the largest projects.
500 You probably do not need to adjust this value.
502 Common unit suffixes of 'k', 'm', or 'g' are supported.
504 core.bigFileThreshold::
505 Files larger than this size are stored deflated, without
506 attempting delta compression. Storing large files without
507 delta compression avoids excessive memory usage, at the
508 slight expense of increased disk usage.
510 Default is 512 MiB on all platforms. This should be reasonable
511 for most projects as source code and other text files can still
512 be delta compressed, but larger binary media files won't be.
514 Common unit suffixes of 'k', 'm', or 'g' are supported.
517 In addition to '.gitignore' (per-directory) and
518 '.git/info/exclude', Git looks into this file for patterns
519 of files which are not meant to be tracked. "`~/`" is expanded
520 to the value of `$HOME` and "`~user/`" to the specified user's
521 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
522 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
523 is used instead. See linkgit:gitignore[5].
526 Some commands (e.g. svn and http interfaces) that interactively
527 ask for a password can be told to use an external program given
528 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
529 environment variable. If not set, fall back to the value of the
530 'SSH_ASKPASS' environment variable or, failing that, a simple password
531 prompt. The external program shall be given a suitable prompt as
532 command line argument and write the password on its STDOUT.
534 core.attributesfile::
535 In addition to '.gitattributes' (per-directory) and
536 '.git/info/attributes', Git looks into this file for attributes
537 (see linkgit:gitattributes[5]). Path expansions are made the same
538 way as for `core.excludesfile`. Its default value is
539 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
540 set or empty, $HOME/.config/git/attributes is used instead.
543 Commands such as `commit` and `tag` that lets you edit
544 messages by launching an editor uses the value of this
545 variable when it is set, and the environment variable
546 `GIT_EDITOR` is not set. See linkgit:git-var[1].
549 Commands such as `commit` and `tag` that lets you edit
550 messages consider a line that begins with this character
551 commented, and removes them after the editor returns
555 Text editor used by `git rebase -i` for editing the rebase instruction file.
556 The value is meant to be interpreted by the shell when it is used.
557 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
558 When not configured the default commit message editor is used instead.
561 Text viewer for use by Git commands (e.g., 'less'). The value
562 is meant to be interpreted by the shell. The order of preference
563 is the `$GIT_PAGER` environment variable, then `core.pager`
564 configuration, then `$PAGER`, and then the default chosen at
565 compile time (usually 'less').
567 When the `LESS` environment variable is unset, Git sets it to `FRSX`
568 (if `LESS` environment variable is set, Git does not change it at
569 all). If you want to selectively override Git's default setting
570 for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
571 be passed to the shell by Git, which will translate the final
572 command to `LESS=FRSX less -+S`. The environment tells the command
573 to set the `S` option to chop long lines but the command line
574 resets it to the default to fold long lines.
576 Likewise, when the `LV` environment variable is unset, Git sets it
577 to `-c`. You can override this setting by exporting `LV` with
578 another value or setting `core.pager` to `lv +c`.
581 A comma separated list of common whitespace problems to
582 notice. 'git diff' will use `color.diff.whitespace` to
583 highlight them, and 'git apply --whitespace=error' will
584 consider them as errors. You can prefix `-` to disable
585 any of them (e.g. `-trailing-space`):
587 * `blank-at-eol` treats trailing whitespaces at the end of the line
588 as an error (enabled by default).
589 * `space-before-tab` treats a space character that appears immediately
590 before a tab character in the initial indent part of the line as an
591 error (enabled by default).
592 * `indent-with-non-tab` treats a line that is indented with space
593 characters instead of the equivalent tabs as an error (not enabled by
595 * `tab-in-indent` treats a tab character in the initial indent part of
596 the line as an error (not enabled by default).
597 * `blank-at-eof` treats blank lines added at the end of file as an error
598 (enabled by default).
599 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
601 * `cr-at-eol` treats a carriage-return at the end of line as
602 part of the line terminator, i.e. with it, `trailing-space`
603 does not trigger if the character before such a carriage-return
604 is not a whitespace (not enabled by default).
605 * `tabwidth=<n>` tells how many character positions a tab occupies; this
606 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
607 errors. The default tab width is 8. Allowed values are 1 to 63.
609 core.fsyncobjectfiles::
610 This boolean will enable 'fsync()' when writing object files.
612 This is a total waste of time and effort on a filesystem that orders
613 data writes properly, but can be useful for filesystems that do not use
614 journalling (traditional UNIX filesystems) or that only journal metadata
615 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
618 Enable parallel index preload for operations like 'git diff'
620 This can speed up operations like 'git diff' and 'git status' especially
621 on filesystems like NFS that have weak caching semantics and thus
622 relatively high IO latencies. With this set to 'true', Git will do the
623 index comparison to the filesystem data in parallel, allowing
627 Enable additional caching of file system data for some operations.
629 Git for Windows uses this to bulk-read and cache lstat data of entire
630 directories (instead of doing lstat file by file).
633 You can set this to 'link', in which case a hardlink followed by
634 a delete of the source are used to make sure that object creation
635 will not overwrite existing objects.
637 On some file system/operating system combinations, this is unreliable.
638 Set this config setting to 'rename' there; However, This will remove the
639 check that makes sure that existing object files will not get overwritten.
642 When showing commit messages, also show notes which are stored in
643 the given ref. The ref must be fully qualified. If the given
644 ref does not exist, it is not an error but means that no
645 notes should be printed.
647 This setting defaults to "refs/notes/commits", and it can be overridden by
648 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
650 core.sparseCheckout::
651 Enable "sparse checkout" feature. See section "Sparse checkout" in
652 linkgit:git-read-tree[1] for more information.
655 Set the length object names are abbreviated to. If unspecified,
656 many commands abbreviate to 7 hexdigits, which may not be enough
657 for abbreviated object names to stay unique for sufficiently long
662 Tells 'git add' to continue adding files when some files cannot be
663 added due to indexing errors. Equivalent to the '--ignore-errors'
664 option of linkgit:git-add[1]. Older versions of Git accept only
665 `add.ignore-errors`, which does not follow the usual naming
666 convention for configuration variables. Newer versions of Git
667 honor `add.ignoreErrors` as well.
670 Command aliases for the linkgit:git[1] command wrapper - e.g.
671 after defining "alias.last = cat-file commit HEAD", the invocation
672 "git last" is equivalent to "git cat-file commit HEAD". To avoid
673 confusion and troubles with script usage, aliases that
674 hide existing Git commands are ignored. Arguments are split by
675 spaces, the usual shell quoting and escaping is supported.
676 quote pair and a backslash can be used to quote them.
678 If the alias expansion is prefixed with an exclamation point,
679 it will be treated as a shell command. For example, defining
680 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
681 "git new" is equivalent to running the shell command
682 "gitk --all --not ORIG_HEAD". Note that shell commands will be
683 executed from the top-level directory of a repository, which may
684 not necessarily be the current directory.
685 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
686 from the original current directory. See linkgit:git-rev-parse[1].
689 If true, git-am will call git-mailsplit for patches in mbox format
690 with parameter '--keep-cr'. In this case git-mailsplit will
691 not remove `\r` from lines ending with `\r\n`. Can be overridden
692 by giving '--no-keep-cr' from the command line.
693 See linkgit:git-am[1], linkgit:git-mailsplit[1].
695 apply.ignorewhitespace::
696 When set to 'change', tells 'git apply' to ignore changes in
697 whitespace, in the same way as the '--ignore-space-change'
699 When set to one of: no, none, never, false tells 'git apply' to
700 respect all whitespace differences.
701 See linkgit:git-apply[1].
704 Tells 'git apply' how to handle whitespaces, in the same way
705 as the '--whitespace' option. See linkgit:git-apply[1].
707 branch.autosetupmerge::
708 Tells 'git branch' and 'git checkout' to set up new branches
709 so that linkgit:git-pull[1] will appropriately merge from the
710 starting point branch. Note that even if this option is not set,
711 this behavior can be chosen per-branch using the `--track`
712 and `--no-track` options. The valid settings are: `false` -- no
713 automatic setup is done; `true` -- automatic setup is done when the
714 starting point is a remote-tracking branch; `always` --
715 automatic setup is done when the starting point is either a
716 local branch or remote-tracking
717 branch. This option defaults to true.
719 branch.autosetuprebase::
720 When a new branch is created with 'git branch' or 'git checkout'
721 that tracks another branch, this variable tells Git to set
722 up pull to rebase instead of merge (see "branch.<name>.rebase").
723 When `never`, rebase is never automatically set to true.
724 When `local`, rebase is set to true for tracked branches of
725 other local branches.
726 When `remote`, rebase is set to true for tracked branches of
727 remote-tracking branches.
728 When `always`, rebase will be set to true for all tracking
730 See "branch.autosetupmerge" for details on how to set up a
731 branch to track another branch.
732 This option defaults to never.
734 branch.<name>.remote::
735 When on branch <name>, it tells 'git fetch' and 'git push'
736 which remote to fetch from/push to. The remote to push to
737 may be overridden with `remote.pushdefault` (for all branches).
738 The remote to push to, for the current branch, may be further
739 overridden by `branch.<name>.pushremote`. If no remote is
740 configured, or if you are not on any branch, it defaults to
741 `origin` for fetching and `remote.pushdefault` for pushing.
742 Additionally, `.` (a period) is the current local repository
743 (a dot-repository), see `branch.<name>.merge`'s final note below.
745 branch.<name>.pushremote::
746 When on branch <name>, it overrides `branch.<name>.remote` for
747 pushing. It also overrides `remote.pushdefault` for pushing
748 from branch <name>. When you pull from one place (e.g. your
749 upstream) and push to another place (e.g. your own publishing
750 repository), you would want to set `remote.pushdefault` to
751 specify the remote to push to for all branches, and use this
752 option to override it for a specific branch.
754 branch.<name>.merge::
755 Defines, together with branch.<name>.remote, the upstream branch
756 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
757 branch to merge and can also affect 'git push' (see push.default).
758 When in branch <name>, it tells 'git fetch' the default
759 refspec to be marked for merging in FETCH_HEAD. The value is
760 handled like the remote part of a refspec, and must match a
761 ref which is fetched from the remote given by
762 "branch.<name>.remote".
763 The merge information is used by 'git pull' (which at first calls
764 'git fetch') to lookup the default branch for merging. Without
765 this option, 'git pull' defaults to merge the first refspec fetched.
766 Specify multiple values to get an octopus merge.
767 If you wish to setup 'git pull' so that it merges into <name> from
768 another branch in the local repository, you can point
769 branch.<name>.merge to the desired branch, and use the relative path
770 setting `.` (a period) for branch.<name>.remote.
772 branch.<name>.mergeoptions::
773 Sets default options for merging into branch <name>. The syntax and
774 supported options are the same as those of linkgit:git-merge[1], but
775 option values containing whitespace characters are currently not
778 branch.<name>.rebase::
779 When true, rebase the branch <name> on top of the fetched branch,
780 instead of merging the default branch from the default remote when
781 "git pull" is run. See "pull.rebase" for doing this in a non
782 branch-specific manner.
784 When preserve, also pass `--preserve-merges` along to 'git rebase'
785 so that locally committed merge commits will not be flattened
786 by running 'git pull'.
788 *NOTE*: this is a possibly dangerous operation; do *not* use
789 it unless you understand the implications (see linkgit:git-rebase[1]
792 branch.<name>.description::
793 Branch description, can be edited with
794 `git branch --edit-description`. Branch description is
795 automatically added in the format-patch cover letter or
796 request-pull summary.
799 Specify the command to invoke the specified browser. The
800 specified command is evaluated in shell with the URLs passed
801 as arguments. (See linkgit:git-web{litdd}browse[1].)
803 browser.<tool>.path::
804 Override the path for the given tool that may be used to
805 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
806 working repository in gitweb (see linkgit:git-instaweb[1]).
809 A boolean to make git-clean do nothing unless given -f,
810 -i or -n. Defaults to true.
813 A boolean to enable/disable color in the output of
814 linkgit:git-branch[1]. May be set to `always`,
815 `false` (or `never`) or `auto` (or `true`), in which case colors are used
816 only when the output is to a terminal. Defaults to false.
818 color.branch.<slot>::
819 Use customized color for branch coloration. `<slot>` is one of
820 `current` (the current branch), `local` (a local branch),
821 `remote` (a remote-tracking branch in refs/remotes/),
822 `upstream` (upstream tracking branch), `plain` (other
825 The value for these configuration variables is a list of colors (at most
826 two) and attributes (at most one), separated by spaces. The colors
827 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
828 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
829 `blink` and `reverse`. The first color given is the foreground; the
830 second is the background. The position of the attribute, if any,
834 Whether to use ANSI escape sequences to add color to patches.
835 If this is set to `always`, linkgit:git-diff[1],
836 linkgit:git-log[1], and linkgit:git-show[1] will use color
837 for all patches. If it is set to `true` or `auto`, those
838 commands will only use color when output is to the terminal.
841 This does not affect linkgit:git-format-patch[1] or the
842 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
843 command line with the `--color[=<when>]` option.
846 Use customized color for diff colorization. `<slot>` specifies
847 which part of the patch to use the specified color, and is one
848 of `plain` (context text), `meta` (metainformation), `frag`
849 (hunk header), 'func' (function in hunk header), `old` (removed lines),
850 `new` (added lines), `commit` (commit headers), or `whitespace`
851 (highlighting whitespace errors). The values of these variables may be
852 specified as in color.branch.<slot>.
854 color.decorate.<slot>::
855 Use customized color for 'git log --decorate' output. `<slot>` is one
856 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
857 branches, remote-tracking branches, tags, stash and HEAD, respectively.
860 When set to `always`, always highlight matches. When `false` (or
861 `never`), never. When set to `true` or `auto`, use color only
862 when the output is written to the terminal. Defaults to `false`.
865 Use customized color for grep colorization. `<slot>` specifies which
866 part of the line to use the specified color, and is one of
870 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
872 filename prefix (when not using `-h`)
874 function name lines (when using `-p`)
876 line number prefix (when using `-n`)
880 non-matching text in selected lines
882 separators between fields on a line (`:`, `-`, and `=`)
883 and between hunks (`--`)
886 The values of these variables may be specified as in color.branch.<slot>.
889 When set to `always`, always use colors for interactive prompts
890 and displays (such as those used by "git-add --interactive" and
891 "git-clean --interactive"). When false (or `never`), never.
892 When set to `true` or `auto`, use colors only when the output is
893 to the terminal. Defaults to false.
895 color.interactive.<slot>::
896 Use customized color for 'git add --interactive' and 'git clean
897 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
898 or `error`, for four distinct types of normal output from
899 interactive commands. The values of these variables may be
900 specified as in color.branch.<slot>.
903 A boolean to enable/disable colored output when the pager is in
904 use (default is true).
907 A boolean to enable/disable color in the output of
908 linkgit:git-show-branch[1]. May be set to `always`,
909 `false` (or `never`) or `auto` (or `true`), in which case colors are used
910 only when the output is to a terminal. Defaults to false.
913 A boolean to enable/disable color in the output of
914 linkgit:git-status[1]. May be set to `always`,
915 `false` (or `never`) or `auto` (or `true`), in which case colors are used
916 only when the output is to a terminal. Defaults to false.
918 color.status.<slot>::
919 Use customized color for status colorization. `<slot>` is
920 one of `header` (the header text of the status message),
921 `added` or `updated` (files which are added but not committed),
922 `changed` (files which are changed but not added in the index),
923 `untracked` (files which are not tracked by Git),
924 `branch` (the current branch), or
925 `nobranch` (the color the 'no branch' warning is shown in, defaulting
926 to red). The values of these variables may be specified as in
930 This variable determines the default value for variables such
931 as `color.diff` and `color.grep` that control the use of color
932 per command family. Its scope will expand as more commands learn
933 configuration to set a default for the `--color` option. Set it
934 to `false` or `never` if you prefer Git commands not to use
935 color unless enabled explicitly with some other configuration
936 or the `--color` option. Set it to `always` if you want all
937 output not intended for machine consumption to use color, to
938 `true` or `auto` (this is the default since Git 1.8.4) if you
939 want such output to use color when written to the terminal.
942 Specify whether supported commands should output in columns.
943 This variable consists of a list of tokens separated by spaces
946 These options control when the feature should be enabled
947 (defaults to 'never'):
951 always show in columns
953 never show in columns
955 show in columns if the output is to the terminal
958 These options control layout (defaults to 'column'). Setting any
959 of these implies 'always' if none of 'always', 'never', or 'auto' are
964 fill columns before rows
966 fill rows before columns
971 Finally, these options can be combined with a layout option (defaults
976 make unequal size columns to utilize more space
978 make equal size columns
982 Specify whether to output branch listing in `git branch` in columns.
983 See `column.ui` for details.
986 Specify the layout when list items in `git clean -i`, which always
987 shows files and directories in columns. See `column.ui` for details.
990 Specify whether to output untracked files in `git status` in columns.
991 See `column.ui` for details.
994 Specify whether to output tag listing in `git tag` in columns.
995 See `column.ui` for details.
998 This setting overrides the default of the `--cleanup` option in
999 `git commit`. See linkgit:git-commit[1] for details. Changing the
1000 default can be useful when you always want to keep lines that begin
1001 with comment character `#` in your log message, in which case you
1002 would do `git config commit.cleanup whitespace` (note that you will
1003 have to remove the help lines that begin with `#` in the commit log
1004 template yourself, if you do this).
1008 A boolean to specify whether all commits should be GPG signed.
1009 Use of this option when doing operations such as rebase can
1010 result in a large number of commits being signed. It may be
1011 convenient to use an agent to avoid typing your GPG passphrase
1015 A boolean to enable/disable inclusion of status information in the
1016 commit message template when using an editor to prepare the commit
1017 message. Defaults to true.
1020 Specify a file to use as the template for new commit messages.
1021 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1022 specified user's home directory.
1025 Specify an external helper to be called when a username or
1026 password credential is needed; the helper may consult external
1027 storage to avoid prompting the user for the credentials. See
1028 linkgit:gitcredentials[7] for details.
1030 credential.useHttpPath::
1031 When acquiring credentials, consider the "path" component of an http
1032 or https URL to be important. Defaults to false. See
1033 linkgit:gitcredentials[7] for more information.
1035 credential.username::
1036 If no username is set for a network authentication, use this username
1037 by default. See credential.<context>.* below, and
1038 linkgit:gitcredentials[7].
1040 credential.<url>.*::
1041 Any of the credential.* options above can be applied selectively to
1042 some credentials. For example "credential.https://example.com.username"
1043 would set the default username only for https connections to
1044 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1047 include::diff-config.txt[]
1049 difftool.<tool>.path::
1050 Override the path for the given tool. This is useful in case
1051 your tool is not in the PATH.
1053 difftool.<tool>.cmd::
1054 Specify the command to invoke the specified diff tool.
1055 The specified command is evaluated in shell with the following
1056 variables available: 'LOCAL' is set to the name of the temporary
1057 file containing the contents of the diff pre-image and 'REMOTE'
1058 is set to the name of the temporary file containing the contents
1059 of the diff post-image.
1062 Prompt before each invocation of the diff tool.
1064 fetch.recurseSubmodules::
1065 This option can be either set to a boolean value or to 'on-demand'.
1066 Setting it to a boolean changes the behavior of fetch and pull to
1067 unconditionally recurse into submodules when set to true or to not
1068 recurse at all when set to false. When set to 'on-demand' (the default
1069 value), fetch and pull will only recurse into a populated submodule
1070 when its superproject retrieves a commit that updates the submodule's
1074 If it is set to true, git-fetch-pack will check all fetched
1075 objects. It will abort in the case of a malformed object or a
1076 broken link. The result of an abort are only dangling objects.
1077 Defaults to false. If not set, the value of `transfer.fsckObjects`
1081 If the number of objects fetched over the Git native
1082 transfer is below this
1083 limit, then the objects will be unpacked into loose object
1084 files. However if the number of received objects equals or
1085 exceeds this limit then the received pack will be stored as
1086 a pack, after adding any missing delta bases. Storing the
1087 pack from a push can make the push operation complete faster,
1088 especially on slow filesystems. If not set, the value of
1089 `transfer.unpackLimit` is used instead.
1092 If true, fetch will automatically behave as if the `--prune`
1093 option was given on the command line. See also `remote.<name>.prune`.
1096 Enable multipart/mixed attachments as the default for
1097 'format-patch'. The value can also be a double quoted string
1098 which will enable attachments as the default and set the
1099 value as the boundary. See the --attach option in
1100 linkgit:git-format-patch[1].
1103 A boolean which can enable or disable sequence numbers in patch
1104 subjects. It defaults to "auto" which enables it only if there
1105 is more than one patch. It can be enabled or disabled for all
1106 messages by setting it to "true" or "false". See --numbered
1107 option in linkgit:git-format-patch[1].
1110 Additional email headers to include in a patch to be submitted
1111 by mail. See linkgit:git-format-patch[1].
1115 Additional recipients to include in a patch to be submitted
1116 by mail. See the --to and --cc options in
1117 linkgit:git-format-patch[1].
1119 format.subjectprefix::
1120 The default for format-patch is to output files with the '[PATCH]'
1121 subject prefix. Use this variable to change that prefix.
1124 The default for format-patch is to output a signature containing
1125 the Git version number. Use this variable to change that default.
1126 Set this variable to the empty string ("") to suppress
1127 signature generation.
1130 The default for format-patch is to output files with the suffix
1131 `.patch`. Use this variable to change that suffix (make sure to
1132 include the dot if you want it).
1135 The default pretty format for log/show/whatchanged command,
1136 See linkgit:git-log[1], linkgit:git-show[1],
1137 linkgit:git-whatchanged[1].
1140 The default threading style for 'git format-patch'. Can be
1141 a boolean value, or `shallow` or `deep`. `shallow` threading
1142 makes every mail a reply to the head of the series,
1143 where the head is chosen from the cover letter, the
1144 `--in-reply-to`, and the first patch mail, in this order.
1145 `deep` threading makes every mail a reply to the previous one.
1146 A true boolean value is the same as `shallow`, and a false
1147 value disables threading.
1150 A boolean value which lets you enable the `-s/--signoff` option of
1151 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1152 patch should be a conscious act and means that you certify you have
1153 the rights to submit this work under the same open source license.
1154 Please see the 'SubmittingPatches' document for further discussion.
1156 format.coverLetter::
1157 A boolean that controls whether to generate a cover-letter when
1158 format-patch is invoked, but in addition can be set to "auto", to
1159 generate a cover-letter only when there's more than one patch.
1161 filter.<driver>.clean::
1162 The command which is used to convert the content of a worktree
1163 file to a blob upon checkin. See linkgit:gitattributes[5] for
1166 filter.<driver>.smudge::
1167 The command which is used to convert the content of a blob
1168 object to a worktree file upon checkout. See
1169 linkgit:gitattributes[5] for details.
1171 gc.aggressiveDepth::
1172 The depth parameter used in the delta compression
1173 algorithm used by 'git gc --aggressive'. This defaults
1176 gc.aggressiveWindow::
1177 The window size parameter used in the delta compression
1178 algorithm used by 'git gc --aggressive'. This defaults
1182 When there are approximately more than this many loose
1183 objects in the repository, `git gc --auto` will pack them.
1184 Some Porcelain commands use this command to perform a
1185 light-weight garbage collection from time to time. The
1186 default value is 6700. Setting this to 0 disables it.
1189 When there are more than this many packs that are not
1190 marked with `*.keep` file in the repository, `git gc
1191 --auto` consolidates them into one larger pack. The
1192 default value is 50. Setting this to 0 disables it.
1195 Make `git gc --auto` return immediately andrun in background
1196 if the system supports it. Default is true.
1199 Running `git pack-refs` in a repository renders it
1200 unclonable by Git versions prior to 1.5.1.2 over dumb
1201 transports such as HTTP. This variable determines whether
1202 'git gc' runs `git pack-refs`. This can be set to `notbare`
1203 to enable it within all non-bare repos or it can be set to a
1204 boolean value. The default is `true`.
1207 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1208 Override the grace period with this config variable. The value
1209 "now" may be used to disable this grace period and always prune
1210 unreachable objects immediately.
1213 gc.<pattern>.reflogexpire::
1214 'git reflog expire' removes reflog entries older than
1215 this time; defaults to 90 days. With "<pattern>" (e.g.
1216 "refs/stash") in the middle the setting applies only to
1217 the refs that match the <pattern>.
1219 gc.reflogexpireunreachable::
1220 gc.<ref>.reflogexpireunreachable::
1221 'git reflog expire' removes reflog entries older than
1222 this time and are not reachable from the current tip;
1223 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1224 in the middle, the setting applies only to the refs that
1225 match the <pattern>.
1228 Records of conflicted merge you resolved earlier are
1229 kept for this many days when 'git rerere gc' is run.
1230 The default is 60 days. See linkgit:git-rerere[1].
1232 gc.rerereunresolved::
1233 Records of conflicted merge you have not resolved are
1234 kept for this many days when 'git rerere gc' is run.
1235 The default is 15 days. See linkgit:git-rerere[1].
1237 gitcvs.commitmsgannotation::
1238 Append this string to each commit message. Set to empty string
1239 to disable this feature. Defaults to "via git-CVS emulator".
1242 Whether the CVS server interface is enabled for this repository.
1243 See linkgit:git-cvsserver[1].
1246 Path to a log file where the CVS server interface well... logs
1247 various stuff. See linkgit:git-cvsserver[1].
1249 gitcvs.usecrlfattr::
1250 If true, the server will look up the end-of-line conversion
1251 attributes for files to determine the '-k' modes to use. If
1252 the attributes force Git to treat a file as text,
1253 the '-k' mode will be left blank so CVS clients will
1254 treat it as text. If they suppress text conversion, the file
1255 will be set with '-kb' mode, which suppresses any newline munging
1256 the client might otherwise do. If the attributes do not allow
1257 the file type to be determined, then 'gitcvs.allbinary' is
1258 used. See linkgit:gitattributes[5].
1261 This is used if 'gitcvs.usecrlfattr' does not resolve
1262 the correct '-kb' mode to use. If true, all
1263 unresolved files are sent to the client in
1264 mode '-kb'. This causes the client to treat them
1265 as binary files, which suppresses any newline munging it
1266 otherwise might do. Alternatively, if it is set to "guess",
1267 then the contents of the file are examined to decide if
1268 it is binary, similar to 'core.autocrlf'.
1271 Database used by git-cvsserver to cache revision information
1272 derived from the Git repository. The exact meaning depends on the
1273 used database driver, for SQLite (which is the default driver) this
1274 is a filename. Supports variable substitution (see
1275 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1276 Default: '%Ggitcvs.%m.sqlite'
1279 Used Perl DBI driver. You can specify any available driver
1280 for this here, but it might not work. git-cvsserver is tested
1281 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1282 reported *not* to work with 'DBD::mysql'. Experimental feature.
1283 May not contain double colons (`:`). Default: 'SQLite'.
1284 See linkgit:git-cvsserver[1].
1286 gitcvs.dbuser, gitcvs.dbpass::
1287 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1288 since SQLite has no concept of database users and/or passwords.
1289 'gitcvs.dbuser' supports variable substitution (see
1290 linkgit:git-cvsserver[1] for details).
1292 gitcvs.dbTableNamePrefix::
1293 Database table name prefix. Prepended to the names of any
1294 database tables used, allowing a single database to be used
1295 for several repositories. Supports variable substitution (see
1296 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1297 characters will be replaced with underscores.
1299 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1300 'gitcvs.allbinary' can also be specified as
1301 'gitcvs.<access_method>.<varname>' (where 'access_method'
1302 is one of "ext" and "pserver") to make them apply only for the given
1306 gitweb.description::
1309 See linkgit:gitweb[1] for description.
1317 gitweb.remote_heads::
1320 See linkgit:gitweb.conf[5] for description.
1323 If set to true, enable '-n' option by default.
1326 Set the default matching behavior. Using a value of 'basic', 'extended',
1327 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1328 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1329 value 'default' will return to the default matching behavior.
1331 grep.extendedRegexp::
1332 If set to true, enable '--extended-regexp' option by default. This
1333 option is ignored when the 'grep.patternType' option is set to a value
1334 other than 'default'.
1337 Use this custom program instead of "gpg" found on $PATH when
1338 making or verifying a PGP signature. The program must support the
1339 same command line interface as GPG, namely, to verify a detached
1340 signature, "gpg --verify $file - <$signature" is run, and the
1341 program is expected to signal a good signature by exiting with
1342 code 0, and to generate an ascii-armored detached signature, the
1343 standard input of "gpg -bsau $key" is fed with the contents to be
1344 signed, and the program is expected to send the result to its
1347 gui.commitmsgwidth::
1348 Defines how wide the commit message window is in the
1349 linkgit:git-gui[1]. "75" is the default.
1352 Specifies how many context lines should be used in calls to diff
1353 made by the linkgit:git-gui[1]. The default is "5".
1355 gui.displayuntracked::
1356 Determines if linkgit::git-gui[1] shows untracked files
1357 in the file list. The default is "true".
1360 Specifies the default encoding to use for displaying of
1361 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1362 It can be overridden by setting the 'encoding' attribute
1363 for relevant files (see linkgit:gitattributes[5]).
1364 If this option is not set, the tools default to the
1367 gui.matchtrackingbranch::
1368 Determines if new branches created with linkgit:git-gui[1] should
1369 default to tracking remote branches with matching names or
1370 not. Default: "false".
1372 gui.newbranchtemplate::
1373 Is used as suggested name when creating new branches using the
1376 gui.pruneduringfetch::
1377 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1378 performing a fetch. The default value is "false".
1381 Determines if linkgit:git-gui[1] should trust the file modification
1382 timestamp or not. By default the timestamps are not trusted.
1384 gui.spellingdictionary::
1385 Specifies the dictionary used for spell checking commit messages in
1386 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1390 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1391 location detection. It makes blame significantly faster on huge
1392 repositories at the expense of less thorough copy detection.
1394 gui.copyblamethreshold::
1395 Specifies the threshold to use in 'git gui blame' original location
1396 detection, measured in alphanumeric characters. See the
1397 linkgit:git-blame[1] manual for more information on copy detection.
1399 gui.blamehistoryctx::
1400 Specifies the radius of history context in days to show in
1401 linkgit:gitk[1] for the selected commit, when the `Show History
1402 Context` menu item is invoked from 'git gui blame'. If this
1403 variable is set to zero, the whole history is shown.
1405 guitool.<name>.cmd::
1406 Specifies the shell command line to execute when the corresponding item
1407 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1408 mandatory for every tool. The command is executed from the root of
1409 the working directory, and in the environment it receives the name of
1410 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1411 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1412 the head is detached, 'CUR_BRANCH' is empty).
1414 guitool.<name>.needsfile::
1415 Run the tool only if a diff is selected in the GUI. It guarantees
1416 that 'FILENAME' is not empty.
1418 guitool.<name>.noconsole::
1419 Run the command silently, without creating a window to display its
1422 guitool.<name>.norescan::
1423 Don't rescan the working directory for changes after the tool
1426 guitool.<name>.confirm::
1427 Show a confirmation dialog before actually running the tool.
1429 guitool.<name>.argprompt::
1430 Request a string argument from the user, and pass it to the tool
1431 through the 'ARGS' environment variable. Since requesting an
1432 argument implies confirmation, the 'confirm' option has no effect
1433 if this is enabled. If the option is set to 'true', 'yes', or '1',
1434 the dialog uses a built-in generic prompt; otherwise the exact
1435 value of the variable is used.
1437 guitool.<name>.revprompt::
1438 Request a single valid revision from the user, and set the
1439 'REVISION' environment variable. In other aspects this option
1440 is similar to 'argprompt', and can be used together with it.
1442 guitool.<name>.revunmerged::
1443 Show only unmerged branches in the 'revprompt' subdialog.
1444 This is useful for tools similar to merge or rebase, but not
1445 for things like checkout or reset.
1447 guitool.<name>.title::
1448 Specifies the title to use for the prompt dialog. The default
1451 guitool.<name>.prompt::
1452 Specifies the general prompt string to display at the top of
1453 the dialog, before subsections for 'argprompt' and 'revprompt'.
1454 The default value includes the actual command.
1457 Specify the browser that will be used to display help in the
1458 'web' format. See linkgit:git-help[1].
1461 Override the default help format used by linkgit:git-help[1].
1462 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1463 the default. 'web' and 'html' are the same.
1466 Automatically correct and execute mistyped commands after
1467 waiting for the given number of deciseconds (0.1 sec). If more
1468 than one command can be deduced from the entered text, nothing
1469 will be executed. If the value of this option is negative,
1470 the corrected command will be executed immediately. If the
1471 value is 0 - the command will be just shown but not executed.
1472 This is the default.
1475 Specify the path where the HTML documentation resides. File system paths
1476 and URLs are supported. HTML pages will be prefixed with this path when
1477 help is displayed in the 'web' format. This defaults to the documentation
1478 path of your Git installation.
1481 Override the HTTP proxy, normally configured using the 'http_proxy',
1482 'https_proxy', and 'all_proxy' environment variables (see
1483 `curl(1)`). This can be overridden on a per-remote basis; see
1487 File containing previously stored cookie lines which should be used
1488 in the Git http session, if they match the server. The file format
1489 of the file to read cookies from should be plain HTTP headers or
1490 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1491 NOTE that the file specified with http.cookiefile is only used as
1492 input unless http.saveCookies is set.
1495 If set, store cookies received during requests to the file specified by
1496 http.cookiefile. Has no effect if http.cookiefile is unset.
1499 Whether to verify the SSL certificate when fetching or pushing
1500 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1504 File containing the SSL certificate when fetching or pushing
1505 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1509 File containing the SSL private key when fetching or pushing
1510 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1513 http.sslCertPasswordProtected::
1514 Enable Git's password prompt for the SSL certificate. Otherwise
1515 OpenSSL will prompt the user, possibly many times, if the
1516 certificate or private key is encrypted. Can be overridden by the
1517 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1520 File containing the certificates to verify the peer with when
1521 fetching or pushing over HTTPS. Can be overridden by the
1522 'GIT_SSL_CAINFO' environment variable.
1525 Path containing files with the CA certificates to verify the peer
1526 with when fetching or pushing over HTTPS. Can be overridden
1527 by the 'GIT_SSL_CAPATH' environment variable.
1530 Attempt to use AUTH SSL/TLS and encrypted data transfers
1531 when connecting via regular FTP protocol. This might be needed
1532 if the FTP server requires it for security reasons or you wish
1533 to connect securely whenever remote FTP server supports it.
1534 Default is false since it might trigger certificate verification
1535 errors on misconfigured servers.
1538 How many HTTP requests to launch in parallel. Can be overridden
1539 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1542 The number of curl sessions (counted across slots) to be kept across
1543 requests. They will not be ended with curl_easy_cleanup() until
1544 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1545 value will be capped at 1. Defaults to 1.
1548 Maximum size in bytes of the buffer used by smart HTTP
1549 transports when POSTing data to the remote system.
1550 For requests larger than this buffer size, HTTP/1.1 and
1551 Transfer-Encoding: chunked is used to avoid creating a
1552 massive pack file locally. Default is 1 MiB, which is
1553 sufficient for most requests.
1555 http.lowSpeedLimit, http.lowSpeedTime::
1556 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1557 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1558 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1559 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1562 A boolean which disables using of EPSV ftp command by curl.
1563 This can helpful with some "poor" ftp servers which don't
1564 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1565 environment variable. Default is false (curl will use EPSV).
1568 The HTTP USER_AGENT string presented to an HTTP server. The default
1569 value represents the version of the client Git such as git/1.7.1.
1570 This option allows you to override this value to a more common value
1571 such as Mozilla/4.0. This may be necessary, for instance, if
1572 connecting through a firewall that restricts HTTP connections to a set
1573 of common USER_AGENT strings (but not including those like git/1.7.1).
1574 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1577 Any of the http.* options above can be applied selectively to some urls.
1578 For a config key to match a URL, each element of the config key is
1579 compared to that of the URL, in the following order:
1582 . Scheme (e.g., `https` in `https://example.com/`). This field
1583 must match exactly between the config key and the URL.
1585 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1586 This field must match exactly between the config key and the URL.
1588 . Port number (e.g., `8080` in `http://example.com:8080/`).
1589 This field must match exactly between the config key and the URL.
1590 Omitted port numbers are automatically converted to the correct
1591 default for the scheme before matching.
1593 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1594 path field of the config key must match the path field of the URL
1595 either exactly or as a prefix of slash-delimited path elements. This means
1596 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1597 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1598 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1599 key with just path `foo/`).
1601 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1602 the config key has a user name it must match the user name in the
1603 URL exactly. If the config key does not have a user name, that
1604 config key will match a URL with any user name (including none),
1605 but at a lower precedence than a config key with a user name.
1608 The list above is ordered by decreasing precedence; a URL that matches
1609 a config key's path is preferred to one that matches its user name. For example,
1610 if the URL is `https://user@example.com/foo/bar` a config key match of
1611 `https://example.com/foo` will be preferred over a config key match of
1612 `https://user@example.com`.
1614 All URLs are normalized before attempting any matching (the password part,
1615 if embedded in the URL, is always ignored for matching purposes) so that
1616 equivalent urls that are simply spelled differently will match properly.
1617 Environment variable settings always override any matches. The urls that are
1618 matched against are those given directly to Git commands. This means any URLs
1619 visited as a result of a redirection do not participate in matching.
1621 i18n.commitEncoding::
1622 Character encoding the commit messages are stored in; Git itself
1623 does not care per se, but this information is necessary e.g. when
1624 importing commits from emails or in the gitk graphical history
1625 browser (and possibly at other places in the future or in other
1626 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1628 i18n.logOutputEncoding::
1629 Character encoding the commit messages are converted to when
1630 running 'git log' and friends.
1633 The configuration variables in the 'imap' section are described
1634 in linkgit:git-imap-send[1].
1637 Specify the version with which new index files should be
1638 initialized. This does not affect existing repositories.
1641 Specify the directory from which templates will be copied.
1642 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1645 Specify the program that will be used to browse your working
1646 repository in gitweb. See linkgit:git-instaweb[1].
1649 The HTTP daemon command-line to start gitweb on your working
1650 repository. See linkgit:git-instaweb[1].
1653 If true the web server started by linkgit:git-instaweb[1] will
1654 be bound to the local IP (127.0.0.1).
1656 instaweb.modulepath::
1657 The default module path for linkgit:git-instaweb[1] to use
1658 instead of /usr/lib/apache2/modules. Only used if httpd
1662 The port number to bind the gitweb httpd to. See
1663 linkgit:git-instaweb[1].
1665 interactive.singlekey::
1666 In interactive commands, allow the user to provide one-letter
1667 input with a single key (i.e., without hitting enter).
1668 Currently this is used by the `--patch` mode of
1669 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1670 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1671 setting is silently ignored if portable keystroke input
1672 is not available; requires the Perl module Term::ReadKey.
1675 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1676 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1677 override this option with `--no-abbrev-commit`.
1680 Set the default date-time mode for the 'log' command.
1681 Setting a value for log.date is similar to using 'git log''s
1682 `--date` option. Possible values are `relative`, `local`,
1683 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1687 Print out the ref names of any commits that are shown by the log
1688 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1689 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1690 specified, the full ref name (including prefix) will be printed.
1691 This is the same as the log commands '--decorate' option.
1694 If true, the initial commit will be shown as a big creation event.
1695 This is equivalent to a diff against an empty tree.
1696 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1697 normally hide the root commit will now show it. True by default.
1700 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1701 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1704 The location of an augmenting mailmap file. The default
1705 mailmap, located in the root of the repository, is loaded
1706 first, then the mailmap file pointed to by this variable.
1707 The location of the mailmap file may be in a repository
1708 subdirectory, or somewhere outside of the repository itself.
1709 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1712 Like `mailmap.file`, but consider the value as a reference to a
1713 blob in the repository. If both `mailmap.file` and
1714 `mailmap.blob` are given, both are parsed, with entries from
1715 `mailmap.file` taking precedence. In a bare repository, this
1716 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1720 Specify the programs that may be used to display help in the
1721 'man' format. See linkgit:git-help[1].
1724 Specify the command to invoke the specified man viewer. The
1725 specified command is evaluated in shell with the man page
1726 passed as argument. (See linkgit:git-help[1].)
1729 Override the path for the given tool that may be used to
1730 display help in the 'man' format. See linkgit:git-help[1].
1732 include::merge-config.txt[]
1734 mergetool.<tool>.path::
1735 Override the path for the given tool. This is useful in case
1736 your tool is not in the PATH.
1738 mergetool.<tool>.cmd::
1739 Specify the command to invoke the specified merge tool. The
1740 specified command is evaluated in shell with the following
1741 variables available: 'BASE' is the name of a temporary file
1742 containing the common base of the files to be merged, if available;
1743 'LOCAL' is the name of a temporary file containing the contents of
1744 the file on the current branch; 'REMOTE' is the name of a temporary
1745 file containing the contents of the file from the branch being
1746 merged; 'MERGED' contains the name of the file to which the merge
1747 tool should write the results of a successful merge.
1749 mergetool.<tool>.trustExitCode::
1750 For a custom merge command, specify whether the exit code of
1751 the merge command can be used to determine whether the merge was
1752 successful. If this is not set to true then the merge target file
1753 timestamp is checked and the merge assumed to have been successful
1754 if the file has been updated, otherwise the user is prompted to
1755 indicate the success of the merge.
1757 mergetool.keepBackup::
1758 After performing a merge, the original file with conflict markers
1759 can be saved as a file with a `.orig` extension. If this variable
1760 is set to `false` then this file is not preserved. Defaults to
1761 `true` (i.e. keep the backup files).
1763 mergetool.keepTemporaries::
1764 When invoking a custom merge tool, Git uses a set of temporary
1765 files to pass to the tool. If the tool returns an error and this
1766 variable is set to `true`, then these temporary files will be
1767 preserved, otherwise they will be removed after the tool has
1768 exited. Defaults to `false`.
1771 Prompt before each invocation of the merge resolution program.
1774 The (fully qualified) refname from which to show notes when
1775 showing commit messages. The value of this variable can be set
1776 to a glob, in which case notes from all matching refs will be
1777 shown. You may also specify this configuration variable
1778 several times. A warning will be issued for refs that do not
1779 exist, but a glob that does not match any refs is silently
1782 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1783 environment variable, which must be a colon separated list of refs or
1786 The effective value of "core.notesRef" (possibly overridden by
1787 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1790 notes.rewrite.<command>::
1791 When rewriting commits with <command> (currently `amend` or
1792 `rebase`) and this variable is set to `true`, Git
1793 automatically copies your notes from the original to the
1794 rewritten commit. Defaults to `true`, but see
1795 "notes.rewriteRef" below.
1798 When copying notes during a rewrite (see the
1799 "notes.rewrite.<command>" option), determines what to do if
1800 the target commit already has a note. Must be one of
1801 `overwrite`, `concatenate`, or `ignore`. Defaults to
1804 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1805 environment variable.
1808 When copying notes during a rewrite, specifies the (fully
1809 qualified) ref whose notes should be copied. The ref may be a
1810 glob, in which case notes in all matching refs will be copied.
1811 You may also specify this configuration several times.
1813 Does not have a default value; you must configure this variable to
1814 enable note rewriting. Set it to `refs/notes/commits` to enable
1815 rewriting for the default commit notes.
1817 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1818 environment variable, which must be a colon separated list of refs or
1822 The size of the window used by linkgit:git-pack-objects[1] when no
1823 window size is given on the command line. Defaults to 10.
1826 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1827 maximum depth is given on the command line. Defaults to 50.
1830 The window memory size limit used by linkgit:git-pack-objects[1]
1831 when no limit is given on the command line. The value can be
1832 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1836 An integer -1..9, indicating the compression level for objects
1837 in a pack file. -1 is the zlib default. 0 means no
1838 compression, and 1..9 are various speed/size tradeoffs, 9 being
1839 slowest. If not set, defaults to core.compression. If that is
1840 not set, defaults to -1, the zlib default, which is "a default
1841 compromise between speed and compression (currently equivalent
1844 Note that changing the compression level will not automatically recompress
1845 all existing objects. You can force recompression by passing the -F option
1846 to linkgit:git-repack[1].
1848 pack.deltaCacheSize::
1849 The maximum memory in bytes used for caching deltas in
1850 linkgit:git-pack-objects[1] before writing them out to a pack.
1851 This cache is used to speed up the writing object phase by not
1852 having to recompute the final delta result once the best match
1853 for all objects is found. Repacking large repositories on machines
1854 which are tight with memory might be badly impacted by this though,
1855 especially if this cache pushes the system into swapping.
1856 A value of 0 means no limit. The smallest size of 1 byte may be
1857 used to virtually disable this cache. Defaults to 256 MiB.
1859 pack.deltaCacheLimit::
1860 The maximum size of a delta, that is cached in
1861 linkgit:git-pack-objects[1]. This cache is used to speed up the
1862 writing object phase by not having to recompute the final delta
1863 result once the best match for all objects is found. Defaults to 1000.
1866 Specifies the number of threads to spawn when searching for best
1867 delta matches. This requires that linkgit:git-pack-objects[1]
1868 be compiled with pthreads otherwise this option is ignored with a
1869 warning. This is meant to reduce packing time on multiprocessor
1870 machines. The required amount of memory for the delta search window
1871 is however multiplied by the number of threads.
1872 Specifying 0 will cause Git to auto-detect the number of CPU's
1873 and set the number of threads accordingly.
1876 Specify the default pack index version. Valid values are 1 for
1877 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1878 the new pack index with capabilities for packs larger than 4 GB
1879 as well as proper protection against the repacking of corrupted
1880 packs. Version 2 is the default. Note that version 2 is enforced
1881 and this config option ignored whenever the corresponding pack is
1884 If you have an old Git that does not understand the version 2 `*.idx` file,
1885 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1886 that will copy both `*.pack` file and corresponding `*.idx` file from the
1887 other side may give you a repository that cannot be accessed with your
1888 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1889 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1892 pack.packSizeLimit::
1893 The maximum size of a pack. This setting only affects
1894 packing to a file when repacking, i.e. the git:// protocol
1895 is unaffected. It can be overridden by the `--max-pack-size`
1896 option of linkgit:git-repack[1]. The minimum size allowed is
1897 limited to 1 MiB. The default is unlimited.
1898 Common unit suffixes of 'k', 'm', or 'g' are
1902 When true, git will use pack bitmaps (if available) when packing
1903 to stdout (e.g., during the server side of a fetch). Defaults to
1904 true. You should not generally need to turn this off unless
1905 you are debugging pack bitmaps.
1908 When true, git will write a bitmap index when packing all
1909 objects to disk (e.g., when `git repack -a` is run). This
1910 index can speed up the "counting objects" phase of subsequent
1911 packs created for clones and fetches, at the cost of some disk
1912 space and extra time spent on the initial repack. Defaults to
1915 pack.writeBitmapHashCache::
1916 When true, git will include a "hash cache" section in the bitmap
1917 index (if one is written). This cache can be used to feed git's
1918 delta heuristics, potentially leading to better deltas between
1919 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1920 between an older, bitmapped pack and objects that have been
1921 pushed since the last gc). The downside is that it consumes 4
1922 bytes per object of disk space, and that JGit's bitmap
1923 implementation does not understand it, causing it to complain if
1924 Git and JGit are used on the same repository. Defaults to false.
1927 If the value is boolean, turns on or off pagination of the
1928 output of a particular Git subcommand when writing to a tty.
1929 Otherwise, turns on pagination for the subcommand using the
1930 pager specified by the value of `pager.<cmd>`. If `--paginate`
1931 or `--no-pager` is specified on the command line, it takes
1932 precedence over this option. To disable pagination for all
1933 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1936 Alias for a --pretty= format string, as specified in
1937 linkgit:git-log[1]. Any aliases defined here can be used just
1938 as the built-in pretty formats could. For example,
1939 running `git config pretty.changelog "format:* %H %s"`
1940 would cause the invocation `git log --pretty=changelog`
1941 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1942 Note that an alias with the same name as a built-in format
1943 will be silently ignored.
1946 By default, Git does not create an extra merge commit when merging
1947 a commit that is a descendant of the current commit. Instead, the
1948 tip of the current branch is fast-forwarded. When set to `false`,
1949 this variable tells Git to create an extra merge commit in such
1950 a case (equivalent to giving the `--no-ff` option from the command
1951 line). When set to `only`, only such fast-forward merges are
1952 allowed (equivalent to giving the `--ff-only` option from the
1956 When true, rebase branches on top of the fetched branch, instead
1957 of merging the default branch from the default remote when "git
1958 pull" is run. See "branch.<name>.rebase" for setting this on a
1961 When preserve, also pass `--preserve-merges` along to 'git rebase'
1962 so that locally committed merge commits will not be flattened
1963 by running 'git pull'.
1965 *NOTE*: this is a possibly dangerous operation; do *not* use
1966 it unless you understand the implications (see linkgit:git-rebase[1]
1970 The default merge strategy to use when pulling multiple branches
1974 The default merge strategy to use when pulling a single branch.
1977 Defines the action `git push` should take if no refspec is
1978 explicitly given. Different values are well-suited for
1979 specific workflows; for instance, in a purely central workflow
1980 (i.e. the fetch source is equal to the push destination),
1981 `upstream` is probably what you want. Possible values are:
1985 * `nothing` - do not push anything (error out) unless a refspec is
1986 explicitly given. This is primarily meant for people who want to
1987 avoid mistakes by always being explicit.
1989 * `current` - push the current branch to update a branch with the same
1990 name on the receiving end. Works in both central and non-central
1993 * `upstream` - push the current branch back to the branch whose
1994 changes are usually integrated into the current branch (which is
1995 called `@{upstream}`). This mode only makes sense if you are
1996 pushing to the same repository you would normally pull from
1997 (i.e. central workflow).
1999 * `simple` - in centralized workflow, work like `upstream` with an
2000 added safety to refuse to push if the upstream branch's name is
2001 different from the local one.
2003 When pushing to a remote that is different from the remote you normally
2004 pull from, work as `current`. This is the safest option and is suited
2007 This mode has become the default in Git 2.0.
2009 * `matching` - push all branches having the same name on both ends.
2010 This makes the repository you are pushing to remember the set of
2011 branches that will be pushed out (e.g. if you always push 'maint'
2012 and 'master' there and no other branches, the repository you push
2013 to will have these two branches, and your local 'maint' and
2014 'master' will be pushed there).
2016 To use this mode effectively, you have to make sure _all_ the
2017 branches you would push out are ready to be pushed out before
2018 running 'git push', as the whole point of this mode is to allow you
2019 to push all of the branches in one go. If you usually finish work
2020 on only one branch and push out the result, while other branches are
2021 unfinished, this mode is not for you. Also this mode is not
2022 suitable for pushing into a shared central repository, as other
2023 people may add new branches there, or update the tip of existing
2024 branches outside your control.
2026 This used to be the default, but not since Git 2.0 (`simple` is the
2032 Whether to show a diffstat of what changed upstream since the last
2033 rebase. False by default.
2036 If set to true enable '--autosquash' option by default.
2039 When set to true, automatically create a temporary stash
2040 before the operation begins, and apply it after the operation
2041 ends. This means that you can run rebase on a dirty worktree.
2042 However, use with care: the final stash application after a
2043 successful rebase might result in non-trivial conflicts.
2047 By default, git-receive-pack will run "git-gc --auto" after
2048 receiving data from git-push and updating refs. You can stop
2049 it by setting this variable to false.
2051 receive.fsckObjects::
2052 If it is set to true, git-receive-pack will check all received
2053 objects. It will abort in the case of a malformed object or a
2054 broken link. The result of an abort are only dangling objects.
2055 Defaults to false. If not set, the value of `transfer.fsckObjects`
2058 receive.unpackLimit::
2059 If the number of objects received in a push is below this
2060 limit then the objects will be unpacked into loose object
2061 files. However if the number of received objects equals or
2062 exceeds this limit then the received pack will be stored as
2063 a pack, after adding any missing delta bases. Storing the
2064 pack from a push can make the push operation complete faster,
2065 especially on slow filesystems. If not set, the value of
2066 `transfer.unpackLimit` is used instead.
2068 receive.denyDeletes::
2069 If set to true, git-receive-pack will deny a ref update that deletes
2070 the ref. Use this to prevent such a ref deletion via a push.
2072 receive.denyDeleteCurrent::
2073 If set to true, git-receive-pack will deny a ref update that
2074 deletes the currently checked out branch of a non-bare repository.
2076 receive.denyCurrentBranch::
2077 If set to true or "refuse", git-receive-pack will deny a ref update
2078 to the currently checked out branch of a non-bare repository.
2079 Such a push is potentially dangerous because it brings the HEAD
2080 out of sync with the index and working tree. If set to "warn",
2081 print a warning of such a push to stderr, but allow the push to
2082 proceed. If set to false or "ignore", allow such pushes with no
2083 message. Defaults to "refuse".
2085 receive.denyNonFastForwards::
2086 If set to true, git-receive-pack will deny a ref update which is
2087 not a fast-forward. Use this to prevent such an update via a push,
2088 even if that push is forced. This configuration variable is
2089 set when initializing a shared repository.
2092 String(s) `receive-pack` uses to decide which refs to omit
2093 from its initial advertisement. Use more than one
2094 definitions to specify multiple prefix strings. A ref that
2095 are under the hierarchies listed on the value of this
2096 variable is excluded, and is hidden when responding to `git
2097 push`, and an attempt to update or delete a hidden ref by
2098 `git push` is rejected.
2100 receive.updateserverinfo::
2101 If set to true, git-receive-pack will run git-update-server-info
2102 after receiving data from git-push and updating refs.
2104 receive.shallowupdate::
2105 If set to true, .git/shallow can be updated when new refs
2106 require new shallow roots. Otherwise those refs are rejected.
2108 remote.pushdefault::
2109 The remote to push to by default. Overrides
2110 `branch.<name>.remote` for all branches, and is overridden by
2111 `branch.<name>.pushremote` for specific branches.
2114 The URL of a remote repository. See linkgit:git-fetch[1] or
2115 linkgit:git-push[1].
2117 remote.<name>.pushurl::
2118 The push URL of a remote repository. See linkgit:git-push[1].
2120 remote.<name>.proxy::
2121 For remotes that require curl (http, https and ftp), the URL to
2122 the proxy to use for that remote. Set to the empty string to
2123 disable proxying for that remote.
2125 remote.<name>.fetch::
2126 The default set of "refspec" for linkgit:git-fetch[1]. See
2127 linkgit:git-fetch[1].
2129 remote.<name>.push::
2130 The default set of "refspec" for linkgit:git-push[1]. See
2131 linkgit:git-push[1].
2133 remote.<name>.mirror::
2134 If true, pushing to this remote will automatically behave
2135 as if the `--mirror` option was given on the command line.
2137 remote.<name>.skipDefaultUpdate::
2138 If true, this remote will be skipped by default when updating
2139 using linkgit:git-fetch[1] or the `update` subcommand of
2140 linkgit:git-remote[1].
2142 remote.<name>.skipFetchAll::
2143 If true, this remote will be skipped by default when updating
2144 using linkgit:git-fetch[1] or the `update` subcommand of
2145 linkgit:git-remote[1].
2147 remote.<name>.receivepack::
2148 The default program to execute on the remote side when pushing. See
2149 option \--receive-pack of linkgit:git-push[1].
2151 remote.<name>.uploadpack::
2152 The default program to execute on the remote side when fetching. See
2153 option \--upload-pack of linkgit:git-fetch-pack[1].
2155 remote.<name>.tagopt::
2156 Setting this value to \--no-tags disables automatic tag following when
2157 fetching from remote <name>. Setting it to \--tags will fetch every
2158 tag from remote <name>, even if they are not reachable from remote
2159 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2160 override this setting. See options \--tags and \--no-tags of
2161 linkgit:git-fetch[1].
2164 Setting this to a value <vcs> will cause Git to interact with
2165 the remote with the git-remote-<vcs> helper.
2167 remote.<name>.prune::
2168 When set to true, fetching from this remote by default will also
2169 remove any remote-tracking references that no longer exist on the
2170 remote (as if the `--prune` option was given on the command line).
2171 Overrides `fetch.prune` settings, if any.
2174 The list of remotes which are fetched by "git remote update
2175 <group>". See linkgit:git-remote[1].
2177 repack.usedeltabaseoffset::
2178 By default, linkgit:git-repack[1] creates packs that use
2179 delta-base offset. If you need to share your repository with
2180 Git older than version 1.4.4, either directly or via a dumb
2181 protocol such as http, then you need to set this option to
2182 "false" and repack. Access from old Git versions over the
2183 native protocol are unaffected by this option.
2185 repack.packKeptObjects::
2186 If set to true, makes `git repack` act as if
2187 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2188 details. Defaults to `false` normally, but `true` if a bitmap
2189 index is being written (either via `--write-bitmap-index` or
2190 `pack.writeBitmaps`).
2193 When set to true, `git-rerere` updates the index with the
2194 resulting contents after it cleanly resolves conflicts using
2195 previously recorded resolution. Defaults to false.
2198 Activate recording of resolved conflicts, so that identical
2199 conflict hunks can be resolved automatically, should they be
2200 encountered again. By default, linkgit:git-rerere[1] is
2201 enabled if there is an `rr-cache` directory under the
2202 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2205 sendemail.identity::
2206 A configuration identity. When given, causes values in the
2207 'sendemail.<identity>' subsection to take precedence over
2208 values in the 'sendemail' section. The default identity is
2209 the value of 'sendemail.identity'.
2211 sendemail.smtpencryption::
2212 See linkgit:git-send-email[1] for description. Note that this
2213 setting is not subject to the 'identity' mechanism.
2216 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2218 sendemail.smtpsslcertpath::
2219 Path to ca-certificates (either a directory or a single file).
2220 Set it to an empty string to disable certificate verification.
2222 sendemail.<identity>.*::
2223 Identity-specific versions of the 'sendemail.*' parameters
2224 found below, taking precedence over those when the this
2225 identity is selected, through command-line or
2226 'sendemail.identity'.
2228 sendemail.aliasesfile::
2229 sendemail.aliasfiletype::
2230 sendemail.annotate::
2234 sendemail.chainreplyto::
2236 sendemail.envelopesender::
2238 sendemail.multiedit::
2239 sendemail.signedoffbycc::
2240 sendemail.smtppass::
2241 sendemail.suppresscc::
2242 sendemail.suppressfrom::
2244 sendemail.smtpdomain::
2245 sendemail.smtpserver::
2246 sendemail.smtpserverport::
2247 sendemail.smtpserveroption::
2248 sendemail.smtpuser::
2250 sendemail.validate::
2251 See linkgit:git-send-email[1] for description.
2253 sendemail.signedoffcc::
2254 Deprecated alias for 'sendemail.signedoffbycc'.
2256 showbranch.default::
2257 The default set of branches for linkgit:git-show-branch[1].
2258 See linkgit:git-show-branch[1].
2260 status.relativePaths::
2261 By default, linkgit:git-status[1] shows paths relative to the
2262 current directory. Setting this variable to `false` shows paths
2263 relative to the repository root (this was the default for Git
2267 Set to true to enable --short by default in linkgit:git-status[1].
2268 The option --no-short takes precedence over this variable.
2271 Set to true to enable --branch by default in linkgit:git-status[1].
2272 The option --no-branch takes precedence over this variable.
2274 status.displayCommentPrefix::
2275 If set to true, linkgit:git-status[1] will insert a comment
2276 prefix before each output line (starting with
2277 `core.commentChar`, i.e. `#` by default). This was the
2278 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2281 status.showUntrackedFiles::
2282 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2283 files which are not currently tracked by Git. Directories which
2284 contain only untracked files, are shown with the directory name
2285 only. Showing untracked files means that Git needs to lstat() all
2286 all the files in the whole repository, which might be slow on some
2287 systems. So, this variable controls how the commands displays
2288 the untracked files. Possible values are:
2291 * `no` - Show no untracked files.
2292 * `normal` - Show untracked files and directories.
2293 * `all` - Show also individual files in untracked directories.
2296 If this variable is not specified, it defaults to 'normal'.
2297 This variable can be overridden with the -u|--untracked-files option
2298 of linkgit:git-status[1] and linkgit:git-commit[1].
2300 status.submodulesummary::
2302 If this is set to a non zero number or true (identical to -1 or an
2303 unlimited number), the submodule summary will be enabled and a
2304 summary of commits for modified submodules will be shown (see
2305 --summary-limit option of linkgit:git-submodule[1]). Please note
2306 that the summary output command will be suppressed for all
2307 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2308 for those submodules where `submodule.<name>.ignore=all`. To
2309 also view the summary for ignored submodules you can either use
2310 the --ignore-submodules=dirty command line option or the 'git
2311 submodule summary' command, which shows a similar output but does
2312 not honor these settings.
2314 submodule.<name>.path::
2315 submodule.<name>.url::
2316 submodule.<name>.update::
2317 The path within this project, URL, and the updating strategy
2318 for a submodule. These variables are initially populated
2319 by 'git submodule init'; edit them to override the
2320 URL and other values found in the `.gitmodules` file. See
2321 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2323 submodule.<name>.branch::
2324 The remote branch name for a submodule, used by `git submodule
2325 update --remote`. Set this option to override the value found in
2326 the `.gitmodules` file. See linkgit:git-submodule[1] and
2327 linkgit:gitmodules[5] for details.
2329 submodule.<name>.fetchRecurseSubmodules::
2330 This option can be used to control recursive fetching of this
2331 submodule. It can be overridden by using the --[no-]recurse-submodules
2332 command line option to "git fetch" and "git pull".
2333 This setting will override that from in the linkgit:gitmodules[5]
2336 submodule.<name>.ignore::
2337 Defines under what circumstances "git status" and the diff family show
2338 a submodule as modified. When set to "all", it will never be considered
2339 modified, "dirty" will ignore all changes to the submodules work tree and
2340 takes only differences between the HEAD of the submodule and the commit
2341 recorded in the superproject into account. "untracked" will additionally
2342 let submodules with modified tracked files in their work tree show up.
2343 Using "none" (the default when this option is not set) also shows
2344 submodules that have untracked files in their work tree as changed.
2345 This setting overrides any setting made in .gitmodules for this submodule,
2346 both settings can be overridden on the command line by using the
2347 "--ignore-submodules" option. The 'git submodule' commands are not
2348 affected by this setting.
2351 This variable can be used to restrict the permission bits of
2352 tar archive entries. The default is 0002, which turns off the
2353 world write bit. The special value "user" indicates that the
2354 archiving user's umask will be used instead. See umask(2) and
2355 linkgit:git-archive[1].
2357 transfer.fsckObjects::
2358 When `fetch.fsckObjects` or `receive.fsckObjects` are
2359 not set, the value of this variable is used instead.
2363 This variable can be used to set both `receive.hiderefs`
2364 and `uploadpack.hiderefs` at the same time to the same
2365 values. See entries for these other variables.
2367 transfer.unpackLimit::
2368 When `fetch.unpackLimit` or `receive.unpackLimit` are
2369 not set, the value of this variable is used instead.
2370 The default value is 100.
2372 uploadarchive.allowUnreachable::
2373 If true, allow clients to use `git archive --remote` to request
2374 any tree, whether reachable from the ref tips or not. See the
2375 discussion in the `SECURITY` section of
2376 linkgit:git-upload-archive[1] for more details. Defaults to
2379 uploadpack.hiderefs::
2380 String(s) `upload-pack` uses to decide which refs to omit
2381 from its initial advertisement. Use more than one
2382 definitions to specify multiple prefix strings. A ref that
2383 are under the hierarchies listed on the value of this
2384 variable is excluded, and is hidden from `git ls-remote`,
2385 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2386 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2388 uploadpack.allowtipsha1inwant::
2389 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2390 to accept a fetch request that asks for an object at the tip
2391 of a hidden ref (by default, such a request is rejected).
2392 see also `uploadpack.hiderefs`.
2394 uploadpack.keepalive::
2395 When `upload-pack` has started `pack-objects`, there may be a
2396 quiet period while `pack-objects` prepares the pack. Normally
2397 it would output progress information, but if `--quiet` was used
2398 for the fetch, `pack-objects` will output nothing at all until
2399 the pack data begins. Some clients and networks may consider
2400 the server to be hung and give up. Setting this option instructs
2401 `upload-pack` to send an empty keepalive packet every
2402 `uploadpack.keepalive` seconds. Setting this option to 0
2403 disables keepalive packets entirely. The default is 5 seconds.
2405 url.<base>.insteadOf::
2406 Any URL that starts with this value will be rewritten to
2407 start, instead, with <base>. In cases where some site serves a
2408 large number of repositories, and serves them with multiple
2409 access methods, and some users need to use different access
2410 methods, this feature allows people to specify any of the
2411 equivalent URLs and have Git automatically rewrite the URL to
2412 the best alternative for the particular user, even for a
2413 never-before-seen repository on the site. When more than one
2414 insteadOf strings match a given URL, the longest match is used.
2416 url.<base>.pushInsteadOf::
2417 Any URL that starts with this value will not be pushed to;
2418 instead, it will be rewritten to start with <base>, and the
2419 resulting URL will be pushed to. In cases where some site serves
2420 a large number of repositories, and serves them with multiple
2421 access methods, some of which do not allow push, this feature
2422 allows people to specify a pull-only URL and have Git
2423 automatically use an appropriate URL to push, even for a
2424 never-before-seen repository on the site. When more than one
2425 pushInsteadOf strings match a given URL, the longest match is
2426 used. If a remote has an explicit pushurl, Git will ignore this
2427 setting for that remote.
2430 Your email address to be recorded in any newly created commits.
2431 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2432 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2435 Your full name to be recorded in any newly created commits.
2436 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2437 environment variables. See linkgit:git-commit-tree[1].
2440 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2441 key you want it to automatically when creating a signed tag or
2442 commit, you can override the default selection with this variable.
2443 This option is passed unchanged to gpg's --local-user parameter,
2444 so you may specify a key using any method that gpg supports.
2447 Specify a web browser that may be used by some commands.
2448 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]