4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times.
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored. The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables. A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins. Section names are not case sensitive. Only alphanumeric
29 characters, `-` and `.` are allowed in section names. Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections. To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
38 [section "subsection"]
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively). Section headers cannot span multiple
45 lines. Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'. If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character. There can be more
60 than one value for a given variable; we say then that the variable is
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean. Boolean values may be given as yes/no,
68 1/0, true/false or on/off. Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS). Other char escape sequences (including octal
82 escape sequences) are invalid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
107 ; Don't trust file modes
112 external = /usr/local/bin/diff-wrapper
117 merge = refs/heads/devel
121 gitProxy="ssh" for "kernel.org"
122 gitProxy=default-proxy ; for the rest
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
138 These variables control various optional help messages designed to
139 aid new users. All 'advice.*' variables default to 'true', and you
140 can tell Git that you do not need help by setting these to 'false':
144 Set this variable to 'false' if you want to disable
145 'pushNonFFCurrent', 'pushNonFFDefault',
146 'pushNonFFMatching', 'pushAlreadyExists',
147 'pushFetchFirst', and 'pushNeedsForce'
150 Advice shown when linkgit:git-push[1] fails due to a
151 non-fast-forward update to the current branch.
153 Advice to set 'push.default' to 'upstream' or 'current'
154 when you ran linkgit:git-push[1] and pushed 'matching
155 refs' by default (i.e. you did not provide an explicit
156 refspec, and no 'push.default' configuration was set)
157 and it resulted in a non-fast-forward error.
159 Advice shown when you ran linkgit:git-push[1] and pushed
160 'matching refs' explicitly (i.e. you used ':', or
161 specified a refspec that isn't your current branch) and
162 it resulted in a non-fast-forward error.
164 Shown when linkgit:git-push[1] rejects an update that
165 does not qualify for fast-forwarding (e.g., a tag.)
167 Shown when linkgit:git-push[1] rejects an update that
168 tries to overwrite a remote ref that points at an
169 object we do not have.
171 Shown when linkgit:git-push[1] rejects an update that
172 tries to overwrite a remote ref that points at an
173 object that is not a commit-ish, or make the remote
174 ref point at an object that is not a commit-ish.
176 Show directions on how to proceed from the current
177 state in the output of linkgit:git-status[1], in
178 the template shown when writing commit messages in
179 linkgit:git-commit[1], and in the help message shown
180 by linkgit:git-checkout[1] when switching branch.
182 Advise to consider using the `-u` option to linkgit:git-status[1]
183 when the command takes more than 2 seconds to enumerate untracked
186 Advice shown when linkgit:git-merge[1] refuses to
187 merge to avoid overwriting local changes.
189 Advice shown by various commands when conflicts
190 prevent the operation from being performed.
192 Advice on how to set your identity configuration when
193 your information is guessed from the system username and
196 Advice shown when you used linkgit:git-checkout[1] to
197 move to the detach HEAD state, to instruct how to create
198 a local branch after the fact.
200 Advice that shows the location of the patch file when
201 linkgit:git-am[1] fails to apply it.
203 In case of failure in the output of linkgit:git-rm[1],
204 show directions on how to proceed from the current state.
208 If false, the executable bit differences between the index and
209 the working tree are ignored; useful on broken filesystems like FAT.
210 See linkgit:git-update-index[1].
212 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
213 will probe and set core.fileMode false if appropriate when the
214 repository is created.
217 (Windows-only) If true (which is the default), mark newly-created
218 directories and files whose name starts with a dot as hidden.
219 If 'dotGitOnly', only the .git/ directory is hidden, but no other
220 files starting with a dot.
223 If true, this option enables various workarounds to enable
224 Git to work better on filesystems that are not case sensitive,
225 like FAT. For example, if a directory listing finds
226 "makefile" when Git expects "Makefile", Git will assume
227 it is really the same file, and continue to remember it as
230 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
231 will probe and set core.ignorecase true if appropriate when the repository
234 core.precomposeunicode::
235 This option is only used by Mac OS implementation of Git.
236 When core.precomposeunicode=true, Git reverts the unicode decomposition
237 of filenames done by Mac OS. This is useful when sharing a repository
238 between Mac OS and Linux or Windows.
239 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
240 When false, file names are handled fully transparent by Git,
241 which is backward compatible with older versions of Git.
244 If false, the ctime differences between the index and the
245 working tree are ignored; useful when the inode change time
246 is regularly modified by something outside Git (file system
247 crawlers and some backup systems).
248 See linkgit:git-update-index[1]. True by default.
251 Determines which stat fields to match between the index
252 and work tree. The user can set this to 'default' or
253 'minimal'. Default (or explicitly 'default'), is to check
254 all fields, including the sub-second part of mtime and ctime.
257 The commands that output paths (e.g. 'ls-files',
258 'diff'), when not given the `-z` option, will quote
259 "unusual" characters in the pathname by enclosing the
260 pathname in a double-quote pair and with backslashes the
261 same way strings in C source code are quoted. If this
262 variable is set to false, the bytes higher than 0x80 are
263 not quoted but output as verbatim. Note that double
264 quote, backslash and control characters are always
265 quoted without `-z` regardless of the setting of this
269 Sets the line ending type to use in the working directory for
270 files that have the `text` property set. Alternatives are
271 'lf', 'crlf' and 'native', which uses the platform's native
272 line ending. The default value is `native`. See
273 linkgit:gitattributes[5] for more information on end-of-line
277 If true, makes Git check if converting `CRLF` is reversible when
278 end-of-line conversion is active. Git will verify if a command
279 modifies a file in the work tree either directly or indirectly.
280 For example, committing a file followed by checking out the
281 same file should yield the original file in the work tree. If
282 this is not the case for the current setting of
283 `core.autocrlf`, Git will reject the file. The variable can
284 be set to "warn", in which case Git will only warn about an
285 irreversible conversion but continue the operation.
287 CRLF conversion bears a slight chance of corrupting data.
288 When it is enabled, Git will convert CRLF to LF during commit and LF to
289 CRLF during checkout. A file that contains a mixture of LF and
290 CRLF before the commit cannot be recreated by Git. For text
291 files this is the right thing to do: it corrects line endings
292 such that we have only LF line endings in the repository.
293 But for binary files that are accidentally classified as text the
294 conversion can corrupt data.
296 If you recognize such corruption early you can easily fix it by
297 setting the conversion type explicitly in .gitattributes. Right
298 after committing you still have the original file in your work
299 tree and this file is not yet corrupted. You can explicitly tell
300 Git that this file is binary and Git will handle the file
303 Unfortunately, the desired effect of cleaning up text files with
304 mixed line endings and the undesired effect of corrupting binary
305 files cannot be distinguished. In both cases CRLFs are removed
306 in an irreversible way. For text files this is the right thing
307 to do because CRLFs are line endings, while for binary files
308 converting CRLFs corrupts data.
310 Note, this safety check does not mean that a checkout will generate a
311 file identical to the original file for a different setting of
312 `core.eol` and `core.autocrlf`, but only for the current one. For
313 example, a text file with `LF` would be accepted with `core.eol=lf`
314 and could later be checked out with `core.eol=crlf`, in which case the
315 resulting file would contain `CRLF`, although the original file
316 contained `LF`. However, in both work trees the line endings would be
317 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
318 file with mixed line endings would be reported by the `core.safecrlf`
322 Setting this variable to "true" is almost the same as setting
323 the `text` attribute to "auto" on all files except that text
324 files are not guaranteed to be normalized: files that contain
325 `CRLF` in the repository will not be touched. Use this
326 setting if you want to have `CRLF` line endings in your
327 working directory even though the repository does not have
328 normalized line endings. This variable can be set to 'input',
329 in which case no output conversion is performed.
332 If false, symbolic links are checked out as small plain files that
333 contain the link text. linkgit:git-update-index[1] and
334 linkgit:git-add[1] will not change the recorded type to regular
335 file. Useful on filesystems like FAT that do not support
338 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
339 will probe and set core.symlinks false if appropriate when the repository
343 A "proxy command" to execute (as 'command host port') instead
344 of establishing direct connection to the remote server when
345 using the Git protocol for fetching. If the variable value is
346 in the "COMMAND for DOMAIN" format, the command is applied only
347 on hostnames ending with the specified domain string. This variable
348 may be set multiple times and is matched in the given order;
349 the first match wins.
351 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
352 (which always applies universally, without the special "for"
355 The special string `none` can be used as the proxy command to
356 specify that no proxy be used for a given domain pattern.
357 This is useful for excluding servers inside a firewall from
358 proxy use, while defaulting to a common proxy for external domains.
361 If true, commands which modify both the working tree and the index
362 will mark the updated paths with the "assume unchanged" bit in the
363 index. These marked files are then assumed to stay unchanged in the
364 working tree, until you mark them otherwise manually - Git will not
365 detect the file changes by lstat() calls. This is useful on systems
366 where those are very slow, such as Microsoft Windows.
367 See linkgit:git-update-index[1].
370 core.preferSymlinkRefs::
371 Instead of the default "symref" format for HEAD
372 and other symbolic reference files, use symbolic links.
373 This is sometimes needed to work with old scripts that
374 expect HEAD to be a symbolic link.
377 If true this repository is assumed to be 'bare' and has no
378 working directory associated with it. If this is the case a
379 number of commands that require a working directory will be
380 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
382 This setting is automatically guessed by linkgit:git-clone[1] or
383 linkgit:git-init[1] when the repository was created. By default a
384 repository that ends in "/.git" is assumed to be not bare (bare =
385 false), while all other repositories are assumed to be bare (bare
389 Set the path to the root of the working tree.
390 This can be overridden by the GIT_WORK_TREE environment
391 variable and the '--work-tree' command line option.
392 The value can be an absolute path or relative to the path to
393 the .git directory, which is either specified by --git-dir
394 or GIT_DIR, or automatically discovered.
395 If --git-dir or GIT_DIR is specified but none of
396 --work-tree, GIT_WORK_TREE and core.worktree is specified,
397 the current working directory is regarded as the top level
398 of your working tree.
400 Note that this variable is honored even when set in a configuration
401 file in a ".git" subdirectory of a directory and its value differs
402 from the latter directory (e.g. "/path/to/.git/config" has
403 core.worktree set to "/different/path"), which is most likely a
404 misconfiguration. Running Git commands in the "/path/to" directory will
405 still use "/different/path" as the root of the work tree and can cause
406 confusion unless you know what you are doing (e.g. you are creating a
407 read-only snapshot of the same index to a location different from the
408 repository's usual working tree).
410 core.logAllRefUpdates::
411 Enable the reflog. Updates to a ref <ref> is logged to the file
412 "$GIT_DIR/logs/<ref>", by appending the new and old
413 SHA-1, the date/time and the reason of the update, but
414 only when the file exists. If this configuration
415 variable is set to true, missing "$GIT_DIR/logs/<ref>"
416 file is automatically created for branch heads (i.e. under
417 refs/heads/), remote refs (i.e. under refs/remotes/),
418 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
420 This information can be used to determine what commit
421 was the tip of a branch "2 days ago".
423 This value is true by default in a repository that has
424 a working directory associated with it, and false by
425 default in a bare repository.
427 core.repositoryFormatVersion::
428 Internal variable identifying the repository format and layout
431 core.sharedRepository::
432 When 'group' (or 'true'), the repository is made shareable between
433 several users in a group (making sure all the files and objects are
434 group-writable). When 'all' (or 'world' or 'everybody'), the
435 repository will be readable by all users, additionally to being
436 group-shareable. When 'umask' (or 'false'), Git will use permissions
437 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
438 files in the repository will have this mode value. '0xxx' will override
439 user's umask value (whereas the other options will only override
440 requested parts of the user's umask value). Examples: '0660' will make
441 the repo read/write-able for the owner and group, but inaccessible to
442 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
443 repository that is group-readable but not group-writable.
444 See linkgit:git-init[1]. False by default.
446 core.warnAmbiguousRefs::
447 If true, Git will warn you if the ref name you passed it is ambiguous
448 and might match multiple refs in the repository. True by default.
451 An integer -1..9, indicating a default compression level.
452 -1 is the zlib default. 0 means no compression,
453 and 1..9 are various speed/size tradeoffs, 9 being slowest.
454 If set, this provides a default to other compression variables,
455 such as 'core.loosecompression' and 'pack.compression'.
457 core.loosecompression::
458 An integer -1..9, indicating the compression level for objects that
459 are not in a pack file. -1 is the zlib default. 0 means no
460 compression, and 1..9 are various speed/size tradeoffs, 9 being
461 slowest. If not set, defaults to core.compression. If that is
462 not set, defaults to 1 (best speed).
464 core.packedGitWindowSize::
465 Number of bytes of a pack file to map into memory in a
466 single mapping operation. Larger window sizes may allow
467 your system to process a smaller number of large pack files
468 more quickly. Smaller window sizes will negatively affect
469 performance due to increased calls to the operating system's
470 memory manager, but may improve performance when accessing
471 a large number of large pack files.
473 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
474 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
475 be reasonable for all users/operating systems. You probably do
476 not need to adjust this value.
478 Common unit suffixes of 'k', 'm', or 'g' are supported.
480 core.packedGitLimit::
481 Maximum number of bytes to map simultaneously into memory
482 from pack files. If Git needs to access more than this many
483 bytes at once to complete an operation it will unmap existing
484 regions to reclaim virtual address space within the process.
486 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
487 This should be reasonable for all users/operating systems, except on
488 the largest projects. You probably do not need to adjust this value.
490 Common unit suffixes of 'k', 'm', or 'g' are supported.
492 core.deltaBaseCacheLimit::
493 Maximum number of bytes to reserve for caching base objects
494 that may be referenced by multiple deltified objects. By storing the
495 entire decompressed base objects in a cache Git is able
496 to avoid unpacking and decompressing frequently used base
497 objects multiple times.
499 Default is 16 MiB on all platforms. This should be reasonable
500 for all users/operating systems, except on the largest projects.
501 You probably do not need to adjust this value.
503 Common unit suffixes of 'k', 'm', or 'g' are supported.
505 core.bigFileThreshold::
506 Files larger than this size are stored deflated, without
507 attempting delta compression. Storing large files without
508 delta compression avoids excessive memory usage, at the
509 slight expense of increased disk usage.
511 Default is 512 MiB on all platforms. This should be reasonable
512 for most projects as source code and other text files can still
513 be delta compressed, but larger binary media files won't be.
515 Common unit suffixes of 'k', 'm', or 'g' are supported.
518 In addition to '.gitignore' (per-directory) and
519 '.git/info/exclude', Git looks into this file for patterns
520 of files which are not meant to be tracked. "`~/`" is expanded
521 to the value of `$HOME` and "`~user/`" to the specified user's
522 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
523 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
524 is used instead. See linkgit:gitignore[5].
527 Some commands (e.g. svn and http interfaces) that interactively
528 ask for a password can be told to use an external program given
529 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
530 environment variable. If not set, fall back to the value of the
531 'SSH_ASKPASS' environment variable or, failing that, a simple password
532 prompt. The external program shall be given a suitable prompt as
533 command line argument and write the password on its STDOUT.
535 core.attributesfile::
536 In addition to '.gitattributes' (per-directory) and
537 '.git/info/attributes', Git looks into this file for attributes
538 (see linkgit:gitattributes[5]). Path expansions are made the same
539 way as for `core.excludesfile`. Its default value is
540 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
541 set or empty, $HOME/.config/git/attributes is used instead.
544 Commands such as `commit` and `tag` that lets you edit
545 messages by launching an editor uses the value of this
546 variable when it is set, and the environment variable
547 `GIT_EDITOR` is not set. See linkgit:git-var[1].
550 Commands such as `commit` and `tag` that lets you edit
551 messages consider a line that begins with this character
552 commented, and removes them after the editor returns
556 Text editor used by `git rebase -i` for editing the rebase instruction file.
557 The value is meant to be interpreted by the shell when it is used.
558 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
559 When not configured the default commit message editor is used instead.
562 Text viewer for use by Git commands (e.g., 'less'). The value
563 is meant to be interpreted by the shell. The order of preference
564 is the `$GIT_PAGER` environment variable, then `core.pager`
565 configuration, then `$PAGER`, and then the default chosen at
566 compile time (usually 'less').
568 When the `LESS` environment variable is unset, Git sets it to `FRSX`
569 (if `LESS` environment variable is set, Git does not change it at
570 all). If you want to selectively override Git's default setting
571 for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
572 be passed to the shell by Git, which will translate the final
573 command to `LESS=FRSX less -+S`. The environment tells the command
574 to set the `S` option to chop long lines but the command line
575 resets it to the default to fold long lines.
577 Likewise, when the `LV` environment variable is unset, Git sets it
578 to `-c`. You can override this setting by exporting `LV` with
579 another value or setting `core.pager` to `lv +c`.
582 A comma separated list of common whitespace problems to
583 notice. 'git diff' will use `color.diff.whitespace` to
584 highlight them, and 'git apply --whitespace=error' will
585 consider them as errors. You can prefix `-` to disable
586 any of them (e.g. `-trailing-space`):
588 * `blank-at-eol` treats trailing whitespaces at the end of the line
589 as an error (enabled by default).
590 * `space-before-tab` treats a space character that appears immediately
591 before a tab character in the initial indent part of the line as an
592 error (enabled by default).
593 * `indent-with-non-tab` treats a line that is indented with space
594 characters instead of the equivalent tabs as an error (not enabled by
596 * `tab-in-indent` treats a tab character in the initial indent part of
597 the line as an error (not enabled by default).
598 * `blank-at-eof` treats blank lines added at the end of file as an error
599 (enabled by default).
600 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
602 * `cr-at-eol` treats a carriage-return at the end of line as
603 part of the line terminator, i.e. with it, `trailing-space`
604 does not trigger if the character before such a carriage-return
605 is not a whitespace (not enabled by default).
606 * `tabwidth=<n>` tells how many character positions a tab occupies; this
607 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
608 errors. The default tab width is 8. Allowed values are 1 to 63.
610 core.fsyncobjectfiles::
611 This boolean will enable 'fsync()' when writing object files.
613 This is a total waste of time and effort on a filesystem that orders
614 data writes properly, but can be useful for filesystems that do not use
615 journalling (traditional UNIX filesystems) or that only journal metadata
616 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
619 Enable parallel index preload for operations like 'git diff'
621 This can speed up operations like 'git diff' and 'git status' especially
622 on filesystems like NFS that have weak caching semantics and thus
623 relatively high IO latencies. With this set to 'true', Git will do the
624 index comparison to the filesystem data in parallel, allowing
628 Enable additional caching of file system data for some operations.
630 Git for Windows uses this to bulk-read and cache lstat data of entire
631 directories (instead of doing lstat file by file).
634 You can set this to 'link', in which case a hardlink followed by
635 a delete of the source are used to make sure that object creation
636 will not overwrite existing objects.
638 On some file system/operating system combinations, this is unreliable.
639 Set this config setting to 'rename' there; However, This will remove the
640 check that makes sure that existing object files will not get overwritten.
643 When showing commit messages, also show notes which are stored in
644 the given ref. The ref must be fully qualified. If the given
645 ref does not exist, it is not an error but means that no
646 notes should be printed.
648 This setting defaults to "refs/notes/commits", and it can be overridden by
649 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
651 core.sparseCheckout::
652 Enable "sparse checkout" feature. See section "Sparse checkout" in
653 linkgit:git-read-tree[1] for more information.
656 Set the length object names are abbreviated to. If unspecified,
657 many commands abbreviate to 7 hexdigits, which may not be enough
658 for abbreviated object names to stay unique for sufficiently long
663 Tells 'git add' to continue adding files when some files cannot be
664 added due to indexing errors. Equivalent to the '--ignore-errors'
665 option of linkgit:git-add[1]. Older versions of Git accept only
666 `add.ignore-errors`, which does not follow the usual naming
667 convention for configuration variables. Newer versions of Git
668 honor `add.ignoreErrors` as well.
671 Command aliases for the linkgit:git[1] command wrapper - e.g.
672 after defining "alias.last = cat-file commit HEAD", the invocation
673 "git last" is equivalent to "git cat-file commit HEAD". To avoid
674 confusion and troubles with script usage, aliases that
675 hide existing Git commands are ignored. Arguments are split by
676 spaces, the usual shell quoting and escaping is supported.
677 quote pair and a backslash can be used to quote them.
679 If the alias expansion is prefixed with an exclamation point,
680 it will be treated as a shell command. For example, defining
681 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
682 "git new" is equivalent to running the shell command
683 "gitk --all --not ORIG_HEAD". Note that shell commands will be
684 executed from the top-level directory of a repository, which may
685 not necessarily be the current directory.
686 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
687 from the original current directory. See linkgit:git-rev-parse[1].
690 If true, git-am will call git-mailsplit for patches in mbox format
691 with parameter '--keep-cr'. In this case git-mailsplit will
692 not remove `\r` from lines ending with `\r\n`. Can be overridden
693 by giving '--no-keep-cr' from the command line.
694 See linkgit:git-am[1], linkgit:git-mailsplit[1].
696 apply.ignorewhitespace::
697 When set to 'change', tells 'git apply' to ignore changes in
698 whitespace, in the same way as the '--ignore-space-change'
700 When set to one of: no, none, never, false tells 'git apply' to
701 respect all whitespace differences.
702 See linkgit:git-apply[1].
705 Tells 'git apply' how to handle whitespaces, in the same way
706 as the '--whitespace' option. See linkgit:git-apply[1].
708 branch.autosetupmerge::
709 Tells 'git branch' and 'git checkout' to set up new branches
710 so that linkgit:git-pull[1] will appropriately merge from the
711 starting point branch. Note that even if this option is not set,
712 this behavior can be chosen per-branch using the `--track`
713 and `--no-track` options. The valid settings are: `false` -- no
714 automatic setup is done; `true` -- automatic setup is done when the
715 starting point is a remote-tracking branch; `always` --
716 automatic setup is done when the starting point is either a
717 local branch or remote-tracking
718 branch. This option defaults to true.
720 branch.autosetuprebase::
721 When a new branch is created with 'git branch' or 'git checkout'
722 that tracks another branch, this variable tells Git to set
723 up pull to rebase instead of merge (see "branch.<name>.rebase").
724 When `never`, rebase is never automatically set to true.
725 When `local`, rebase is set to true for tracked branches of
726 other local branches.
727 When `remote`, rebase is set to true for tracked branches of
728 remote-tracking branches.
729 When `always`, rebase will be set to true for all tracking
731 See "branch.autosetupmerge" for details on how to set up a
732 branch to track another branch.
733 This option defaults to never.
735 branch.<name>.remote::
736 When on branch <name>, it tells 'git fetch' and 'git push'
737 which remote to fetch from/push to. The remote to push to
738 may be overridden with `remote.pushdefault` (for all branches).
739 The remote to push to, for the current branch, may be further
740 overridden by `branch.<name>.pushremote`. If no remote is
741 configured, or if you are not on any branch, it defaults to
742 `origin` for fetching and `remote.pushdefault` for pushing.
743 Additionally, `.` (a period) is the current local repository
744 (a dot-repository), see `branch.<name>.merge`'s final note below.
746 branch.<name>.pushremote::
747 When on branch <name>, it overrides `branch.<name>.remote` for
748 pushing. It also overrides `remote.pushdefault` for pushing
749 from branch <name>. When you pull from one place (e.g. your
750 upstream) and push to another place (e.g. your own publishing
751 repository), you would want to set `remote.pushdefault` to
752 specify the remote to push to for all branches, and use this
753 option to override it for a specific branch.
755 branch.<name>.merge::
756 Defines, together with branch.<name>.remote, the upstream branch
757 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
758 branch to merge and can also affect 'git push' (see push.default).
759 When in branch <name>, it tells 'git fetch' the default
760 refspec to be marked for merging in FETCH_HEAD. The value is
761 handled like the remote part of a refspec, and must match a
762 ref which is fetched from the remote given by
763 "branch.<name>.remote".
764 The merge information is used by 'git pull' (which at first calls
765 'git fetch') to lookup the default branch for merging. Without
766 this option, 'git pull' defaults to merge the first refspec fetched.
767 Specify multiple values to get an octopus merge.
768 If you wish to setup 'git pull' so that it merges into <name> from
769 another branch in the local repository, you can point
770 branch.<name>.merge to the desired branch, and use the relative path
771 setting `.` (a period) for branch.<name>.remote.
773 branch.<name>.mergeoptions::
774 Sets default options for merging into branch <name>. The syntax and
775 supported options are the same as those of linkgit:git-merge[1], but
776 option values containing whitespace characters are currently not
779 branch.<name>.rebase::
780 When true, rebase the branch <name> on top of the fetched branch,
781 instead of merging the default branch from the default remote when
782 "git pull" is run. See "pull.rebase" for doing this in a non
783 branch-specific manner.
785 When preserve, also pass `--preserve-merges` along to 'git rebase'
786 so that locally committed merge commits will not be flattened
787 by running 'git pull'.
789 *NOTE*: this is a possibly dangerous operation; do *not* use
790 it unless you understand the implications (see linkgit:git-rebase[1]
793 branch.<name>.description::
794 Branch description, can be edited with
795 `git branch --edit-description`. Branch description is
796 automatically added in the format-patch cover letter or
797 request-pull summary.
800 Specify the command to invoke the specified browser. The
801 specified command is evaluated in shell with the URLs passed
802 as arguments. (See linkgit:git-web{litdd}browse[1].)
804 browser.<tool>.path::
805 Override the path for the given tool that may be used to
806 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
807 working repository in gitweb (see linkgit:git-instaweb[1]).
810 A boolean to make git-clean do nothing unless given -f,
811 -i or -n. Defaults to true.
814 A boolean to enable/disable color in the output of
815 linkgit:git-branch[1]. May be set to `always`,
816 `false` (or `never`) or `auto` (or `true`), in which case colors are used
817 only when the output is to a terminal. Defaults to false.
819 color.branch.<slot>::
820 Use customized color for branch coloration. `<slot>` is one of
821 `current` (the current branch), `local` (a local branch),
822 `remote` (a remote-tracking branch in refs/remotes/),
823 `upstream` (upstream tracking branch), `plain` (other
826 The value for these configuration variables is a list of colors (at most
827 two) and attributes (at most one), separated by spaces. The colors
828 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
829 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
830 `blink` and `reverse`. The first color given is the foreground; the
831 second is the background. The position of the attribute, if any,
835 Whether to use ANSI escape sequences to add color to patches.
836 If this is set to `always`, linkgit:git-diff[1],
837 linkgit:git-log[1], and linkgit:git-show[1] will use color
838 for all patches. If it is set to `true` or `auto`, those
839 commands will only use color when output is to the terminal.
842 This does not affect linkgit:git-format-patch[1] or the
843 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
844 command line with the `--color[=<when>]` option.
847 Use customized color for diff colorization. `<slot>` specifies
848 which part of the patch to use the specified color, and is one
849 of `plain` (context text), `meta` (metainformation), `frag`
850 (hunk header), 'func' (function in hunk header), `old` (removed lines),
851 `new` (added lines), `commit` (commit headers), or `whitespace`
852 (highlighting whitespace errors). The values of these variables may be
853 specified as in color.branch.<slot>.
855 color.decorate.<slot>::
856 Use customized color for 'git log --decorate' output. `<slot>` is one
857 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
858 branches, remote-tracking branches, tags, stash and HEAD, respectively.
861 When set to `always`, always highlight matches. When `false` (or
862 `never`), never. When set to `true` or `auto`, use color only
863 when the output is written to the terminal. Defaults to `false`.
866 Use customized color for grep colorization. `<slot>` specifies which
867 part of the line to use the specified color, and is one of
871 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
873 filename prefix (when not using `-h`)
875 function name lines (when using `-p`)
877 line number prefix (when using `-n`)
881 non-matching text in selected lines
883 separators between fields on a line (`:`, `-`, and `=`)
884 and between hunks (`--`)
887 The values of these variables may be specified as in color.branch.<slot>.
890 When set to `always`, always use colors for interactive prompts
891 and displays (such as those used by "git-add --interactive" and
892 "git-clean --interactive"). When false (or `never`), never.
893 When set to `true` or `auto`, use colors only when the output is
894 to the terminal. Defaults to false.
896 color.interactive.<slot>::
897 Use customized color for 'git add --interactive' and 'git clean
898 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
899 or `error`, for four distinct types of normal output from
900 interactive commands. The values of these variables may be
901 specified as in color.branch.<slot>.
904 A boolean to enable/disable colored output when the pager is in
905 use (default is true).
908 A boolean to enable/disable color in the output of
909 linkgit:git-show-branch[1]. May be set to `always`,
910 `false` (or `never`) or `auto` (or `true`), in which case colors are used
911 only when the output is to a terminal. Defaults to false.
914 A boolean to enable/disable color in the output of
915 linkgit:git-status[1]. May be set to `always`,
916 `false` (or `never`) or `auto` (or `true`), in which case colors are used
917 only when the output is to a terminal. Defaults to false.
919 color.status.<slot>::
920 Use customized color for status colorization. `<slot>` is
921 one of `header` (the header text of the status message),
922 `added` or `updated` (files which are added but not committed),
923 `changed` (files which are changed but not added in the index),
924 `untracked` (files which are not tracked by Git),
925 `branch` (the current branch), or
926 `nobranch` (the color the 'no branch' warning is shown in, defaulting
927 to red). The values of these variables may be specified as in
931 This variable determines the default value for variables such
932 as `color.diff` and `color.grep` that control the use of color
933 per command family. Its scope will expand as more commands learn
934 configuration to set a default for the `--color` option. Set it
935 to `false` or `never` if you prefer Git commands not to use
936 color unless enabled explicitly with some other configuration
937 or the `--color` option. Set it to `always` if you want all
938 output not intended for machine consumption to use color, to
939 `true` or `auto` (this is the default since Git 1.8.4) if you
940 want such output to use color when written to the terminal.
943 Specify whether supported commands should output in columns.
944 This variable consists of a list of tokens separated by spaces
947 These options control when the feature should be enabled
948 (defaults to 'never'):
952 always show in columns
954 never show in columns
956 show in columns if the output is to the terminal
959 These options control layout (defaults to 'column'). Setting any
960 of these implies 'always' if none of 'always', 'never', or 'auto' are
965 fill columns before rows
967 fill rows before columns
972 Finally, these options can be combined with a layout option (defaults
977 make unequal size columns to utilize more space
979 make equal size columns
983 Specify whether to output branch listing in `git branch` in columns.
984 See `column.ui` for details.
987 Specify the layout when list items in `git clean -i`, which always
988 shows files and directories in columns. See `column.ui` for details.
991 Specify whether to output untracked files in `git status` in columns.
992 See `column.ui` for details.
995 Specify whether to output tag listing in `git tag` in columns.
996 See `column.ui` for details.
999 This setting overrides the default of the `--cleanup` option in
1000 `git commit`. See linkgit:git-commit[1] for details. Changing the
1001 default can be useful when you always want to keep lines that begin
1002 with comment character `#` in your log message, in which case you
1003 would do `git config commit.cleanup whitespace` (note that you will
1004 have to remove the help lines that begin with `#` in the commit log
1005 template yourself, if you do this).
1008 A boolean to enable/disable inclusion of status information in the
1009 commit message template when using an editor to prepare the commit
1010 message. Defaults to true.
1013 Specify a file to use as the template for new commit messages.
1014 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1015 specified user's home directory.
1018 Specify an external helper to be called when a username or
1019 password credential is needed; the helper may consult external
1020 storage to avoid prompting the user for the credentials. See
1021 linkgit:gitcredentials[7] for details.
1023 credential.useHttpPath::
1024 When acquiring credentials, consider the "path" component of an http
1025 or https URL to be important. Defaults to false. See
1026 linkgit:gitcredentials[7] for more information.
1028 credential.username::
1029 If no username is set for a network authentication, use this username
1030 by default. See credential.<context>.* below, and
1031 linkgit:gitcredentials[7].
1033 credential.<url>.*::
1034 Any of the credential.* options above can be applied selectively to
1035 some credentials. For example "credential.https://example.com.username"
1036 would set the default username only for https connections to
1037 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1040 include::diff-config.txt[]
1042 difftool.<tool>.path::
1043 Override the path for the given tool. This is useful in case
1044 your tool is not in the PATH.
1046 difftool.<tool>.cmd::
1047 Specify the command to invoke the specified diff tool.
1048 The specified command is evaluated in shell with the following
1049 variables available: 'LOCAL' is set to the name of the temporary
1050 file containing the contents of the diff pre-image and 'REMOTE'
1051 is set to the name of the temporary file containing the contents
1052 of the diff post-image.
1055 Prompt before each invocation of the diff tool.
1057 fetch.recurseSubmodules::
1058 This option can be either set to a boolean value or to 'on-demand'.
1059 Setting it to a boolean changes the behavior of fetch and pull to
1060 unconditionally recurse into submodules when set to true or to not
1061 recurse at all when set to false. When set to 'on-demand' (the default
1062 value), fetch and pull will only recurse into a populated submodule
1063 when its superproject retrieves a commit that updates the submodule's
1067 If it is set to true, git-fetch-pack will check all fetched
1068 objects. It will abort in the case of a malformed object or a
1069 broken link. The result of an abort are only dangling objects.
1070 Defaults to false. If not set, the value of `transfer.fsckObjects`
1074 If the number of objects fetched over the Git native
1075 transfer is below this
1076 limit, then the objects will be unpacked into loose object
1077 files. However if the number of received objects equals or
1078 exceeds this limit then the received pack will be stored as
1079 a pack, after adding any missing delta bases. Storing the
1080 pack from a push can make the push operation complete faster,
1081 especially on slow filesystems. If not set, the value of
1082 `transfer.unpackLimit` is used instead.
1085 If true, fetch will automatically behave as if the `--prune`
1086 option was given on the command line. See also `remote.<name>.prune`.
1089 Enable multipart/mixed attachments as the default for
1090 'format-patch'. The value can also be a double quoted string
1091 which will enable attachments as the default and set the
1092 value as the boundary. See the --attach option in
1093 linkgit:git-format-patch[1].
1096 A boolean which can enable or disable sequence numbers in patch
1097 subjects. It defaults to "auto" which enables it only if there
1098 is more than one patch. It can be enabled or disabled for all
1099 messages by setting it to "true" or "false". See --numbered
1100 option in linkgit:git-format-patch[1].
1103 Additional email headers to include in a patch to be submitted
1104 by mail. See linkgit:git-format-patch[1].
1108 Additional recipients to include in a patch to be submitted
1109 by mail. See the --to and --cc options in
1110 linkgit:git-format-patch[1].
1112 format.subjectprefix::
1113 The default for format-patch is to output files with the '[PATCH]'
1114 subject prefix. Use this variable to change that prefix.
1117 The default for format-patch is to output a signature containing
1118 the Git version number. Use this variable to change that default.
1119 Set this variable to the empty string ("") to suppress
1120 signature generation.
1123 The default for format-patch is to output files with the suffix
1124 `.patch`. Use this variable to change that suffix (make sure to
1125 include the dot if you want it).
1128 The default pretty format for log/show/whatchanged command,
1129 See linkgit:git-log[1], linkgit:git-show[1],
1130 linkgit:git-whatchanged[1].
1133 The default threading style for 'git format-patch'. Can be
1134 a boolean value, or `shallow` or `deep`. `shallow` threading
1135 makes every mail a reply to the head of the series,
1136 where the head is chosen from the cover letter, the
1137 `--in-reply-to`, and the first patch mail, in this order.
1138 `deep` threading makes every mail a reply to the previous one.
1139 A true boolean value is the same as `shallow`, and a false
1140 value disables threading.
1143 A boolean value which lets you enable the `-s/--signoff` option of
1144 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1145 patch should be a conscious act and means that you certify you have
1146 the rights to submit this work under the same open source license.
1147 Please see the 'SubmittingPatches' document for further discussion.
1149 format.coverLetter::
1150 A boolean that controls whether to generate a cover-letter when
1151 format-patch is invoked, but in addition can be set to "auto", to
1152 generate a cover-letter only when there's more than one patch.
1154 filter.<driver>.clean::
1155 The command which is used to convert the content of a worktree
1156 file to a blob upon checkin. See linkgit:gitattributes[5] for
1159 filter.<driver>.smudge::
1160 The command which is used to convert the content of a blob
1161 object to a worktree file upon checkout. See
1162 linkgit:gitattributes[5] for details.
1164 gc.aggressiveWindow::
1165 The window size parameter used in the delta compression
1166 algorithm used by 'git gc --aggressive'. This defaults
1170 When there are approximately more than this many loose
1171 objects in the repository, `git gc --auto` will pack them.
1172 Some Porcelain commands use this command to perform a
1173 light-weight garbage collection from time to time. The
1174 default value is 6700. Setting this to 0 disables it.
1177 When there are more than this many packs that are not
1178 marked with `*.keep` file in the repository, `git gc
1179 --auto` consolidates them into one larger pack. The
1180 default value is 50. Setting this to 0 disables it.
1183 Running `git pack-refs` in a repository renders it
1184 unclonable by Git versions prior to 1.5.1.2 over dumb
1185 transports such as HTTP. This variable determines whether
1186 'git gc' runs `git pack-refs`. This can be set to `notbare`
1187 to enable it within all non-bare repos or it can be set to a
1188 boolean value. The default is `true`.
1191 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1192 Override the grace period with this config variable. The value
1193 "now" may be used to disable this grace period and always prune
1194 unreachable objects immediately.
1197 gc.<pattern>.reflogexpire::
1198 'git reflog expire' removes reflog entries older than
1199 this time; defaults to 90 days. With "<pattern>" (e.g.
1200 "refs/stash") in the middle the setting applies only to
1201 the refs that match the <pattern>.
1203 gc.reflogexpireunreachable::
1204 gc.<ref>.reflogexpireunreachable::
1205 'git reflog expire' removes reflog entries older than
1206 this time and are not reachable from the current tip;
1207 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1208 in the middle, the setting applies only to the refs that
1209 match the <pattern>.
1212 Records of conflicted merge you resolved earlier are
1213 kept for this many days when 'git rerere gc' is run.
1214 The default is 60 days. See linkgit:git-rerere[1].
1216 gc.rerereunresolved::
1217 Records of conflicted merge you have not resolved are
1218 kept for this many days when 'git rerere gc' is run.
1219 The default is 15 days. See linkgit:git-rerere[1].
1221 gitcvs.commitmsgannotation::
1222 Append this string to each commit message. Set to empty string
1223 to disable this feature. Defaults to "via git-CVS emulator".
1226 Whether the CVS server interface is enabled for this repository.
1227 See linkgit:git-cvsserver[1].
1230 Path to a log file where the CVS server interface well... logs
1231 various stuff. See linkgit:git-cvsserver[1].
1233 gitcvs.usecrlfattr::
1234 If true, the server will look up the end-of-line conversion
1235 attributes for files to determine the '-k' modes to use. If
1236 the attributes force Git to treat a file as text,
1237 the '-k' mode will be left blank so CVS clients will
1238 treat it as text. If they suppress text conversion, the file
1239 will be set with '-kb' mode, which suppresses any newline munging
1240 the client might otherwise do. If the attributes do not allow
1241 the file type to be determined, then 'gitcvs.allbinary' is
1242 used. See linkgit:gitattributes[5].
1245 This is used if 'gitcvs.usecrlfattr' does not resolve
1246 the correct '-kb' mode to use. If true, all
1247 unresolved files are sent to the client in
1248 mode '-kb'. This causes the client to treat them
1249 as binary files, which suppresses any newline munging it
1250 otherwise might do. Alternatively, if it is set to "guess",
1251 then the contents of the file are examined to decide if
1252 it is binary, similar to 'core.autocrlf'.
1255 Database used by git-cvsserver to cache revision information
1256 derived from the Git repository. The exact meaning depends on the
1257 used database driver, for SQLite (which is the default driver) this
1258 is a filename. Supports variable substitution (see
1259 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1260 Default: '%Ggitcvs.%m.sqlite'
1263 Used Perl DBI driver. You can specify any available driver
1264 for this here, but it might not work. git-cvsserver is tested
1265 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1266 reported *not* to work with 'DBD::mysql'. Experimental feature.
1267 May not contain double colons (`:`). Default: 'SQLite'.
1268 See linkgit:git-cvsserver[1].
1270 gitcvs.dbuser, gitcvs.dbpass::
1271 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1272 since SQLite has no concept of database users and/or passwords.
1273 'gitcvs.dbuser' supports variable substitution (see
1274 linkgit:git-cvsserver[1] for details).
1276 gitcvs.dbTableNamePrefix::
1277 Database table name prefix. Prepended to the names of any
1278 database tables used, allowing a single database to be used
1279 for several repositories. Supports variable substitution (see
1280 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1281 characters will be replaced with underscores.
1283 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1284 'gitcvs.allbinary' can also be specified as
1285 'gitcvs.<access_method>.<varname>' (where 'access_method'
1286 is one of "ext" and "pserver") to make them apply only for the given
1290 gitweb.description::
1293 See linkgit:gitweb[1] for description.
1301 gitweb.remote_heads::
1304 See linkgit:gitweb.conf[5] for description.
1307 If set to true, enable '-n' option by default.
1310 Set the default matching behavior. Using a value of 'basic', 'extended',
1311 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1312 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1313 value 'default' will return to the default matching behavior.
1315 grep.extendedRegexp::
1316 If set to true, enable '--extended-regexp' option by default. This
1317 option is ignored when the 'grep.patternType' option is set to a value
1318 other than 'default'.
1321 Use this custom program instead of "gpg" found on $PATH when
1322 making or verifying a PGP signature. The program must support the
1323 same command line interface as GPG, namely, to verify a detached
1324 signature, "gpg --verify $file - <$signature" is run, and the
1325 program is expected to signal a good signature by exiting with
1326 code 0, and to generate an ascii-armored detached signature, the
1327 standard input of "gpg -bsau $key" is fed with the contents to be
1328 signed, and the program is expected to send the result to its
1331 gui.commitmsgwidth::
1332 Defines how wide the commit message window is in the
1333 linkgit:git-gui[1]. "75" is the default.
1336 Specifies how many context lines should be used in calls to diff
1337 made by the linkgit:git-gui[1]. The default is "5".
1340 Specifies the default encoding to use for displaying of
1341 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1342 It can be overridden by setting the 'encoding' attribute
1343 for relevant files (see linkgit:gitattributes[5]).
1344 If this option is not set, the tools default to the
1347 gui.matchtrackingbranch::
1348 Determines if new branches created with linkgit:git-gui[1] should
1349 default to tracking remote branches with matching names or
1350 not. Default: "false".
1352 gui.newbranchtemplate::
1353 Is used as suggested name when creating new branches using the
1356 gui.pruneduringfetch::
1357 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1358 performing a fetch. The default value is "false".
1361 Determines if linkgit:git-gui[1] should trust the file modification
1362 timestamp or not. By default the timestamps are not trusted.
1364 gui.spellingdictionary::
1365 Specifies the dictionary used for spell checking commit messages in
1366 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1370 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1371 location detection. It makes blame significantly faster on huge
1372 repositories at the expense of less thorough copy detection.
1374 gui.copyblamethreshold::
1375 Specifies the threshold to use in 'git gui blame' original location
1376 detection, measured in alphanumeric characters. See the
1377 linkgit:git-blame[1] manual for more information on copy detection.
1379 gui.blamehistoryctx::
1380 Specifies the radius of history context in days to show in
1381 linkgit:gitk[1] for the selected commit, when the `Show History
1382 Context` menu item is invoked from 'git gui blame'. If this
1383 variable is set to zero, the whole history is shown.
1385 guitool.<name>.cmd::
1386 Specifies the shell command line to execute when the corresponding item
1387 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1388 mandatory for every tool. The command is executed from the root of
1389 the working directory, and in the environment it receives the name of
1390 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1391 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1392 the head is detached, 'CUR_BRANCH' is empty).
1394 guitool.<name>.needsfile::
1395 Run the tool only if a diff is selected in the GUI. It guarantees
1396 that 'FILENAME' is not empty.
1398 guitool.<name>.noconsole::
1399 Run the command silently, without creating a window to display its
1402 guitool.<name>.norescan::
1403 Don't rescan the working directory for changes after the tool
1406 guitool.<name>.confirm::
1407 Show a confirmation dialog before actually running the tool.
1409 guitool.<name>.argprompt::
1410 Request a string argument from the user, and pass it to the tool
1411 through the 'ARGS' environment variable. Since requesting an
1412 argument implies confirmation, the 'confirm' option has no effect
1413 if this is enabled. If the option is set to 'true', 'yes', or '1',
1414 the dialog uses a built-in generic prompt; otherwise the exact
1415 value of the variable is used.
1417 guitool.<name>.revprompt::
1418 Request a single valid revision from the user, and set the
1419 'REVISION' environment variable. In other aspects this option
1420 is similar to 'argprompt', and can be used together with it.
1422 guitool.<name>.revunmerged::
1423 Show only unmerged branches in the 'revprompt' subdialog.
1424 This is useful for tools similar to merge or rebase, but not
1425 for things like checkout or reset.
1427 guitool.<name>.title::
1428 Specifies the title to use for the prompt dialog. The default
1431 guitool.<name>.prompt::
1432 Specifies the general prompt string to display at the top of
1433 the dialog, before subsections for 'argprompt' and 'revprompt'.
1434 The default value includes the actual command.
1437 Specify the browser that will be used to display help in the
1438 'web' format. See linkgit:git-help[1].
1441 Override the default help format used by linkgit:git-help[1].
1442 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1443 the default. 'web' and 'html' are the same.
1446 Automatically correct and execute mistyped commands after
1447 waiting for the given number of deciseconds (0.1 sec). If more
1448 than one command can be deduced from the entered text, nothing
1449 will be executed. If the value of this option is negative,
1450 the corrected command will be executed immediately. If the
1451 value is 0 - the command will be just shown but not executed.
1452 This is the default.
1455 Specify the path where the HTML documentation resides. File system paths
1456 and URLs are supported. HTML pages will be prefixed with this path when
1457 help is displayed in the 'web' format. This defaults to the documentation
1458 path of your Git installation.
1461 Override the HTTP proxy, normally configured using the 'http_proxy',
1462 'https_proxy', and 'all_proxy' environment variables (see
1463 `curl(1)`). This can be overridden on a per-remote basis; see
1467 File containing previously stored cookie lines which should be used
1468 in the Git http session, if they match the server. The file format
1469 of the file to read cookies from should be plain HTTP headers or
1470 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1471 NOTE that the file specified with http.cookiefile is only used as
1472 input unless http.saveCookies is set.
1475 If set, store cookies received during requests to the file specified by
1476 http.cookiefile. Has no effect if http.cookiefile is unset.
1479 Whether to verify the SSL certificate when fetching or pushing
1480 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1484 File containing the SSL certificate when fetching or pushing
1485 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1489 File containing the SSL private key when fetching or pushing
1490 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1493 http.sslCertPasswordProtected::
1494 Enable Git's password prompt for the SSL certificate. Otherwise
1495 OpenSSL will prompt the user, possibly many times, if the
1496 certificate or private key is encrypted. Can be overridden by the
1497 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1500 File containing the certificates to verify the peer with when
1501 fetching or pushing over HTTPS. Can be overridden by the
1502 'GIT_SSL_CAINFO' environment variable.
1505 Path containing files with the CA certificates to verify the peer
1506 with when fetching or pushing over HTTPS. Can be overridden
1507 by the 'GIT_SSL_CAPATH' environment variable.
1510 Attempt to use AUTH SSL/TLS and encrypted data transfers
1511 when connecting via regular FTP protocol. This might be needed
1512 if the FTP server requires it for security reasons or you wish
1513 to connect securely whenever remote FTP server supports it.
1514 Default is false since it might trigger certificate verification
1515 errors on misconfigured servers.
1518 How many HTTP requests to launch in parallel. Can be overridden
1519 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1522 The number of curl sessions (counted across slots) to be kept across
1523 requests. They will not be ended with curl_easy_cleanup() until
1524 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1525 value will be capped at 1. Defaults to 1.
1528 Maximum size in bytes of the buffer used by smart HTTP
1529 transports when POSTing data to the remote system.
1530 For requests larger than this buffer size, HTTP/1.1 and
1531 Transfer-Encoding: chunked is used to avoid creating a
1532 massive pack file locally. Default is 1 MiB, which is
1533 sufficient for most requests.
1535 http.lowSpeedLimit, http.lowSpeedTime::
1536 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1537 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1538 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1539 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1542 A boolean which disables using of EPSV ftp command by curl.
1543 This can helpful with some "poor" ftp servers which don't
1544 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1545 environment variable. Default is false (curl will use EPSV).
1548 The HTTP USER_AGENT string presented to an HTTP server. The default
1549 value represents the version of the client Git such as git/1.7.1.
1550 This option allows you to override this value to a more common value
1551 such as Mozilla/4.0. This may be necessary, for instance, if
1552 connecting through a firewall that restricts HTTP connections to a set
1553 of common USER_AGENT strings (but not including those like git/1.7.1).
1554 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1557 Any of the http.* options above can be applied selectively to some urls.
1558 For a config key to match a URL, each element of the config key is
1559 compared to that of the URL, in the following order:
1562 . Scheme (e.g., `https` in `https://example.com/`). This field
1563 must match exactly between the config key and the URL.
1565 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1566 This field must match exactly between the config key and the URL.
1568 . Port number (e.g., `8080` in `http://example.com:8080/`).
1569 This field must match exactly between the config key and the URL.
1570 Omitted port numbers are automatically converted to the correct
1571 default for the scheme before matching.
1573 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1574 path field of the config key must match the path field of the URL
1575 either exactly or as a prefix of slash-delimited path elements. This means
1576 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1577 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1578 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1579 key with just path `foo/`).
1581 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1582 the config key has a user name it must match the user name in the
1583 URL exactly. If the config key does not have a user name, that
1584 config key will match a URL with any user name (including none),
1585 but at a lower precedence than a config key with a user name.
1588 The list above is ordered by decreasing precedence; a URL that matches
1589 a config key's path is preferred to one that matches its user name. For example,
1590 if the URL is `https://user@example.com/foo/bar` a config key match of
1591 `https://example.com/foo` will be preferred over a config key match of
1592 `https://user@example.com`.
1594 All URLs are normalized before attempting any matching (the password part,
1595 if embedded in the URL, is always ignored for matching purposes) so that
1596 equivalent urls that are simply spelled differently will match properly.
1597 Environment variable settings always override any matches. The urls that are
1598 matched against are those given directly to Git commands. This means any URLs
1599 visited as a result of a redirection do not participate in matching.
1601 i18n.commitEncoding::
1602 Character encoding the commit messages are stored in; Git itself
1603 does not care per se, but this information is necessary e.g. when
1604 importing commits from emails or in the gitk graphical history
1605 browser (and possibly at other places in the future or in other
1606 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1608 i18n.logOutputEncoding::
1609 Character encoding the commit messages are converted to when
1610 running 'git log' and friends.
1613 The configuration variables in the 'imap' section are described
1614 in linkgit:git-imap-send[1].
1617 Specify the directory from which templates will be copied.
1618 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1621 Specify the program that will be used to browse your working
1622 repository in gitweb. See linkgit:git-instaweb[1].
1625 The HTTP daemon command-line to start gitweb on your working
1626 repository. See linkgit:git-instaweb[1].
1629 If true the web server started by linkgit:git-instaweb[1] will
1630 be bound to the local IP (127.0.0.1).
1632 instaweb.modulepath::
1633 The default module path for linkgit:git-instaweb[1] to use
1634 instead of /usr/lib/apache2/modules. Only used if httpd
1638 The port number to bind the gitweb httpd to. See
1639 linkgit:git-instaweb[1].
1641 interactive.singlekey::
1642 In interactive commands, allow the user to provide one-letter
1643 input with a single key (i.e., without hitting enter).
1644 Currently this is used by the `--patch` mode of
1645 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1646 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1647 setting is silently ignored if portable keystroke input
1651 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1652 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1653 override this option with `--no-abbrev-commit`.
1656 Set the default date-time mode for the 'log' command.
1657 Setting a value for log.date is similar to using 'git log''s
1658 `--date` option. Possible values are `relative`, `local`,
1659 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1663 Print out the ref names of any commits that are shown by the log
1664 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1665 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1666 specified, the full ref name (including prefix) will be printed.
1667 This is the same as the log commands '--decorate' option.
1670 If true, the initial commit will be shown as a big creation event.
1671 This is equivalent to a diff against an empty tree.
1672 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1673 normally hide the root commit will now show it. True by default.
1676 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1677 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1680 The location of an augmenting mailmap file. The default
1681 mailmap, located in the root of the repository, is loaded
1682 first, then the mailmap file pointed to by this variable.
1683 The location of the mailmap file may be in a repository
1684 subdirectory, or somewhere outside of the repository itself.
1685 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1688 Like `mailmap.file`, but consider the value as a reference to a
1689 blob in the repository. If both `mailmap.file` and
1690 `mailmap.blob` are given, both are parsed, with entries from
1691 `mailmap.file` taking precedence. In a bare repository, this
1692 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1696 Specify the programs that may be used to display help in the
1697 'man' format. See linkgit:git-help[1].
1700 Specify the command to invoke the specified man viewer. The
1701 specified command is evaluated in shell with the man page
1702 passed as argument. (See linkgit:git-help[1].)
1705 Override the path for the given tool that may be used to
1706 display help in the 'man' format. See linkgit:git-help[1].
1708 include::merge-config.txt[]
1710 mergetool.<tool>.path::
1711 Override the path for the given tool. This is useful in case
1712 your tool is not in the PATH.
1714 mergetool.<tool>.cmd::
1715 Specify the command to invoke the specified merge tool. The
1716 specified command is evaluated in shell with the following
1717 variables available: 'BASE' is the name of a temporary file
1718 containing the common base of the files to be merged, if available;
1719 'LOCAL' is the name of a temporary file containing the contents of
1720 the file on the current branch; 'REMOTE' is the name of a temporary
1721 file containing the contents of the file from the branch being
1722 merged; 'MERGED' contains the name of the file to which the merge
1723 tool should write the results of a successful merge.
1725 mergetool.<tool>.trustExitCode::
1726 For a custom merge command, specify whether the exit code of
1727 the merge command can be used to determine whether the merge was
1728 successful. If this is not set to true then the merge target file
1729 timestamp is checked and the merge assumed to have been successful
1730 if the file has been updated, otherwise the user is prompted to
1731 indicate the success of the merge.
1733 mergetool.keepBackup::
1734 After performing a merge, the original file with conflict markers
1735 can be saved as a file with a `.orig` extension. If this variable
1736 is set to `false` then this file is not preserved. Defaults to
1737 `true` (i.e. keep the backup files).
1739 mergetool.keepTemporaries::
1740 When invoking a custom merge tool, Git uses a set of temporary
1741 files to pass to the tool. If the tool returns an error and this
1742 variable is set to `true`, then these temporary files will be
1743 preserved, otherwise they will be removed after the tool has
1744 exited. Defaults to `false`.
1747 Prompt before each invocation of the merge resolution program.
1750 The (fully qualified) refname from which to show notes when
1751 showing commit messages. The value of this variable can be set
1752 to a glob, in which case notes from all matching refs will be
1753 shown. You may also specify this configuration variable
1754 several times. A warning will be issued for refs that do not
1755 exist, but a glob that does not match any refs is silently
1758 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1759 environment variable, which must be a colon separated list of refs or
1762 The effective value of "core.notesRef" (possibly overridden by
1763 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1766 notes.rewrite.<command>::
1767 When rewriting commits with <command> (currently `amend` or
1768 `rebase`) and this variable is set to `true`, Git
1769 automatically copies your notes from the original to the
1770 rewritten commit. Defaults to `true`, but see
1771 "notes.rewriteRef" below.
1774 When copying notes during a rewrite (see the
1775 "notes.rewrite.<command>" option), determines what to do if
1776 the target commit already has a note. Must be one of
1777 `overwrite`, `concatenate`, or `ignore`. Defaults to
1780 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1781 environment variable.
1784 When copying notes during a rewrite, specifies the (fully
1785 qualified) ref whose notes should be copied. The ref may be a
1786 glob, in which case notes in all matching refs will be copied.
1787 You may also specify this configuration several times.
1789 Does not have a default value; you must configure this variable to
1790 enable note rewriting. Set it to `refs/notes/commits` to enable
1791 rewriting for the default commit notes.
1793 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1794 environment variable, which must be a colon separated list of refs or
1798 The size of the window used by linkgit:git-pack-objects[1] when no
1799 window size is given on the command line. Defaults to 10.
1802 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1803 maximum depth is given on the command line. Defaults to 50.
1806 The window memory size limit used by linkgit:git-pack-objects[1]
1807 when no limit is given on the command line. The value can be
1808 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1812 An integer -1..9, indicating the compression level for objects
1813 in a pack file. -1 is the zlib default. 0 means no
1814 compression, and 1..9 are various speed/size tradeoffs, 9 being
1815 slowest. If not set, defaults to core.compression. If that is
1816 not set, defaults to -1, the zlib default, which is "a default
1817 compromise between speed and compression (currently equivalent
1820 Note that changing the compression level will not automatically recompress
1821 all existing objects. You can force recompression by passing the -F option
1822 to linkgit:git-repack[1].
1824 pack.deltaCacheSize::
1825 The maximum memory in bytes used for caching deltas in
1826 linkgit:git-pack-objects[1] before writing them out to a pack.
1827 This cache is used to speed up the writing object phase by not
1828 having to recompute the final delta result once the best match
1829 for all objects is found. Repacking large repositories on machines
1830 which are tight with memory might be badly impacted by this though,
1831 especially if this cache pushes the system into swapping.
1832 A value of 0 means no limit. The smallest size of 1 byte may be
1833 used to virtually disable this cache. Defaults to 256 MiB.
1835 pack.deltaCacheLimit::
1836 The maximum size of a delta, that is cached in
1837 linkgit:git-pack-objects[1]. This cache is used to speed up the
1838 writing object phase by not having to recompute the final delta
1839 result once the best match for all objects is found. Defaults to 1000.
1842 Specifies the number of threads to spawn when searching for best
1843 delta matches. This requires that linkgit:git-pack-objects[1]
1844 be compiled with pthreads otherwise this option is ignored with a
1845 warning. This is meant to reduce packing time on multiprocessor
1846 machines. The required amount of memory for the delta search window
1847 is however multiplied by the number of threads.
1848 Specifying 0 will cause Git to auto-detect the number of CPU's
1849 and set the number of threads accordingly.
1852 Specify the default pack index version. Valid values are 1 for
1853 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1854 the new pack index with capabilities for packs larger than 4 GB
1855 as well as proper protection against the repacking of corrupted
1856 packs. Version 2 is the default. Note that version 2 is enforced
1857 and this config option ignored whenever the corresponding pack is
1860 If you have an old Git that does not understand the version 2 `*.idx` file,
1861 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1862 that will copy both `*.pack` file and corresponding `*.idx` file from the
1863 other side may give you a repository that cannot be accessed with your
1864 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1865 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1868 pack.packSizeLimit::
1869 The maximum size of a pack. This setting only affects
1870 packing to a file when repacking, i.e. the git:// protocol
1871 is unaffected. It can be overridden by the `--max-pack-size`
1872 option of linkgit:git-repack[1]. The minimum size allowed is
1873 limited to 1 MiB. The default is unlimited.
1874 Common unit suffixes of 'k', 'm', or 'g' are
1878 If the value is boolean, turns on or off pagination of the
1879 output of a particular Git subcommand when writing to a tty.
1880 Otherwise, turns on pagination for the subcommand using the
1881 pager specified by the value of `pager.<cmd>`. If `--paginate`
1882 or `--no-pager` is specified on the command line, it takes
1883 precedence over this option. To disable pagination for all
1884 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1887 Alias for a --pretty= format string, as specified in
1888 linkgit:git-log[1]. Any aliases defined here can be used just
1889 as the built-in pretty formats could. For example,
1890 running `git config pretty.changelog "format:* %H %s"`
1891 would cause the invocation `git log --pretty=changelog`
1892 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1893 Note that an alias with the same name as a built-in format
1894 will be silently ignored.
1897 When true, rebase branches on top of the fetched branch, instead
1898 of merging the default branch from the default remote when "git
1899 pull" is run. See "branch.<name>.rebase" for setting this on a
1902 When preserve, also pass `--preserve-merges` along to 'git rebase'
1903 so that locally committed merge commits will not be flattened
1904 by running 'git pull'.
1906 *NOTE*: this is a possibly dangerous operation; do *not* use
1907 it unless you understand the implications (see linkgit:git-rebase[1]
1911 The default merge strategy to use when pulling multiple branches
1915 The default merge strategy to use when pulling a single branch.
1918 Defines the action `git push` should take if no refspec is
1919 explicitly given. Different values are well-suited for
1920 specific workflows; for instance, in a purely central workflow
1921 (i.e. the fetch source is equal to the push destination),
1922 `upstream` is probably what you want. Possible values are:
1926 * `nothing` - do not push anything (error out) unless a refspec is
1927 explicitly given. This is primarily meant for people who want to
1928 avoid mistakes by always being explicit.
1930 * `current` - push the current branch to update a branch with the same
1931 name on the receiving end. Works in both central and non-central
1934 * `upstream` - push the current branch back to the branch whose
1935 changes are usually integrated into the current branch (which is
1936 called `@{upstream}`). This mode only makes sense if you are
1937 pushing to the same repository you would normally pull from
1938 (i.e. central workflow).
1940 * `simple` - in centralized workflow, work like `upstream` with an
1941 added safety to refuse to push if the upstream branch's name is
1942 different from the local one.
1944 When pushing to a remote that is different from the remote you normally
1945 pull from, work as `current`. This is the safest option and is suited
1948 This mode will become the default in Git 2.0.
1950 * `matching` - push all branches having the same name on both ends.
1951 This makes the repository you are pushing to remember the set of
1952 branches that will be pushed out (e.g. if you always push 'maint'
1953 and 'master' there and no other branches, the repository you push
1954 to will have these two branches, and your local 'maint' and
1955 'master' will be pushed there).
1957 To use this mode effectively, you have to make sure _all_ the
1958 branches you would push out are ready to be pushed out before
1959 running 'git push', as the whole point of this mode is to allow you
1960 to push all of the branches in one go. If you usually finish work
1961 on only one branch and push out the result, while other branches are
1962 unfinished, this mode is not for you. Also this mode is not
1963 suitable for pushing into a shared central repository, as other
1964 people may add new branches there, or update the tip of existing
1965 branches outside your control.
1967 This is currently the default, but Git 2.0 will change the default
1973 Whether to show a diffstat of what changed upstream since the last
1974 rebase. False by default.
1977 If set to true enable '--autosquash' option by default.
1980 When set to true, automatically create a temporary stash
1981 before the operation begins, and apply it after the operation
1982 ends. This means that you can run rebase on a dirty worktree.
1983 However, use with care: the final stash application after a
1984 successful rebase might result in non-trivial conflicts.
1988 By default, git-receive-pack will run "git-gc --auto" after
1989 receiving data from git-push and updating refs. You can stop
1990 it by setting this variable to false.
1992 receive.fsckObjects::
1993 If it is set to true, git-receive-pack will check all received
1994 objects. It will abort in the case of a malformed object or a
1995 broken link. The result of an abort are only dangling objects.
1996 Defaults to false. If not set, the value of `transfer.fsckObjects`
1999 receive.unpackLimit::
2000 If the number of objects received in a push is below this
2001 limit then the objects will be unpacked into loose object
2002 files. However if the number of received objects equals or
2003 exceeds this limit then the received pack will be stored as
2004 a pack, after adding any missing delta bases. Storing the
2005 pack from a push can make the push operation complete faster,
2006 especially on slow filesystems. If not set, the value of
2007 `transfer.unpackLimit` is used instead.
2009 receive.denyDeletes::
2010 If set to true, git-receive-pack will deny a ref update that deletes
2011 the ref. Use this to prevent such a ref deletion via a push.
2013 receive.denyDeleteCurrent::
2014 If set to true, git-receive-pack will deny a ref update that
2015 deletes the currently checked out branch of a non-bare repository.
2017 receive.denyCurrentBranch::
2018 If set to true or "refuse", git-receive-pack will deny a ref update
2019 to the currently checked out branch of a non-bare repository.
2020 Such a push is potentially dangerous because it brings the HEAD
2021 out of sync with the index and working tree. If set to "warn",
2022 print a warning of such a push to stderr, but allow the push to
2023 proceed. If set to false or "ignore", allow such pushes with no
2024 message. Defaults to "refuse".
2026 receive.denyNonFastForwards::
2027 If set to true, git-receive-pack will deny a ref update which is
2028 not a fast-forward. Use this to prevent such an update via a push,
2029 even if that push is forced. This configuration variable is
2030 set when initializing a shared repository.
2033 String(s) `receive-pack` uses to decide which refs to omit
2034 from its initial advertisement. Use more than one
2035 definitions to specify multiple prefix strings. A ref that
2036 are under the hierarchies listed on the value of this
2037 variable is excluded, and is hidden when responding to `git
2038 push`, and an attempt to update or delete a hidden ref by
2039 `git push` is rejected.
2041 receive.updateserverinfo::
2042 If set to true, git-receive-pack will run git-update-server-info
2043 after receiving data from git-push and updating refs.
2045 receive.shallowupdate::
2046 If set to true, .git/shallow can be updated when new refs
2047 require new shallow roots. Otherwise those refs are rejected.
2049 remote.pushdefault::
2050 The remote to push to by default. Overrides
2051 `branch.<name>.remote` for all branches, and is overridden by
2052 `branch.<name>.pushremote` for specific branches.
2055 The URL of a remote repository. See linkgit:git-fetch[1] or
2056 linkgit:git-push[1].
2058 remote.<name>.pushurl::
2059 The push URL of a remote repository. See linkgit:git-push[1].
2061 remote.<name>.proxy::
2062 For remotes that require curl (http, https and ftp), the URL to
2063 the proxy to use for that remote. Set to the empty string to
2064 disable proxying for that remote.
2066 remote.<name>.fetch::
2067 The default set of "refspec" for linkgit:git-fetch[1]. See
2068 linkgit:git-fetch[1].
2070 remote.<name>.push::
2071 The default set of "refspec" for linkgit:git-push[1]. See
2072 linkgit:git-push[1].
2074 remote.<name>.mirror::
2075 If true, pushing to this remote will automatically behave
2076 as if the `--mirror` option was given on the command line.
2078 remote.<name>.skipDefaultUpdate::
2079 If true, this remote will be skipped by default when updating
2080 using linkgit:git-fetch[1] or the `update` subcommand of
2081 linkgit:git-remote[1].
2083 remote.<name>.skipFetchAll::
2084 If true, this remote will be skipped by default when updating
2085 using linkgit:git-fetch[1] or the `update` subcommand of
2086 linkgit:git-remote[1].
2088 remote.<name>.receivepack::
2089 The default program to execute on the remote side when pushing. See
2090 option \--receive-pack of linkgit:git-push[1].
2092 remote.<name>.uploadpack::
2093 The default program to execute on the remote side when fetching. See
2094 option \--upload-pack of linkgit:git-fetch-pack[1].
2096 remote.<name>.tagopt::
2097 Setting this value to \--no-tags disables automatic tag following when
2098 fetching from remote <name>. Setting it to \--tags will fetch every
2099 tag from remote <name>, even if they are not reachable from remote
2100 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2101 override this setting. See options \--tags and \--no-tags of
2102 linkgit:git-fetch[1].
2105 Setting this to a value <vcs> will cause Git to interact with
2106 the remote with the git-remote-<vcs> helper.
2108 remote.<name>.prune::
2109 When set to true, fetching from this remote by default will also
2110 remove any remote-tracking references that no longer exist on the
2111 remote (as if the `--prune` option was given on the command line).
2112 Overrides `fetch.prune` settings, if any.
2115 The list of remotes which are fetched by "git remote update
2116 <group>". See linkgit:git-remote[1].
2118 repack.usedeltabaseoffset::
2119 By default, linkgit:git-repack[1] creates packs that use
2120 delta-base offset. If you need to share your repository with
2121 Git older than version 1.4.4, either directly or via a dumb
2122 protocol such as http, then you need to set this option to
2123 "false" and repack. Access from old Git versions over the
2124 native protocol are unaffected by this option.
2127 When set to true, `git-rerere` updates the index with the
2128 resulting contents after it cleanly resolves conflicts using
2129 previously recorded resolution. Defaults to false.
2132 Activate recording of resolved conflicts, so that identical
2133 conflict hunks can be resolved automatically, should they be
2134 encountered again. By default, linkgit:git-rerere[1] is
2135 enabled if there is an `rr-cache` directory under the
2136 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2139 sendemail.identity::
2140 A configuration identity. When given, causes values in the
2141 'sendemail.<identity>' subsection to take precedence over
2142 values in the 'sendemail' section. The default identity is
2143 the value of 'sendemail.identity'.
2145 sendemail.smtpencryption::
2146 See linkgit:git-send-email[1] for description. Note that this
2147 setting is not subject to the 'identity' mechanism.
2150 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2152 sendemail.smtpsslcertpath::
2153 Path to ca-certificates (either a directory or a single file).
2154 Set it to an empty string to disable certificate verification.
2156 sendemail.<identity>.*::
2157 Identity-specific versions of the 'sendemail.*' parameters
2158 found below, taking precedence over those when the this
2159 identity is selected, through command-line or
2160 'sendemail.identity'.
2162 sendemail.aliasesfile::
2163 sendemail.aliasfiletype::
2164 sendemail.annotate::
2168 sendemail.chainreplyto::
2170 sendemail.envelopesender::
2172 sendemail.multiedit::
2173 sendemail.signedoffbycc::
2174 sendemail.smtppass::
2175 sendemail.suppresscc::
2176 sendemail.suppressfrom::
2178 sendemail.smtpdomain::
2179 sendemail.smtpserver::
2180 sendemail.smtpserverport::
2181 sendemail.smtpserveroption::
2182 sendemail.smtpuser::
2184 sendemail.validate::
2185 See linkgit:git-send-email[1] for description.
2187 sendemail.signedoffcc::
2188 Deprecated alias for 'sendemail.signedoffbycc'.
2190 showbranch.default::
2191 The default set of branches for linkgit:git-show-branch[1].
2192 See linkgit:git-show-branch[1].
2194 status.relativePaths::
2195 By default, linkgit:git-status[1] shows paths relative to the
2196 current directory. Setting this variable to `false` shows paths
2197 relative to the repository root (this was the default for Git
2201 Set to true to enable --short by default in linkgit:git-status[1].
2202 The option --no-short takes precedence over this variable.
2205 Set to true to enable --branch by default in linkgit:git-status[1].
2206 The option --no-branch takes precedence over this variable.
2208 status.displayCommentPrefix::
2209 If set to true, linkgit:git-status[1] will insert a comment
2210 prefix before each output line (starting with
2211 `core.commentChar`, i.e. `#` by default). This was the
2212 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2215 status.showUntrackedFiles::
2216 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2217 files which are not currently tracked by Git. Directories which
2218 contain only untracked files, are shown with the directory name
2219 only. Showing untracked files means that Git needs to lstat() all
2220 all the files in the whole repository, which might be slow on some
2221 systems. So, this variable controls how the commands displays
2222 the untracked files. Possible values are:
2225 * `no` - Show no untracked files.
2226 * `normal` - Show untracked files and directories.
2227 * `all` - Show also individual files in untracked directories.
2230 If this variable is not specified, it defaults to 'normal'.
2231 This variable can be overridden with the -u|--untracked-files option
2232 of linkgit:git-status[1] and linkgit:git-commit[1].
2234 status.submodulesummary::
2236 If this is set to a non zero number or true (identical to -1 or an
2237 unlimited number), the submodule summary will be enabled and a
2238 summary of commits for modified submodules will be shown (see
2239 --summary-limit option of linkgit:git-submodule[1]). Please note
2240 that the summary output command will be suppressed for all
2241 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2242 for those submodules where `submodule.<name>.ignore=all`. To
2243 also view the summary for ignored submodules you can either use
2244 the --ignore-submodules=dirty command line option or the 'git
2245 submodule summary' command, which shows a similar output but does
2246 not honor these settings.
2248 submodule.<name>.path::
2249 submodule.<name>.url::
2250 submodule.<name>.update::
2251 The path within this project, URL, and the updating strategy
2252 for a submodule. These variables are initially populated
2253 by 'git submodule init'; edit them to override the
2254 URL and other values found in the `.gitmodules` file. See
2255 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2257 submodule.<name>.branch::
2258 The remote branch name for a submodule, used by `git submodule
2259 update --remote`. Set this option to override the value found in
2260 the `.gitmodules` file. See linkgit:git-submodule[1] and
2261 linkgit:gitmodules[5] for details.
2263 submodule.<name>.fetchRecurseSubmodules::
2264 This option can be used to control recursive fetching of this
2265 submodule. It can be overridden by using the --[no-]recurse-submodules
2266 command line option to "git fetch" and "git pull".
2267 This setting will override that from in the linkgit:gitmodules[5]
2270 submodule.<name>.ignore::
2271 Defines under what circumstances "git status" and the diff family show
2272 a submodule as modified. When set to "all", it will never be considered
2273 modified, "dirty" will ignore all changes to the submodules work tree and
2274 takes only differences between the HEAD of the submodule and the commit
2275 recorded in the superproject into account. "untracked" will additionally
2276 let submodules with modified tracked files in their work tree show up.
2277 Using "none" (the default when this option is not set) also shows
2278 submodules that have untracked files in their work tree as changed.
2279 This setting overrides any setting made in .gitmodules for this submodule,
2280 both settings can be overridden on the command line by using the
2281 "--ignore-submodules" option. The 'git submodule' commands are not
2282 affected by this setting.
2285 This variable can be used to restrict the permission bits of
2286 tar archive entries. The default is 0002, which turns off the
2287 world write bit. The special value "user" indicates that the
2288 archiving user's umask will be used instead. See umask(2) and
2289 linkgit:git-archive[1].
2291 transfer.fsckObjects::
2292 When `fetch.fsckObjects` or `receive.fsckObjects` are
2293 not set, the value of this variable is used instead.
2297 This variable can be used to set both `receive.hiderefs`
2298 and `uploadpack.hiderefs` at the same time to the same
2299 values. See entries for these other variables.
2301 transfer.unpackLimit::
2302 When `fetch.unpackLimit` or `receive.unpackLimit` are
2303 not set, the value of this variable is used instead.
2304 The default value is 100.
2306 uploadpack.hiderefs::
2307 String(s) `upload-pack` uses to decide which refs to omit
2308 from its initial advertisement. Use more than one
2309 definitions to specify multiple prefix strings. A ref that
2310 are under the hierarchies listed on the value of this
2311 variable is excluded, and is hidden from `git ls-remote`,
2312 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2313 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2315 uploadpack.allowtipsha1inwant::
2316 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2317 to accept a fetch request that asks for an object at the tip
2318 of a hidden ref (by default, such a request is rejected).
2319 see also `uploadpack.hiderefs`.
2321 uploadpack.keepalive::
2322 When `upload-pack` has started `pack-objects`, there may be a
2323 quiet period while `pack-objects` prepares the pack. Normally
2324 it would output progress information, but if `--quiet` was used
2325 for the fetch, `pack-objects` will output nothing at all until
2326 the pack data begins. Some clients and networks may consider
2327 the server to be hung and give up. Setting this option instructs
2328 `upload-pack` to send an empty keepalive packet every
2329 `uploadpack.keepalive` seconds. Setting this option to 0
2330 disables keepalive packets entirely. The default is 5 seconds.
2332 url.<base>.insteadOf::
2333 Any URL that starts with this value will be rewritten to
2334 start, instead, with <base>. In cases where some site serves a
2335 large number of repositories, and serves them with multiple
2336 access methods, and some users need to use different access
2337 methods, this feature allows people to specify any of the
2338 equivalent URLs and have Git automatically rewrite the URL to
2339 the best alternative for the particular user, even for a
2340 never-before-seen repository on the site. When more than one
2341 insteadOf strings match a given URL, the longest match is used.
2343 url.<base>.pushInsteadOf::
2344 Any URL that starts with this value will not be pushed to;
2345 instead, it will be rewritten to start with <base>, and the
2346 resulting URL will be pushed to. In cases where some site serves
2347 a large number of repositories, and serves them with multiple
2348 access methods, some of which do not allow push, this feature
2349 allows people to specify a pull-only URL and have Git
2350 automatically use an appropriate URL to push, even for a
2351 never-before-seen repository on the site. When more than one
2352 pushInsteadOf strings match a given URL, the longest match is
2353 used. If a remote has an explicit pushurl, Git will ignore this
2354 setting for that remote.
2357 Your email address to be recorded in any newly created commits.
2358 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2359 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2362 Your full name to be recorded in any newly created commits.
2363 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2364 environment variables. See linkgit:git-commit-tree[1].
2367 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2368 key you want it to automatically when creating a signed tag or
2369 commit, you can override the default selection with this variable.
2370 This option is passed unchanged to gpg's --local-user parameter,
2371 so you may specify a key using any method that gpg supports.
2374 Specify a web browser that may be used by some commands.
2375 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]