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.
157 core.ignoreCygwinFSTricks::
158 This option is only used by Cygwin implementation of Git. If false,
159 the Cygwin stat() and lstat() functions are used. This may be useful
160 if your repository consists of a few separate directories joined in
161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162 whenever it is possible and falls back to Cygwin functions only to
163 handle symbol links. The native mode is more than twice faster than
164 normal Cygwin l/stat() functions. True by default, unless core.filemode
165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166 POSIX emulation is required to support core.filemode.
169 If true, this option enables various workarounds to enable
170 git to work better on filesystems that are not case sensitive,
171 like FAT. For example, if a directory listing finds
172 "makefile" when git expects "Makefile", git will assume
173 it is really the same file, and continue to remember it as
176 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177 will probe and set core.ignorecase true if appropriate when the repository
181 If false, the ctime differences between the index and the
182 working copy are ignored; useful when the inode change time
183 is regularly modified by something outside Git (file system
184 crawlers and some backup systems).
185 See linkgit:git-update-index[1]. True by default.
188 The commands that output paths (e.g. 'ls-files',
189 'diff'), when not given the `-z` option, will quote
190 "unusual" characters in the pathname by enclosing the
191 pathname in a double-quote pair and with backslashes the
192 same way strings in C source code are quoted. If this
193 variable is set to false, the bytes higher than 0x80 are
194 not quoted but output as verbatim. Note that double
195 quote, backslash and control characters are always
196 quoted without `-z` regardless of the setting of this
200 Sets the line ending type to use in the working directory for
201 files that have the `text` property set. Alternatives are
202 'lf', 'crlf' and 'native', which uses the platform's native
203 line ending. The default value is `native`. See
204 linkgit:gitattributes[5] for more information on end-of-line
208 If true, makes git check if converting `CRLF` is reversible when
209 end-of-line conversion is active. Git will verify if a command
210 modifies a file in the work tree either directly or indirectly.
211 For example, committing a file followed by checking out the
212 same file should yield the original file in the work tree. If
213 this is not the case for the current setting of
214 `core.autocrlf`, git will reject the file. The variable can
215 be set to "warn", in which case git will only warn about an
216 irreversible conversion but continue the operation.
218 CRLF conversion bears a slight chance of corrupting data.
219 When it is enabled, git will convert CRLF to LF during commit and LF to
220 CRLF during checkout. A file that contains a mixture of LF and
221 CRLF before the commit cannot be recreated by git. For text
222 files this is the right thing to do: it corrects line endings
223 such that we have only LF line endings in the repository.
224 But for binary files that are accidentally classified as text the
225 conversion can corrupt data.
227 If you recognize such corruption early you can easily fix it by
228 setting the conversion type explicitly in .gitattributes. Right
229 after committing you still have the original file in your work
230 tree and this file is not yet corrupted. You can explicitly tell
231 git that this file is binary and git will handle the file
234 Unfortunately, the desired effect of cleaning up text files with
235 mixed line endings and the undesired effect of corrupting binary
236 files cannot be distinguished. In both cases CRLFs are removed
237 in an irreversible way. For text files this is the right thing
238 to do because CRLFs are line endings, while for binary files
239 converting CRLFs corrupts data.
241 Note, this safety check does not mean that a checkout will generate a
242 file identical to the original file for a different setting of
243 `core.eol` and `core.autocrlf`, but only for the current one. For
244 example, a text file with `LF` would be accepted with `core.eol=lf`
245 and could later be checked out with `core.eol=crlf`, in which case the
246 resulting file would contain `CRLF`, although the original file
247 contained `LF`. However, in both work trees the line endings would be
248 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249 file with mixed line endings would be reported by the `core.safecrlf`
253 Setting this variable to "true" is almost the same as setting
254 the `text` attribute to "auto" on all files except that text
255 files are not guaranteed to be normalized: files that contain
256 `CRLF` in the repository will not be touched. Use this
257 setting if you want to have `CRLF` line endings in your
258 working directory even though the repository does not have
259 normalized line endings. This variable can be set to 'input',
260 in which case no output conversion is performed.
263 If false, symbolic links are checked out as small plain files that
264 contain the link text. linkgit:git-update-index[1] and
265 linkgit:git-add[1] will not change the recorded type to regular
266 file. Useful on filesystems like FAT that do not support
269 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270 will probe and set core.symlinks false if appropriate when the repository
274 A "proxy command" to execute (as 'command host port') instead
275 of establishing direct connection to the remote server when
276 using the git protocol for fetching. If the variable value is
277 in the "COMMAND for DOMAIN" format, the command is applied only
278 on hostnames ending with the specified domain string. This variable
279 may be set multiple times and is matched in the given order;
280 the first match wins.
282 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283 (which always applies universally, without the special "for"
286 The special string `none` can be used as the proxy command to
287 specify that no proxy be used for a given domain pattern.
288 This is useful for excluding servers inside a firewall from
289 proxy use, while defaulting to a common proxy for external domains.
292 If true, commands which modify both the working tree and the index
293 will mark the updated paths with the "assume unchanged" bit in the
294 index. These marked files are then assumed to stay unchanged in the
295 working copy, until you mark them otherwise manually - Git will not
296 detect the file changes by lstat() calls. This is useful on systems
297 where those are very slow, such as Microsoft Windows.
298 See linkgit:git-update-index[1].
301 core.preferSymlinkRefs::
302 Instead of the default "symref" format for HEAD
303 and other symbolic reference files, use symbolic links.
304 This is sometimes needed to work with old scripts that
305 expect HEAD to be a symbolic link.
308 If true this repository is assumed to be 'bare' and has no
309 working directory associated with it. If this is the case a
310 number of commands that require a working directory will be
311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
313 This setting is automatically guessed by linkgit:git-clone[1] or
314 linkgit:git-init[1] when the repository was created. By default a
315 repository that ends in "/.git" is assumed to be not bare (bare =
316 false), while all other repositories are assumed to be bare (bare
320 Set the path to the root of the working tree.
321 This can be overridden by the GIT_WORK_TREE environment
322 variable and the '--work-tree' command line option.
323 The value can be an absolute path or relative to the path to
324 the .git directory, which is either specified by --git-dir
325 or GIT_DIR, or automatically discovered.
326 If --git-dir or GIT_DIR is specified but none of
327 --work-tree, GIT_WORK_TREE and core.worktree is specified,
328 the current working directory is regarded as the top level
329 of your working tree.
331 Note that this variable is honored even when set in a configuration
332 file in a ".git" subdirectory of a directory and its value differs
333 from the latter directory (e.g. "/path/to/.git/config" has
334 core.worktree set to "/different/path"), which is most likely a
335 misconfiguration. Running git commands in the "/path/to" directory will
336 still use "/different/path" as the root of the work tree and can cause
337 confusion unless you know what you are doing (e.g. you are creating a
338 read-only snapshot of the same index to a location different from the
339 repository's usual working tree).
341 core.logAllRefUpdates::
342 Enable the reflog. Updates to a ref <ref> is logged to the file
343 "$GIT_DIR/logs/<ref>", by appending the new and old
344 SHA1, the date/time and the reason of the update, but
345 only when the file exists. If this configuration
346 variable is set to true, missing "$GIT_DIR/logs/<ref>"
347 file is automatically created for branch heads.
349 This information can be used to determine what commit
350 was the tip of a branch "2 days ago".
352 This value is true by default in a repository that has
353 a working directory associated with it, and false by
354 default in a bare repository.
356 core.repositoryFormatVersion::
357 Internal variable identifying the repository format and layout
360 core.sharedRepository::
361 When 'group' (or 'true'), the repository is made shareable between
362 several users in a group (making sure all the files and objects are
363 group-writable). When 'all' (or 'world' or 'everybody'), the
364 repository will be readable by all users, additionally to being
365 group-shareable. When 'umask' (or 'false'), git will use permissions
366 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
367 files in the repository will have this mode value. '0xxx' will override
368 user's umask value (whereas the other options will only override
369 requested parts of the user's umask value). Examples: '0660' will make
370 the repo read/write-able for the owner and group, but inaccessible to
371 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
372 repository that is group-readable but not group-writable.
373 See linkgit:git-init[1]. False by default.
375 core.warnAmbiguousRefs::
376 If true, git will warn you if the ref name you passed it is ambiguous
377 and might match multiple refs in the .git/refs/ tree. True by default.
380 An integer -1..9, indicating a default compression level.
381 -1 is the zlib default. 0 means no compression,
382 and 1..9 are various speed/size tradeoffs, 9 being slowest.
383 If set, this provides a default to other compression variables,
384 such as 'core.loosecompression' and 'pack.compression'.
386 core.loosecompression::
387 An integer -1..9, indicating the compression level for objects that
388 are not in a pack file. -1 is the zlib default. 0 means no
389 compression, and 1..9 are various speed/size tradeoffs, 9 being
390 slowest. If not set, defaults to core.compression. If that is
391 not set, defaults to 1 (best speed).
393 core.packedGitWindowSize::
394 Number of bytes of a pack file to map into memory in a
395 single mapping operation. Larger window sizes may allow
396 your system to process a smaller number of large pack files
397 more quickly. Smaller window sizes will negatively affect
398 performance due to increased calls to the operating system's
399 memory manager, but may improve performance when accessing
400 a large number of large pack files.
402 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
403 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
404 be reasonable for all users/operating systems. You probably do
405 not need to adjust this value.
407 Common unit suffixes of 'k', 'm', or 'g' are supported.
409 core.packedGitLimit::
410 Maximum number of bytes to map simultaneously into memory
411 from pack files. If Git needs to access more than this many
412 bytes at once to complete an operation it will unmap existing
413 regions to reclaim virtual address space within the process.
415 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
416 This should be reasonable for all users/operating systems, except on
417 the largest projects. You probably do not need to adjust this value.
419 Common unit suffixes of 'k', 'm', or 'g' are supported.
421 core.deltaBaseCacheLimit::
422 Maximum number of bytes to reserve for caching base objects
423 that may be referenced by multiple deltified objects. By storing the
424 entire decompressed base objects in a cache Git is able
425 to avoid unpacking and decompressing frequently used base
426 objects multiple times.
428 Default is 16 MiB on all platforms. This should be reasonable
429 for all users/operating systems, except on the largest projects.
430 You probably do not need to adjust this value.
432 Common unit suffixes of 'k', 'm', or 'g' are supported.
434 core.bigFileThreshold::
435 Files larger than this size are stored deflated, without
436 attempting delta compression. Storing large files without
437 delta compression avoids excessive memory usage, at the
438 slight expense of increased disk usage.
440 Default is 512 MiB on all platforms. This should be reasonable
441 for most projects as source code and other text files can still
442 be delta compressed, but larger binary media files won't be.
444 Common unit suffixes of 'k', 'm', or 'g' are supported.
446 Currently only linkgit:git-fast-import[1] honors this setting.
449 In addition to '.gitignore' (per-directory) and
450 '.git/info/exclude', git looks into this file for patterns
451 of files which are not meant to be tracked. "{tilde}/" is expanded
452 to the value of `$HOME` and "{tilde}user/" to the specified user's
453 home directory. See linkgit:gitignore[5].
456 Some commands (e.g. svn and http interfaces) that interactively
457 ask for a password can be told to use an external program given
458 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
459 environment variable. If not set, fall back to the value of the
460 'SSH_ASKPASS' environment variable or, failing that, a simple password
461 prompt. The external program shall be given a suitable prompt as
462 command line argument and write the password on its STDOUT.
464 core.attributesfile::
465 In addition to '.gitattributes' (per-directory) and
466 '.git/info/attributes', git looks into this file for attributes
467 (see linkgit:gitattributes[5]). Path expansions are made the same
468 way as for `core.excludesfile`.
471 Commands such as `commit` and `tag` that lets you edit
472 messages by launching an editor uses the value of this
473 variable when it is set, and the environment variable
474 `GIT_EDITOR` is not set. See linkgit:git-var[1].
477 The command that git will use to paginate output. Can
478 be overridden with the `GIT_PAGER` environment
479 variable. Note that git sets the `LESS` environment
480 variable to `FRSX` if it is unset when it runs the
481 pager. One can change these settings by setting the
482 `LESS` variable to some other value. Alternately,
483 these settings can be overridden on a project or
484 global basis by setting the `core.pager` option.
485 Setting `core.pager` has no affect on the `LESS`
486 environment variable behaviour above, so if you want
487 to override git's default settings this way, you need
488 to be explicit. For example, to disable the S option
489 in a backward compatible manner, set `core.pager`
490 to `less -+$LESS -FRX`. This will be passed to the
491 shell by git, which will translate the final command to
492 `LESS=FRSX less -+FRSX -FRX`.
495 A comma separated list of common whitespace problems to
496 notice. 'git diff' will use `color.diff.whitespace` to
497 highlight them, and 'git apply --whitespace=error' will
498 consider them as errors. You can prefix `-` to disable
499 any of them (e.g. `-trailing-space`):
501 * `blank-at-eol` treats trailing whitespaces at the end of the line
502 as an error (enabled by default).
503 * `space-before-tab` treats a space character that appears immediately
504 before a tab character in the initial indent part of the line as an
505 error (enabled by default).
506 * `indent-with-non-tab` treats a line that is indented with 8 or more
507 space characters as an error (not enabled by default).
508 * `tab-in-indent` treats a tab character in the initial indent part of
509 the line as an error (not enabled by default).
510 * `blank-at-eof` treats blank lines added at the end of file as an error
511 (enabled by default).
512 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
514 * `cr-at-eol` treats a carriage-return at the end of line as
515 part of the line terminator, i.e. with it, `trailing-space`
516 does not trigger if the character before such a carriage-return
517 is not a whitespace (not enabled by default).
518 * `tabwidth=<n>` tells how many character positions a tab occupies; this
519 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
520 errors. The default tab width is 8. Allowed values are 1 to 63.
522 core.fsyncobjectfiles::
523 This boolean will enable 'fsync()' when writing object files.
525 This is a total waste of time and effort on a filesystem that orders
526 data writes properly, but can be useful for filesystems that do not use
527 journalling (traditional UNIX filesystems) or that only journal metadata
528 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
531 Enable parallel index preload for operations like 'git diff'
533 This can speed up operations like 'git diff' and 'git status' especially
534 on filesystems like NFS that have weak caching semantics and thus
535 relatively high IO latencies. With this set to 'true', git will do the
536 index comparison to the filesystem data in parallel, allowing
540 You can set this to 'link', in which case a hardlink followed by
541 a delete of the source are used to make sure that object creation
542 will not overwrite existing objects.
544 On some file system/operating system combinations, this is unreliable.
545 Set this config setting to 'rename' there; However, This will remove the
546 check that makes sure that existing object files will not get overwritten.
549 When showing commit messages, also show notes which are stored in
550 the given ref. The ref must be fully qualified. If the given
551 ref does not exist, it is not an error but means that no
552 notes should be printed.
554 This setting defaults to "refs/notes/commits", and it can be overridden by
555 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
557 core.sparseCheckout::
558 Enable "sparse checkout" feature. See section "Sparse checkout" in
559 linkgit:git-read-tree[1] for more information.
562 Set the length object names are abbreviated to. If unspecified,
563 many commands abbreviate to 7 hexdigits, which may not be enough
564 for abbreviated object names to stay unique for sufficiently long
569 Tells 'git add' to continue adding files when some files cannot be
570 added due to indexing errors. Equivalent to the '--ignore-errors'
571 option of linkgit:git-add[1]. Older versions of git accept only
572 `add.ignore-errors`, which does not follow the usual naming
573 convention for configuration variables. Newer versions of git
574 honor `add.ignoreErrors` as well.
577 Command aliases for the linkgit:git[1] command wrapper - e.g.
578 after defining "alias.last = cat-file commit HEAD", the invocation
579 "git last" is equivalent to "git cat-file commit HEAD". To avoid
580 confusion and troubles with script usage, aliases that
581 hide existing git commands are ignored. Arguments are split by
582 spaces, the usual shell quoting and escaping is supported.
583 quote pair and a backslash can be used to quote them.
585 If the alias expansion is prefixed with an exclamation point,
586 it will be treated as a shell command. For example, defining
587 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
588 "git new" is equivalent to running the shell command
589 "gitk --all --not ORIG_HEAD". Note that shell commands will be
590 executed from the top-level directory of a repository, which may
591 not necessarily be the current directory.
594 If true, git-am will call git-mailsplit for patches in mbox format
595 with parameter '--keep-cr'. In this case git-mailsplit will
596 not remove `\r` from lines ending with `\r\n`. Can be overridden
597 by giving '--no-keep-cr' from the command line.
598 See linkgit:git-am[1], linkgit:git-mailsplit[1].
600 apply.ignorewhitespace::
601 When set to 'change', tells 'git apply' to ignore changes in
602 whitespace, in the same way as the '--ignore-space-change'
604 When set to one of: no, none, never, false tells 'git apply' to
605 respect all whitespace differences.
606 See linkgit:git-apply[1].
609 Tells 'git apply' how to handle whitespaces, in the same way
610 as the '--whitespace' option. See linkgit:git-apply[1].
612 branch.autosetupmerge::
613 Tells 'git branch' and 'git checkout' to set up new branches
614 so that linkgit:git-pull[1] will appropriately merge from the
615 starting point branch. Note that even if this option is not set,
616 this behavior can be chosen per-branch using the `--track`
617 and `--no-track` options. The valid settings are: `false` -- no
618 automatic setup is done; `true` -- automatic setup is done when the
619 starting point is a remote-tracking branch; `always` --
620 automatic setup is done when the starting point is either a
621 local branch or remote-tracking
622 branch. This option defaults to true.
624 branch.autosetuprebase::
625 When a new branch is created with 'git branch' or 'git checkout'
626 that tracks another branch, this variable tells git to set
627 up pull to rebase instead of merge (see "branch.<name>.rebase").
628 When `never`, rebase is never automatically set to true.
629 When `local`, rebase is set to true for tracked branches of
630 other local branches.
631 When `remote`, rebase is set to true for tracked branches of
632 remote-tracking branches.
633 When `always`, rebase will be set to true for all tracking
635 See "branch.autosetupmerge" for details on how to set up a
636 branch to track another branch.
637 This option defaults to never.
639 branch.<name>.remote::
640 When in branch <name>, it tells 'git fetch' and 'git push' which
641 remote to fetch from/push to. It defaults to `origin` if no remote is
642 configured. `origin` is also used if you are not on any branch.
644 branch.<name>.merge::
645 Defines, together with branch.<name>.remote, the upstream branch
646 for the given branch. It tells 'git fetch'/'git pull' which
647 branch to merge and can also affect 'git push' (see push.default).
648 When in branch <name>, it tells 'git fetch' the default
649 refspec to be marked for merging in FETCH_HEAD. The value is
650 handled like the remote part of a refspec, and must match a
651 ref which is fetched from the remote given by
652 "branch.<name>.remote".
653 The merge information is used by 'git pull' (which at first calls
654 'git fetch') to lookup the default branch for merging. Without
655 this option, 'git pull' defaults to merge the first refspec fetched.
656 Specify multiple values to get an octopus merge.
657 If you wish to setup 'git pull' so that it merges into <name> from
658 another branch in the local repository, you can point
659 branch.<name>.merge to the desired branch, and use the special setting
660 `.` (a period) for branch.<name>.remote.
662 branch.<name>.mergeoptions::
663 Sets default options for merging into branch <name>. The syntax and
664 supported options are the same as those of linkgit:git-merge[1], but
665 option values containing whitespace characters are currently not
668 branch.<name>.rebase::
669 When true, rebase the branch <name> on top of the fetched branch,
670 instead of merging the default branch from the default remote when
672 *NOTE*: this is a possibly dangerous operation; do *not* use
673 it unless you understand the implications (see linkgit:git-rebase[1]
677 Specify the command to invoke the specified browser. The
678 specified command is evaluated in shell with the URLs passed
679 as arguments. (See linkgit:git-web--browse[1].)
681 browser.<tool>.path::
682 Override the path for the given tool that may be used to
683 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
684 working repository in gitweb (see linkgit:git-instaweb[1]).
687 A boolean to make git-clean do nothing unless given -f
688 or -n. Defaults to true.
691 A boolean to enable/disable color in the output of
692 linkgit:git-branch[1]. May be set to `always`,
693 `false` (or `never`) or `auto` (or `true`), in which case colors are used
694 only when the output is to a terminal. Defaults to false.
696 color.branch.<slot>::
697 Use customized color for branch coloration. `<slot>` is one of
698 `current` (the current branch), `local` (a local branch),
699 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
702 The value for these configuration variables is a list of colors (at most
703 two) and attributes (at most one), separated by spaces. The colors
704 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
705 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
706 `blink` and `reverse`. The first color given is the foreground; the
707 second is the background. The position of the attribute, if any,
711 When set to `always`, always use colors in patch.
712 When false (or `never`), never. When set to `true` or `auto`, use
713 colors only when the output is to the terminal. Defaults to false.
716 Use customized color for diff colorization. `<slot>` specifies
717 which part of the patch to use the specified color, and is one
718 of `plain` (context text), `meta` (metainformation), `frag`
719 (hunk header), 'func' (function in hunk header), `old` (removed lines),
720 `new` (added lines), `commit` (commit headers), or `whitespace`
721 (highlighting whitespace errors). The values of these variables may be
722 specified as in color.branch.<slot>.
724 color.decorate.<slot>::
725 Use customized color for 'git log --decorate' output. `<slot>` is one
726 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
727 branches, remote-tracking branches, tags, stash and HEAD, respectively.
730 When set to `always`, always highlight matches. When `false` (or
731 `never`), never. When set to `true` or `auto`, use color only
732 when the output is written to the terminal. Defaults to `false`.
735 Use customized color for grep colorization. `<slot>` specifies which
736 part of the line to use the specified color, and is one of
740 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
742 filename prefix (when not using `-h`)
744 function name lines (when using `-p`)
746 line number prefix (when using `-n`)
750 non-matching text in selected lines
752 separators between fields on a line (`:`, `-`, and `=`)
753 and between hunks (`--`)
756 The values of these variables may be specified as in color.branch.<slot>.
759 When set to `always`, always use colors for interactive prompts
760 and displays (such as those used by "git-add --interactive").
761 When false (or `never`), never. When set to `true` or `auto`, use
762 colors only when the output is to the terminal. Defaults to false.
764 color.interactive.<slot>::
765 Use customized color for 'git add --interactive'
766 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
767 four distinct types of normal output from interactive
768 commands. The values of these variables may be specified as
769 in color.branch.<slot>.
772 A boolean to enable/disable colored output when the pager is in
773 use (default is true).
776 A boolean to enable/disable color in the output of
777 linkgit:git-show-branch[1]. May be set to `always`,
778 `false` (or `never`) or `auto` (or `true`), in which case colors are used
779 only when the output is to a terminal. Defaults to false.
782 A boolean to enable/disable color in the output of
783 linkgit:git-status[1]. May be set to `always`,
784 `false` (or `never`) or `auto` (or `true`), in which case colors are used
785 only when the output is to a terminal. Defaults to false.
787 color.status.<slot>::
788 Use customized color for status colorization. `<slot>` is
789 one of `header` (the header text of the status message),
790 `added` or `updated` (files which are added but not committed),
791 `changed` (files which are changed but not added in the index),
792 `untracked` (files which are not tracked by git),
793 `branch` (the current branch), or
794 `nobranch` (the color the 'no branch' warning is shown in, defaulting
795 to red). The values of these variables may be specified as in
799 When set to `always`, always use colors in all git commands which
800 are capable of colored output. When false (or `never`), never. When
801 set to `true` or `auto`, use colors only when the output is to the
802 terminal. When more specific variables of color.* are set, they always
803 take precedence over this setting. Defaults to false.
806 A boolean to enable/disable inclusion of status information in the
807 commit message template when using an editor to prepare the commit
808 message. Defaults to true.
811 Specify a file to use as the template for new commit messages.
812 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
813 specified user's home directory.
815 include::diff-config.txt[]
817 difftool.<tool>.path::
818 Override the path for the given tool. This is useful in case
819 your tool is not in the PATH.
821 difftool.<tool>.cmd::
822 Specify the command to invoke the specified diff tool.
823 The specified command is evaluated in shell with the following
824 variables available: 'LOCAL' is set to the name of the temporary
825 file containing the contents of the diff pre-image and 'REMOTE'
826 is set to the name of the temporary file containing the contents
827 of the diff post-image.
830 Prompt before each invocation of the diff tool.
833 A POSIX Extended Regular Expression used to determine what is a "word"
834 when performing word-by-word difference calculations. Character
835 sequences that match the regular expression are "words", all other
836 characters are *ignorable* whitespace.
838 fetch.recurseSubmodules::
839 A boolean value which changes the behavior for fetch and pull, the
840 default is to not recursively fetch populated submodules unless
841 configured otherwise.
844 If the number of objects fetched over the git native
845 transfer is below this
846 limit, then the objects will be unpacked into loose object
847 files. However if the number of received objects equals or
848 exceeds this limit then the received pack will be stored as
849 a pack, after adding any missing delta bases. Storing the
850 pack from a push can make the push operation complete faster,
851 especially on slow filesystems. If not set, the value of
852 `transfer.unpackLimit` is used instead.
855 Enable multipart/mixed attachments as the default for
856 'format-patch'. The value can also be a double quoted string
857 which will enable attachments as the default and set the
858 value as the boundary. See the --attach option in
859 linkgit:git-format-patch[1].
862 A boolean which can enable or disable sequence numbers in patch
863 subjects. It defaults to "auto" which enables it only if there
864 is more than one patch. It can be enabled or disabled for all
865 messages by setting it to "true" or "false". See --numbered
866 option in linkgit:git-format-patch[1].
869 Additional email headers to include in a patch to be submitted
870 by mail. See linkgit:git-format-patch[1].
874 Additional recipients to include in a patch to be submitted
875 by mail. See the --to and --cc options in
876 linkgit:git-format-patch[1].
878 format.subjectprefix::
879 The default for format-patch is to output files with the '[PATCH]'
880 subject prefix. Use this variable to change that prefix.
883 The default for format-patch is to output a signature containing
884 the git version number. Use this variable to change that default.
885 Set this variable to the empty string ("") to suppress
886 signature generation.
889 The default for format-patch is to output files with the suffix
890 `.patch`. Use this variable to change that suffix (make sure to
891 include the dot if you want it).
894 The default pretty format for log/show/whatchanged command,
895 See linkgit:git-log[1], linkgit:git-show[1],
896 linkgit:git-whatchanged[1].
899 The default threading style for 'git format-patch'. Can be
900 a boolean value, or `shallow` or `deep`. `shallow` threading
901 makes every mail a reply to the head of the series,
902 where the head is chosen from the cover letter, the
903 `\--in-reply-to`, and the first patch mail, in this order.
904 `deep` threading makes every mail a reply to the previous one.
905 A true boolean value is the same as `shallow`, and a false
906 value disables threading.
909 A boolean value which lets you enable the `-s/--signoff` option of
910 format-patch by default. *Note:* Adding the Signed-off-by: line to a
911 patch should be a conscious act and means that you certify you have
912 the rights to submit this work under the same open source license.
913 Please see the 'SubmittingPatches' document for further discussion.
915 filter.<driver>.clean::
916 The command which is used to convert the content of a worktree
917 file to a blob upon checkin. See linkgit:gitattributes[5] for
920 filter.<driver>.smudge::
921 The command which is used to convert the content of a blob
922 object to a worktree file upon checkout. See
923 linkgit:gitattributes[5] for details.
925 gc.aggressiveWindow::
926 The window size parameter used in the delta compression
927 algorithm used by 'git gc --aggressive'. This defaults
931 When there are approximately more than this many loose
932 objects in the repository, `git gc --auto` will pack them.
933 Some Porcelain commands use this command to perform a
934 light-weight garbage collection from time to time. The
935 default value is 6700. Setting this to 0 disables it.
938 When there are more than this many packs that are not
939 marked with `*.keep` file in the repository, `git gc
940 --auto` consolidates them into one larger pack. The
941 default value is 50. Setting this to 0 disables it.
944 Running `git pack-refs` in a repository renders it
945 unclonable by Git versions prior to 1.5.1.2 over dumb
946 transports such as HTTP. This variable determines whether
947 'git gc' runs `git pack-refs`. This can be set to `notbare`
948 to enable it within all non-bare repos or it can be set to a
949 boolean value. The default is `true`.
952 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
953 Override the grace period with this config variable. The value
954 "now" may be used to disable this grace period and always prune
955 unreachable objects immediately.
958 gc.<pattern>.reflogexpire::
959 'git reflog expire' removes reflog entries older than
960 this time; defaults to 90 days. With "<pattern>" (e.g.
961 "refs/stash") in the middle the setting applies only to
962 the refs that match the <pattern>.
964 gc.reflogexpireunreachable::
965 gc.<ref>.reflogexpireunreachable::
966 'git reflog expire' removes reflog entries older than
967 this time and are not reachable from the current tip;
968 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
969 in the middle, the setting applies only to the refs that
973 Records of conflicted merge you resolved earlier are
974 kept for this many days when 'git rerere gc' is run.
975 The default is 60 days. See linkgit:git-rerere[1].
977 gc.rerereunresolved::
978 Records of conflicted merge you have not resolved are
979 kept for this many days when 'git rerere gc' is run.
980 The default is 15 days. See linkgit:git-rerere[1].
982 gitcvs.commitmsgannotation::
983 Append this string to each commit message. Set to empty string
984 to disable this feature. Defaults to "via git-CVS emulator".
987 Whether the CVS server interface is enabled for this repository.
988 See linkgit:git-cvsserver[1].
991 Path to a log file where the CVS server interface well... logs
992 various stuff. See linkgit:git-cvsserver[1].
995 If true, the server will look up the end-of-line conversion
996 attributes for files to determine the '-k' modes to use. If
997 the attributes force git to treat a file as text,
998 the '-k' mode will be left blank so CVS clients will
999 treat it as text. If they suppress text conversion, the file
1000 will be set with '-kb' mode, which suppresses any newline munging
1001 the client might otherwise do. If the attributes do not allow
1002 the file type to be determined, then 'gitcvs.allbinary' is
1003 used. See linkgit:gitattributes[5].
1006 This is used if 'gitcvs.usecrlfattr' does not resolve
1007 the correct '-kb' mode to use. If true, all
1008 unresolved files are sent to the client in
1009 mode '-kb'. This causes the client to treat them
1010 as binary files, which suppresses any newline munging it
1011 otherwise might do. Alternatively, if it is set to "guess",
1012 then the contents of the file are examined to decide if
1013 it is binary, similar to 'core.autocrlf'.
1016 Database used by git-cvsserver to cache revision information
1017 derived from the git repository. The exact meaning depends on the
1018 used database driver, for SQLite (which is the default driver) this
1019 is a filename. Supports variable substitution (see
1020 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1021 Default: '%Ggitcvs.%m.sqlite'
1024 Used Perl DBI driver. You can specify any available driver
1025 for this here, but it might not work. git-cvsserver is tested
1026 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1027 reported *not* to work with 'DBD::mysql'. Experimental feature.
1028 May not contain double colons (`:`). Default: 'SQLite'.
1029 See linkgit:git-cvsserver[1].
1031 gitcvs.dbuser, gitcvs.dbpass::
1032 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1033 since SQLite has no concept of database users and/or passwords.
1034 'gitcvs.dbuser' supports variable substitution (see
1035 linkgit:git-cvsserver[1] for details).
1037 gitcvs.dbTableNamePrefix::
1038 Database table name prefix. Prepended to the names of any
1039 database tables used, allowing a single database to be used
1040 for several repositories. Supports variable substitution (see
1041 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1042 characters will be replaced with underscores.
1044 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1045 'gitcvs.allbinary' can also be specified as
1046 'gitcvs.<access_method>.<varname>' (where 'access_method'
1047 is one of "ext" and "pserver") to make them apply only for the given
1050 gui.commitmsgwidth::
1051 Defines how wide the commit message window is in the
1052 linkgit:git-gui[1]. "75" is the default.
1055 Specifies how many context lines should be used in calls to diff
1056 made by the linkgit:git-gui[1]. The default is "5".
1059 Specifies the default encoding to use for displaying of
1060 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1061 It can be overridden by setting the 'encoding' attribute
1062 for relevant files (see linkgit:gitattributes[5]).
1063 If this option is not set, the tools default to the
1066 gui.matchtrackingbranch::
1067 Determines if new branches created with linkgit:git-gui[1] should
1068 default to tracking remote branches with matching names or
1069 not. Default: "false".
1071 gui.newbranchtemplate::
1072 Is used as suggested name when creating new branches using the
1075 gui.pruneduringfetch::
1076 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1077 performing a fetch. The default value is "false".
1080 Determines if linkgit:git-gui[1] should trust the file modification
1081 timestamp or not. By default the timestamps are not trusted.
1083 gui.spellingdictionary::
1084 Specifies the dictionary used for spell checking commit messages in
1085 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1089 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1090 location detection. It makes blame significantly faster on huge
1091 repositories at the expense of less thorough copy detection.
1093 gui.copyblamethreshold::
1094 Specifies the threshold to use in 'git gui blame' original location
1095 detection, measured in alphanumeric characters. See the
1096 linkgit:git-blame[1] manual for more information on copy detection.
1098 gui.blamehistoryctx::
1099 Specifies the radius of history context in days to show in
1100 linkgit:gitk[1] for the selected commit, when the `Show History
1101 Context` menu item is invoked from 'git gui blame'. If this
1102 variable is set to zero, the whole history is shown.
1104 guitool.<name>.cmd::
1105 Specifies the shell command line to execute when the corresponding item
1106 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1107 mandatory for every tool. The command is executed from the root of
1108 the working directory, and in the environment it receives the name of
1109 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1110 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1111 the head is detached, 'CUR_BRANCH' is empty).
1113 guitool.<name>.needsfile::
1114 Run the tool only if a diff is selected in the GUI. It guarantees
1115 that 'FILENAME' is not empty.
1117 guitool.<name>.noconsole::
1118 Run the command silently, without creating a window to display its
1121 guitool.<name>.norescan::
1122 Don't rescan the working directory for changes after the tool
1125 guitool.<name>.confirm::
1126 Show a confirmation dialog before actually running the tool.
1128 guitool.<name>.argprompt::
1129 Request a string argument from the user, and pass it to the tool
1130 through the 'ARGS' environment variable. Since requesting an
1131 argument implies confirmation, the 'confirm' option has no effect
1132 if this is enabled. If the option is set to 'true', 'yes', or '1',
1133 the dialog uses a built-in generic prompt; otherwise the exact
1134 value of the variable is used.
1136 guitool.<name>.revprompt::
1137 Request a single valid revision from the user, and set the
1138 'REVISION' environment variable. In other aspects this option
1139 is similar to 'argprompt', and can be used together with it.
1141 guitool.<name>.revunmerged::
1142 Show only unmerged branches in the 'revprompt' subdialog.
1143 This is useful for tools similar to merge or rebase, but not
1144 for things like checkout or reset.
1146 guitool.<name>.title::
1147 Specifies the title to use for the prompt dialog. The default
1150 guitool.<name>.prompt::
1151 Specifies the general prompt string to display at the top of
1152 the dialog, before subsections for 'argprompt' and 'revprompt'.
1153 The default value includes the actual command.
1156 Specify the browser that will be used to display help in the
1157 'web' format. See linkgit:git-help[1].
1160 Override the default help format used by linkgit:git-help[1].
1161 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1162 the default. 'web' and 'html' are the same.
1165 Automatically correct and execute mistyped commands after
1166 waiting for the given number of deciseconds (0.1 sec). If more
1167 than one command can be deduced from the entered text, nothing
1168 will be executed. If the value of this option is negative,
1169 the corrected command will be executed immediately. If the
1170 value is 0 - the command will be just shown but not executed.
1171 This is the default.
1174 Override the HTTP proxy, normally configured using the 'http_proxy'
1175 environment variable (see linkgit:curl[1]). This can be overridden
1176 on a per-remote basis; see remote.<name>.proxy
1179 Whether to verify the SSL certificate when fetching or pushing
1180 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1184 File containing the SSL certificate when fetching or pushing
1185 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1189 File containing the SSL private key when fetching or pushing
1190 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1193 http.sslCertPasswordProtected::
1194 Enable git's password prompt for the SSL certificate. Otherwise
1195 OpenSSL will prompt the user, possibly many times, if the
1196 certificate or private key is encrypted. Can be overridden by the
1197 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1200 File containing the certificates to verify the peer with when
1201 fetching or pushing over HTTPS. Can be overridden by the
1202 'GIT_SSL_CAINFO' environment variable.
1205 Path containing files with the CA certificates to verify the peer
1206 with when fetching or pushing over HTTPS. Can be overridden
1207 by the 'GIT_SSL_CAPATH' environment variable.
1210 How many HTTP requests to launch in parallel. Can be overridden
1211 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1214 The number of curl sessions (counted across slots) to be kept across
1215 requests. They will not be ended with curl_easy_cleanup() until
1216 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1217 value will be capped at 1. Defaults to 1.
1220 Maximum size in bytes of the buffer used by smart HTTP
1221 transports when POSTing data to the remote system.
1222 For requests larger than this buffer size, HTTP/1.1 and
1223 Transfer-Encoding: chunked is used to avoid creating a
1224 massive pack file locally. Default is 1 MiB, which is
1225 sufficient for most requests.
1227 http.lowSpeedLimit, http.lowSpeedTime::
1228 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1229 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1230 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1231 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1234 A boolean which disables using of EPSV ftp command by curl.
1235 This can helpful with some "poor" ftp servers which don't
1236 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1237 environment variable. Default is false (curl will use EPSV).
1240 The HTTP USER_AGENT string presented to an HTTP server. The default
1241 value represents the version of the client git such as git/1.7.1.
1242 This option allows you to override this value to a more common value
1243 such as Mozilla/4.0. This may be necessary, for instance, if
1244 connecting through a firewall that restricts HTTP connections to a set
1245 of common USER_AGENT strings (but not including those like git/1.7.1).
1246 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1248 i18n.commitEncoding::
1249 Character encoding the commit messages are stored in; git itself
1250 does not care per se, but this information is necessary e.g. when
1251 importing commits from emails or in the gitk graphical history
1252 browser (and possibly at other places in the future or in other
1253 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1255 i18n.logOutputEncoding::
1256 Character encoding the commit messages are converted to when
1257 running 'git log' and friends.
1260 The configuration variables in the 'imap' section are described
1261 in linkgit:git-imap-send[1].
1264 Specify the directory from which templates will be copied.
1265 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1268 Specify the program that will be used to browse your working
1269 repository in gitweb. See linkgit:git-instaweb[1].
1272 The HTTP daemon command-line to start gitweb on your working
1273 repository. See linkgit:git-instaweb[1].
1276 If true the web server started by linkgit:git-instaweb[1] will
1277 be bound to the local IP (127.0.0.1).
1279 instaweb.modulepath::
1280 The default module path for linkgit:git-instaweb[1] to use
1281 instead of /usr/lib/apache2/modules. Only used if httpd
1285 The port number to bind the gitweb httpd to. See
1286 linkgit:git-instaweb[1].
1288 interactive.singlekey::
1289 In interactive commands, allow the user to provide one-letter
1290 input with a single key (i.e., without hitting enter).
1291 Currently this is used only by the `\--patch` mode of
1292 linkgit:git-add[1]. Note that this setting is silently
1293 ignored if portable keystroke input is not available.
1296 Set the default date-time mode for the 'log' command.
1297 Setting a value for log.date is similar to using 'git log''s
1298 `\--date` option. Possible values are `relative`, `local`,
1299 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1303 Print out the ref names of any commits that are shown by the log
1304 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1305 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1306 specified, the full ref name (including prefix) will be printed.
1307 This is the same as the log commands '--decorate' option.
1310 If true, the initial commit will be shown as a big creation event.
1311 This is equivalent to a diff against an empty tree.
1312 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1313 normally hide the root commit will now show it. True by default.
1316 The location of an augmenting mailmap file. The default
1317 mailmap, located in the root of the repository, is loaded
1318 first, then the mailmap file pointed to by this variable.
1319 The location of the mailmap file may be in a repository
1320 subdirectory, or somewhere outside of the repository itself.
1321 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1324 Specify the programs that may be used to display help in the
1325 'man' format. See linkgit:git-help[1].
1328 Specify the command to invoke the specified man viewer. The
1329 specified command is evaluated in shell with the man page
1330 passed as argument. (See linkgit:git-help[1].)
1333 Override the path for the given tool that may be used to
1334 display help in the 'man' format. See linkgit:git-help[1].
1336 include::merge-config.txt[]
1338 mergetool.<tool>.path::
1339 Override the path for the given tool. This is useful in case
1340 your tool is not in the PATH.
1342 mergetool.<tool>.cmd::
1343 Specify the command to invoke the specified merge tool. The
1344 specified command is evaluated in shell with the following
1345 variables available: 'BASE' is the name of a temporary file
1346 containing the common base of the files to be merged, if available;
1347 'LOCAL' is the name of a temporary file containing the contents of
1348 the file on the current branch; 'REMOTE' is the name of a temporary
1349 file containing the contents of the file from the branch being
1350 merged; 'MERGED' contains the name of the file to which the merge
1351 tool should write the results of a successful merge.
1353 mergetool.<tool>.trustExitCode::
1354 For a custom merge command, specify whether the exit code of
1355 the merge command can be used to determine whether the merge was
1356 successful. If this is not set to true then the merge target file
1357 timestamp is checked and the merge assumed to have been successful
1358 if the file has been updated, otherwise the user is prompted to
1359 indicate the success of the merge.
1361 mergetool.keepBackup::
1362 After performing a merge, the original file with conflict markers
1363 can be saved as a file with a `.orig` extension. If this variable
1364 is set to `false` then this file is not preserved. Defaults to
1365 `true` (i.e. keep the backup files).
1367 mergetool.keepTemporaries::
1368 When invoking a custom merge tool, git uses a set of temporary
1369 files to pass to the tool. If the tool returns an error and this
1370 variable is set to `true`, then these temporary files will be
1371 preserved, otherwise they will be removed after the tool has
1372 exited. Defaults to `false`.
1375 Prompt before each invocation of the merge resolution program.
1378 The (fully qualified) refname from which to show notes when
1379 showing commit messages. The value of this variable can be set
1380 to a glob, in which case notes from all matching refs will be
1381 shown. You may also specify this configuration variable
1382 several times. A warning will be issued for refs that do not
1383 exist, but a glob that does not match any refs is silently
1386 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1387 environment variable, which must be a colon separated list of refs or
1390 The effective value of "core.notesRef" (possibly overridden by
1391 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1394 notes.rewrite.<command>::
1395 When rewriting commits with <command> (currently `amend` or
1396 `rebase`) and this variable is set to `true`, git
1397 automatically copies your notes from the original to the
1398 rewritten commit. Defaults to `true`, but see
1399 "notes.rewriteRef" below.
1402 When copying notes during a rewrite (see the
1403 "notes.rewrite.<command>" option), determines what to do if
1404 the target commit already has a note. Must be one of
1405 `overwrite`, `concatenate`, or `ignore`. Defaults to
1408 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1409 environment variable.
1412 When copying notes during a rewrite, specifies the (fully
1413 qualified) ref whose notes should be copied. The ref may be a
1414 glob, in which case notes in all matching refs will be copied.
1415 You may also specify this configuration several times.
1417 Does not have a default value; you must configure this variable to
1418 enable note rewriting.
1420 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1421 environment variable, which must be a colon separated list of refs or
1425 The size of the window used by linkgit:git-pack-objects[1] when no
1426 window size is given on the command line. Defaults to 10.
1429 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1430 maximum depth is given on the command line. Defaults to 50.
1433 The window memory size limit used by linkgit:git-pack-objects[1]
1434 when no limit is given on the command line. The value can be
1435 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1439 An integer -1..9, indicating the compression level for objects
1440 in a pack file. -1 is the zlib default. 0 means no
1441 compression, and 1..9 are various speed/size tradeoffs, 9 being
1442 slowest. If not set, defaults to core.compression. If that is
1443 not set, defaults to -1, the zlib default, which is "a default
1444 compromise between speed and compression (currently equivalent
1447 Note that changing the compression level will not automatically recompress
1448 all existing objects. You can force recompression by passing the -F option
1449 to linkgit:git-repack[1].
1451 pack.deltaCacheSize::
1452 The maximum memory in bytes used for caching deltas in
1453 linkgit:git-pack-objects[1] before writing them out to a pack.
1454 This cache is used to speed up the writing object phase by not
1455 having to recompute the final delta result once the best match
1456 for all objects is found. Repacking large repositories on machines
1457 which are tight with memory might be badly impacted by this though,
1458 especially if this cache pushes the system into swapping.
1459 A value of 0 means no limit. The smallest size of 1 byte may be
1460 used to virtually disable this cache. Defaults to 256 MiB.
1462 pack.deltaCacheLimit::
1463 The maximum size of a delta, that is cached in
1464 linkgit:git-pack-objects[1]. This cache is used to speed up the
1465 writing object phase by not having to recompute the final delta
1466 result once the best match for all objects is found. Defaults to 1000.
1469 Specifies the number of threads to spawn when searching for best
1470 delta matches. This requires that linkgit:git-pack-objects[1]
1471 be compiled with pthreads otherwise this option is ignored with a
1472 warning. This is meant to reduce packing time on multiprocessor
1473 machines. The required amount of memory for the delta search window
1474 is however multiplied by the number of threads.
1475 Specifying 0 will cause git to auto-detect the number of CPU's
1476 and set the number of threads accordingly.
1479 Specify the default pack index version. Valid values are 1 for
1480 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1481 the new pack index with capabilities for packs larger than 4 GB
1482 as well as proper protection against the repacking of corrupted
1483 packs. Version 2 is the default. Note that version 2 is enforced
1484 and this config option ignored whenever the corresponding pack is
1487 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1488 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1489 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1490 other side may give you a repository that cannot be accessed with your
1491 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1492 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1493 the `{asterisk}.idx` file.
1495 pack.packSizeLimit::
1496 The maximum size of a pack. This setting only affects
1497 packing to a file when repacking, i.e. the git:// protocol
1498 is unaffected. It can be overridden by the `\--max-pack-size`
1499 option of linkgit:git-repack[1]. The minimum size allowed is
1500 limited to 1 MiB. The default is unlimited.
1501 Common unit suffixes of 'k', 'm', or 'g' are
1505 If the value is boolean, turns on or off pagination of the
1506 output of a particular git subcommand when writing to a tty.
1507 Otherwise, turns on pagination for the subcommand using the
1508 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1509 or `\--no-pager` is specified on the command line, it takes
1510 precedence over this option. To disable pagination for all
1511 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1514 Alias for a --pretty= format string, as specified in
1515 linkgit:git-log[1]. Any aliases defined here can be used just
1516 as the built-in pretty formats could. For example,
1517 running `git config pretty.changelog "format:{asterisk} %H %s"`
1518 would cause the invocation `git log --pretty=changelog`
1519 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1520 Note that an alias with the same name as a built-in format
1521 will be silently ignored.
1524 The default merge strategy to use when pulling multiple branches
1528 The default merge strategy to use when pulling a single branch.
1531 Defines the action git push should take if no refspec is given
1532 on the command line, no refspec is configured in the remote, and
1533 no refspec is implied by any of the options given on the command
1534 line. Possible values are:
1536 * `nothing` - do not push anything.
1537 * `matching` - push all matching branches.
1538 All branches having the same name in both ends are considered to be
1539 matching. This is the default.
1540 * `upstream` - push the current branch to its upstream branch.
1541 * `tracking` - deprecated synonym for `upstream`.
1542 * `current` - push the current branch to a branch of the same name.
1545 Whether to show a diffstat of what changed upstream since the last
1546 rebase. False by default.
1549 If set to true enable '--autosquash' option by default.
1552 By default, git-receive-pack will run "git-gc --auto" after
1553 receiving data from git-push and updating refs. You can stop
1554 it by setting this variable to false.
1556 receive.fsckObjects::
1557 If it is set to true, git-receive-pack will check all received
1558 objects. It will abort in the case of a malformed object or a
1559 broken link. The result of an abort are only dangling objects.
1562 receive.unpackLimit::
1563 If the number of objects received in a push is below this
1564 limit then the objects will be unpacked into loose object
1565 files. However if the number of received objects equals or
1566 exceeds this limit then the received pack will be stored as
1567 a pack, after adding any missing delta bases. Storing the
1568 pack from a push can make the push operation complete faster,
1569 especially on slow filesystems. If not set, the value of
1570 `transfer.unpackLimit` is used instead.
1572 receive.denyDeletes::
1573 If set to true, git-receive-pack will deny a ref update that deletes
1574 the ref. Use this to prevent such a ref deletion via a push.
1576 receive.denyDeleteCurrent::
1577 If set to true, git-receive-pack will deny a ref update that
1578 deletes the currently checked out branch of a non-bare repository.
1580 receive.denyCurrentBranch::
1581 If set to true or "refuse", git-receive-pack will deny a ref update
1582 to the currently checked out branch of a non-bare repository.
1583 Such a push is potentially dangerous because it brings the HEAD
1584 out of sync with the index and working tree. If set to "warn",
1585 print a warning of such a push to stderr, but allow the push to
1586 proceed. If set to false or "ignore", allow such pushes with no
1587 message. Defaults to "refuse".
1589 receive.denyNonFastForwards::
1590 If set to true, git-receive-pack will deny a ref update which is
1591 not a fast-forward. Use this to prevent such an update via a push,
1592 even if that push is forced. This configuration variable is
1593 set when initializing a shared repository.
1595 receive.updateserverinfo::
1596 If set to true, git-receive-pack will run git-update-server-info
1597 after receiving data from git-push and updating refs.
1600 The URL of a remote repository. See linkgit:git-fetch[1] or
1601 linkgit:git-push[1].
1603 remote.<name>.pushurl::
1604 The push URL of a remote repository. See linkgit:git-push[1].
1606 remote.<name>.proxy::
1607 For remotes that require curl (http, https and ftp), the URL to
1608 the proxy to use for that remote. Set to the empty string to
1609 disable proxying for that remote.
1611 remote.<name>.fetch::
1612 The default set of "refspec" for linkgit:git-fetch[1]. See
1613 linkgit:git-fetch[1].
1615 remote.<name>.push::
1616 The default set of "refspec" for linkgit:git-push[1]. See
1617 linkgit:git-push[1].
1619 remote.<name>.mirror::
1620 If true, pushing to this remote will automatically behave
1621 as if the `\--mirror` option was given on the command line.
1623 remote.<name>.skipDefaultUpdate::
1624 If true, this remote will be skipped by default when updating
1625 using linkgit:git-fetch[1] or the `update` subcommand of
1626 linkgit:git-remote[1].
1628 remote.<name>.skipFetchAll::
1629 If true, this remote will be skipped by default when updating
1630 using linkgit:git-fetch[1] or the `update` subcommand of
1631 linkgit:git-remote[1].
1633 remote.<name>.receivepack::
1634 The default program to execute on the remote side when pushing. See
1635 option \--receive-pack of linkgit:git-push[1].
1637 remote.<name>.uploadpack::
1638 The default program to execute on the remote side when fetching. See
1639 option \--upload-pack of linkgit:git-fetch-pack[1].
1641 remote.<name>.tagopt::
1642 Setting this value to \--no-tags disables automatic tag following when
1643 fetching from remote <name>. Setting it to \--tags will fetch every
1644 tag from remote <name>, even if they are not reachable from remote
1645 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1646 override this setting. See options \--tags and \--no-tags of
1647 linkgit:git-fetch[1].
1650 Setting this to a value <vcs> will cause git to interact with
1651 the remote with the git-remote-<vcs> helper.
1654 The list of remotes which are fetched by "git remote update
1655 <group>". See linkgit:git-remote[1].
1657 repack.usedeltabaseoffset::
1658 By default, linkgit:git-repack[1] creates packs that use
1659 delta-base offset. If you need to share your repository with
1660 git older than version 1.4.4, either directly or via a dumb
1661 protocol such as http, then you need to set this option to
1662 "false" and repack. Access from old git versions over the
1663 native protocol are unaffected by this option.
1666 When set to true, `git-rerere` updates the index with the
1667 resulting contents after it cleanly resolves conflicts using
1668 previously recorded resolution. Defaults to false.
1671 Activate recording of resolved conflicts, so that identical
1672 conflict hunks can be resolved automatically, should they
1673 be encountered again. linkgit:git-rerere[1] command is by
1674 default enabled if you create `rr-cache` directory under
1675 `$GIT_DIR`, but can be disabled by setting this option to false.
1677 sendemail.identity::
1678 A configuration identity. When given, causes values in the
1679 'sendemail.<identity>' subsection to take precedence over
1680 values in the 'sendemail' section. The default identity is
1681 the value of 'sendemail.identity'.
1683 sendemail.smtpencryption::
1684 See linkgit:git-send-email[1] for description. Note that this
1685 setting is not subject to the 'identity' mechanism.
1688 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1690 sendemail.<identity>.*::
1691 Identity-specific versions of the 'sendemail.*' parameters
1692 found below, taking precedence over those when the this
1693 identity is selected, through command-line or
1694 'sendemail.identity'.
1696 sendemail.aliasesfile::
1697 sendemail.aliasfiletype::
1701 sendemail.chainreplyto::
1703 sendemail.envelopesender::
1705 sendemail.multiedit::
1706 sendemail.signedoffbycc::
1707 sendemail.smtppass::
1708 sendemail.suppresscc::
1709 sendemail.suppressfrom::
1711 sendemail.smtpdomain::
1712 sendemail.smtpserver::
1713 sendemail.smtpserverport::
1714 sendemail.smtpserveroption::
1715 sendemail.smtpuser::
1717 sendemail.validate::
1718 See linkgit:git-send-email[1] for description.
1720 sendemail.signedoffcc::
1721 Deprecated alias for 'sendemail.signedoffbycc'.
1723 showbranch.default::
1724 The default set of branches for linkgit:git-show-branch[1].
1725 See linkgit:git-show-branch[1].
1727 status.relativePaths::
1728 By default, linkgit:git-status[1] shows paths relative to the
1729 current directory. Setting this variable to `false` shows paths
1730 relative to the repository root (this was the default for git
1733 status.showUntrackedFiles::
1734 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1735 files which are not currently tracked by Git. Directories which
1736 contain only untracked files, are shown with the directory name
1737 only. Showing untracked files means that Git needs to lstat() all
1738 all the files in the whole repository, which might be slow on some
1739 systems. So, this variable controls how the commands displays
1740 the untracked files. Possible values are:
1743 * `no` - Show no untracked files.
1744 * `normal` - Show untracked files and directories.
1745 * `all` - Show also individual files in untracked directories.
1748 If this variable is not specified, it defaults to 'normal'.
1749 This variable can be overridden with the -u|--untracked-files option
1750 of linkgit:git-status[1] and linkgit:git-commit[1].
1752 status.submodulesummary::
1754 If this is set to a non zero number or true (identical to -1 or an
1755 unlimited number), the submodule summary will be enabled and a
1756 summary of commits for modified submodules will be shown (see
1757 --summary-limit option of linkgit:git-submodule[1]).
1759 submodule.<name>.path::
1760 submodule.<name>.url::
1761 submodule.<name>.update::
1762 The path within this project, URL, and the updating strategy
1763 for a submodule. These variables are initially populated
1764 by 'git submodule init'; edit them to override the
1765 URL and other values found in the `.gitmodules` file. See
1766 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1768 submodule.<name>.fetchRecurseSubmodules::
1769 This option can be used to enable/disable recursive fetching of this
1770 submodule. It can be overridden by using the --[no-]recurse-submodules
1771 command line option to "git fetch" and "git pull".
1772 This setting will override that from in the linkgit:gitmodules[5]
1775 submodule.<name>.ignore::
1776 Defines under what circumstances "git status" and the diff family show
1777 a submodule as modified. When set to "all", it will never be considered
1778 modified, "dirty" will ignore all changes to the submodules work tree and
1779 takes only differences between the HEAD of the submodule and the commit
1780 recorded in the superproject into account. "untracked" will additionally
1781 let submodules with modified tracked files in their work tree show up.
1782 Using "none" (the default when this option is not set) also shows
1783 submodules that have untracked files in their work tree as changed.
1784 This setting overrides any setting made in .gitmodules for this submodule,
1785 both settings can be overridden on the command line by using the
1786 "--ignore-submodules" option.
1789 This variable can be used to restrict the permission bits of
1790 tar archive entries. The default is 0002, which turns off the
1791 world write bit. The special value "user" indicates that the
1792 archiving user's umask will be used instead. See umask(2) and
1793 linkgit:git-archive[1].
1795 transfer.unpackLimit::
1796 When `fetch.unpackLimit` or `receive.unpackLimit` are
1797 not set, the value of this variable is used instead.
1798 The default value is 100.
1800 url.<base>.insteadOf::
1801 Any URL that starts with this value will be rewritten to
1802 start, instead, with <base>. In cases where some site serves a
1803 large number of repositories, and serves them with multiple
1804 access methods, and some users need to use different access
1805 methods, this feature allows people to specify any of the
1806 equivalent URLs and have git automatically rewrite the URL to
1807 the best alternative for the particular user, even for a
1808 never-before-seen repository on the site. When more than one
1809 insteadOf strings match a given URL, the longest match is used.
1811 url.<base>.pushInsteadOf::
1812 Any URL that starts with this value will not be pushed to;
1813 instead, it will be rewritten to start with <base>, and the
1814 resulting URL will be pushed to. In cases where some site serves
1815 a large number of repositories, and serves them with multiple
1816 access methods, some of which do not allow push, this feature
1817 allows people to specify a pull-only URL and have git
1818 automatically use an appropriate URL to push, even for a
1819 never-before-seen repository on the site. When more than one
1820 pushInsteadOf strings match a given URL, the longest match is
1821 used. If a remote has an explicit pushurl, git will ignore this
1822 setting for that remote.
1825 Your email address to be recorded in any newly created commits.
1826 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1827 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1830 Your full name to be recorded in any newly created commits.
1831 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1832 environment variables. See linkgit:git-commit-tree[1].
1835 If linkgit:git-tag[1] is not selecting the key you want it to
1836 automatically when creating a signed tag, you can override the
1837 default selection with this variable. This option is passed
1838 unchanged to gpg's --local-user parameter, so you may specify a key
1839 using any method that gpg supports.
1842 Specify a web browser that may be used by some commands.
1843 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]