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