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 This can be overridden by the GIT_WORK_TREE environment
384 variable and the '--work-tree' command line option.
385 The value can be an absolute path or relative to the path to
386 the .git directory, which is either specified by --git-dir
387 or GIT_DIR, or automatically discovered.
388 If --git-dir or GIT_DIR is specified but none of
389 --work-tree, GIT_WORK_TREE and core.worktree is specified,
390 the current working directory is regarded as the top level
391 of your working tree.
393 Note that this variable is honored even when set in a configuration
394 file in a ".git" subdirectory of a directory and its value differs
395 from the latter directory (e.g. "/path/to/.git/config" has
396 core.worktree set to "/different/path"), which is most likely a
397 misconfiguration. Running Git commands in the "/path/to" directory will
398 still use "/different/path" as the root of the work tree and can cause
399 confusion unless you know what you are doing (e.g. you are creating a
400 read-only snapshot of the same index to a location different from the
401 repository's usual working tree).
403 core.logAllRefUpdates::
404 Enable the reflog. Updates to a ref <ref> is logged to the file
405 "$GIT_DIR/logs/<ref>", by appending the new and old
406 SHA-1, the date/time and the reason of the update, but
407 only when the file exists. If this configuration
408 variable is set to true, missing "$GIT_DIR/logs/<ref>"
409 file is automatically created for branch heads (i.e. under
410 refs/heads/), remote refs (i.e. under refs/remotes/),
411 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
413 This information can be used to determine what commit
414 was the tip of a branch "2 days ago".
416 This value is true by default in a repository that has
417 a working directory associated with it, and false by
418 default in a bare repository.
420 core.repositoryFormatVersion::
421 Internal variable identifying the repository format and layout
424 core.sharedRepository::
425 When 'group' (or 'true'), the repository is made shareable between
426 several users in a group (making sure all the files and objects are
427 group-writable). When 'all' (or 'world' or 'everybody'), the
428 repository will be readable by all users, additionally to being
429 group-shareable. When 'umask' (or 'false'), Git will use permissions
430 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
431 files in the repository will have this mode value. '0xxx' will override
432 user's umask value (whereas the other options will only override
433 requested parts of the user's umask value). Examples: '0660' will make
434 the repo read/write-able for the owner and group, but inaccessible to
435 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
436 repository that is group-readable but not group-writable.
437 See linkgit:git-init[1]. False by default.
439 core.warnAmbiguousRefs::
440 If true, Git will warn you if the ref name you passed it is ambiguous
441 and might match multiple refs in the repository. True by default.
444 An integer -1..9, indicating a default compression level.
445 -1 is the zlib default. 0 means no compression,
446 and 1..9 are various speed/size tradeoffs, 9 being slowest.
447 If set, this provides a default to other compression variables,
448 such as 'core.loosecompression' and 'pack.compression'.
450 core.loosecompression::
451 An integer -1..9, indicating the compression level for objects that
452 are not in a pack file. -1 is the zlib default. 0 means no
453 compression, and 1..9 are various speed/size tradeoffs, 9 being
454 slowest. If not set, defaults to core.compression. If that is
455 not set, defaults to 1 (best speed).
457 core.packedGitWindowSize::
458 Number of bytes of a pack file to map into memory in a
459 single mapping operation. Larger window sizes may allow
460 your system to process a smaller number of large pack files
461 more quickly. Smaller window sizes will negatively affect
462 performance due to increased calls to the operating system's
463 memory manager, but may improve performance when accessing
464 a large number of large pack files.
466 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
467 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
468 be reasonable for all users/operating systems. You probably do
469 not need to adjust this value.
471 Common unit suffixes of 'k', 'm', or 'g' are supported.
473 core.packedGitLimit::
474 Maximum number of bytes to map simultaneously into memory
475 from pack files. If Git needs to access more than this many
476 bytes at once to complete an operation it will unmap existing
477 regions to reclaim virtual address space within the process.
479 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
480 This should be reasonable for all users/operating systems, except on
481 the largest projects. You probably do not need to adjust this value.
483 Common unit suffixes of 'k', 'm', or 'g' are supported.
485 core.deltaBaseCacheLimit::
486 Maximum number of bytes to reserve for caching base objects
487 that may be referenced by multiple deltified objects. By storing the
488 entire decompressed base objects in a cache Git is able
489 to avoid unpacking and decompressing frequently used base
490 objects multiple times.
492 Default is 16 MiB on all platforms. This should be reasonable
493 for all users/operating systems, except on the largest projects.
494 You probably do not need to adjust this value.
496 Common unit suffixes of 'k', 'm', or 'g' are supported.
498 core.bigFileThreshold::
499 Files larger than this size are stored deflated, without
500 attempting delta compression. Storing large files without
501 delta compression avoids excessive memory usage, at the
502 slight expense of increased disk usage.
504 Default is 512 MiB on all platforms. This should be reasonable
505 for most projects as source code and other text files can still
506 be delta compressed, but larger binary media files won't be.
508 Common unit suffixes of 'k', 'm', or 'g' are supported.
511 In addition to '.gitignore' (per-directory) and
512 '.git/info/exclude', Git looks into this file for patterns
513 of files which are not meant to be tracked. "`~/`" is expanded
514 to the value of `$HOME` and "`~user/`" to the specified user's
515 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
516 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
517 is used instead. See linkgit:gitignore[5].
520 Some commands (e.g. svn and http interfaces) that interactively
521 ask for a password can be told to use an external program given
522 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
523 environment variable. If not set, fall back to the value of the
524 'SSH_ASKPASS' environment variable or, failing that, a simple password
525 prompt. The external program shall be given a suitable prompt as
526 command line argument and write the password on its STDOUT.
528 core.attributesfile::
529 In addition to '.gitattributes' (per-directory) and
530 '.git/info/attributes', Git looks into this file for attributes
531 (see linkgit:gitattributes[5]). Path expansions are made the same
532 way as for `core.excludesfile`. Its default value is
533 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
534 set or empty, $HOME/.config/git/attributes is used instead.
537 Commands such as `commit` and `tag` that lets you edit
538 messages by launching an editor uses the value of this
539 variable when it is set, and the environment variable
540 `GIT_EDITOR` is not set. See linkgit:git-var[1].
543 Commands such as `commit` and `tag` that lets you edit
544 messages consider a line that begins with this character
545 commented, and removes them after the editor returns
548 If set to "auto", `git-commit` would select a character that is not
549 the beginning character of any line in existing commit messages.
552 Text editor used by `git rebase -i` for editing the rebase instruction file.
553 The value is meant to be interpreted by the shell when it is used.
554 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
555 When not configured the default commit message editor is used instead.
558 Text viewer for use by Git commands (e.g., 'less'). The value
559 is meant to be interpreted by the shell. The order of preference
560 is the `$GIT_PAGER` environment variable, then `core.pager`
561 configuration, then `$PAGER`, and then the default chosen at
562 compile time (usually 'less').
564 When the `LESS` environment variable is unset, Git sets it to `FRSX`
565 (if `LESS` environment variable is set, Git does not change it at
566 all). If you want to selectively override Git's default setting
567 for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
568 be passed to the shell by Git, which will translate the final
569 command to `LESS=FRSX less -+S`. The environment tells the command
570 to set the `S` option to chop long lines but the command line
571 resets it to the default to fold long lines.
573 Likewise, when the `LV` environment variable is unset, Git sets it
574 to `-c`. You can override this setting by exporting `LV` with
575 another value or setting `core.pager` to `lv +c`.
578 A comma separated list of common whitespace problems to
579 notice. 'git diff' will use `color.diff.whitespace` to
580 highlight them, and 'git apply --whitespace=error' will
581 consider them as errors. You can prefix `-` to disable
582 any of them (e.g. `-trailing-space`):
584 * `blank-at-eol` treats trailing whitespaces at the end of the line
585 as an error (enabled by default).
586 * `space-before-tab` treats a space character that appears immediately
587 before a tab character in the initial indent part of the line as an
588 error (enabled by default).
589 * `indent-with-non-tab` treats a line that is indented with space
590 characters instead of the equivalent tabs as an error (not enabled by
592 * `tab-in-indent` treats a tab character in the initial indent part of
593 the line as an error (not enabled by default).
594 * `blank-at-eof` treats blank lines added at the end of file as an error
595 (enabled by default).
596 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
598 * `cr-at-eol` treats a carriage-return at the end of line as
599 part of the line terminator, i.e. with it, `trailing-space`
600 does not trigger if the character before such a carriage-return
601 is not a whitespace (not enabled by default).
602 * `tabwidth=<n>` tells how many character positions a tab occupies; this
603 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
604 errors. The default tab width is 8. Allowed values are 1 to 63.
606 core.fsyncobjectfiles::
607 This boolean will enable 'fsync()' when writing object files.
609 This is a total waste of time and effort on a filesystem that orders
610 data writes properly, but can be useful for filesystems that do not use
611 journalling (traditional UNIX filesystems) or that only journal metadata
612 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
615 Enable parallel index preload for operations like 'git diff'
617 This can speed up operations like 'git diff' and 'git status' especially
618 on filesystems like NFS that have weak caching semantics and thus
619 relatively high IO latencies. With this set to 'true', Git will do the
620 index comparison to the filesystem data in parallel, allowing
624 You can set this to 'link', in which case a hardlink followed by
625 a delete of the source are used to make sure that object creation
626 will not overwrite existing objects.
628 On some file system/operating system combinations, this is unreliable.
629 Set this config setting to 'rename' there; However, This will remove the
630 check that makes sure that existing object files will not get overwritten.
633 When showing commit messages, also show notes which are stored in
634 the given ref. The ref must be fully qualified. If the given
635 ref does not exist, it is not an error but means that no
636 notes should be printed.
638 This setting defaults to "refs/notes/commits", and it can be overridden by
639 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
641 core.sparseCheckout::
642 Enable "sparse checkout" feature. See section "Sparse checkout" in
643 linkgit:git-read-tree[1] for more information.
646 Set the length object names are abbreviated to. If unspecified,
647 many commands abbreviate to 7 hexdigits, which may not be enough
648 for abbreviated object names to stay unique for sufficiently long
653 Tells 'git add' to continue adding files when some files cannot be
654 added due to indexing errors. Equivalent to the '--ignore-errors'
655 option of linkgit:git-add[1]. Older versions of Git accept only
656 `add.ignore-errors`, which does not follow the usual naming
657 convention for configuration variables. Newer versions of Git
658 honor `add.ignoreErrors` as well.
661 Command aliases for the linkgit:git[1] command wrapper - e.g.
662 after defining "alias.last = cat-file commit HEAD", the invocation
663 "git last" is equivalent to "git cat-file commit HEAD". To avoid
664 confusion and troubles with script usage, aliases that
665 hide existing Git commands are ignored. Arguments are split by
666 spaces, the usual shell quoting and escaping is supported.
667 quote pair and a backslash can be used to quote them.
669 If the alias expansion is prefixed with an exclamation point,
670 it will be treated as a shell command. For example, defining
671 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
672 "git new" is equivalent to running the shell command
673 "gitk --all --not ORIG_HEAD". Note that shell commands will be
674 executed from the top-level directory of a repository, which may
675 not necessarily be the current directory.
676 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
677 from the original current directory. See linkgit:git-rev-parse[1].
680 If true, git-am will call git-mailsplit for patches in mbox format
681 with parameter '--keep-cr'. In this case git-mailsplit will
682 not remove `\r` from lines ending with `\r\n`. Can be overridden
683 by giving '--no-keep-cr' from the command line.
684 See linkgit:git-am[1], linkgit:git-mailsplit[1].
686 apply.ignorewhitespace::
687 When set to 'change', tells 'git apply' to ignore changes in
688 whitespace, in the same way as the '--ignore-space-change'
690 When set to one of: no, none, never, false tells 'git apply' to
691 respect all whitespace differences.
692 See linkgit:git-apply[1].
695 Tells 'git apply' how to handle whitespaces, in the same way
696 as the '--whitespace' option. See linkgit:git-apply[1].
698 branch.autosetupmerge::
699 Tells 'git branch' and 'git checkout' to set up new branches
700 so that linkgit:git-pull[1] will appropriately merge from the
701 starting point branch. Note that even if this option is not set,
702 this behavior can be chosen per-branch using the `--track`
703 and `--no-track` options. The valid settings are: `false` -- no
704 automatic setup is done; `true` -- automatic setup is done when the
705 starting point is a remote-tracking branch; `always` --
706 automatic setup is done when the starting point is either a
707 local branch or remote-tracking
708 branch. This option defaults to true.
710 branch.autosetuprebase::
711 When a new branch is created with 'git branch' or 'git checkout'
712 that tracks another branch, this variable tells Git to set
713 up pull to rebase instead of merge (see "branch.<name>.rebase").
714 When `never`, rebase is never automatically set to true.
715 When `local`, rebase is set to true for tracked branches of
716 other local branches.
717 When `remote`, rebase is set to true for tracked branches of
718 remote-tracking branches.
719 When `always`, rebase will be set to true for all tracking
721 See "branch.autosetupmerge" for details on how to set up a
722 branch to track another branch.
723 This option defaults to never.
725 branch.<name>.remote::
726 When on branch <name>, it tells 'git fetch' and 'git push'
727 which remote to fetch from/push to. The remote to push to
728 may be overridden with `remote.pushdefault` (for all branches).
729 The remote to push to, for the current branch, may be further
730 overridden by `branch.<name>.pushremote`. If no remote is
731 configured, or if you are not on any branch, it defaults to
732 `origin` for fetching and `remote.pushdefault` for pushing.
733 Additionally, `.` (a period) is the current local repository
734 (a dot-repository), see `branch.<name>.merge`'s final note below.
736 branch.<name>.pushremote::
737 When on branch <name>, it overrides `branch.<name>.remote` for
738 pushing. It also overrides `remote.pushdefault` for pushing
739 from branch <name>. When you pull from one place (e.g. your
740 upstream) and push to another place (e.g. your own publishing
741 repository), you would want to set `remote.pushdefault` to
742 specify the remote to push to for all branches, and use this
743 option to override it for a specific branch.
745 branch.<name>.merge::
746 Defines, together with branch.<name>.remote, the upstream branch
747 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
748 branch to merge and can also affect 'git push' (see push.default).
749 When in branch <name>, it tells 'git fetch' the default
750 refspec to be marked for merging in FETCH_HEAD. The value is
751 handled like the remote part of a refspec, and must match a
752 ref which is fetched from the remote given by
753 "branch.<name>.remote".
754 The merge information is used by 'git pull' (which at first calls
755 'git fetch') to lookup the default branch for merging. Without
756 this option, 'git pull' defaults to merge the first refspec fetched.
757 Specify multiple values to get an octopus merge.
758 If you wish to setup 'git pull' so that it merges into <name> from
759 another branch in the local repository, you can point
760 branch.<name>.merge to the desired branch, and use the relative path
761 setting `.` (a period) for branch.<name>.remote.
763 branch.<name>.mergeoptions::
764 Sets default options for merging into branch <name>. The syntax and
765 supported options are the same as those of linkgit:git-merge[1], but
766 option values containing whitespace characters are currently not
769 branch.<name>.rebase::
770 When true, rebase the branch <name> on top of the fetched branch,
771 instead of merging the default branch from the default remote when
772 "git pull" is run. See "pull.rebase" for doing this in a non
773 branch-specific manner.
775 When preserve, also pass `--preserve-merges` along to 'git rebase'
776 so that locally committed merge commits will not be flattened
777 by running 'git pull'.
779 *NOTE*: this is a possibly dangerous operation; do *not* use
780 it unless you understand the implications (see linkgit:git-rebase[1]
783 branch.<name>.description::
784 Branch description, can be edited with
785 `git branch --edit-description`. Branch description is
786 automatically added in the format-patch cover letter or
787 request-pull summary.
790 Specify the command to invoke the specified browser. The
791 specified command is evaluated in shell with the URLs passed
792 as arguments. (See linkgit:git-web{litdd}browse[1].)
794 browser.<tool>.path::
795 Override the path for the given tool that may be used to
796 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
797 working repository in gitweb (see linkgit:git-instaweb[1]).
800 A boolean to make git-clean do nothing unless given -f,
801 -i or -n. Defaults to true.
804 A boolean to enable/disable color in the output of
805 linkgit:git-branch[1]. May be set to `always`,
806 `false` (or `never`) or `auto` (or `true`), in which case colors are used
807 only when the output is to a terminal. Defaults to false.
809 color.branch.<slot>::
810 Use customized color for branch coloration. `<slot>` is one of
811 `current` (the current branch), `local` (a local branch),
812 `remote` (a remote-tracking branch in refs/remotes/),
813 `upstream` (upstream tracking branch), `plain` (other
816 The value for these configuration variables is a list of colors (at most
817 two) and attributes (at most one), separated by spaces. The colors
818 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
819 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
820 `blink` and `reverse`. The first color given is the foreground; the
821 second is the background. The position of the attribute, if any,
825 Whether to use ANSI escape sequences to add color to patches.
826 If this is set to `always`, linkgit:git-diff[1],
827 linkgit:git-log[1], and linkgit:git-show[1] will use color
828 for all patches. If it is set to `true` or `auto`, those
829 commands will only use color when output is to the terminal.
832 This does not affect linkgit:git-format-patch[1] or the
833 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
834 command line with the `--color[=<when>]` option.
837 Use customized color for diff colorization. `<slot>` specifies
838 which part of the patch to use the specified color, and is one
839 of `plain` (context text), `meta` (metainformation), `frag`
840 (hunk header), 'func' (function in hunk header), `old` (removed lines),
841 `new` (added lines), `commit` (commit headers), or `whitespace`
842 (highlighting whitespace errors). The values of these variables may be
843 specified as in color.branch.<slot>.
845 color.decorate.<slot>::
846 Use customized color for 'git log --decorate' output. `<slot>` is one
847 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
848 branches, remote-tracking branches, tags, stash and HEAD, respectively.
851 When set to `always`, always highlight matches. When `false` (or
852 `never`), never. When set to `true` or `auto`, use color only
853 when the output is written to the terminal. Defaults to `false`.
856 Use customized color for grep colorization. `<slot>` specifies which
857 part of the line to use the specified color, and is one of
861 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
863 filename prefix (when not using `-h`)
865 function name lines (when using `-p`)
867 line number prefix (when using `-n`)
871 non-matching text in selected lines
873 separators between fields on a line (`:`, `-`, and `=`)
874 and between hunks (`--`)
877 The values of these variables may be specified as in color.branch.<slot>.
880 When set to `always`, always use colors for interactive prompts
881 and displays (such as those used by "git-add --interactive" and
882 "git-clean --interactive"). When false (or `never`), never.
883 When set to `true` or `auto`, use colors only when the output is
884 to the terminal. Defaults to false.
886 color.interactive.<slot>::
887 Use customized color for 'git add --interactive' and 'git clean
888 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
889 or `error`, for four distinct types of normal output from
890 interactive commands. The values of these variables may be
891 specified as in color.branch.<slot>.
894 A boolean to enable/disable colored output when the pager is in
895 use (default is true).
898 A boolean to enable/disable color in the output of
899 linkgit:git-show-branch[1]. May be set to `always`,
900 `false` (or `never`) or `auto` (or `true`), in which case colors are used
901 only when the output is to a terminal. Defaults to false.
904 A boolean to enable/disable color in the output of
905 linkgit:git-status[1]. May be set to `always`,
906 `false` (or `never`) or `auto` (or `true`), in which case colors are used
907 only when the output is to a terminal. Defaults to false.
909 color.status.<slot>::
910 Use customized color for status colorization. `<slot>` is
911 one of `header` (the header text of the status message),
912 `added` or `updated` (files which are added but not committed),
913 `changed` (files which are changed but not added in the index),
914 `untracked` (files which are not tracked by Git),
915 `branch` (the current branch), or
916 `nobranch` (the color the 'no branch' warning is shown in, defaulting
917 to red). The values of these variables may be specified as in
921 This variable determines the default value for variables such
922 as `color.diff` and `color.grep` that control the use of color
923 per command family. Its scope will expand as more commands learn
924 configuration to set a default for the `--color` option. Set it
925 to `false` or `never` if you prefer Git commands not to use
926 color unless enabled explicitly with some other configuration
927 or the `--color` option. Set it to `always` if you want all
928 output not intended for machine consumption to use color, to
929 `true` or `auto` (this is the default since Git 1.8.4) if you
930 want such output to use color when written to the terminal.
933 Specify whether supported commands should output in columns.
934 This variable consists of a list of tokens separated by spaces
937 These options control when the feature should be enabled
938 (defaults to 'never'):
942 always show in columns
944 never show in columns
946 show in columns if the output is to the terminal
949 These options control layout (defaults to 'column'). Setting any
950 of these implies 'always' if none of 'always', 'never', or 'auto' are
955 fill columns before rows
957 fill rows before columns
962 Finally, these options can be combined with a layout option (defaults
967 make unequal size columns to utilize more space
969 make equal size columns
973 Specify whether to output branch listing in `git branch` in columns.
974 See `column.ui` for details.
977 Specify the layout when list items in `git clean -i`, which always
978 shows files and directories in columns. See `column.ui` for details.
981 Specify whether to output untracked files in `git status` in columns.
982 See `column.ui` for details.
985 Specify whether to output tag listing in `git tag` in columns.
986 See `column.ui` for details.
989 This setting overrides the default of the `--cleanup` option in
990 `git commit`. See linkgit:git-commit[1] for details. Changing the
991 default can be useful when you always want to keep lines that begin
992 with comment character `#` in your log message, in which case you
993 would do `git config commit.cleanup whitespace` (note that you will
994 have to remove the help lines that begin with `#` in the commit log
995 template yourself, if you do this).
999 A boolean to specify whether all commits should be GPG signed.
1000 Use of this option when doing operations such as rebase can
1001 result in a large number of commits being signed. It may be
1002 convenient to use an agent to avoid typing your GPG passphrase
1006 A boolean to enable/disable inclusion of status information in the
1007 commit message template when using an editor to prepare the commit
1008 message. Defaults to true.
1011 Specify a file to use as the template for new commit messages.
1012 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1013 specified user's home directory.
1016 Specify an external helper to be called when a username or
1017 password credential is needed; the helper may consult external
1018 storage to avoid prompting the user for the credentials. See
1019 linkgit:gitcredentials[7] for details.
1021 credential.useHttpPath::
1022 When acquiring credentials, consider the "path" component of an http
1023 or https URL to be important. Defaults to false. See
1024 linkgit:gitcredentials[7] for more information.
1026 credential.username::
1027 If no username is set for a network authentication, use this username
1028 by default. See credential.<context>.* below, and
1029 linkgit:gitcredentials[7].
1031 credential.<url>.*::
1032 Any of the credential.* options above can be applied selectively to
1033 some credentials. For example "credential.https://example.com.username"
1034 would set the default username only for https connections to
1035 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1038 include::diff-config.txt[]
1040 difftool.<tool>.path::
1041 Override the path for the given tool. This is useful in case
1042 your tool is not in the PATH.
1044 difftool.<tool>.cmd::
1045 Specify the command to invoke the specified diff tool.
1046 The specified command is evaluated in shell with the following
1047 variables available: 'LOCAL' is set to the name of the temporary
1048 file containing the contents of the diff pre-image and 'REMOTE'
1049 is set to the name of the temporary file containing the contents
1050 of the diff post-image.
1053 Prompt before each invocation of the diff tool.
1055 fetch.recurseSubmodules::
1056 This option can be either set to a boolean value or to 'on-demand'.
1057 Setting it to a boolean changes the behavior of fetch and pull to
1058 unconditionally recurse into submodules when set to true or to not
1059 recurse at all when set to false. When set to 'on-demand' (the default
1060 value), fetch and pull will only recurse into a populated submodule
1061 when its superproject retrieves a commit that updates the submodule's
1065 If it is set to true, git-fetch-pack will check all fetched
1066 objects. It will abort in the case of a malformed object or a
1067 broken link. The result of an abort are only dangling objects.
1068 Defaults to false. If not set, the value of `transfer.fsckObjects`
1072 If the number of objects fetched over the Git native
1073 transfer is below this
1074 limit, then the objects will be unpacked into loose object
1075 files. However if the number of received objects equals or
1076 exceeds this limit then the received pack will be stored as
1077 a pack, after adding any missing delta bases. Storing the
1078 pack from a push can make the push operation complete faster,
1079 especially on slow filesystems. If not set, the value of
1080 `transfer.unpackLimit` is used instead.
1083 If true, fetch will automatically behave as if the `--prune`
1084 option was given on the command line. See also `remote.<name>.prune`.
1087 Enable multipart/mixed attachments as the default for
1088 'format-patch'. The value can also be a double quoted string
1089 which will enable attachments as the default and set the
1090 value as the boundary. See the --attach option in
1091 linkgit:git-format-patch[1].
1094 A boolean which can enable or disable sequence numbers in patch
1095 subjects. It defaults to "auto" which enables it only if there
1096 is more than one patch. It can be enabled or disabled for all
1097 messages by setting it to "true" or "false". See --numbered
1098 option in linkgit:git-format-patch[1].
1101 Additional email headers to include in a patch to be submitted
1102 by mail. See linkgit:git-format-patch[1].
1106 Additional recipients to include in a patch to be submitted
1107 by mail. See the --to and --cc options in
1108 linkgit:git-format-patch[1].
1110 format.subjectprefix::
1111 The default for format-patch is to output files with the '[PATCH]'
1112 subject prefix. Use this variable to change that prefix.
1115 The default for format-patch is to output a signature containing
1116 the Git version number. Use this variable to change that default.
1117 Set this variable to the empty string ("") to suppress
1118 signature generation.
1121 The default for format-patch is to output files with the suffix
1122 `.patch`. Use this variable to change that suffix (make sure to
1123 include the dot if you want it).
1126 The default pretty format for log/show/whatchanged command,
1127 See linkgit:git-log[1], linkgit:git-show[1],
1128 linkgit:git-whatchanged[1].
1131 The default threading style for 'git format-patch'. Can be
1132 a boolean value, or `shallow` or `deep`. `shallow` threading
1133 makes every mail a reply to the head of the series,
1134 where the head is chosen from the cover letter, the
1135 `--in-reply-to`, and the first patch mail, in this order.
1136 `deep` threading makes every mail a reply to the previous one.
1137 A true boolean value is the same as `shallow`, and a false
1138 value disables threading.
1141 A boolean value which lets you enable the `-s/--signoff` option of
1142 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1143 patch should be a conscious act and means that you certify you have
1144 the rights to submit this work under the same open source license.
1145 Please see the 'SubmittingPatches' document for further discussion.
1147 format.coverLetter::
1148 A boolean that controls whether to generate a cover-letter when
1149 format-patch is invoked, but in addition can be set to "auto", to
1150 generate a cover-letter only when there's more than one patch.
1152 filter.<driver>.clean::
1153 The command which is used to convert the content of a worktree
1154 file to a blob upon checkin. See linkgit:gitattributes[5] for
1157 filter.<driver>.smudge::
1158 The command which is used to convert the content of a blob
1159 object to a worktree file upon checkout. See
1160 linkgit:gitattributes[5] for details.
1162 gc.aggressiveDepth::
1163 The depth parameter used in the delta compression
1164 algorithm used by 'git gc --aggressive'. This defaults
1167 gc.aggressiveWindow::
1168 The window size parameter used in the delta compression
1169 algorithm used by 'git gc --aggressive'. This defaults
1173 When there are approximately more than this many loose
1174 objects in the repository, `git gc --auto` will pack them.
1175 Some Porcelain commands use this command to perform a
1176 light-weight garbage collection from time to time. The
1177 default value is 6700. Setting this to 0 disables it.
1180 When there are more than this many packs that are not
1181 marked with `*.keep` file in the repository, `git gc
1182 --auto` consolidates them into one larger pack. The
1183 default value is 50. Setting this to 0 disables it.
1186 Make `git gc --auto` return immediately andrun in background
1187 if the system supports it. Default is true.
1190 Running `git pack-refs` in a repository renders it
1191 unclonable by Git versions prior to 1.5.1.2 over dumb
1192 transports such as HTTP. This variable determines whether
1193 'git gc' runs `git pack-refs`. This can be set to `notbare`
1194 to enable it within all non-bare repos or it can be set to a
1195 boolean value. The default is `true`.
1198 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1199 Override the grace period with this config variable. The value
1200 "now" may be used to disable this grace period and always prune
1201 unreachable objects immediately.
1204 gc.<pattern>.reflogexpire::
1205 'git reflog expire' removes reflog entries older than
1206 this time; defaults to 90 days. With "<pattern>" (e.g.
1207 "refs/stash") in the middle the setting applies only to
1208 the refs that match the <pattern>.
1210 gc.reflogexpireunreachable::
1211 gc.<ref>.reflogexpireunreachable::
1212 'git reflog expire' removes reflog entries older than
1213 this time and are not reachable from the current tip;
1214 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1215 in the middle, the setting applies only to the refs that
1216 match the <pattern>.
1219 Records of conflicted merge you resolved earlier are
1220 kept for this many days when 'git rerere gc' is run.
1221 The default is 60 days. See linkgit:git-rerere[1].
1223 gc.rerereunresolved::
1224 Records of conflicted merge you have not resolved are
1225 kept for this many days when 'git rerere gc' is run.
1226 The default is 15 days. See linkgit:git-rerere[1].
1228 gitcvs.commitmsgannotation::
1229 Append this string to each commit message. Set to empty string
1230 to disable this feature. Defaults to "via git-CVS emulator".
1233 Whether the CVS server interface is enabled for this repository.
1234 See linkgit:git-cvsserver[1].
1237 Path to a log file where the CVS server interface well... logs
1238 various stuff. See linkgit:git-cvsserver[1].
1240 gitcvs.usecrlfattr::
1241 If true, the server will look up the end-of-line conversion
1242 attributes for files to determine the '-k' modes to use. If
1243 the attributes force Git to treat a file as text,
1244 the '-k' mode will be left blank so CVS clients will
1245 treat it as text. If they suppress text conversion, the file
1246 will be set with '-kb' mode, which suppresses any newline munging
1247 the client might otherwise do. If the attributes do not allow
1248 the file type to be determined, then 'gitcvs.allbinary' is
1249 used. See linkgit:gitattributes[5].
1252 This is used if 'gitcvs.usecrlfattr' does not resolve
1253 the correct '-kb' mode to use. If true, all
1254 unresolved files are sent to the client in
1255 mode '-kb'. This causes the client to treat them
1256 as binary files, which suppresses any newline munging it
1257 otherwise might do. Alternatively, if it is set to "guess",
1258 then the contents of the file are examined to decide if
1259 it is binary, similar to 'core.autocrlf'.
1262 Database used by git-cvsserver to cache revision information
1263 derived from the Git repository. The exact meaning depends on the
1264 used database driver, for SQLite (which is the default driver) this
1265 is a filename. Supports variable substitution (see
1266 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1267 Default: '%Ggitcvs.%m.sqlite'
1270 Used Perl DBI driver. You can specify any available driver
1271 for this here, but it might not work. git-cvsserver is tested
1272 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1273 reported *not* to work with 'DBD::mysql'. Experimental feature.
1274 May not contain double colons (`:`). Default: 'SQLite'.
1275 See linkgit:git-cvsserver[1].
1277 gitcvs.dbuser, gitcvs.dbpass::
1278 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1279 since SQLite has no concept of database users and/or passwords.
1280 'gitcvs.dbuser' supports variable substitution (see
1281 linkgit:git-cvsserver[1] for details).
1283 gitcvs.dbTableNamePrefix::
1284 Database table name prefix. Prepended to the names of any
1285 database tables used, allowing a single database to be used
1286 for several repositories. Supports variable substitution (see
1287 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1288 characters will be replaced with underscores.
1290 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1291 'gitcvs.allbinary' can also be specified as
1292 'gitcvs.<access_method>.<varname>' (where 'access_method'
1293 is one of "ext" and "pserver") to make them apply only for the given
1297 gitweb.description::
1300 See linkgit:gitweb[1] for description.
1308 gitweb.remote_heads::
1311 See linkgit:gitweb.conf[5] for description.
1314 If set to true, enable '-n' option by default.
1317 Set the default matching behavior. Using a value of 'basic', 'extended',
1318 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1319 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1320 value 'default' will return to the default matching behavior.
1322 grep.extendedRegexp::
1323 If set to true, enable '--extended-regexp' option by default. This
1324 option is ignored when the 'grep.patternType' option is set to a value
1325 other than 'default'.
1328 Use this custom program instead of "gpg" found on $PATH when
1329 making or verifying a PGP signature. The program must support the
1330 same command line interface as GPG, namely, to verify a detached
1331 signature, "gpg --verify $file - <$signature" is run, and the
1332 program is expected to signal a good signature by exiting with
1333 code 0, and to generate an ascii-armored detached signature, the
1334 standard input of "gpg -bsau $key" is fed with the contents to be
1335 signed, and the program is expected to send the result to its
1338 gui.commitmsgwidth::
1339 Defines how wide the commit message window is in the
1340 linkgit:git-gui[1]. "75" is the default.
1343 Specifies how many context lines should be used in calls to diff
1344 made by the linkgit:git-gui[1]. The default is "5".
1346 gui.displayuntracked::
1347 Determines if linkgit::git-gui[1] shows untracked files
1348 in the file list. The default is "true".
1351 Specifies the default encoding to use for displaying of
1352 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1353 It can be overridden by setting the 'encoding' attribute
1354 for relevant files (see linkgit:gitattributes[5]).
1355 If this option is not set, the tools default to the
1358 gui.matchtrackingbranch::
1359 Determines if new branches created with linkgit:git-gui[1] should
1360 default to tracking remote branches with matching names or
1361 not. Default: "false".
1363 gui.newbranchtemplate::
1364 Is used as suggested name when creating new branches using the
1367 gui.pruneduringfetch::
1368 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1369 performing a fetch. The default value is "false".
1372 Determines if linkgit:git-gui[1] should trust the file modification
1373 timestamp or not. By default the timestamps are not trusted.
1375 gui.spellingdictionary::
1376 Specifies the dictionary used for spell checking commit messages in
1377 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1381 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1382 location detection. It makes blame significantly faster on huge
1383 repositories at the expense of less thorough copy detection.
1385 gui.copyblamethreshold::
1386 Specifies the threshold to use in 'git gui blame' original location
1387 detection, measured in alphanumeric characters. See the
1388 linkgit:git-blame[1] manual for more information on copy detection.
1390 gui.blamehistoryctx::
1391 Specifies the radius of history context in days to show in
1392 linkgit:gitk[1] for the selected commit, when the `Show History
1393 Context` menu item is invoked from 'git gui blame'. If this
1394 variable is set to zero, the whole history is shown.
1396 guitool.<name>.cmd::
1397 Specifies the shell command line to execute when the corresponding item
1398 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1399 mandatory for every tool. The command is executed from the root of
1400 the working directory, and in the environment it receives the name of
1401 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1402 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1403 the head is detached, 'CUR_BRANCH' is empty).
1405 guitool.<name>.needsfile::
1406 Run the tool only if a diff is selected in the GUI. It guarantees
1407 that 'FILENAME' is not empty.
1409 guitool.<name>.noconsole::
1410 Run the command silently, without creating a window to display its
1413 guitool.<name>.norescan::
1414 Don't rescan the working directory for changes after the tool
1417 guitool.<name>.confirm::
1418 Show a confirmation dialog before actually running the tool.
1420 guitool.<name>.argprompt::
1421 Request a string argument from the user, and pass it to the tool
1422 through the 'ARGS' environment variable. Since requesting an
1423 argument implies confirmation, the 'confirm' option has no effect
1424 if this is enabled. If the option is set to 'true', 'yes', or '1',
1425 the dialog uses a built-in generic prompt; otherwise the exact
1426 value of the variable is used.
1428 guitool.<name>.revprompt::
1429 Request a single valid revision from the user, and set the
1430 'REVISION' environment variable. In other aspects this option
1431 is similar to 'argprompt', and can be used together with it.
1433 guitool.<name>.revunmerged::
1434 Show only unmerged branches in the 'revprompt' subdialog.
1435 This is useful for tools similar to merge or rebase, but not
1436 for things like checkout or reset.
1438 guitool.<name>.title::
1439 Specifies the title to use for the prompt dialog. The default
1442 guitool.<name>.prompt::
1443 Specifies the general prompt string to display at the top of
1444 the dialog, before subsections for 'argprompt' and 'revprompt'.
1445 The default value includes the actual command.
1448 Specify the browser that will be used to display help in the
1449 'web' format. See linkgit:git-help[1].
1452 Override the default help format used by linkgit:git-help[1].
1453 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1454 the default. 'web' and 'html' are the same.
1457 Automatically correct and execute mistyped commands after
1458 waiting for the given number of deciseconds (0.1 sec). If more
1459 than one command can be deduced from the entered text, nothing
1460 will be executed. If the value of this option is negative,
1461 the corrected command will be executed immediately. If the
1462 value is 0 - the command will be just shown but not executed.
1463 This is the default.
1466 Specify the path where the HTML documentation resides. File system paths
1467 and URLs are supported. HTML pages will be prefixed with this path when
1468 help is displayed in the 'web' format. This defaults to the documentation
1469 path of your Git installation.
1472 Override the HTTP proxy, normally configured using the 'http_proxy',
1473 'https_proxy', and 'all_proxy' environment variables (see
1474 `curl(1)`). This can be overridden on a per-remote basis; see
1478 File containing previously stored cookie lines which should be used
1479 in the Git http session, if they match the server. The file format
1480 of the file to read cookies from should be plain HTTP headers or
1481 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1482 NOTE that the file specified with http.cookiefile is only used as
1483 input unless http.saveCookies is set.
1486 If set, store cookies received during requests to the file specified by
1487 http.cookiefile. Has no effect if http.cookiefile is unset.
1490 Whether to verify the SSL certificate when fetching or pushing
1491 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1495 File containing the SSL certificate when fetching or pushing
1496 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1500 File containing the SSL private key when fetching or pushing
1501 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1504 http.sslCertPasswordProtected::
1505 Enable Git's password prompt for the SSL certificate. Otherwise
1506 OpenSSL will prompt the user, possibly many times, if the
1507 certificate or private key is encrypted. Can be overridden by the
1508 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1511 File containing the certificates to verify the peer with when
1512 fetching or pushing over HTTPS. Can be overridden by the
1513 'GIT_SSL_CAINFO' environment variable.
1516 Path containing files with the CA certificates to verify the peer
1517 with when fetching or pushing over HTTPS. Can be overridden
1518 by the 'GIT_SSL_CAPATH' environment variable.
1521 Attempt to use AUTH SSL/TLS and encrypted data transfers
1522 when connecting via regular FTP protocol. This might be needed
1523 if the FTP server requires it for security reasons or you wish
1524 to connect securely whenever remote FTP server supports it.
1525 Default is false since it might trigger certificate verification
1526 errors on misconfigured servers.
1529 How many HTTP requests to launch in parallel. Can be overridden
1530 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1533 The number of curl sessions (counted across slots) to be kept across
1534 requests. They will not be ended with curl_easy_cleanup() until
1535 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1536 value will be capped at 1. Defaults to 1.
1539 Maximum size in bytes of the buffer used by smart HTTP
1540 transports when POSTing data to the remote system.
1541 For requests larger than this buffer size, HTTP/1.1 and
1542 Transfer-Encoding: chunked is used to avoid creating a
1543 massive pack file locally. Default is 1 MiB, which is
1544 sufficient for most requests.
1546 http.lowSpeedLimit, http.lowSpeedTime::
1547 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1548 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1549 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1550 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1553 A boolean which disables using of EPSV ftp command by curl.
1554 This can helpful with some "poor" ftp servers which don't
1555 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1556 environment variable. Default is false (curl will use EPSV).
1559 The HTTP USER_AGENT string presented to an HTTP server. The default
1560 value represents the version of the client Git such as git/1.7.1.
1561 This option allows you to override this value to a more common value
1562 such as Mozilla/4.0. This may be necessary, for instance, if
1563 connecting through a firewall that restricts HTTP connections to a set
1564 of common USER_AGENT strings (but not including those like git/1.7.1).
1565 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1568 Any of the http.* options above can be applied selectively to some urls.
1569 For a config key to match a URL, each element of the config key is
1570 compared to that of the URL, in the following order:
1573 . Scheme (e.g., `https` in `https://example.com/`). This field
1574 must match exactly between the config key and the URL.
1576 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1577 This field must match exactly between the config key and the URL.
1579 . Port number (e.g., `8080` in `http://example.com:8080/`).
1580 This field must match exactly between the config key and the URL.
1581 Omitted port numbers are automatically converted to the correct
1582 default for the scheme before matching.
1584 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1585 path field of the config key must match the path field of the URL
1586 either exactly or as a prefix of slash-delimited path elements. This means
1587 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1588 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1589 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1590 key with just path `foo/`).
1592 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1593 the config key has a user name it must match the user name in the
1594 URL exactly. If the config key does not have a user name, that
1595 config key will match a URL with any user name (including none),
1596 but at a lower precedence than a config key with a user name.
1599 The list above is ordered by decreasing precedence; a URL that matches
1600 a config key's path is preferred to one that matches its user name. For example,
1601 if the URL is `https://user@example.com/foo/bar` a config key match of
1602 `https://example.com/foo` will be preferred over a config key match of
1603 `https://user@example.com`.
1605 All URLs are normalized before attempting any matching (the password part,
1606 if embedded in the URL, is always ignored for matching purposes) so that
1607 equivalent urls that are simply spelled differently will match properly.
1608 Environment variable settings always override any matches. The urls that are
1609 matched against are those given directly to Git commands. This means any URLs
1610 visited as a result of a redirection do not participate in matching.
1612 i18n.commitEncoding::
1613 Character encoding the commit messages are stored in; Git itself
1614 does not care per se, but this information is necessary e.g. when
1615 importing commits from emails or in the gitk graphical history
1616 browser (and possibly at other places in the future or in other
1617 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1619 i18n.logOutputEncoding::
1620 Character encoding the commit messages are converted to when
1621 running 'git log' and friends.
1624 The configuration variables in the 'imap' section are described
1625 in linkgit:git-imap-send[1].
1628 Specify the version with which new index files should be
1629 initialized. This does not affect existing repositories.
1632 Specify the directory from which templates will be copied.
1633 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1636 Specify the program that will be used to browse your working
1637 repository in gitweb. See linkgit:git-instaweb[1].
1640 The HTTP daemon command-line to start gitweb on your working
1641 repository. See linkgit:git-instaweb[1].
1644 If true the web server started by linkgit:git-instaweb[1] will
1645 be bound to the local IP (127.0.0.1).
1647 instaweb.modulepath::
1648 The default module path for linkgit:git-instaweb[1] to use
1649 instead of /usr/lib/apache2/modules. Only used if httpd
1653 The port number to bind the gitweb httpd to. See
1654 linkgit:git-instaweb[1].
1656 interactive.singlekey::
1657 In interactive commands, allow the user to provide one-letter
1658 input with a single key (i.e., without hitting enter).
1659 Currently this is used by the `--patch` mode of
1660 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1661 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1662 setting is silently ignored if portable keystroke input
1663 is not available; requires the Perl module Term::ReadKey.
1666 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1667 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1668 override this option with `--no-abbrev-commit`.
1671 Set the default date-time mode for the 'log' command.
1672 Setting a value for log.date is similar to using 'git log''s
1673 `--date` option. Possible values are `relative`, `local`,
1674 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1678 Print out the ref names of any commits that are shown by the log
1679 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1680 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1681 specified, the full ref name (including prefix) will be printed.
1682 This is the same as the log commands '--decorate' option.
1685 If true, the initial commit will be shown as a big creation event.
1686 This is equivalent to a diff against an empty tree.
1687 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1688 normally hide the root commit will now show it. True by default.
1691 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1692 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1695 The location of an augmenting mailmap file. The default
1696 mailmap, located in the root of the repository, is loaded
1697 first, then the mailmap file pointed to by this variable.
1698 The location of the mailmap file may be in a repository
1699 subdirectory, or somewhere outside of the repository itself.
1700 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1703 Like `mailmap.file`, but consider the value as a reference to a
1704 blob in the repository. If both `mailmap.file` and
1705 `mailmap.blob` are given, both are parsed, with entries from
1706 `mailmap.file` taking precedence. In a bare repository, this
1707 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1711 Specify the programs that may be used to display help in the
1712 'man' format. See linkgit:git-help[1].
1715 Specify the command to invoke the specified man viewer. The
1716 specified command is evaluated in shell with the man page
1717 passed as argument. (See linkgit:git-help[1].)
1720 Override the path for the given tool that may be used to
1721 display help in the 'man' format. See linkgit:git-help[1].
1723 include::merge-config.txt[]
1725 mergetool.<tool>.path::
1726 Override the path for the given tool. This is useful in case
1727 your tool is not in the PATH.
1729 mergetool.<tool>.cmd::
1730 Specify the command to invoke the specified merge tool. The
1731 specified command is evaluated in shell with the following
1732 variables available: 'BASE' is the name of a temporary file
1733 containing the common base of the files to be merged, if available;
1734 'LOCAL' is the name of a temporary file containing the contents of
1735 the file on the current branch; 'REMOTE' is the name of a temporary
1736 file containing the contents of the file from the branch being
1737 merged; 'MERGED' contains the name of the file to which the merge
1738 tool should write the results of a successful merge.
1740 mergetool.<tool>.trustExitCode::
1741 For a custom merge command, specify whether the exit code of
1742 the merge command can be used to determine whether the merge was
1743 successful. If this is not set to true then the merge target file
1744 timestamp is checked and the merge assumed to have been successful
1745 if the file has been updated, otherwise the user is prompted to
1746 indicate the success of the merge.
1748 mergetool.keepBackup::
1749 After performing a merge, the original file with conflict markers
1750 can be saved as a file with a `.orig` extension. If this variable
1751 is set to `false` then this file is not preserved. Defaults to
1752 `true` (i.e. keep the backup files).
1754 mergetool.keepTemporaries::
1755 When invoking a custom merge tool, Git uses a set of temporary
1756 files to pass to the tool. If the tool returns an error and this
1757 variable is set to `true`, then these temporary files will be
1758 preserved, otherwise they will be removed after the tool has
1759 exited. Defaults to `false`.
1762 Prompt before each invocation of the merge resolution program.
1765 The (fully qualified) refname from which to show notes when
1766 showing commit messages. The value of this variable can be set
1767 to a glob, in which case notes from all matching refs will be
1768 shown. You may also specify this configuration variable
1769 several times. A warning will be issued for refs that do not
1770 exist, but a glob that does not match any refs is silently
1773 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1774 environment variable, which must be a colon separated list of refs or
1777 The effective value of "core.notesRef" (possibly overridden by
1778 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1781 notes.rewrite.<command>::
1782 When rewriting commits with <command> (currently `amend` or
1783 `rebase`) and this variable is set to `true`, Git
1784 automatically copies your notes from the original to the
1785 rewritten commit. Defaults to `true`, but see
1786 "notes.rewriteRef" below.
1789 When copying notes during a rewrite (see the
1790 "notes.rewrite.<command>" option), determines what to do if
1791 the target commit already has a note. Must be one of
1792 `overwrite`, `concatenate`, or `ignore`. Defaults to
1795 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1796 environment variable.
1799 When copying notes during a rewrite, specifies the (fully
1800 qualified) ref whose notes should be copied. The ref may be a
1801 glob, in which case notes in all matching refs will be copied.
1802 You may also specify this configuration several times.
1804 Does not have a default value; you must configure this variable to
1805 enable note rewriting. Set it to `refs/notes/commits` to enable
1806 rewriting for the default commit notes.
1808 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1809 environment variable, which must be a colon separated list of refs or
1813 The size of the window used by linkgit:git-pack-objects[1] when no
1814 window size is given on the command line. Defaults to 10.
1817 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1818 maximum depth is given on the command line. Defaults to 50.
1821 The window memory size limit used by linkgit:git-pack-objects[1]
1822 when no limit is given on the command line. The value can be
1823 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1827 An integer -1..9, indicating the compression level for objects
1828 in a pack file. -1 is the zlib default. 0 means no
1829 compression, and 1..9 are various speed/size tradeoffs, 9 being
1830 slowest. If not set, defaults to core.compression. If that is
1831 not set, defaults to -1, the zlib default, which is "a default
1832 compromise between speed and compression (currently equivalent
1835 Note that changing the compression level will not automatically recompress
1836 all existing objects. You can force recompression by passing the -F option
1837 to linkgit:git-repack[1].
1839 pack.deltaCacheSize::
1840 The maximum memory in bytes used for caching deltas in
1841 linkgit:git-pack-objects[1] before writing them out to a pack.
1842 This cache is used to speed up the writing object phase by not
1843 having to recompute the final delta result once the best match
1844 for all objects is found. Repacking large repositories on machines
1845 which are tight with memory might be badly impacted by this though,
1846 especially if this cache pushes the system into swapping.
1847 A value of 0 means no limit. The smallest size of 1 byte may be
1848 used to virtually disable this cache. Defaults to 256 MiB.
1850 pack.deltaCacheLimit::
1851 The maximum size of a delta, that is cached in
1852 linkgit:git-pack-objects[1]. This cache is used to speed up the
1853 writing object phase by not having to recompute the final delta
1854 result once the best match for all objects is found. Defaults to 1000.
1857 Specifies the number of threads to spawn when searching for best
1858 delta matches. This requires that linkgit:git-pack-objects[1]
1859 be compiled with pthreads otherwise this option is ignored with a
1860 warning. This is meant to reduce packing time on multiprocessor
1861 machines. The required amount of memory for the delta search window
1862 is however multiplied by the number of threads.
1863 Specifying 0 will cause Git to auto-detect the number of CPU's
1864 and set the number of threads accordingly.
1867 Specify the default pack index version. Valid values are 1 for
1868 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1869 the new pack index with capabilities for packs larger than 4 GB
1870 as well as proper protection against the repacking of corrupted
1871 packs. Version 2 is the default. Note that version 2 is enforced
1872 and this config option ignored whenever the corresponding pack is
1875 If you have an old Git that does not understand the version 2 `*.idx` file,
1876 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1877 that will copy both `*.pack` file and corresponding `*.idx` file from the
1878 other side may give you a repository that cannot be accessed with your
1879 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1880 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1883 pack.packSizeLimit::
1884 The maximum size of a pack. This setting only affects
1885 packing to a file when repacking, i.e. the git:// protocol
1886 is unaffected. It can be overridden by the `--max-pack-size`
1887 option of linkgit:git-repack[1]. The minimum size allowed is
1888 limited to 1 MiB. The default is unlimited.
1889 Common unit suffixes of 'k', 'm', or 'g' are
1893 When true, git will use pack bitmaps (if available) when packing
1894 to stdout (e.g., during the server side of a fetch). Defaults to
1895 true. You should not generally need to turn this off unless
1896 you are debugging pack bitmaps.
1899 When true, git will write a bitmap index when packing all
1900 objects to disk (e.g., when `git repack -a` is run). This
1901 index can speed up the "counting objects" phase of subsequent
1902 packs created for clones and fetches, at the cost of some disk
1903 space and extra time spent on the initial repack. Defaults to
1906 pack.writeBitmapHashCache::
1907 When true, git will include a "hash cache" section in the bitmap
1908 index (if one is written). This cache can be used to feed git's
1909 delta heuristics, potentially leading to better deltas between
1910 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1911 between an older, bitmapped pack and objects that have been
1912 pushed since the last gc). The downside is that it consumes 4
1913 bytes per object of disk space, and that JGit's bitmap
1914 implementation does not understand it, causing it to complain if
1915 Git and JGit are used on the same repository. Defaults to false.
1918 If the value is boolean, turns on or off pagination of the
1919 output of a particular Git subcommand when writing to a tty.
1920 Otherwise, turns on pagination for the subcommand using the
1921 pager specified by the value of `pager.<cmd>`. If `--paginate`
1922 or `--no-pager` is specified on the command line, it takes
1923 precedence over this option. To disable pagination for all
1924 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1927 Alias for a --pretty= format string, as specified in
1928 linkgit:git-log[1]. Any aliases defined here can be used just
1929 as the built-in pretty formats could. For example,
1930 running `git config pretty.changelog "format:* %H %s"`
1931 would cause the invocation `git log --pretty=changelog`
1932 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1933 Note that an alias with the same name as a built-in format
1934 will be silently ignored.
1937 By default, Git does not create an extra merge commit when merging
1938 a commit that is a descendant of the current commit. Instead, the
1939 tip of the current branch is fast-forwarded. When set to `false`,
1940 this variable tells Git to create an extra merge commit in such
1941 a case (equivalent to giving the `--no-ff` option from the command
1942 line). When set to `only`, only such fast-forward merges are
1943 allowed (equivalent to giving the `--ff-only` option from the
1947 When true, rebase branches on top of the fetched branch, instead
1948 of merging the default branch from the default remote when "git
1949 pull" is run. See "branch.<name>.rebase" for setting this on a
1952 When preserve, also pass `--preserve-merges` along to 'git rebase'
1953 so that locally committed merge commits will not be flattened
1954 by running 'git pull'.
1956 *NOTE*: this is a possibly dangerous operation; do *not* use
1957 it unless you understand the implications (see linkgit:git-rebase[1]
1961 The default merge strategy to use when pulling multiple branches
1965 The default merge strategy to use when pulling a single branch.
1968 Defines the action `git push` should take if no refspec is
1969 explicitly given. Different values are well-suited for
1970 specific workflows; for instance, in a purely central workflow
1971 (i.e. the fetch source is equal to the push destination),
1972 `upstream` is probably what you want. Possible values are:
1976 * `nothing` - do not push anything (error out) unless a refspec is
1977 explicitly given. This is primarily meant for people who want to
1978 avoid mistakes by always being explicit.
1980 * `current` - push the current branch to update a branch with the same
1981 name on the receiving end. Works in both central and non-central
1984 * `upstream` - push the current branch back to the branch whose
1985 changes are usually integrated into the current branch (which is
1986 called `@{upstream}`). This mode only makes sense if you are
1987 pushing to the same repository you would normally pull from
1988 (i.e. central workflow).
1990 * `simple` - in centralized workflow, work like `upstream` with an
1991 added safety to refuse to push if the upstream branch's name is
1992 different from the local one.
1994 When pushing to a remote that is different from the remote you normally
1995 pull from, work as `current`. This is the safest option and is suited
1998 This mode has become the default in Git 2.0.
2000 * `matching` - push all branches having the same name on both ends.
2001 This makes the repository you are pushing to remember the set of
2002 branches that will be pushed out (e.g. if you always push 'maint'
2003 and 'master' there and no other branches, the repository you push
2004 to will have these two branches, and your local 'maint' and
2005 'master' will be pushed there).
2007 To use this mode effectively, you have to make sure _all_ the
2008 branches you would push out are ready to be pushed out before
2009 running 'git push', as the whole point of this mode is to allow you
2010 to push all of the branches in one go. If you usually finish work
2011 on only one branch and push out the result, while other branches are
2012 unfinished, this mode is not for you. Also this mode is not
2013 suitable for pushing into a shared central repository, as other
2014 people may add new branches there, or update the tip of existing
2015 branches outside your control.
2017 This used to be the default, but not since Git 2.0 (`simple` is the
2023 Whether to show a diffstat of what changed upstream since the last
2024 rebase. False by default.
2027 If set to true enable '--autosquash' option by default.
2030 When set to true, automatically create a temporary stash
2031 before the operation begins, and apply it after the operation
2032 ends. This means that you can run rebase on a dirty worktree.
2033 However, use with care: the final stash application after a
2034 successful rebase might result in non-trivial conflicts.
2038 By default, git-receive-pack will run "git-gc --auto" after
2039 receiving data from git-push and updating refs. You can stop
2040 it by setting this variable to false.
2042 receive.fsckObjects::
2043 If it is set to true, git-receive-pack will check all received
2044 objects. It will abort in the case of a malformed object or a
2045 broken link. The result of an abort are only dangling objects.
2046 Defaults to false. If not set, the value of `transfer.fsckObjects`
2049 receive.unpackLimit::
2050 If the number of objects received in a push is below this
2051 limit then the objects will be unpacked into loose object
2052 files. However if the number of received objects equals or
2053 exceeds this limit then the received pack will be stored as
2054 a pack, after adding any missing delta bases. Storing the
2055 pack from a push can make the push operation complete faster,
2056 especially on slow filesystems. If not set, the value of
2057 `transfer.unpackLimit` is used instead.
2059 receive.denyDeletes::
2060 If set to true, git-receive-pack will deny a ref update that deletes
2061 the ref. Use this to prevent such a ref deletion via a push.
2063 receive.denyDeleteCurrent::
2064 If set to true, git-receive-pack will deny a ref update that
2065 deletes the currently checked out branch of a non-bare repository.
2067 receive.denyCurrentBranch::
2068 If set to true or "refuse", git-receive-pack will deny a ref update
2069 to the currently checked out branch of a non-bare repository.
2070 Such a push is potentially dangerous because it brings the HEAD
2071 out of sync with the index and working tree. If set to "warn",
2072 print a warning of such a push to stderr, but allow the push to
2073 proceed. If set to false or "ignore", allow such pushes with no
2074 message. Defaults to "refuse".
2076 receive.denyNonFastForwards::
2077 If set to true, git-receive-pack will deny a ref update which is
2078 not a fast-forward. Use this to prevent such an update via a push,
2079 even if that push is forced. This configuration variable is
2080 set when initializing a shared repository.
2083 String(s) `receive-pack` uses to decide which refs to omit
2084 from its initial advertisement. Use more than one
2085 definitions to specify multiple prefix strings. A ref that
2086 are under the hierarchies listed on the value of this
2087 variable is excluded, and is hidden when responding to `git
2088 push`, and an attempt to update or delete a hidden ref by
2089 `git push` is rejected.
2091 receive.updateserverinfo::
2092 If set to true, git-receive-pack will run git-update-server-info
2093 after receiving data from git-push and updating refs.
2095 receive.shallowupdate::
2096 If set to true, .git/shallow can be updated when new refs
2097 require new shallow roots. Otherwise those refs are rejected.
2099 remote.pushdefault::
2100 The remote to push to by default. Overrides
2101 `branch.<name>.remote` for all branches, and is overridden by
2102 `branch.<name>.pushremote` for specific branches.
2105 The URL of a remote repository. See linkgit:git-fetch[1] or
2106 linkgit:git-push[1].
2108 remote.<name>.pushurl::
2109 The push URL of a remote repository. See linkgit:git-push[1].
2111 remote.<name>.proxy::
2112 For remotes that require curl (http, https and ftp), the URL to
2113 the proxy to use for that remote. Set to the empty string to
2114 disable proxying for that remote.
2116 remote.<name>.fetch::
2117 The default set of "refspec" for linkgit:git-fetch[1]. See
2118 linkgit:git-fetch[1].
2120 remote.<name>.push::
2121 The default set of "refspec" for linkgit:git-push[1]. See
2122 linkgit:git-push[1].
2124 remote.<name>.mirror::
2125 If true, pushing to this remote will automatically behave
2126 as if the `--mirror` option was given on the command line.
2128 remote.<name>.skipDefaultUpdate::
2129 If true, this remote will be skipped by default when updating
2130 using linkgit:git-fetch[1] or the `update` subcommand of
2131 linkgit:git-remote[1].
2133 remote.<name>.skipFetchAll::
2134 If true, this remote will be skipped by default when updating
2135 using linkgit:git-fetch[1] or the `update` subcommand of
2136 linkgit:git-remote[1].
2138 remote.<name>.receivepack::
2139 The default program to execute on the remote side when pushing. See
2140 option \--receive-pack of linkgit:git-push[1].
2142 remote.<name>.uploadpack::
2143 The default program to execute on the remote side when fetching. See
2144 option \--upload-pack of linkgit:git-fetch-pack[1].
2146 remote.<name>.tagopt::
2147 Setting this value to \--no-tags disables automatic tag following when
2148 fetching from remote <name>. Setting it to \--tags will fetch every
2149 tag from remote <name>, even if they are not reachable from remote
2150 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2151 override this setting. See options \--tags and \--no-tags of
2152 linkgit:git-fetch[1].
2155 Setting this to a value <vcs> will cause Git to interact with
2156 the remote with the git-remote-<vcs> helper.
2158 remote.<name>.prune::
2159 When set to true, fetching from this remote by default will also
2160 remove any remote-tracking references that no longer exist on the
2161 remote (as if the `--prune` option was given on the command line).
2162 Overrides `fetch.prune` settings, if any.
2165 The list of remotes which are fetched by "git remote update
2166 <group>". See linkgit:git-remote[1].
2168 repack.usedeltabaseoffset::
2169 By default, linkgit:git-repack[1] creates packs that use
2170 delta-base offset. If you need to share your repository with
2171 Git older than version 1.4.4, either directly or via a dumb
2172 protocol such as http, then you need to set this option to
2173 "false" and repack. Access from old Git versions over the
2174 native protocol are unaffected by this option.
2176 repack.packKeptObjects::
2177 If set to true, makes `git repack` act as if
2178 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2179 details. Defaults to `false` normally, but `true` if a bitmap
2180 index is being written (either via `--write-bitmap-index` or
2181 `pack.writeBitmaps`).
2184 When set to true, `git-rerere` updates the index with the
2185 resulting contents after it cleanly resolves conflicts using
2186 previously recorded resolution. Defaults to false.
2189 Activate recording of resolved conflicts, so that identical
2190 conflict hunks can be resolved automatically, should they be
2191 encountered again. By default, linkgit:git-rerere[1] is
2192 enabled if there is an `rr-cache` directory under the
2193 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2196 sendemail.identity::
2197 A configuration identity. When given, causes values in the
2198 'sendemail.<identity>' subsection to take precedence over
2199 values in the 'sendemail' section. The default identity is
2200 the value of 'sendemail.identity'.
2202 sendemail.smtpencryption::
2203 See linkgit:git-send-email[1] for description. Note that this
2204 setting is not subject to the 'identity' mechanism.
2207 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2209 sendemail.smtpsslcertpath::
2210 Path to ca-certificates (either a directory or a single file).
2211 Set it to an empty string to disable certificate verification.
2213 sendemail.<identity>.*::
2214 Identity-specific versions of the 'sendemail.*' parameters
2215 found below, taking precedence over those when the this
2216 identity is selected, through command-line or
2217 'sendemail.identity'.
2219 sendemail.aliasesfile::
2220 sendemail.aliasfiletype::
2221 sendemail.annotate::
2225 sendemail.chainreplyto::
2227 sendemail.envelopesender::
2229 sendemail.multiedit::
2230 sendemail.signedoffbycc::
2231 sendemail.smtppass::
2232 sendemail.suppresscc::
2233 sendemail.suppressfrom::
2235 sendemail.smtpdomain::
2236 sendemail.smtpserver::
2237 sendemail.smtpserverport::
2238 sendemail.smtpserveroption::
2239 sendemail.smtpuser::
2241 sendemail.validate::
2242 See linkgit:git-send-email[1] for description.
2244 sendemail.signedoffcc::
2245 Deprecated alias for 'sendemail.signedoffbycc'.
2247 showbranch.default::
2248 The default set of branches for linkgit:git-show-branch[1].
2249 See linkgit:git-show-branch[1].
2251 status.relativePaths::
2252 By default, linkgit:git-status[1] shows paths relative to the
2253 current directory. Setting this variable to `false` shows paths
2254 relative to the repository root (this was the default for Git
2258 Set to true to enable --short by default in linkgit:git-status[1].
2259 The option --no-short takes precedence over this variable.
2262 Set to true to enable --branch by default in linkgit:git-status[1].
2263 The option --no-branch takes precedence over this variable.
2265 status.displayCommentPrefix::
2266 If set to true, linkgit:git-status[1] will insert a comment
2267 prefix before each output line (starting with
2268 `core.commentChar`, i.e. `#` by default). This was the
2269 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2272 status.showUntrackedFiles::
2273 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2274 files which are not currently tracked by Git. Directories which
2275 contain only untracked files, are shown with the directory name
2276 only. Showing untracked files means that Git needs to lstat() all
2277 all the files in the whole repository, which might be slow on some
2278 systems. So, this variable controls how the commands displays
2279 the untracked files. Possible values are:
2282 * `no` - Show no untracked files.
2283 * `normal` - Show untracked files and directories.
2284 * `all` - Show also individual files in untracked directories.
2287 If this variable is not specified, it defaults to 'normal'.
2288 This variable can be overridden with the -u|--untracked-files option
2289 of linkgit:git-status[1] and linkgit:git-commit[1].
2291 status.submodulesummary::
2293 If this is set to a non zero number or true (identical to -1 or an
2294 unlimited number), the submodule summary will be enabled and a
2295 summary of commits for modified submodules will be shown (see
2296 --summary-limit option of linkgit:git-submodule[1]). Please note
2297 that the summary output command will be suppressed for all
2298 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2299 for those submodules where `submodule.<name>.ignore=all`. To
2300 also view the summary for ignored submodules you can either use
2301 the --ignore-submodules=dirty command line option or the 'git
2302 submodule summary' command, which shows a similar output but does
2303 not honor these settings.
2305 submodule.<name>.path::
2306 submodule.<name>.url::
2307 submodule.<name>.update::
2308 The path within this project, URL, and the updating strategy
2309 for a submodule. These variables are initially populated
2310 by 'git submodule init'; edit them to override the
2311 URL and other values found in the `.gitmodules` file. See
2312 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2314 submodule.<name>.branch::
2315 The remote branch name for a submodule, used by `git submodule
2316 update --remote`. Set this option to override the value found in
2317 the `.gitmodules` file. See linkgit:git-submodule[1] and
2318 linkgit:gitmodules[5] for details.
2320 submodule.<name>.fetchRecurseSubmodules::
2321 This option can be used to control recursive fetching of this
2322 submodule. It can be overridden by using the --[no-]recurse-submodules
2323 command line option to "git fetch" and "git pull".
2324 This setting will override that from in the linkgit:gitmodules[5]
2327 submodule.<name>.ignore::
2328 Defines under what circumstances "git status" and the diff family show
2329 a submodule as modified. When set to "all", it will never be considered
2330 modified, "dirty" will ignore all changes to the submodules work tree and
2331 takes only differences between the HEAD of the submodule and the commit
2332 recorded in the superproject into account. "untracked" will additionally
2333 let submodules with modified tracked files in their work tree show up.
2334 Using "none" (the default when this option is not set) also shows
2335 submodules that have untracked files in their work tree as changed.
2336 This setting overrides any setting made in .gitmodules for this submodule,
2337 both settings can be overridden on the command line by using the
2338 "--ignore-submodules" option. The 'git submodule' commands are not
2339 affected by this setting.
2342 This variable can be used to restrict the permission bits of
2343 tar archive entries. The default is 0002, which turns off the
2344 world write bit. The special value "user" indicates that the
2345 archiving user's umask will be used instead. See umask(2) and
2346 linkgit:git-archive[1].
2348 transfer.fsckObjects::
2349 When `fetch.fsckObjects` or `receive.fsckObjects` are
2350 not set, the value of this variable is used instead.
2354 This variable can be used to set both `receive.hiderefs`
2355 and `uploadpack.hiderefs` at the same time to the same
2356 values. See entries for these other variables.
2358 transfer.unpackLimit::
2359 When `fetch.unpackLimit` or `receive.unpackLimit` are
2360 not set, the value of this variable is used instead.
2361 The default value is 100.
2363 uploadarchive.allowUnreachable::
2364 If true, allow clients to use `git archive --remote` to request
2365 any tree, whether reachable from the ref tips or not. See the
2366 discussion in the `SECURITY` section of
2367 linkgit:git-upload-archive[1] for more details. Defaults to
2370 uploadpack.hiderefs::
2371 String(s) `upload-pack` uses to decide which refs to omit
2372 from its initial advertisement. Use more than one
2373 definitions to specify multiple prefix strings. A ref that
2374 are under the hierarchies listed on the value of this
2375 variable is excluded, and is hidden from `git ls-remote`,
2376 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2377 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2379 uploadpack.allowtipsha1inwant::
2380 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2381 to accept a fetch request that asks for an object at the tip
2382 of a hidden ref (by default, such a request is rejected).
2383 see also `uploadpack.hiderefs`.
2385 uploadpack.keepalive::
2386 When `upload-pack` has started `pack-objects`, there may be a
2387 quiet period while `pack-objects` prepares the pack. Normally
2388 it would output progress information, but if `--quiet` was used
2389 for the fetch, `pack-objects` will output nothing at all until
2390 the pack data begins. Some clients and networks may consider
2391 the server to be hung and give up. Setting this option instructs
2392 `upload-pack` to send an empty keepalive packet every
2393 `uploadpack.keepalive` seconds. Setting this option to 0
2394 disables keepalive packets entirely. The default is 5 seconds.
2396 url.<base>.insteadOf::
2397 Any URL that starts with this value will be rewritten to
2398 start, instead, with <base>. In cases where some site serves a
2399 large number of repositories, and serves them with multiple
2400 access methods, and some users need to use different access
2401 methods, this feature allows people to specify any of the
2402 equivalent URLs and have Git automatically rewrite the URL to
2403 the best alternative for the particular user, even for a
2404 never-before-seen repository on the site. When more than one
2405 insteadOf strings match a given URL, the longest match is used.
2407 url.<base>.pushInsteadOf::
2408 Any URL that starts with this value will not be pushed to;
2409 instead, it will be rewritten to start with <base>, and the
2410 resulting URL will be pushed to. In cases where some site serves
2411 a large number of repositories, and serves them with multiple
2412 access methods, some of which do not allow push, this feature
2413 allows people to specify a pull-only URL and have Git
2414 automatically use an appropriate URL to push, even for a
2415 never-before-seen repository on the site. When more than one
2416 pushInsteadOf strings match a given URL, the longest match is
2417 used. If a remote has an explicit pushurl, Git will ignore this
2418 setting for that remote.
2421 Your email address to be recorded in any newly created commits.
2422 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2423 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2426 Your full name to be recorded in any newly created commits.
2427 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2428 environment variables. See linkgit:git-commit-tree[1].
2431 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2432 key you want it to automatically when creating a signed tag or
2433 commit, you can override the default selection with this variable.
2434 This option is passed unchanged to gpg's --local-user parameter,
2435 so you may specify a key using any method that gpg supports.
2438 Specify a web browser that may be used by some commands.
2439 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]