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.
136 Other git-related tools may and do use their own variables. When
137 inventing new variables for use in your own tool, make sure their
138 names do not conflict with those that are used by Git itself and
139 other popular tools, and describe them in your documentation.
143 These variables control various optional help messages designed to
144 aid new users. All 'advice.*' variables default to 'true', and you
145 can tell Git that you do not need help by setting these to 'false':
149 Set this variable to 'false' if you want to disable
151 'pushNonFFMatching', 'pushAlreadyExists',
152 'pushFetchFirst', and 'pushNeedsForce'
155 Advice shown when linkgit:git-push[1] fails due to a
156 non-fast-forward update to the current branch.
158 Advice shown when you ran linkgit:git-push[1] and pushed
159 'matching refs' explicitly (i.e. you used ':', or
160 specified a refspec that isn't your current branch) and
161 it resulted in a non-fast-forward error.
163 Shown when linkgit:git-push[1] rejects an update that
164 does not qualify for fast-forwarding (e.g., a tag.)
166 Shown when linkgit:git-push[1] rejects an update that
167 tries to overwrite a remote ref that points at an
168 object we do not have.
170 Shown when linkgit:git-push[1] rejects an update that
171 tries to overwrite a remote ref that points at an
172 object that is not a commit-ish, or make the remote
173 ref point at an object that is not a commit-ish.
175 Show directions on how to proceed from the current
176 state in the output of linkgit:git-status[1], in
177 the template shown when writing commit messages in
178 linkgit:git-commit[1], and in the help message shown
179 by linkgit:git-checkout[1] when switching branch.
181 Advise to consider using the `-u` option to linkgit:git-status[1]
182 when the command takes more than 2 seconds to enumerate untracked
185 Advice shown when linkgit:git-merge[1] refuses to
186 merge to avoid overwriting local changes.
188 Advice shown by various commands when conflicts
189 prevent the operation from being performed.
191 Advice on how to set your identity configuration when
192 your information is guessed from the system username and
195 Advice shown when you used linkgit:git-checkout[1] to
196 move to the detach HEAD state, to instruct how to create
197 a local branch after the fact.
199 Advice that shows the location of the patch file when
200 linkgit:git-am[1] fails to apply it.
202 In case of failure in the output of linkgit:git-rm[1],
203 show directions on how to proceed from the current state.
207 If false, the executable bit differences between the index and
208 the working tree are ignored; useful on broken filesystems like FAT.
209 See linkgit:git-update-index[1].
211 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
212 will probe and set core.fileMode false if appropriate when the
213 repository is created.
216 If true, this option enables various workarounds to enable
217 Git to work better on filesystems that are not case sensitive,
218 like FAT. For example, if a directory listing finds
219 "makefile" when Git expects "Makefile", Git will assume
220 it is really the same file, and continue to remember it as
223 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
224 will probe and set core.ignorecase true if appropriate when the repository
227 core.precomposeunicode::
228 This option is only used by Mac OS implementation of Git.
229 When core.precomposeunicode=true, Git reverts the unicode decomposition
230 of filenames done by Mac OS. This is useful when sharing a repository
231 between Mac OS and Linux or Windows.
232 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
233 When false, file names are handled fully transparent by Git,
234 which is backward compatible with older versions of Git.
237 If false, the ctime differences between the index and the
238 working tree are ignored; useful when the inode change time
239 is regularly modified by something outside Git (file system
240 crawlers and some backup systems).
241 See linkgit:git-update-index[1]. True by default.
244 Determines which stat fields to match between the index
245 and work tree. The user can set this to 'default' or
246 'minimal'. Default (or explicitly 'default'), is to check
247 all fields, including the sub-second part of mtime and ctime.
250 The commands that output paths (e.g. 'ls-files',
251 'diff'), when not given the `-z` option, will quote
252 "unusual" characters in the pathname by enclosing the
253 pathname in a double-quote pair and with backslashes the
254 same way strings in C source code are quoted. If this
255 variable is set to false, the bytes higher than 0x80 are
256 not quoted but output as verbatim. Note that double
257 quote, backslash and control characters are always
258 quoted without `-z` regardless of the setting of this
262 Sets the line ending type to use in the working directory for
263 files that have the `text` property set. Alternatives are
264 'lf', 'crlf' and 'native', which uses the platform's native
265 line ending. The default value is `native`. See
266 linkgit:gitattributes[5] for more information on end-of-line
270 If true, makes Git check if converting `CRLF` is reversible when
271 end-of-line conversion is active. Git will verify if a command
272 modifies a file in the work tree either directly or indirectly.
273 For example, committing a file followed by checking out the
274 same file should yield the original file in the work tree. If
275 this is not the case for the current setting of
276 `core.autocrlf`, Git will reject the file. The variable can
277 be set to "warn", in which case Git will only warn about an
278 irreversible conversion but continue the operation.
280 CRLF conversion bears a slight chance of corrupting data.
281 When it is enabled, Git will convert CRLF to LF during commit and LF to
282 CRLF during checkout. A file that contains a mixture of LF and
283 CRLF before the commit cannot be recreated by Git. For text
284 files this is the right thing to do: it corrects line endings
285 such that we have only LF line endings in the repository.
286 But for binary files that are accidentally classified as text the
287 conversion can corrupt data.
289 If you recognize such corruption early you can easily fix it by
290 setting the conversion type explicitly in .gitattributes. Right
291 after committing you still have the original file in your work
292 tree and this file is not yet corrupted. You can explicitly tell
293 Git that this file is binary and Git will handle the file
296 Unfortunately, the desired effect of cleaning up text files with
297 mixed line endings and the undesired effect of corrupting binary
298 files cannot be distinguished. In both cases CRLFs are removed
299 in an irreversible way. For text files this is the right thing
300 to do because CRLFs are line endings, while for binary files
301 converting CRLFs corrupts data.
303 Note, this safety check does not mean that a checkout will generate a
304 file identical to the original file for a different setting of
305 `core.eol` and `core.autocrlf`, but only for the current one. For
306 example, a text file with `LF` would be accepted with `core.eol=lf`
307 and could later be checked out with `core.eol=crlf`, in which case the
308 resulting file would contain `CRLF`, although the original file
309 contained `LF`. However, in both work trees the line endings would be
310 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
311 file with mixed line endings would be reported by the `core.safecrlf`
315 Setting this variable to "true" is almost the same as setting
316 the `text` attribute to "auto" on all files except that text
317 files are not guaranteed to be normalized: files that contain
318 `CRLF` in the repository will not be touched. Use this
319 setting if you want to have `CRLF` line endings in your
320 working directory even though the repository does not have
321 normalized line endings. This variable can be set to 'input',
322 in which case no output conversion is performed.
325 If false, symbolic links are checked out as small plain files that
326 contain the link text. linkgit:git-update-index[1] and
327 linkgit:git-add[1] will not change the recorded type to regular
328 file. Useful on filesystems like FAT that do not support
331 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
332 will probe and set core.symlinks false if appropriate when the repository
336 A "proxy command" to execute (as 'command host port') instead
337 of establishing direct connection to the remote server when
338 using the Git protocol for fetching. If the variable value is
339 in the "COMMAND for DOMAIN" format, the command is applied only
340 on hostnames ending with the specified domain string. This variable
341 may be set multiple times and is matched in the given order;
342 the first match wins.
344 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
345 (which always applies universally, without the special "for"
348 The special string `none` can be used as the proxy command to
349 specify that no proxy be used for a given domain pattern.
350 This is useful for excluding servers inside a firewall from
351 proxy use, while defaulting to a common proxy for external domains.
354 If true, commands which modify both the working tree and the index
355 will mark the updated paths with the "assume unchanged" bit in the
356 index. These marked files are then assumed to stay unchanged in the
357 working tree, until you mark them otherwise manually - Git will not
358 detect the file changes by lstat() calls. This is useful on systems
359 where those are very slow, such as Microsoft Windows.
360 See linkgit:git-update-index[1].
363 core.preferSymlinkRefs::
364 Instead of the default "symref" format for HEAD
365 and other symbolic reference files, use symbolic links.
366 This is sometimes needed to work with old scripts that
367 expect HEAD to be a symbolic link.
370 If true this repository is assumed to be 'bare' and has no
371 working directory associated with it. If this is the case a
372 number of commands that require a working directory will be
373 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
375 This setting is automatically guessed by linkgit:git-clone[1] or
376 linkgit:git-init[1] when the repository was created. By default a
377 repository that ends in "/.git" is assumed to be not bare (bare =
378 false), while all other repositories are assumed to be bare (bare
382 Set the path to the root of the working tree.
383 If GIT_COMMON_DIR environment variable is set, core.worktree
384 is ignored and not used for determining the root of working tree.
385 This can be overridden by the GIT_WORK_TREE environment
386 variable and the '--work-tree' command-line option.
387 The value can be an absolute path or relative to the path to
388 the .git directory, which is either specified by --git-dir
389 or GIT_DIR, or automatically discovered.
390 If --git-dir or GIT_DIR is specified but none of
391 --work-tree, GIT_WORK_TREE and core.worktree is specified,
392 the current working directory is regarded as the top level
393 of your working tree.
395 Note that this variable is honored even when set in a configuration
396 file in a ".git" subdirectory of a directory and its value differs
397 from the latter directory (e.g. "/path/to/.git/config" has
398 core.worktree set to "/different/path"), which is most likely a
399 misconfiguration. Running Git commands in the "/path/to" directory will
400 still use "/different/path" as the root of the work tree and can cause
401 confusion unless you know what you are doing (e.g. you are creating a
402 read-only snapshot of the same index to a location different from the
403 repository's usual working tree).
405 core.logAllRefUpdates::
406 Enable the reflog. Updates to a ref <ref> is logged to the file
407 "$GIT_DIR/logs/<ref>", by appending the new and old
408 SHA-1, the date/time and the reason of the update, but
409 only when the file exists. If this configuration
410 variable is set to true, missing "$GIT_DIR/logs/<ref>"
411 file is automatically created for branch heads (i.e. under
412 refs/heads/), remote refs (i.e. under refs/remotes/),
413 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
415 This information can be used to determine what commit
416 was the tip of a branch "2 days ago".
418 This value is true by default in a repository that has
419 a working directory associated with it, and false by
420 default in a bare repository.
422 core.repositoryFormatVersion::
423 Internal variable identifying the repository format and layout
426 core.sharedRepository::
427 When 'group' (or 'true'), the repository is made shareable between
428 several users in a group (making sure all the files and objects are
429 group-writable). When 'all' (or 'world' or 'everybody'), the
430 repository will be readable by all users, additionally to being
431 group-shareable. When 'umask' (or 'false'), Git will use permissions
432 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
433 files in the repository will have this mode value. '0xxx' will override
434 user's umask value (whereas the other options will only override
435 requested parts of the user's umask value). Examples: '0660' will make
436 the repo read/write-able for the owner and group, but inaccessible to
437 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
438 repository that is group-readable but not group-writable.
439 See linkgit:git-init[1]. False by default.
441 core.warnAmbiguousRefs::
442 If true, Git will warn you if the ref name you passed it is ambiguous
443 and might match multiple refs in the repository. True by default.
446 An integer -1..9, indicating a default compression level.
447 -1 is the zlib default. 0 means no compression,
448 and 1..9 are various speed/size tradeoffs, 9 being slowest.
449 If set, this provides a default to other compression variables,
450 such as 'core.loosecompression' and 'pack.compression'.
452 core.loosecompression::
453 An integer -1..9, indicating the compression level for objects that
454 are not in a pack file. -1 is the zlib default. 0 means no
455 compression, and 1..9 are various speed/size tradeoffs, 9 being
456 slowest. If not set, defaults to core.compression. If that is
457 not set, defaults to 1 (best speed).
459 core.packedGitWindowSize::
460 Number of bytes of a pack file to map into memory in a
461 single mapping operation. Larger window sizes may allow
462 your system to process a smaller number of large pack files
463 more quickly. Smaller window sizes will negatively affect
464 performance due to increased calls to the operating system's
465 memory manager, but may improve performance when accessing
466 a large number of large pack files.
468 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
469 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
470 be reasonable for all users/operating systems. You probably do
471 not need to adjust this value.
473 Common unit suffixes of 'k', 'm', or 'g' are supported.
475 core.packedGitLimit::
476 Maximum number of bytes to map simultaneously into memory
477 from pack files. If Git needs to access more than this many
478 bytes at once to complete an operation it will unmap existing
479 regions to reclaim virtual address space within the process.
481 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
482 This should be reasonable for all users/operating systems, except on
483 the largest projects. You probably do not need to adjust this value.
485 Common unit suffixes of 'k', 'm', or 'g' are supported.
487 core.deltaBaseCacheLimit::
488 Maximum number of bytes to reserve for caching base objects
489 that may be referenced by multiple deltified objects. By storing the
490 entire decompressed base objects in a cache Git is able
491 to avoid unpacking and decompressing frequently used base
492 objects multiple times.
494 Default is 96 MiB on all platforms. This should be reasonable
495 for all users/operating systems, except on the largest projects.
496 You probably do not need to adjust this value.
498 Common unit suffixes of 'k', 'm', or 'g' are supported.
500 core.bigFileThreshold::
501 Files larger than this size are stored deflated, without
502 attempting delta compression. Storing large files without
503 delta compression avoids excessive memory usage, at the
504 slight expense of increased disk usage.
506 Default is 512 MiB on all platforms. This should be reasonable
507 for most projects as source code and other text files can still
508 be delta compressed, but larger binary media files won't be.
510 Common unit suffixes of 'k', 'm', or 'g' are supported.
513 In addition to '.gitignore' (per-directory) and
514 '.git/info/exclude', Git looks into this file for patterns
515 of files which are not meant to be tracked. "`~/`" is expanded
516 to the value of `$HOME` and "`~user/`" to the specified user's
517 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
518 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
519 is used instead. See linkgit:gitignore[5].
522 Some commands (e.g. svn and http interfaces) that interactively
523 ask for a password can be told to use an external program given
524 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
525 environment variable. If not set, fall back to the value of the
526 'SSH_ASKPASS' environment variable or, failing that, a simple password
527 prompt. The external program shall be given a suitable prompt as
528 command-line argument and write the password on its STDOUT.
530 core.attributesfile::
531 In addition to '.gitattributes' (per-directory) and
532 '.git/info/attributes', Git looks into this file for attributes
533 (see linkgit:gitattributes[5]). Path expansions are made the same
534 way as for `core.excludesfile`. Its default value is
535 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
536 set or empty, $HOME/.config/git/attributes is used instead.
539 Commands such as `commit` and `tag` that lets you edit
540 messages by launching an editor uses the value of this
541 variable when it is set, and the environment variable
542 `GIT_EDITOR` is not set. See linkgit:git-var[1].
545 Commands such as `commit` and `tag` that lets you edit
546 messages consider a line that begins with this character
547 commented, and removes them after the editor returns
550 If set to "auto", `git-commit` would select a character that is not
551 the beginning character of any line in existing commit messages.
554 Text editor used by `git rebase -i` for editing the rebase instruction file.
555 The value is meant to be interpreted by the shell when it is used.
556 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
557 When not configured the default commit message editor is used instead.
560 Text viewer for use by Git commands (e.g., 'less'). The value
561 is meant to be interpreted by the shell. The order of preference
562 is the `$GIT_PAGER` environment variable, then `core.pager`
563 configuration, then `$PAGER`, and then the default chosen at
564 compile time (usually 'less').
566 When the `LESS` environment variable is unset, Git sets it to `FRX`
567 (if `LESS` environment variable is set, Git does not change it at
568 all). If you want to selectively override Git's default setting
569 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
570 be passed to the shell by Git, which will translate the final
571 command to `LESS=FRX less -S`. The environment does not set the
572 `S` option but the command line does, instructing less to truncate
573 long lines. Similarly, setting `core.pager` to `less -+F` will
574 deactivate the `F` option specified by the environment from the
575 command-line, deactivating the "quit if one screen" behavior of
576 `less`. One can specifically activate some flags for particular
577 commands: for example, setting `pager.blame` to `less -S` enables
578 line truncation only for `git blame`.
580 Likewise, when the `LV` environment variable is unset, Git sets it
581 to `-c`. You can override this setting by exporting `LV` with
582 another value or setting `core.pager` to `lv +c`.
585 A comma separated list of common whitespace problems to
586 notice. 'git diff' will use `color.diff.whitespace` to
587 highlight them, and 'git apply --whitespace=error' will
588 consider them as errors. You can prefix `-` to disable
589 any of them (e.g. `-trailing-space`):
591 * `blank-at-eol` treats trailing whitespaces at the end of the line
592 as an error (enabled by default).
593 * `space-before-tab` treats a space character that appears immediately
594 before a tab character in the initial indent part of the line as an
595 error (enabled by default).
596 * `indent-with-non-tab` treats a line that is indented with space
597 characters instead of the equivalent tabs as an error (not enabled by
599 * `tab-in-indent` treats a tab character in the initial indent part of
600 the line as an error (not enabled by default).
601 * `blank-at-eof` treats blank lines added at the end of file as an error
602 (enabled by default).
603 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
605 * `cr-at-eol` treats a carriage-return at the end of line as
606 part of the line terminator, i.e. with it, `trailing-space`
607 does not trigger if the character before such a carriage-return
608 is not a whitespace (not enabled by default).
609 * `tabwidth=<n>` tells how many character positions a tab occupies; this
610 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
611 errors. The default tab width is 8. Allowed values are 1 to 63.
613 core.fsyncobjectfiles::
614 This boolean will enable 'fsync()' when writing object files.
616 This is a total waste of time and effort on a filesystem that orders
617 data writes properly, but can be useful for filesystems that do not use
618 journalling (traditional UNIX filesystems) or that only journal metadata
619 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
622 Enable parallel index preload for operations like 'git diff'
624 This can speed up operations like 'git diff' and 'git status' especially
625 on filesystems like NFS that have weak caching semantics and thus
626 relatively high IO latencies. When enabled, Git will do the
627 index comparison to the filesystem data in parallel, allowing
628 overlapping IO's. Defaults to true.
631 You can set this to 'link', in which case a hardlink followed by
632 a delete of the source are used to make sure that object creation
633 will not overwrite existing objects.
635 On some file system/operating system combinations, this is unreliable.
636 Set this config setting to 'rename' there; However, This will remove the
637 check that makes sure that existing object files will not get overwritten.
640 When showing commit messages, also show notes which are stored in
641 the given ref. The ref must be fully qualified. If the given
642 ref does not exist, it is not an error but means that no
643 notes should be printed.
645 This setting defaults to "refs/notes/commits", and it can be overridden by
646 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
648 core.sparseCheckout::
649 Enable "sparse checkout" feature. See section "Sparse checkout" in
650 linkgit:git-read-tree[1] for more information.
653 Set the length object names are abbreviated to. If unspecified,
654 many commands abbreviate to 7 hexdigits, which may not be enough
655 for abbreviated object names to stay unique for sufficiently long
660 Tells 'git add' to continue adding files when some files cannot be
661 added due to indexing errors. Equivalent to the '--ignore-errors'
662 option of linkgit:git-add[1]. Older versions of Git accept only
663 `add.ignore-errors`, which does not follow the usual naming
664 convention for configuration variables. Newer versions of Git
665 honor `add.ignoreErrors` as well.
668 Command aliases for the linkgit:git[1] command wrapper - e.g.
669 after defining "alias.last = cat-file commit HEAD", the invocation
670 "git last" is equivalent to "git cat-file commit HEAD". To avoid
671 confusion and troubles with script usage, aliases that
672 hide existing Git commands are ignored. Arguments are split by
673 spaces, the usual shell quoting and escaping is supported.
674 quote pair and a backslash can be used to quote them.
676 If the alias expansion is prefixed with an exclamation point,
677 it will be treated as a shell command. For example, defining
678 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
679 "git new" is equivalent to running the shell command
680 "gitk --all --not ORIG_HEAD". Note that shell commands will be
681 executed from the top-level directory of a repository, which may
682 not necessarily be the current directory.
683 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
684 from the original current directory. See linkgit:git-rev-parse[1].
687 If true, git-am will call git-mailsplit for patches in mbox format
688 with parameter '--keep-cr'. In this case git-mailsplit will
689 not remove `\r` from lines ending with `\r\n`. Can be overridden
690 by giving '--no-keep-cr' from the command line.
691 See linkgit:git-am[1], linkgit:git-mailsplit[1].
693 apply.ignorewhitespace::
694 When set to 'change', tells 'git apply' to ignore changes in
695 whitespace, in the same way as the '--ignore-space-change'
697 When set to one of: no, none, never, false tells 'git apply' to
698 respect all whitespace differences.
699 See linkgit:git-apply[1].
702 Tells 'git apply' how to handle whitespaces, in the same way
703 as the '--whitespace' option. See linkgit:git-apply[1].
705 branch.autosetupmerge::
706 Tells 'git branch' and 'git checkout' to set up new branches
707 so that linkgit:git-pull[1] will appropriately merge from the
708 starting point branch. Note that even if this option is not set,
709 this behavior can be chosen per-branch using the `--track`
710 and `--no-track` options. The valid settings are: `false` -- no
711 automatic setup is done; `true` -- automatic setup is done when the
712 starting point is a remote-tracking branch; `always` --
713 automatic setup is done when the starting point is either a
714 local branch or remote-tracking
715 branch. This option defaults to true.
717 branch.autosetuprebase::
718 When a new branch is created with 'git branch' or 'git checkout'
719 that tracks another branch, this variable tells Git to set
720 up pull to rebase instead of merge (see "branch.<name>.rebase").
721 When `never`, rebase is never automatically set to true.
722 When `local`, rebase is set to true for tracked branches of
723 other local branches.
724 When `remote`, rebase is set to true for tracked branches of
725 remote-tracking branches.
726 When `always`, rebase will be set to true for all tracking
728 See "branch.autosetupmerge" for details on how to set up a
729 branch to track another branch.
730 This option defaults to never.
732 branch.<name>.remote::
733 When on branch <name>, it tells 'git fetch' and 'git push'
734 which remote to fetch from/push to. The remote to push to
735 may be overridden with `remote.pushdefault` (for all branches).
736 The remote to push to, for the current branch, may be further
737 overridden by `branch.<name>.pushremote`. If no remote is
738 configured, or if you are not on any branch, it defaults to
739 `origin` for fetching and `remote.pushdefault` for pushing.
740 Additionally, `.` (a period) is the current local repository
741 (a dot-repository), see `branch.<name>.merge`'s final note below.
743 branch.<name>.pushremote::
744 When on branch <name>, it overrides `branch.<name>.remote` for
745 pushing. It also overrides `remote.pushdefault` for pushing
746 from branch <name>. When you pull from one place (e.g. your
747 upstream) and push to another place (e.g. your own publishing
748 repository), you would want to set `remote.pushdefault` to
749 specify the remote to push to for all branches, and use this
750 option to override it for a specific branch.
752 branch.<name>.merge::
753 Defines, together with branch.<name>.remote, the upstream branch
754 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
755 branch to merge and can also affect 'git push' (see push.default).
756 When in branch <name>, it tells 'git fetch' the default
757 refspec to be marked for merging in FETCH_HEAD. The value is
758 handled like the remote part of a refspec, and must match a
759 ref which is fetched from the remote given by
760 "branch.<name>.remote".
761 The merge information is used by 'git pull' (which at first calls
762 'git fetch') to lookup the default branch for merging. Without
763 this option, 'git pull' defaults to merge the first refspec fetched.
764 Specify multiple values to get an octopus merge.
765 If you wish to setup 'git pull' so that it merges into <name> from
766 another branch in the local repository, you can point
767 branch.<name>.merge to the desired branch, and use the relative path
768 setting `.` (a period) for branch.<name>.remote.
770 branch.<name>.mergeoptions::
771 Sets default options for merging into branch <name>. The syntax and
772 supported options are the same as those of linkgit:git-merge[1], but
773 option values containing whitespace characters are currently not
776 branch.<name>.rebase::
777 When true, rebase the branch <name> on top of the fetched branch,
778 instead of merging the default branch from the default remote when
779 "git pull" is run. See "pull.rebase" for doing this in a non
780 branch-specific manner.
782 When preserve, also pass `--preserve-merges` along to 'git rebase'
783 so that locally committed merge commits will not be flattened
784 by running 'git pull'.
786 *NOTE*: this is a possibly dangerous operation; do *not* use
787 it unless you understand the implications (see linkgit:git-rebase[1]
790 branch.<name>.description::
791 Branch description, can be edited with
792 `git branch --edit-description`. Branch description is
793 automatically added in the format-patch cover letter or
794 request-pull summary.
797 Specify the command to invoke the specified browser. The
798 specified command is evaluated in shell with the URLs passed
799 as arguments. (See linkgit:git-web{litdd}browse[1].)
801 browser.<tool>.path::
802 Override the path for the given tool that may be used to
803 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
804 working repository in gitweb (see linkgit:git-instaweb[1]).
807 A boolean to make git-clean do nothing unless given -f,
808 -i or -n. Defaults to true.
811 A boolean to enable/disable color in the output of
812 linkgit:git-branch[1]. May be set to `always`,
813 `false` (or `never`) or `auto` (or `true`), in which case colors are used
814 only when the output is to a terminal. Defaults to false.
816 color.branch.<slot>::
817 Use customized color for branch coloration. `<slot>` is one of
818 `current` (the current branch), `local` (a local branch),
819 `remote` (a remote-tracking branch in refs/remotes/),
820 `upstream` (upstream tracking branch), `plain` (other
823 The value for these configuration variables is a list of colors (at most
824 two) and attributes (at most one), separated by spaces. The colors
825 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
826 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
827 `blink` and `reverse`. The first color given is the foreground; the
828 second is the background. The position of the attribute, if any,
832 Whether to use ANSI escape sequences to add color to patches.
833 If this is set to `always`, linkgit:git-diff[1],
834 linkgit:git-log[1], and linkgit:git-show[1] will use color
835 for all patches. If it is set to `true` or `auto`, those
836 commands will only use color when output is to the terminal.
839 This does not affect linkgit:git-format-patch[1] or the
840 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
841 command line with the `--color[=<when>]` option.
844 Use customized color for diff colorization. `<slot>` specifies
845 which part of the patch to use the specified color, and is one
846 of `plain` (context text), `meta` (metainformation), `frag`
847 (hunk header), 'func' (function in hunk header), `old` (removed lines),
848 `new` (added lines), `commit` (commit headers), or `whitespace`
849 (highlighting whitespace errors). The values of these variables may be
850 specified as in color.branch.<slot>.
852 color.decorate.<slot>::
853 Use customized color for 'git log --decorate' output. `<slot>` is one
854 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
855 branches, remote-tracking branches, tags, stash and HEAD, respectively.
858 When set to `always`, always highlight matches. When `false` (or
859 `never`), never. When set to `true` or `auto`, use color only
860 when the output is written to the terminal. Defaults to `false`.
863 Use customized color for grep colorization. `<slot>` specifies which
864 part of the line to use the specified color, and is one of
868 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
870 filename prefix (when not using `-h`)
872 function name lines (when using `-p`)
874 line number prefix (when using `-n`)
878 non-matching text in selected lines
880 separators between fields on a line (`:`, `-`, and `=`)
881 and between hunks (`--`)
884 The values of these variables may be specified as in color.branch.<slot>.
887 When set to `always`, always use colors for interactive prompts
888 and displays (such as those used by "git-add --interactive" and
889 "git-clean --interactive"). When false (or `never`), never.
890 When set to `true` or `auto`, use colors only when the output is
891 to the terminal. Defaults to false.
893 color.interactive.<slot>::
894 Use customized color for 'git add --interactive' and 'git clean
895 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
896 or `error`, for four distinct types of normal output from
897 interactive commands. The values of these variables may be
898 specified as in color.branch.<slot>.
901 A boolean to enable/disable colored output when the pager is in
902 use (default is true).
905 A boolean to enable/disable color in the output of
906 linkgit:git-show-branch[1]. May be set to `always`,
907 `false` (or `never`) or `auto` (or `true`), in which case colors are used
908 only when the output is to a terminal. Defaults to false.
911 A boolean to enable/disable color in the output of
912 linkgit:git-status[1]. May be set to `always`,
913 `false` (or `never`) or `auto` (or `true`), in which case colors are used
914 only when the output is to a terminal. Defaults to false.
916 color.status.<slot>::
917 Use customized color for status colorization. `<slot>` is
918 one of `header` (the header text of the status message),
919 `added` or `updated` (files which are added but not committed),
920 `changed` (files which are changed but not added in the index),
921 `untracked` (files which are not tracked by Git),
922 `branch` (the current branch), or
923 `nobranch` (the color the 'no branch' warning is shown in, defaulting
924 to red). The values of these variables may be specified as in
928 This variable determines the default value for variables such
929 as `color.diff` and `color.grep` that control the use of color
930 per command family. Its scope will expand as more commands learn
931 configuration to set a default for the `--color` option. Set it
932 to `false` or `never` if you prefer Git commands not to use
933 color unless enabled explicitly with some other configuration
934 or the `--color` option. Set it to `always` if you want all
935 output not intended for machine consumption to use color, to
936 `true` or `auto` (this is the default since Git 1.8.4) if you
937 want such output to use color when written to the terminal.
940 Specify whether supported commands should output in columns.
941 This variable consists of a list of tokens separated by spaces
944 These options control when the feature should be enabled
945 (defaults to 'never'):
949 always show in columns
951 never show in columns
953 show in columns if the output is to the terminal
956 These options control layout (defaults to 'column'). Setting any
957 of these implies 'always' if none of 'always', 'never', or 'auto' are
962 fill columns before rows
964 fill rows before columns
969 Finally, these options can be combined with a layout option (defaults
974 make unequal size columns to utilize more space
976 make equal size columns
980 Specify whether to output branch listing in `git branch` in columns.
981 See `column.ui` for details.
984 Specify the layout when list items in `git clean -i`, which always
985 shows files and directories in columns. See `column.ui` for details.
988 Specify whether to output untracked files in `git status` in columns.
989 See `column.ui` for details.
992 Specify whether to output tag listing in `git tag` in columns.
993 See `column.ui` for details.
996 This setting overrides the default of the `--cleanup` option in
997 `git commit`. See linkgit:git-commit[1] for details. Changing the
998 default can be useful when you always want to keep lines that begin
999 with comment character `#` in your log message, in which case you
1000 would do `git config commit.cleanup whitespace` (note that you will
1001 have to remove the help lines that begin with `#` in the commit log
1002 template yourself, if you do this).
1006 A boolean to specify whether all commits should be GPG signed.
1007 Use of this option when doing operations such as rebase can
1008 result in a large number of commits being signed. It may be
1009 convenient to use an agent to avoid typing your GPG passphrase
1013 A boolean to enable/disable inclusion of status information in the
1014 commit message template when using an editor to prepare the commit
1015 message. Defaults to true.
1018 Specify a file to use as the template for new commit messages.
1019 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1020 specified user's home directory.
1023 Specify an external helper to be called when a username or
1024 password credential is needed; the helper may consult external
1025 storage to avoid prompting the user for the credentials. See
1026 linkgit:gitcredentials[7] for details.
1028 credential.useHttpPath::
1029 When acquiring credentials, consider the "path" component of an http
1030 or https URL to be important. Defaults to false. See
1031 linkgit:gitcredentials[7] for more information.
1033 credential.username::
1034 If no username is set for a network authentication, use this username
1035 by default. See credential.<context>.* below, and
1036 linkgit:gitcredentials[7].
1038 credential.<url>.*::
1039 Any of the credential.* options above can be applied selectively to
1040 some credentials. For example "credential.https://example.com.username"
1041 would set the default username only for https connections to
1042 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1045 include::diff-config.txt[]
1047 difftool.<tool>.path::
1048 Override the path for the given tool. This is useful in case
1049 your tool is not in the PATH.
1051 difftool.<tool>.cmd::
1052 Specify the command to invoke the specified diff tool.
1053 The specified command is evaluated in shell with the following
1054 variables available: 'LOCAL' is set to the name of the temporary
1055 file containing the contents of the diff pre-image and 'REMOTE'
1056 is set to the name of the temporary file containing the contents
1057 of the diff post-image.
1060 Prompt before each invocation of the diff tool.
1062 fetch.recurseSubmodules::
1063 This option can be either set to a boolean value or to 'on-demand'.
1064 Setting it to a boolean changes the behavior of fetch and pull to
1065 unconditionally recurse into submodules when set to true or to not
1066 recurse at all when set to false. When set to 'on-demand' (the default
1067 value), fetch and pull will only recurse into a populated submodule
1068 when its superproject retrieves a commit that updates the submodule's
1072 If it is set to true, git-fetch-pack will check all fetched
1073 objects. It will abort in the case of a malformed object or a
1074 broken link. The result of an abort are only dangling objects.
1075 Defaults to false. If not set, the value of `transfer.fsckObjects`
1079 If the number of objects fetched over the Git native
1080 transfer is below this
1081 limit, then the objects will be unpacked into loose object
1082 files. However if the number of received objects equals or
1083 exceeds this limit then the received pack will be stored as
1084 a pack, after adding any missing delta bases. Storing the
1085 pack from a push can make the push operation complete faster,
1086 especially on slow filesystems. If not set, the value of
1087 `transfer.unpackLimit` is used instead.
1090 If true, fetch will automatically behave as if the `--prune`
1091 option was given on the command line. See also `remote.<name>.prune`.
1094 Enable multipart/mixed attachments as the default for
1095 'format-patch'. The value can also be a double quoted string
1096 which will enable attachments as the default and set the
1097 value as the boundary. See the --attach option in
1098 linkgit:git-format-patch[1].
1101 A boolean which can enable or disable sequence numbers in patch
1102 subjects. It defaults to "auto" which enables it only if there
1103 is more than one patch. It can be enabled or disabled for all
1104 messages by setting it to "true" or "false". See --numbered
1105 option in linkgit:git-format-patch[1].
1108 Additional email headers to include in a patch to be submitted
1109 by mail. See linkgit:git-format-patch[1].
1113 Additional recipients to include in a patch to be submitted
1114 by mail. See the --to and --cc options in
1115 linkgit:git-format-patch[1].
1117 format.subjectprefix::
1118 The default for format-patch is to output files with the '[PATCH]'
1119 subject prefix. Use this variable to change that prefix.
1122 The default for format-patch is to output a signature containing
1123 the Git version number. Use this variable to change that default.
1124 Set this variable to the empty string ("") to suppress
1125 signature generation.
1127 format.signaturefile::
1128 Works just like format.signature except the contents of the
1129 file specified by this variable will be used as the signature.
1132 The default for format-patch is to output files with the suffix
1133 `.patch`. Use this variable to change that suffix (make sure to
1134 include the dot if you want it).
1137 The default pretty format for log/show/whatchanged command,
1138 See linkgit:git-log[1], linkgit:git-show[1],
1139 linkgit:git-whatchanged[1].
1142 The default threading style for 'git format-patch'. Can be
1143 a boolean value, or `shallow` or `deep`. `shallow` threading
1144 makes every mail a reply to the head of the series,
1145 where the head is chosen from the cover letter, the
1146 `--in-reply-to`, and the first patch mail, in this order.
1147 `deep` threading makes every mail a reply to the previous one.
1148 A true boolean value is the same as `shallow`, and a false
1149 value disables threading.
1152 A boolean value which lets you enable the `-s/--signoff` option of
1153 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1154 patch should be a conscious act and means that you certify you have
1155 the rights to submit this work under the same open source license.
1156 Please see the 'SubmittingPatches' document for further discussion.
1158 format.coverLetter::
1159 A boolean that controls whether to generate a cover-letter when
1160 format-patch is invoked, but in addition can be set to "auto", to
1161 generate a cover-letter only when there's more than one patch.
1163 filter.<driver>.clean::
1164 The command which is used to convert the content of a worktree
1165 file to a blob upon checkin. See linkgit:gitattributes[5] for
1168 filter.<driver>.smudge::
1169 The command which is used to convert the content of a blob
1170 object to a worktree file upon checkout. See
1171 linkgit:gitattributes[5] for details.
1173 gc.aggressiveDepth::
1174 The depth parameter used in the delta compression
1175 algorithm used by 'git gc --aggressive'. This defaults
1178 gc.aggressiveWindow::
1179 The window size parameter used in the delta compression
1180 algorithm used by 'git gc --aggressive'. This defaults
1184 When there are approximately more than this many loose
1185 objects in the repository, `git gc --auto` will pack them.
1186 Some Porcelain commands use this command to perform a
1187 light-weight garbage collection from time to time. The
1188 default value is 6700. Setting this to 0 disables it.
1191 When there are more than this many packs that are not
1192 marked with `*.keep` file in the repository, `git gc
1193 --auto` consolidates them into one larger pack. The
1194 default value is 50. Setting this to 0 disables it.
1197 Make `git gc --auto` return immediately andrun in background
1198 if the system supports it. Default is true.
1201 Running `git pack-refs` in a repository renders it
1202 unclonable by Git versions prior to 1.5.1.2 over dumb
1203 transports such as HTTP. This variable determines whether
1204 'git gc' runs `git pack-refs`. This can be set to `notbare`
1205 to enable it within all non-bare repos or it can be set to a
1206 boolean value. The default is `true`.
1209 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1210 Override the grace period with this config variable. The value
1211 "now" may be used to disable this grace period and always prune
1212 unreachable objects immediately.
1214 gc.prunereposexpire::
1215 When 'git gc' is run, it will call
1216 'prune --repos --expire 3.months.ago'.
1217 Override the grace period with this config variable. The value
1218 "now" may be used to disable the grace period and prune
1219 $GIT_DIR/repos immediately.
1222 gc.<pattern>.reflogexpire::
1223 'git reflog expire' removes reflog entries older than
1224 this time; defaults to 90 days. With "<pattern>" (e.g.
1225 "refs/stash") in the middle the setting applies only to
1226 the refs that match the <pattern>.
1228 gc.reflogexpireunreachable::
1229 gc.<ref>.reflogexpireunreachable::
1230 'git reflog expire' removes reflog entries older than
1231 this time and are not reachable from the current tip;
1232 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1233 in the middle, the setting applies only to the refs that
1234 match the <pattern>.
1237 Records of conflicted merge you resolved earlier are
1238 kept for this many days when 'git rerere gc' is run.
1239 The default is 60 days. See linkgit:git-rerere[1].
1241 gc.rerereunresolved::
1242 Records of conflicted merge you have not resolved are
1243 kept for this many days when 'git rerere gc' is run.
1244 The default is 15 days. See linkgit:git-rerere[1].
1246 gitcvs.commitmsgannotation::
1247 Append this string to each commit message. Set to empty string
1248 to disable this feature. Defaults to "via git-CVS emulator".
1251 Whether the CVS server interface is enabled for this repository.
1252 See linkgit:git-cvsserver[1].
1255 Path to a log file where the CVS server interface well... logs
1256 various stuff. See linkgit:git-cvsserver[1].
1258 gitcvs.usecrlfattr::
1259 If true, the server will look up the end-of-line conversion
1260 attributes for files to determine the '-k' modes to use. If
1261 the attributes force Git to treat a file as text,
1262 the '-k' mode will be left blank so CVS clients will
1263 treat it as text. If they suppress text conversion, the file
1264 will be set with '-kb' mode, which suppresses any newline munging
1265 the client might otherwise do. If the attributes do not allow
1266 the file type to be determined, then 'gitcvs.allbinary' is
1267 used. See linkgit:gitattributes[5].
1270 This is used if 'gitcvs.usecrlfattr' does not resolve
1271 the correct '-kb' mode to use. If true, all
1272 unresolved files are sent to the client in
1273 mode '-kb'. This causes the client to treat them
1274 as binary files, which suppresses any newline munging it
1275 otherwise might do. Alternatively, if it is set to "guess",
1276 then the contents of the file are examined to decide if
1277 it is binary, similar to 'core.autocrlf'.
1280 Database used by git-cvsserver to cache revision information
1281 derived from the Git repository. The exact meaning depends on the
1282 used database driver, for SQLite (which is the default driver) this
1283 is a filename. Supports variable substitution (see
1284 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1285 Default: '%Ggitcvs.%m.sqlite'
1288 Used Perl DBI driver. You can specify any available driver
1289 for this here, but it might not work. git-cvsserver is tested
1290 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1291 reported *not* to work with 'DBD::mysql'. Experimental feature.
1292 May not contain double colons (`:`). Default: 'SQLite'.
1293 See linkgit:git-cvsserver[1].
1295 gitcvs.dbuser, gitcvs.dbpass::
1296 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1297 since SQLite has no concept of database users and/or passwords.
1298 'gitcvs.dbuser' supports variable substitution (see
1299 linkgit:git-cvsserver[1] for details).
1301 gitcvs.dbTableNamePrefix::
1302 Database table name prefix. Prepended to the names of any
1303 database tables used, allowing a single database to be used
1304 for several repositories. Supports variable substitution (see
1305 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1306 characters will be replaced with underscores.
1308 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1309 'gitcvs.allbinary' can also be specified as
1310 'gitcvs.<access_method>.<varname>' (where 'access_method'
1311 is one of "ext" and "pserver") to make them apply only for the given
1315 gitweb.description::
1318 See linkgit:gitweb[1] for description.
1326 gitweb.remote_heads::
1329 See linkgit:gitweb.conf[5] for description.
1332 If set to true, enable '-n' option by default.
1335 Set the default matching behavior. Using a value of 'basic', 'extended',
1336 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1337 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1338 value 'default' will return to the default matching behavior.
1340 grep.extendedRegexp::
1341 If set to true, enable '--extended-regexp' option by default. This
1342 option is ignored when the 'grep.patternType' option is set to a value
1343 other than 'default'.
1346 Use this custom program instead of "gpg" found on $PATH when
1347 making or verifying a PGP signature. The program must support the
1348 same command-line interface as GPG, namely, to verify a detached
1349 signature, "gpg --verify $file - <$signature" is run, and the
1350 program is expected to signal a good signature by exiting with
1351 code 0, and to generate an ascii-armored detached signature, the
1352 standard input of "gpg -bsau $key" is fed with the contents to be
1353 signed, and the program is expected to send the result to its
1356 gui.commitmsgwidth::
1357 Defines how wide the commit message window is in the
1358 linkgit:git-gui[1]. "75" is the default.
1361 Specifies how many context lines should be used in calls to diff
1362 made by the linkgit:git-gui[1]. The default is "5".
1364 gui.displayuntracked::
1365 Determines if linkgit::git-gui[1] shows untracked files
1366 in the file list. The default is "true".
1369 Specifies the default encoding to use for displaying of
1370 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1371 It can be overridden by setting the 'encoding' attribute
1372 for relevant files (see linkgit:gitattributes[5]).
1373 If this option is not set, the tools default to the
1376 gui.matchtrackingbranch::
1377 Determines if new branches created with linkgit:git-gui[1] should
1378 default to tracking remote branches with matching names or
1379 not. Default: "false".
1381 gui.newbranchtemplate::
1382 Is used as suggested name when creating new branches using the
1385 gui.pruneduringfetch::
1386 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1387 performing a fetch. The default value is "false".
1390 Determines if linkgit:git-gui[1] should trust the file modification
1391 timestamp or not. By default the timestamps are not trusted.
1393 gui.spellingdictionary::
1394 Specifies the dictionary used for spell checking commit messages in
1395 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1399 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1400 location detection. It makes blame significantly faster on huge
1401 repositories at the expense of less thorough copy detection.
1403 gui.copyblamethreshold::
1404 Specifies the threshold to use in 'git gui blame' original location
1405 detection, measured in alphanumeric characters. See the
1406 linkgit:git-blame[1] manual for more information on copy detection.
1408 gui.blamehistoryctx::
1409 Specifies the radius of history context in days to show in
1410 linkgit:gitk[1] for the selected commit, when the `Show History
1411 Context` menu item is invoked from 'git gui blame'. If this
1412 variable is set to zero, the whole history is shown.
1414 guitool.<name>.cmd::
1415 Specifies the shell command line to execute when the corresponding item
1416 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1417 mandatory for every tool. The command is executed from the root of
1418 the working directory, and in the environment it receives the name of
1419 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1420 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1421 the head is detached, 'CUR_BRANCH' is empty).
1423 guitool.<name>.needsfile::
1424 Run the tool only if a diff is selected in the GUI. It guarantees
1425 that 'FILENAME' is not empty.
1427 guitool.<name>.noconsole::
1428 Run the command silently, without creating a window to display its
1431 guitool.<name>.norescan::
1432 Don't rescan the working directory for changes after the tool
1435 guitool.<name>.confirm::
1436 Show a confirmation dialog before actually running the tool.
1438 guitool.<name>.argprompt::
1439 Request a string argument from the user, and pass it to the tool
1440 through the 'ARGS' environment variable. Since requesting an
1441 argument implies confirmation, the 'confirm' option has no effect
1442 if this is enabled. If the option is set to 'true', 'yes', or '1',
1443 the dialog uses a built-in generic prompt; otherwise the exact
1444 value of the variable is used.
1446 guitool.<name>.revprompt::
1447 Request a single valid revision from the user, and set the
1448 'REVISION' environment variable. In other aspects this option
1449 is similar to 'argprompt', and can be used together with it.
1451 guitool.<name>.revunmerged::
1452 Show only unmerged branches in the 'revprompt' subdialog.
1453 This is useful for tools similar to merge or rebase, but not
1454 for things like checkout or reset.
1456 guitool.<name>.title::
1457 Specifies the title to use for the prompt dialog. The default
1460 guitool.<name>.prompt::
1461 Specifies the general prompt string to display at the top of
1462 the dialog, before subsections for 'argprompt' and 'revprompt'.
1463 The default value includes the actual command.
1466 Specify the browser that will be used to display help in the
1467 'web' format. See linkgit:git-help[1].
1470 Override the default help format used by linkgit:git-help[1].
1471 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1472 the default. 'web' and 'html' are the same.
1475 Automatically correct and execute mistyped commands after
1476 waiting for the given number of deciseconds (0.1 sec). If more
1477 than one command can be deduced from the entered text, nothing
1478 will be executed. If the value of this option is negative,
1479 the corrected command will be executed immediately. If the
1480 value is 0 - the command will be just shown but not executed.
1481 This is the default.
1484 Specify the path where the HTML documentation resides. File system paths
1485 and URLs are supported. HTML pages will be prefixed with this path when
1486 help is displayed in the 'web' format. This defaults to the documentation
1487 path of your Git installation.
1490 Override the HTTP proxy, normally configured using the 'http_proxy',
1491 'https_proxy', and 'all_proxy' environment variables (see
1492 `curl(1)`). This can be overridden on a per-remote basis; see
1496 File containing previously stored cookie lines which should be used
1497 in the Git http session, if they match the server. The file format
1498 of the file to read cookies from should be plain HTTP headers or
1499 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1500 NOTE that the file specified with http.cookiefile is only used as
1501 input unless http.saveCookies is set.
1504 If set, store cookies received during requests to the file specified by
1505 http.cookiefile. Has no effect if http.cookiefile is unset.
1508 Whether to verify the SSL certificate when fetching or pushing
1509 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1513 File containing the SSL certificate when fetching or pushing
1514 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1518 File containing the SSL private key when fetching or pushing
1519 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1522 http.sslCertPasswordProtected::
1523 Enable Git's password prompt for the SSL certificate. Otherwise
1524 OpenSSL will prompt the user, possibly many times, if the
1525 certificate or private key is encrypted. Can be overridden by the
1526 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1529 File containing the certificates to verify the peer with when
1530 fetching or pushing over HTTPS. Can be overridden by the
1531 'GIT_SSL_CAINFO' environment variable.
1534 Path containing files with the CA certificates to verify the peer
1535 with when fetching or pushing over HTTPS. Can be overridden
1536 by the 'GIT_SSL_CAPATH' environment variable.
1539 Attempt to use AUTH SSL/TLS and encrypted data transfers
1540 when connecting via regular FTP protocol. This might be needed
1541 if the FTP server requires it for security reasons or you wish
1542 to connect securely whenever remote FTP server supports it.
1543 Default is false since it might trigger certificate verification
1544 errors on misconfigured servers.
1547 How many HTTP requests to launch in parallel. Can be overridden
1548 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1551 The number of curl sessions (counted across slots) to be kept across
1552 requests. They will not be ended with curl_easy_cleanup() until
1553 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1554 value will be capped at 1. Defaults to 1.
1557 Maximum size in bytes of the buffer used by smart HTTP
1558 transports when POSTing data to the remote system.
1559 For requests larger than this buffer size, HTTP/1.1 and
1560 Transfer-Encoding: chunked is used to avoid creating a
1561 massive pack file locally. Default is 1 MiB, which is
1562 sufficient for most requests.
1564 http.lowSpeedLimit, http.lowSpeedTime::
1565 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1566 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1567 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1568 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1571 A boolean which disables using of EPSV ftp command by curl.
1572 This can helpful with some "poor" ftp servers which don't
1573 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1574 environment variable. Default is false (curl will use EPSV).
1577 The HTTP USER_AGENT string presented to an HTTP server. The default
1578 value represents the version of the client Git such as git/1.7.1.
1579 This option allows you to override this value to a more common value
1580 such as Mozilla/4.0. This may be necessary, for instance, if
1581 connecting through a firewall that restricts HTTP connections to a set
1582 of common USER_AGENT strings (but not including those like git/1.7.1).
1583 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1586 Any of the http.* options above can be applied selectively to some urls.
1587 For a config key to match a URL, each element of the config key is
1588 compared to that of the URL, in the following order:
1591 . Scheme (e.g., `https` in `https://example.com/`). This field
1592 must match exactly between the config key and the URL.
1594 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1595 This field must match exactly between the config key and the URL.
1597 . Port number (e.g., `8080` in `http://example.com:8080/`).
1598 This field must match exactly between the config key and the URL.
1599 Omitted port numbers are automatically converted to the correct
1600 default for the scheme before matching.
1602 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1603 path field of the config key must match the path field of the URL
1604 either exactly or as a prefix of slash-delimited path elements. This means
1605 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1606 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1607 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1608 key with just path `foo/`).
1610 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1611 the config key has a user name it must match the user name in the
1612 URL exactly. If the config key does not have a user name, that
1613 config key will match a URL with any user name (including none),
1614 but at a lower precedence than a config key with a user name.
1617 The list above is ordered by decreasing precedence; a URL that matches
1618 a config key's path is preferred to one that matches its user name. For example,
1619 if the URL is `https://user@example.com/foo/bar` a config key match of
1620 `https://example.com/foo` will be preferred over a config key match of
1621 `https://user@example.com`.
1623 All URLs are normalized before attempting any matching (the password part,
1624 if embedded in the URL, is always ignored for matching purposes) so that
1625 equivalent urls that are simply spelled differently will match properly.
1626 Environment variable settings always override any matches. The urls that are
1627 matched against are those given directly to Git commands. This means any URLs
1628 visited as a result of a redirection do not participate in matching.
1630 i18n.commitEncoding::
1631 Character encoding the commit messages are stored in; Git itself
1632 does not care per se, but this information is necessary e.g. when
1633 importing commits from emails or in the gitk graphical history
1634 browser (and possibly at other places in the future or in other
1635 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1637 i18n.logOutputEncoding::
1638 Character encoding the commit messages are converted to when
1639 running 'git log' and friends.
1642 The configuration variables in the 'imap' section are described
1643 in linkgit:git-imap-send[1].
1646 Specify the version with which new index files should be
1647 initialized. This does not affect existing repositories.
1650 Specify the directory from which templates will be copied.
1651 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1654 Specify the program that will be used to browse your working
1655 repository in gitweb. See linkgit:git-instaweb[1].
1658 The HTTP daemon command-line to start gitweb on your working
1659 repository. See linkgit:git-instaweb[1].
1662 If true the web server started by linkgit:git-instaweb[1] will
1663 be bound to the local IP (127.0.0.1).
1665 instaweb.modulepath::
1666 The default module path for linkgit:git-instaweb[1] to use
1667 instead of /usr/lib/apache2/modules. Only used if httpd
1671 The port number to bind the gitweb httpd to. See
1672 linkgit:git-instaweb[1].
1674 interactive.singlekey::
1675 In interactive commands, allow the user to provide one-letter
1676 input with a single key (i.e., without hitting enter).
1677 Currently this is used by the `--patch` mode of
1678 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1679 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1680 setting is silently ignored if portable keystroke input
1681 is not available; requires the Perl module Term::ReadKey.
1684 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1685 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1686 override this option with `--no-abbrev-commit`.
1689 Set the default date-time mode for the 'log' command.
1690 Setting a value for log.date is similar to using 'git log''s
1691 `--date` option. Possible values are `relative`, `local`,
1692 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1696 Print out the ref names of any commits that are shown by the log
1697 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1698 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1699 specified, the full ref name (including prefix) will be printed.
1700 This is the same as the log commands '--decorate' option.
1703 If true, the initial commit will be shown as a big creation event.
1704 This is equivalent to a diff against an empty tree.
1705 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1706 normally hide the root commit will now show it. True by default.
1709 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1710 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1713 The location of an augmenting mailmap file. The default
1714 mailmap, located in the root of the repository, is loaded
1715 first, then the mailmap file pointed to by this variable.
1716 The location of the mailmap file may be in a repository
1717 subdirectory, or somewhere outside of the repository itself.
1718 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1721 Like `mailmap.file`, but consider the value as a reference to a
1722 blob in the repository. If both `mailmap.file` and
1723 `mailmap.blob` are given, both are parsed, with entries from
1724 `mailmap.file` taking precedence. In a bare repository, this
1725 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1729 Specify the programs that may be used to display help in the
1730 'man' format. See linkgit:git-help[1].
1733 Specify the command to invoke the specified man viewer. The
1734 specified command is evaluated in shell with the man page
1735 passed as argument. (See linkgit:git-help[1].)
1738 Override the path for the given tool that may be used to
1739 display help in the 'man' format. See linkgit:git-help[1].
1741 include::merge-config.txt[]
1743 mergetool.<tool>.path::
1744 Override the path for the given tool. This is useful in case
1745 your tool is not in the PATH.
1747 mergetool.<tool>.cmd::
1748 Specify the command to invoke the specified merge tool. The
1749 specified command is evaluated in shell with the following
1750 variables available: 'BASE' is the name of a temporary file
1751 containing the common base of the files to be merged, if available;
1752 'LOCAL' is the name of a temporary file containing the contents of
1753 the file on the current branch; 'REMOTE' is the name of a temporary
1754 file containing the contents of the file from the branch being
1755 merged; 'MERGED' contains the name of the file to which the merge
1756 tool should write the results of a successful merge.
1758 mergetool.<tool>.trustExitCode::
1759 For a custom merge command, specify whether the exit code of
1760 the merge command can be used to determine whether the merge was
1761 successful. If this is not set to true then the merge target file
1762 timestamp is checked and the merge assumed to have been successful
1763 if the file has been updated, otherwise the user is prompted to
1764 indicate the success of the merge.
1766 mergetool.keepBackup::
1767 After performing a merge, the original file with conflict markers
1768 can be saved as a file with a `.orig` extension. If this variable
1769 is set to `false` then this file is not preserved. Defaults to
1770 `true` (i.e. keep the backup files).
1772 mergetool.keepTemporaries::
1773 When invoking a custom merge tool, Git uses a set of temporary
1774 files to pass to the tool. If the tool returns an error and this
1775 variable is set to `true`, then these temporary files will be
1776 preserved, otherwise they will be removed after the tool has
1777 exited. Defaults to `false`.
1780 Prompt before each invocation of the merge resolution program.
1783 The (fully qualified) refname from which to show notes when
1784 showing commit messages. The value of this variable can be set
1785 to a glob, in which case notes from all matching refs will be
1786 shown. You may also specify this configuration variable
1787 several times. A warning will be issued for refs that do not
1788 exist, but a glob that does not match any refs is silently
1791 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1792 environment variable, which must be a colon separated list of refs or
1795 The effective value of "core.notesRef" (possibly overridden by
1796 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1799 notes.rewrite.<command>::
1800 When rewriting commits with <command> (currently `amend` or
1801 `rebase`) and this variable is set to `true`, Git
1802 automatically copies your notes from the original to the
1803 rewritten commit. Defaults to `true`, but see
1804 "notes.rewriteRef" below.
1807 When copying notes during a rewrite (see the
1808 "notes.rewrite.<command>" option), determines what to do if
1809 the target commit already has a note. Must be one of
1810 `overwrite`, `concatenate`, or `ignore`. Defaults to
1813 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1814 environment variable.
1817 When copying notes during a rewrite, specifies the (fully
1818 qualified) ref whose notes should be copied. The ref may be a
1819 glob, in which case notes in all matching refs will be copied.
1820 You may also specify this configuration several times.
1822 Does not have a default value; you must configure this variable to
1823 enable note rewriting. Set it to `refs/notes/commits` to enable
1824 rewriting for the default commit notes.
1826 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1827 environment variable, which must be a colon separated list of refs or
1831 The size of the window used by linkgit:git-pack-objects[1] when no
1832 window size is given on the command line. Defaults to 10.
1835 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1836 maximum depth is given on the command line. Defaults to 50.
1839 The window memory size limit used by linkgit:git-pack-objects[1]
1840 when no limit is given on the command line. The value can be
1841 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1845 An integer -1..9, indicating the compression level for objects
1846 in a pack file. -1 is the zlib default. 0 means no
1847 compression, and 1..9 are various speed/size tradeoffs, 9 being
1848 slowest. If not set, defaults to core.compression. If that is
1849 not set, defaults to -1, the zlib default, which is "a default
1850 compromise between speed and compression (currently equivalent
1853 Note that changing the compression level will not automatically recompress
1854 all existing objects. You can force recompression by passing the -F option
1855 to linkgit:git-repack[1].
1857 pack.deltaCacheSize::
1858 The maximum memory in bytes used for caching deltas in
1859 linkgit:git-pack-objects[1] before writing them out to a pack.
1860 This cache is used to speed up the writing object phase by not
1861 having to recompute the final delta result once the best match
1862 for all objects is found. Repacking large repositories on machines
1863 which are tight with memory might be badly impacted by this though,
1864 especially if this cache pushes the system into swapping.
1865 A value of 0 means no limit. The smallest size of 1 byte may be
1866 used to virtually disable this cache. Defaults to 256 MiB.
1868 pack.deltaCacheLimit::
1869 The maximum size of a delta, that is cached in
1870 linkgit:git-pack-objects[1]. This cache is used to speed up the
1871 writing object phase by not having to recompute the final delta
1872 result once the best match for all objects is found. Defaults to 1000.
1875 Specifies the number of threads to spawn when searching for best
1876 delta matches. This requires that linkgit:git-pack-objects[1]
1877 be compiled with pthreads otherwise this option is ignored with a
1878 warning. This is meant to reduce packing time on multiprocessor
1879 machines. The required amount of memory for the delta search window
1880 is however multiplied by the number of threads.
1881 Specifying 0 will cause Git to auto-detect the number of CPU's
1882 and set the number of threads accordingly.
1885 Specify the default pack index version. Valid values are 1 for
1886 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1887 the new pack index with capabilities for packs larger than 4 GB
1888 as well as proper protection against the repacking of corrupted
1889 packs. Version 2 is the default. Note that version 2 is enforced
1890 and this config option ignored whenever the corresponding pack is
1893 If you have an old Git that does not understand the version 2 `*.idx` file,
1894 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1895 that will copy both `*.pack` file and corresponding `*.idx` file from the
1896 other side may give you a repository that cannot be accessed with your
1897 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1898 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1901 pack.packSizeLimit::
1902 The maximum size of a pack. This setting only affects
1903 packing to a file when repacking, i.e. the git:// protocol
1904 is unaffected. It can be overridden by the `--max-pack-size`
1905 option of linkgit:git-repack[1]. The minimum size allowed is
1906 limited to 1 MiB. The default is unlimited.
1907 Common unit suffixes of 'k', 'm', or 'g' are
1911 When true, git will use pack bitmaps (if available) when packing
1912 to stdout (e.g., during the server side of a fetch). Defaults to
1913 true. You should not generally need to turn this off unless
1914 you are debugging pack bitmaps.
1917 This is a deprecated synonym for `repack.writeBitmaps`.
1919 pack.writeBitmapHashCache::
1920 When true, git will include a "hash cache" section in the bitmap
1921 index (if one is written). This cache can be used to feed git's
1922 delta heuristics, potentially leading to better deltas between
1923 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1924 between an older, bitmapped pack and objects that have been
1925 pushed since the last gc). The downside is that it consumes 4
1926 bytes per object of disk space, and that JGit's bitmap
1927 implementation does not understand it, causing it to complain if
1928 Git and JGit are used on the same repository. Defaults to false.
1931 If the value is boolean, turns on or off pagination of the
1932 output of a particular Git subcommand when writing to a tty.
1933 Otherwise, turns on pagination for the subcommand using the
1934 pager specified by the value of `pager.<cmd>`. If `--paginate`
1935 or `--no-pager` is specified on the command line, it takes
1936 precedence over this option. To disable pagination for all
1937 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1940 Alias for a --pretty= format string, as specified in
1941 linkgit:git-log[1]. Any aliases defined here can be used just
1942 as the built-in pretty formats could. For example,
1943 running `git config pretty.changelog "format:* %H %s"`
1944 would cause the invocation `git log --pretty=changelog`
1945 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1946 Note that an alias with the same name as a built-in format
1947 will be silently ignored.
1950 By default, Git does not create an extra merge commit when merging
1951 a commit that is a descendant of the current commit. Instead, the
1952 tip of the current branch is fast-forwarded. When set to `false`,
1953 this variable tells Git to create an extra merge commit in such
1954 a case (equivalent to giving the `--no-ff` option from the command
1955 line). When set to `only`, only such fast-forward merges are
1956 allowed (equivalent to giving the `--ff-only` option from the
1960 When true, rebase branches on top of the fetched branch, instead
1961 of merging the default branch from the default remote when "git
1962 pull" is run. See "branch.<name>.rebase" for setting this on a
1965 When preserve, also pass `--preserve-merges` along to 'git rebase'
1966 so that locally committed merge commits will not be flattened
1967 by running 'git pull'.
1969 *NOTE*: this is a possibly dangerous operation; do *not* use
1970 it unless you understand the implications (see linkgit:git-rebase[1]
1974 The default merge strategy to use when pulling multiple branches
1978 The default merge strategy to use when pulling a single branch.
1981 Defines the action `git push` should take if no refspec is
1982 explicitly given. Different values are well-suited for
1983 specific workflows; for instance, in a purely central workflow
1984 (i.e. the fetch source is equal to the push destination),
1985 `upstream` is probably what you want. Possible values are:
1989 * `nothing` - do not push anything (error out) unless a refspec is
1990 explicitly given. This is primarily meant for people who want to
1991 avoid mistakes by always being explicit.
1993 * `current` - push the current branch to update a branch with the same
1994 name on the receiving end. Works in both central and non-central
1997 * `upstream` - push the current branch back to the branch whose
1998 changes are usually integrated into the current branch (which is
1999 called `@{upstream}`). This mode only makes sense if you are
2000 pushing to the same repository you would normally pull from
2001 (i.e. central workflow).
2003 * `simple` - in centralized workflow, work like `upstream` with an
2004 added safety to refuse to push if the upstream branch's name is
2005 different from the local one.
2007 When pushing to a remote that is different from the remote you normally
2008 pull from, work as `current`. This is the safest option and is suited
2011 This mode has become the default in Git 2.0.
2013 * `matching` - push all branches having the same name on both ends.
2014 This makes the repository you are pushing to remember the set of
2015 branches that will be pushed out (e.g. if you always push 'maint'
2016 and 'master' there and no other branches, the repository you push
2017 to will have these two branches, and your local 'maint' and
2018 'master' will be pushed there).
2020 To use this mode effectively, you have to make sure _all_ the
2021 branches you would push out are ready to be pushed out before
2022 running 'git push', as the whole point of this mode is to allow you
2023 to push all of the branches in one go. If you usually finish work
2024 on only one branch and push out the result, while other branches are
2025 unfinished, this mode is not for you. Also this mode is not
2026 suitable for pushing into a shared central repository, as other
2027 people may add new branches there, or update the tip of existing
2028 branches outside your control.
2030 This used to be the default, but not since Git 2.0 (`simple` is the
2036 Whether to show a diffstat of what changed upstream since the last
2037 rebase. False by default.
2040 If set to true enable '--autosquash' option by default.
2043 When set to true, automatically create a temporary stash
2044 before the operation begins, and apply it after the operation
2045 ends. This means that you can run rebase on a dirty worktree.
2046 However, use with care: the final stash application after a
2047 successful rebase might result in non-trivial conflicts.
2051 By default, git-receive-pack will run "git-gc --auto" after
2052 receiving data from git-push and updating refs. You can stop
2053 it by setting this variable to false.
2055 receive.fsckObjects::
2056 If it is set to true, git-receive-pack will check all received
2057 objects. It will abort in the case of a malformed object or a
2058 broken link. The result of an abort are only dangling objects.
2059 Defaults to false. If not set, the value of `transfer.fsckObjects`
2062 receive.unpackLimit::
2063 If the number of objects received in a push is below this
2064 limit then the objects will be unpacked into loose object
2065 files. However if the number of received objects equals or
2066 exceeds this limit then the received pack will be stored as
2067 a pack, after adding any missing delta bases. Storing the
2068 pack from a push can make the push operation complete faster,
2069 especially on slow filesystems. If not set, the value of
2070 `transfer.unpackLimit` is used instead.
2072 receive.denyDeletes::
2073 If set to true, git-receive-pack will deny a ref update that deletes
2074 the ref. Use this to prevent such a ref deletion via a push.
2076 receive.denyDeleteCurrent::
2077 If set to true, git-receive-pack will deny a ref update that
2078 deletes the currently checked out branch of a non-bare repository.
2080 receive.denyCurrentBranch::
2081 If set to true or "refuse", git-receive-pack will deny a ref update
2082 to the currently checked out branch of a non-bare repository.
2083 Such a push is potentially dangerous because it brings the HEAD
2084 out of sync with the index and working tree. If set to "warn",
2085 print a warning of such a push to stderr, but allow the push to
2086 proceed. If set to false or "ignore", allow such pushes with no
2087 message. Defaults to "refuse".
2089 receive.denyNonFastForwards::
2090 If set to true, git-receive-pack will deny a ref update which is
2091 not a fast-forward. Use this to prevent such an update via a push,
2092 even if that push is forced. This configuration variable is
2093 set when initializing a shared repository.
2096 String(s) `receive-pack` uses to decide which refs to omit
2097 from its initial advertisement. Use more than one
2098 definitions to specify multiple prefix strings. A ref that
2099 are under the hierarchies listed on the value of this
2100 variable is excluded, and is hidden when responding to `git
2101 push`, and an attempt to update or delete a hidden ref by
2102 `git push` is rejected.
2104 receive.updateserverinfo::
2105 If set to true, git-receive-pack will run git-update-server-info
2106 after receiving data from git-push and updating refs.
2108 receive.shallowupdate::
2109 If set to true, .git/shallow can be updated when new refs
2110 require new shallow roots. Otherwise those refs are rejected.
2112 remote.pushdefault::
2113 The remote to push to by default. Overrides
2114 `branch.<name>.remote` for all branches, and is overridden by
2115 `branch.<name>.pushremote` for specific branches.
2118 The URL of a remote repository. See linkgit:git-fetch[1] or
2119 linkgit:git-push[1].
2121 remote.<name>.pushurl::
2122 The push URL of a remote repository. See linkgit:git-push[1].
2124 remote.<name>.proxy::
2125 For remotes that require curl (http, https and ftp), the URL to
2126 the proxy to use for that remote. Set to the empty string to
2127 disable proxying for that remote.
2129 remote.<name>.fetch::
2130 The default set of "refspec" for linkgit:git-fetch[1]. See
2131 linkgit:git-fetch[1].
2133 remote.<name>.push::
2134 The default set of "refspec" for linkgit:git-push[1]. See
2135 linkgit:git-push[1].
2137 remote.<name>.mirror::
2138 If true, pushing to this remote will automatically behave
2139 as if the `--mirror` option was given on the command line.
2141 remote.<name>.skipDefaultUpdate::
2142 If true, this remote will be skipped by default when updating
2143 using linkgit:git-fetch[1] or the `update` subcommand of
2144 linkgit:git-remote[1].
2146 remote.<name>.skipFetchAll::
2147 If true, this remote will be skipped by default when updating
2148 using linkgit:git-fetch[1] or the `update` subcommand of
2149 linkgit:git-remote[1].
2151 remote.<name>.receivepack::
2152 The default program to execute on the remote side when pushing. See
2153 option \--receive-pack of linkgit:git-push[1].
2155 remote.<name>.uploadpack::
2156 The default program to execute on the remote side when fetching. See
2157 option \--upload-pack of linkgit:git-fetch-pack[1].
2159 remote.<name>.tagopt::
2160 Setting this value to \--no-tags disables automatic tag following when
2161 fetching from remote <name>. Setting it to \--tags will fetch every
2162 tag from remote <name>, even if they are not reachable from remote
2163 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2164 override this setting. See options \--tags and \--no-tags of
2165 linkgit:git-fetch[1].
2168 Setting this to a value <vcs> will cause Git to interact with
2169 the remote with the git-remote-<vcs> helper.
2171 remote.<name>.prune::
2172 When set to true, fetching from this remote by default will also
2173 remove any remote-tracking references that no longer exist on the
2174 remote (as if the `--prune` option was given on the command line).
2175 Overrides `fetch.prune` settings, if any.
2178 The list of remotes which are fetched by "git remote update
2179 <group>". See linkgit:git-remote[1].
2181 repack.usedeltabaseoffset::
2182 By default, linkgit:git-repack[1] creates packs that use
2183 delta-base offset. If you need to share your repository with
2184 Git older than version 1.4.4, either directly or via a dumb
2185 protocol such as http, then you need to set this option to
2186 "false" and repack. Access from old Git versions over the
2187 native protocol are unaffected by this option.
2189 repack.packKeptObjects::
2190 If set to true, makes `git repack` act as if
2191 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2192 details. Defaults to `false` normally, but `true` if a bitmap
2193 index is being written (either via `--write-bitmap-index` or
2194 `repack.writeBitmaps`).
2196 repack.writeBitmaps::
2197 When true, git will write a bitmap index when packing all
2198 objects to disk (e.g., when `git repack -a` is run). This
2199 index can speed up the "counting objects" phase of subsequent
2200 packs created for clones and fetches, at the cost of some disk
2201 space and extra time spent on the initial repack. Defaults to
2205 When set to true, `git-rerere` updates the index with the
2206 resulting contents after it cleanly resolves conflicts using
2207 previously recorded resolution. Defaults to false.
2210 Activate recording of resolved conflicts, so that identical
2211 conflict hunks can be resolved automatically, should they be
2212 encountered again. By default, linkgit:git-rerere[1] is
2213 enabled if there is an `rr-cache` directory under the
2214 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2217 sendemail.identity::
2218 A configuration identity. When given, causes values in the
2219 'sendemail.<identity>' subsection to take precedence over
2220 values in the 'sendemail' section. The default identity is
2221 the value of 'sendemail.identity'.
2223 sendemail.smtpencryption::
2224 See linkgit:git-send-email[1] for description. Note that this
2225 setting is not subject to the 'identity' mechanism.
2228 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2230 sendemail.smtpsslcertpath::
2231 Path to ca-certificates (either a directory or a single file).
2232 Set it to an empty string to disable certificate verification.
2234 sendemail.<identity>.*::
2235 Identity-specific versions of the 'sendemail.*' parameters
2236 found below, taking precedence over those when the this
2237 identity is selected, through command-line or
2238 'sendemail.identity'.
2240 sendemail.aliasesfile::
2241 sendemail.aliasfiletype::
2242 sendemail.annotate::
2246 sendemail.chainreplyto::
2248 sendemail.envelopesender::
2250 sendemail.multiedit::
2251 sendemail.signedoffbycc::
2252 sendemail.smtppass::
2253 sendemail.suppresscc::
2254 sendemail.suppressfrom::
2256 sendemail.smtpdomain::
2257 sendemail.smtpserver::
2258 sendemail.smtpserverport::
2259 sendemail.smtpserveroption::
2260 sendemail.smtpuser::
2262 sendemail.validate::
2263 See linkgit:git-send-email[1] for description.
2265 sendemail.signedoffcc::
2266 Deprecated alias for 'sendemail.signedoffbycc'.
2268 showbranch.default::
2269 The default set of branches for linkgit:git-show-branch[1].
2270 See linkgit:git-show-branch[1].
2272 status.relativePaths::
2273 By default, linkgit:git-status[1] shows paths relative to the
2274 current directory. Setting this variable to `false` shows paths
2275 relative to the repository root (this was the default for Git
2279 Set to true to enable --short by default in linkgit:git-status[1].
2280 The option --no-short takes precedence over this variable.
2283 Set to true to enable --branch by default in linkgit:git-status[1].
2284 The option --no-branch takes precedence over this variable.
2286 status.displayCommentPrefix::
2287 If set to true, linkgit:git-status[1] will insert a comment
2288 prefix before each output line (starting with
2289 `core.commentChar`, i.e. `#` by default). This was the
2290 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2293 status.showUntrackedFiles::
2294 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2295 files which are not currently tracked by Git. Directories which
2296 contain only untracked files, are shown with the directory name
2297 only. Showing untracked files means that Git needs to lstat() all
2298 all the files in the whole repository, which might be slow on some
2299 systems. So, this variable controls how the commands displays
2300 the untracked files. Possible values are:
2303 * `no` - Show no untracked files.
2304 * `normal` - Show untracked files and directories.
2305 * `all` - Show also individual files in untracked directories.
2308 If this variable is not specified, it defaults to 'normal'.
2309 This variable can be overridden with the -u|--untracked-files option
2310 of linkgit:git-status[1] and linkgit:git-commit[1].
2312 status.submodulesummary::
2314 If this is set to a non zero number or true (identical to -1 or an
2315 unlimited number), the submodule summary will be enabled and a
2316 summary of commits for modified submodules will be shown (see
2317 --summary-limit option of linkgit:git-submodule[1]). Please note
2318 that the summary output command will be suppressed for all
2319 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2320 for those submodules where `submodule.<name>.ignore=all`. The only
2321 exception to that rule is that status and commit will show staged
2322 submodule changes. To
2323 also view the summary for ignored submodules you can either use
2324 the --ignore-submodules=dirty command-line option or the 'git
2325 submodule summary' command, which shows a similar output but does
2326 not honor these settings.
2328 submodule.<name>.path::
2329 submodule.<name>.url::
2330 submodule.<name>.update::
2331 The path within this project, URL, and the updating strategy
2332 for a submodule. These variables are initially populated
2333 by 'git submodule init'; edit them to override the
2334 URL and other values found in the `.gitmodules` file. See
2335 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2337 submodule.<name>.branch::
2338 The remote branch name for a submodule, used by `git submodule
2339 update --remote`. Set this option to override the value found in
2340 the `.gitmodules` file. See linkgit:git-submodule[1] and
2341 linkgit:gitmodules[5] for details.
2343 submodule.<name>.fetchRecurseSubmodules::
2344 This option can be used to control recursive fetching of this
2345 submodule. It can be overridden by using the --[no-]recurse-submodules
2346 command-line option to "git fetch" and "git pull".
2347 This setting will override that from in the linkgit:gitmodules[5]
2350 submodule.<name>.ignore::
2351 Defines under what circumstances "git status" and the diff family show
2352 a submodule as modified. When set to "all", it will never be considered
2353 modified (but it will nonetheless show up in the output of status and
2354 commit when it has been staged), "dirty" will ignore all changes
2355 to the submodules work tree and
2356 takes only differences between the HEAD of the submodule and the commit
2357 recorded in the superproject into account. "untracked" will additionally
2358 let submodules with modified tracked files in their work tree show up.
2359 Using "none" (the default when this option is not set) also shows
2360 submodules that have untracked files in their work tree as changed.
2361 This setting overrides any setting made in .gitmodules for this submodule,
2362 both settings can be overridden on the command line by using the
2363 "--ignore-submodules" option. The 'git submodule' commands are not
2364 affected by this setting.
2367 This variable controls the sort ordering of tags when displayed by
2368 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2369 value of this variable will be used as the default.
2372 This variable can be used to restrict the permission bits of
2373 tar archive entries. The default is 0002, which turns off the
2374 world write bit. The special value "user" indicates that the
2375 archiving user's umask will be used instead. See umask(2) and
2376 linkgit:git-archive[1].
2378 transfer.fsckObjects::
2379 When `fetch.fsckObjects` or `receive.fsckObjects` are
2380 not set, the value of this variable is used instead.
2384 This variable can be used to set both `receive.hiderefs`
2385 and `uploadpack.hiderefs` at the same time to the same
2386 values. See entries for these other variables.
2388 transfer.unpackLimit::
2389 When `fetch.unpackLimit` or `receive.unpackLimit` are
2390 not set, the value of this variable is used instead.
2391 The default value is 100.
2393 uploadarchive.allowUnreachable::
2394 If true, allow clients to use `git archive --remote` to request
2395 any tree, whether reachable from the ref tips or not. See the
2396 discussion in the `SECURITY` section of
2397 linkgit:git-upload-archive[1] for more details. Defaults to
2400 uploadpack.hiderefs::
2401 String(s) `upload-pack` uses to decide which refs to omit
2402 from its initial advertisement. Use more than one
2403 definitions to specify multiple prefix strings. A ref that
2404 are under the hierarchies listed on the value of this
2405 variable is excluded, and is hidden from `git ls-remote`,
2406 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2407 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2409 uploadpack.allowtipsha1inwant::
2410 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2411 to accept a fetch request that asks for an object at the tip
2412 of a hidden ref (by default, such a request is rejected).
2413 see also `uploadpack.hiderefs`.
2415 uploadpack.keepalive::
2416 When `upload-pack` has started `pack-objects`, there may be a
2417 quiet period while `pack-objects` prepares the pack. Normally
2418 it would output progress information, but if `--quiet` was used
2419 for the fetch, `pack-objects` will output nothing at all until
2420 the pack data begins. Some clients and networks may consider
2421 the server to be hung and give up. Setting this option instructs
2422 `upload-pack` to send an empty keepalive packet every
2423 `uploadpack.keepalive` seconds. Setting this option to 0
2424 disables keepalive packets entirely. The default is 5 seconds.
2426 url.<base>.insteadOf::
2427 Any URL that starts with this value will be rewritten to
2428 start, instead, with <base>. In cases where some site serves a
2429 large number of repositories, and serves them with multiple
2430 access methods, and some users need to use different access
2431 methods, this feature allows people to specify any of the
2432 equivalent URLs and have Git automatically rewrite the URL to
2433 the best alternative for the particular user, even for a
2434 never-before-seen repository on the site. When more than one
2435 insteadOf strings match a given URL, the longest match is used.
2437 url.<base>.pushInsteadOf::
2438 Any URL that starts with this value will not be pushed to;
2439 instead, it will be rewritten to start with <base>, and the
2440 resulting URL will be pushed to. In cases where some site serves
2441 a large number of repositories, and serves them with multiple
2442 access methods, some of which do not allow push, this feature
2443 allows people to specify a pull-only URL and have Git
2444 automatically use an appropriate URL to push, even for a
2445 never-before-seen repository on the site. When more than one
2446 pushInsteadOf strings match a given URL, the longest match is
2447 used. If a remote has an explicit pushurl, Git will ignore this
2448 setting for that remote.
2451 Your email address to be recorded in any newly created commits.
2452 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2453 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2456 Your full name to be recorded in any newly created commits.
2457 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2458 environment variables. See linkgit:git-commit-tree[1].
2461 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2462 key you want it to automatically when creating a signed tag or
2463 commit, you can override the default selection with this variable.
2464 This option is passed unchanged to gpg's --local-user parameter,
2465 so you may specify a key using any method that gpg supports.
2468 Specify a web browser that may be used by some commands.
2469 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]