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 (Windows-only) If true (which is the default), mark newly-created
217 directories and files whose name starts with a dot as hidden.
218 If 'dotGitOnly', only the .git/ directory is hidden, but no other
219 files starting with a dot.
222 If true, this option enables various workarounds to enable
223 Git to work better on filesystems that are not case sensitive,
224 like FAT. For example, if a directory listing finds
225 "makefile" when Git expects "Makefile", Git will assume
226 it is really the same file, and continue to remember it as
229 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
230 will probe and set core.ignorecase true if appropriate when the repository
233 core.precomposeunicode::
234 This option is only used by Mac OS implementation of Git.
235 When core.precomposeunicode=true, Git reverts the unicode decomposition
236 of filenames done by Mac OS. This is useful when sharing a repository
237 between Mac OS and Linux or Windows.
238 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
239 When false, file names are handled fully transparent by Git,
240 which is backward compatible with older versions of Git.
243 If false, the ctime differences between the index and the
244 working tree are ignored; useful when the inode change time
245 is regularly modified by something outside Git (file system
246 crawlers and some backup systems).
247 See linkgit:git-update-index[1]. True by default.
250 Determines which stat fields to match between the index
251 and work tree. The user can set this to 'default' or
252 'minimal'. Default (or explicitly 'default'), is to check
253 all fields, including the sub-second part of mtime and ctime.
256 The commands that output paths (e.g. 'ls-files',
257 'diff'), when not given the `-z` option, will quote
258 "unusual" characters in the pathname by enclosing the
259 pathname in a double-quote pair and with backslashes the
260 same way strings in C source code are quoted. If this
261 variable is set to false, the bytes higher than 0x80 are
262 not quoted but output as verbatim. Note that double
263 quote, backslash and control characters are always
264 quoted without `-z` regardless of the setting of this
268 Sets the line ending type to use in the working directory for
269 files that have the `text` property set. Alternatives are
270 'lf', 'crlf' and 'native', which uses the platform's native
271 line ending. The default value is `native`. See
272 linkgit:gitattributes[5] for more information on end-of-line
276 If true, makes Git check if converting `CRLF` is reversible when
277 end-of-line conversion is active. Git will verify if a command
278 modifies a file in the work tree either directly or indirectly.
279 For example, committing a file followed by checking out the
280 same file should yield the original file in the work tree. If
281 this is not the case for the current setting of
282 `core.autocrlf`, Git will reject the file. The variable can
283 be set to "warn", in which case Git will only warn about an
284 irreversible conversion but continue the operation.
286 CRLF conversion bears a slight chance of corrupting data.
287 When it is enabled, Git will convert CRLF to LF during commit and LF to
288 CRLF during checkout. A file that contains a mixture of LF and
289 CRLF before the commit cannot be recreated by Git. For text
290 files this is the right thing to do: it corrects line endings
291 such that we have only LF line endings in the repository.
292 But for binary files that are accidentally classified as text the
293 conversion can corrupt data.
295 If you recognize such corruption early you can easily fix it by
296 setting the conversion type explicitly in .gitattributes. Right
297 after committing you still have the original file in your work
298 tree and this file is not yet corrupted. You can explicitly tell
299 Git that this file is binary and Git will handle the file
302 Unfortunately, the desired effect of cleaning up text files with
303 mixed line endings and the undesired effect of corrupting binary
304 files cannot be distinguished. In both cases CRLFs are removed
305 in an irreversible way. For text files this is the right thing
306 to do because CRLFs are line endings, while for binary files
307 converting CRLFs corrupts data.
309 Note, this safety check does not mean that a checkout will generate a
310 file identical to the original file for a different setting of
311 `core.eol` and `core.autocrlf`, but only for the current one. For
312 example, a text file with `LF` would be accepted with `core.eol=lf`
313 and could later be checked out with `core.eol=crlf`, in which case the
314 resulting file would contain `CRLF`, although the original file
315 contained `LF`. However, in both work trees the line endings would be
316 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
317 file with mixed line endings would be reported by the `core.safecrlf`
321 Setting this variable to "true" is almost the same as setting
322 the `text` attribute to "auto" on all files except that text
323 files are not guaranteed to be normalized: files that contain
324 `CRLF` in the repository will not be touched. Use this
325 setting if you want to have `CRLF` line endings in your
326 working directory even though the repository does not have
327 normalized line endings. This variable can be set to 'input',
328 in which case no output conversion is performed.
331 If false, symbolic links are checked out as small plain files that
332 contain the link text. linkgit:git-update-index[1] and
333 linkgit:git-add[1] will not change the recorded type to regular
334 file. Useful on filesystems like FAT that do not support
337 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
338 will probe and set core.symlinks false if appropriate when the repository
342 A "proxy command" to execute (as 'command host port') instead
343 of establishing direct connection to the remote server when
344 using the Git protocol for fetching. If the variable value is
345 in the "COMMAND for DOMAIN" format, the command is applied only
346 on hostnames ending with the specified domain string. This variable
347 may be set multiple times and is matched in the given order;
348 the first match wins.
350 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
351 (which always applies universally, without the special "for"
354 The special string `none` can be used as the proxy command to
355 specify that no proxy be used for a given domain pattern.
356 This is useful for excluding servers inside a firewall from
357 proxy use, while defaulting to a common proxy for external domains.
360 If true, commands which modify both the working tree and the index
361 will mark the updated paths with the "assume unchanged" bit in the
362 index. These marked files are then assumed to stay unchanged in the
363 working tree, until you mark them otherwise manually - Git will not
364 detect the file changes by lstat() calls. This is useful on systems
365 where those are very slow, such as Microsoft Windows.
366 See linkgit:git-update-index[1].
369 core.preferSymlinkRefs::
370 Instead of the default "symref" format for HEAD
371 and other symbolic reference files, use symbolic links.
372 This is sometimes needed to work with old scripts that
373 expect HEAD to be a symbolic link.
376 If true this repository is assumed to be 'bare' and has no
377 working directory associated with it. If this is the case a
378 number of commands that require a working directory will be
379 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
381 This setting is automatically guessed by linkgit:git-clone[1] or
382 linkgit:git-init[1] when the repository was created. By default a
383 repository that ends in "/.git" is assumed to be not bare (bare =
384 false), while all other repositories are assumed to be bare (bare
388 Set the path to the root of the working tree.
389 This can be overridden by the GIT_WORK_TREE environment
390 variable and the '--work-tree' command-line option.
391 The value can be an absolute path or relative to the path to
392 the .git directory, which is either specified by --git-dir
393 or GIT_DIR, or automatically discovered.
394 If --git-dir or GIT_DIR is specified but none of
395 --work-tree, GIT_WORK_TREE and core.worktree is specified,
396 the current working directory is regarded as the top level
397 of your working tree.
399 Note that this variable is honored even when set in a configuration
400 file in a ".git" subdirectory of a directory and its value differs
401 from the latter directory (e.g. "/path/to/.git/config" has
402 core.worktree set to "/different/path"), which is most likely a
403 misconfiguration. Running Git commands in the "/path/to" directory will
404 still use "/different/path" as the root of the work tree and can cause
405 confusion unless you know what you are doing (e.g. you are creating a
406 read-only snapshot of the same index to a location different from the
407 repository's usual working tree).
409 core.logAllRefUpdates::
410 Enable the reflog. Updates to a ref <ref> is logged to the file
411 "$GIT_DIR/logs/<ref>", by appending the new and old
412 SHA-1, the date/time and the reason of the update, but
413 only when the file exists. If this configuration
414 variable is set to true, missing "$GIT_DIR/logs/<ref>"
415 file is automatically created for branch heads (i.e. under
416 refs/heads/), remote refs (i.e. under refs/remotes/),
417 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
419 This information can be used to determine what commit
420 was the tip of a branch "2 days ago".
422 This value is true by default in a repository that has
423 a working directory associated with it, and false by
424 default in a bare repository.
426 core.repositoryFormatVersion::
427 Internal variable identifying the repository format and layout
430 core.sharedRepository::
431 When 'group' (or 'true'), the repository is made shareable between
432 several users in a group (making sure all the files and objects are
433 group-writable). When 'all' (or 'world' or 'everybody'), the
434 repository will be readable by all users, additionally to being
435 group-shareable. When 'umask' (or 'false'), Git will use permissions
436 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
437 files in the repository will have this mode value. '0xxx' will override
438 user's umask value (whereas the other options will only override
439 requested parts of the user's umask value). Examples: '0660' will make
440 the repo read/write-able for the owner and group, but inaccessible to
441 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
442 repository that is group-readable but not group-writable.
443 See linkgit:git-init[1]. False by default.
445 core.warnAmbiguousRefs::
446 If true, Git will warn you if the ref name you passed it is ambiguous
447 and might match multiple refs in the repository. True by default.
450 An integer -1..9, indicating a default compression level.
451 -1 is the zlib default. 0 means no compression,
452 and 1..9 are various speed/size tradeoffs, 9 being slowest.
453 If set, this provides a default to other compression variables,
454 such as 'core.loosecompression' and 'pack.compression'.
456 core.loosecompression::
457 An integer -1..9, indicating the compression level for objects that
458 are not in a pack file. -1 is the zlib default. 0 means no
459 compression, and 1..9 are various speed/size tradeoffs, 9 being
460 slowest. If not set, defaults to core.compression. If that is
461 not set, defaults to 1 (best speed).
463 core.packedGitWindowSize::
464 Number of bytes of a pack file to map into memory in a
465 single mapping operation. Larger window sizes may allow
466 your system to process a smaller number of large pack files
467 more quickly. Smaller window sizes will negatively affect
468 performance due to increased calls to the operating system's
469 memory manager, but may improve performance when accessing
470 a large number of large pack files.
472 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
473 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
474 be reasonable for all users/operating systems. You probably do
475 not need to adjust this value.
477 Common unit suffixes of 'k', 'm', or 'g' are supported.
479 core.packedGitLimit::
480 Maximum number of bytes to map simultaneously into memory
481 from pack files. If Git needs to access more than this many
482 bytes at once to complete an operation it will unmap existing
483 regions to reclaim virtual address space within the process.
485 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
486 This should be reasonable for all users/operating systems, except on
487 the largest projects. You probably do not need to adjust this value.
489 Common unit suffixes of 'k', 'm', or 'g' are supported.
491 core.deltaBaseCacheLimit::
492 Maximum number of bytes to reserve for caching base objects
493 that may be referenced by multiple deltified objects. By storing the
494 entire decompressed base objects in a cache Git is able
495 to avoid unpacking and decompressing frequently used base
496 objects multiple times.
498 Default is 96 MiB on all platforms. This should be reasonable
499 for all users/operating systems, except on the largest projects.
500 You probably do not need to adjust this value.
502 Common unit suffixes of 'k', 'm', or 'g' are supported.
504 core.bigFileThreshold::
505 Files larger than this size are stored deflated, without
506 attempting delta compression. Storing large files without
507 delta compression avoids excessive memory usage, at the
508 slight expense of increased disk usage.
510 Default is 512 MiB on all platforms. This should be reasonable
511 for most projects as source code and other text files can still
512 be delta compressed, but larger binary media files won't be.
514 Common unit suffixes of 'k', 'm', or 'g' are supported.
517 In addition to '.gitignore' (per-directory) and
518 '.git/info/exclude', Git looks into this file for patterns
519 of files which are not meant to be tracked. "`~/`" is expanded
520 to the value of `$HOME` and "`~user/`" to the specified user's
521 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
522 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
523 is used instead. See linkgit:gitignore[5].
526 Some commands (e.g. svn and http interfaces) that interactively
527 ask for a password can be told to use an external program given
528 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
529 environment variable. If not set, fall back to the value of the
530 'SSH_ASKPASS' environment variable or, failing that, a simple password
531 prompt. The external program shall be given a suitable prompt as
532 command-line argument and write the password on its STDOUT.
534 core.attributesfile::
535 In addition to '.gitattributes' (per-directory) and
536 '.git/info/attributes', Git looks into this file for attributes
537 (see linkgit:gitattributes[5]). Path expansions are made the same
538 way as for `core.excludesfile`. Its default value is
539 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
540 set or empty, $HOME/.config/git/attributes is used instead.
543 Commands such as `commit` and `tag` that lets you edit
544 messages by launching an editor uses the value of this
545 variable when it is set, and the environment variable
546 `GIT_EDITOR` is not set. See linkgit:git-var[1].
549 Commands such as `commit` and `tag` that lets you edit
550 messages consider a line that begins with this character
551 commented, and removes them after the editor returns
554 If set to "auto", `git-commit` would select a character that is not
555 the beginning character of any line in existing commit messages.
558 Text editor used by `git rebase -i` for editing the rebase instruction file.
559 The value is meant to be interpreted by the shell when it is used.
560 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
561 When not configured the default commit message editor is used instead.
564 Text viewer for use by Git commands (e.g., 'less'). The value
565 is meant to be interpreted by the shell. The order of preference
566 is the `$GIT_PAGER` environment variable, then `core.pager`
567 configuration, then `$PAGER`, and then the default chosen at
568 compile time (usually 'less').
570 When the `LESS` environment variable is unset, Git sets it to `FRX`
571 (if `LESS` environment variable is set, Git does not change it at
572 all). If you want to selectively override Git's default setting
573 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
574 be passed to the shell by Git, which will translate the final
575 command to `LESS=FRX less -S`. The environment does not set the
576 `S` option but the command line does, instructing less to truncate
577 long lines. Similarly, setting `core.pager` to `less -+F` will
578 deactivate the `F` option specified by the environment from the
579 command-line, deactivating the "quit if one screen" behavior of
580 `less`. One can specifically activate some flags for particular
581 commands: for example, setting `pager.blame` to `less -S` enables
582 line truncation only for `git blame`.
584 Likewise, when the `LV` environment variable is unset, Git sets it
585 to `-c`. You can override this setting by exporting `LV` with
586 another value or setting `core.pager` to `lv +c`.
589 A comma separated list of common whitespace problems to
590 notice. 'git diff' will use `color.diff.whitespace` to
591 highlight them, and 'git apply --whitespace=error' will
592 consider them as errors. You can prefix `-` to disable
593 any of them (e.g. `-trailing-space`):
595 * `blank-at-eol` treats trailing whitespaces at the end of the line
596 as an error (enabled by default).
597 * `space-before-tab` treats a space character that appears immediately
598 before a tab character in the initial indent part of the line as an
599 error (enabled by default).
600 * `indent-with-non-tab` treats a line that is indented with space
601 characters instead of the equivalent tabs as an error (not enabled by
603 * `tab-in-indent` treats a tab character in the initial indent part of
604 the line as an error (not enabled by default).
605 * `blank-at-eof` treats blank lines added at the end of file as an error
606 (enabled by default).
607 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
609 * `cr-at-eol` treats a carriage-return at the end of line as
610 part of the line terminator, i.e. with it, `trailing-space`
611 does not trigger if the character before such a carriage-return
612 is not a whitespace (not enabled by default).
613 * `tabwidth=<n>` tells how many character positions a tab occupies; this
614 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
615 errors. The default tab width is 8. Allowed values are 1 to 63.
617 core.fsyncobjectfiles::
618 This boolean will enable 'fsync()' when writing object files.
620 This is a total waste of time and effort on a filesystem that orders
621 data writes properly, but can be useful for filesystems that do not use
622 journalling (traditional UNIX filesystems) or that only journal metadata
623 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
626 Enable parallel index preload for operations like 'git diff'
628 This can speed up operations like 'git diff' and 'git status' especially
629 on filesystems like NFS that have weak caching semantics and thus
630 relatively high IO latencies. When enabled, Git will do the
631 index comparison to the filesystem data in parallel, allowing
632 overlapping IO's. Defaults to true.
635 Enable additional caching of file system data for some operations.
637 Git for Windows uses this to bulk-read and cache lstat data of entire
638 directories (instead of doing lstat file by file).
641 Enable long path (> 260) support for builtin commands in Git for
642 Windows. This is disabled by default, as long paths are not supported
643 by Windows Explorer, cmd.exe and the Git for Windows tool chain
644 (msys, bash, tcl, perl...). Only enable this if you know what you're
645 doing and are prepared to live with a few quirks.
648 You can set this to 'link', in which case a hardlink followed by
649 a delete of the source are used to make sure that object creation
650 will not overwrite existing objects.
652 On some file system/operating system combinations, this is unreliable.
653 Set this config setting to 'rename' there; However, This will remove the
654 check that makes sure that existing object files will not get overwritten.
657 When showing commit messages, also show notes which are stored in
658 the given ref. The ref must be fully qualified. If the given
659 ref does not exist, it is not an error but means that no
660 notes should be printed.
662 This setting defaults to "refs/notes/commits", and it can be overridden by
663 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
665 core.sparseCheckout::
666 Enable "sparse checkout" feature. See section "Sparse checkout" in
667 linkgit:git-read-tree[1] for more information.
670 Set the length object names are abbreviated to. If unspecified,
671 many commands abbreviate to 7 hexdigits, which may not be enough
672 for abbreviated object names to stay unique for sufficiently long
677 Tells 'git add' to continue adding files when some files cannot be
678 added due to indexing errors. Equivalent to the '--ignore-errors'
679 option of linkgit:git-add[1]. Older versions of Git accept only
680 `add.ignore-errors`, which does not follow the usual naming
681 convention for configuration variables. Newer versions of Git
682 honor `add.ignoreErrors` as well.
685 Command aliases for the linkgit:git[1] command wrapper - e.g.
686 after defining "alias.last = cat-file commit HEAD", the invocation
687 "git last" is equivalent to "git cat-file commit HEAD". To avoid
688 confusion and troubles with script usage, aliases that
689 hide existing Git commands are ignored. Arguments are split by
690 spaces, the usual shell quoting and escaping is supported.
691 quote pair and a backslash can be used to quote them.
693 If the alias expansion is prefixed with an exclamation point,
694 it will be treated as a shell command. For example, defining
695 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
696 "git new" is equivalent to running the shell command
697 "gitk --all --not ORIG_HEAD". Note that shell commands will be
698 executed from the top-level directory of a repository, which may
699 not necessarily be the current directory.
700 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
701 from the original current directory. See linkgit:git-rev-parse[1].
704 If true, git-am will call git-mailsplit for patches in mbox format
705 with parameter '--keep-cr'. In this case git-mailsplit will
706 not remove `\r` from lines ending with `\r\n`. Can be overridden
707 by giving '--no-keep-cr' from the command line.
708 See linkgit:git-am[1], linkgit:git-mailsplit[1].
710 apply.ignorewhitespace::
711 When set to 'change', tells 'git apply' to ignore changes in
712 whitespace, in the same way as the '--ignore-space-change'
714 When set to one of: no, none, never, false tells 'git apply' to
715 respect all whitespace differences.
716 See linkgit:git-apply[1].
719 Tells 'git apply' how to handle whitespaces, in the same way
720 as the '--whitespace' option. See linkgit:git-apply[1].
722 branch.autosetupmerge::
723 Tells 'git branch' and 'git checkout' to set up new branches
724 so that linkgit:git-pull[1] will appropriately merge from the
725 starting point branch. Note that even if this option is not set,
726 this behavior can be chosen per-branch using the `--track`
727 and `--no-track` options. The valid settings are: `false` -- no
728 automatic setup is done; `true` -- automatic setup is done when the
729 starting point is a remote-tracking branch; `always` --
730 automatic setup is done when the starting point is either a
731 local branch or remote-tracking
732 branch. This option defaults to true.
734 branch.autosetuprebase::
735 When a new branch is created with 'git branch' or 'git checkout'
736 that tracks another branch, this variable tells Git to set
737 up pull to rebase instead of merge (see "branch.<name>.rebase").
738 When `never`, rebase is never automatically set to true.
739 When `local`, rebase is set to true for tracked branches of
740 other local branches.
741 When `remote`, rebase is set to true for tracked branches of
742 remote-tracking branches.
743 When `always`, rebase will be set to true for all tracking
745 See "branch.autosetupmerge" for details on how to set up a
746 branch to track another branch.
747 This option defaults to never.
749 branch.<name>.remote::
750 When on branch <name>, it tells 'git fetch' and 'git push'
751 which remote to fetch from/push to. The remote to push to
752 may be overridden with `remote.pushdefault` (for all branches).
753 The remote to push to, for the current branch, may be further
754 overridden by `branch.<name>.pushremote`. If no remote is
755 configured, or if you are not on any branch, it defaults to
756 `origin` for fetching and `remote.pushdefault` for pushing.
757 Additionally, `.` (a period) is the current local repository
758 (a dot-repository), see `branch.<name>.merge`'s final note below.
760 branch.<name>.pushremote::
761 When on branch <name>, it overrides `branch.<name>.remote` for
762 pushing. It also overrides `remote.pushdefault` for pushing
763 from branch <name>. When you pull from one place (e.g. your
764 upstream) and push to another place (e.g. your own publishing
765 repository), you would want to set `remote.pushdefault` to
766 specify the remote to push to for all branches, and use this
767 option to override it for a specific branch.
769 branch.<name>.merge::
770 Defines, together with branch.<name>.remote, the upstream branch
771 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
772 branch to merge and can also affect 'git push' (see push.default).
773 When in branch <name>, it tells 'git fetch' the default
774 refspec to be marked for merging in FETCH_HEAD. The value is
775 handled like the remote part of a refspec, and must match a
776 ref which is fetched from the remote given by
777 "branch.<name>.remote".
778 The merge information is used by 'git pull' (which at first calls
779 'git fetch') to lookup the default branch for merging. Without
780 this option, 'git pull' defaults to merge the first refspec fetched.
781 Specify multiple values to get an octopus merge.
782 If you wish to setup 'git pull' so that it merges into <name> from
783 another branch in the local repository, you can point
784 branch.<name>.merge to the desired branch, and use the relative path
785 setting `.` (a period) for branch.<name>.remote.
787 branch.<name>.mergeoptions::
788 Sets default options for merging into branch <name>. The syntax and
789 supported options are the same as those of linkgit:git-merge[1], but
790 option values containing whitespace characters are currently not
793 branch.<name>.rebase::
794 When true, rebase the branch <name> on top of the fetched branch,
795 instead of merging the default branch from the default remote when
796 "git pull" is run. See "pull.rebase" for doing this in a non
797 branch-specific manner.
798 When the value is `interactive`, the rebase is run in interactive mode.
800 When preserve, also pass `--preserve-merges` along to 'git rebase'
801 so that locally committed merge commits will not be flattened
802 by running 'git pull'.
804 *NOTE*: this is a possibly dangerous operation; do *not* use
805 it unless you understand the implications (see linkgit:git-rebase[1]
808 branch.<name>.description::
809 Branch description, can be edited with
810 `git branch --edit-description`. Branch description is
811 automatically added in the format-patch cover letter or
812 request-pull summary.
815 Specify the command to invoke the specified browser. The
816 specified command is evaluated in shell with the URLs passed
817 as arguments. (See linkgit:git-web{litdd}browse[1].)
819 browser.<tool>.path::
820 Override the path for the given tool that may be used to
821 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
822 working repository in gitweb (see linkgit:git-instaweb[1]).
825 A boolean to make git-clean do nothing unless given -f,
826 -i or -n. Defaults to true.
829 A boolean to enable/disable color in the output of
830 linkgit:git-branch[1]. May be set to `always`,
831 `false` (or `never`) or `auto` (or `true`), in which case colors are used
832 only when the output is to a terminal. Defaults to false.
834 color.branch.<slot>::
835 Use customized color for branch coloration. `<slot>` is one of
836 `current` (the current branch), `local` (a local branch),
837 `remote` (a remote-tracking branch in refs/remotes/),
838 `upstream` (upstream tracking branch), `plain` (other
841 The value for these configuration variables is a list of colors (at most
842 two) and attributes (at most one), separated by spaces. The colors
843 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
844 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
845 `blink` and `reverse`. The first color given is the foreground; the
846 second is the background. The position of the attribute, if any,
850 Whether to use ANSI escape sequences to add color to patches.
851 If this is set to `always`, linkgit:git-diff[1],
852 linkgit:git-log[1], and linkgit:git-show[1] will use color
853 for all patches. If it is set to `true` or `auto`, those
854 commands will only use color when output is to the terminal.
857 This does not affect linkgit:git-format-patch[1] or the
858 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
859 command line with the `--color[=<when>]` option.
862 Use customized color for diff colorization. `<slot>` specifies
863 which part of the patch to use the specified color, and is one
864 of `plain` (context text), `meta` (metainformation), `frag`
865 (hunk header), 'func' (function in hunk header), `old` (removed lines),
866 `new` (added lines), `commit` (commit headers), or `whitespace`
867 (highlighting whitespace errors). The values of these variables may be
868 specified as in color.branch.<slot>.
870 color.decorate.<slot>::
871 Use customized color for 'git log --decorate' output. `<slot>` is one
872 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
873 branches, remote-tracking branches, tags, stash and HEAD, respectively.
876 When set to `always`, always highlight matches. When `false` (or
877 `never`), never. When set to `true` or `auto`, use color only
878 when the output is written to the terminal. Defaults to `false`.
881 Use customized color for grep colorization. `<slot>` specifies which
882 part of the line to use the specified color, and is one of
886 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
888 filename prefix (when not using `-h`)
890 function name lines (when using `-p`)
892 line number prefix (when using `-n`)
896 non-matching text in selected lines
898 separators between fields on a line (`:`, `-`, and `=`)
899 and between hunks (`--`)
902 The values of these variables may be specified as in color.branch.<slot>.
905 When set to `always`, always use colors for interactive prompts
906 and displays (such as those used by "git-add --interactive" and
907 "git-clean --interactive"). When false (or `never`), never.
908 When set to `true` or `auto`, use colors only when the output is
909 to the terminal. Defaults to false.
911 color.interactive.<slot>::
912 Use customized color for 'git add --interactive' and 'git clean
913 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
914 or `error`, for four distinct types of normal output from
915 interactive commands. The values of these variables may be
916 specified as in color.branch.<slot>.
919 A boolean to enable/disable colored output when the pager is in
920 use (default is true).
923 A boolean to enable/disable color in the output of
924 linkgit:git-show-branch[1]. May be set to `always`,
925 `false` (or `never`) or `auto` (or `true`), in which case colors are used
926 only when the output is to a terminal. Defaults to false.
929 A boolean to enable/disable color in the output of
930 linkgit:git-status[1]. May be set to `always`,
931 `false` (or `never`) or `auto` (or `true`), in which case colors are used
932 only when the output is to a terminal. Defaults to false.
934 color.status.<slot>::
935 Use customized color for status colorization. `<slot>` is
936 one of `header` (the header text of the status message),
937 `added` or `updated` (files which are added but not committed),
938 `changed` (files which are changed but not added in the index),
939 `untracked` (files which are not tracked by Git),
940 `branch` (the current branch), or
941 `nobranch` (the color the 'no branch' warning is shown in, defaulting
942 to red). The values of these variables may be specified as in
946 This variable determines the default value for variables such
947 as `color.diff` and `color.grep` that control the use of color
948 per command family. Its scope will expand as more commands learn
949 configuration to set a default for the `--color` option. Set it
950 to `false` or `never` if you prefer Git commands not to use
951 color unless enabled explicitly with some other configuration
952 or the `--color` option. Set it to `always` if you want all
953 output not intended for machine consumption to use color, to
954 `true` or `auto` (this is the default since Git 1.8.4) if you
955 want such output to use color when written to the terminal.
958 Specify whether supported commands should output in columns.
959 This variable consists of a list of tokens separated by spaces
962 These options control when the feature should be enabled
963 (defaults to 'never'):
967 always show in columns
969 never show in columns
971 show in columns if the output is to the terminal
974 These options control layout (defaults to 'column'). Setting any
975 of these implies 'always' if none of 'always', 'never', or 'auto' are
980 fill columns before rows
982 fill rows before columns
987 Finally, these options can be combined with a layout option (defaults
992 make unequal size columns to utilize more space
994 make equal size columns
998 Specify whether to output branch listing in `git branch` in columns.
999 See `column.ui` for details.
1002 Specify the layout when list items in `git clean -i`, which always
1003 shows files and directories in columns. See `column.ui` for details.
1006 Specify whether to output untracked files in `git status` in columns.
1007 See `column.ui` for details.
1010 Specify whether to output tag listing in `git tag` in columns.
1011 See `column.ui` for details.
1014 This setting overrides the default of the `--cleanup` option in
1015 `git commit`. See linkgit:git-commit[1] for details. Changing the
1016 default can be useful when you always want to keep lines that begin
1017 with comment character `#` in your log message, in which case you
1018 would do `git config commit.cleanup whitespace` (note that you will
1019 have to remove the help lines that begin with `#` in the commit log
1020 template yourself, if you do this).
1024 A boolean to specify whether all commits should be GPG signed.
1025 Use of this option when doing operations such as rebase can
1026 result in a large number of commits being signed. It may be
1027 convenient to use an agent to avoid typing your GPG passphrase
1031 A boolean to enable/disable inclusion of status information in the
1032 commit message template when using an editor to prepare the commit
1033 message. Defaults to true.
1036 Specify a file to use as the template for new commit messages.
1037 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1038 specified user's home directory.
1041 Specify an external helper to be called when a username or
1042 password credential is needed; the helper may consult external
1043 storage to avoid prompting the user for the credentials. See
1044 linkgit:gitcredentials[7] for details.
1046 credential.useHttpPath::
1047 When acquiring credentials, consider the "path" component of an http
1048 or https URL to be important. Defaults to false. See
1049 linkgit:gitcredentials[7] for more information.
1051 credential.username::
1052 If no username is set for a network authentication, use this username
1053 by default. See credential.<context>.* below, and
1054 linkgit:gitcredentials[7].
1056 credential.<url>.*::
1057 Any of the credential.* options above can be applied selectively to
1058 some credentials. For example "credential.https://example.com.username"
1059 would set the default username only for https connections to
1060 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1063 include::diff-config.txt[]
1065 difftool.<tool>.path::
1066 Override the path for the given tool. This is useful in case
1067 your tool is not in the PATH.
1069 difftool.<tool>.cmd::
1070 Specify the command to invoke the specified diff tool.
1071 The specified command is evaluated in shell with the following
1072 variables available: 'LOCAL' is set to the name of the temporary
1073 file containing the contents of the diff pre-image and 'REMOTE'
1074 is set to the name of the temporary file containing the contents
1075 of the diff post-image.
1078 Prompt before each invocation of the diff tool.
1080 fetch.recurseSubmodules::
1081 This option can be either set to a boolean value or to 'on-demand'.
1082 Setting it to a boolean changes the behavior of fetch and pull to
1083 unconditionally recurse into submodules when set to true or to not
1084 recurse at all when set to false. When set to 'on-demand' (the default
1085 value), fetch and pull will only recurse into a populated submodule
1086 when its superproject retrieves a commit that updates the submodule's
1090 If it is set to true, git-fetch-pack will check all fetched
1091 objects. It will abort in the case of a malformed object or a
1092 broken link. The result of an abort are only dangling objects.
1093 Defaults to false. If not set, the value of `transfer.fsckObjects`
1097 If the number of objects fetched over the Git native
1098 transfer is below this
1099 limit, then the objects will be unpacked into loose object
1100 files. However if the number of received objects equals or
1101 exceeds this limit then the received pack will be stored as
1102 a pack, after adding any missing delta bases. Storing the
1103 pack from a push can make the push operation complete faster,
1104 especially on slow filesystems. If not set, the value of
1105 `transfer.unpackLimit` is used instead.
1108 If true, fetch will automatically behave as if the `--prune`
1109 option was given on the command line. See also `remote.<name>.prune`.
1112 Enable multipart/mixed attachments as the default for
1113 'format-patch'. The value can also be a double quoted string
1114 which will enable attachments as the default and set the
1115 value as the boundary. See the --attach option in
1116 linkgit:git-format-patch[1].
1119 A boolean which can enable or disable sequence numbers in patch
1120 subjects. It defaults to "auto" which enables it only if there
1121 is more than one patch. It can be enabled or disabled for all
1122 messages by setting it to "true" or "false". See --numbered
1123 option in linkgit:git-format-patch[1].
1126 Additional email headers to include in a patch to be submitted
1127 by mail. See linkgit:git-format-patch[1].
1131 Additional recipients to include in a patch to be submitted
1132 by mail. See the --to and --cc options in
1133 linkgit:git-format-patch[1].
1135 format.subjectprefix::
1136 The default for format-patch is to output files with the '[PATCH]'
1137 subject prefix. Use this variable to change that prefix.
1140 The default for format-patch is to output a signature containing
1141 the Git version number. Use this variable to change that default.
1142 Set this variable to the empty string ("") to suppress
1143 signature generation.
1145 format.signaturefile::
1146 Works just like format.signature except the contents of the
1147 file specified by this variable will be used as the signature.
1150 The default for format-patch is to output files with the suffix
1151 `.patch`. Use this variable to change that suffix (make sure to
1152 include the dot if you want it).
1155 The default pretty format for log/show/whatchanged command,
1156 See linkgit:git-log[1], linkgit:git-show[1],
1157 linkgit:git-whatchanged[1].
1160 The default threading style for 'git format-patch'. Can be
1161 a boolean value, or `shallow` or `deep`. `shallow` threading
1162 makes every mail a reply to the head of the series,
1163 where the head is chosen from the cover letter, the
1164 `--in-reply-to`, and the first patch mail, in this order.
1165 `deep` threading makes every mail a reply to the previous one.
1166 A true boolean value is the same as `shallow`, and a false
1167 value disables threading.
1170 A boolean value which lets you enable the `-s/--signoff` option of
1171 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1172 patch should be a conscious act and means that you certify you have
1173 the rights to submit this work under the same open source license.
1174 Please see the 'SubmittingPatches' document for further discussion.
1176 format.coverLetter::
1177 A boolean that controls whether to generate a cover-letter when
1178 format-patch is invoked, but in addition can be set to "auto", to
1179 generate a cover-letter only when there's more than one patch.
1181 filter.<driver>.clean::
1182 The command which is used to convert the content of a worktree
1183 file to a blob upon checkin. See linkgit:gitattributes[5] for
1186 filter.<driver>.smudge::
1187 The command which is used to convert the content of a blob
1188 object to a worktree file upon checkout. See
1189 linkgit:gitattributes[5] for details.
1191 gc.aggressiveDepth::
1192 The depth parameter used in the delta compression
1193 algorithm used by 'git gc --aggressive'. This defaults
1196 gc.aggressiveWindow::
1197 The window size parameter used in the delta compression
1198 algorithm used by 'git gc --aggressive'. This defaults
1202 When there are approximately more than this many loose
1203 objects in the repository, `git gc --auto` will pack them.
1204 Some Porcelain commands use this command to perform a
1205 light-weight garbage collection from time to time. The
1206 default value is 6700. Setting this to 0 disables it.
1209 When there are more than this many packs that are not
1210 marked with `*.keep` file in the repository, `git gc
1211 --auto` consolidates them into one larger pack. The
1212 default value is 50. Setting this to 0 disables it.
1215 Make `git gc --auto` return immediately andrun in background
1216 if the system supports it. Default is true.
1219 Running `git pack-refs` in a repository renders it
1220 unclonable by Git versions prior to 1.5.1.2 over dumb
1221 transports such as HTTP. This variable determines whether
1222 'git gc' runs `git pack-refs`. This can be set to `notbare`
1223 to enable it within all non-bare repos or it can be set to a
1224 boolean value. The default is `true`.
1227 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1228 Override the grace period with this config variable. The value
1229 "now" may be used to disable this grace period and always prune
1230 unreachable objects immediately.
1233 gc.<pattern>.reflogexpire::
1234 'git reflog expire' removes reflog entries older than
1235 this time; defaults to 90 days. With "<pattern>" (e.g.
1236 "refs/stash") in the middle the setting applies only to
1237 the refs that match the <pattern>.
1239 gc.reflogexpireunreachable::
1240 gc.<ref>.reflogexpireunreachable::
1241 'git reflog expire' removes reflog entries older than
1242 this time and are not reachable from the current tip;
1243 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1244 in the middle, the setting applies only to the refs that
1245 match the <pattern>.
1248 Records of conflicted merge you resolved earlier are
1249 kept for this many days when 'git rerere gc' is run.
1250 The default is 60 days. See linkgit:git-rerere[1].
1252 gc.rerereunresolved::
1253 Records of conflicted merge you have not resolved are
1254 kept for this many days when 'git rerere gc' is run.
1255 The default is 15 days. See linkgit:git-rerere[1].
1257 gitcvs.commitmsgannotation::
1258 Append this string to each commit message. Set to empty string
1259 to disable this feature. Defaults to "via git-CVS emulator".
1262 Whether the CVS server interface is enabled for this repository.
1263 See linkgit:git-cvsserver[1].
1266 Path to a log file where the CVS server interface well... logs
1267 various stuff. See linkgit:git-cvsserver[1].
1269 gitcvs.usecrlfattr::
1270 If true, the server will look up the end-of-line conversion
1271 attributes for files to determine the '-k' modes to use. If
1272 the attributes force Git to treat a file as text,
1273 the '-k' mode will be left blank so CVS clients will
1274 treat it as text. If they suppress text conversion, the file
1275 will be set with '-kb' mode, which suppresses any newline munging
1276 the client might otherwise do. If the attributes do not allow
1277 the file type to be determined, then 'gitcvs.allbinary' is
1278 used. See linkgit:gitattributes[5].
1281 This is used if 'gitcvs.usecrlfattr' does not resolve
1282 the correct '-kb' mode to use. If true, all
1283 unresolved files are sent to the client in
1284 mode '-kb'. This causes the client to treat them
1285 as binary files, which suppresses any newline munging it
1286 otherwise might do. Alternatively, if it is set to "guess",
1287 then the contents of the file are examined to decide if
1288 it is binary, similar to 'core.autocrlf'.
1291 Database used by git-cvsserver to cache revision information
1292 derived from the Git repository. The exact meaning depends on the
1293 used database driver, for SQLite (which is the default driver) this
1294 is a filename. Supports variable substitution (see
1295 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1296 Default: '%Ggitcvs.%m.sqlite'
1299 Used Perl DBI driver. You can specify any available driver
1300 for this here, but it might not work. git-cvsserver is tested
1301 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1302 reported *not* to work with 'DBD::mysql'. Experimental feature.
1303 May not contain double colons (`:`). Default: 'SQLite'.
1304 See linkgit:git-cvsserver[1].
1306 gitcvs.dbuser, gitcvs.dbpass::
1307 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1308 since SQLite has no concept of database users and/or passwords.
1309 'gitcvs.dbuser' supports variable substitution (see
1310 linkgit:git-cvsserver[1] for details).
1312 gitcvs.dbTableNamePrefix::
1313 Database table name prefix. Prepended to the names of any
1314 database tables used, allowing a single database to be used
1315 for several repositories. Supports variable substitution (see
1316 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1317 characters will be replaced with underscores.
1319 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1320 'gitcvs.allbinary' can also be specified as
1321 'gitcvs.<access_method>.<varname>' (where 'access_method'
1322 is one of "ext" and "pserver") to make them apply only for the given
1326 gitweb.description::
1329 See linkgit:gitweb[1] for description.
1337 gitweb.remote_heads::
1340 See linkgit:gitweb.conf[5] for description.
1343 If set to true, enable '-n' option by default.
1346 Set the default matching behavior. Using a value of 'basic', 'extended',
1347 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1348 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1349 value 'default' will return to the default matching behavior.
1351 grep.extendedRegexp::
1352 If set to true, enable '--extended-regexp' option by default. This
1353 option is ignored when the 'grep.patternType' option is set to a value
1354 other than 'default'.
1357 Use this custom program instead of "gpg" found on $PATH when
1358 making or verifying a PGP signature. The program must support the
1359 same command-line interface as GPG, namely, to verify a detached
1360 signature, "gpg --verify $file - <$signature" is run, and the
1361 program is expected to signal a good signature by exiting with
1362 code 0, and to generate an ascii-armored detached signature, the
1363 standard input of "gpg -bsau $key" is fed with the contents to be
1364 signed, and the program is expected to send the result to its
1367 gui.commitmsgwidth::
1368 Defines how wide the commit message window is in the
1369 linkgit:git-gui[1]. "75" is the default.
1372 Specifies how many context lines should be used in calls to diff
1373 made by the linkgit:git-gui[1]. The default is "5".
1375 gui.displayuntracked::
1376 Determines if linkgit::git-gui[1] shows untracked files
1377 in the file list. The default is "true".
1380 Specifies the default encoding to use for displaying of
1381 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1382 It can be overridden by setting the 'encoding' attribute
1383 for relevant files (see linkgit:gitattributes[5]).
1384 If this option is not set, the tools default to the
1387 gui.matchtrackingbranch::
1388 Determines if new branches created with linkgit:git-gui[1] should
1389 default to tracking remote branches with matching names or
1390 not. Default: "false".
1392 gui.newbranchtemplate::
1393 Is used as suggested name when creating new branches using the
1396 gui.pruneduringfetch::
1397 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1398 performing a fetch. The default value is "false".
1401 Determines if linkgit:git-gui[1] should trust the file modification
1402 timestamp or not. By default the timestamps are not trusted.
1404 gui.spellingdictionary::
1405 Specifies the dictionary used for spell checking commit messages in
1406 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1410 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1411 location detection. It makes blame significantly faster on huge
1412 repositories at the expense of less thorough copy detection.
1414 gui.copyblamethreshold::
1415 Specifies the threshold to use in 'git gui blame' original location
1416 detection, measured in alphanumeric characters. See the
1417 linkgit:git-blame[1] manual for more information on copy detection.
1419 gui.blamehistoryctx::
1420 Specifies the radius of history context in days to show in
1421 linkgit:gitk[1] for the selected commit, when the `Show History
1422 Context` menu item is invoked from 'git gui blame'. If this
1423 variable is set to zero, the whole history is shown.
1425 guitool.<name>.cmd::
1426 Specifies the shell command line to execute when the corresponding item
1427 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1428 mandatory for every tool. The command is executed from the root of
1429 the working directory, and in the environment it receives the name of
1430 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1431 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1432 the head is detached, 'CUR_BRANCH' is empty).
1434 guitool.<name>.needsfile::
1435 Run the tool only if a diff is selected in the GUI. It guarantees
1436 that 'FILENAME' is not empty.
1438 guitool.<name>.noconsole::
1439 Run the command silently, without creating a window to display its
1442 guitool.<name>.norescan::
1443 Don't rescan the working directory for changes after the tool
1446 guitool.<name>.confirm::
1447 Show a confirmation dialog before actually running the tool.
1449 guitool.<name>.argprompt::
1450 Request a string argument from the user, and pass it to the tool
1451 through the 'ARGS' environment variable. Since requesting an
1452 argument implies confirmation, the 'confirm' option has no effect
1453 if this is enabled. If the option is set to 'true', 'yes', or '1',
1454 the dialog uses a built-in generic prompt; otherwise the exact
1455 value of the variable is used.
1457 guitool.<name>.revprompt::
1458 Request a single valid revision from the user, and set the
1459 'REVISION' environment variable. In other aspects this option
1460 is similar to 'argprompt', and can be used together with it.
1462 guitool.<name>.revunmerged::
1463 Show only unmerged branches in the 'revprompt' subdialog.
1464 This is useful for tools similar to merge or rebase, but not
1465 for things like checkout or reset.
1467 guitool.<name>.title::
1468 Specifies the title to use for the prompt dialog. The default
1471 guitool.<name>.prompt::
1472 Specifies the general prompt string to display at the top of
1473 the dialog, before subsections for 'argprompt' and 'revprompt'.
1474 The default value includes the actual command.
1477 Specify the browser that will be used to display help in the
1478 'web' format. See linkgit:git-help[1].
1481 Override the default help format used by linkgit:git-help[1].
1482 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1483 the default. 'web' and 'html' are the same.
1486 Automatically correct and execute mistyped commands after
1487 waiting for the given number of deciseconds (0.1 sec). If more
1488 than one command can be deduced from the entered text, nothing
1489 will be executed. If the value of this option is negative,
1490 the corrected command will be executed immediately. If the
1491 value is 0 - the command will be just shown but not executed.
1492 This is the default.
1495 Specify the path where the HTML documentation resides. File system paths
1496 and URLs are supported. HTML pages will be prefixed with this path when
1497 help is displayed in the 'web' format. This defaults to the documentation
1498 path of your Git installation.
1501 Override the HTTP proxy, normally configured using the 'http_proxy',
1502 'https_proxy', and 'all_proxy' environment variables (see
1503 `curl(1)`). This can be overridden on a per-remote basis; see
1507 File containing previously stored cookie lines which should be used
1508 in the Git http session, if they match the server. The file format
1509 of the file to read cookies from should be plain HTTP headers or
1510 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1511 NOTE that the file specified with http.cookiefile is only used as
1512 input unless http.saveCookies is set.
1515 If set, store cookies received during requests to the file specified by
1516 http.cookiefile. Has no effect if http.cookiefile is unset.
1519 Whether to verify the SSL certificate when fetching or pushing
1520 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1524 File containing the SSL certificate when fetching or pushing
1525 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1529 File containing the SSL private key when fetching or pushing
1530 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1533 http.sslCertPasswordProtected::
1534 Enable Git's password prompt for the SSL certificate. Otherwise
1535 OpenSSL will prompt the user, possibly many times, if the
1536 certificate or private key is encrypted. Can be overridden by the
1537 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1540 File containing the certificates to verify the peer with when
1541 fetching or pushing over HTTPS. Can be overridden by the
1542 'GIT_SSL_CAINFO' environment variable.
1545 Path containing files with the CA certificates to verify the peer
1546 with when fetching or pushing over HTTPS. Can be overridden
1547 by the 'GIT_SSL_CAPATH' environment variable.
1550 Attempt to use AUTH SSL/TLS and encrypted data transfers
1551 when connecting via regular FTP protocol. This might be needed
1552 if the FTP server requires it for security reasons or you wish
1553 to connect securely whenever remote FTP server supports it.
1554 Default is false since it might trigger certificate verification
1555 errors on misconfigured servers.
1558 How many HTTP requests to launch in parallel. Can be overridden
1559 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1562 The number of curl sessions (counted across slots) to be kept across
1563 requests. They will not be ended with curl_easy_cleanup() until
1564 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1565 value will be capped at 1. Defaults to 1.
1568 Maximum size in bytes of the buffer used by smart HTTP
1569 transports when POSTing data to the remote system.
1570 For requests larger than this buffer size, HTTP/1.1 and
1571 Transfer-Encoding: chunked is used to avoid creating a
1572 massive pack file locally. Default is 1 MiB, which is
1573 sufficient for most requests.
1575 http.lowSpeedLimit, http.lowSpeedTime::
1576 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1577 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1578 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1579 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1582 A boolean which disables using of EPSV ftp command by curl.
1583 This can helpful with some "poor" ftp servers which don't
1584 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1585 environment variable. Default is false (curl will use EPSV).
1588 The HTTP USER_AGENT string presented to an HTTP server. The default
1589 value represents the version of the client Git such as git/1.7.1.
1590 This option allows you to override this value to a more common value
1591 such as Mozilla/4.0. This may be necessary, for instance, if
1592 connecting through a firewall that restricts HTTP connections to a set
1593 of common USER_AGENT strings (but not including those like git/1.7.1).
1594 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1597 Any of the http.* options above can be applied selectively to some urls.
1598 For a config key to match a URL, each element of the config key is
1599 compared to that of the URL, in the following order:
1602 . Scheme (e.g., `https` in `https://example.com/`). This field
1603 must match exactly between the config key and the URL.
1605 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1606 This field must match exactly between the config key and the URL.
1608 . Port number (e.g., `8080` in `http://example.com:8080/`).
1609 This field must match exactly between the config key and the URL.
1610 Omitted port numbers are automatically converted to the correct
1611 default for the scheme before matching.
1613 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1614 path field of the config key must match the path field of the URL
1615 either exactly or as a prefix of slash-delimited path elements. This means
1616 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1617 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1618 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1619 key with just path `foo/`).
1621 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1622 the config key has a user name it must match the user name in the
1623 URL exactly. If the config key does not have a user name, that
1624 config key will match a URL with any user name (including none),
1625 but at a lower precedence than a config key with a user name.
1628 The list above is ordered by decreasing precedence; a URL that matches
1629 a config key's path is preferred to one that matches its user name. For example,
1630 if the URL is `https://user@example.com/foo/bar` a config key match of
1631 `https://example.com/foo` will be preferred over a config key match of
1632 `https://user@example.com`.
1634 All URLs are normalized before attempting any matching (the password part,
1635 if embedded in the URL, is always ignored for matching purposes) so that
1636 equivalent urls that are simply spelled differently will match properly.
1637 Environment variable settings always override any matches. The urls that are
1638 matched against are those given directly to Git commands. This means any URLs
1639 visited as a result of a redirection do not participate in matching.
1641 i18n.commitEncoding::
1642 Character encoding the commit messages are stored in; Git itself
1643 does not care per se, but this information is necessary e.g. when
1644 importing commits from emails or in the gitk graphical history
1645 browser (and possibly at other places in the future or in other
1646 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1648 i18n.logOutputEncoding::
1649 Character encoding the commit messages are converted to when
1650 running 'git log' and friends.
1653 The configuration variables in the 'imap' section are described
1654 in linkgit:git-imap-send[1].
1657 Specify the version with which new index files should be
1658 initialized. This does not affect existing repositories.
1661 Specify the directory from which templates will be copied.
1662 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1665 Specify the program that will be used to browse your working
1666 repository in gitweb. See linkgit:git-instaweb[1].
1669 The HTTP daemon command-line to start gitweb on your working
1670 repository. See linkgit:git-instaweb[1].
1673 If true the web server started by linkgit:git-instaweb[1] will
1674 be bound to the local IP (127.0.0.1).
1676 instaweb.modulepath::
1677 The default module path for linkgit:git-instaweb[1] to use
1678 instead of /usr/lib/apache2/modules. Only used if httpd
1682 The port number to bind the gitweb httpd to. See
1683 linkgit:git-instaweb[1].
1685 interactive.singlekey::
1686 In interactive commands, allow the user to provide one-letter
1687 input with a single key (i.e., without hitting enter).
1688 Currently this is used by the `--patch` mode of
1689 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1690 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1691 setting is silently ignored if portable keystroke input
1692 is not available; requires the Perl module Term::ReadKey.
1695 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1696 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1697 override this option with `--no-abbrev-commit`.
1700 Set the default date-time mode for the 'log' command.
1701 Setting a value for log.date is similar to using 'git log''s
1702 `--date` option. Possible values are `relative`, `local`,
1703 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1707 Print out the ref names of any commits that are shown by the log
1708 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1709 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1710 specified, the full ref name (including prefix) will be printed.
1711 This is the same as the log commands '--decorate' option.
1714 If true, the initial commit will be shown as a big creation event.
1715 This is equivalent to a diff against an empty tree.
1716 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1717 normally hide the root commit will now show it. True by default.
1720 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1721 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1724 The location of an augmenting mailmap file. The default
1725 mailmap, located in the root of the repository, is loaded
1726 first, then the mailmap file pointed to by this variable.
1727 The location of the mailmap file may be in a repository
1728 subdirectory, or somewhere outside of the repository itself.
1729 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1732 Like `mailmap.file`, but consider the value as a reference to a
1733 blob in the repository. If both `mailmap.file` and
1734 `mailmap.blob` are given, both are parsed, with entries from
1735 `mailmap.file` taking precedence. In a bare repository, this
1736 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1740 Specify the programs that may be used to display help in the
1741 'man' format. See linkgit:git-help[1].
1744 Specify the command to invoke the specified man viewer. The
1745 specified command is evaluated in shell with the man page
1746 passed as argument. (See linkgit:git-help[1].)
1749 Override the path for the given tool that may be used to
1750 display help in the 'man' format. See linkgit:git-help[1].
1752 include::merge-config.txt[]
1754 mergetool.<tool>.path::
1755 Override the path for the given tool. This is useful in case
1756 your tool is not in the PATH.
1758 mergetool.<tool>.cmd::
1759 Specify the command to invoke the specified merge tool. The
1760 specified command is evaluated in shell with the following
1761 variables available: 'BASE' is the name of a temporary file
1762 containing the common base of the files to be merged, if available;
1763 'LOCAL' is the name of a temporary file containing the contents of
1764 the file on the current branch; 'REMOTE' is the name of a temporary
1765 file containing the contents of the file from the branch being
1766 merged; 'MERGED' contains the name of the file to which the merge
1767 tool should write the results of a successful merge.
1769 mergetool.<tool>.trustExitCode::
1770 For a custom merge command, specify whether the exit code of
1771 the merge command can be used to determine whether the merge was
1772 successful. If this is not set to true then the merge target file
1773 timestamp is checked and the merge assumed to have been successful
1774 if the file has been updated, otherwise the user is prompted to
1775 indicate the success of the merge.
1777 mergetool.keepBackup::
1778 After performing a merge, the original file with conflict markers
1779 can be saved as a file with a `.orig` extension. If this variable
1780 is set to `false` then this file is not preserved. Defaults to
1781 `true` (i.e. keep the backup files).
1783 mergetool.keepTemporaries::
1784 When invoking a custom merge tool, Git uses a set of temporary
1785 files to pass to the tool. If the tool returns an error and this
1786 variable is set to `true`, then these temporary files will be
1787 preserved, otherwise they will be removed after the tool has
1788 exited. Defaults to `false`.
1791 Prompt before each invocation of the merge resolution program.
1794 The (fully qualified) refname from which to show notes when
1795 showing commit messages. The value of this variable can be set
1796 to a glob, in which case notes from all matching refs will be
1797 shown. You may also specify this configuration variable
1798 several times. A warning will be issued for refs that do not
1799 exist, but a glob that does not match any refs is silently
1802 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1803 environment variable, which must be a colon separated list of refs or
1806 The effective value of "core.notesRef" (possibly overridden by
1807 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1810 notes.rewrite.<command>::
1811 When rewriting commits with <command> (currently `amend` or
1812 `rebase`) and this variable is set to `true`, Git
1813 automatically copies your notes from the original to the
1814 rewritten commit. Defaults to `true`, but see
1815 "notes.rewriteRef" below.
1818 When copying notes during a rewrite (see the
1819 "notes.rewrite.<command>" option), determines what to do if
1820 the target commit already has a note. Must be one of
1821 `overwrite`, `concatenate`, or `ignore`. Defaults to
1824 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1825 environment variable.
1828 When copying notes during a rewrite, specifies the (fully
1829 qualified) ref whose notes should be copied. The ref may be a
1830 glob, in which case notes in all matching refs will be copied.
1831 You may also specify this configuration several times.
1833 Does not have a default value; you must configure this variable to
1834 enable note rewriting. Set it to `refs/notes/commits` to enable
1835 rewriting for the default commit notes.
1837 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1838 environment variable, which must be a colon separated list of refs or
1842 The size of the window used by linkgit:git-pack-objects[1] when no
1843 window size is given on the command line. Defaults to 10.
1846 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1847 maximum depth is given on the command line. Defaults to 50.
1850 The window memory size limit used by linkgit:git-pack-objects[1]
1851 when no limit is given on the command line. The value can be
1852 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1856 An integer -1..9, indicating the compression level for objects
1857 in a pack file. -1 is the zlib default. 0 means no
1858 compression, and 1..9 are various speed/size tradeoffs, 9 being
1859 slowest. If not set, defaults to core.compression. If that is
1860 not set, defaults to -1, the zlib default, which is "a default
1861 compromise between speed and compression (currently equivalent
1864 Note that changing the compression level will not automatically recompress
1865 all existing objects. You can force recompression by passing the -F option
1866 to linkgit:git-repack[1].
1868 pack.deltaCacheSize::
1869 The maximum memory in bytes used for caching deltas in
1870 linkgit:git-pack-objects[1] before writing them out to a pack.
1871 This cache is used to speed up the writing object phase by not
1872 having to recompute the final delta result once the best match
1873 for all objects is found. Repacking large repositories on machines
1874 which are tight with memory might be badly impacted by this though,
1875 especially if this cache pushes the system into swapping.
1876 A value of 0 means no limit. The smallest size of 1 byte may be
1877 used to virtually disable this cache. Defaults to 256 MiB.
1879 pack.deltaCacheLimit::
1880 The maximum size of a delta, that is cached in
1881 linkgit:git-pack-objects[1]. This cache is used to speed up the
1882 writing object phase by not having to recompute the final delta
1883 result once the best match for all objects is found. Defaults to 1000.
1886 Specifies the number of threads to spawn when searching for best
1887 delta matches. This requires that linkgit:git-pack-objects[1]
1888 be compiled with pthreads otherwise this option is ignored with a
1889 warning. This is meant to reduce packing time on multiprocessor
1890 machines. The required amount of memory for the delta search window
1891 is however multiplied by the number of threads.
1892 Specifying 0 will cause Git to auto-detect the number of CPU's
1893 and set the number of threads accordingly.
1896 Specify the default pack index version. Valid values are 1 for
1897 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1898 the new pack index with capabilities for packs larger than 4 GB
1899 as well as proper protection against the repacking of corrupted
1900 packs. Version 2 is the default. Note that version 2 is enforced
1901 and this config option ignored whenever the corresponding pack is
1904 If you have an old Git that does not understand the version 2 `*.idx` file,
1905 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1906 that will copy both `*.pack` file and corresponding `*.idx` file from the
1907 other side may give you a repository that cannot be accessed with your
1908 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1909 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1912 pack.packSizeLimit::
1913 The maximum size of a pack. This setting only affects
1914 packing to a file when repacking, i.e. the git:// protocol
1915 is unaffected. It can be overridden by the `--max-pack-size`
1916 option of linkgit:git-repack[1]. The minimum size allowed is
1917 limited to 1 MiB. The default is unlimited.
1918 Common unit suffixes of 'k', 'm', or 'g' are
1922 When true, git will use pack bitmaps (if available) when packing
1923 to stdout (e.g., during the server side of a fetch). Defaults to
1924 true. You should not generally need to turn this off unless
1925 you are debugging pack bitmaps.
1928 This is a deprecated synonym for `repack.writeBitmaps`.
1930 pack.writeBitmapHashCache::
1931 When true, git will include a "hash cache" section in the bitmap
1932 index (if one is written). This cache can be used to feed git's
1933 delta heuristics, potentially leading to better deltas between
1934 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1935 between an older, bitmapped pack and objects that have been
1936 pushed since the last gc). The downside is that it consumes 4
1937 bytes per object of disk space, and that JGit's bitmap
1938 implementation does not understand it, causing it to complain if
1939 Git and JGit are used on the same repository. Defaults to false.
1942 If the value is boolean, turns on or off pagination of the
1943 output of a particular Git subcommand when writing to a tty.
1944 Otherwise, turns on pagination for the subcommand using the
1945 pager specified by the value of `pager.<cmd>`. If `--paginate`
1946 or `--no-pager` is specified on the command line, it takes
1947 precedence over this option. To disable pagination for all
1948 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1951 Alias for a --pretty= format string, as specified in
1952 linkgit:git-log[1]. Any aliases defined here can be used just
1953 as the built-in pretty formats could. For example,
1954 running `git config pretty.changelog "format:* %H %s"`
1955 would cause the invocation `git log --pretty=changelog`
1956 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1957 Note that an alias with the same name as a built-in format
1958 will be silently ignored.
1961 By default, Git does not create an extra merge commit when merging
1962 a commit that is a descendant of the current commit. Instead, the
1963 tip of the current branch is fast-forwarded. When set to `false`,
1964 this variable tells Git to create an extra merge commit in such
1965 a case (equivalent to giving the `--no-ff` option from the command
1966 line). When set to `only`, only such fast-forward merges are
1967 allowed (equivalent to giving the `--ff-only` option from the
1971 When true, rebase branches on top of the fetched branch, instead
1972 of merging the default branch from the default remote when "git
1973 pull" is run. See "branch.<name>.rebase" for setting this on a
1976 When preserve, also pass `--preserve-merges` along to 'git rebase'
1977 so that locally committed merge commits will not be flattened
1978 by running 'git pull'.
1980 *NOTE*: this is a possibly dangerous operation; do *not* use
1981 it unless you understand the implications (see linkgit:git-rebase[1]
1985 The default merge strategy to use when pulling multiple branches
1989 The default merge strategy to use when pulling a single branch.
1992 Defines the action `git push` should take if no refspec is
1993 explicitly given. Different values are well-suited for
1994 specific workflows; for instance, in a purely central workflow
1995 (i.e. the fetch source is equal to the push destination),
1996 `upstream` is probably what you want. Possible values are:
2000 * `nothing` - do not push anything (error out) unless a refspec is
2001 explicitly given. This is primarily meant for people who want to
2002 avoid mistakes by always being explicit.
2004 * `current` - push the current branch to update a branch with the same
2005 name on the receiving end. Works in both central and non-central
2008 * `upstream` - push the current branch back to the branch whose
2009 changes are usually integrated into the current branch (which is
2010 called `@{upstream}`). This mode only makes sense if you are
2011 pushing to the same repository you would normally pull from
2012 (i.e. central workflow).
2014 * `simple` - in centralized workflow, work like `upstream` with an
2015 added safety to refuse to push if the upstream branch's name is
2016 different from the local one.
2018 When pushing to a remote that is different from the remote you normally
2019 pull from, work as `current`. This is the safest option and is suited
2022 This mode has become the default in Git 2.0.
2024 * `matching` - push all branches having the same name on both ends.
2025 This makes the repository you are pushing to remember the set of
2026 branches that will be pushed out (e.g. if you always push 'maint'
2027 and 'master' there and no other branches, the repository you push
2028 to will have these two branches, and your local 'maint' and
2029 'master' will be pushed there).
2031 To use this mode effectively, you have to make sure _all_ the
2032 branches you would push out are ready to be pushed out before
2033 running 'git push', as the whole point of this mode is to allow you
2034 to push all of the branches in one go. If you usually finish work
2035 on only one branch and push out the result, while other branches are
2036 unfinished, this mode is not for you. Also this mode is not
2037 suitable for pushing into a shared central repository, as other
2038 people may add new branches there, or update the tip of existing
2039 branches outside your control.
2041 This used to be the default, but not since Git 2.0 (`simple` is the
2047 Whether to show a diffstat of what changed upstream since the last
2048 rebase. False by default.
2051 If set to true enable '--autosquash' option by default.
2054 When set to true, automatically create a temporary stash
2055 before the operation begins, and apply it after the operation
2056 ends. This means that you can run rebase on a dirty worktree.
2057 However, use with care: the final stash application after a
2058 successful rebase might result in non-trivial conflicts.
2062 By default, git-receive-pack will run "git-gc --auto" after
2063 receiving data from git-push and updating refs. You can stop
2064 it by setting this variable to false.
2066 receive.fsckObjects::
2067 If it is set to true, git-receive-pack will check all received
2068 objects. It will abort in the case of a malformed object or a
2069 broken link. The result of an abort are only dangling objects.
2070 Defaults to false. If not set, the value of `transfer.fsckObjects`
2073 receive.unpackLimit::
2074 If the number of objects received in a push is below this
2075 limit then the objects will be unpacked into loose object
2076 files. However if the number of received objects equals or
2077 exceeds this limit then the received pack will be stored as
2078 a pack, after adding any missing delta bases. Storing the
2079 pack from a push can make the push operation complete faster,
2080 especially on slow filesystems. If not set, the value of
2081 `transfer.unpackLimit` is used instead.
2083 receive.denyDeletes::
2084 If set to true, git-receive-pack will deny a ref update that deletes
2085 the ref. Use this to prevent such a ref deletion via a push.
2087 receive.denyDeleteCurrent::
2088 If set to true, git-receive-pack will deny a ref update that
2089 deletes the currently checked out branch of a non-bare repository.
2091 receive.denyCurrentBranch::
2092 If set to true or "refuse", git-receive-pack will deny a ref update
2093 to the currently checked out branch of a non-bare repository.
2094 Such a push is potentially dangerous because it brings the HEAD
2095 out of sync with the index and working tree. If set to "warn",
2096 print a warning of such a push to stderr, but allow the push to
2097 proceed. If set to false or "ignore", allow such pushes with no
2098 message. Defaults to "refuse".
2100 There are two more options that are meant for Git experts: "updateInstead"
2101 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
2102 the HEAD so it does not need to change. Both options come with their own
2103 set of possible *complications*, but can be appropriate in rare workflows.
2105 receive.denyNonFastForwards::
2106 If set to true, git-receive-pack will deny a ref update which is
2107 not a fast-forward. Use this to prevent such an update via a push,
2108 even if that push is forced. This configuration variable is
2109 set when initializing a shared repository.
2112 String(s) `receive-pack` uses to decide which refs to omit
2113 from its initial advertisement. Use more than one
2114 definitions to specify multiple prefix strings. A ref that
2115 are under the hierarchies listed on the value of this
2116 variable is excluded, and is hidden when responding to `git
2117 push`, and an attempt to update or delete a hidden ref by
2118 `git push` is rejected.
2120 receive.updateserverinfo::
2121 If set to true, git-receive-pack will run git-update-server-info
2122 after receiving data from git-push and updating refs.
2124 receive.shallowupdate::
2125 If set to true, .git/shallow can be updated when new refs
2126 require new shallow roots. Otherwise those refs are rejected.
2128 remote.pushdefault::
2129 The remote to push to by default. Overrides
2130 `branch.<name>.remote` for all branches, and is overridden by
2131 `branch.<name>.pushremote` for specific branches.
2134 The URL of a remote repository. See linkgit:git-fetch[1] or
2135 linkgit:git-push[1].
2137 remote.<name>.pushurl::
2138 The push URL of a remote repository. See linkgit:git-push[1].
2140 remote.<name>.proxy::
2141 For remotes that require curl (http, https and ftp), the URL to
2142 the proxy to use for that remote. Set to the empty string to
2143 disable proxying for that remote.
2145 remote.<name>.fetch::
2146 The default set of "refspec" for linkgit:git-fetch[1]. See
2147 linkgit:git-fetch[1].
2149 remote.<name>.push::
2150 The default set of "refspec" for linkgit:git-push[1]. See
2151 linkgit:git-push[1].
2153 remote.<name>.mirror::
2154 If true, pushing to this remote will automatically behave
2155 as if the `--mirror` option was given on the command line.
2157 remote.<name>.skipDefaultUpdate::
2158 If true, this remote will be skipped by default when updating
2159 using linkgit:git-fetch[1] or the `update` subcommand of
2160 linkgit:git-remote[1].
2162 remote.<name>.skipFetchAll::
2163 If true, this remote will be skipped by default when updating
2164 using linkgit:git-fetch[1] or the `update` subcommand of
2165 linkgit:git-remote[1].
2167 remote.<name>.receivepack::
2168 The default program to execute on the remote side when pushing. See
2169 option \--receive-pack of linkgit:git-push[1].
2171 remote.<name>.uploadpack::
2172 The default program to execute on the remote side when fetching. See
2173 option \--upload-pack of linkgit:git-fetch-pack[1].
2175 remote.<name>.tagopt::
2176 Setting this value to \--no-tags disables automatic tag following when
2177 fetching from remote <name>. Setting it to \--tags will fetch every
2178 tag from remote <name>, even if they are not reachable from remote
2179 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2180 override this setting. See options \--tags and \--no-tags of
2181 linkgit:git-fetch[1].
2184 Setting this to a value <vcs> will cause Git to interact with
2185 the remote with the git-remote-<vcs> helper.
2187 remote.<name>.prune::
2188 When set to true, fetching from this remote by default will also
2189 remove any remote-tracking references that no longer exist on the
2190 remote (as if the `--prune` option was given on the command line).
2191 Overrides `fetch.prune` settings, if any.
2194 The list of remotes which are fetched by "git remote update
2195 <group>". See linkgit:git-remote[1].
2197 repack.usedeltabaseoffset::
2198 By default, linkgit:git-repack[1] creates packs that use
2199 delta-base offset. If you need to share your repository with
2200 Git older than version 1.4.4, either directly or via a dumb
2201 protocol such as http, then you need to set this option to
2202 "false" and repack. Access from old Git versions over the
2203 native protocol are unaffected by this option.
2205 repack.packKeptObjects::
2206 If set to true, makes `git repack` act as if
2207 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2208 details. Defaults to `false` normally, but `true` if a bitmap
2209 index is being written (either via `--write-bitmap-index` or
2210 `repack.writeBitmaps`).
2212 repack.writeBitmaps::
2213 When true, git will write a bitmap index when packing all
2214 objects to disk (e.g., when `git repack -a` is run). This
2215 index can speed up the "counting objects" phase of subsequent
2216 packs created for clones and fetches, at the cost of some disk
2217 space and extra time spent on the initial repack. Defaults to
2221 When set to true, `git-rerere` updates the index with the
2222 resulting contents after it cleanly resolves conflicts using
2223 previously recorded resolution. Defaults to false.
2226 Activate recording of resolved conflicts, so that identical
2227 conflict hunks can be resolved automatically, should they be
2228 encountered again. By default, linkgit:git-rerere[1] is
2229 enabled if there is an `rr-cache` directory under the
2230 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2233 sendemail.identity::
2234 A configuration identity. When given, causes values in the
2235 'sendemail.<identity>' subsection to take precedence over
2236 values in the 'sendemail' section. The default identity is
2237 the value of 'sendemail.identity'.
2239 sendemail.smtpencryption::
2240 See linkgit:git-send-email[1] for description. Note that this
2241 setting is not subject to the 'identity' mechanism.
2244 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2246 sendemail.smtpsslcertpath::
2247 Path to ca-certificates (either a directory or a single file).
2248 Set it to an empty string to disable certificate verification.
2250 sendemail.<identity>.*::
2251 Identity-specific versions of the 'sendemail.*' parameters
2252 found below, taking precedence over those when the this
2253 identity is selected, through command-line or
2254 'sendemail.identity'.
2256 sendemail.aliasesfile::
2257 sendemail.aliasfiletype::
2258 sendemail.annotate::
2262 sendemail.chainreplyto::
2264 sendemail.envelopesender::
2266 sendemail.multiedit::
2267 sendemail.signedoffbycc::
2268 sendemail.smtppass::
2269 sendemail.suppresscc::
2270 sendemail.suppressfrom::
2272 sendemail.smtpdomain::
2273 sendemail.smtpserver::
2274 sendemail.smtpserverport::
2275 sendemail.smtpserveroption::
2276 sendemail.smtpuser::
2278 sendemail.validate::
2279 See linkgit:git-send-email[1] for description.
2281 sendemail.signedoffcc::
2282 Deprecated alias for 'sendemail.signedoffbycc'.
2284 showbranch.default::
2285 The default set of branches for linkgit:git-show-branch[1].
2286 See linkgit:git-show-branch[1].
2288 status.relativePaths::
2289 By default, linkgit:git-status[1] shows paths relative to the
2290 current directory. Setting this variable to `false` shows paths
2291 relative to the repository root (this was the default for Git
2295 Set to true to enable --short by default in linkgit:git-status[1].
2296 The option --no-short takes precedence over this variable.
2299 Set to true to enable --branch by default in linkgit:git-status[1].
2300 The option --no-branch takes precedence over this variable.
2302 status.displayCommentPrefix::
2303 If set to true, linkgit:git-status[1] will insert a comment
2304 prefix before each output line (starting with
2305 `core.commentChar`, i.e. `#` by default). This was the
2306 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2309 status.showUntrackedFiles::
2310 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2311 files which are not currently tracked by Git. Directories which
2312 contain only untracked files, are shown with the directory name
2313 only. Showing untracked files means that Git needs to lstat() all
2314 all the files in the whole repository, which might be slow on some
2315 systems. So, this variable controls how the commands displays
2316 the untracked files. Possible values are:
2319 * `no` - Show no untracked files.
2320 * `normal` - Show untracked files and directories.
2321 * `all` - Show also individual files in untracked directories.
2324 If this variable is not specified, it defaults to 'normal'.
2325 This variable can be overridden with the -u|--untracked-files option
2326 of linkgit:git-status[1] and linkgit:git-commit[1].
2328 status.submodulesummary::
2330 If this is set to a non zero number or true (identical to -1 or an
2331 unlimited number), the submodule summary will be enabled and a
2332 summary of commits for modified submodules will be shown (see
2333 --summary-limit option of linkgit:git-submodule[1]). Please note
2334 that the summary output command will be suppressed for all
2335 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2336 for those submodules where `submodule.<name>.ignore=all`. The only
2337 exception to that rule is that status and commit will show staged
2338 submodule changes. To
2339 also view the summary for ignored submodules you can either use
2340 the --ignore-submodules=dirty command-line option or the 'git
2341 submodule summary' command, which shows a similar output but does
2342 not honor these settings.
2344 submodule.<name>.path::
2345 submodule.<name>.url::
2346 submodule.<name>.update::
2347 The path within this project, URL, and the updating strategy
2348 for a submodule. These variables are initially populated
2349 by 'git submodule init'; edit them to override the
2350 URL and other values found in the `.gitmodules` file. See
2351 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2353 submodule.<name>.branch::
2354 The remote branch name for a submodule, used by `git submodule
2355 update --remote`. Set this option to override the value found in
2356 the `.gitmodules` file. See linkgit:git-submodule[1] and
2357 linkgit:gitmodules[5] for details.
2359 submodule.<name>.fetchRecurseSubmodules::
2360 This option can be used to control recursive fetching of this
2361 submodule. It can be overridden by using the --[no-]recurse-submodules
2362 command-line option to "git fetch" and "git pull".
2363 This setting will override that from in the linkgit:gitmodules[5]
2366 submodule.<name>.ignore::
2367 Defines under what circumstances "git status" and the diff family show
2368 a submodule as modified. When set to "all", it will never be considered
2369 modified (but it will nonetheless show up in the output of status and
2370 commit when it has been staged), "dirty" will ignore all changes
2371 to the submodules work tree and
2372 takes only differences between the HEAD of the submodule and the commit
2373 recorded in the superproject into account. "untracked" will additionally
2374 let submodules with modified tracked files in their work tree show up.
2375 Using "none" (the default when this option is not set) also shows
2376 submodules that have untracked files in their work tree as changed.
2377 This setting overrides any setting made in .gitmodules for this submodule,
2378 both settings can be overridden on the command line by using the
2379 "--ignore-submodules" option. The 'git submodule' commands are not
2380 affected by this setting.
2383 This variable controls the sort ordering of tags when displayed by
2384 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2385 value of this variable will be used as the default.
2388 This variable can be used to restrict the permission bits of
2389 tar archive entries. The default is 0002, which turns off the
2390 world write bit. The special value "user" indicates that the
2391 archiving user's umask will be used instead. See umask(2) and
2392 linkgit:git-archive[1].
2394 transfer.fsckObjects::
2395 When `fetch.fsckObjects` or `receive.fsckObjects` are
2396 not set, the value of this variable is used instead.
2400 This variable can be used to set both `receive.hiderefs`
2401 and `uploadpack.hiderefs` at the same time to the same
2402 values. See entries for these other variables.
2404 transfer.unpackLimit::
2405 When `fetch.unpackLimit` or `receive.unpackLimit` are
2406 not set, the value of this variable is used instead.
2407 The default value is 100.
2409 uploadarchive.allowUnreachable::
2410 If true, allow clients to use `git archive --remote` to request
2411 any tree, whether reachable from the ref tips or not. See the
2412 discussion in the `SECURITY` section of
2413 linkgit:git-upload-archive[1] for more details. Defaults to
2416 uploadpack.hiderefs::
2417 String(s) `upload-pack` uses to decide which refs to omit
2418 from its initial advertisement. Use more than one
2419 definitions to specify multiple prefix strings. A ref that
2420 are under the hierarchies listed on the value of this
2421 variable is excluded, and is hidden from `git ls-remote`,
2422 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2423 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2425 uploadpack.allowtipsha1inwant::
2426 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2427 to accept a fetch request that asks for an object at the tip
2428 of a hidden ref (by default, such a request is rejected).
2429 see also `uploadpack.hiderefs`.
2431 uploadpack.keepalive::
2432 When `upload-pack` has started `pack-objects`, there may be a
2433 quiet period while `pack-objects` prepares the pack. Normally
2434 it would output progress information, but if `--quiet` was used
2435 for the fetch, `pack-objects` will output nothing at all until
2436 the pack data begins. Some clients and networks may consider
2437 the server to be hung and give up. Setting this option instructs
2438 `upload-pack` to send an empty keepalive packet every
2439 `uploadpack.keepalive` seconds. Setting this option to 0
2440 disables keepalive packets entirely. The default is 5 seconds.
2442 url.<base>.insteadOf::
2443 Any URL that starts with this value will be rewritten to
2444 start, instead, with <base>. In cases where some site serves a
2445 large number of repositories, and serves them with multiple
2446 access methods, and some users need to use different access
2447 methods, this feature allows people to specify any of the
2448 equivalent URLs and have Git automatically rewrite the URL to
2449 the best alternative for the particular user, even for a
2450 never-before-seen repository on the site. When more than one
2451 insteadOf strings match a given URL, the longest match is used.
2453 url.<base>.pushInsteadOf::
2454 Any URL that starts with this value will not be pushed to;
2455 instead, it will be rewritten to start with <base>, and the
2456 resulting URL will be pushed to. In cases where some site serves
2457 a large number of repositories, and serves them with multiple
2458 access methods, some of which do not allow push, this feature
2459 allows people to specify a pull-only URL and have Git
2460 automatically use an appropriate URL to push, even for a
2461 never-before-seen repository on the site. When more than one
2462 pushInsteadOf strings match a given URL, the longest match is
2463 used. If a remote has an explicit pushurl, Git will ignore this
2464 setting for that remote.
2467 Your email address to be recorded in any newly created commits.
2468 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2469 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2472 Your full name to be recorded in any newly created commits.
2473 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2474 environment variables. See linkgit:git-commit-tree[1].
2477 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2478 key you want it to automatically when creating a signed tag or
2479 commit, you can override the default selection with this variable.
2480 This option is passed unchanged to gpg's --local-user parameter,
2481 so you may specify a key using any method that gpg supports.
2484 Specify a web browser that may be used by some commands.
2485 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2489 Allows to disable the side-band-64k capability for send-pack even
2490 when it is advertised by the server. Makes it possible to work
2491 around a limitation in the git for windows implementation together
2492 with the dump git protocol. Defaults to true.