4 The git configuration file contains a number of variables that affect
5 the git command's 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 and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, `-` and `.` are allowed in section names. Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
37 [section "subsection"]
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively). Section headers cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'. If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed. There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean. Boolean values may be given as yes/no,
65 1/0, true/false or on/off. Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS). No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
91 ; Don't trust file modes
96 external = /usr/local/bin/diff-wrapper
101 merge = refs/heads/devel
105 gitProxy="ssh" for "kernel.org"
106 gitProxy=default-proxy ; for the rest
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid overwriting local changes.
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
138 Advice on how to set your identity configuration when
139 your information is guessed from the system username and
140 domain name. Default: true.
143 Advice shown when you used linkgit::git-checkout[1] to
144 move to the detach HEAD state, to instruct how to create
145 a local branch after the fact. Default: true.
149 If false, the executable bit differences between the index and
150 the working copy are ignored; useful on broken filesystems like FAT.
151 See linkgit:git-update-index[1].
153 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154 will probe and set core.fileMode false if appropriate when the
155 repository is created.
158 (Windows-only) If true (which is the default), mark newly-created
159 directories and files whose name starts with a dot as hidden.
160 If 'dotGitOnly', only the .git/ directory is hidden, but no other
161 files starting with a dot.
163 core.ignoreCygwinFSTricks::
164 This option is only used by Cygwin implementation of Git. If false,
165 the Cygwin stat() and lstat() functions are used. This may be useful
166 if your repository consists of a few separate directories joined in
167 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
168 whenever it is possible and falls back to Cygwin functions only to
169 handle symbol links. The native mode is more than twice faster than
170 normal Cygwin l/stat() functions. True by default, unless core.filemode
171 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
172 POSIX emulation is required to support core.filemode.
175 If true, this option enables various workarounds to enable
176 git to work better on filesystems that are not case sensitive,
177 like FAT. For example, if a directory listing finds
178 "makefile" when git expects "Makefile", git will assume
179 it is really the same file, and continue to remember it as
182 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
183 will probe and set core.ignorecase true if appropriate when the repository
187 If false, the ctime differences between the index and the
188 working copy are ignored; useful when the inode change time
189 is regularly modified by something outside Git (file system
190 crawlers and some backup systems).
191 See linkgit:git-update-index[1]. True by default.
194 The commands that output paths (e.g. 'ls-files',
195 'diff'), when not given the `-z` option, will quote
196 "unusual" characters in the pathname by enclosing the
197 pathname in a double-quote pair and with backslashes the
198 same way strings in C source code are quoted. If this
199 variable is set to false, the bytes higher than 0x80 are
200 not quoted but output as verbatim. Note that double
201 quote, backslash and control characters are always
202 quoted without `-z` regardless of the setting of this
206 Sets the line ending type to use in the working directory for
207 files that have the `text` property set. Alternatives are
208 'lf', 'crlf' and 'native', which uses the platform's native
209 line ending. The default value is `native`. See
210 linkgit:gitattributes[5] for more information on end-of-line
214 If true, makes git check if converting `CRLF` is reversible when
215 end-of-line conversion is active. Git will verify if a command
216 modifies a file in the work tree either directly or indirectly.
217 For example, committing a file followed by checking out the
218 same file should yield the original file in the work tree. If
219 this is not the case for the current setting of
220 `core.autocrlf`, git will reject the file. The variable can
221 be set to "warn", in which case git will only warn about an
222 irreversible conversion but continue the operation.
224 CRLF conversion bears a slight chance of corrupting data.
225 When it is enabled, git will convert CRLF to LF during commit and LF to
226 CRLF during checkout. A file that contains a mixture of LF and
227 CRLF before the commit cannot be recreated by git. For text
228 files this is the right thing to do: it corrects line endings
229 such that we have only LF line endings in the repository.
230 But for binary files that are accidentally classified as text the
231 conversion can corrupt data.
233 If you recognize such corruption early you can easily fix it by
234 setting the conversion type explicitly in .gitattributes. Right
235 after committing you still have the original file in your work
236 tree and this file is not yet corrupted. You can explicitly tell
237 git that this file is binary and git will handle the file
240 Unfortunately, the desired effect of cleaning up text files with
241 mixed line endings and the undesired effect of corrupting binary
242 files cannot be distinguished. In both cases CRLFs are removed
243 in an irreversible way. For text files this is the right thing
244 to do because CRLFs are line endings, while for binary files
245 converting CRLFs corrupts data.
247 Note, this safety check does not mean that a checkout will generate a
248 file identical to the original file for a different setting of
249 `core.eol` and `core.autocrlf`, but only for the current one. For
250 example, a text file with `LF` would be accepted with `core.eol=lf`
251 and could later be checked out with `core.eol=crlf`, in which case the
252 resulting file would contain `CRLF`, although the original file
253 contained `LF`. However, in both work trees the line endings would be
254 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
255 file with mixed line endings would be reported by the `core.safecrlf`
259 Setting this variable to "true" is almost the same as setting
260 the `text` attribute to "auto" on all files except that text
261 files are not guaranteed to be normalized: files that contain
262 `CRLF` in the repository will not be touched. Use this
263 setting if you want to have `CRLF` line endings in your
264 working directory even though the repository does not have
265 normalized line endings. This variable can be set to 'input',
266 in which case no output conversion is performed.
269 If false, symbolic links are checked out as small plain files that
270 contain the link text. linkgit:git-update-index[1] and
271 linkgit:git-add[1] will not change the recorded type to regular
272 file. Useful on filesystems like FAT that do not support
275 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
276 will probe and set core.symlinks false if appropriate when the repository
280 A "proxy command" to execute (as 'command host port') instead
281 of establishing direct connection to the remote server when
282 using the git protocol for fetching. If the variable value is
283 in the "COMMAND for DOMAIN" format, the command is applied only
284 on hostnames ending with the specified domain string. This variable
285 may be set multiple times and is matched in the given order;
286 the first match wins.
288 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
289 (which always applies universally, without the special "for"
292 The special string `none` can be used as the proxy command to
293 specify that no proxy be used for a given domain pattern.
294 This is useful for excluding servers inside a firewall from
295 proxy use, while defaulting to a common proxy for external domains.
298 If true, commands which modify both the working tree and the index
299 will mark the updated paths with the "assume unchanged" bit in the
300 index. These marked files are then assumed to stay unchanged in the
301 working copy, until you mark them otherwise manually - Git will not
302 detect the file changes by lstat() calls. This is useful on systems
303 where those are very slow, such as Microsoft Windows.
304 See linkgit:git-update-index[1].
307 core.preferSymlinkRefs::
308 Instead of the default "symref" format for HEAD
309 and other symbolic reference files, use symbolic links.
310 This is sometimes needed to work with old scripts that
311 expect HEAD to be a symbolic link.
314 If true this repository is assumed to be 'bare' and has no
315 working directory associated with it. If this is the case a
316 number of commands that require a working directory will be
317 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
319 This setting is automatically guessed by linkgit:git-clone[1] or
320 linkgit:git-init[1] when the repository was created. By default a
321 repository that ends in "/.git" is assumed to be not bare (bare =
322 false), while all other repositories are assumed to be bare (bare
326 Set the path to the root of the working tree.
327 This can be overridden by the GIT_WORK_TREE environment
328 variable and the '--work-tree' command line option.
329 The value can be an absolute path or relative to the path to
330 the .git directory, which is either specified by --git-dir
331 or GIT_DIR, or automatically discovered.
332 If --git-dir or GIT_DIR is specified but none of
333 --work-tree, GIT_WORK_TREE and core.worktree is specified,
334 the current working directory is regarded as the top level
335 of your working tree.
337 Note that this variable is honored even when set in a configuration
338 file in a ".git" subdirectory of a directory and its value differs
339 from the latter directory (e.g. "/path/to/.git/config" has
340 core.worktree set to "/different/path"), which is most likely a
341 misconfiguration. Running git commands in the "/path/to" directory will
342 still use "/different/path" as the root of the work tree and can cause
343 confusion unless you know what you are doing (e.g. you are creating a
344 read-only snapshot of the same index to a location different from the
345 repository's usual working tree).
347 core.logAllRefUpdates::
348 Enable the reflog. Updates to a ref <ref> is logged to the file
349 "$GIT_DIR/logs/<ref>", by appending the new and old
350 SHA1, the date/time and the reason of the update, but
351 only when the file exists. If this configuration
352 variable is set to true, missing "$GIT_DIR/logs/<ref>"
353 file is automatically created for branch heads.
355 This information can be used to determine what commit
356 was the tip of a branch "2 days ago".
358 This value is true by default in a repository that has
359 a working directory associated with it, and false by
360 default in a bare repository.
362 core.repositoryFormatVersion::
363 Internal variable identifying the repository format and layout
366 core.sharedRepository::
367 When 'group' (or 'true'), the repository is made shareable between
368 several users in a group (making sure all the files and objects are
369 group-writable). When 'all' (or 'world' or 'everybody'), the
370 repository will be readable by all users, additionally to being
371 group-shareable. When 'umask' (or 'false'), git will use permissions
372 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
373 files in the repository will have this mode value. '0xxx' will override
374 user's umask value (whereas the other options will only override
375 requested parts of the user's umask value). Examples: '0660' will make
376 the repo read/write-able for the owner and group, but inaccessible to
377 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
378 repository that is group-readable but not group-writable.
379 See linkgit:git-init[1]. False by default.
381 core.warnAmbiguousRefs::
382 If true, git will warn you if the ref name you passed it is ambiguous
383 and might match multiple refs in the .git/refs/ tree. True by default.
386 An integer -1..9, indicating a default compression level.
387 -1 is the zlib default. 0 means no compression,
388 and 1..9 are various speed/size tradeoffs, 9 being slowest.
389 If set, this provides a default to other compression variables,
390 such as 'core.loosecompression' and 'pack.compression'.
392 core.loosecompression::
393 An integer -1..9, indicating the compression level for objects that
394 are not in a pack file. -1 is the zlib default. 0 means no
395 compression, and 1..9 are various speed/size tradeoffs, 9 being
396 slowest. If not set, defaults to core.compression. If that is
397 not set, defaults to 1 (best speed).
399 core.packedGitWindowSize::
400 Number of bytes of a pack file to map into memory in a
401 single mapping operation. Larger window sizes may allow
402 your system to process a smaller number of large pack files
403 more quickly. Smaller window sizes will negatively affect
404 performance due to increased calls to the operating system's
405 memory manager, but may improve performance when accessing
406 a large number of large pack files.
408 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
409 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
410 be reasonable for all users/operating systems. You probably do
411 not need to adjust this value.
413 Common unit suffixes of 'k', 'm', or 'g' are supported.
415 core.packedGitLimit::
416 Maximum number of bytes to map simultaneously into memory
417 from pack files. If Git needs to access more than this many
418 bytes at once to complete an operation it will unmap existing
419 regions to reclaim virtual address space within the process.
421 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
422 This should be reasonable for all users/operating systems, except on
423 the largest projects. You probably do not need to adjust this value.
425 Common unit suffixes of 'k', 'm', or 'g' are supported.
427 core.deltaBaseCacheLimit::
428 Maximum number of bytes to reserve for caching base objects
429 that may be referenced by multiple deltified objects. By storing the
430 entire decompressed base objects in a cache Git is able
431 to avoid unpacking and decompressing frequently used base
432 objects multiple times.
434 Default is 16 MiB on all platforms. This should be reasonable
435 for all users/operating systems, except on the largest projects.
436 You probably do not need to adjust this value.
438 Common unit suffixes of 'k', 'm', or 'g' are supported.
440 core.bigFileThreshold::
441 Files larger than this size are stored deflated, without
442 attempting delta compression. Storing large files without
443 delta compression avoids excessive memory usage, at the
444 slight expense of increased disk usage.
446 Default is 512 MiB on all platforms. This should be reasonable
447 for most projects as source code and other text files can still
448 be delta compressed, but larger binary media files won't be.
450 Common unit suffixes of 'k', 'm', or 'g' are supported.
453 In addition to '.gitignore' (per-directory) and
454 '.git/info/exclude', git looks into this file for patterns
455 of files which are not meant to be tracked. "{tilde}/" is expanded
456 to the value of `$HOME` and "{tilde}user/" to the specified user's
457 home directory. See linkgit:gitignore[5].
460 Some commands (e.g. svn and http interfaces) that interactively
461 ask for a password can be told to use an external program given
462 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
463 environment variable. If not set, fall back to the value of the
464 'SSH_ASKPASS' environment variable or, failing that, a simple password
465 prompt. The external program shall be given a suitable prompt as
466 command line argument and write the password on its STDOUT.
468 core.attributesfile::
469 In addition to '.gitattributes' (per-directory) and
470 '.git/info/attributes', git looks into this file for attributes
471 (see linkgit:gitattributes[5]). Path expansions are made the same
472 way as for `core.excludesfile`.
475 Commands such as `commit` and `tag` that lets you edit
476 messages by launching an editor uses the value of this
477 variable when it is set, and the environment variable
478 `GIT_EDITOR` is not set. See linkgit:git-var[1].
481 The command that git will use to paginate output. Can
482 be overridden with the `GIT_PAGER` environment
483 variable. Note that git sets the `LESS` environment
484 variable to `FRSX` if it is unset when it runs the
485 pager. One can change these settings by setting the
486 `LESS` variable to some other value. Alternately,
487 these settings can be overridden on a project or
488 global basis by setting the `core.pager` option.
489 Setting `core.pager` has no affect on the `LESS`
490 environment variable behaviour above, so if you want
491 to override git's default settings this way, you need
492 to be explicit. For example, to disable the S option
493 in a backward compatible manner, set `core.pager`
494 to `less -+$LESS -FRX`. This will be passed to the
495 shell by git, which will translate the final command to
496 `LESS=FRSX less -+FRSX -FRX`.
499 A comma separated list of common whitespace problems to
500 notice. 'git diff' will use `color.diff.whitespace` to
501 highlight them, and 'git apply --whitespace=error' will
502 consider them as errors. You can prefix `-` to disable
503 any of them (e.g. `-trailing-space`):
505 * `blank-at-eol` treats trailing whitespaces at the end of the line
506 as an error (enabled by default).
507 * `space-before-tab` treats a space character that appears immediately
508 before a tab character in the initial indent part of the line as an
509 error (enabled by default).
510 * `indent-with-non-tab` treats a line that is indented with 8 or more
511 space characters as an error (not enabled by default).
512 * `tab-in-indent` treats a tab character in the initial indent part of
513 the line as an error (not enabled by default).
514 * `blank-at-eof` treats blank lines added at the end of file as an error
515 (enabled by default).
516 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
518 * `cr-at-eol` treats a carriage-return at the end of line as
519 part of the line terminator, i.e. with it, `trailing-space`
520 does not trigger if the character before such a carriage-return
521 is not a whitespace (not enabled by default).
522 * `tabwidth=<n>` tells how many character positions a tab occupies; this
523 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
524 errors. The default tab width is 8. Allowed values are 1 to 63.
526 core.fsyncobjectfiles::
527 This boolean will enable 'fsync()' when writing object files.
529 This is a total waste of time and effort on a filesystem that orders
530 data writes properly, but can be useful for filesystems that do not use
531 journalling (traditional UNIX filesystems) or that only journal metadata
532 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
535 Enable parallel index preload for operations like 'git diff'
537 This can speed up operations like 'git diff' and 'git status' especially
538 on filesystems like NFS that have weak caching semantics and thus
539 relatively high IO latencies. With this set to 'true', git will do the
540 index comparison to the filesystem data in parallel, allowing
544 You can set this to 'link', in which case a hardlink followed by
545 a delete of the source are used to make sure that object creation
546 will not overwrite existing objects.
548 On some file system/operating system combinations, this is unreliable.
549 Set this config setting to 'rename' there; However, This will remove the
550 check that makes sure that existing object files will not get overwritten.
553 When showing commit messages, also show notes which are stored in
554 the given ref. The ref must be fully qualified. If the given
555 ref does not exist, it is not an error but means that no
556 notes should be printed.
558 This setting defaults to "refs/notes/commits", and it can be overridden by
559 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
561 core.sparseCheckout::
562 Enable "sparse checkout" feature. See section "Sparse checkout" in
563 linkgit:git-read-tree[1] for more information.
566 Set the length object names are abbreviated to. If unspecified,
567 many commands abbreviate to 7 hexdigits, which may not be enough
568 for abbreviated object names to stay unique for sufficiently long
573 Tells 'git add' to continue adding files when some files cannot be
574 added due to indexing errors. Equivalent to the '--ignore-errors'
575 option of linkgit:git-add[1]. Older versions of git accept only
576 `add.ignore-errors`, which does not follow the usual naming
577 convention for configuration variables. Newer versions of git
578 honor `add.ignoreErrors` as well.
581 Command aliases for the linkgit:git[1] command wrapper - e.g.
582 after defining "alias.last = cat-file commit HEAD", the invocation
583 "git last" is equivalent to "git cat-file commit HEAD". To avoid
584 confusion and troubles with script usage, aliases that
585 hide existing git commands are ignored. Arguments are split by
586 spaces, the usual shell quoting and escaping is supported.
587 quote pair and a backslash can be used to quote them.
589 If the alias expansion is prefixed with an exclamation point,
590 it will be treated as a shell command. For example, defining
591 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
592 "git new" is equivalent to running the shell command
593 "gitk --all --not ORIG_HEAD". Note that shell commands will be
594 executed from the top-level directory of a repository, which may
595 not necessarily be the current directory.
596 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
597 from the original current directory. See linkgit:git-rev-parse[1].
600 If true, git-am will call git-mailsplit for patches in mbox format
601 with parameter '--keep-cr'. In this case git-mailsplit will
602 not remove `\r` from lines ending with `\r\n`. Can be overridden
603 by giving '--no-keep-cr' from the command line.
604 See linkgit:git-am[1], linkgit:git-mailsplit[1].
606 apply.ignorewhitespace::
607 When set to 'change', tells 'git apply' to ignore changes in
608 whitespace, in the same way as the '--ignore-space-change'
610 When set to one of: no, none, never, false tells 'git apply' to
611 respect all whitespace differences.
612 See linkgit:git-apply[1].
615 Tells 'git apply' how to handle whitespaces, in the same way
616 as the '--whitespace' option. See linkgit:git-apply[1].
618 branch.autosetupmerge::
619 Tells 'git branch' and 'git checkout' to set up new branches
620 so that linkgit:git-pull[1] will appropriately merge from the
621 starting point branch. Note that even if this option is not set,
622 this behavior can be chosen per-branch using the `--track`
623 and `--no-track` options. The valid settings are: `false` -- no
624 automatic setup is done; `true` -- automatic setup is done when the
625 starting point is a remote-tracking branch; `always` --
626 automatic setup is done when the starting point is either a
627 local branch or remote-tracking
628 branch. This option defaults to true.
630 branch.autosetuprebase::
631 When a new branch is created with 'git branch' or 'git checkout'
632 that tracks another branch, this variable tells git to set
633 up pull to rebase instead of merge (see "branch.<name>.rebase").
634 When `never`, rebase is never automatically set to true.
635 When `local`, rebase is set to true for tracked branches of
636 other local branches.
637 When `remote`, rebase is set to true for tracked branches of
638 remote-tracking branches.
639 When `always`, rebase will be set to true for all tracking
641 See "branch.autosetupmerge" for details on how to set up a
642 branch to track another branch.
643 This option defaults to never.
645 branch.<name>.remote::
646 When in branch <name>, it tells 'git fetch' and 'git push' which
647 remote to fetch from/push to. It defaults to `origin` if no remote is
648 configured. `origin` is also used if you are not on any branch.
650 branch.<name>.merge::
651 Defines, together with branch.<name>.remote, the upstream branch
652 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
653 branch to merge and can also affect 'git push' (see push.default).
654 When in branch <name>, it tells 'git fetch' the default
655 refspec to be marked for merging in FETCH_HEAD. The value is
656 handled like the remote part of a refspec, and must match a
657 ref which is fetched from the remote given by
658 "branch.<name>.remote".
659 The merge information is used by 'git pull' (which at first calls
660 'git fetch') to lookup the default branch for merging. Without
661 this option, 'git pull' defaults to merge the first refspec fetched.
662 Specify multiple values to get an octopus merge.
663 If you wish to setup 'git pull' so that it merges into <name> from
664 another branch in the local repository, you can point
665 branch.<name>.merge to the desired branch, and use the special setting
666 `.` (a period) for branch.<name>.remote.
668 branch.<name>.mergeoptions::
669 Sets default options for merging into branch <name>. The syntax and
670 supported options are the same as those of linkgit:git-merge[1], but
671 option values containing whitespace characters are currently not
674 branch.<name>.rebase::
675 When true, rebase the branch <name> on top of the fetched branch,
676 instead of merging the default branch from the default remote when
678 *NOTE*: this is a possibly dangerous operation; do *not* use
679 it unless you understand the implications (see linkgit:git-rebase[1]
683 Specify the command to invoke the specified browser. The
684 specified command is evaluated in shell with the URLs passed
685 as arguments. (See linkgit:git-web--browse[1].)
687 browser.<tool>.path::
688 Override the path for the given tool that may be used to
689 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
690 working repository in gitweb (see linkgit:git-instaweb[1]).
693 A boolean to make git-clean do nothing unless given -f
694 or -n. Defaults to true.
697 A boolean to enable/disable color in the output of
698 linkgit:git-branch[1]. May be set to `always`,
699 `false` (or `never`) or `auto` (or `true`), in which case colors are used
700 only when the output is to a terminal. Defaults to false.
702 color.branch.<slot>::
703 Use customized color for branch coloration. `<slot>` is one of
704 `current` (the current branch), `local` (a local branch),
705 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
708 The value for these configuration variables is a list of colors (at most
709 two) and attributes (at most one), separated by spaces. The colors
710 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
711 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
712 `blink` and `reverse`. The first color given is the foreground; the
713 second is the background. The position of the attribute, if any,
717 Whether to use ANSI escape sequences to add color to patches.
718 If this is set to `always`, linkgit:git-diff[1],
719 linkgit:git-log[1], and linkgit:git-show[1] will use color
720 for all patches. If it is set to `true` or `auto`, those
721 commands will only use color when output is to the terminal.
724 This does not affect linkgit:git-format-patch[1] nor the
725 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
726 command line with the `--color[=<when>]` option.
729 Use customized color for diff colorization. `<slot>` specifies
730 which part of the patch to use the specified color, and is one
731 of `plain` (context text), `meta` (metainformation), `frag`
732 (hunk header), 'func' (function in hunk header), `old` (removed lines),
733 `new` (added lines), `commit` (commit headers), or `whitespace`
734 (highlighting whitespace errors). The values of these variables may be
735 specified as in color.branch.<slot>.
737 color.decorate.<slot>::
738 Use customized color for 'git log --decorate' output. `<slot>` is one
739 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
740 branches, remote-tracking branches, tags, stash and HEAD, respectively.
743 When set to `always`, always highlight matches. When `false` (or
744 `never`), never. When set to `true` or `auto`, use color only
745 when the output is written to the terminal. Defaults to `false`.
748 Use customized color for grep colorization. `<slot>` specifies which
749 part of the line to use the specified color, and is one of
753 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
755 filename prefix (when not using `-h`)
757 function name lines (when using `-p`)
759 line number prefix (when using `-n`)
763 non-matching text in selected lines
765 separators between fields on a line (`:`, `-`, and `=`)
766 and between hunks (`--`)
769 The values of these variables may be specified as in color.branch.<slot>.
772 When set to `always`, always use colors for interactive prompts
773 and displays (such as those used by "git-add --interactive").
774 When false (or `never`), never. When set to `true` or `auto`, use
775 colors only when the output is to the terminal. Defaults to false.
777 color.interactive.<slot>::
778 Use customized color for 'git add --interactive'
779 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
780 four distinct types of normal output from interactive
781 commands. The values of these variables may be specified as
782 in color.branch.<slot>.
785 A boolean to enable/disable colored output when the pager is in
786 use (default is true).
789 A boolean to enable/disable color in the output of
790 linkgit:git-show-branch[1]. May be set to `always`,
791 `false` (or `never`) or `auto` (or `true`), in which case colors are used
792 only when the output is to a terminal. Defaults to false.
795 A boolean to enable/disable color in the output of
796 linkgit:git-status[1]. May be set to `always`,
797 `false` (or `never`) or `auto` (or `true`), in which case colors are used
798 only when the output is to a terminal. Defaults to false.
800 color.status.<slot>::
801 Use customized color for status colorization. `<slot>` is
802 one of `header` (the header text of the status message),
803 `added` or `updated` (files which are added but not committed),
804 `changed` (files which are changed but not added in the index),
805 `untracked` (files which are not tracked by git),
806 `branch` (the current branch), or
807 `nobranch` (the color the 'no branch' warning is shown in, defaulting
808 to red). The values of these variables may be specified as in
812 This variable determines the default value for variables such
813 as `color.diff` and `color.grep` that control the use of color
814 per command family. Its scope will expand as more commands learn
815 configuration to set a default for the `--color` option. Set it
816 to `always` if you want all output not intended for machine
817 consumption to use color, to `true` or `auto` if you want such
818 output to use color when written to the terminal, or to `false` or
819 `never` if you prefer git commands not to use color unless enabled
820 explicitly with some other configuration or the `--color` option.
823 A boolean to enable/disable inclusion of status information in the
824 commit message template when using an editor to prepare the commit
825 message. Defaults to true.
828 Specify a file to use as the template for new commit messages.
829 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
830 specified user's home directory.
832 include::diff-config.txt[]
834 difftool.<tool>.path::
835 Override the path for the given tool. This is useful in case
836 your tool is not in the PATH.
838 difftool.<tool>.cmd::
839 Specify the command to invoke the specified diff tool.
840 The specified command is evaluated in shell with the following
841 variables available: 'LOCAL' is set to the name of the temporary
842 file containing the contents of the diff pre-image and 'REMOTE'
843 is set to the name of the temporary file containing the contents
844 of the diff post-image.
847 Prompt before each invocation of the diff tool.
850 A POSIX Extended Regular Expression used to determine what is a "word"
851 when performing word-by-word difference calculations. Character
852 sequences that match the regular expression are "words", all other
853 characters are *ignorable* whitespace.
855 fetch.recurseSubmodules::
856 This option can be either set to a boolean value or to 'on-demand'.
857 Setting it to a boolean changes the behavior of fetch and pull to
858 unconditionally recurse into submodules when set to true or to not
859 recurse at all when set to false. When set to 'on-demand' (the default
860 value), fetch and pull will only recurse into a populated submodule
861 when its superproject retrieves a commit that updates the submodule's
865 If the number of objects fetched over the git native
866 transfer is below this
867 limit, then the objects will be unpacked into loose object
868 files. However if the number of received objects equals or
869 exceeds this limit then the received pack will be stored as
870 a pack, after adding any missing delta bases. Storing the
871 pack from a push can make the push operation complete faster,
872 especially on slow filesystems. If not set, the value of
873 `transfer.unpackLimit` is used instead.
876 Enable multipart/mixed attachments as the default for
877 'format-patch'. The value can also be a double quoted string
878 which will enable attachments as the default and set the
879 value as the boundary. See the --attach option in
880 linkgit:git-format-patch[1].
883 A boolean which can enable or disable sequence numbers in patch
884 subjects. It defaults to "auto" which enables it only if there
885 is more than one patch. It can be enabled or disabled for all
886 messages by setting it to "true" or "false". See --numbered
887 option in linkgit:git-format-patch[1].
890 Additional email headers to include in a patch to be submitted
891 by mail. See linkgit:git-format-patch[1].
895 Additional recipients to include in a patch to be submitted
896 by mail. See the --to and --cc options in
897 linkgit:git-format-patch[1].
899 format.subjectprefix::
900 The default for format-patch is to output files with the '[PATCH]'
901 subject prefix. Use this variable to change that prefix.
904 The default for format-patch is to output a signature containing
905 the git version number. Use this variable to change that default.
906 Set this variable to the empty string ("") to suppress
907 signature generation.
910 The default for format-patch is to output files with the suffix
911 `.patch`. Use this variable to change that suffix (make sure to
912 include the dot if you want it).
915 The default pretty format for log/show/whatchanged command,
916 See linkgit:git-log[1], linkgit:git-show[1],
917 linkgit:git-whatchanged[1].
920 The default threading style for 'git format-patch'. Can be
921 a boolean value, or `shallow` or `deep`. `shallow` threading
922 makes every mail a reply to the head of the series,
923 where the head is chosen from the cover letter, the
924 `\--in-reply-to`, and the first patch mail, in this order.
925 `deep` threading makes every mail a reply to the previous one.
926 A true boolean value is the same as `shallow`, and a false
927 value disables threading.
930 A boolean value which lets you enable the `-s/--signoff` option of
931 format-patch by default. *Note:* Adding the Signed-off-by: line to a
932 patch should be a conscious act and means that you certify you have
933 the rights to submit this work under the same open source license.
934 Please see the 'SubmittingPatches' document for further discussion.
936 filter.<driver>.clean::
937 The command which is used to convert the content of a worktree
938 file to a blob upon checkin. See linkgit:gitattributes[5] for
941 filter.<driver>.smudge::
942 The command which is used to convert the content of a blob
943 object to a worktree file upon checkout. See
944 linkgit:gitattributes[5] for details.
946 gc.aggressiveWindow::
947 The window size parameter used in the delta compression
948 algorithm used by 'git gc --aggressive'. This defaults
952 When there are approximately more than this many loose
953 objects in the repository, `git gc --auto` will pack them.
954 Some Porcelain commands use this command to perform a
955 light-weight garbage collection from time to time. The
956 default value is 6700. Setting this to 0 disables it.
959 When there are more than this many packs that are not
960 marked with `*.keep` file in the repository, `git gc
961 --auto` consolidates them into one larger pack. The
962 default value is 50. Setting this to 0 disables it.
965 Running `git pack-refs` in a repository renders it
966 unclonable by Git versions prior to 1.5.1.2 over dumb
967 transports such as HTTP. This variable determines whether
968 'git gc' runs `git pack-refs`. This can be set to `notbare`
969 to enable it within all non-bare repos or it can be set to a
970 boolean value. The default is `true`.
973 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
974 Override the grace period with this config variable. The value
975 "now" may be used to disable this grace period and always prune
976 unreachable objects immediately.
979 gc.<pattern>.reflogexpire::
980 'git reflog expire' removes reflog entries older than
981 this time; defaults to 90 days. With "<pattern>" (e.g.
982 "refs/stash") in the middle the setting applies only to
983 the refs that match the <pattern>.
985 gc.reflogexpireunreachable::
986 gc.<ref>.reflogexpireunreachable::
987 'git reflog expire' removes reflog entries older than
988 this time and are not reachable from the current tip;
989 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
990 in the middle, the setting applies only to the refs that
994 Records of conflicted merge you resolved earlier are
995 kept for this many days when 'git rerere gc' is run.
996 The default is 60 days. See linkgit:git-rerere[1].
998 gc.rerereunresolved::
999 Records of conflicted merge you have not resolved are
1000 kept for this many days when 'git rerere gc' is run.
1001 The default is 15 days. See linkgit:git-rerere[1].
1003 gitcvs.commitmsgannotation::
1004 Append this string to each commit message. Set to empty string
1005 to disable this feature. Defaults to "via git-CVS emulator".
1008 Whether the CVS server interface is enabled for this repository.
1009 See linkgit:git-cvsserver[1].
1012 Path to a log file where the CVS server interface well... logs
1013 various stuff. See linkgit:git-cvsserver[1].
1015 gitcvs.usecrlfattr::
1016 If true, the server will look up the end-of-line conversion
1017 attributes for files to determine the '-k' modes to use. If
1018 the attributes force git to treat a file as text,
1019 the '-k' mode will be left blank so CVS clients will
1020 treat it as text. If they suppress text conversion, the file
1021 will be set with '-kb' mode, which suppresses any newline munging
1022 the client might otherwise do. If the attributes do not allow
1023 the file type to be determined, then 'gitcvs.allbinary' is
1024 used. See linkgit:gitattributes[5].
1027 This is used if 'gitcvs.usecrlfattr' does not resolve
1028 the correct '-kb' mode to use. If true, all
1029 unresolved files are sent to the client in
1030 mode '-kb'. This causes the client to treat them
1031 as binary files, which suppresses any newline munging it
1032 otherwise might do. Alternatively, if it is set to "guess",
1033 then the contents of the file are examined to decide if
1034 it is binary, similar to 'core.autocrlf'.
1037 Database used by git-cvsserver to cache revision information
1038 derived from the git repository. The exact meaning depends on the
1039 used database driver, for SQLite (which is the default driver) this
1040 is a filename. Supports variable substitution (see
1041 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1042 Default: '%Ggitcvs.%m.sqlite'
1045 Used Perl DBI driver. You can specify any available driver
1046 for this here, but it might not work. git-cvsserver is tested
1047 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1048 reported *not* to work with 'DBD::mysql'. Experimental feature.
1049 May not contain double colons (`:`). Default: 'SQLite'.
1050 See linkgit:git-cvsserver[1].
1052 gitcvs.dbuser, gitcvs.dbpass::
1053 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1054 since SQLite has no concept of database users and/or passwords.
1055 'gitcvs.dbuser' supports variable substitution (see
1056 linkgit:git-cvsserver[1] for details).
1058 gitcvs.dbTableNamePrefix::
1059 Database table name prefix. Prepended to the names of any
1060 database tables used, allowing a single database to be used
1061 for several repositories. Supports variable substitution (see
1062 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1063 characters will be replaced with underscores.
1065 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1066 'gitcvs.allbinary' can also be specified as
1067 'gitcvs.<access_method>.<varname>' (where 'access_method'
1068 is one of "ext" and "pserver") to make them apply only for the given
1072 If set to true, enable '-n' option by default.
1074 grep.extendedRegexp::
1075 If set to true, enable '--extended-regexp' option by default.
1077 gui.commitmsgwidth::
1078 Defines how wide the commit message window is in the
1079 linkgit:git-gui[1]. "75" is the default.
1082 Specifies how many context lines should be used in calls to diff
1083 made by the linkgit:git-gui[1]. The default is "5".
1086 Specifies the default encoding to use for displaying of
1087 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1088 It can be overridden by setting the 'encoding' attribute
1089 for relevant files (see linkgit:gitattributes[5]).
1090 If this option is not set, the tools default to the
1093 gui.matchtrackingbranch::
1094 Determines if new branches created with linkgit:git-gui[1] should
1095 default to tracking remote branches with matching names or
1096 not. Default: "false".
1098 gui.newbranchtemplate::
1099 Is used as suggested name when creating new branches using the
1102 gui.pruneduringfetch::
1103 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1104 performing a fetch. The default value is "false".
1107 Determines if linkgit:git-gui[1] should trust the file modification
1108 timestamp or not. By default the timestamps are not trusted.
1110 gui.spellingdictionary::
1111 Specifies the dictionary used for spell checking commit messages in
1112 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1116 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1117 location detection. It makes blame significantly faster on huge
1118 repositories at the expense of less thorough copy detection.
1120 gui.copyblamethreshold::
1121 Specifies the threshold to use in 'git gui blame' original location
1122 detection, measured in alphanumeric characters. See the
1123 linkgit:git-blame[1] manual for more information on copy detection.
1125 gui.blamehistoryctx::
1126 Specifies the radius of history context in days to show in
1127 linkgit:gitk[1] for the selected commit, when the `Show History
1128 Context` menu item is invoked from 'git gui blame'. If this
1129 variable is set to zero, the whole history is shown.
1131 guitool.<name>.cmd::
1132 Specifies the shell command line to execute when the corresponding item
1133 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1134 mandatory for every tool. The command is executed from the root of
1135 the working directory, and in the environment it receives the name of
1136 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1137 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1138 the head is detached, 'CUR_BRANCH' is empty).
1140 guitool.<name>.needsfile::
1141 Run the tool only if a diff is selected in the GUI. It guarantees
1142 that 'FILENAME' is not empty.
1144 guitool.<name>.noconsole::
1145 Run the command silently, without creating a window to display its
1148 guitool.<name>.norescan::
1149 Don't rescan the working directory for changes after the tool
1152 guitool.<name>.confirm::
1153 Show a confirmation dialog before actually running the tool.
1155 guitool.<name>.argprompt::
1156 Request a string argument from the user, and pass it to the tool
1157 through the 'ARGS' environment variable. Since requesting an
1158 argument implies confirmation, the 'confirm' option has no effect
1159 if this is enabled. If the option is set to 'true', 'yes', or '1',
1160 the dialog uses a built-in generic prompt; otherwise the exact
1161 value of the variable is used.
1163 guitool.<name>.revprompt::
1164 Request a single valid revision from the user, and set the
1165 'REVISION' environment variable. In other aspects this option
1166 is similar to 'argprompt', and can be used together with it.
1168 guitool.<name>.revunmerged::
1169 Show only unmerged branches in the 'revprompt' subdialog.
1170 This is useful for tools similar to merge or rebase, but not
1171 for things like checkout or reset.
1173 guitool.<name>.title::
1174 Specifies the title to use for the prompt dialog. The default
1177 guitool.<name>.prompt::
1178 Specifies the general prompt string to display at the top of
1179 the dialog, before subsections for 'argprompt' and 'revprompt'.
1180 The default value includes the actual command.
1183 Specify the browser that will be used to display help in the
1184 'web' format. See linkgit:git-help[1].
1187 Override the default help format used by linkgit:git-help[1].
1188 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1189 the default. 'web' and 'html' are the same.
1192 Automatically correct and execute mistyped commands after
1193 waiting for the given number of deciseconds (0.1 sec). If more
1194 than one command can be deduced from the entered text, nothing
1195 will be executed. If the value of this option is negative,
1196 the corrected command will be executed immediately. If the
1197 value is 0 - the command will be just shown but not executed.
1198 This is the default.
1201 Override the HTTP proxy, normally configured using the 'http_proxy'
1202 environment variable (see linkgit:curl[1]). This can be overridden
1203 on a per-remote basis; see remote.<name>.proxy
1206 Whether to verify the SSL certificate when fetching or pushing
1207 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1211 File containing the SSL certificate when fetching or pushing
1212 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1216 File containing the SSL private key when fetching or pushing
1217 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1220 http.sslCertPasswordProtected::
1221 Enable git's password prompt for the SSL certificate. Otherwise
1222 OpenSSL will prompt the user, possibly many times, if the
1223 certificate or private key is encrypted. Can be overridden by the
1224 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1227 File containing the certificates to verify the peer with when
1228 fetching or pushing over HTTPS. Can be overridden by the
1229 'GIT_SSL_CAINFO' environment variable.
1232 Path containing files with the CA certificates to verify the peer
1233 with when fetching or pushing over HTTPS. Can be overridden
1234 by the 'GIT_SSL_CAPATH' environment variable.
1237 How many HTTP requests to launch in parallel. Can be overridden
1238 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1241 The number of curl sessions (counted across slots) to be kept across
1242 requests. They will not be ended with curl_easy_cleanup() until
1243 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1244 value will be capped at 1. Defaults to 1.
1247 Maximum size in bytes of the buffer used by smart HTTP
1248 transports when POSTing data to the remote system.
1249 For requests larger than this buffer size, HTTP/1.1 and
1250 Transfer-Encoding: chunked is used to avoid creating a
1251 massive pack file locally. Default is 1 MiB, which is
1252 sufficient for most requests.
1254 http.lowSpeedLimit, http.lowSpeedTime::
1255 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1256 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1257 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1258 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1261 A boolean which disables using of EPSV ftp command by curl.
1262 This can helpful with some "poor" ftp servers which don't
1263 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1264 environment variable. Default is false (curl will use EPSV).
1267 The HTTP USER_AGENT string presented to an HTTP server. The default
1268 value represents the version of the client git such as git/1.7.1.
1269 This option allows you to override this value to a more common value
1270 such as Mozilla/4.0. This may be necessary, for instance, if
1271 connecting through a firewall that restricts HTTP connections to a set
1272 of common USER_AGENT strings (but not including those like git/1.7.1).
1273 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1275 i18n.commitEncoding::
1276 Character encoding the commit messages are stored in; git itself
1277 does not care per se, but this information is necessary e.g. when
1278 importing commits from emails or in the gitk graphical history
1279 browser (and possibly at other places in the future or in other
1280 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1282 i18n.logOutputEncoding::
1283 Character encoding the commit messages are converted to when
1284 running 'git log' and friends.
1287 The configuration variables in the 'imap' section are described
1288 in linkgit:git-imap-send[1].
1291 Specify the directory from which templates will be copied.
1292 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1295 Specify the program that will be used to browse your working
1296 repository in gitweb. See linkgit:git-instaweb[1].
1299 The HTTP daemon command-line to start gitweb on your working
1300 repository. See linkgit:git-instaweb[1].
1303 If true the web server started by linkgit:git-instaweb[1] will
1304 be bound to the local IP (127.0.0.1).
1306 instaweb.modulepath::
1307 The default module path for linkgit:git-instaweb[1] to use
1308 instead of /usr/lib/apache2/modules. Only used if httpd
1312 The port number to bind the gitweb httpd to. See
1313 linkgit:git-instaweb[1].
1315 interactive.singlekey::
1316 In interactive commands, allow the user to provide one-letter
1317 input with a single key (i.e., without hitting enter).
1318 Currently this is used by the `\--patch` mode of
1319 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1320 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1321 setting is silently ignored if portable keystroke input
1325 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1326 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1327 override this option with `\--no-abbrev-commit`.
1330 Set the default date-time mode for the 'log' command.
1331 Setting a value for log.date is similar to using 'git log''s
1332 `\--date` option. Possible values are `relative`, `local`,
1333 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1337 Print out the ref names of any commits that are shown by the log
1338 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1339 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1340 specified, the full ref name (including prefix) will be printed.
1341 This is the same as the log commands '--decorate' option.
1344 If true, the initial commit will be shown as a big creation event.
1345 This is equivalent to a diff against an empty tree.
1346 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1347 normally hide the root commit will now show it. True by default.
1350 The location of an augmenting mailmap file. The default
1351 mailmap, located in the root of the repository, is loaded
1352 first, then the mailmap file pointed to by this variable.
1353 The location of the mailmap file may be in a repository
1354 subdirectory, or somewhere outside of the repository itself.
1355 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1358 Specify the programs that may be used to display help in the
1359 'man' format. See linkgit:git-help[1].
1362 Specify the command to invoke the specified man viewer. The
1363 specified command is evaluated in shell with the man page
1364 passed as argument. (See linkgit:git-help[1].)
1367 Override the path for the given tool that may be used to
1368 display help in the 'man' format. See linkgit:git-help[1].
1370 include::merge-config.txt[]
1372 mergetool.<tool>.path::
1373 Override the path for the given tool. This is useful in case
1374 your tool is not in the PATH.
1376 mergetool.<tool>.cmd::
1377 Specify the command to invoke the specified merge tool. The
1378 specified command is evaluated in shell with the following
1379 variables available: 'BASE' is the name of a temporary file
1380 containing the common base of the files to be merged, if available;
1381 'LOCAL' is the name of a temporary file containing the contents of
1382 the file on the current branch; 'REMOTE' is the name of a temporary
1383 file containing the contents of the file from the branch being
1384 merged; 'MERGED' contains the name of the file to which the merge
1385 tool should write the results of a successful merge.
1387 mergetool.<tool>.trustExitCode::
1388 For a custom merge command, specify whether the exit code of
1389 the merge command can be used to determine whether the merge was
1390 successful. If this is not set to true then the merge target file
1391 timestamp is checked and the merge assumed to have been successful
1392 if the file has been updated, otherwise the user is prompted to
1393 indicate the success of the merge.
1395 mergetool.keepBackup::
1396 After performing a merge, the original file with conflict markers
1397 can be saved as a file with a `.orig` extension. If this variable
1398 is set to `false` then this file is not preserved. Defaults to
1399 `true` (i.e. keep the backup files).
1401 mergetool.keepTemporaries::
1402 When invoking a custom merge tool, git uses a set of temporary
1403 files to pass to the tool. If the tool returns an error and this
1404 variable is set to `true`, then these temporary files will be
1405 preserved, otherwise they will be removed after the tool has
1406 exited. Defaults to `false`.
1409 Prompt before each invocation of the merge resolution program.
1412 The (fully qualified) refname from which to show notes when
1413 showing commit messages. The value of this variable can be set
1414 to a glob, in which case notes from all matching refs will be
1415 shown. You may also specify this configuration variable
1416 several times. A warning will be issued for refs that do not
1417 exist, but a glob that does not match any refs is silently
1420 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1421 environment variable, which must be a colon separated list of refs or
1424 The effective value of "core.notesRef" (possibly overridden by
1425 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1428 notes.rewrite.<command>::
1429 When rewriting commits with <command> (currently `amend` or
1430 `rebase`) and this variable is set to `true`, git
1431 automatically copies your notes from the original to the
1432 rewritten commit. Defaults to `true`, but see
1433 "notes.rewriteRef" below.
1436 When copying notes during a rewrite (see the
1437 "notes.rewrite.<command>" option), determines what to do if
1438 the target commit already has a note. Must be one of
1439 `overwrite`, `concatenate`, or `ignore`. Defaults to
1442 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1443 environment variable.
1446 When copying notes during a rewrite, specifies the (fully
1447 qualified) ref whose notes should be copied. The ref may be a
1448 glob, in which case notes in all matching refs will be copied.
1449 You may also specify this configuration several times.
1451 Does not have a default value; you must configure this variable to
1452 enable note rewriting.
1454 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1455 environment variable, which must be a colon separated list of refs or
1459 The size of the window used by linkgit:git-pack-objects[1] when no
1460 window size is given on the command line. Defaults to 10.
1463 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1464 maximum depth is given on the command line. Defaults to 50.
1467 The window memory size limit used by linkgit:git-pack-objects[1]
1468 when no limit is given on the command line. The value can be
1469 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1473 An integer -1..9, indicating the compression level for objects
1474 in a pack file. -1 is the zlib default. 0 means no
1475 compression, and 1..9 are various speed/size tradeoffs, 9 being
1476 slowest. If not set, defaults to core.compression. If that is
1477 not set, defaults to -1, the zlib default, which is "a default
1478 compromise between speed and compression (currently equivalent
1481 Note that changing the compression level will not automatically recompress
1482 all existing objects. You can force recompression by passing the -F option
1483 to linkgit:git-repack[1].
1485 pack.deltaCacheSize::
1486 The maximum memory in bytes used for caching deltas in
1487 linkgit:git-pack-objects[1] before writing them out to a pack.
1488 This cache is used to speed up the writing object phase by not
1489 having to recompute the final delta result once the best match
1490 for all objects is found. Repacking large repositories on machines
1491 which are tight with memory might be badly impacted by this though,
1492 especially if this cache pushes the system into swapping.
1493 A value of 0 means no limit. The smallest size of 1 byte may be
1494 used to virtually disable this cache. Defaults to 256 MiB.
1496 pack.deltaCacheLimit::
1497 The maximum size of a delta, that is cached in
1498 linkgit:git-pack-objects[1]. This cache is used to speed up the
1499 writing object phase by not having to recompute the final delta
1500 result once the best match for all objects is found. Defaults to 1000.
1503 Specifies the number of threads to spawn when searching for best
1504 delta matches. This requires that linkgit:git-pack-objects[1]
1505 be compiled with pthreads otherwise this option is ignored with a
1506 warning. This is meant to reduce packing time on multiprocessor
1507 machines. The required amount of memory for the delta search window
1508 is however multiplied by the number of threads.
1509 Specifying 0 will cause git to auto-detect the number of CPU's
1510 and set the number of threads accordingly.
1513 Specify the default pack index version. Valid values are 1 for
1514 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1515 the new pack index with capabilities for packs larger than 4 GB
1516 as well as proper protection against the repacking of corrupted
1517 packs. Version 2 is the default. Note that version 2 is enforced
1518 and this config option ignored whenever the corresponding pack is
1521 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1522 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1523 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1524 other side may give you a repository that cannot be accessed with your
1525 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1526 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1527 the `{asterisk}.idx` file.
1529 pack.packSizeLimit::
1530 The maximum size of a pack. This setting only affects
1531 packing to a file when repacking, i.e. the git:// protocol
1532 is unaffected. It can be overridden by the `\--max-pack-size`
1533 option of linkgit:git-repack[1]. The minimum size allowed is
1534 limited to 1 MiB. The default is unlimited.
1535 Common unit suffixes of 'k', 'm', or 'g' are
1539 If the value is boolean, turns on or off pagination of the
1540 output of a particular git subcommand when writing to a tty.
1541 Otherwise, turns on pagination for the subcommand using the
1542 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1543 or `\--no-pager` is specified on the command line, it takes
1544 precedence over this option. To disable pagination for all
1545 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1548 Alias for a --pretty= format string, as specified in
1549 linkgit:git-log[1]. Any aliases defined here can be used just
1550 as the built-in pretty formats could. For example,
1551 running `git config pretty.changelog "format:{asterisk} %H %s"`
1552 would cause the invocation `git log --pretty=changelog`
1553 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1554 Note that an alias with the same name as a built-in format
1555 will be silently ignored.
1558 The default merge strategy to use when pulling multiple branches
1562 The default merge strategy to use when pulling a single branch.
1565 Defines the action git push should take if no refspec is given
1566 on the command line, no refspec is configured in the remote, and
1567 no refspec is implied by any of the options given on the command
1568 line. Possible values are:
1570 * `nothing` - do not push anything.
1571 * `matching` - push all matching branches.
1572 All branches having the same name in both ends are considered to be
1573 matching. This is the default.
1574 * `upstream` - push the current branch to its upstream branch.
1575 * `tracking` - deprecated synonym for `upstream`.
1576 * `current` - push the current branch to a branch of the same name.
1579 Whether to show a diffstat of what changed upstream since the last
1580 rebase. False by default.
1583 If set to true enable '--autosquash' option by default.
1586 By default, git-receive-pack will run "git-gc --auto" after
1587 receiving data from git-push and updating refs. You can stop
1588 it by setting this variable to false.
1590 receive.fsckObjects::
1591 If it is set to true, git-receive-pack will check all received
1592 objects. It will abort in the case of a malformed object or a
1593 broken link. The result of an abort are only dangling objects.
1596 receive.unpackLimit::
1597 If the number of objects received in a push is below this
1598 limit then the objects will be unpacked into loose object
1599 files. However if the number of received objects equals or
1600 exceeds this limit then the received pack will be stored as
1601 a pack, after adding any missing delta bases. Storing the
1602 pack from a push can make the push operation complete faster,
1603 especially on slow filesystems. If not set, the value of
1604 `transfer.unpackLimit` is used instead.
1606 receive.denyDeletes::
1607 If set to true, git-receive-pack will deny a ref update that deletes
1608 the ref. Use this to prevent such a ref deletion via a push.
1610 receive.denyDeleteCurrent::
1611 If set to true, git-receive-pack will deny a ref update that
1612 deletes the currently checked out branch of a non-bare repository.
1614 receive.denyCurrentBranch::
1615 If set to true or "refuse", git-receive-pack will deny a ref update
1616 to the currently checked out branch of a non-bare repository.
1617 Such a push is potentially dangerous because it brings the HEAD
1618 out of sync with the index and working tree. If set to "warn",
1619 print a warning of such a push to stderr, but allow the push to
1620 proceed. If set to false or "ignore", allow such pushes with no
1621 message. Defaults to "refuse".
1623 There are two more options that are meant for Git experts: "updateInstead"
1624 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1625 the HEAD so it does not need to change. Both options come with their own
1626 set of possible *complications*, but can be appropriate in rare workflows.
1628 receive.denyNonFastForwards::
1629 If set to true, git-receive-pack will deny a ref update which is
1630 not a fast-forward. Use this to prevent such an update via a push,
1631 even if that push is forced. This configuration variable is
1632 set when initializing a shared repository.
1634 receive.updateserverinfo::
1635 If set to true, git-receive-pack will run git-update-server-info
1636 after receiving data from git-push and updating refs.
1639 The URL of a remote repository. See linkgit:git-fetch[1] or
1640 linkgit:git-push[1].
1642 remote.<name>.pushurl::
1643 The push URL of a remote repository. See linkgit:git-push[1].
1645 remote.<name>.proxy::
1646 For remotes that require curl (http, https and ftp), the URL to
1647 the proxy to use for that remote. Set to the empty string to
1648 disable proxying for that remote.
1650 remote.<name>.fetch::
1651 The default set of "refspec" for linkgit:git-fetch[1]. See
1652 linkgit:git-fetch[1].
1654 remote.<name>.push::
1655 The default set of "refspec" for linkgit:git-push[1]. See
1656 linkgit:git-push[1].
1658 remote.<name>.mirror::
1659 If true, pushing to this remote will automatically behave
1660 as if the `\--mirror` option was given on the command line.
1662 remote.<name>.skipDefaultUpdate::
1663 If true, this remote will be skipped by default when updating
1664 using linkgit:git-fetch[1] or the `update` subcommand of
1665 linkgit:git-remote[1].
1667 remote.<name>.skipFetchAll::
1668 If true, this remote will be skipped by default when updating
1669 using linkgit:git-fetch[1] or the `update` subcommand of
1670 linkgit:git-remote[1].
1672 remote.<name>.receivepack::
1673 The default program to execute on the remote side when pushing. See
1674 option \--receive-pack of linkgit:git-push[1].
1676 remote.<name>.uploadpack::
1677 The default program to execute on the remote side when fetching. See
1678 option \--upload-pack of linkgit:git-fetch-pack[1].
1680 remote.<name>.tagopt::
1681 Setting this value to \--no-tags disables automatic tag following when
1682 fetching from remote <name>. Setting it to \--tags will fetch every
1683 tag from remote <name>, even if they are not reachable from remote
1684 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1685 override this setting. See options \--tags and \--no-tags of
1686 linkgit:git-fetch[1].
1689 Setting this to a value <vcs> will cause git to interact with
1690 the remote with the git-remote-<vcs> helper.
1693 The list of remotes which are fetched by "git remote update
1694 <group>". See linkgit:git-remote[1].
1696 repack.usedeltabaseoffset::
1697 By default, linkgit:git-repack[1] creates packs that use
1698 delta-base offset. If you need to share your repository with
1699 git older than version 1.4.4, either directly or via a dumb
1700 protocol such as http, then you need to set this option to
1701 "false" and repack. Access from old git versions over the
1702 native protocol are unaffected by this option.
1705 When set to true, `git-rerere` updates the index with the
1706 resulting contents after it cleanly resolves conflicts using
1707 previously recorded resolution. Defaults to false.
1710 Activate recording of resolved conflicts, so that identical
1711 conflict hunks can be resolved automatically, should they
1712 be encountered again. linkgit:git-rerere[1] command is by
1713 default enabled if you create `rr-cache` directory under
1714 `$GIT_DIR`, but can be disabled by setting this option to false.
1716 sendemail.identity::
1717 A configuration identity. When given, causes values in the
1718 'sendemail.<identity>' subsection to take precedence over
1719 values in the 'sendemail' section. The default identity is
1720 the value of 'sendemail.identity'.
1722 sendemail.smtpencryption::
1723 See linkgit:git-send-email[1] for description. Note that this
1724 setting is not subject to the 'identity' mechanism.
1727 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1729 sendemail.<identity>.*::
1730 Identity-specific versions of the 'sendemail.*' parameters
1731 found below, taking precedence over those when the this
1732 identity is selected, through command-line or
1733 'sendemail.identity'.
1735 sendemail.aliasesfile::
1736 sendemail.aliasfiletype::
1740 sendemail.chainreplyto::
1742 sendemail.envelopesender::
1744 sendemail.multiedit::
1745 sendemail.signedoffbycc::
1746 sendemail.smtppass::
1747 sendemail.suppresscc::
1748 sendemail.suppressfrom::
1750 sendemail.smtpdomain::
1751 sendemail.smtpserver::
1752 sendemail.smtpserverport::
1753 sendemail.smtpserveroption::
1754 sendemail.smtpuser::
1756 sendemail.validate::
1757 See linkgit:git-send-email[1] for description.
1759 sendemail.signedoffcc::
1760 Deprecated alias for 'sendemail.signedoffbycc'.
1762 showbranch.default::
1763 The default set of branches for linkgit:git-show-branch[1].
1764 See linkgit:git-show-branch[1].
1766 status.relativePaths::
1767 By default, linkgit:git-status[1] shows paths relative to the
1768 current directory. Setting this variable to `false` shows paths
1769 relative to the repository root (this was the default for git
1772 status.showUntrackedFiles::
1773 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1774 files which are not currently tracked by Git. Directories which
1775 contain only untracked files, are shown with the directory name
1776 only. Showing untracked files means that Git needs to lstat() all
1777 all the files in the whole repository, which might be slow on some
1778 systems. So, this variable controls how the commands displays
1779 the untracked files. Possible values are:
1782 * `no` - Show no untracked files.
1783 * `normal` - Show untracked files and directories.
1784 * `all` - Show also individual files in untracked directories.
1787 If this variable is not specified, it defaults to 'normal'.
1788 This variable can be overridden with the -u|--untracked-files option
1789 of linkgit:git-status[1] and linkgit:git-commit[1].
1791 status.submodulesummary::
1793 If this is set to a non zero number or true (identical to -1 or an
1794 unlimited number), the submodule summary will be enabled and a
1795 summary of commits for modified submodules will be shown (see
1796 --summary-limit option of linkgit:git-submodule[1]).
1798 submodule.<name>.path::
1799 submodule.<name>.url::
1800 submodule.<name>.update::
1801 The path within this project, URL, and the updating strategy
1802 for a submodule. These variables are initially populated
1803 by 'git submodule init'; edit them to override the
1804 URL and other values found in the `.gitmodules` file. See
1805 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1807 submodule.<name>.fetchRecurseSubmodules::
1808 This option can be used to control recursive fetching of this
1809 submodule. It can be overridden by using the --[no-]recurse-submodules
1810 command line option to "git fetch" and "git pull".
1811 This setting will override that from in the linkgit:gitmodules[5]
1814 submodule.<name>.ignore::
1815 Defines under what circumstances "git status" and the diff family show
1816 a submodule as modified. When set to "all", it will never be considered
1817 modified, "dirty" will ignore all changes to the submodules work tree and
1818 takes only differences between the HEAD of the submodule and the commit
1819 recorded in the superproject into account. "untracked" will additionally
1820 let submodules with modified tracked files in their work tree show up.
1821 Using "none" (the default when this option is not set) also shows
1822 submodules that have untracked files in their work tree as changed.
1823 This setting overrides any setting made in .gitmodules for this submodule,
1824 both settings can be overridden on the command line by using the
1825 "--ignore-submodules" option.
1828 This variable can be used to restrict the permission bits of
1829 tar archive entries. The default is 0002, which turns off the
1830 world write bit. The special value "user" indicates that the
1831 archiving user's umask will be used instead. See umask(2) and
1832 linkgit:git-archive[1].
1834 transfer.unpackLimit::
1835 When `fetch.unpackLimit` or `receive.unpackLimit` are
1836 not set, the value of this variable is used instead.
1837 The default value is 100.
1839 url.<base>.insteadOf::
1840 Any URL that starts with this value will be rewritten to
1841 start, instead, with <base>. In cases where some site serves a
1842 large number of repositories, and serves them with multiple
1843 access methods, and some users need to use different access
1844 methods, this feature allows people to specify any of the
1845 equivalent URLs and have git automatically rewrite the URL to
1846 the best alternative for the particular user, even for a
1847 never-before-seen repository on the site. When more than one
1848 insteadOf strings match a given URL, the longest match is used.
1850 url.<base>.pushInsteadOf::
1851 Any URL that starts with this value will not be pushed to;
1852 instead, it will be rewritten to start with <base>, and the
1853 resulting URL will be pushed to. In cases where some site serves
1854 a large number of repositories, and serves them with multiple
1855 access methods, some of which do not allow push, this feature
1856 allows people to specify a pull-only URL and have git
1857 automatically use an appropriate URL to push, even for a
1858 never-before-seen repository on the site. When more than one
1859 pushInsteadOf strings match a given URL, the longest match is
1860 used. If a remote has an explicit pushurl, git will ignore this
1861 setting for that remote.
1864 Your email address to be recorded in any newly created commits.
1865 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1866 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1869 Your full name to be recorded in any newly created commits.
1870 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1871 environment variables. See linkgit:git-commit-tree[1].
1874 If linkgit:git-tag[1] is not selecting the key you want it to
1875 automatically when creating a signed tag, you can override the
1876 default selection with this variable. This option is passed
1877 unchanged to gpg's --local-user parameter, so you may specify a key
1878 using any method that gpg supports.
1881 Specify a web browser that may be used by some commands.
1882 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]