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). No other char escape sequence, nor octal
82 char sequences are valid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
107 ; Don't trust file modes
112 external = /usr/local/bin/diff-wrapper
117 merge = refs/heads/devel
121 gitProxy="ssh" for "kernel.org"
122 gitProxy=default-proxy ; for the rest
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
138 These variables control various optional help messages designed to
139 aid new users. All 'advice.*' variables default to 'true', and you
140 can tell Git that you do not need help by setting these to 'false':
144 Set this variable to 'false' if you want to disable
145 'pushNonFFCurrent', 'pushNonFFDefault',
146 'pushNonFFMatching', 'pushAlreadyExists',
147 'pushFetchFirst', and 'pushNeedsForce'
150 Advice shown when linkgit:git-push[1] fails due to a
151 non-fast-forward update to the current branch.
153 Advice to set 'push.default' to 'upstream' or 'current'
154 when you ran linkgit:git-push[1] and pushed 'matching
155 refs' by default (i.e. you did not provide an explicit
156 refspec, and no 'push.default' configuration was set)
157 and it resulted in a non-fast-forward error.
159 Advice shown when you ran linkgit:git-push[1] and pushed
160 'matching refs' explicitly (i.e. you used ':', or
161 specified a refspec that isn't your current branch) and
162 it resulted in a non-fast-forward error.
164 Shown when linkgit:git-push[1] rejects an update that
165 does not qualify for fast-forwarding (e.g., a tag.)
167 Shown when linkgit:git-push[1] rejects an update that
168 tries to overwrite a remote ref that points at an
169 object we do not have.
171 Shown when linkgit:git-push[1] rejects an update that
172 tries to overwrite a remote ref that points at an
173 object that is not a commit-ish, or make the remote
174 ref point at an object that is not a commit-ish.
176 Show directions on how to proceed from the current
177 state in the output of linkgit:git-status[1], in
178 the template shown when writing commit messages in
179 linkgit:git-commit[1], and in the help message shown
180 by linkgit:git-checkout[1] when switching branch.
182 Advise to consider using the `-u` option to linkgit:git-status[1]
183 when the command takes more than 2 seconds to enumerate untracked
186 Advice shown when linkgit:git-merge[1] refuses to
187 merge to avoid overwriting local changes.
189 Advice shown by various commands when conflicts
190 prevent the operation from being performed.
192 Advice on how to set your identity configuration when
193 your information is guessed from the system username and
196 Advice shown when you used linkgit:git-checkout[1] to
197 move to the detach HEAD state, to instruct how to create
198 a local branch after the fact.
200 Advice that shows the location of the patch file when
201 linkgit:git-am[1] fails to apply it.
203 In case of failure in the output of linkgit:git-rm[1],
204 show directions on how to proceed from the current state.
208 If false, the executable bit differences between the index and
209 the working tree are ignored; useful on broken filesystems like FAT.
210 See linkgit:git-update-index[1].
212 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
213 will probe and set core.fileMode false if appropriate when the
214 repository is created.
217 If true, this option enables various workarounds to enable
218 Git to work better on filesystems that are not case sensitive,
219 like FAT. For example, if a directory listing finds
220 "makefile" when Git expects "Makefile", Git will assume
221 it is really the same file, and continue to remember it as
224 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
225 will probe and set core.ignorecase true if appropriate when the repository
228 core.precomposeunicode::
229 This option is only used by Mac OS implementation of Git.
230 When core.precomposeunicode=true, Git reverts the unicode decomposition
231 of filenames done by Mac OS. This is useful when sharing a repository
232 between Mac OS and Linux or Windows.
233 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
234 When false, file names are handled fully transparent by Git,
235 which is backward compatible with older versions of Git.
238 If false, the ctime differences between the index and the
239 working tree are ignored; useful when the inode change time
240 is regularly modified by something outside Git (file system
241 crawlers and some backup systems).
242 See linkgit:git-update-index[1]. True by default.
245 Determines which stat fields to match between the index
246 and work tree. The user can set this to 'default' or
247 'minimal'. Default (or explicitly 'default'), is to check
248 all fields, including the sub-second part of mtime and ctime.
251 The commands that output paths (e.g. 'ls-files',
252 'diff'), when not given the `-z` option, will quote
253 "unusual" characters in the pathname by enclosing the
254 pathname in a double-quote pair and with backslashes the
255 same way strings in C source code are quoted. If this
256 variable is set to false, the bytes higher than 0x80 are
257 not quoted but output as verbatim. Note that double
258 quote, backslash and control characters are always
259 quoted without `-z` regardless of the setting of this
263 Sets the line ending type to use in the working directory for
264 files that have the `text` property set. Alternatives are
265 'lf', 'crlf' and 'native', which uses the platform's native
266 line ending. The default value is `native`. See
267 linkgit:gitattributes[5] for more information on end-of-line
271 If true, makes Git check if converting `CRLF` is reversible when
272 end-of-line conversion is active. Git will verify if a command
273 modifies a file in the work tree either directly or indirectly.
274 For example, committing a file followed by checking out the
275 same file should yield the original file in the work tree. If
276 this is not the case for the current setting of
277 `core.autocrlf`, Git will reject the file. The variable can
278 be set to "warn", in which case Git will only warn about an
279 irreversible conversion but continue the operation.
281 CRLF conversion bears a slight chance of corrupting data.
282 When it is enabled, Git will convert CRLF to LF during commit and LF to
283 CRLF during checkout. A file that contains a mixture of LF and
284 CRLF before the commit cannot be recreated by Git. For text
285 files this is the right thing to do: it corrects line endings
286 such that we have only LF line endings in the repository.
287 But for binary files that are accidentally classified as text the
288 conversion can corrupt data.
290 If you recognize such corruption early you can easily fix it by
291 setting the conversion type explicitly in .gitattributes. Right
292 after committing you still have the original file in your work
293 tree and this file is not yet corrupted. You can explicitly tell
294 Git that this file is binary and Git will handle the file
297 Unfortunately, the desired effect of cleaning up text files with
298 mixed line endings and the undesired effect of corrupting binary
299 files cannot be distinguished. In both cases CRLFs are removed
300 in an irreversible way. For text files this is the right thing
301 to do because CRLFs are line endings, while for binary files
302 converting CRLFs corrupts data.
304 Note, this safety check does not mean that a checkout will generate a
305 file identical to the original file for a different setting of
306 `core.eol` and `core.autocrlf`, but only for the current one. For
307 example, a text file with `LF` would be accepted with `core.eol=lf`
308 and could later be checked out with `core.eol=crlf`, in which case the
309 resulting file would contain `CRLF`, although the original file
310 contained `LF`. However, in both work trees the line endings would be
311 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
312 file with mixed line endings would be reported by the `core.safecrlf`
316 Setting this variable to "true" is almost the same as setting
317 the `text` attribute to "auto" on all files except that text
318 files are not guaranteed to be normalized: files that contain
319 `CRLF` in the repository will not be touched. Use this
320 setting if you want to have `CRLF` line endings in your
321 working directory even though the repository does not have
322 normalized line endings. This variable can be set to 'input',
323 in which case no output conversion is performed.
326 If false, symbolic links are checked out as small plain files that
327 contain the link text. linkgit:git-update-index[1] and
328 linkgit:git-add[1] will not change the recorded type to regular
329 file. Useful on filesystems like FAT that do not support
332 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
333 will probe and set core.symlinks false if appropriate when the repository
337 A "proxy command" to execute (as 'command host port') instead
338 of establishing direct connection to the remote server when
339 using the Git protocol for fetching. If the variable value is
340 in the "COMMAND for DOMAIN" format, the command is applied only
341 on hostnames ending with the specified domain string. This variable
342 may be set multiple times and is matched in the given order;
343 the first match wins.
345 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
346 (which always applies universally, without the special "for"
349 The special string `none` can be used as the proxy command to
350 specify that no proxy be used for a given domain pattern.
351 This is useful for excluding servers inside a firewall from
352 proxy use, while defaulting to a common proxy for external domains.
355 If true, commands which modify both the working tree and the index
356 will mark the updated paths with the "assume unchanged" bit in the
357 index. These marked files are then assumed to stay unchanged in the
358 working tree, until you mark them otherwise manually - Git will not
359 detect the file changes by lstat() calls. This is useful on systems
360 where those are very slow, such as Microsoft Windows.
361 See linkgit:git-update-index[1].
364 core.preferSymlinkRefs::
365 Instead of the default "symref" format for HEAD
366 and other symbolic reference files, use symbolic links.
367 This is sometimes needed to work with old scripts that
368 expect HEAD to be a symbolic link.
371 If true this repository is assumed to be 'bare' and has no
372 working directory associated with it. If this is the case a
373 number of commands that require a working directory will be
374 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
376 This setting is automatically guessed by linkgit:git-clone[1] or
377 linkgit:git-init[1] when the repository was created. By default a
378 repository that ends in "/.git" is assumed to be not bare (bare =
379 false), while all other repositories are assumed to be bare (bare
383 Set the path to the root of the working tree.
384 This can be overridden by the GIT_WORK_TREE environment
385 variable and the '--work-tree' command line option.
386 The value can be an absolute path or relative to the path to
387 the .git directory, which is either specified by --git-dir
388 or GIT_DIR, or automatically discovered.
389 If --git-dir or GIT_DIR is specified but none of
390 --work-tree, GIT_WORK_TREE and core.worktree is specified,
391 the current working directory is regarded as the top level
392 of your working tree.
394 Note that this variable is honored even when set in a configuration
395 file in a ".git" subdirectory of a directory and its value differs
396 from the latter directory (e.g. "/path/to/.git/config" has
397 core.worktree set to "/different/path"), which is most likely a
398 misconfiguration. Running Git commands in the "/path/to" directory will
399 still use "/different/path" as the root of the work tree and can cause
400 confusion unless you know what you are doing (e.g. you are creating a
401 read-only snapshot of the same index to a location different from the
402 repository's usual working tree).
404 core.logAllRefUpdates::
405 Enable the reflog. Updates to a ref <ref> is logged to the file
406 "$GIT_DIR/logs/<ref>", by appending the new and old
407 SHA-1, the date/time and the reason of the update, but
408 only when the file exists. If this configuration
409 variable is set to true, missing "$GIT_DIR/logs/<ref>"
410 file is automatically created for branch heads (i.e. under
411 refs/heads/), remote refs (i.e. under refs/remotes/),
412 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
414 This information can be used to determine what commit
415 was the tip of a branch "2 days ago".
417 This value is true by default in a repository that has
418 a working directory associated with it, and false by
419 default in a bare repository.
421 core.repositoryFormatVersion::
422 Internal variable identifying the repository format and layout
425 core.sharedRepository::
426 When 'group' (or 'true'), the repository is made shareable between
427 several users in a group (making sure all the files and objects are
428 group-writable). When 'all' (or 'world' or 'everybody'), the
429 repository will be readable by all users, additionally to being
430 group-shareable. When 'umask' (or 'false'), Git will use permissions
431 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
432 files in the repository will have this mode value. '0xxx' will override
433 user's umask value (whereas the other options will only override
434 requested parts of the user's umask value). Examples: '0660' will make
435 the repo read/write-able for the owner and group, but inaccessible to
436 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
437 repository that is group-readable but not group-writable.
438 See linkgit:git-init[1]. False by default.
440 core.warnAmbiguousRefs::
441 If true, Git will warn you if the ref name you passed it is ambiguous
442 and might match multiple refs in the repository. True by default.
445 An integer -1..9, indicating a default compression level.
446 -1 is the zlib default. 0 means no compression,
447 and 1..9 are various speed/size tradeoffs, 9 being slowest.
448 If set, this provides a default to other compression variables,
449 such as 'core.loosecompression' and 'pack.compression'.
451 core.loosecompression::
452 An integer -1..9, indicating the compression level for objects that
453 are not in a pack file. -1 is the zlib default. 0 means no
454 compression, and 1..9 are various speed/size tradeoffs, 9 being
455 slowest. If not set, defaults to core.compression. If that is
456 not set, defaults to 1 (best speed).
458 core.packedGitWindowSize::
459 Number of bytes of a pack file to map into memory in a
460 single mapping operation. Larger window sizes may allow
461 your system to process a smaller number of large pack files
462 more quickly. Smaller window sizes will negatively affect
463 performance due to increased calls to the operating system's
464 memory manager, but may improve performance when accessing
465 a large number of large pack files.
467 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
468 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
469 be reasonable for all users/operating systems. You probably do
470 not need to adjust this value.
472 Common unit suffixes of 'k', 'm', or 'g' are supported.
474 core.packedGitLimit::
475 Maximum number of bytes to map simultaneously into memory
476 from pack files. If Git needs to access more than this many
477 bytes at once to complete an operation it will unmap existing
478 regions to reclaim virtual address space within the process.
480 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
481 This should be reasonable for all users/operating systems, except on
482 the largest projects. You probably do not need to adjust this value.
484 Common unit suffixes of 'k', 'm', or 'g' are supported.
486 core.deltaBaseCacheLimit::
487 Maximum number of bytes to reserve for caching base objects
488 that may be referenced by multiple deltified objects. By storing the
489 entire decompressed base objects in a cache Git is able
490 to avoid unpacking and decompressing frequently used base
491 objects multiple times.
493 Default is 16 MiB on all platforms. This should be reasonable
494 for all users/operating systems, except on the largest projects.
495 You probably do not need to adjust this value.
497 Common unit suffixes of 'k', 'm', or 'g' are supported.
499 core.bigFileThreshold::
500 Files larger than this size are stored deflated, without
501 attempting delta compression. Storing large files without
502 delta compression avoids excessive memory usage, at the
503 slight expense of increased disk usage.
505 Default is 512 MiB on all platforms. This should be reasonable
506 for most projects as source code and other text files can still
507 be delta compressed, but larger binary media files won't be.
509 Common unit suffixes of 'k', 'm', or 'g' are supported.
512 In addition to '.gitignore' (per-directory) and
513 '.git/info/exclude', Git looks into this file for patterns
514 of files which are not meant to be tracked. "`~/`" is expanded
515 to the value of `$HOME` and "`~user/`" to the specified user's
516 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
517 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
518 is used instead. See linkgit:gitignore[5].
521 Some commands (e.g. svn and http interfaces) that interactively
522 ask for a password can be told to use an external program given
523 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
524 environment variable. If not set, fall back to the value of the
525 'SSH_ASKPASS' environment variable or, failing that, a simple password
526 prompt. The external program shall be given a suitable prompt as
527 command line argument and write the password on its STDOUT.
529 core.attributesfile::
530 In addition to '.gitattributes' (per-directory) and
531 '.git/info/attributes', Git looks into this file for attributes
532 (see linkgit:gitattributes[5]). Path expansions are made the same
533 way as for `core.excludesfile`. Its default value is
534 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
535 set or empty, $HOME/.config/git/attributes is used instead.
538 Commands such as `commit` and `tag` that lets you edit
539 messages by launching an editor uses the value of this
540 variable when it is set, and the environment variable
541 `GIT_EDITOR` is not set. See linkgit:git-var[1].
544 Commands such as `commit` and `tag` that lets you edit
545 messages consider a line that begins with this character
546 commented, and removes them after the editor returns
550 Text editor used by `git rebase -i` for editing the rebase instruction file.
551 The value is meant to be interpreted by the shell when it is used.
552 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
553 When not configured the default commit message editor is used instead.
556 Text viewer for use by Git commands (e.g., 'less'). The value
557 is meant to be interpreted by the shell. The order of preference
558 is the `$GIT_PAGER` environment variable, then `core.pager`
559 configuration, then `$PAGER`, and then the default chosen at
560 compile time (usually 'less').
562 When the `LESS` environment variable is unset, Git sets it to `FRSX`
563 (if `LESS` environment variable is set, Git does not change it at
564 all). If you want to selectively override Git's default setting
565 for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
566 be passed to the shell by Git, which will translate the final
567 command to `LESS=FRSX less -+S`. The environment tells the command
568 to set the `S` option to chop long lines but the command line
569 resets it to the default to fold long lines.
571 Likewise, when the `LV` environment variable is unset, Git sets it
572 to `-c`. You can override this setting by exporting `LV` with
573 another value or setting `core.pager` to `lv +c`.
576 A comma separated list of common whitespace problems to
577 notice. 'git diff' will use `color.diff.whitespace` to
578 highlight them, and 'git apply --whitespace=error' will
579 consider them as errors. You can prefix `-` to disable
580 any of them (e.g. `-trailing-space`):
582 * `blank-at-eol` treats trailing whitespaces at the end of the line
583 as an error (enabled by default).
584 * `space-before-tab` treats a space character that appears immediately
585 before a tab character in the initial indent part of the line as an
586 error (enabled by default).
587 * `indent-with-non-tab` treats a line that is indented with space
588 characters instead of the equivalent tabs as an error (not enabled by
590 * `tab-in-indent` treats a tab character in the initial indent part of
591 the line as an error (not enabled by default).
592 * `blank-at-eof` treats blank lines added at the end of file as an error
593 (enabled by default).
594 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
596 * `cr-at-eol` treats a carriage-return at the end of line as
597 part of the line terminator, i.e. with it, `trailing-space`
598 does not trigger if the character before such a carriage-return
599 is not a whitespace (not enabled by default).
600 * `tabwidth=<n>` tells how many character positions a tab occupies; this
601 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
602 errors. The default tab width is 8. Allowed values are 1 to 63.
604 core.fsyncobjectfiles::
605 This boolean will enable 'fsync()' when writing object files.
607 This is a total waste of time and effort on a filesystem that orders
608 data writes properly, but can be useful for filesystems that do not use
609 journalling (traditional UNIX filesystems) or that only journal metadata
610 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
613 Enable parallel index preload for operations like 'git diff'
615 This can speed up operations like 'git diff' and 'git status' especially
616 on filesystems like NFS that have weak caching semantics and thus
617 relatively high IO latencies. With this set to 'true', Git will do the
618 index comparison to the filesystem data in parallel, allowing
622 You can set this to 'link', in which case a hardlink followed by
623 a delete of the source are used to make sure that object creation
624 will not overwrite existing objects.
626 On some file system/operating system combinations, this is unreliable.
627 Set this config setting to 'rename' there; However, This will remove the
628 check that makes sure that existing object files will not get overwritten.
631 When showing commit messages, also show notes which are stored in
632 the given ref. The ref must be fully qualified. If the given
633 ref does not exist, it is not an error but means that no
634 notes should be printed.
636 This setting defaults to "refs/notes/commits", and it can be overridden by
637 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
639 core.sparseCheckout::
640 Enable "sparse checkout" feature. See section "Sparse checkout" in
641 linkgit:git-read-tree[1] for more information.
644 Set the length object names are abbreviated to. If unspecified,
645 many commands abbreviate to 7 hexdigits, which may not be enough
646 for abbreviated object names to stay unique for sufficiently long
651 Tells 'git add' to continue adding files when some files cannot be
652 added due to indexing errors. Equivalent to the '--ignore-errors'
653 option of linkgit:git-add[1]. Older versions of Git accept only
654 `add.ignore-errors`, which does not follow the usual naming
655 convention for configuration variables. Newer versions of Git
656 honor `add.ignoreErrors` as well.
659 Command aliases for the linkgit:git[1] command wrapper - e.g.
660 after defining "alias.last = cat-file commit HEAD", the invocation
661 "git last" is equivalent to "git cat-file commit HEAD". To avoid
662 confusion and troubles with script usage, aliases that
663 hide existing Git commands are ignored. Arguments are split by
664 spaces, the usual shell quoting and escaping is supported.
665 quote pair and a backslash can be used to quote them.
667 If the alias expansion is prefixed with an exclamation point,
668 it will be treated as a shell command. For example, defining
669 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
670 "git new" is equivalent to running the shell command
671 "gitk --all --not ORIG_HEAD". Note that shell commands will be
672 executed from the top-level directory of a repository, which may
673 not necessarily be the current directory.
674 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
675 from the original current directory. See linkgit:git-rev-parse[1].
678 If true, git-am will call git-mailsplit for patches in mbox format
679 with parameter '--keep-cr'. In this case git-mailsplit will
680 not remove `\r` from lines ending with `\r\n`. Can be overridden
681 by giving '--no-keep-cr' from the command line.
682 See linkgit:git-am[1], linkgit:git-mailsplit[1].
684 apply.ignorewhitespace::
685 When set to 'change', tells 'git apply' to ignore changes in
686 whitespace, in the same way as the '--ignore-space-change'
688 When set to one of: no, none, never, false tells 'git apply' to
689 respect all whitespace differences.
690 See linkgit:git-apply[1].
693 Tells 'git apply' how to handle whitespaces, in the same way
694 as the '--whitespace' option. See linkgit:git-apply[1].
696 branch.autosetupmerge::
697 Tells 'git branch' and 'git checkout' to set up new branches
698 so that linkgit:git-pull[1] will appropriately merge from the
699 starting point branch. Note that even if this option is not set,
700 this behavior can be chosen per-branch using the `--track`
701 and `--no-track` options. The valid settings are: `false` -- no
702 automatic setup is done; `true` -- automatic setup is done when the
703 starting point is a remote-tracking branch; `always` --
704 automatic setup is done when the starting point is either a
705 local branch or remote-tracking
706 branch. This option defaults to true.
708 branch.autosetuprebase::
709 When a new branch is created with 'git branch' or 'git checkout'
710 that tracks another branch, this variable tells Git to set
711 up pull to rebase instead of merge (see "branch.<name>.rebase").
712 When `never`, rebase is never automatically set to true.
713 When `local`, rebase is set to true for tracked branches of
714 other local branches.
715 When `remote`, rebase is set to true for tracked branches of
716 remote-tracking branches.
717 When `always`, rebase will be set to true for all tracking
719 See "branch.autosetupmerge" for details on how to set up a
720 branch to track another branch.
721 This option defaults to never.
723 branch.<name>.remote::
724 When on branch <name>, it tells 'git fetch' and 'git push'
725 which remote to fetch from/push to. The remote to push to
726 may be overridden with `remote.pushdefault` (for all branches).
727 The remote to push to, for the current branch, may be further
728 overridden by `branch.<name>.pushremote`. If no remote is
729 configured, or if you are not on any branch, it defaults to
730 `origin` for fetching and `remote.pushdefault` for pushing.
731 Additionally, `.` (a period) is the current local repository
732 (a dot-repository), see `branch.<name>.merge`'s final note below.
734 branch.<name>.pushremote::
735 When on branch <name>, it overrides `branch.<name>.remote` for
736 pushing. It also overrides `remote.pushdefault` for pushing
737 from branch <name>. When you pull from one place (e.g. your
738 upstream) and push to another place (e.g. your own publishing
739 repository), you would want to set `remote.pushdefault` to
740 specify the remote to push to for all branches, and use this
741 option to override it for a specific branch.
743 branch.<name>.merge::
744 Defines, together with branch.<name>.remote, the upstream branch
745 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
746 branch to merge and can also affect 'git push' (see push.default).
747 When in branch <name>, it tells 'git fetch' the default
748 refspec to be marked for merging in FETCH_HEAD. The value is
749 handled like the remote part of a refspec, and must match a
750 ref which is fetched from the remote given by
751 "branch.<name>.remote".
752 The merge information is used by 'git pull' (which at first calls
753 'git fetch') to lookup the default branch for merging. Without
754 this option, 'git pull' defaults to merge the first refspec fetched.
755 Specify multiple values to get an octopus merge.
756 If you wish to setup 'git pull' so that it merges into <name> from
757 another branch in the local repository, you can point
758 branch.<name>.merge to the desired branch, and use the relative path
759 setting `.` (a period) for branch.<name>.remote.
761 branch.<name>.mergeoptions::
762 Sets default options for merging into branch <name>. The syntax and
763 supported options are the same as those of linkgit:git-merge[1], but
764 option values containing whitespace characters are currently not
767 branch.<name>.rebase::
768 When true, rebase the branch <name> on top of the fetched branch,
769 instead of merging the default branch from the default remote when
770 "git pull" is run. See "pull.rebase" for doing this in a non
771 branch-specific manner.
773 When preserve, also pass `--preserve-merges` along to 'git rebase'
774 so that locally committed merge commits will not be flattened
775 by running 'git pull'.
777 *NOTE*: this is a possibly dangerous operation; do *not* use
778 it unless you understand the implications (see linkgit:git-rebase[1]
781 branch.<name>.description::
782 Branch description, can be edited with
783 `git branch --edit-description`. Branch description is
784 automatically added in the format-patch cover letter or
785 request-pull summary.
788 Specify the command to invoke the specified browser. The
789 specified command is evaluated in shell with the URLs passed
790 as arguments. (See linkgit:git-web{litdd}browse[1].)
792 browser.<tool>.path::
793 Override the path for the given tool that may be used to
794 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
795 working repository in gitweb (see linkgit:git-instaweb[1]).
798 A boolean to make git-clean do nothing unless given -f,
799 -i or -n. Defaults to true.
802 A boolean to enable/disable color in the output of
803 linkgit:git-branch[1]. May be set to `always`,
804 `false` (or `never`) or `auto` (or `true`), in which case colors are used
805 only when the output is to a terminal. Defaults to false.
807 color.branch.<slot>::
808 Use customized color for branch coloration. `<slot>` is one of
809 `current` (the current branch), `local` (a local branch),
810 `remote` (a remote-tracking branch in refs/remotes/),
811 `upstream` (upstream tracking branch), `plain` (other
814 The value for these configuration variables is a list of colors (at most
815 two) and attributes (at most one), separated by spaces. The colors
816 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
817 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
818 `blink` and `reverse`. The first color given is the foreground; the
819 second is the background. The position of the attribute, if any,
823 Whether to use ANSI escape sequences to add color to patches.
824 If this is set to `always`, linkgit:git-diff[1],
825 linkgit:git-log[1], and linkgit:git-show[1] will use color
826 for all patches. If it is set to `true` or `auto`, those
827 commands will only use color when output is to the terminal.
830 This does not affect linkgit:git-format-patch[1] nor the
831 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
832 command line with the `--color[=<when>]` option.
835 Use customized color for diff colorization. `<slot>` specifies
836 which part of the patch to use the specified color, and is one
837 of `plain` (context text), `meta` (metainformation), `frag`
838 (hunk header), 'func' (function in hunk header), `old` (removed lines),
839 `new` (added lines), `commit` (commit headers), or `whitespace`
840 (highlighting whitespace errors). The values of these variables may be
841 specified as in color.branch.<slot>.
843 color.decorate.<slot>::
844 Use customized color for 'git log --decorate' output. `<slot>` is one
845 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
846 branches, remote-tracking branches, tags, stash and HEAD, respectively.
849 When set to `always`, always highlight matches. When `false` (or
850 `never`), never. When set to `true` or `auto`, use color only
851 when the output is written to the terminal. Defaults to `false`.
854 Use customized color for grep colorization. `<slot>` specifies which
855 part of the line to use the specified color, and is one of
859 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
861 filename prefix (when not using `-h`)
863 function name lines (when using `-p`)
865 line number prefix (when using `-n`)
869 non-matching text in selected lines
871 separators between fields on a line (`:`, `-`, and `=`)
872 and between hunks (`--`)
875 The values of these variables may be specified as in color.branch.<slot>.
878 When set to `always`, always use colors for interactive prompts
879 and displays (such as those used by "git-add --interactive" and
880 "git-clean --interactive"). When false (or `never`), never.
881 When set to `true` or `auto`, use colors only when the output is
882 to the terminal. Defaults to false.
884 color.interactive.<slot>::
885 Use customized color for 'git add --interactive' and 'git clean
886 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
887 or `error`, for four distinct types of normal output from
888 interactive commands. The values of these variables may be
889 specified as in color.branch.<slot>.
892 A boolean to enable/disable colored output when the pager is in
893 use (default is true).
896 A boolean to enable/disable color in the output of
897 linkgit:git-show-branch[1]. May be set to `always`,
898 `false` (or `never`) or `auto` (or `true`), in which case colors are used
899 only when the output is to a terminal. Defaults to false.
902 A boolean to enable/disable color in the output of
903 linkgit:git-status[1]. May be set to `always`,
904 `false` (or `never`) or `auto` (or `true`), in which case colors are used
905 only when the output is to a terminal. Defaults to false.
907 color.status.<slot>::
908 Use customized color for status colorization. `<slot>` is
909 one of `header` (the header text of the status message),
910 `added` or `updated` (files which are added but not committed),
911 `changed` (files which are changed but not added in the index),
912 `untracked` (files which are not tracked by Git),
913 `branch` (the current branch), or
914 `nobranch` (the color the 'no branch' warning is shown in, defaulting
915 to red). The values of these variables may be specified as in
919 This variable determines the default value for variables such
920 as `color.diff` and `color.grep` that control the use of color
921 per command family. Its scope will expand as more commands learn
922 configuration to set a default for the `--color` option. Set it
923 to `false` or `never` if you prefer Git commands not to use
924 color unless enabled explicitly with some other configuration
925 or the `--color` option. Set it to `always` if you want all
926 output not intended for machine consumption to use color, to
927 `true` or `auto` (this is the default since Git 1.8.4) if you
928 want such output to use color when written to the terminal.
931 Specify whether supported commands should output in columns.
932 This variable consists of a list of tokens separated by spaces
935 These options control when the feature should be enabled
936 (defaults to 'never'):
940 always show in columns
942 never show in columns
944 show in columns if the output is to the terminal
947 These options control layout (defaults to 'column'). Setting any
948 of these implies 'always' if none of 'always', 'never', or 'auto' are
953 fill columns before rows
955 fill rows before columns
960 Finally, these options can be combined with a layout option (defaults
965 make unequal size columns to utilize more space
967 make equal size columns
971 Specify whether to output branch listing in `git branch` in columns.
972 See `column.ui` for details.
975 Specify the layout when list items in `git clean -i`, which always
976 shows files and directories in columns. See `column.ui` for details.
979 Specify whether to output untracked files in `git status` in columns.
980 See `column.ui` for details.
983 Specify whether to output tag listing in `git tag` in columns.
984 See `column.ui` for details.
987 This setting overrides the default of the `--cleanup` option in
988 `git commit`. See linkgit:git-commit[1] for details. Changing the
989 default can be useful when you always want to keep lines that begin
990 with comment character `#` in your log message, in which case you
991 would do `git config commit.cleanup whitespace` (note that you will
992 have to remove the help lines that begin with `#` in the commit log
993 template yourself, if you do this).
997 A boolean to specify whether all commits should be GPG signed.
998 Use of this option when doing operations such as rebase can
999 result in a large number of commits being signed. It may be
1000 convenient to use an agent to avoid typing your GPG passphrase
1004 A boolean to enable/disable inclusion of status information in the
1005 commit message template when using an editor to prepare the commit
1006 message. Defaults to true.
1009 Specify a file to use as the template for new commit messages.
1010 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1011 specified user's home directory.
1014 Specify an external helper to be called when a username or
1015 password credential is needed; the helper may consult external
1016 storage to avoid prompting the user for the credentials. See
1017 linkgit:gitcredentials[7] for details.
1019 credential.useHttpPath::
1020 When acquiring credentials, consider the "path" component of an http
1021 or https URL to be important. Defaults to false. See
1022 linkgit:gitcredentials[7] for more information.
1024 credential.username::
1025 If no username is set for a network authentication, use this username
1026 by default. See credential.<context>.* below, and
1027 linkgit:gitcredentials[7].
1029 credential.<url>.*::
1030 Any of the credential.* options above can be applied selectively to
1031 some credentials. For example "credential.https://example.com.username"
1032 would set the default username only for https connections to
1033 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1036 include::diff-config.txt[]
1038 difftool.<tool>.path::
1039 Override the path for the given tool. This is useful in case
1040 your tool is not in the PATH.
1042 difftool.<tool>.cmd::
1043 Specify the command to invoke the specified diff tool.
1044 The specified command is evaluated in shell with the following
1045 variables available: 'LOCAL' is set to the name of the temporary
1046 file containing the contents of the diff pre-image and 'REMOTE'
1047 is set to the name of the temporary file containing the contents
1048 of the diff post-image.
1051 Prompt before each invocation of the diff tool.
1053 fetch.recurseSubmodules::
1054 This option can be either set to a boolean value or to 'on-demand'.
1055 Setting it to a boolean changes the behavior of fetch and pull to
1056 unconditionally recurse into submodules when set to true or to not
1057 recurse at all when set to false. When set to 'on-demand' (the default
1058 value), fetch and pull will only recurse into a populated submodule
1059 when its superproject retrieves a commit that updates the submodule's
1063 If it is set to true, git-fetch-pack will check all fetched
1064 objects. It will abort in the case of a malformed object or a
1065 broken link. The result of an abort are only dangling objects.
1066 Defaults to false. If not set, the value of `transfer.fsckObjects`
1070 If the number of objects fetched over the Git native
1071 transfer is below this
1072 limit, then the objects will be unpacked into loose object
1073 files. However if the number of received objects equals or
1074 exceeds this limit then the received pack will be stored as
1075 a pack, after adding any missing delta bases. Storing the
1076 pack from a push can make the push operation complete faster,
1077 especially on slow filesystems. If not set, the value of
1078 `transfer.unpackLimit` is used instead.
1081 If true, fetch will automatically behave as if the `--prune`
1082 option was given on the command line. See also `remote.<name>.prune`.
1085 Enable multipart/mixed attachments as the default for
1086 'format-patch'. The value can also be a double quoted string
1087 which will enable attachments as the default and set the
1088 value as the boundary. See the --attach option in
1089 linkgit:git-format-patch[1].
1092 A boolean which can enable or disable sequence numbers in patch
1093 subjects. It defaults to "auto" which enables it only if there
1094 is more than one patch. It can be enabled or disabled for all
1095 messages by setting it to "true" or "false". See --numbered
1096 option in linkgit:git-format-patch[1].
1099 Additional email headers to include in a patch to be submitted
1100 by mail. See linkgit:git-format-patch[1].
1104 Additional recipients to include in a patch to be submitted
1105 by mail. See the --to and --cc options in
1106 linkgit:git-format-patch[1].
1108 format.subjectprefix::
1109 The default for format-patch is to output files with the '[PATCH]'
1110 subject prefix. Use this variable to change that prefix.
1113 The default for format-patch is to output a signature containing
1114 the Git version number. Use this variable to change that default.
1115 Set this variable to the empty string ("") to suppress
1116 signature generation.
1119 The default for format-patch is to output files with the suffix
1120 `.patch`. Use this variable to change that suffix (make sure to
1121 include the dot if you want it).
1124 The default pretty format for log/show/whatchanged command,
1125 See linkgit:git-log[1], linkgit:git-show[1],
1126 linkgit:git-whatchanged[1].
1129 The default threading style for 'git format-patch'. Can be
1130 a boolean value, or `shallow` or `deep`. `shallow` threading
1131 makes every mail a reply to the head of the series,
1132 where the head is chosen from the cover letter, the
1133 `--in-reply-to`, and the first patch mail, in this order.
1134 `deep` threading makes every mail a reply to the previous one.
1135 A true boolean value is the same as `shallow`, and a false
1136 value disables threading.
1139 A boolean value which lets you enable the `-s/--signoff` option of
1140 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1141 patch should be a conscious act and means that you certify you have
1142 the rights to submit this work under the same open source license.
1143 Please see the 'SubmittingPatches' document for further discussion.
1145 format.coverLetter::
1146 A boolean that controls whether to generate a cover-letter when
1147 format-patch is invoked, but in addition can be set to "auto", to
1148 generate a cover-letter only when there's more than one patch.
1150 filter.<driver>.clean::
1151 The command which is used to convert the content of a worktree
1152 file to a blob upon checkin. See linkgit:gitattributes[5] for
1155 filter.<driver>.smudge::
1156 The command which is used to convert the content of a blob
1157 object to a worktree file upon checkout. See
1158 linkgit:gitattributes[5] for details.
1160 gc.aggressiveWindow::
1161 The window size parameter used in the delta compression
1162 algorithm used by 'git gc --aggressive'. This defaults
1166 When there are approximately more than this many loose
1167 objects in the repository, `git gc --auto` will pack them.
1168 Some Porcelain commands use this command to perform a
1169 light-weight garbage collection from time to time. The
1170 default value is 6700. Setting this to 0 disables it.
1173 When there are more than this many packs that are not
1174 marked with `*.keep` file in the repository, `git gc
1175 --auto` consolidates them into one larger pack. The
1176 default value is 50. Setting this to 0 disables it.
1179 Running `git pack-refs` in a repository renders it
1180 unclonable by Git versions prior to 1.5.1.2 over dumb
1181 transports such as HTTP. This variable determines whether
1182 'git gc' runs `git pack-refs`. This can be set to `notbare`
1183 to enable it within all non-bare repos or it can be set to a
1184 boolean value. The default is `true`.
1187 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1188 Override the grace period with this config variable. The value
1189 "now" may be used to disable this grace period and always prune
1190 unreachable objects immediately.
1193 gc.<pattern>.reflogexpire::
1194 'git reflog expire' removes reflog entries older than
1195 this time; defaults to 90 days. With "<pattern>" (e.g.
1196 "refs/stash") in the middle the setting applies only to
1197 the refs that match the <pattern>.
1199 gc.reflogexpireunreachable::
1200 gc.<ref>.reflogexpireunreachable::
1201 'git reflog expire' removes reflog entries older than
1202 this time and are not reachable from the current tip;
1203 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1204 in the middle, the setting applies only to the refs that
1205 match the <pattern>.
1208 Records of conflicted merge you resolved earlier are
1209 kept for this many days when 'git rerere gc' is run.
1210 The default is 60 days. See linkgit:git-rerere[1].
1212 gc.rerereunresolved::
1213 Records of conflicted merge you have not resolved are
1214 kept for this many days when 'git rerere gc' is run.
1215 The default is 15 days. See linkgit:git-rerere[1].
1217 gitcvs.commitmsgannotation::
1218 Append this string to each commit message. Set to empty string
1219 to disable this feature. Defaults to "via git-CVS emulator".
1222 Whether the CVS server interface is enabled for this repository.
1223 See linkgit:git-cvsserver[1].
1226 Path to a log file where the CVS server interface well... logs
1227 various stuff. See linkgit:git-cvsserver[1].
1229 gitcvs.usecrlfattr::
1230 If true, the server will look up the end-of-line conversion
1231 attributes for files to determine the '-k' modes to use. If
1232 the attributes force Git to treat a file as text,
1233 the '-k' mode will be left blank so CVS clients will
1234 treat it as text. If they suppress text conversion, the file
1235 will be set with '-kb' mode, which suppresses any newline munging
1236 the client might otherwise do. If the attributes do not allow
1237 the file type to be determined, then 'gitcvs.allbinary' is
1238 used. See linkgit:gitattributes[5].
1241 This is used if 'gitcvs.usecrlfattr' does not resolve
1242 the correct '-kb' mode to use. If true, all
1243 unresolved files are sent to the client in
1244 mode '-kb'. This causes the client to treat them
1245 as binary files, which suppresses any newline munging it
1246 otherwise might do. Alternatively, if it is set to "guess",
1247 then the contents of the file are examined to decide if
1248 it is binary, similar to 'core.autocrlf'.
1251 Database used by git-cvsserver to cache revision information
1252 derived from the Git repository. The exact meaning depends on the
1253 used database driver, for SQLite (which is the default driver) this
1254 is a filename. Supports variable substitution (see
1255 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1256 Default: '%Ggitcvs.%m.sqlite'
1259 Used Perl DBI driver. You can specify any available driver
1260 for this here, but it might not work. git-cvsserver is tested
1261 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1262 reported *not* to work with 'DBD::mysql'. Experimental feature.
1263 May not contain double colons (`:`). Default: 'SQLite'.
1264 See linkgit:git-cvsserver[1].
1266 gitcvs.dbuser, gitcvs.dbpass::
1267 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1268 since SQLite has no concept of database users and/or passwords.
1269 'gitcvs.dbuser' supports variable substitution (see
1270 linkgit:git-cvsserver[1] for details).
1272 gitcvs.dbTableNamePrefix::
1273 Database table name prefix. Prepended to the names of any
1274 database tables used, allowing a single database to be used
1275 for several repositories. Supports variable substitution (see
1276 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1277 characters will be replaced with underscores.
1279 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1280 'gitcvs.allbinary' can also be specified as
1281 'gitcvs.<access_method>.<varname>' (where 'access_method'
1282 is one of "ext" and "pserver") to make them apply only for the given
1286 gitweb.description::
1289 See linkgit:gitweb[1] for description.
1297 gitweb.remote_heads::
1300 See linkgit:gitweb.conf[5] for description.
1303 If set to true, enable '-n' option by default.
1306 Set the default matching behavior. Using a value of 'basic', 'extended',
1307 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1308 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1309 value 'default' will return to the default matching behavior.
1311 grep.extendedRegexp::
1312 If set to true, enable '--extended-regexp' option by default. This
1313 option is ignored when the 'grep.patternType' option is set to a value
1314 other than 'default'.
1317 Use this custom program instead of "gpg" found on $PATH when
1318 making or verifying a PGP signature. The program must support the
1319 same command line interface as GPG, namely, to verify a detached
1320 signature, "gpg --verify $file - <$signature" is run, and the
1321 program is expected to signal a good signature by exiting with
1322 code 0, and to generate an ascii-armored detached signature, the
1323 standard input of "gpg -bsau $key" is fed with the contents to be
1324 signed, and the program is expected to send the result to its
1327 gui.commitmsgwidth::
1328 Defines how wide the commit message window is in the
1329 linkgit:git-gui[1]. "75" is the default.
1332 Specifies how many context lines should be used in calls to diff
1333 made by the linkgit:git-gui[1]. The default is "5".
1336 Specifies the default encoding to use for displaying of
1337 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1338 It can be overridden by setting the 'encoding' attribute
1339 for relevant files (see linkgit:gitattributes[5]).
1340 If this option is not set, the tools default to the
1343 gui.matchtrackingbranch::
1344 Determines if new branches created with linkgit:git-gui[1] should
1345 default to tracking remote branches with matching names or
1346 not. Default: "false".
1348 gui.newbranchtemplate::
1349 Is used as suggested name when creating new branches using the
1352 gui.pruneduringfetch::
1353 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1354 performing a fetch. The default value is "false".
1357 Determines if linkgit:git-gui[1] should trust the file modification
1358 timestamp or not. By default the timestamps are not trusted.
1360 gui.spellingdictionary::
1361 Specifies the dictionary used for spell checking commit messages in
1362 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1366 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1367 location detection. It makes blame significantly faster on huge
1368 repositories at the expense of less thorough copy detection.
1370 gui.copyblamethreshold::
1371 Specifies the threshold to use in 'git gui blame' original location
1372 detection, measured in alphanumeric characters. See the
1373 linkgit:git-blame[1] manual for more information on copy detection.
1375 gui.blamehistoryctx::
1376 Specifies the radius of history context in days to show in
1377 linkgit:gitk[1] for the selected commit, when the `Show History
1378 Context` menu item is invoked from 'git gui blame'. If this
1379 variable is set to zero, the whole history is shown.
1381 guitool.<name>.cmd::
1382 Specifies the shell command line to execute when the corresponding item
1383 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1384 mandatory for every tool. The command is executed from the root of
1385 the working directory, and in the environment it receives the name of
1386 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1387 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1388 the head is detached, 'CUR_BRANCH' is empty).
1390 guitool.<name>.needsfile::
1391 Run the tool only if a diff is selected in the GUI. It guarantees
1392 that 'FILENAME' is not empty.
1394 guitool.<name>.noconsole::
1395 Run the command silently, without creating a window to display its
1398 guitool.<name>.norescan::
1399 Don't rescan the working directory for changes after the tool
1402 guitool.<name>.confirm::
1403 Show a confirmation dialog before actually running the tool.
1405 guitool.<name>.argprompt::
1406 Request a string argument from the user, and pass it to the tool
1407 through the 'ARGS' environment variable. Since requesting an
1408 argument implies confirmation, the 'confirm' option has no effect
1409 if this is enabled. If the option is set to 'true', 'yes', or '1',
1410 the dialog uses a built-in generic prompt; otherwise the exact
1411 value of the variable is used.
1413 guitool.<name>.revprompt::
1414 Request a single valid revision from the user, and set the
1415 'REVISION' environment variable. In other aspects this option
1416 is similar to 'argprompt', and can be used together with it.
1418 guitool.<name>.revunmerged::
1419 Show only unmerged branches in the 'revprompt' subdialog.
1420 This is useful for tools similar to merge or rebase, but not
1421 for things like checkout or reset.
1423 guitool.<name>.title::
1424 Specifies the title to use for the prompt dialog. The default
1427 guitool.<name>.prompt::
1428 Specifies the general prompt string to display at the top of
1429 the dialog, before subsections for 'argprompt' and 'revprompt'.
1430 The default value includes the actual command.
1433 Specify the browser that will be used to display help in the
1434 'web' format. See linkgit:git-help[1].
1437 Override the default help format used by linkgit:git-help[1].
1438 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1439 the default. 'web' and 'html' are the same.
1442 Automatically correct and execute mistyped commands after
1443 waiting for the given number of deciseconds (0.1 sec). If more
1444 than one command can be deduced from the entered text, nothing
1445 will be executed. If the value of this option is negative,
1446 the corrected command will be executed immediately. If the
1447 value is 0 - the command will be just shown but not executed.
1448 This is the default.
1451 Specify the path where the HTML documentation resides. File system paths
1452 and URLs are supported. HTML pages will be prefixed with this path when
1453 help is displayed in the 'web' format. This defaults to the documentation
1454 path of your Git installation.
1457 Override the HTTP proxy, normally configured using the 'http_proxy',
1458 'https_proxy', and 'all_proxy' environment variables (see
1459 `curl(1)`). This can be overridden on a per-remote basis; see
1463 File containing previously stored cookie lines which should be used
1464 in the Git http session, if they match the server. The file format
1465 of the file to read cookies from should be plain HTTP headers or
1466 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1467 NOTE that the file specified with http.cookiefile is only used as
1468 input unless http.saveCookies is set.
1471 If set, store cookies received during requests to the file specified by
1472 http.cookiefile. Has no effect if http.cookiefile is unset.
1475 Whether to verify the SSL certificate when fetching or pushing
1476 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1480 File containing the SSL certificate when fetching or pushing
1481 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1485 File containing the SSL private key when fetching or pushing
1486 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1489 http.sslCertPasswordProtected::
1490 Enable Git's password prompt for the SSL certificate. Otherwise
1491 OpenSSL will prompt the user, possibly many times, if the
1492 certificate or private key is encrypted. Can be overridden by the
1493 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1496 File containing the certificates to verify the peer with when
1497 fetching or pushing over HTTPS. Can be overridden by the
1498 'GIT_SSL_CAINFO' environment variable.
1501 Path containing files with the CA certificates to verify the peer
1502 with when fetching or pushing over HTTPS. Can be overridden
1503 by the 'GIT_SSL_CAPATH' environment variable.
1506 Attempt to use AUTH SSL/TLS and encrypted data transfers
1507 when connecting via regular FTP protocol. This might be needed
1508 if the FTP server requires it for security reasons or you wish
1509 to connect securely whenever remote FTP server supports it.
1510 Default is false since it might trigger certificate verification
1511 errors on misconfigured servers.
1514 How many HTTP requests to launch in parallel. Can be overridden
1515 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1518 The number of curl sessions (counted across slots) to be kept across
1519 requests. They will not be ended with curl_easy_cleanup() until
1520 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1521 value will be capped at 1. Defaults to 1.
1524 Maximum size in bytes of the buffer used by smart HTTP
1525 transports when POSTing data to the remote system.
1526 For requests larger than this buffer size, HTTP/1.1 and
1527 Transfer-Encoding: chunked is used to avoid creating a
1528 massive pack file locally. Default is 1 MiB, which is
1529 sufficient for most requests.
1531 http.lowSpeedLimit, http.lowSpeedTime::
1532 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1533 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1534 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1535 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1538 A boolean which disables using of EPSV ftp command by curl.
1539 This can helpful with some "poor" ftp servers which don't
1540 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1541 environment variable. Default is false (curl will use EPSV).
1544 The HTTP USER_AGENT string presented to an HTTP server. The default
1545 value represents the version of the client Git such as git/1.7.1.
1546 This option allows you to override this value to a more common value
1547 such as Mozilla/4.0. This may be necessary, for instance, if
1548 connecting through a firewall that restricts HTTP connections to a set
1549 of common USER_AGENT strings (but not including those like git/1.7.1).
1550 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1553 Any of the http.* options above can be applied selectively to some urls.
1554 For a config key to match a URL, each element of the config key is
1555 compared to that of the URL, in the following order:
1558 . Scheme (e.g., `https` in `https://example.com/`). This field
1559 must match exactly between the config key and the URL.
1561 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1562 This field must match exactly between the config key and the URL.
1564 . Port number (e.g., `8080` in `http://example.com:8080/`).
1565 This field must match exactly between the config key and the URL.
1566 Omitted port numbers are automatically converted to the correct
1567 default for the scheme before matching.
1569 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1570 path field of the config key must match the path field of the URL
1571 either exactly or as a prefix of slash-delimited path elements. This means
1572 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1573 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1574 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1575 key with just path `foo/`).
1577 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1578 the config key has a user name it must match the user name in the
1579 URL exactly. If the config key does not have a user name, that
1580 config key will match a URL with any user name (including none),
1581 but at a lower precedence than a config key with a user name.
1584 The list above is ordered by decreasing precedence; a URL that matches
1585 a config key's path is preferred to one that matches its user name. For example,
1586 if the URL is `https://user@example.com/foo/bar` a config key match of
1587 `https://example.com/foo` will be preferred over a config key match of
1588 `https://user@example.com`.
1590 All URLs are normalized before attempting any matching (the password part,
1591 if embedded in the URL, is always ignored for matching purposes) so that
1592 equivalent urls that are simply spelled differently will match properly.
1593 Environment variable settings always override any matches. The urls that are
1594 matched against are those given directly to Git commands. This means any URLs
1595 visited as a result of a redirection do not participate in matching.
1597 i18n.commitEncoding::
1598 Character encoding the commit messages are stored in; Git itself
1599 does not care per se, but this information is necessary e.g. when
1600 importing commits from emails or in the gitk graphical history
1601 browser (and possibly at other places in the future or in other
1602 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1604 i18n.logOutputEncoding::
1605 Character encoding the commit messages are converted to when
1606 running 'git log' and friends.
1609 The configuration variables in the 'imap' section are described
1610 in linkgit:git-imap-send[1].
1613 Specify the directory from which templates will be copied.
1614 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1617 Specify the program that will be used to browse your working
1618 repository in gitweb. See linkgit:git-instaweb[1].
1621 The HTTP daemon command-line to start gitweb on your working
1622 repository. See linkgit:git-instaweb[1].
1625 If true the web server started by linkgit:git-instaweb[1] will
1626 be bound to the local IP (127.0.0.1).
1628 instaweb.modulepath::
1629 The default module path for linkgit:git-instaweb[1] to use
1630 instead of /usr/lib/apache2/modules. Only used if httpd
1634 The port number to bind the gitweb httpd to. See
1635 linkgit:git-instaweb[1].
1637 interactive.singlekey::
1638 In interactive commands, allow the user to provide one-letter
1639 input with a single key (i.e., without hitting enter).
1640 Currently this is used by the `--patch` mode of
1641 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1642 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1643 setting is silently ignored if portable keystroke input
1647 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1648 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1649 override this option with `--no-abbrev-commit`.
1652 Set the default date-time mode for the 'log' command.
1653 Setting a value for log.date is similar to using 'git log''s
1654 `--date` option. Possible values are `relative`, `local`,
1655 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1659 Print out the ref names of any commits that are shown by the log
1660 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1661 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1662 specified, the full ref name (including prefix) will be printed.
1663 This is the same as the log commands '--decorate' option.
1666 If true, the initial commit will be shown as a big creation event.
1667 This is equivalent to a diff against an empty tree.
1668 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1669 normally hide the root commit will now show it. True by default.
1672 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1673 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1676 The location of an augmenting mailmap file. The default
1677 mailmap, located in the root of the repository, is loaded
1678 first, then the mailmap file pointed to by this variable.
1679 The location of the mailmap file may be in a repository
1680 subdirectory, or somewhere outside of the repository itself.
1681 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1684 Like `mailmap.file`, but consider the value as a reference to a
1685 blob in the repository. If both `mailmap.file` and
1686 `mailmap.blob` are given, both are parsed, with entries from
1687 `mailmap.file` taking precedence. In a bare repository, this
1688 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1692 Specify the programs that may be used to display help in the
1693 'man' format. See linkgit:git-help[1].
1696 Specify the command to invoke the specified man viewer. The
1697 specified command is evaluated in shell with the man page
1698 passed as argument. (See linkgit:git-help[1].)
1701 Override the path for the given tool that may be used to
1702 display help in the 'man' format. See linkgit:git-help[1].
1704 include::merge-config.txt[]
1706 mergetool.<tool>.path::
1707 Override the path for the given tool. This is useful in case
1708 your tool is not in the PATH.
1710 mergetool.<tool>.cmd::
1711 Specify the command to invoke the specified merge tool. The
1712 specified command is evaluated in shell with the following
1713 variables available: 'BASE' is the name of a temporary file
1714 containing the common base of the files to be merged, if available;
1715 'LOCAL' is the name of a temporary file containing the contents of
1716 the file on the current branch; 'REMOTE' is the name of a temporary
1717 file containing the contents of the file from the branch being
1718 merged; 'MERGED' contains the name of the file to which the merge
1719 tool should write the results of a successful merge.
1721 mergetool.<tool>.trustExitCode::
1722 For a custom merge command, specify whether the exit code of
1723 the merge command can be used to determine whether the merge was
1724 successful. If this is not set to true then the merge target file
1725 timestamp is checked and the merge assumed to have been successful
1726 if the file has been updated, otherwise the user is prompted to
1727 indicate the success of the merge.
1729 mergetool.keepBackup::
1730 After performing a merge, the original file with conflict markers
1731 can be saved as a file with a `.orig` extension. If this variable
1732 is set to `false` then this file is not preserved. Defaults to
1733 `true` (i.e. keep the backup files).
1735 mergetool.keepTemporaries::
1736 When invoking a custom merge tool, Git uses a set of temporary
1737 files to pass to the tool. If the tool returns an error and this
1738 variable is set to `true`, then these temporary files will be
1739 preserved, otherwise they will be removed after the tool has
1740 exited. Defaults to `false`.
1743 Prompt before each invocation of the merge resolution program.
1746 The (fully qualified) refname from which to show notes when
1747 showing commit messages. The value of this variable can be set
1748 to a glob, in which case notes from all matching refs will be
1749 shown. You may also specify this configuration variable
1750 several times. A warning will be issued for refs that do not
1751 exist, but a glob that does not match any refs is silently
1754 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1755 environment variable, which must be a colon separated list of refs or
1758 The effective value of "core.notesRef" (possibly overridden by
1759 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1762 notes.rewrite.<command>::
1763 When rewriting commits with <command> (currently `amend` or
1764 `rebase`) and this variable is set to `true`, Git
1765 automatically copies your notes from the original to the
1766 rewritten commit. Defaults to `true`, but see
1767 "notes.rewriteRef" below.
1770 When copying notes during a rewrite (see the
1771 "notes.rewrite.<command>" option), determines what to do if
1772 the target commit already has a note. Must be one of
1773 `overwrite`, `concatenate`, or `ignore`. Defaults to
1776 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1777 environment variable.
1780 When copying notes during a rewrite, specifies the (fully
1781 qualified) ref whose notes should be copied. The ref may be a
1782 glob, in which case notes in all matching refs will be copied.
1783 You may also specify this configuration several times.
1785 Does not have a default value; you must configure this variable to
1786 enable note rewriting. Set it to `refs/notes/commits` to enable
1787 rewriting for the default commit notes.
1789 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1790 environment variable, which must be a colon separated list of refs or
1794 The size of the window used by linkgit:git-pack-objects[1] when no
1795 window size is given on the command line. Defaults to 10.
1798 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1799 maximum depth is given on the command line. Defaults to 50.
1802 The window memory size limit used by linkgit:git-pack-objects[1]
1803 when no limit is given on the command line. The value can be
1804 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1808 An integer -1..9, indicating the compression level for objects
1809 in a pack file. -1 is the zlib default. 0 means no
1810 compression, and 1..9 are various speed/size tradeoffs, 9 being
1811 slowest. If not set, defaults to core.compression. If that is
1812 not set, defaults to -1, the zlib default, which is "a default
1813 compromise between speed and compression (currently equivalent
1816 Note that changing the compression level will not automatically recompress
1817 all existing objects. You can force recompression by passing the -F option
1818 to linkgit:git-repack[1].
1820 pack.deltaCacheSize::
1821 The maximum memory in bytes used for caching deltas in
1822 linkgit:git-pack-objects[1] before writing them out to a pack.
1823 This cache is used to speed up the writing object phase by not
1824 having to recompute the final delta result once the best match
1825 for all objects is found. Repacking large repositories on machines
1826 which are tight with memory might be badly impacted by this though,
1827 especially if this cache pushes the system into swapping.
1828 A value of 0 means no limit. The smallest size of 1 byte may be
1829 used to virtually disable this cache. Defaults to 256 MiB.
1831 pack.deltaCacheLimit::
1832 The maximum size of a delta, that is cached in
1833 linkgit:git-pack-objects[1]. This cache is used to speed up the
1834 writing object phase by not having to recompute the final delta
1835 result once the best match for all objects is found. Defaults to 1000.
1838 Specifies the number of threads to spawn when searching for best
1839 delta matches. This requires that linkgit:git-pack-objects[1]
1840 be compiled with pthreads otherwise this option is ignored with a
1841 warning. This is meant to reduce packing time on multiprocessor
1842 machines. The required amount of memory for the delta search window
1843 is however multiplied by the number of threads.
1844 Specifying 0 will cause Git to auto-detect the number of CPU's
1845 and set the number of threads accordingly.
1848 Specify the default pack index version. Valid values are 1 for
1849 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1850 the new pack index with capabilities for packs larger than 4 GB
1851 as well as proper protection against the repacking of corrupted
1852 packs. Version 2 is the default. Note that version 2 is enforced
1853 and this config option ignored whenever the corresponding pack is
1856 If you have an old Git that does not understand the version 2 `*.idx` file,
1857 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1858 that will copy both `*.pack` file and corresponding `*.idx` file from the
1859 other side may give you a repository that cannot be accessed with your
1860 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1861 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1864 pack.packSizeLimit::
1865 The maximum size of a pack. This setting only affects
1866 packing to a file when repacking, i.e. the git:// protocol
1867 is unaffected. It can be overridden by the `--max-pack-size`
1868 option of linkgit:git-repack[1]. The minimum size allowed is
1869 limited to 1 MiB. The default is unlimited.
1870 Common unit suffixes of 'k', 'm', or 'g' are
1874 When true, git will use pack bitmaps (if available) when packing
1875 to stdout (e.g., during the server side of a fetch). Defaults to
1876 true. You should not generally need to turn this off unless
1877 you are debugging pack bitmaps.
1880 When true, git will write a bitmap index when packing all
1881 objects to disk (e.g., when `git repack -a` is run). This
1882 index can speed up the "counting objects" phase of subsequent
1883 packs created for clones and fetches, at the cost of some disk
1884 space and extra time spent on the initial repack. Defaults to
1887 pack.writeBitmapHashCache::
1888 When true, git will include a "hash cache" section in the bitmap
1889 index (if one is written). This cache can be used to feed git's
1890 delta heuristics, potentially leading to better deltas between
1891 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1892 between an older, bitmapped pack and objects that have been
1893 pushed since the last gc). The downside is that it consumes 4
1894 bytes per object of disk space, and that JGit's bitmap
1895 implementation does not understand it, causing it to complain if
1896 Git and JGit are used on the same repository. Defaults to false.
1899 If the value is boolean, turns on or off pagination of the
1900 output of a particular Git subcommand when writing to a tty.
1901 Otherwise, turns on pagination for the subcommand using the
1902 pager specified by the value of `pager.<cmd>`. If `--paginate`
1903 or `--no-pager` is specified on the command line, it takes
1904 precedence over this option. To disable pagination for all
1905 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1908 Alias for a --pretty= format string, as specified in
1909 linkgit:git-log[1]. Any aliases defined here can be used just
1910 as the built-in pretty formats could. For example,
1911 running `git config pretty.changelog "format:* %H %s"`
1912 would cause the invocation `git log --pretty=changelog`
1913 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1914 Note that an alias with the same name as a built-in format
1915 will be silently ignored.
1918 By default, Git does not create an extra merge commit when merging
1919 a commit that is a descendant of the current commit. Instead, the
1920 tip of the current branch is fast-forwarded. When set to `false`,
1921 this variable tells Git to create an extra merge commit in such
1922 a case (equivalent to giving the `--no-ff` option from the command
1923 line). When set to `only`, only such fast-forward merges are
1924 allowed (equivalent to giving the `--ff-only` option from the
1928 When true, rebase branches on top of the fetched branch, instead
1929 of merging the default branch from the default remote when "git
1930 pull" is run. See "branch.<name>.rebase" for setting this on a
1933 When preserve, also pass `--preserve-merges` along to 'git rebase'
1934 so that locally committed merge commits will not be flattened
1935 by running 'git pull'.
1937 *NOTE*: this is a possibly dangerous operation; do *not* use
1938 it unless you understand the implications (see linkgit:git-rebase[1]
1942 The default merge strategy to use when pulling multiple branches
1946 The default merge strategy to use when pulling a single branch.
1949 Defines the action `git push` should take if no refspec is
1950 explicitly given. Different values are well-suited for
1951 specific workflows; for instance, in a purely central workflow
1952 (i.e. the fetch source is equal to the push destination),
1953 `upstream` is probably what you want. Possible values are:
1957 * `nothing` - do not push anything (error out) unless a refspec is
1958 explicitly given. This is primarily meant for people who want to
1959 avoid mistakes by always being explicit.
1961 * `current` - push the current branch to update a branch with the same
1962 name on the receiving end. Works in both central and non-central
1965 * `upstream` - push the current branch back to the branch whose
1966 changes are usually integrated into the current branch (which is
1967 called `@{upstream}`). This mode only makes sense if you are
1968 pushing to the same repository you would normally pull from
1969 (i.e. central workflow).
1971 * `simple` - in centralized workflow, work like `upstream` with an
1972 added safety to refuse to push if the upstream branch's name is
1973 different from the local one.
1975 When pushing to a remote that is different from the remote you normally
1976 pull from, work as `current`. This is the safest option and is suited
1979 This mode will become the default in Git 2.0.
1981 * `matching` - push all branches having the same name on both ends.
1982 This makes the repository you are pushing to remember the set of
1983 branches that will be pushed out (e.g. if you always push 'maint'
1984 and 'master' there and no other branches, the repository you push
1985 to will have these two branches, and your local 'maint' and
1986 'master' will be pushed there).
1988 To use this mode effectively, you have to make sure _all_ the
1989 branches you would push out are ready to be pushed out before
1990 running 'git push', as the whole point of this mode is to allow you
1991 to push all of the branches in one go. If you usually finish work
1992 on only one branch and push out the result, while other branches are
1993 unfinished, this mode is not for you. Also this mode is not
1994 suitable for pushing into a shared central repository, as other
1995 people may add new branches there, or update the tip of existing
1996 branches outside your control.
1998 This is currently the default, but Git 2.0 will change the default
2004 Whether to show a diffstat of what changed upstream since the last
2005 rebase. False by default.
2008 If set to true enable '--autosquash' option by default.
2011 When set to true, automatically create a temporary stash
2012 before the operation begins, and apply it after the operation
2013 ends. This means that you can run rebase on a dirty worktree.
2014 However, use with care: the final stash application after a
2015 successful rebase might result in non-trivial conflicts.
2019 By default, git-receive-pack will run "git-gc --auto" after
2020 receiving data from git-push and updating refs. You can stop
2021 it by setting this variable to false.
2023 receive.fsckObjects::
2024 If it is set to true, git-receive-pack will check all received
2025 objects. It will abort in the case of a malformed object or a
2026 broken link. The result of an abort are only dangling objects.
2027 Defaults to false. If not set, the value of `transfer.fsckObjects`
2030 receive.unpackLimit::
2031 If the number of objects received in a push is below this
2032 limit then the objects will be unpacked into loose object
2033 files. However if the number of received objects equals or
2034 exceeds this limit then the received pack will be stored as
2035 a pack, after adding any missing delta bases. Storing the
2036 pack from a push can make the push operation complete faster,
2037 especially on slow filesystems. If not set, the value of
2038 `transfer.unpackLimit` is used instead.
2040 receive.denyDeletes::
2041 If set to true, git-receive-pack will deny a ref update that deletes
2042 the ref. Use this to prevent such a ref deletion via a push.
2044 receive.denyDeleteCurrent::
2045 If set to true, git-receive-pack will deny a ref update that
2046 deletes the currently checked out branch of a non-bare repository.
2048 receive.denyCurrentBranch::
2049 If set to true or "refuse", git-receive-pack will deny a ref update
2050 to the currently checked out branch of a non-bare repository.
2051 Such a push is potentially dangerous because it brings the HEAD
2052 out of sync with the index and working tree. If set to "warn",
2053 print a warning of such a push to stderr, but allow the push to
2054 proceed. If set to false or "ignore", allow such pushes with no
2055 message. Defaults to "refuse".
2057 receive.denyNonFastForwards::
2058 If set to true, git-receive-pack will deny a ref update which is
2059 not a fast-forward. Use this to prevent such an update via a push,
2060 even if that push is forced. This configuration variable is
2061 set when initializing a shared repository.
2064 String(s) `receive-pack` uses to decide which refs to omit
2065 from its initial advertisement. Use more than one
2066 definitions to specify multiple prefix strings. A ref that
2067 are under the hierarchies listed on the value of this
2068 variable is excluded, and is hidden when responding to `git
2069 push`, and an attempt to update or delete a hidden ref by
2070 `git push` is rejected.
2072 receive.updateserverinfo::
2073 If set to true, git-receive-pack will run git-update-server-info
2074 after receiving data from git-push and updating refs.
2076 receive.shallowupdate::
2077 If set to true, .git/shallow can be updated when new refs
2078 require new shallow roots. Otherwise those refs are rejected.
2080 remote.pushdefault::
2081 The remote to push to by default. Overrides
2082 `branch.<name>.remote` for all branches, and is overridden by
2083 `branch.<name>.pushremote` for specific branches.
2086 The URL of a remote repository. See linkgit:git-fetch[1] or
2087 linkgit:git-push[1].
2089 remote.<name>.pushurl::
2090 The push URL of a remote repository. See linkgit:git-push[1].
2092 remote.<name>.proxy::
2093 For remotes that require curl (http, https and ftp), the URL to
2094 the proxy to use for that remote. Set to the empty string to
2095 disable proxying for that remote.
2097 remote.<name>.fetch::
2098 The default set of "refspec" for linkgit:git-fetch[1]. See
2099 linkgit:git-fetch[1].
2101 remote.<name>.push::
2102 The default set of "refspec" for linkgit:git-push[1]. See
2103 linkgit:git-push[1].
2105 remote.<name>.mirror::
2106 If true, pushing to this remote will automatically behave
2107 as if the `--mirror` option was given on the command line.
2109 remote.<name>.skipDefaultUpdate::
2110 If true, this remote will be skipped by default when updating
2111 using linkgit:git-fetch[1] or the `update` subcommand of
2112 linkgit:git-remote[1].
2114 remote.<name>.skipFetchAll::
2115 If true, this remote will be skipped by default when updating
2116 using linkgit:git-fetch[1] or the `update` subcommand of
2117 linkgit:git-remote[1].
2119 remote.<name>.receivepack::
2120 The default program to execute on the remote side when pushing. See
2121 option \--receive-pack of linkgit:git-push[1].
2123 remote.<name>.uploadpack::
2124 The default program to execute on the remote side when fetching. See
2125 option \--upload-pack of linkgit:git-fetch-pack[1].
2127 remote.<name>.tagopt::
2128 Setting this value to \--no-tags disables automatic tag following when
2129 fetching from remote <name>. Setting it to \--tags will fetch every
2130 tag from remote <name>, even if they are not reachable from remote
2131 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2132 override this setting. See options \--tags and \--no-tags of
2133 linkgit:git-fetch[1].
2136 Setting this to a value <vcs> will cause Git to interact with
2137 the remote with the git-remote-<vcs> helper.
2139 remote.<name>.prune::
2140 When set to true, fetching from this remote by default will also
2141 remove any remote-tracking references that no longer exist on the
2142 remote (as if the `--prune` option was given on the command line).
2143 Overrides `fetch.prune` settings, if any.
2146 The list of remotes which are fetched by "git remote update
2147 <group>". See linkgit:git-remote[1].
2149 repack.usedeltabaseoffset::
2150 By default, linkgit:git-repack[1] creates packs that use
2151 delta-base offset. If you need to share your repository with
2152 Git older than version 1.4.4, either directly or via a dumb
2153 protocol such as http, then you need to set this option to
2154 "false" and repack. Access from old Git versions over the
2155 native protocol are unaffected by this option.
2158 When set to true, `git-rerere` updates the index with the
2159 resulting contents after it cleanly resolves conflicts using
2160 previously recorded resolution. Defaults to false.
2163 Activate recording of resolved conflicts, so that identical
2164 conflict hunks can be resolved automatically, should they be
2165 encountered again. By default, linkgit:git-rerere[1] is
2166 enabled if there is an `rr-cache` directory under the
2167 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2170 sendemail.identity::
2171 A configuration identity. When given, causes values in the
2172 'sendemail.<identity>' subsection to take precedence over
2173 values in the 'sendemail' section. The default identity is
2174 the value of 'sendemail.identity'.
2176 sendemail.smtpencryption::
2177 See linkgit:git-send-email[1] for description. Note that this
2178 setting is not subject to the 'identity' mechanism.
2181 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2183 sendemail.smtpsslcertpath::
2184 Path to ca-certificates (either a directory or a single file).
2185 Set it to an empty string to disable certificate verification.
2187 sendemail.<identity>.*::
2188 Identity-specific versions of the 'sendemail.*' parameters
2189 found below, taking precedence over those when the this
2190 identity is selected, through command-line or
2191 'sendemail.identity'.
2193 sendemail.aliasesfile::
2194 sendemail.aliasfiletype::
2195 sendemail.annotate::
2199 sendemail.chainreplyto::
2201 sendemail.envelopesender::
2203 sendemail.multiedit::
2204 sendemail.signedoffbycc::
2205 sendemail.smtppass::
2206 sendemail.suppresscc::
2207 sendemail.suppressfrom::
2209 sendemail.smtpdomain::
2210 sendemail.smtpserver::
2211 sendemail.smtpserverport::
2212 sendemail.smtpserveroption::
2213 sendemail.smtpuser::
2215 sendemail.validate::
2216 See linkgit:git-send-email[1] for description.
2218 sendemail.signedoffcc::
2219 Deprecated alias for 'sendemail.signedoffbycc'.
2221 showbranch.default::
2222 The default set of branches for linkgit:git-show-branch[1].
2223 See linkgit:git-show-branch[1].
2225 status.relativePaths::
2226 By default, linkgit:git-status[1] shows paths relative to the
2227 current directory. Setting this variable to `false` shows paths
2228 relative to the repository root (this was the default for Git
2232 Set to true to enable --short by default in linkgit:git-status[1].
2233 The option --no-short takes precedence over this variable.
2236 Set to true to enable --branch by default in linkgit:git-status[1].
2237 The option --no-branch takes precedence over this variable.
2239 status.displayCommentPrefix::
2240 If set to true, linkgit:git-status[1] will insert a comment
2241 prefix before each output line (starting with
2242 `core.commentChar`, i.e. `#` by default). This was the
2243 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2246 status.showUntrackedFiles::
2247 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2248 files which are not currently tracked by Git. Directories which
2249 contain only untracked files, are shown with the directory name
2250 only. Showing untracked files means that Git needs to lstat() all
2251 all the files in the whole repository, which might be slow on some
2252 systems. So, this variable controls how the commands displays
2253 the untracked files. Possible values are:
2256 * `no` - Show no untracked files.
2257 * `normal` - Show untracked files and directories.
2258 * `all` - Show also individual files in untracked directories.
2261 If this variable is not specified, it defaults to 'normal'.
2262 This variable can be overridden with the -u|--untracked-files option
2263 of linkgit:git-status[1] and linkgit:git-commit[1].
2265 status.submodulesummary::
2267 If this is set to a non zero number or true (identical to -1 or an
2268 unlimited number), the submodule summary will be enabled and a
2269 summary of commits for modified submodules will be shown (see
2270 --summary-limit option of linkgit:git-submodule[1]). Please note
2271 that the summary output command will be suppressed for all
2272 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2273 for those submodules where `submodule.<name>.ignore=all`. To
2274 also view the summary for ignored submodules you can either use
2275 the --ignore-submodules=dirty command line option or the 'git
2276 submodule summary' command, which shows a similar output but does
2277 not honor these settings.
2279 submodule.<name>.path::
2280 submodule.<name>.url::
2281 submodule.<name>.update::
2282 The path within this project, URL, and the updating strategy
2283 for a submodule. These variables are initially populated
2284 by 'git submodule init'; edit them to override the
2285 URL and other values found in the `.gitmodules` file. See
2286 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2288 submodule.<name>.branch::
2289 The remote branch name for a submodule, used by `git submodule
2290 update --remote`. Set this option to override the value found in
2291 the `.gitmodules` file. See linkgit:git-submodule[1] and
2292 linkgit:gitmodules[5] for details.
2294 submodule.<name>.fetchRecurseSubmodules::
2295 This option can be used to control recursive fetching of this
2296 submodule. It can be overridden by using the --[no-]recurse-submodules
2297 command line option to "git fetch" and "git pull".
2298 This setting will override that from in the linkgit:gitmodules[5]
2301 submodule.<name>.ignore::
2302 Defines under what circumstances "git status" and the diff family show
2303 a submodule as modified. When set to "all", it will never be considered
2304 modified, "dirty" will ignore all changes to the submodules work tree and
2305 takes only differences between the HEAD of the submodule and the commit
2306 recorded in the superproject into account. "untracked" will additionally
2307 let submodules with modified tracked files in their work tree show up.
2308 Using "none" (the default when this option is not set) also shows
2309 submodules that have untracked files in their work tree as changed.
2310 This setting overrides any setting made in .gitmodules for this submodule,
2311 both settings can be overridden on the command line by using the
2312 "--ignore-submodules" option. The 'git submodule' commands are not
2313 affected by this setting.
2316 This variable can be used to restrict the permission bits of
2317 tar archive entries. The default is 0002, which turns off the
2318 world write bit. The special value "user" indicates that the
2319 archiving user's umask will be used instead. See umask(2) and
2320 linkgit:git-archive[1].
2322 transfer.fsckObjects::
2323 When `fetch.fsckObjects` or `receive.fsckObjects` are
2324 not set, the value of this variable is used instead.
2328 This variable can be used to set both `receive.hiderefs`
2329 and `uploadpack.hiderefs` at the same time to the same
2330 values. See entries for these other variables.
2332 transfer.unpackLimit::
2333 When `fetch.unpackLimit` or `receive.unpackLimit` are
2334 not set, the value of this variable is used instead.
2335 The default value is 100.
2337 uploadpack.hiderefs::
2338 String(s) `upload-pack` uses to decide which refs to omit
2339 from its initial advertisement. Use more than one
2340 definitions to specify multiple prefix strings. A ref that
2341 are under the hierarchies listed on the value of this
2342 variable is excluded, and is hidden from `git ls-remote`,
2343 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2344 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2346 uploadpack.allowtipsha1inwant::
2347 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2348 to accept a fetch request that asks for an object at the tip
2349 of a hidden ref (by default, such a request is rejected).
2350 see also `uploadpack.hiderefs`.
2352 uploadpack.keepalive::
2353 When `upload-pack` has started `pack-objects`, there may be a
2354 quiet period while `pack-objects` prepares the pack. Normally
2355 it would output progress information, but if `--quiet` was used
2356 for the fetch, `pack-objects` will output nothing at all until
2357 the pack data begins. Some clients and networks may consider
2358 the server to be hung and give up. Setting this option instructs
2359 `upload-pack` to send an empty keepalive packet every
2360 `uploadpack.keepalive` seconds. Setting this option to 0
2361 disables keepalive packets entirely. The default is 5 seconds.
2363 url.<base>.insteadOf::
2364 Any URL that starts with this value will be rewritten to
2365 start, instead, with <base>. In cases where some site serves a
2366 large number of repositories, and serves them with multiple
2367 access methods, and some users need to use different access
2368 methods, this feature allows people to specify any of the
2369 equivalent URLs and have Git automatically rewrite the URL to
2370 the best alternative for the particular user, even for a
2371 never-before-seen repository on the site. When more than one
2372 insteadOf strings match a given URL, the longest match is used.
2374 url.<base>.pushInsteadOf::
2375 Any URL that starts with this value will not be pushed to;
2376 instead, it will be rewritten to start with <base>, and the
2377 resulting URL will be pushed to. In cases where some site serves
2378 a large number of repositories, and serves them with multiple
2379 access methods, some of which do not allow push, this feature
2380 allows people to specify a pull-only URL and have Git
2381 automatically use an appropriate URL to push, even for a
2382 never-before-seen repository on the site. When more than one
2383 pushInsteadOf strings match a given URL, the longest match is
2384 used. If a remote has an explicit pushurl, Git will ignore this
2385 setting for that remote.
2388 Your email address to be recorded in any newly created commits.
2389 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2390 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2393 Your full name to be recorded in any newly created commits.
2394 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2395 environment variables. See linkgit:git-commit-tree[1].
2398 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2399 key you want it to automatically when creating a signed tag or
2400 commit, you can override the default selection with this variable.
2401 This option is passed unchanged to gpg's --local-user parameter,
2402 so you may specify a key using any method that gpg supports.
2405 Specify a web browser that may be used by some commands.
2406 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]