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 deprecated `[section.subsection]` syntax. With this
49 syntax, the subsection name is converted to lower-case and is also
50 compared case sensitively. These subsection names follow the same
51 restrictions as section names.
53 All the other lines (and the remainder of the line after the section
54 header) are recognized as setting variables, in the form
55 'name = value'. If there is no equal sign on the line, the entire line
56 is taken as 'name' and the variable is recognized as boolean "true".
57 The variable names are case-insensitive and only alphanumeric
58 characters and `-` are allowed. There can be more than one value
59 for a given variable; we say then that variable is multivalued.
61 Leading and trailing whitespace in a variable value is discarded.
62 Internal whitespace within a variable value is retained verbatim.
64 The values following the equals sign in variable assign are all either
65 a string, an integer, or a boolean. Boolean values may be given as yes/no,
66 1/0, true/false or on/off. Case is not significant in boolean values, when
67 converting value to the canonical form using '--bool' type specifier;
68 'git config' will ensure that the output is "true" or "false".
70 String values may be entirely or partially enclosed in double quotes.
71 You need to enclose variable values in double quotes if you want to
72 preserve leading or trailing whitespace, or if the variable value contains
73 comment characters (i.e. it contains '#' or ';').
74 Double quote `"` and backslash `\` characters in variable values must
75 be escaped: use `\"` for `"` and `\\` for `\`.
77 The following escape sequences (beside `\"` and `\\`) are recognized:
78 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
79 and `\b` for backspace (BS). No other char escape sequence, nor octal
80 char sequences are valid.
82 Variable values ending in a `\` are continued on the next line in the
83 customary UNIX fashion.
85 Some variables may require a special value format.
92 ; Don't trust file modes
97 external = /usr/local/bin/diff-wrapper
102 merge = refs/heads/devel
106 gitProxy="ssh" for "kernel.org"
107 gitProxy=default-proxy ; for the rest
112 Note that this list is non-comprehensive and not necessarily complete.
113 For command-specific variables, you will find a more detailed description
114 in the appropriate manual page. You will find a description of non-core
115 porcelain configuration variables in the respective porcelain documentation.
118 When set to 'true', display the given optional help message.
119 When set to 'false', do not display. The configuration variables
124 Advice shown when linkgit:git-push[1] refuses
125 non-fast-forward refs. Default: true.
127 Directions on how to stage/unstage/add shown in the
128 output of linkgit:git-status[1] and the template shown
129 when writing commit messages. Default: true.
131 Advice shown when linkgit:git-merge[1] refuses to
132 merge to avoid overwriting local changes.
135 Advices shown by various commands when conflicts
136 prevent the operation from being performed.
139 Advice on how to set your identity configuration when
140 your information is guessed from the system username and
141 domain name. Default: true.
144 Advice shown when you used linkgit::git-checkout[1] to
145 move to the detach HEAD state, to instruct how to create
146 a local branch after the fact. Default: true.
150 If false, the executable bit differences between the index and
151 the working tree are ignored; useful on broken filesystems like FAT.
152 See linkgit:git-update-index[1].
154 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
155 will probe and set core.fileMode false if appropriate when the
156 repository is created.
158 core.ignoreCygwinFSTricks::
159 This option is only used by Cygwin implementation of Git. If false,
160 the Cygwin stat() and lstat() functions are used. This may be useful
161 if your repository consists of a few separate directories joined in
162 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
163 whenever it is possible and falls back to Cygwin functions only to
164 handle symbol links. The native mode is more than twice faster than
165 normal Cygwin l/stat() functions. True by default, unless core.filemode
166 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
167 POSIX emulation is required to support core.filemode.
170 If true, this option enables various workarounds to enable
171 git to work better on filesystems that are not case sensitive,
172 like FAT. For example, if a directory listing finds
173 "makefile" when git expects "Makefile", git will assume
174 it is really the same file, and continue to remember it as
177 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
178 will probe and set core.ignorecase true if appropriate when the repository
182 If false, the ctime differences between the index and the
183 working tree are ignored; useful when the inode change time
184 is regularly modified by something outside Git (file system
185 crawlers and some backup systems).
186 See linkgit:git-update-index[1]. True by default.
189 The commands that output paths (e.g. 'ls-files',
190 'diff'), when not given the `-z` option, will quote
191 "unusual" characters in the pathname by enclosing the
192 pathname in a double-quote pair and with backslashes the
193 same way strings in C source code are quoted. If this
194 variable is set to false, the bytes higher than 0x80 are
195 not quoted but output as verbatim. Note that double
196 quote, backslash and control characters are always
197 quoted without `-z` regardless of the setting of this
201 Sets the line ending type to use in the working directory for
202 files that have the `text` property set. Alternatives are
203 'lf', 'crlf' and 'native', which uses the platform's native
204 line ending. The default value is `native`. See
205 linkgit:gitattributes[5] for more information on end-of-line
209 If true, makes git check if converting `CRLF` is reversible when
210 end-of-line conversion is active. Git will verify if a command
211 modifies a file in the work tree either directly or indirectly.
212 For example, committing a file followed by checking out the
213 same file should yield the original file in the work tree. If
214 this is not the case for the current setting of
215 `core.autocrlf`, git will reject the file. The variable can
216 be set to "warn", in which case git will only warn about an
217 irreversible conversion but continue the operation.
219 CRLF conversion bears a slight chance of corrupting data.
220 When it is enabled, git will convert CRLF to LF during commit and LF to
221 CRLF during checkout. A file that contains a mixture of LF and
222 CRLF before the commit cannot be recreated by git. For text
223 files this is the right thing to do: it corrects line endings
224 such that we have only LF line endings in the repository.
225 But for binary files that are accidentally classified as text the
226 conversion can corrupt data.
228 If you recognize such corruption early you can easily fix it by
229 setting the conversion type explicitly in .gitattributes. Right
230 after committing you still have the original file in your work
231 tree and this file is not yet corrupted. You can explicitly tell
232 git that this file is binary and git will handle the file
235 Unfortunately, the desired effect of cleaning up text files with
236 mixed line endings and the undesired effect of corrupting binary
237 files cannot be distinguished. In both cases CRLFs are removed
238 in an irreversible way. For text files this is the right thing
239 to do because CRLFs are line endings, while for binary files
240 converting CRLFs corrupts data.
242 Note, this safety check does not mean that a checkout will generate a
243 file identical to the original file for a different setting of
244 `core.eol` and `core.autocrlf`, but only for the current one. For
245 example, a text file with `LF` would be accepted with `core.eol=lf`
246 and could later be checked out with `core.eol=crlf`, in which case the
247 resulting file would contain `CRLF`, although the original file
248 contained `LF`. However, in both work trees the line endings would be
249 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
250 file with mixed line endings would be reported by the `core.safecrlf`
254 Setting this variable to "true" is almost the same as setting
255 the `text` attribute to "auto" on all files except that text
256 files are not guaranteed to be normalized: files that contain
257 `CRLF` in the repository will not be touched. Use this
258 setting if you want to have `CRLF` line endings in your
259 working directory even though the repository does not have
260 normalized line endings. This variable can be set to 'input',
261 in which case no output conversion is performed.
264 If false, symbolic links are checked out as small plain files that
265 contain the link text. linkgit:git-update-index[1] and
266 linkgit:git-add[1] will not change the recorded type to regular
267 file. Useful on filesystems like FAT that do not support
270 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
271 will probe and set core.symlinks false if appropriate when the repository
275 A "proxy command" to execute (as 'command host port') instead
276 of establishing direct connection to the remote server when
277 using the git protocol for fetching. If the variable value is
278 in the "COMMAND for DOMAIN" format, the command is applied only
279 on hostnames ending with the specified domain string. This variable
280 may be set multiple times and is matched in the given order;
281 the first match wins.
283 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
284 (which always applies universally, without the special "for"
287 The special string `none` can be used as the proxy command to
288 specify that no proxy be used for a given domain pattern.
289 This is useful for excluding servers inside a firewall from
290 proxy use, while defaulting to a common proxy for external domains.
293 If true, commands which modify both the working tree and the index
294 will mark the updated paths with the "assume unchanged" bit in the
295 index. These marked files are then assumed to stay unchanged in the
296 working tree, until you mark them otherwise manually - Git will not
297 detect the file changes by lstat() calls. This is useful on systems
298 where those are very slow, such as Microsoft Windows.
299 See linkgit:git-update-index[1].
302 core.preferSymlinkRefs::
303 Instead of the default "symref" format for HEAD
304 and other symbolic reference files, use symbolic links.
305 This is sometimes needed to work with old scripts that
306 expect HEAD to be a symbolic link.
309 If true this repository is assumed to be 'bare' and has no
310 working directory associated with it. If this is the case a
311 number of commands that require a working directory will be
312 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
314 This setting is automatically guessed by linkgit:git-clone[1] or
315 linkgit:git-init[1] when the repository was created. By default a
316 repository that ends in "/.git" is assumed to be not bare (bare =
317 false), while all other repositories are assumed to be bare (bare
321 Set the path to the root of the working tree.
322 This can be overridden by the GIT_WORK_TREE environment
323 variable and the '--work-tree' command line option.
324 The value can be an absolute path or relative to the path to
325 the .git directory, which is either specified by --git-dir
326 or GIT_DIR, or automatically discovered.
327 If --git-dir or GIT_DIR is specified but none of
328 --work-tree, GIT_WORK_TREE and core.worktree is specified,
329 the current working directory is regarded as the top level
330 of your working tree.
332 Note that this variable is honored even when set in a configuration
333 file in a ".git" subdirectory of a directory and its value differs
334 from the latter directory (e.g. "/path/to/.git/config" has
335 core.worktree set to "/different/path"), which is most likely a
336 misconfiguration. Running git commands in the "/path/to" directory will
337 still use "/different/path" as the root of the work tree and can cause
338 confusion unless you know what you are doing (e.g. you are creating a
339 read-only snapshot of the same index to a location different from the
340 repository's usual working tree).
342 core.logAllRefUpdates::
343 Enable the reflog. Updates to a ref <ref> is logged to the file
344 "$GIT_DIR/logs/<ref>", by appending the new and old
345 SHA1, the date/time and the reason of the update, but
346 only when the file exists. If this configuration
347 variable is set to true, missing "$GIT_DIR/logs/<ref>"
348 file is automatically created for branch heads (i.e. under
349 refs/heads/), remote refs (i.e. under refs/remotes/),
350 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
352 This information can be used to determine what commit
353 was the tip of a branch "2 days ago".
355 This value is true by default in a repository that has
356 a working directory associated with it, and false by
357 default in a bare repository.
359 core.repositoryFormatVersion::
360 Internal variable identifying the repository format and layout
363 core.sharedRepository::
364 When 'group' (or 'true'), the repository is made shareable between
365 several users in a group (making sure all the files and objects are
366 group-writable). When 'all' (or 'world' or 'everybody'), the
367 repository will be readable by all users, additionally to being
368 group-shareable. When 'umask' (or 'false'), git will use permissions
369 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
370 files in the repository will have this mode value. '0xxx' will override
371 user's umask value (whereas the other options will only override
372 requested parts of the user's umask value). Examples: '0660' will make
373 the repo read/write-able for the owner and group, but inaccessible to
374 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
375 repository that is group-readable but not group-writable.
376 See linkgit:git-init[1]. False by default.
378 core.warnAmbiguousRefs::
379 If true, git will warn you if the ref name you passed it is ambiguous
380 and might match multiple refs in the .git/refs/ tree. True by default.
383 An integer -1..9, indicating a default compression level.
384 -1 is the zlib default. 0 means no compression,
385 and 1..9 are various speed/size tradeoffs, 9 being slowest.
386 If set, this provides a default to other compression variables,
387 such as 'core.loosecompression' and 'pack.compression'.
389 core.loosecompression::
390 An integer -1..9, indicating the compression level for objects that
391 are not in a pack file. -1 is the zlib default. 0 means no
392 compression, and 1..9 are various speed/size tradeoffs, 9 being
393 slowest. If not set, defaults to core.compression. If that is
394 not set, defaults to 1 (best speed).
396 core.packedGitWindowSize::
397 Number of bytes of a pack file to map into memory in a
398 single mapping operation. Larger window sizes may allow
399 your system to process a smaller number of large pack files
400 more quickly. Smaller window sizes will negatively affect
401 performance due to increased calls to the operating system's
402 memory manager, but may improve performance when accessing
403 a large number of large pack files.
405 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
406 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
407 be reasonable for all users/operating systems. You probably do
408 not need to adjust this value.
410 Common unit suffixes of 'k', 'm', or 'g' are supported.
412 core.packedGitLimit::
413 Maximum number of bytes to map simultaneously into memory
414 from pack files. If Git needs to access more than this many
415 bytes at once to complete an operation it will unmap existing
416 regions to reclaim virtual address space within the process.
418 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
419 This should be reasonable for all users/operating systems, except on
420 the largest projects. You probably do not need to adjust this value.
422 Common unit suffixes of 'k', 'm', or 'g' are supported.
424 core.deltaBaseCacheLimit::
425 Maximum number of bytes to reserve for caching base objects
426 that may be referenced by multiple deltified objects. By storing the
427 entire decompressed base objects in a cache Git is able
428 to avoid unpacking and decompressing frequently used base
429 objects multiple times.
431 Default is 16 MiB on all platforms. This should be reasonable
432 for all users/operating systems, except on the largest projects.
433 You probably do not need to adjust this value.
435 Common unit suffixes of 'k', 'm', or 'g' are supported.
437 core.bigFileThreshold::
438 Files larger than this size are stored deflated, without
439 attempting delta compression. Storing large files without
440 delta compression avoids excessive memory usage, at the
441 slight expense of increased disk usage.
443 Default is 512 MiB on all platforms. This should be reasonable
444 for most projects as source code and other text files can still
445 be delta compressed, but larger binary media files won't be.
447 Common unit suffixes of 'k', 'm', or 'g' are supported.
450 In addition to '.gitignore' (per-directory) and
451 '.git/info/exclude', git looks into this file for patterns
452 of files which are not meant to be tracked. "{tilde}/" is expanded
453 to the value of `$HOME` and "{tilde}user/" to the specified user's
454 home directory. See linkgit:gitignore[5].
457 Some commands (e.g. svn and http interfaces) that interactively
458 ask for a password can be told to use an external program given
459 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
460 environment variable. If not set, fall back to the value of the
461 'SSH_ASKPASS' environment variable or, failing that, a simple password
462 prompt. The external program shall be given a suitable prompt as
463 command line argument and write the password on its STDOUT.
465 core.attributesfile::
466 In addition to '.gitattributes' (per-directory) and
467 '.git/info/attributes', git looks into this file for attributes
468 (see linkgit:gitattributes[5]). Path expansions are made the same
469 way as for `core.excludesfile`.
472 Commands such as `commit` and `tag` that lets you edit
473 messages by launching an editor uses the value of this
474 variable when it is set, and the environment variable
475 `GIT_EDITOR` is not set. See linkgit:git-var[1].
478 Text editor used by `git rebase -i` for editing the rebase insn file.
479 The value is meant to be interpreted by the shell when it is used.
480 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
481 When not configured the default commit message editor is used instead.
484 The command that git will use to paginate output. Can
485 be overridden with the `GIT_PAGER` environment
486 variable. Note that git sets the `LESS` environment
487 variable to `FRSX` if it is unset when it runs the
488 pager. One can change these settings by setting the
489 `LESS` variable to some other value. Alternately,
490 these settings can be overridden on a project or
491 global basis by setting the `core.pager` option.
492 Setting `core.pager` has no affect on the `LESS`
493 environment variable behaviour above, so if you want
494 to override git's default settings this way, you need
495 to be explicit. For example, to disable the S option
496 in a backward compatible manner, set `core.pager`
497 to `less -+$LESS -FRX`. This will be passed to the
498 shell by git, which will translate the final command to
499 `LESS=FRSX less -+FRSX -FRX`.
502 A comma separated list of common whitespace problems to
503 notice. 'git diff' will use `color.diff.whitespace` to
504 highlight them, and 'git apply --whitespace=error' will
505 consider them as errors. You can prefix `-` to disable
506 any of them (e.g. `-trailing-space`):
508 * `blank-at-eol` treats trailing whitespaces at the end of the line
509 as an error (enabled by default).
510 * `space-before-tab` treats a space character that appears immediately
511 before a tab character in the initial indent part of the line as an
512 error (enabled by default).
513 * `indent-with-non-tab` treats a line that is indented with 8 or more
514 space characters as an error (not enabled by default).
515 * `tab-in-indent` treats a tab character in the initial indent part of
516 the line as an error (not enabled by default).
517 * `blank-at-eof` treats blank lines added at the end of file as an error
518 (enabled by default).
519 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
521 * `cr-at-eol` treats a carriage-return at the end of line as
522 part of the line terminator, i.e. with it, `trailing-space`
523 does not trigger if the character before such a carriage-return
524 is not a whitespace (not enabled by default).
525 * `tabwidth=<n>` tells how many character positions a tab occupies; this
526 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
527 errors. The default tab width is 8. Allowed values are 1 to 63.
529 core.fsyncobjectfiles::
530 This boolean will enable 'fsync()' when writing object files.
532 This is a total waste of time and effort on a filesystem that orders
533 data writes properly, but can be useful for filesystems that do not use
534 journalling (traditional UNIX filesystems) or that only journal metadata
535 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
538 Enable parallel index preload for operations like 'git diff'
540 This can speed up operations like 'git diff' and 'git status' especially
541 on filesystems like NFS that have weak caching semantics and thus
542 relatively high IO latencies. With this set to 'true', git will do the
543 index comparison to the filesystem data in parallel, allowing
547 You can set this to 'link', in which case a hardlink followed by
548 a delete of the source are used to make sure that object creation
549 will not overwrite existing objects.
551 On some file system/operating system combinations, this is unreliable.
552 Set this config setting to 'rename' there; However, This will remove the
553 check that makes sure that existing object files will not get overwritten.
556 When showing commit messages, also show notes which are stored in
557 the given ref. The ref must be fully qualified. If the given
558 ref does not exist, it is not an error but means that no
559 notes should be printed.
561 This setting defaults to "refs/notes/commits", and it can be overridden by
562 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
564 core.sparseCheckout::
565 Enable "sparse checkout" feature. See section "Sparse checkout" in
566 linkgit:git-read-tree[1] for more information.
569 Set the length object names are abbreviated to. If unspecified,
570 many commands abbreviate to 7 hexdigits, which may not be enough
571 for abbreviated object names to stay unique for sufficiently long
576 Tells 'git add' to continue adding files when some files cannot be
577 added due to indexing errors. Equivalent to the '--ignore-errors'
578 option of linkgit:git-add[1]. Older versions of git accept only
579 `add.ignore-errors`, which does not follow the usual naming
580 convention for configuration variables. Newer versions of git
581 honor `add.ignoreErrors` as well.
584 Command aliases for the linkgit:git[1] command wrapper - e.g.
585 after defining "alias.last = cat-file commit HEAD", the invocation
586 "git last" is equivalent to "git cat-file commit HEAD". To avoid
587 confusion and troubles with script usage, aliases that
588 hide existing git commands are ignored. Arguments are split by
589 spaces, the usual shell quoting and escaping is supported.
590 quote pair and a backslash can be used to quote them.
592 If the alias expansion is prefixed with an exclamation point,
593 it will be treated as a shell command. For example, defining
594 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
595 "git new" is equivalent to running the shell command
596 "gitk --all --not ORIG_HEAD". Note that shell commands will be
597 executed from the top-level directory of a repository, which may
598 not necessarily be the current directory.
599 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
600 from the original current directory. See linkgit:git-rev-parse[1].
603 If true, git-am will call git-mailsplit for patches in mbox format
604 with parameter '--keep-cr'. In this case git-mailsplit will
605 not remove `\r` from lines ending with `\r\n`. Can be overridden
606 by giving '--no-keep-cr' from the command line.
607 See linkgit:git-am[1], linkgit:git-mailsplit[1].
609 apply.ignorewhitespace::
610 When set to 'change', tells 'git apply' to ignore changes in
611 whitespace, in the same way as the '--ignore-space-change'
613 When set to one of: no, none, never, false tells 'git apply' to
614 respect all whitespace differences.
615 See linkgit:git-apply[1].
618 Tells 'git apply' how to handle whitespaces, in the same way
619 as the '--whitespace' option. See linkgit:git-apply[1].
621 branch.autosetupmerge::
622 Tells 'git branch' and 'git checkout' to set up new branches
623 so that linkgit:git-pull[1] will appropriately merge from the
624 starting point branch. Note that even if this option is not set,
625 this behavior can be chosen per-branch using the `--track`
626 and `--no-track` options. The valid settings are: `false` -- no
627 automatic setup is done; `true` -- automatic setup is done when the
628 starting point is a remote-tracking branch; `always` --
629 automatic setup is done when the starting point is either a
630 local branch or remote-tracking
631 branch. This option defaults to true.
633 branch.autosetuprebase::
634 When a new branch is created with 'git branch' or 'git checkout'
635 that tracks another branch, this variable tells git to set
636 up pull to rebase instead of merge (see "branch.<name>.rebase").
637 When `never`, rebase is never automatically set to true.
638 When `local`, rebase is set to true for tracked branches of
639 other local branches.
640 When `remote`, rebase is set to true for tracked branches of
641 remote-tracking branches.
642 When `always`, rebase will be set to true for all tracking
644 See "branch.autosetupmerge" for details on how to set up a
645 branch to track another branch.
646 This option defaults to never.
648 branch.<name>.remote::
649 When in branch <name>, it tells 'git fetch' and 'git push' which
650 remote to fetch from/push to. It defaults to `origin` if no remote is
651 configured. `origin` is also used if you are not on any branch.
653 branch.<name>.merge::
654 Defines, together with branch.<name>.remote, the upstream branch
655 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
656 branch to merge and can also affect 'git push' (see push.default).
657 When in branch <name>, it tells 'git fetch' the default
658 refspec to be marked for merging in FETCH_HEAD. The value is
659 handled like the remote part of a refspec, and must match a
660 ref which is fetched from the remote given by
661 "branch.<name>.remote".
662 The merge information is used by 'git pull' (which at first calls
663 'git fetch') to lookup the default branch for merging. Without
664 this option, 'git pull' defaults to merge the first refspec fetched.
665 Specify multiple values to get an octopus merge.
666 If you wish to setup 'git pull' so that it merges into <name> from
667 another branch in the local repository, you can point
668 branch.<name>.merge to the desired branch, and use the special setting
669 `.` (a period) for branch.<name>.remote.
671 branch.<name>.mergeoptions::
672 Sets default options for merging into branch <name>. The syntax and
673 supported options are the same as those of linkgit:git-merge[1], but
674 option values containing whitespace characters are currently not
677 branch.<name>.rebase::
678 When true, rebase the branch <name> on top of the fetched branch,
679 instead of merging the default branch from the default remote when
680 "git pull" is run. See "pull.rebase" for doing this in a non
681 branch-specific manner.
683 *NOTE*: this is a possibly dangerous operation; do *not* use
684 it unless you understand the implications (see linkgit:git-rebase[1]
688 Specify the command to invoke the specified browser. The
689 specified command is evaluated in shell with the URLs passed
690 as arguments. (See linkgit:git-web{litdd}browse[1].)
692 browser.<tool>.path::
693 Override the path for the given tool that may be used to
694 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
695 working repository in gitweb (see linkgit:git-instaweb[1]).
698 A boolean to make git-clean do nothing unless given -f
699 or -n. Defaults to true.
702 A boolean to enable/disable color in the output of
703 linkgit:git-branch[1]. May be set to `always`,
704 `false` (or `never`) or `auto` (or `true`), in which case colors are used
705 only when the output is to a terminal. Defaults to false.
707 color.branch.<slot>::
708 Use customized color for branch coloration. `<slot>` is one of
709 `current` (the current branch), `local` (a local branch),
710 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
713 The value for these configuration variables is a list of colors (at most
714 two) and attributes (at most one), separated by spaces. The colors
715 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
716 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
717 `blink` and `reverse`. The first color given is the foreground; the
718 second is the background. The position of the attribute, if any,
722 Whether to use ANSI escape sequences to add color to patches.
723 If this is set to `always`, linkgit:git-diff[1],
724 linkgit:git-log[1], and linkgit:git-show[1] will use color
725 for all patches. If it is set to `true` or `auto`, those
726 commands will only use color when output is to the terminal.
729 This does not affect linkgit:git-format-patch[1] nor the
730 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
731 command line with the `--color[=<when>]` option.
734 Use customized color for diff colorization. `<slot>` specifies
735 which part of the patch to use the specified color, and is one
736 of `plain` (context text), `meta` (metainformation), `frag`
737 (hunk header), 'func' (function in hunk header), `old` (removed lines),
738 `new` (added lines), `commit` (commit headers), or `whitespace`
739 (highlighting whitespace errors). The values of these variables may be
740 specified as in color.branch.<slot>.
742 color.decorate.<slot>::
743 Use customized color for 'git log --decorate' output. `<slot>` is one
744 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
745 branches, remote-tracking branches, tags, stash and HEAD, respectively.
748 When set to `always`, always highlight matches. When `false` (or
749 `never`), never. When set to `true` or `auto`, use color only
750 when the output is written to the terminal. Defaults to `false`.
753 Use customized color for grep colorization. `<slot>` specifies which
754 part of the line to use the specified color, and is one of
758 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
760 filename prefix (when not using `-h`)
762 function name lines (when using `-p`)
764 line number prefix (when using `-n`)
768 non-matching text in selected lines
770 separators between fields on a line (`:`, `-`, and `=`)
771 and between hunks (`--`)
774 The values of these variables may be specified as in color.branch.<slot>.
777 When set to `always`, always use colors for interactive prompts
778 and displays (such as those used by "git-add --interactive").
779 When false (or `never`), never. When set to `true` or `auto`, use
780 colors only when the output is to the terminal. Defaults to false.
782 color.interactive.<slot>::
783 Use customized color for 'git add --interactive'
784 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
785 four distinct types of normal output from interactive
786 commands. The values of these variables may be specified as
787 in color.branch.<slot>.
790 A boolean to enable/disable colored output when the pager is in
791 use (default is true).
794 A boolean to enable/disable color in the output of
795 linkgit:git-show-branch[1]. May be set to `always`,
796 `false` (or `never`) or `auto` (or `true`), in which case colors are used
797 only when the output is to a terminal. Defaults to false.
800 A boolean to enable/disable color in the output of
801 linkgit:git-status[1]. May be set to `always`,
802 `false` (or `never`) or `auto` (or `true`), in which case colors are used
803 only when the output is to a terminal. Defaults to false.
805 color.status.<slot>::
806 Use customized color for status colorization. `<slot>` is
807 one of `header` (the header text of the status message),
808 `added` or `updated` (files which are added but not committed),
809 `changed` (files which are changed but not added in the index),
810 `untracked` (files which are not tracked by git),
811 `branch` (the current branch), or
812 `nobranch` (the color the 'no branch' warning is shown in, defaulting
813 to red). The values of these variables may be specified as in
817 This variable determines the default value for variables such
818 as `color.diff` and `color.grep` that control the use of color
819 per command family. Its scope will expand as more commands learn
820 configuration to set a default for the `--color` option. Set it
821 to `always` if you want all output not intended for machine
822 consumption to use color, to `true` or `auto` if you want such
823 output to use color when written to the terminal, or to `false` or
824 `never` if you prefer git commands not to use color unless enabled
825 explicitly with some other configuration or the `--color` option.
828 A boolean to enable/disable inclusion of status information in the
829 commit message template when using an editor to prepare the commit
830 message. Defaults to true.
833 Specify a file to use as the template for new commit messages.
834 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
835 specified user's home directory.
838 Specify an external helper to be called when a username or
839 password credential is needed; the helper may consult external
840 storage to avoid prompting the user for the credentials. See
841 linkgit:gitcredentials[7] for details.
843 credential.useHttpPath::
844 When acquiring credentials, consider the "path" component of an http
845 or https URL to be important. Defaults to false. See
846 linkgit:gitcredentials[7] for more information.
848 credential.username::
849 If no username is set for a network authentication, use this username
850 by default. See credential.<context>.* below, and
851 linkgit:gitcredentials[7].
854 Any of the credential.* options above can be applied selectively to
855 some credentials. For example "credential.https://example.com.username"
856 would set the default username only for https connections to
857 example.com. See linkgit:gitcredentials[7] for details on how URLs are
860 include::diff-config.txt[]
862 difftool.<tool>.path::
863 Override the path for the given tool. This is useful in case
864 your tool is not in the PATH.
866 difftool.<tool>.cmd::
867 Specify the command to invoke the specified diff tool.
868 The specified command is evaluated in shell with the following
869 variables available: 'LOCAL' is set to the name of the temporary
870 file containing the contents of the diff pre-image and 'REMOTE'
871 is set to the name of the temporary file containing the contents
872 of the diff post-image.
875 Prompt before each invocation of the diff tool.
878 A POSIX Extended Regular Expression used to determine what is a "word"
879 when performing word-by-word difference calculations. Character
880 sequences that match the regular expression are "words", all other
881 characters are *ignorable* whitespace.
883 fetch.recurseSubmodules::
884 This option can be either set to a boolean value or to 'on-demand'.
885 Setting it to a boolean changes the behavior of fetch and pull to
886 unconditionally recurse into submodules when set to true or to not
887 recurse at all when set to false. When set to 'on-demand' (the default
888 value), fetch and pull will only recurse into a populated submodule
889 when its superproject retrieves a commit that updates the submodule's
893 If it is set to true, git-fetch-pack will check all fetched
894 objects. It will abort in the case of a malformed object or a
895 broken link. The result of an abort are only dangling objects.
896 Defaults to false. If not set, the value of `transfer.fsckObjects`
900 If the number of objects fetched over the git native
901 transfer is below this
902 limit, then the objects will be unpacked into loose object
903 files. However if the number of received objects equals or
904 exceeds this limit then the received pack will be stored as
905 a pack, after adding any missing delta bases. Storing the
906 pack from a push can make the push operation complete faster,
907 especially on slow filesystems. If not set, the value of
908 `transfer.unpackLimit` is used instead.
911 Enable multipart/mixed attachments as the default for
912 'format-patch'. The value can also be a double quoted string
913 which will enable attachments as the default and set the
914 value as the boundary. See the --attach option in
915 linkgit:git-format-patch[1].
918 A boolean which can enable or disable sequence numbers in patch
919 subjects. It defaults to "auto" which enables it only if there
920 is more than one patch. It can be enabled or disabled for all
921 messages by setting it to "true" or "false". See --numbered
922 option in linkgit:git-format-patch[1].
925 Additional email headers to include in a patch to be submitted
926 by mail. See linkgit:git-format-patch[1].
930 Additional recipients to include in a patch to be submitted
931 by mail. See the --to and --cc options in
932 linkgit:git-format-patch[1].
934 format.subjectprefix::
935 The default for format-patch is to output files with the '[PATCH]'
936 subject prefix. Use this variable to change that prefix.
939 The default for format-patch is to output a signature containing
940 the git version number. Use this variable to change that default.
941 Set this variable to the empty string ("") to suppress
942 signature generation.
945 The default for format-patch is to output files with the suffix
946 `.patch`. Use this variable to change that suffix (make sure to
947 include the dot if you want it).
950 The default pretty format for log/show/whatchanged command,
951 See linkgit:git-log[1], linkgit:git-show[1],
952 linkgit:git-whatchanged[1].
955 The default threading style for 'git format-patch'. Can be
956 a boolean value, or `shallow` or `deep`. `shallow` threading
957 makes every mail a reply to the head of the series,
958 where the head is chosen from the cover letter, the
959 `\--in-reply-to`, and the first patch mail, in this order.
960 `deep` threading makes every mail a reply to the previous one.
961 A true boolean value is the same as `shallow`, and a false
962 value disables threading.
965 A boolean value which lets you enable the `-s/--signoff` option of
966 format-patch by default. *Note:* Adding the Signed-off-by: line to a
967 patch should be a conscious act and means that you certify you have
968 the rights to submit this work under the same open source license.
969 Please see the 'SubmittingPatches' document for further discussion.
971 filter.<driver>.clean::
972 The command which is used to convert the content of a worktree
973 file to a blob upon checkin. See linkgit:gitattributes[5] for
976 filter.<driver>.smudge::
977 The command which is used to convert the content of a blob
978 object to a worktree file upon checkout. See
979 linkgit:gitattributes[5] for details.
981 gc.aggressiveWindow::
982 The window size parameter used in the delta compression
983 algorithm used by 'git gc --aggressive'. This defaults
987 When there are approximately more than this many loose
988 objects in the repository, `git gc --auto` will pack them.
989 Some Porcelain commands use this command to perform a
990 light-weight garbage collection from time to time. The
991 default value is 6700. Setting this to 0 disables it.
994 When there are more than this many packs that are not
995 marked with `*.keep` file in the repository, `git gc
996 --auto` consolidates them into one larger pack. The
997 default value is 50. Setting this to 0 disables it.
1000 Running `git pack-refs` in a repository renders it
1001 unclonable by Git versions prior to 1.5.1.2 over dumb
1002 transports such as HTTP. This variable determines whether
1003 'git gc' runs `git pack-refs`. This can be set to `notbare`
1004 to enable it within all non-bare repos or it can be set to a
1005 boolean value. The default is `true`.
1008 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1009 Override the grace period with this config variable. The value
1010 "now" may be used to disable this grace period and always prune
1011 unreachable objects immediately.
1014 gc.<pattern>.reflogexpire::
1015 'git reflog expire' removes reflog entries older than
1016 this time; defaults to 90 days. With "<pattern>" (e.g.
1017 "refs/stash") in the middle the setting applies only to
1018 the refs that match the <pattern>.
1020 gc.reflogexpireunreachable::
1021 gc.<ref>.reflogexpireunreachable::
1022 'git reflog expire' removes reflog entries older than
1023 this time and are not reachable from the current tip;
1024 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1025 in the middle, the setting applies only to the refs that
1026 match the <pattern>.
1029 Records of conflicted merge you resolved earlier are
1030 kept for this many days when 'git rerere gc' is run.
1031 The default is 60 days. See linkgit:git-rerere[1].
1033 gc.rerereunresolved::
1034 Records of conflicted merge you have not resolved are
1035 kept for this many days when 'git rerere gc' is run.
1036 The default is 15 days. See linkgit:git-rerere[1].
1038 gitcvs.commitmsgannotation::
1039 Append this string to each commit message. Set to empty string
1040 to disable this feature. Defaults to "via git-CVS emulator".
1043 Whether the CVS server interface is enabled for this repository.
1044 See linkgit:git-cvsserver[1].
1047 Path to a log file where the CVS server interface well... logs
1048 various stuff. See linkgit:git-cvsserver[1].
1050 gitcvs.usecrlfattr::
1051 If true, the server will look up the end-of-line conversion
1052 attributes for files to determine the '-k' modes to use. If
1053 the attributes force git to treat a file as text,
1054 the '-k' mode will be left blank so CVS clients will
1055 treat it as text. If they suppress text conversion, the file
1056 will be set with '-kb' mode, which suppresses any newline munging
1057 the client might otherwise do. If the attributes do not allow
1058 the file type to be determined, then 'gitcvs.allbinary' is
1059 used. See linkgit:gitattributes[5].
1062 This is used if 'gitcvs.usecrlfattr' does not resolve
1063 the correct '-kb' mode to use. If true, all
1064 unresolved files are sent to the client in
1065 mode '-kb'. This causes the client to treat them
1066 as binary files, which suppresses any newline munging it
1067 otherwise might do. Alternatively, if it is set to "guess",
1068 then the contents of the file are examined to decide if
1069 it is binary, similar to 'core.autocrlf'.
1072 Database used by git-cvsserver to cache revision information
1073 derived from the git repository. The exact meaning depends on the
1074 used database driver, for SQLite (which is the default driver) this
1075 is a filename. Supports variable substitution (see
1076 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1077 Default: '%Ggitcvs.%m.sqlite'
1080 Used Perl DBI driver. You can specify any available driver
1081 for this here, but it might not work. git-cvsserver is tested
1082 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1083 reported *not* to work with 'DBD::mysql'. Experimental feature.
1084 May not contain double colons (`:`). Default: 'SQLite'.
1085 See linkgit:git-cvsserver[1].
1087 gitcvs.dbuser, gitcvs.dbpass::
1088 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1089 since SQLite has no concept of database users and/or passwords.
1090 'gitcvs.dbuser' supports variable substitution (see
1091 linkgit:git-cvsserver[1] for details).
1093 gitcvs.dbTableNamePrefix::
1094 Database table name prefix. Prepended to the names of any
1095 database tables used, allowing a single database to be used
1096 for several repositories. Supports variable substitution (see
1097 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1098 characters will be replaced with underscores.
1100 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1101 'gitcvs.allbinary' can also be specified as
1102 'gitcvs.<access_method>.<varname>' (where 'access_method'
1103 is one of "ext" and "pserver") to make them apply only for the given
1107 gitweb.description::
1110 See linkgit:gitweb[1] for description.
1118 gitweb.remote_heads::
1121 See linkgit:gitweb.conf[5] for description.
1124 If set to true, enable '-n' option by default.
1126 grep.extendedRegexp::
1127 If set to true, enable '--extended-regexp' option by default.
1129 gui.commitmsgwidth::
1130 Defines how wide the commit message window is in the
1131 linkgit:git-gui[1]. "75" is the default.
1134 Specifies how many context lines should be used in calls to diff
1135 made by the linkgit:git-gui[1]. The default is "5".
1138 Specifies the default encoding to use for displaying of
1139 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1140 It can be overridden by setting the 'encoding' attribute
1141 for relevant files (see linkgit:gitattributes[5]).
1142 If this option is not set, the tools default to the
1145 gui.matchtrackingbranch::
1146 Determines if new branches created with linkgit:git-gui[1] should
1147 default to tracking remote branches with matching names or
1148 not. Default: "false".
1150 gui.newbranchtemplate::
1151 Is used as suggested name when creating new branches using the
1154 gui.pruneduringfetch::
1155 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1156 performing a fetch. The default value is "false".
1159 Determines if linkgit:git-gui[1] should trust the file modification
1160 timestamp or not. By default the timestamps are not trusted.
1162 gui.spellingdictionary::
1163 Specifies the dictionary used for spell checking commit messages in
1164 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1168 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1169 location detection. It makes blame significantly faster on huge
1170 repositories at the expense of less thorough copy detection.
1172 gui.copyblamethreshold::
1173 Specifies the threshold to use in 'git gui blame' original location
1174 detection, measured in alphanumeric characters. See the
1175 linkgit:git-blame[1] manual for more information on copy detection.
1177 gui.blamehistoryctx::
1178 Specifies the radius of history context in days to show in
1179 linkgit:gitk[1] for the selected commit, when the `Show History
1180 Context` menu item is invoked from 'git gui blame'. If this
1181 variable is set to zero, the whole history is shown.
1183 guitool.<name>.cmd::
1184 Specifies the shell command line to execute when the corresponding item
1185 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1186 mandatory for every tool. The command is executed from the root of
1187 the working directory, and in the environment it receives the name of
1188 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1189 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1190 the head is detached, 'CUR_BRANCH' is empty).
1192 guitool.<name>.needsfile::
1193 Run the tool only if a diff is selected in the GUI. It guarantees
1194 that 'FILENAME' is not empty.
1196 guitool.<name>.noconsole::
1197 Run the command silently, without creating a window to display its
1200 guitool.<name>.norescan::
1201 Don't rescan the working directory for changes after the tool
1204 guitool.<name>.confirm::
1205 Show a confirmation dialog before actually running the tool.
1207 guitool.<name>.argprompt::
1208 Request a string argument from the user, and pass it to the tool
1209 through the 'ARGS' environment variable. Since requesting an
1210 argument implies confirmation, the 'confirm' option has no effect
1211 if this is enabled. If the option is set to 'true', 'yes', or '1',
1212 the dialog uses a built-in generic prompt; otherwise the exact
1213 value of the variable is used.
1215 guitool.<name>.revprompt::
1216 Request a single valid revision from the user, and set the
1217 'REVISION' environment variable. In other aspects this option
1218 is similar to 'argprompt', and can be used together with it.
1220 guitool.<name>.revunmerged::
1221 Show only unmerged branches in the 'revprompt' subdialog.
1222 This is useful for tools similar to merge or rebase, but not
1223 for things like checkout or reset.
1225 guitool.<name>.title::
1226 Specifies the title to use for the prompt dialog. The default
1229 guitool.<name>.prompt::
1230 Specifies the general prompt string to display at the top of
1231 the dialog, before subsections for 'argprompt' and 'revprompt'.
1232 The default value includes the actual command.
1235 Specify the browser that will be used to display help in the
1236 'web' format. See linkgit:git-help[1].
1239 Override the default help format used by linkgit:git-help[1].
1240 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1241 the default. 'web' and 'html' are the same.
1244 Automatically correct and execute mistyped commands after
1245 waiting for the given number of deciseconds (0.1 sec). If more
1246 than one command can be deduced from the entered text, nothing
1247 will be executed. If the value of this option is negative,
1248 the corrected command will be executed immediately. If the
1249 value is 0 - the command will be just shown but not executed.
1250 This is the default.
1253 Override the HTTP proxy, normally configured using the 'http_proxy'
1254 environment variable (see linkgit:curl[1]). This can be overridden
1255 on a per-remote basis; see remote.<name>.proxy
1258 File containing previously stored cookie lines which should be used
1259 in the git http session, if they match the server. The file format
1260 of the file to read cookies from should be plain HTTP headers or
1261 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1262 NOTE that the file specified with http.cookiefile is only used as
1263 input. No cookies will be stored in the file.
1266 Whether to verify the SSL certificate when fetching or pushing
1267 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1271 File containing the SSL certificate when fetching or pushing
1272 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1276 File containing the SSL private key when fetching or pushing
1277 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1280 http.sslCertPasswordProtected::
1281 Enable git's password prompt for the SSL certificate. Otherwise
1282 OpenSSL will prompt the user, possibly many times, if the
1283 certificate or private key is encrypted. Can be overridden by the
1284 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1287 File containing the certificates to verify the peer with when
1288 fetching or pushing over HTTPS. Can be overridden by the
1289 'GIT_SSL_CAINFO' environment variable.
1292 Path containing files with the CA certificates to verify the peer
1293 with when fetching or pushing over HTTPS. Can be overridden
1294 by the 'GIT_SSL_CAPATH' environment variable.
1297 How many HTTP requests to launch in parallel. Can be overridden
1298 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1301 The number of curl sessions (counted across slots) to be kept across
1302 requests. They will not be ended with curl_easy_cleanup() until
1303 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1304 value will be capped at 1. Defaults to 1.
1307 Maximum size in bytes of the buffer used by smart HTTP
1308 transports when POSTing data to the remote system.
1309 For requests larger than this buffer size, HTTP/1.1 and
1310 Transfer-Encoding: chunked is used to avoid creating a
1311 massive pack file locally. Default is 1 MiB, which is
1312 sufficient for most requests.
1314 http.lowSpeedLimit, http.lowSpeedTime::
1315 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1316 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1317 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1318 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1321 A boolean which disables using of EPSV ftp command by curl.
1322 This can helpful with some "poor" ftp servers which don't
1323 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1324 environment variable. Default is false (curl will use EPSV).
1327 The HTTP USER_AGENT string presented to an HTTP server. The default
1328 value represents the version of the client git such as git/1.7.1.
1329 This option allows you to override this value to a more common value
1330 such as Mozilla/4.0. This may be necessary, for instance, if
1331 connecting through a firewall that restricts HTTP connections to a set
1332 of common USER_AGENT strings (but not including those like git/1.7.1).
1333 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1335 i18n.commitEncoding::
1336 Character encoding the commit messages are stored in; git itself
1337 does not care per se, but this information is necessary e.g. when
1338 importing commits from emails or in the gitk graphical history
1339 browser (and possibly at other places in the future or in other
1340 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1342 i18n.logOutputEncoding::
1343 Character encoding the commit messages are converted to when
1344 running 'git log' and friends.
1347 The configuration variables in the 'imap' section are described
1348 in linkgit:git-imap-send[1].
1351 Specify the directory from which templates will be copied.
1352 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1355 Specify the program that will be used to browse your working
1356 repository in gitweb. See linkgit:git-instaweb[1].
1359 The HTTP daemon command-line to start gitweb on your working
1360 repository. See linkgit:git-instaweb[1].
1363 If true the web server started by linkgit:git-instaweb[1] will
1364 be bound to the local IP (127.0.0.1).
1366 instaweb.modulepath::
1367 The default module path for linkgit:git-instaweb[1] to use
1368 instead of /usr/lib/apache2/modules. Only used if httpd
1372 The port number to bind the gitweb httpd to. See
1373 linkgit:git-instaweb[1].
1375 interactive.singlekey::
1376 In interactive commands, allow the user to provide one-letter
1377 input with a single key (i.e., without hitting enter).
1378 Currently this is used by the `\--patch` mode of
1379 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1380 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1381 setting is silently ignored if portable keystroke input
1385 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1386 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1387 override this option with `\--no-abbrev-commit`.
1390 Set the default date-time mode for the 'log' command.
1391 Setting a value for log.date is similar to using 'git log''s
1392 `\--date` option. Possible values are `relative`, `local`,
1393 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1397 Print out the ref names of any commits that are shown by the log
1398 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1399 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1400 specified, the full ref name (including prefix) will be printed.
1401 This is the same as the log commands '--decorate' option.
1404 If true, the initial commit will be shown as a big creation event.
1405 This is equivalent to a diff against an empty tree.
1406 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1407 normally hide the root commit will now show it. True by default.
1410 The location of an augmenting mailmap file. The default
1411 mailmap, located in the root of the repository, is loaded
1412 first, then the mailmap file pointed to by this variable.
1413 The location of the mailmap file may be in a repository
1414 subdirectory, or somewhere outside of the repository itself.
1415 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1418 Specify the programs that may be used to display help in the
1419 'man' format. See linkgit:git-help[1].
1422 Specify the command to invoke the specified man viewer. The
1423 specified command is evaluated in shell with the man page
1424 passed as argument. (See linkgit:git-help[1].)
1427 Override the path for the given tool that may be used to
1428 display help in the 'man' format. See linkgit:git-help[1].
1430 include::merge-config.txt[]
1432 mergetool.<tool>.path::
1433 Override the path for the given tool. This is useful in case
1434 your tool is not in the PATH.
1436 mergetool.<tool>.cmd::
1437 Specify the command to invoke the specified merge tool. The
1438 specified command is evaluated in shell with the following
1439 variables available: 'BASE' is the name of a temporary file
1440 containing the common base of the files to be merged, if available;
1441 'LOCAL' is the name of a temporary file containing the contents of
1442 the file on the current branch; 'REMOTE' is the name of a temporary
1443 file containing the contents of the file from the branch being
1444 merged; 'MERGED' contains the name of the file to which the merge
1445 tool should write the results of a successful merge.
1447 mergetool.<tool>.trustExitCode::
1448 For a custom merge command, specify whether the exit code of
1449 the merge command can be used to determine whether the merge was
1450 successful. If this is not set to true then the merge target file
1451 timestamp is checked and the merge assumed to have been successful
1452 if the file has been updated, otherwise the user is prompted to
1453 indicate the success of the merge.
1455 mergetool.keepBackup::
1456 After performing a merge, the original file with conflict markers
1457 can be saved as a file with a `.orig` extension. If this variable
1458 is set to `false` then this file is not preserved. Defaults to
1459 `true` (i.e. keep the backup files).
1461 mergetool.keepTemporaries::
1462 When invoking a custom merge tool, git uses a set of temporary
1463 files to pass to the tool. If the tool returns an error and this
1464 variable is set to `true`, then these temporary files will be
1465 preserved, otherwise they will be removed after the tool has
1466 exited. Defaults to `false`.
1469 Prompt before each invocation of the merge resolution program.
1472 The (fully qualified) refname from which to show notes when
1473 showing commit messages. The value of this variable can be set
1474 to a glob, in which case notes from all matching refs will be
1475 shown. You may also specify this configuration variable
1476 several times. A warning will be issued for refs that do not
1477 exist, but a glob that does not match any refs is silently
1480 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1481 environment variable, which must be a colon separated list of refs or
1484 The effective value of "core.notesRef" (possibly overridden by
1485 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1488 notes.rewrite.<command>::
1489 When rewriting commits with <command> (currently `amend` or
1490 `rebase`) and this variable is set to `true`, git
1491 automatically copies your notes from the original to the
1492 rewritten commit. Defaults to `true`, but see
1493 "notes.rewriteRef" below.
1496 When copying notes during a rewrite (see the
1497 "notes.rewrite.<command>" option), determines what to do if
1498 the target commit already has a note. Must be one of
1499 `overwrite`, `concatenate`, or `ignore`. Defaults to
1502 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1503 environment variable.
1506 When copying notes during a rewrite, specifies the (fully
1507 qualified) ref whose notes should be copied. The ref may be a
1508 glob, in which case notes in all matching refs will be copied.
1509 You may also specify this configuration several times.
1511 Does not have a default value; you must configure this variable to
1512 enable note rewriting. Set it to `refs/notes/commits` to enable
1513 rewriting for the default commit notes.
1515 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1516 environment variable, which must be a colon separated list of refs or
1520 The size of the window used by linkgit:git-pack-objects[1] when no
1521 window size is given on the command line. Defaults to 10.
1524 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1525 maximum depth is given on the command line. Defaults to 50.
1528 The window memory size limit used by linkgit:git-pack-objects[1]
1529 when no limit is given on the command line. The value can be
1530 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1534 An integer -1..9, indicating the compression level for objects
1535 in a pack file. -1 is the zlib default. 0 means no
1536 compression, and 1..9 are various speed/size tradeoffs, 9 being
1537 slowest. If not set, defaults to core.compression. If that is
1538 not set, defaults to -1, the zlib default, which is "a default
1539 compromise between speed and compression (currently equivalent
1542 Note that changing the compression level will not automatically recompress
1543 all existing objects. You can force recompression by passing the -F option
1544 to linkgit:git-repack[1].
1546 pack.deltaCacheSize::
1547 The maximum memory in bytes used for caching deltas in
1548 linkgit:git-pack-objects[1] before writing them out to a pack.
1549 This cache is used to speed up the writing object phase by not
1550 having to recompute the final delta result once the best match
1551 for all objects is found. Repacking large repositories on machines
1552 which are tight with memory might be badly impacted by this though,
1553 especially if this cache pushes the system into swapping.
1554 A value of 0 means no limit. The smallest size of 1 byte may be
1555 used to virtually disable this cache. Defaults to 256 MiB.
1557 pack.deltaCacheLimit::
1558 The maximum size of a delta, that is cached in
1559 linkgit:git-pack-objects[1]. This cache is used to speed up the
1560 writing object phase by not having to recompute the final delta
1561 result once the best match for all objects is found. Defaults to 1000.
1564 Specifies the number of threads to spawn when searching for best
1565 delta matches. This requires that linkgit:git-pack-objects[1]
1566 be compiled with pthreads otherwise this option is ignored with a
1567 warning. This is meant to reduce packing time on multiprocessor
1568 machines. The required amount of memory for the delta search window
1569 is however multiplied by the number of threads.
1570 Specifying 0 will cause git to auto-detect the number of CPU's
1571 and set the number of threads accordingly.
1574 Specify the default pack index version. Valid values are 1 for
1575 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1576 the new pack index with capabilities for packs larger than 4 GB
1577 as well as proper protection against the repacking of corrupted
1578 packs. Version 2 is the default. Note that version 2 is enforced
1579 and this config option ignored whenever the corresponding pack is
1582 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1583 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1584 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1585 other side may give you a repository that cannot be accessed with your
1586 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1587 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1588 the `{asterisk}.idx` file.
1590 pack.packSizeLimit::
1591 The maximum size of a pack. This setting only affects
1592 packing to a file when repacking, i.e. the git:// protocol
1593 is unaffected. It can be overridden by the `\--max-pack-size`
1594 option of linkgit:git-repack[1]. The minimum size allowed is
1595 limited to 1 MiB. The default is unlimited.
1596 Common unit suffixes of 'k', 'm', or 'g' are
1600 If the value is boolean, turns on or off pagination of the
1601 output of a particular git subcommand when writing to a tty.
1602 Otherwise, turns on pagination for the subcommand using the
1603 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1604 or `\--no-pager` is specified on the command line, it takes
1605 precedence over this option. To disable pagination for all
1606 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1609 Alias for a --pretty= format string, as specified in
1610 linkgit:git-log[1]. Any aliases defined here can be used just
1611 as the built-in pretty formats could. For example,
1612 running `git config pretty.changelog "format:{asterisk} %H %s"`
1613 would cause the invocation `git log --pretty=changelog`
1614 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1615 Note that an alias with the same name as a built-in format
1616 will be silently ignored.
1619 When true, rebase branches on top of the fetched branch, instead
1620 of merging the default branch from the default remote when "git
1621 pull" is run. See "branch.<name>.rebase" for setting this on a
1624 *NOTE*: this is a possibly dangerous operation; do *not* use
1625 it unless you understand the implications (see linkgit:git-rebase[1]
1629 The default merge strategy to use when pulling multiple branches
1633 The default merge strategy to use when pulling a single branch.
1636 Defines the action git push should take if no refspec is given
1637 on the command line, no refspec is configured in the remote, and
1638 no refspec is implied by any of the options given on the command
1639 line. Possible values are:
1641 * `nothing` - do not push anything.
1642 * `matching` - push all matching branches.
1643 All branches having the same name in both ends are considered to be
1644 matching. This is the default.
1645 * `upstream` - push the current branch to its upstream branch.
1646 * `tracking` - deprecated synonym for `upstream`.
1647 * `current` - push the current branch to a branch of the same name.
1650 Whether to show a diffstat of what changed upstream since the last
1651 rebase. False by default.
1654 If set to true enable '--autosquash' option by default.
1657 By default, git-receive-pack will run "git-gc --auto" after
1658 receiving data from git-push and updating refs. You can stop
1659 it by setting this variable to false.
1661 receive.fsckObjects::
1662 If it is set to true, git-receive-pack will check all received
1663 objects. It will abort in the case of a malformed object or a
1664 broken link. The result of an abort are only dangling objects.
1665 Defaults to false. If not set, the value of `transfer.fsckObjects`
1668 receive.unpackLimit::
1669 If the number of objects received in a push is below this
1670 limit then the objects will be unpacked into loose object
1671 files. However if the number of received objects equals or
1672 exceeds this limit then the received pack will be stored as
1673 a pack, after adding any missing delta bases. Storing the
1674 pack from a push can make the push operation complete faster,
1675 especially on slow filesystems. If not set, the value of
1676 `transfer.unpackLimit` is used instead.
1678 receive.denyDeletes::
1679 If set to true, git-receive-pack will deny a ref update that deletes
1680 the ref. Use this to prevent such a ref deletion via a push.
1682 receive.denyDeleteCurrent::
1683 If set to true, git-receive-pack will deny a ref update that
1684 deletes the currently checked out branch of a non-bare repository.
1686 receive.denyCurrentBranch::
1687 If set to true or "refuse", git-receive-pack will deny a ref update
1688 to the currently checked out branch of a non-bare repository.
1689 Such a push is potentially dangerous because it brings the HEAD
1690 out of sync with the index and working tree. If set to "warn",
1691 print a warning of such a push to stderr, but allow the push to
1692 proceed. If set to false or "ignore", allow such pushes with no
1693 message. Defaults to "refuse".
1695 receive.denyNonFastForwards::
1696 If set to true, git-receive-pack will deny a ref update which is
1697 not a fast-forward. Use this to prevent such an update via a push,
1698 even if that push is forced. This configuration variable is
1699 set when initializing a shared repository.
1701 receive.updateserverinfo::
1702 If set to true, git-receive-pack will run git-update-server-info
1703 after receiving data from git-push and updating refs.
1706 The URL of a remote repository. See linkgit:git-fetch[1] or
1707 linkgit:git-push[1].
1709 remote.<name>.pushurl::
1710 The push URL of a remote repository. See linkgit:git-push[1].
1712 remote.<name>.proxy::
1713 For remotes that require curl (http, https and ftp), the URL to
1714 the proxy to use for that remote. Set to the empty string to
1715 disable proxying for that remote.
1717 remote.<name>.fetch::
1718 The default set of "refspec" for linkgit:git-fetch[1]. See
1719 linkgit:git-fetch[1].
1721 remote.<name>.push::
1722 The default set of "refspec" for linkgit:git-push[1]. See
1723 linkgit:git-push[1].
1725 remote.<name>.mirror::
1726 If true, pushing to this remote will automatically behave
1727 as if the `\--mirror` option was given on the command line.
1729 remote.<name>.skipDefaultUpdate::
1730 If true, this remote will be skipped by default when updating
1731 using linkgit:git-fetch[1] or the `update` subcommand of
1732 linkgit:git-remote[1].
1734 remote.<name>.skipFetchAll::
1735 If true, this remote will be skipped by default when updating
1736 using linkgit:git-fetch[1] or the `update` subcommand of
1737 linkgit:git-remote[1].
1739 remote.<name>.receivepack::
1740 The default program to execute on the remote side when pushing. See
1741 option \--receive-pack of linkgit:git-push[1].
1743 remote.<name>.uploadpack::
1744 The default program to execute on the remote side when fetching. See
1745 option \--upload-pack of linkgit:git-fetch-pack[1].
1747 remote.<name>.tagopt::
1748 Setting this value to \--no-tags disables automatic tag following when
1749 fetching from remote <name>. Setting it to \--tags will fetch every
1750 tag from remote <name>, even if they are not reachable from remote
1751 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1752 override this setting. See options \--tags and \--no-tags of
1753 linkgit:git-fetch[1].
1756 Setting this to a value <vcs> will cause git to interact with
1757 the remote with the git-remote-<vcs> helper.
1760 The list of remotes which are fetched by "git remote update
1761 <group>". See linkgit:git-remote[1].
1763 repack.usedeltabaseoffset::
1764 By default, linkgit:git-repack[1] creates packs that use
1765 delta-base offset. If you need to share your repository with
1766 git older than version 1.4.4, either directly or via a dumb
1767 protocol such as http, then you need to set this option to
1768 "false" and repack. Access from old git versions over the
1769 native protocol are unaffected by this option.
1772 When set to true, `git-rerere` updates the index with the
1773 resulting contents after it cleanly resolves conflicts using
1774 previously recorded resolution. Defaults to false.
1777 Activate recording of resolved conflicts, so that identical
1778 conflict hunks can be resolved automatically, should they
1779 be encountered again. linkgit:git-rerere[1] command is by
1780 default enabled if you create `rr-cache` directory under
1781 `$GIT_DIR`, but can be disabled by setting this option to false.
1783 sendemail.identity::
1784 A configuration identity. When given, causes values in the
1785 'sendemail.<identity>' subsection to take precedence over
1786 values in the 'sendemail' section. The default identity is
1787 the value of 'sendemail.identity'.
1789 sendemail.smtpencryption::
1790 See linkgit:git-send-email[1] for description. Note that this
1791 setting is not subject to the 'identity' mechanism.
1794 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1796 sendemail.<identity>.*::
1797 Identity-specific versions of the 'sendemail.*' parameters
1798 found below, taking precedence over those when the this
1799 identity is selected, through command-line or
1800 'sendemail.identity'.
1802 sendemail.aliasesfile::
1803 sendemail.aliasfiletype::
1807 sendemail.chainreplyto::
1809 sendemail.envelopesender::
1811 sendemail.multiedit::
1812 sendemail.signedoffbycc::
1813 sendemail.smtppass::
1814 sendemail.suppresscc::
1815 sendemail.suppressfrom::
1817 sendemail.smtpdomain::
1818 sendemail.smtpserver::
1819 sendemail.smtpserverport::
1820 sendemail.smtpserveroption::
1821 sendemail.smtpuser::
1823 sendemail.validate::
1824 See linkgit:git-send-email[1] for description.
1826 sendemail.signedoffcc::
1827 Deprecated alias for 'sendemail.signedoffbycc'.
1829 showbranch.default::
1830 The default set of branches for linkgit:git-show-branch[1].
1831 See linkgit:git-show-branch[1].
1833 status.relativePaths::
1834 By default, linkgit:git-status[1] shows paths relative to the
1835 current directory. Setting this variable to `false` shows paths
1836 relative to the repository root (this was the default for git
1839 status.showUntrackedFiles::
1840 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1841 files which are not currently tracked by Git. Directories which
1842 contain only untracked files, are shown with the directory name
1843 only. Showing untracked files means that Git needs to lstat() all
1844 all the files in the whole repository, which might be slow on some
1845 systems. So, this variable controls how the commands displays
1846 the untracked files. Possible values are:
1849 * `no` - Show no untracked files.
1850 * `normal` - Show untracked files and directories.
1851 * `all` - Show also individual files in untracked directories.
1854 If this variable is not specified, it defaults to 'normal'.
1855 This variable can be overridden with the -u|--untracked-files option
1856 of linkgit:git-status[1] and linkgit:git-commit[1].
1858 status.submodulesummary::
1860 If this is set to a non zero number or true (identical to -1 or an
1861 unlimited number), the submodule summary will be enabled and a
1862 summary of commits for modified submodules will be shown (see
1863 --summary-limit option of linkgit:git-submodule[1]).
1865 submodule.<name>.path::
1866 submodule.<name>.url::
1867 submodule.<name>.update::
1868 The path within this project, URL, and the updating strategy
1869 for a submodule. These variables are initially populated
1870 by 'git submodule init'; edit them to override the
1871 URL and other values found in the `.gitmodules` file. See
1872 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1874 submodule.<name>.fetchRecurseSubmodules::
1875 This option can be used to control recursive fetching of this
1876 submodule. It can be overridden by using the --[no-]recurse-submodules
1877 command line option to "git fetch" and "git pull".
1878 This setting will override that from in the linkgit:gitmodules[5]
1881 submodule.<name>.ignore::
1882 Defines under what circumstances "git status" and the diff family show
1883 a submodule as modified. When set to "all", it will never be considered
1884 modified, "dirty" will ignore all changes to the submodules work tree and
1885 takes only differences between the HEAD of the submodule and the commit
1886 recorded in the superproject into account. "untracked" will additionally
1887 let submodules with modified tracked files in their work tree show up.
1888 Using "none" (the default when this option is not set) also shows
1889 submodules that have untracked files in their work tree as changed.
1890 This setting overrides any setting made in .gitmodules for this submodule,
1891 both settings can be overridden on the command line by using the
1892 "--ignore-submodules" option.
1895 This variable can be used to restrict the permission bits of
1896 tar archive entries. The default is 0002, which turns off the
1897 world write bit. The special value "user" indicates that the
1898 archiving user's umask will be used instead. See umask(2) and
1899 linkgit:git-archive[1].
1901 transfer.fsckObjects::
1902 When `fetch.fsckObjects` or `receive.fsckObjects` are
1903 not set, the value of this variable is used instead.
1906 transfer.unpackLimit::
1907 When `fetch.unpackLimit` or `receive.unpackLimit` are
1908 not set, the value of this variable is used instead.
1909 The default value is 100.
1911 url.<base>.insteadOf::
1912 Any URL that starts with this value will be rewritten to
1913 start, instead, with <base>. In cases where some site serves a
1914 large number of repositories, and serves them with multiple
1915 access methods, and some users need to use different access
1916 methods, this feature allows people to specify any of the
1917 equivalent URLs and have git automatically rewrite the URL to
1918 the best alternative for the particular user, even for a
1919 never-before-seen repository on the site. When more than one
1920 insteadOf strings match a given URL, the longest match is used.
1922 url.<base>.pushInsteadOf::
1923 Any URL that starts with this value will not be pushed to;
1924 instead, it will be rewritten to start with <base>, and the
1925 resulting URL will be pushed to. In cases where some site serves
1926 a large number of repositories, and serves them with multiple
1927 access methods, some of which do not allow push, this feature
1928 allows people to specify a pull-only URL and have git
1929 automatically use an appropriate URL to push, even for a
1930 never-before-seen repository on the site. When more than one
1931 pushInsteadOf strings match a given URL, the longest match is
1932 used. If a remote has an explicit pushurl, git will ignore this
1933 setting for that remote.
1936 Your email address to be recorded in any newly created commits.
1937 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1938 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1941 Your full name to be recorded in any newly created commits.
1942 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1943 environment variables. See linkgit:git-commit-tree[1].
1946 If linkgit:git-tag[1] is not selecting the key you want it to
1947 automatically when creating a signed tag, you can override the
1948 default selection with this variable. This option is passed
1949 unchanged to gpg's --local-user parameter, so you may specify a key
1950 using any method that gpg supports.
1953 Specify a web browser that may be used by some commands.
1954 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]