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