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; we say then that the variable is
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored. The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
27 The file consists of sections and variables. A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins. Section names are case-insensitive. Only alphanumeric
30 characters, `-` and `.` are allowed in section names. Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
34 Sections can be further divided into subsections. To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
39 [section "subsection"]
43 Subsection names are case sensitive and can contain any characters except
44 newline (doublequote `"` and backslash can be included by escaping them
45 as `\"` and `\\`, respectively). Section headers cannot span multiple
46 lines. Variables may belong directly to a section or to a given subsection.
47 You can have `[section]` if you have `[section "subsection"]`, but you
50 There is also a deprecated `[section.subsection]` syntax. With this
51 syntax, the subsection name is converted to lower-case and is also
52 compared case sensitively. These subsection names follow the same
53 restrictions as section names.
55 All the other lines (and the remainder of the line after the section
56 header) are recognized as setting variables, in the form
57 'name = value' (or just 'name', which is a short-hand to say that
58 the variable is the boolean "true").
59 The variable names are case-insensitive, allow only alphanumeric characters
60 and `-`, and must start with an alphabetic character.
62 A line that defines a value can be continued to the next line by
63 ending it with a `\`; the backquote and the end-of-line are
64 stripped. Leading whitespaces after 'name =', the remainder of the
65 line after the first comment character '#' or ';', and trailing
66 whitespaces of the line are discarded unless they are enclosed in
67 double quotes. Internal whitespaces within the value are retained
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
73 The following escape sequences (beside `\"` and `\\`) are recognized:
74 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
75 and `\b` for backspace (BS). Other char escape sequences (including octal
76 escape sequences) are invalid.
82 You can include one config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 variable takes a pathname as its value, and is subject to tilde
88 included file is expanded immediately, as if its contents had been
89 found at the location of the include directive. If the value of the
90 `include.path` variable is a relative path, the path is considered to be
91 relative to the configuration file in which the include directive was
92 found. See below for examples.
100 ; Don't trust file modes
105 external = /usr/local/bin/diff-wrapper
110 merge = refs/heads/devel
114 gitProxy="ssh" for "kernel.org"
115 gitProxy=default-proxy ; for the rest
118 path = /path/to/foo.inc ; include by absolute path
119 path = foo ; expand "foo" relative to the current file
120 path = ~/foo ; expand "foo" in your `$HOME` directory
126 Values of many variables are treated as a simple string, but there
127 are variables that take values of specific types and there are rules
128 as to how to spell them.
132 When a variable is said to take a boolean value, many
133 synonyms are accepted for 'true' and 'false'; these are all
136 true;; Boolean true can be spelled as `yes`, `on`, `true`,
137 or `1`. Also, a variable defined without `= <value>`
140 false;; Boolean false can be spelled as `no`, `off`,
143 When converting value to the canonical form using '--bool' type
144 specifier; 'git config' will ensure that the output is "true" or
145 "false" (spelled in lowercase).
148 The value for many variables that specify various sizes can
149 be suffixed with `k`, `M`,... to mean "scale the number by
150 1024", "by 1024x1024", etc.
153 The value for a variables that takes a color is a list of
154 colors (at most two) and attributes (at most one), separated
155 by spaces. The colors accepted are `normal`, `black`,
156 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
157 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
158 `reverse`. The first color given is the foreground; the
159 second is the background. The position of the attribute, if
160 any, doesn't matter. Attributes may be turned off specifically
161 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
163 Colors (foreground and background) may also be given as numbers between
164 0 and 255; these use ANSI 256-color mode (but note that not all
165 terminals may support this). If your terminal supports it, you may also
166 specify 24-bit RGB values as hex, like `#ff0ab3`.
168 The attributes are meant to be reset at the beginning of each item
169 in the colored output, so setting color.decorate.branch to `black`
170 will paint that branch name in a plain `black`, even if the previous
171 thing on the same output line (e.g. opening parenthesis before the
172 list of branch names in `log --decorate` output) is set to be
173 painted with `bold` or some other attribute.
176 A variable that takes a pathname value can be given a
177 string that begins with "`~/`" or "`~user/`", and the usual
178 tilde expansion happens to such a string: `~/`
179 is expanded to the value of `$HOME`, and `~user/` to the
180 specified user's home directory.
186 Note that this list is non-comprehensive and not necessarily complete.
187 For command-specific variables, you will find a more detailed description
188 in the appropriate manual page.
190 Other git-related tools may and do use their own variables. When
191 inventing new variables for use in your own tool, make sure their
192 names do not conflict with those that are used by Git itself and
193 other popular tools, and describe them in your documentation.
197 These variables control various optional help messages designed to
198 aid new users. All 'advice.*' variables default to 'true', and you
199 can tell Git that you do not need help by setting these to 'false':
203 Set this variable to 'false' if you want to disable
205 'pushNonFFMatching', 'pushAlreadyExists',
206 'pushFetchFirst', and 'pushNeedsForce'
209 Advice shown when linkgit:git-push[1] fails due to a
210 non-fast-forward update to the current branch.
212 Advice shown when you ran linkgit:git-push[1] and pushed
213 'matching refs' explicitly (i.e. you used ':', or
214 specified a refspec that isn't your current branch) and
215 it resulted in a non-fast-forward error.
217 Shown when linkgit:git-push[1] rejects an update that
218 does not qualify for fast-forwarding (e.g., a tag.)
220 Shown when linkgit:git-push[1] rejects an update that
221 tries to overwrite a remote ref that points at an
222 object we do not have.
224 Shown when linkgit:git-push[1] rejects an update that
225 tries to overwrite a remote ref that points at an
226 object that is not a commit-ish, or make the remote
227 ref point at an object that is not a commit-ish.
229 Show directions on how to proceed from the current
230 state in the output of linkgit:git-status[1], in
231 the template shown when writing commit messages in
232 linkgit:git-commit[1], and in the help message shown
233 by linkgit:git-checkout[1] when switching branch.
235 Advise to consider using the `-u` option to linkgit:git-status[1]
236 when the command takes more than 2 seconds to enumerate untracked
239 Advice shown when linkgit:git-merge[1] refuses to
240 merge to avoid overwriting local changes.
242 Advice shown by various commands when conflicts
243 prevent the operation from being performed.
245 Advice on how to set your identity configuration when
246 your information is guessed from the system username and
249 Advice shown when you used linkgit:git-checkout[1] to
250 move to the detach HEAD state, to instruct how to create
251 a local branch after the fact.
253 Advice that shows the location of the patch file when
254 linkgit:git-am[1] fails to apply it.
256 In case of failure in the output of linkgit:git-rm[1],
257 show directions on how to proceed from the current state.
261 Tells Git if the executable bit of files in the working tree
264 Some filesystems lose the executable bit when a file that is
265 marked as executable is checked out, or checks out an
266 non-executable file with executable bit on.
267 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
268 to see if it handles the executable bit correctly
269 and this variable is automatically set as necessary.
271 A repository, however, may be on a filesystem that handles
272 the filemode correctly, and this variable is set to 'true'
273 when created, but later may be made accessible from another
274 environment that loses the filemode (e.g. exporting ext4 via
275 CIFS mount, visiting a Cygwin created repository with
276 Git for Windows or Eclipse).
277 In such a case it may be necessary to set this variable to 'false'.
278 See linkgit:git-update-index[1].
280 The default is true (when core.filemode is not specified in the config file).
283 (Windows-only) If true, mark newly-created directories and files whose
284 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
285 directory is hidden, but no other files starting with a dot. The
286 default mode is 'dotGitOnly'.
289 If true, this option enables various workarounds to enable
290 Git to work better on filesystems that are not case sensitive,
291 like FAT. For example, if a directory listing finds
292 "makefile" when Git expects "Makefile", Git will assume
293 it is really the same file, and continue to remember it as
296 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
297 will probe and set core.ignoreCase true if appropriate when the repository
300 core.precomposeUnicode::
301 This option is only used by Mac OS implementation of Git.
302 When core.precomposeUnicode=true, Git reverts the unicode decomposition
303 of filenames done by Mac OS. This is useful when sharing a repository
304 between Mac OS and Linux or Windows.
305 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
306 When false, file names are handled fully transparent by Git,
307 which is backward compatible with older versions of Git.
310 If set to true, do not allow checkout of paths that would
311 be considered equivalent to `.git` on an HFS+ filesystem.
312 Defaults to `true` on Mac OS, and `false` elsewhere.
315 If set to true, do not allow checkout of paths that would
316 cause problems with the NTFS filesystem, e.g. conflict with
318 Defaults to `true` on Windows, and `false` elsewhere.
321 If false, the ctime differences between the index and the
322 working tree are ignored; useful when the inode change time
323 is regularly modified by something outside Git (file system
324 crawlers and some backup systems).
325 See linkgit:git-update-index[1]. True by default.
327 core.untrackedCache::
328 Determines what to do about the untracked cache feature of the
329 index. It will be kept, if this variable is unset or set to
330 `keep`. It will automatically be added if set to `true`. And
331 it will automatically be removed, if set to `false`. Before
332 setting it to `true`, you should check that mtime is working
333 properly on your system.
334 See linkgit:git-update-index[1]. `keep` by default.
337 Determines which stat fields to match between the index
338 and work tree. The user can set this to 'default' or
339 'minimal'. Default (or explicitly 'default'), is to check
340 all fields, including the sub-second part of mtime and ctime.
343 The commands that output paths (e.g. 'ls-files',
344 'diff'), when not given the `-z` option, will quote
345 "unusual" characters in the pathname by enclosing the
346 pathname in a double-quote pair and with backslashes the
347 same way strings in C source code are quoted. If this
348 variable is set to false, the bytes higher than 0x80 are
349 not quoted but output as verbatim. Note that double
350 quote, backslash and control characters are always
351 quoted without `-z` regardless of the setting of this
355 Sets the line ending type to use in the working directory for
356 files that have the `text` property set. Alternatives are
357 'lf', 'crlf' and 'native', which uses the platform's native
358 line ending. The default value is `native`. See
359 linkgit:gitattributes[5] for more information on end-of-line
363 If true, makes Git check if converting `CRLF` is reversible when
364 end-of-line conversion is active. Git will verify if a command
365 modifies a file in the work tree either directly or indirectly.
366 For example, committing a file followed by checking out the
367 same file should yield the original file in the work tree. If
368 this is not the case for the current setting of
369 `core.autocrlf`, Git will reject the file. The variable can
370 be set to "warn", in which case Git will only warn about an
371 irreversible conversion but continue the operation.
373 CRLF conversion bears a slight chance of corrupting data.
374 When it is enabled, Git will convert CRLF to LF during commit and LF to
375 CRLF during checkout. A file that contains a mixture of LF and
376 CRLF before the commit cannot be recreated by Git. For text
377 files this is the right thing to do: it corrects line endings
378 such that we have only LF line endings in the repository.
379 But for binary files that are accidentally classified as text the
380 conversion can corrupt data.
382 If you recognize such corruption early you can easily fix it by
383 setting the conversion type explicitly in .gitattributes. Right
384 after committing you still have the original file in your work
385 tree and this file is not yet corrupted. You can explicitly tell
386 Git that this file is binary and Git will handle the file
389 Unfortunately, the desired effect of cleaning up text files with
390 mixed line endings and the undesired effect of corrupting binary
391 files cannot be distinguished. In both cases CRLFs are removed
392 in an irreversible way. For text files this is the right thing
393 to do because CRLFs are line endings, while for binary files
394 converting CRLFs corrupts data.
396 Note, this safety check does not mean that a checkout will generate a
397 file identical to the original file for a different setting of
398 `core.eol` and `core.autocrlf`, but only for the current one. For
399 example, a text file with `LF` would be accepted with `core.eol=lf`
400 and could later be checked out with `core.eol=crlf`, in which case the
401 resulting file would contain `CRLF`, although the original file
402 contained `LF`. However, in both work trees the line endings would be
403 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
404 file with mixed line endings would be reported by the `core.safecrlf`
408 Setting this variable to "true" is almost the same as setting
409 the `text` attribute to "auto" on all files except that text
410 files are not guaranteed to be normalized: files that contain
411 `CRLF` in the repository will not be touched. Use this
412 setting if you want to have `CRLF` line endings in your
413 working directory even though the repository does not have
414 normalized line endings. This variable can be set to 'input',
415 in which case no output conversion is performed.
418 If false, symbolic links are checked out as small plain files that
419 contain the link text. linkgit:git-update-index[1] and
420 linkgit:git-add[1] will not change the recorded type to regular
421 file. Useful on filesystems like FAT that do not support
424 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
425 will probe and set core.symlinks false if appropriate when the repository
429 A "proxy command" to execute (as 'command host port') instead
430 of establishing direct connection to the remote server when
431 using the Git protocol for fetching. If the variable value is
432 in the "COMMAND for DOMAIN" format, the command is applied only
433 on hostnames ending with the specified domain string. This variable
434 may be set multiple times and is matched in the given order;
435 the first match wins.
437 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
438 (which always applies universally, without the special "for"
441 The special string `none` can be used as the proxy command to
442 specify that no proxy be used for a given domain pattern.
443 This is useful for excluding servers inside a firewall from
444 proxy use, while defaulting to a common proxy for external domains.
447 If true, Git will avoid using lstat() calls to detect if files have
448 changed by setting the "assume-unchanged" bit for those tracked files
449 which it has updated identically in both the index and working tree.
451 When files are modified outside of Git, the user will need to stage
452 the modified files explicitly (e.g. see 'Examples' section in
453 linkgit:git-update-index[1]).
454 Git will not normally detect changes to those files.
456 This is useful on systems where lstat() calls are very slow, such as
457 CIFS/Microsoft Windows.
461 core.preferSymlinkRefs::
462 Instead of the default "symref" format for HEAD
463 and other symbolic reference files, use symbolic links.
464 This is sometimes needed to work with old scripts that
465 expect HEAD to be a symbolic link.
468 If true this repository is assumed to be 'bare' and has no
469 working directory associated with it. If this is the case a
470 number of commands that require a working directory will be
471 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
473 This setting is automatically guessed by linkgit:git-clone[1] or
474 linkgit:git-init[1] when the repository was created. By default a
475 repository that ends in "/.git" is assumed to be not bare (bare =
476 false), while all other repositories are assumed to be bare (bare
480 Set the path to the root of the working tree.
481 If GIT_COMMON_DIR environment variable is set, core.worktree
482 is ignored and not used for determining the root of working tree.
483 This can be overridden by the GIT_WORK_TREE environment
484 variable and the '--work-tree' command-line option.
485 The value can be an absolute path or relative to the path to
486 the .git directory, which is either specified by --git-dir
487 or GIT_DIR, or automatically discovered.
488 If --git-dir or GIT_DIR is specified but none of
489 --work-tree, GIT_WORK_TREE and core.worktree is specified,
490 the current working directory is regarded as the top level
491 of your working tree.
493 Note that this variable is honored even when set in a configuration
494 file in a ".git" subdirectory of a directory and its value differs
495 from the latter directory (e.g. "/path/to/.git/config" has
496 core.worktree set to "/different/path"), which is most likely a
497 misconfiguration. Running Git commands in the "/path/to" directory will
498 still use "/different/path" as the root of the work tree and can cause
499 confusion unless you know what you are doing (e.g. you are creating a
500 read-only snapshot of the same index to a location different from the
501 repository's usual working tree).
503 core.logAllRefUpdates::
504 Enable the reflog. Updates to a ref <ref> is logged to the file
505 "`$GIT_DIR/logs/<ref>`", by appending the new and old
506 SHA-1, the date/time and the reason of the update, but
507 only when the file exists. If this configuration
508 variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
509 file is automatically created for branch heads (i.e. under
510 refs/heads/), remote refs (i.e. under refs/remotes/),
511 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
513 This information can be used to determine what commit
514 was the tip of a branch "2 days ago".
516 This value is true by default in a repository that has
517 a working directory associated with it, and false by
518 default in a bare repository.
520 core.repositoryFormatVersion::
521 Internal variable identifying the repository format and layout
524 core.sharedRepository::
525 When 'group' (or 'true'), the repository is made shareable between
526 several users in a group (making sure all the files and objects are
527 group-writable). When 'all' (or 'world' or 'everybody'), the
528 repository will be readable by all users, additionally to being
529 group-shareable. When 'umask' (or 'false'), Git will use permissions
530 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
531 files in the repository will have this mode value. '0xxx' will override
532 user's umask value (whereas the other options will only override
533 requested parts of the user's umask value). Examples: '0660' will make
534 the repo read/write-able for the owner and group, but inaccessible to
535 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
536 repository that is group-readable but not group-writable.
537 See linkgit:git-init[1]. False by default.
539 core.warnAmbiguousRefs::
540 If true, Git will warn you if the ref name you passed it is ambiguous
541 and might match multiple refs in the repository. True by default.
544 An integer -1..9, indicating a default compression level.
545 -1 is the zlib default. 0 means no compression,
546 and 1..9 are various speed/size tradeoffs, 9 being slowest.
547 If set, this provides a default to other compression variables,
548 such as 'core.looseCompression' and 'pack.compression'.
550 core.looseCompression::
551 An integer -1..9, indicating the compression level for objects that
552 are not in a pack file. -1 is the zlib default. 0 means no
553 compression, and 1..9 are various speed/size tradeoffs, 9 being
554 slowest. If not set, defaults to core.compression. If that is
555 not set, defaults to 1 (best speed).
557 core.packedGitWindowSize::
558 Number of bytes of a pack file to map into memory in a
559 single mapping operation. Larger window sizes may allow
560 your system to process a smaller number of large pack files
561 more quickly. Smaller window sizes will negatively affect
562 performance due to increased calls to the operating system's
563 memory manager, but may improve performance when accessing
564 a large number of large pack files.
566 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
567 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
568 be reasonable for all users/operating systems. You probably do
569 not need to adjust this value.
571 Common unit suffixes of 'k', 'm', or 'g' are supported.
573 core.packedGitLimit::
574 Maximum number of bytes to map simultaneously into memory
575 from pack files. If Git needs to access more than this many
576 bytes at once to complete an operation it will unmap existing
577 regions to reclaim virtual address space within the process.
579 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
580 This should be reasonable for all users/operating systems, except on
581 the largest projects. You probably do not need to adjust this value.
583 Common unit suffixes of 'k', 'm', or 'g' are supported.
585 core.deltaBaseCacheLimit::
586 Maximum number of bytes to reserve for caching base objects
587 that may be referenced by multiple deltified objects. By storing the
588 entire decompressed base objects in a cache Git is able
589 to avoid unpacking and decompressing frequently used base
590 objects multiple times.
592 Default is 96 MiB on all platforms. This should be reasonable
593 for all users/operating systems, except on the largest projects.
594 You probably do not need to adjust this value.
596 Common unit suffixes of 'k', 'm', or 'g' are supported.
598 core.bigFileThreshold::
599 Files larger than this size are stored deflated, without
600 attempting delta compression. Storing large files without
601 delta compression avoids excessive memory usage, at the
602 slight expense of increased disk usage. Additionally files
603 larger than this size are always treated as binary.
605 Default is 512 MiB on all platforms. This should be reasonable
606 for most projects as source code and other text files can still
607 be delta compressed, but larger binary media files won't be.
609 Common unit suffixes of 'k', 'm', or 'g' are supported.
612 Specifies the pathname to the file that contains patterns to
613 describe paths that are not meant to be tracked, in addition
614 to '.gitignore' (per-directory) and '.git/info/exclude'.
615 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
616 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
617 is used instead. See linkgit:gitignore[5].
620 Some commands (e.g. svn and http interfaces) that interactively
621 ask for a password can be told to use an external program given
622 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
623 environment variable. If not set, fall back to the value of the
624 'SSH_ASKPASS' environment variable or, failing that, a simple password
625 prompt. The external program shall be given a suitable prompt as
626 command-line argument and write the password on its STDOUT.
628 core.attributesFile::
629 In addition to '.gitattributes' (per-directory) and
630 '.git/info/attributes', Git looks into this file for attributes
631 (see linkgit:gitattributes[5]). Path expansions are made the same
632 way as for `core.excludesFile`. Its default value is
633 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
634 set or empty, `$HOME/.config/git/attributes` is used instead.
637 By default Git will look for your hooks in the
638 '$GIT_DIR/hooks' directory. Set this to different path,
639 e.g. '/etc/git/hooks', and Git will try to find your hooks in
640 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
641 in '$GIT_DIR/hooks/pre-receive'.
643 The path can be either absolute or relative. A relative path is
644 taken as relative to the directory where the hooks are run (see
645 the "DESCRIPTION" section of linkgit:githooks[5]).
647 This configuration variable is useful in cases where you'd like to
648 centrally configure your Git hooks instead of configuring them on a
649 per-repository basis, or as a more flexible and centralized
650 alternative to having an `init.templateDir` where you've changed
654 Commands such as `commit` and `tag` that lets you edit
655 messages by launching an editor uses the value of this
656 variable when it is set, and the environment variable
657 `GIT_EDITOR` is not set. See linkgit:git-var[1].
660 Commands such as `commit` and `tag` that lets you edit
661 messages consider a line that begins with this character
662 commented, and removes them after the editor returns
665 If set to "auto", `git-commit` would select a character that is not
666 the beginning character of any line in existing commit messages.
668 core.packedRefsTimeout::
669 The length of time, in milliseconds, to retry when trying to
670 lock the `packed-refs` file. Value 0 means not to retry at
671 all; -1 means to try indefinitely. Default is 1000 (i.e.,
675 Text editor used by `git rebase -i` for editing the rebase instruction file.
676 The value is meant to be interpreted by the shell when it is used.
677 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
678 When not configured the default commit message editor is used instead.
681 Text viewer for use by Git commands (e.g., 'less'). The value
682 is meant to be interpreted by the shell. The order of preference
683 is the `$GIT_PAGER` environment variable, then `core.pager`
684 configuration, then `$PAGER`, and then the default chosen at
685 compile time (usually 'less').
687 When the `LESS` environment variable is unset, Git sets it to `FRX`
688 (if `LESS` environment variable is set, Git does not change it at
689 all). If you want to selectively override Git's default setting
690 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
691 be passed to the shell by Git, which will translate the final
692 command to `LESS=FRX less -S`. The environment does not set the
693 `S` option but the command line does, instructing less to truncate
694 long lines. Similarly, setting `core.pager` to `less -+F` will
695 deactivate the `F` option specified by the environment from the
696 command-line, deactivating the "quit if one screen" behavior of
697 `less`. One can specifically activate some flags for particular
698 commands: for example, setting `pager.blame` to `less -S` enables
699 line truncation only for `git blame`.
701 Likewise, when the `LV` environment variable is unset, Git sets it
702 to `-c`. You can override this setting by exporting `LV` with
703 another value or setting `core.pager` to `lv +c`.
706 A comma separated list of common whitespace problems to
707 notice. 'git diff' will use `color.diff.whitespace` to
708 highlight them, and 'git apply --whitespace=error' will
709 consider them as errors. You can prefix `-` to disable
710 any of them (e.g. `-trailing-space`):
712 * `blank-at-eol` treats trailing whitespaces at the end of the line
713 as an error (enabled by default).
714 * `space-before-tab` treats a space character that appears immediately
715 before a tab character in the initial indent part of the line as an
716 error (enabled by default).
717 * `indent-with-non-tab` treats a line that is indented with space
718 characters instead of the equivalent tabs as an error (not enabled by
720 * `tab-in-indent` treats a tab character in the initial indent part of
721 the line as an error (not enabled by default).
722 * `blank-at-eof` treats blank lines added at the end of file as an error
723 (enabled by default).
724 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
726 * `cr-at-eol` treats a carriage-return at the end of line as
727 part of the line terminator, i.e. with it, `trailing-space`
728 does not trigger if the character before such a carriage-return
729 is not a whitespace (not enabled by default).
730 * `tabwidth=<n>` tells how many character positions a tab occupies; this
731 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
732 errors. The default tab width is 8. Allowed values are 1 to 63.
734 core.fsyncObjectFiles::
735 This boolean will enable 'fsync()' when writing object files.
737 This is a total waste of time and effort on a filesystem that orders
738 data writes properly, but can be useful for filesystems that do not use
739 journalling (traditional UNIX filesystems) or that only journal metadata
740 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
743 Enable parallel index preload for operations like 'git diff'
745 This can speed up operations like 'git diff' and 'git status' especially
746 on filesystems like NFS that have weak caching semantics and thus
747 relatively high IO latencies. When enabled, Git will do the
748 index comparison to the filesystem data in parallel, allowing
749 overlapping IO's. Defaults to true.
752 You can set this to 'link', in which case a hardlink followed by
753 a delete of the source are used to make sure that object creation
754 will not overwrite existing objects.
756 On some file system/operating system combinations, this is unreliable.
757 Set this config setting to 'rename' there; However, This will remove the
758 check that makes sure that existing object files will not get overwritten.
761 When showing commit messages, also show notes which are stored in
762 the given ref. The ref must be fully qualified. If the given
763 ref does not exist, it is not an error but means that no
764 notes should be printed.
766 This setting defaults to "refs/notes/commits", and it can be overridden by
767 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
769 core.sparseCheckout::
770 Enable "sparse checkout" feature. See section "Sparse checkout" in
771 linkgit:git-read-tree[1] for more information.
774 Set the length object names are abbreviated to. If unspecified,
775 many commands abbreviate to 7 hexdigits, which may not be enough
776 for abbreviated object names to stay unique for sufficiently long
780 add.ignore-errors (deprecated)::
781 Tells 'git add' to continue adding files when some files cannot be
782 added due to indexing errors. Equivalent to the '--ignore-errors'
783 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
784 as it does not follow the usual naming convention for configuration
788 Command aliases for the linkgit:git[1] command wrapper - e.g.
789 after defining "alias.last = cat-file commit HEAD", the invocation
790 "git last" is equivalent to "git cat-file commit HEAD". To avoid
791 confusion and troubles with script usage, aliases that
792 hide existing Git commands are ignored. Arguments are split by
793 spaces, the usual shell quoting and escaping is supported.
794 A quote pair or a backslash can be used to quote them.
796 If the alias expansion is prefixed with an exclamation point,
797 it will be treated as a shell command. For example, defining
798 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
799 "git new" is equivalent to running the shell command
800 "gitk --all --not ORIG_HEAD". Note that shell commands will be
801 executed from the top-level directory of a repository, which may
802 not necessarily be the current directory.
803 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
804 from the original current directory. See linkgit:git-rev-parse[1].
807 If true, git-am will call git-mailsplit for patches in mbox format
808 with parameter '--keep-cr'. In this case git-mailsplit will
809 not remove `\r` from lines ending with `\r\n`. Can be overridden
810 by giving '--no-keep-cr' from the command line.
811 See linkgit:git-am[1], linkgit:git-mailsplit[1].
814 By default, `git am` will fail if the patch does not apply cleanly. When
815 set to true, this setting tells `git am` to fall back on 3-way merge if
816 the patch records the identity of blobs it is supposed to apply to and
817 we have those blobs available locally (equivalent to giving the `--3way`
818 option from the command line). Defaults to `false`.
819 See linkgit:git-am[1].
821 apply.ignoreWhitespace::
822 When set to 'change', tells 'git apply' to ignore changes in
823 whitespace, in the same way as the '--ignore-space-change'
825 When set to one of: no, none, never, false tells 'git apply' to
826 respect all whitespace differences.
827 See linkgit:git-apply[1].
830 Tells 'git apply' how to handle whitespaces, in the same way
831 as the '--whitespace' option. See linkgit:git-apply[1].
833 branch.autoSetupMerge::
834 Tells 'git branch' and 'git checkout' to set up new branches
835 so that linkgit:git-pull[1] will appropriately merge from the
836 starting point branch. Note that even if this option is not set,
837 this behavior can be chosen per-branch using the `--track`
838 and `--no-track` options. The valid settings are: `false` -- no
839 automatic setup is done; `true` -- automatic setup is done when the
840 starting point is a remote-tracking branch; `always` --
841 automatic setup is done when the starting point is either a
842 local branch or remote-tracking
843 branch. This option defaults to true.
845 branch.autoSetupRebase::
846 When a new branch is created with 'git branch' or 'git checkout'
847 that tracks another branch, this variable tells Git to set
848 up pull to rebase instead of merge (see "branch.<name>.rebase").
849 When `never`, rebase is never automatically set to true.
850 When `local`, rebase is set to true for tracked branches of
851 other local branches.
852 When `remote`, rebase is set to true for tracked branches of
853 remote-tracking branches.
854 When `always`, rebase will be set to true for all tracking
856 See "branch.autoSetupMerge" for details on how to set up a
857 branch to track another branch.
858 This option defaults to never.
860 branch.<name>.remote::
861 When on branch <name>, it tells 'git fetch' and 'git push'
862 which remote to fetch from/push to. The remote to push to
863 may be overridden with `remote.pushDefault` (for all branches).
864 The remote to push to, for the current branch, may be further
865 overridden by `branch.<name>.pushRemote`. If no remote is
866 configured, or if you are not on any branch, it defaults to
867 `origin` for fetching and `remote.pushDefault` for pushing.
868 Additionally, `.` (a period) is the current local repository
869 (a dot-repository), see `branch.<name>.merge`'s final note below.
871 branch.<name>.pushRemote::
872 When on branch <name>, it overrides `branch.<name>.remote` for
873 pushing. It also overrides `remote.pushDefault` for pushing
874 from branch <name>. When you pull from one place (e.g. your
875 upstream) and push to another place (e.g. your own publishing
876 repository), you would want to set `remote.pushDefault` to
877 specify the remote to push to for all branches, and use this
878 option to override it for a specific branch.
880 branch.<name>.merge::
881 Defines, together with branch.<name>.remote, the upstream branch
882 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
883 branch to merge and can also affect 'git push' (see push.default).
884 When in branch <name>, it tells 'git fetch' the default
885 refspec to be marked for merging in FETCH_HEAD. The value is
886 handled like the remote part of a refspec, and must match a
887 ref which is fetched from the remote given by
888 "branch.<name>.remote".
889 The merge information is used by 'git pull' (which at first calls
890 'git fetch') to lookup the default branch for merging. Without
891 this option, 'git pull' defaults to merge the first refspec fetched.
892 Specify multiple values to get an octopus merge.
893 If you wish to setup 'git pull' so that it merges into <name> from
894 another branch in the local repository, you can point
895 branch.<name>.merge to the desired branch, and use the relative path
896 setting `.` (a period) for branch.<name>.remote.
898 branch.<name>.mergeOptions::
899 Sets default options for merging into branch <name>. The syntax and
900 supported options are the same as those of linkgit:git-merge[1], but
901 option values containing whitespace characters are currently not
904 branch.<name>.rebase::
905 When true, rebase the branch <name> on top of the fetched branch,
906 instead of merging the default branch from the default remote when
907 "git pull" is run. See "pull.rebase" for doing this in a non
908 branch-specific manner.
910 When preserve, also pass `--preserve-merges` along to 'git rebase'
911 so that locally committed merge commits will not be flattened
912 by running 'git pull'.
914 When the value is `interactive`, the rebase is run in interactive mode.
916 *NOTE*: this is a possibly dangerous operation; do *not* use
917 it unless you understand the implications (see linkgit:git-rebase[1]
920 branch.<name>.description::
921 Branch description, can be edited with
922 `git branch --edit-description`. Branch description is
923 automatically added in the format-patch cover letter or
924 request-pull summary.
927 Specify the command to invoke the specified browser. The
928 specified command is evaluated in shell with the URLs passed
929 as arguments. (See linkgit:git-web{litdd}browse[1].)
931 browser.<tool>.path::
932 Override the path for the given tool that may be used to
933 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
934 working repository in gitweb (see linkgit:git-instaweb[1]).
937 A boolean to make git-clean do nothing unless given -f,
938 -i or -n. Defaults to true.
941 A boolean to enable/disable color in the output of
942 linkgit:git-branch[1]. May be set to `always`,
943 `false` (or `never`) or `auto` (or `true`), in which case colors are used
944 only when the output is to a terminal. Defaults to false.
946 color.branch.<slot>::
947 Use customized color for branch coloration. `<slot>` is one of
948 `current` (the current branch), `local` (a local branch),
949 `remote` (a remote-tracking branch in refs/remotes/),
950 `upstream` (upstream tracking branch), `plain` (other
954 Whether to use ANSI escape sequences to add color to patches.
955 If this is set to `always`, linkgit:git-diff[1],
956 linkgit:git-log[1], and linkgit:git-show[1] will use color
957 for all patches. If it is set to `true` or `auto`, those
958 commands will only use color when output is to the terminal.
961 This does not affect linkgit:git-format-patch[1] or the
962 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
963 command line with the `--color[=<when>]` option.
966 Use customized color for diff colorization. `<slot>` specifies
967 which part of the patch to use the specified color, and is one
968 of `context` (context text - `plain` is a historical synonym),
969 `meta` (metainformation), `frag`
970 (hunk header), 'func' (function in hunk header), `old` (removed lines),
971 `new` (added lines), `commit` (commit headers), or `whitespace`
972 (highlighting whitespace errors).
974 color.decorate.<slot>::
975 Use customized color for 'git log --decorate' output. `<slot>` is one
976 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
977 branches, remote-tracking branches, tags, stash and HEAD, respectively.
980 When set to `always`, always highlight matches. When `false` (or
981 `never`), never. When set to `true` or `auto`, use color only
982 when the output is written to the terminal. Defaults to `false`.
985 Use customized color for grep colorization. `<slot>` specifies which
986 part of the line to use the specified color, and is one of
990 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
992 filename prefix (when not using `-h`)
994 function name lines (when using `-p`)
996 line number prefix (when using `-n`)
998 matching text (same as setting `matchContext` and `matchSelected`)
1000 matching text in context lines
1002 matching text in selected lines
1004 non-matching text in selected lines
1006 separators between fields on a line (`:`, `-`, and `=`)
1007 and between hunks (`--`)
1011 When set to `always`, always use colors for interactive prompts
1012 and displays (such as those used by "git-add --interactive" and
1013 "git-clean --interactive"). When false (or `never`), never.
1014 When set to `true` or `auto`, use colors only when the output is
1015 to the terminal. Defaults to false.
1017 color.interactive.<slot>::
1018 Use customized color for 'git add --interactive' and 'git clean
1019 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1020 or `error`, for four distinct types of normal output from
1021 interactive commands.
1024 A boolean to enable/disable colored output when the pager is in
1025 use (default is true).
1028 A boolean to enable/disable color in the output of
1029 linkgit:git-show-branch[1]. May be set to `always`,
1030 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1031 only when the output is to a terminal. Defaults to false.
1034 A boolean to enable/disable color in the output of
1035 linkgit:git-status[1]. May be set to `always`,
1036 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1037 only when the output is to a terminal. Defaults to false.
1039 color.status.<slot>::
1040 Use customized color for status colorization. `<slot>` is
1041 one of `header` (the header text of the status message),
1042 `added` or `updated` (files which are added but not committed),
1043 `changed` (files which are changed but not added in the index),
1044 `untracked` (files which are not tracked by Git),
1045 `branch` (the current branch),
1046 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1048 `unmerged` (files which have unmerged changes).
1051 This variable determines the default value for variables such
1052 as `color.diff` and `color.grep` that control the use of color
1053 per command family. Its scope will expand as more commands learn
1054 configuration to set a default for the `--color` option. Set it
1055 to `false` or `never` if you prefer Git commands not to use
1056 color unless enabled explicitly with some other configuration
1057 or the `--color` option. Set it to `always` if you want all
1058 output not intended for machine consumption to use color, to
1059 `true` or `auto` (this is the default since Git 1.8.4) if you
1060 want such output to use color when written to the terminal.
1063 Specify whether supported commands should output in columns.
1064 This variable consists of a list of tokens separated by spaces
1067 These options control when the feature should be enabled
1068 (defaults to 'never'):
1072 always show in columns
1074 never show in columns
1076 show in columns if the output is to the terminal
1079 These options control layout (defaults to 'column'). Setting any
1080 of these implies 'always' if none of 'always', 'never', or 'auto' are
1085 fill columns before rows
1087 fill rows before columns
1092 Finally, these options can be combined with a layout option (defaults
1097 make unequal size columns to utilize more space
1099 make equal size columns
1103 Specify whether to output branch listing in `git branch` in columns.
1104 See `column.ui` for details.
1107 Specify the layout when list items in `git clean -i`, which always
1108 shows files and directories in columns. See `column.ui` for details.
1111 Specify whether to output untracked files in `git status` in columns.
1112 See `column.ui` for details.
1115 Specify whether to output tag listing in `git tag` in columns.
1116 See `column.ui` for details.
1119 This setting overrides the default of the `--cleanup` option in
1120 `git commit`. See linkgit:git-commit[1] for details. Changing the
1121 default can be useful when you always want to keep lines that begin
1122 with comment character `#` in your log message, in which case you
1123 would do `git config commit.cleanup whitespace` (note that you will
1124 have to remove the help lines that begin with `#` in the commit log
1125 template yourself, if you do this).
1129 A boolean to specify whether all commits should be GPG signed.
1130 Use of this option when doing operations such as rebase can
1131 result in a large number of commits being signed. It may be
1132 convenient to use an agent to avoid typing your GPG passphrase
1136 A boolean to enable/disable inclusion of status information in the
1137 commit message template when using an editor to prepare the commit
1138 message. Defaults to true.
1141 Specify the pathname of a file to use as the template for
1142 new commit messages.
1145 Specify an external helper to be called when a username or
1146 password credential is needed; the helper may consult external
1147 storage to avoid prompting the user for the credentials. Note
1148 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1151 credential.useHttpPath::
1152 When acquiring credentials, consider the "path" component of an http
1153 or https URL to be important. Defaults to false. See
1154 linkgit:gitcredentials[7] for more information.
1156 credential.username::
1157 If no username is set for a network authentication, use this username
1158 by default. See credential.<context>.* below, and
1159 linkgit:gitcredentials[7].
1161 credential.<url>.*::
1162 Any of the credential.* options above can be applied selectively to
1163 some credentials. For example "credential.https://example.com.username"
1164 would set the default username only for https connections to
1165 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1168 credentialCache.ignoreSIGHUP::
1169 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1171 include::diff-config.txt[]
1173 difftool.<tool>.path::
1174 Override the path for the given tool. This is useful in case
1175 your tool is not in the PATH.
1177 difftool.<tool>.cmd::
1178 Specify the command to invoke the specified diff tool.
1179 The specified command is evaluated in shell with the following
1180 variables available: 'LOCAL' is set to the name of the temporary
1181 file containing the contents of the diff pre-image and 'REMOTE'
1182 is set to the name of the temporary file containing the contents
1183 of the diff post-image.
1186 Prompt before each invocation of the diff tool.
1188 fetch.recurseSubmodules::
1189 This option can be either set to a boolean value or to 'on-demand'.
1190 Setting it to a boolean changes the behavior of fetch and pull to
1191 unconditionally recurse into submodules when set to true or to not
1192 recurse at all when set to false. When set to 'on-demand' (the default
1193 value), fetch and pull will only recurse into a populated submodule
1194 when its superproject retrieves a commit that updates the submodule's
1198 If it is set to true, git-fetch-pack will check all fetched
1199 objects. It will abort in the case of a malformed object or a
1200 broken link. The result of an abort are only dangling objects.
1201 Defaults to false. If not set, the value of `transfer.fsckObjects`
1205 If the number of objects fetched over the Git native
1206 transfer is below this
1207 limit, then the objects will be unpacked into loose object
1208 files. However if the number of received objects equals or
1209 exceeds this limit then the received pack will be stored as
1210 a pack, after adding any missing delta bases. Storing the
1211 pack from a push can make the push operation complete faster,
1212 especially on slow filesystems. If not set, the value of
1213 `transfer.unpackLimit` is used instead.
1216 If true, fetch will automatically behave as if the `--prune`
1217 option was given on the command line. See also `remote.<name>.prune`.
1220 Enable multipart/mixed attachments as the default for
1221 'format-patch'. The value can also be a double quoted string
1222 which will enable attachments as the default and set the
1223 value as the boundary. See the --attach option in
1224 linkgit:git-format-patch[1].
1227 A boolean which can enable or disable sequence numbers in patch
1228 subjects. It defaults to "auto" which enables it only if there
1229 is more than one patch. It can be enabled or disabled for all
1230 messages by setting it to "true" or "false". See --numbered
1231 option in linkgit:git-format-patch[1].
1234 Additional email headers to include in a patch to be submitted
1235 by mail. See linkgit:git-format-patch[1].
1239 Additional recipients to include in a patch to be submitted
1240 by mail. See the --to and --cc options in
1241 linkgit:git-format-patch[1].
1243 format.subjectPrefix::
1244 The default for format-patch is to output files with the '[PATCH]'
1245 subject prefix. Use this variable to change that prefix.
1248 The default for format-patch is to output a signature containing
1249 the Git version number. Use this variable to change that default.
1250 Set this variable to the empty string ("") to suppress
1251 signature generation.
1253 format.signatureFile::
1254 Works just like format.signature except the contents of the
1255 file specified by this variable will be used as the signature.
1258 The default for format-patch is to output files with the suffix
1259 `.patch`. Use this variable to change that suffix (make sure to
1260 include the dot if you want it).
1263 The default pretty format for log/show/whatchanged command,
1264 See linkgit:git-log[1], linkgit:git-show[1],
1265 linkgit:git-whatchanged[1].
1268 The default threading style for 'git format-patch'. Can be
1269 a boolean value, or `shallow` or `deep`. `shallow` threading
1270 makes every mail a reply to the head of the series,
1271 where the head is chosen from the cover letter, the
1272 `--in-reply-to`, and the first patch mail, in this order.
1273 `deep` threading makes every mail a reply to the previous one.
1274 A true boolean value is the same as `shallow`, and a false
1275 value disables threading.
1278 A boolean value which lets you enable the `-s/--signoff` option of
1279 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1280 patch should be a conscious act and means that you certify you have
1281 the rights to submit this work under the same open source license.
1282 Please see the 'SubmittingPatches' document for further discussion.
1284 format.coverLetter::
1285 A boolean that controls whether to generate a cover-letter when
1286 format-patch is invoked, but in addition can be set to "auto", to
1287 generate a cover-letter only when there's more than one patch.
1289 format.outputDirectory::
1290 Set a custom directory to store the resulting files instead of the
1291 current working directory.
1293 filter.<driver>.clean::
1294 The command which is used to convert the content of a worktree
1295 file to a blob upon checkin. See linkgit:gitattributes[5] for
1298 filter.<driver>.smudge::
1299 The command which is used to convert the content of a blob
1300 object to a worktree file upon checkout. See
1301 linkgit:gitattributes[5] for details.
1304 Allows overriding the message type (error, warn or ignore) of a
1305 specific message ID such as `missingEmail`.
1307 For convenience, fsck prefixes the error/warning with the message ID,
1308 e.g. "missingEmail: invalid author/committer line - missing email" means
1309 that setting `fsck.missingEmail = ignore` will hide that issue.
1311 This feature is intended to support working with legacy repositories
1312 which cannot be repaired without disruptive changes.
1315 The path to a sorted list of object names (i.e. one SHA-1 per
1316 line) that are known to be broken in a non-fatal way and should
1317 be ignored. This feature is useful when an established project
1318 should be accepted despite early commits containing errors that
1319 can be safely ignored such as invalid committer email addresses.
1320 Note: corrupt objects cannot be skipped with this setting.
1322 gc.aggressiveDepth::
1323 The depth parameter used in the delta compression
1324 algorithm used by 'git gc --aggressive'. This defaults
1327 gc.aggressiveWindow::
1328 The window size parameter used in the delta compression
1329 algorithm used by 'git gc --aggressive'. This defaults
1333 When there are approximately more than this many loose
1334 objects in the repository, `git gc --auto` will pack them.
1335 Some Porcelain commands use this command to perform a
1336 light-weight garbage collection from time to time. The
1337 default value is 6700. Setting this to 0 disables it.
1340 When there are more than this many packs that are not
1341 marked with `*.keep` file in the repository, `git gc
1342 --auto` consolidates them into one larger pack. The
1343 default value is 50. Setting this to 0 disables it.
1346 Make `git gc --auto` return immediately and run in background
1347 if the system supports it. Default is true.
1350 Running `git pack-refs` in a repository renders it
1351 unclonable by Git versions prior to 1.5.1.2 over dumb
1352 transports such as HTTP. This variable determines whether
1353 'git gc' runs `git pack-refs`. This can be set to `notbare`
1354 to enable it within all non-bare repos or it can be set to a
1355 boolean value. The default is `true`.
1358 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1359 Override the grace period with this config variable. The value
1360 "now" may be used to disable this grace period and always prune
1361 unreachable objects immediately, or "never" may be used to
1364 gc.worktreePruneExpire::
1365 When 'git gc' is run, it calls
1366 'git worktree prune --expire 3.months.ago'.
1367 This config variable can be used to set a different grace
1368 period. The value "now" may be used to disable the grace
1369 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1370 may be used to suppress pruning.
1373 gc.<pattern>.reflogExpire::
1374 'git reflog expire' removes reflog entries older than
1375 this time; defaults to 90 days. The value "now" expires all
1376 entries immediately, and "never" suppresses expiration
1377 altogether. With "<pattern>" (e.g.
1378 "refs/stash") in the middle the setting applies only to
1379 the refs that match the <pattern>.
1381 gc.reflogExpireUnreachable::
1382 gc.<pattern>.reflogExpireUnreachable::
1383 'git reflog expire' removes reflog entries older than
1384 this time and are not reachable from the current tip;
1385 defaults to 30 days. The value "now" expires all entries
1386 immediately, and "never" suppresses expiration altogether.
1387 With "<pattern>" (e.g. "refs/stash")
1388 in the middle, the setting applies only to the refs that
1389 match the <pattern>.
1392 Records of conflicted merge you resolved earlier are
1393 kept for this many days when 'git rerere gc' is run.
1394 The default is 60 days. See linkgit:git-rerere[1].
1396 gc.rerereUnresolved::
1397 Records of conflicted merge you have not resolved are
1398 kept for this many days when 'git rerere gc' is run.
1399 The default is 15 days. See linkgit:git-rerere[1].
1401 gitcvs.commitMsgAnnotation::
1402 Append this string to each commit message. Set to empty string
1403 to disable this feature. Defaults to "via git-CVS emulator".
1406 Whether the CVS server interface is enabled for this repository.
1407 See linkgit:git-cvsserver[1].
1410 Path to a log file where the CVS server interface well... logs
1411 various stuff. See linkgit:git-cvsserver[1].
1413 gitcvs.usecrlfattr::
1414 If true, the server will look up the end-of-line conversion
1415 attributes for files to determine the '-k' modes to use. If
1416 the attributes force Git to treat a file as text,
1417 the '-k' mode will be left blank so CVS clients will
1418 treat it as text. If they suppress text conversion, the file
1419 will be set with '-kb' mode, which suppresses any newline munging
1420 the client might otherwise do. If the attributes do not allow
1421 the file type to be determined, then 'gitcvs.allBinary' is
1422 used. See linkgit:gitattributes[5].
1425 This is used if 'gitcvs.usecrlfattr' does not resolve
1426 the correct '-kb' mode to use. If true, all
1427 unresolved files are sent to the client in
1428 mode '-kb'. This causes the client to treat them
1429 as binary files, which suppresses any newline munging it
1430 otherwise might do. Alternatively, if it is set to "guess",
1431 then the contents of the file are examined to decide if
1432 it is binary, similar to 'core.autocrlf'.
1435 Database used by git-cvsserver to cache revision information
1436 derived from the Git repository. The exact meaning depends on the
1437 used database driver, for SQLite (which is the default driver) this
1438 is a filename. Supports variable substitution (see
1439 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1440 Default: '%Ggitcvs.%m.sqlite'
1443 Used Perl DBI driver. You can specify any available driver
1444 for this here, but it might not work. git-cvsserver is tested
1445 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1446 reported *not* to work with 'DBD::mysql'. Experimental feature.
1447 May not contain double colons (`:`). Default: 'SQLite'.
1448 See linkgit:git-cvsserver[1].
1450 gitcvs.dbUser, gitcvs.dbPass::
1451 Database user and password. Only useful if setting 'gitcvs.dbDriver',
1452 since SQLite has no concept of database users and/or passwords.
1453 'gitcvs.dbUser' supports variable substitution (see
1454 linkgit:git-cvsserver[1] for details).
1456 gitcvs.dbTableNamePrefix::
1457 Database table name prefix. Prepended to the names of any
1458 database tables used, allowing a single database to be used
1459 for several repositories. Supports variable substitution (see
1460 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1461 characters will be replaced with underscores.
1463 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1464 'gitcvs.allBinary' can also be specified as
1465 'gitcvs.<access_method>.<varname>' (where 'access_method'
1466 is one of "ext" and "pserver") to make them apply only for the given
1470 gitweb.description::
1473 See linkgit:gitweb[1] for description.
1481 gitweb.remote_heads::
1484 See linkgit:gitweb.conf[5] for description.
1487 If set to true, enable '-n' option by default.
1490 Set the default matching behavior. Using a value of 'basic', 'extended',
1491 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1492 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1493 value 'default' will return to the default matching behavior.
1495 grep.extendedRegexp::
1496 If set to true, enable '--extended-regexp' option by default. This
1497 option is ignored when the 'grep.patternType' option is set to a value
1498 other than 'default'.
1501 Number of grep worker threads to use.
1502 See `grep.threads` in linkgit:git-grep[1] for more information.
1504 grep.fallbackToNoIndex::
1505 If set to true, fall back to git grep --no-index if git grep
1506 is executed outside of a git repository. Defaults to false.
1509 Use this custom program instead of "`gpg`" found on `$PATH` when
1510 making or verifying a PGP signature. The program must support the
1511 same command-line interface as GPG, namely, to verify a detached
1512 signature, "`gpg --verify $file - <$signature`" is run, and the
1513 program is expected to signal a good signature by exiting with
1514 code 0, and to generate an ASCII-armored detached signature, the
1515 standard input of "`gpg -bsau $key`" is fed with the contents to be
1516 signed, and the program is expected to send the result to its
1519 gui.commitMsgWidth::
1520 Defines how wide the commit message window is in the
1521 linkgit:git-gui[1]. "75" is the default.
1524 Specifies how many context lines should be used in calls to diff
1525 made by the linkgit:git-gui[1]. The default is "5".
1527 gui.displayUntracked::
1528 Determines if linkgit:git-gui[1] shows untracked files
1529 in the file list. The default is "true".
1532 Specifies the default encoding to use for displaying of
1533 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1534 It can be overridden by setting the 'encoding' attribute
1535 for relevant files (see linkgit:gitattributes[5]).
1536 If this option is not set, the tools default to the
1539 gui.matchTrackingBranch::
1540 Determines if new branches created with linkgit:git-gui[1] should
1541 default to tracking remote branches with matching names or
1542 not. Default: "false".
1544 gui.newBranchTemplate::
1545 Is used as suggested name when creating new branches using the
1548 gui.pruneDuringFetch::
1549 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1550 performing a fetch. The default value is "false".
1553 Determines if linkgit:git-gui[1] should trust the file modification
1554 timestamp or not. By default the timestamps are not trusted.
1556 gui.spellingDictionary::
1557 Specifies the dictionary used for spell checking commit messages in
1558 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1562 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1563 location detection. It makes blame significantly faster on huge
1564 repositories at the expense of less thorough copy detection.
1566 gui.copyBlameThreshold::
1567 Specifies the threshold to use in 'git gui blame' original location
1568 detection, measured in alphanumeric characters. See the
1569 linkgit:git-blame[1] manual for more information on copy detection.
1571 gui.blamehistoryctx::
1572 Specifies the radius of history context in days to show in
1573 linkgit:gitk[1] for the selected commit, when the `Show History
1574 Context` menu item is invoked from 'git gui blame'. If this
1575 variable is set to zero, the whole history is shown.
1577 guitool.<name>.cmd::
1578 Specifies the shell command line to execute when the corresponding item
1579 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1580 mandatory for every tool. The command is executed from the root of
1581 the working directory, and in the environment it receives the name of
1582 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1583 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1584 the head is detached, 'CUR_BRANCH' is empty).
1586 guitool.<name>.needsFile::
1587 Run the tool only if a diff is selected in the GUI. It guarantees
1588 that 'FILENAME' is not empty.
1590 guitool.<name>.noConsole::
1591 Run the command silently, without creating a window to display its
1594 guitool.<name>.noRescan::
1595 Don't rescan the working directory for changes after the tool
1598 guitool.<name>.confirm::
1599 Show a confirmation dialog before actually running the tool.
1601 guitool.<name>.argPrompt::
1602 Request a string argument from the user, and pass it to the tool
1603 through the 'ARGS' environment variable. Since requesting an
1604 argument implies confirmation, the 'confirm' option has no effect
1605 if this is enabled. If the option is set to 'true', 'yes', or '1',
1606 the dialog uses a built-in generic prompt; otherwise the exact
1607 value of the variable is used.
1609 guitool.<name>.revPrompt::
1610 Request a single valid revision from the user, and set the
1611 'REVISION' environment variable. In other aspects this option
1612 is similar to 'argPrompt', and can be used together with it.
1614 guitool.<name>.revUnmerged::
1615 Show only unmerged branches in the 'revPrompt' subdialog.
1616 This is useful for tools similar to merge or rebase, but not
1617 for things like checkout or reset.
1619 guitool.<name>.title::
1620 Specifies the title to use for the prompt dialog. The default
1623 guitool.<name>.prompt::
1624 Specifies the general prompt string to display at the top of
1625 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1626 The default value includes the actual command.
1629 Specify the browser that will be used to display help in the
1630 'web' format. See linkgit:git-help[1].
1633 Override the default help format used by linkgit:git-help[1].
1634 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1635 the default. 'web' and 'html' are the same.
1638 Automatically correct and execute mistyped commands after
1639 waiting for the given number of deciseconds (0.1 sec). If more
1640 than one command can be deduced from the entered text, nothing
1641 will be executed. If the value of this option is negative,
1642 the corrected command will be executed immediately. If the
1643 value is 0 - the command will be just shown but not executed.
1644 This is the default.
1647 Specify the path where the HTML documentation resides. File system paths
1648 and URLs are supported. HTML pages will be prefixed with this path when
1649 help is displayed in the 'web' format. This defaults to the documentation
1650 path of your Git installation.
1653 Override the HTTP proxy, normally configured using the 'http_proxy',
1654 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1655 addition to the syntax understood by curl, it is possible to specify a
1656 proxy string with a user name but no password, in which case git will
1657 attempt to acquire one in the same way it does for other credentials. See
1658 linkgit:gitcredentials[7] for more information. The syntax thus is
1659 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1660 on a per-remote basis; see remote.<name>.proxy
1662 http.proxyAuthMethod::
1663 Set the method with which to authenticate against the HTTP proxy. This
1664 only takes effect if the configured proxy string contains a user name part
1665 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1666 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1667 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1668 variable. Possible values are:
1671 * `anyauth` - Automatically pick a suitable authentication method. It is
1672 assumed that the proxy answers an unauthenticated request with a 407
1673 status code and one or more Proxy-authenticate headers with supported
1674 authentication methods. This is the default.
1675 * `basic` - HTTP Basic authentication
1676 * `digest` - HTTP Digest authentication; this prevents the password from being
1677 transmitted to the proxy in clear text
1678 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1680 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1684 Attempt authentication without seeking a username or password. This
1685 can be used to attempt GSS-Negotiate authentication without specifying
1686 a username in the URL, as libcurl normally requires a username for
1690 Pass an additional HTTP header when communicating with a server. If
1691 more than one such entry exists, all of them are added as extra
1692 headers. To allow overriding the settings inherited from the system
1693 config, an empty value will reset the extra headers to the empty list.
1696 The pathname of a file containing previously stored cookie lines,
1697 which should be used
1698 in the Git http session, if they match the server. The file format
1699 of the file to read cookies from should be plain HTTP headers or
1700 the Netscape/Mozilla cookie file format (see `curl(1)`).
1701 NOTE that the file specified with http.cookieFile is used only as
1702 input unless http.saveCookies is set.
1705 If set, store cookies received during requests to the file specified by
1706 http.cookieFile. Has no effect if http.cookieFile is unset.
1709 The SSL version to use when negotiating an SSL connection, if you
1710 want to force the default. The available and default version
1711 depend on whether libcurl was built against NSS or OpenSSL and the
1712 particular configuration of the crypto library in use. Internally
1713 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1714 documentation for more details on the format of this option and
1715 for the ssl version supported. Actually the possible values of
1726 Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1727 To force git to use libcurl's default ssl version and ignore any
1728 explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1731 http.sslCipherList::
1732 A list of SSL ciphers to use when negotiating an SSL connection.
1733 The available ciphers depend on whether libcurl was built against
1734 NSS or OpenSSL and the particular configuration of the crypto
1735 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1736 option; see the libcurl documentation for more details on the format
1739 Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1740 To force git to use libcurl's default cipher list and ignore any
1741 explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1745 Whether to verify the SSL certificate when fetching or pushing
1746 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1750 File containing the SSL certificate when fetching or pushing
1751 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1755 File containing the SSL private key when fetching or pushing
1756 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1759 http.sslCertPasswordProtected::
1760 Enable Git's password prompt for the SSL certificate. Otherwise
1761 OpenSSL will prompt the user, possibly many times, if the
1762 certificate or private key is encrypted. Can be overridden by the
1763 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1766 File containing the certificates to verify the peer with when
1767 fetching or pushing over HTTPS. Can be overridden by the
1768 'GIT_SSL_CAINFO' environment variable.
1771 Path containing files with the CA certificates to verify the peer
1772 with when fetching or pushing over HTTPS. Can be overridden
1773 by the 'GIT_SSL_CAPATH' environment variable.
1776 Public key of the https service. It may either be the filename of
1777 a PEM or DER encoded public key file or a string starting with
1778 'sha256//' followed by the base64 encoded sha256 hash of the
1779 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1780 exit with an error if this option is set but not supported by
1784 Attempt to use AUTH SSL/TLS and encrypted data transfers
1785 when connecting via regular FTP protocol. This might be needed
1786 if the FTP server requires it for security reasons or you wish
1787 to connect securely whenever remote FTP server supports it.
1788 Default is false since it might trigger certificate verification
1789 errors on misconfigured servers.
1792 How many HTTP requests to launch in parallel. Can be overridden
1793 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1796 The number of curl sessions (counted across slots) to be kept across
1797 requests. They will not be ended with curl_easy_cleanup() until
1798 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1799 value will be capped at 1. Defaults to 1.
1802 Maximum size in bytes of the buffer used by smart HTTP
1803 transports when POSTing data to the remote system.
1804 For requests larger than this buffer size, HTTP/1.1 and
1805 Transfer-Encoding: chunked is used to avoid creating a
1806 massive pack file locally. Default is 1 MiB, which is
1807 sufficient for most requests.
1809 http.lowSpeedLimit, http.lowSpeedTime::
1810 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1811 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1812 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1813 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1816 A boolean which disables using of EPSV ftp command by curl.
1817 This can helpful with some "poor" ftp servers which don't
1818 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1819 environment variable. Default is false (curl will use EPSV).
1822 The HTTP USER_AGENT string presented to an HTTP server. The default
1823 value represents the version of the client Git such as git/1.7.1.
1824 This option allows you to override this value to a more common value
1825 such as Mozilla/4.0. This may be necessary, for instance, if
1826 connecting through a firewall that restricts HTTP connections to a set
1827 of common USER_AGENT strings (but not including those like git/1.7.1).
1828 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1831 Any of the http.* options above can be applied selectively to some URLs.
1832 For a config key to match a URL, each element of the config key is
1833 compared to that of the URL, in the following order:
1836 . Scheme (e.g., `https` in `https://example.com/`). This field
1837 must match exactly between the config key and the URL.
1839 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1840 This field must match exactly between the config key and the URL.
1842 . Port number (e.g., `8080` in `http://example.com:8080/`).
1843 This field must match exactly between the config key and the URL.
1844 Omitted port numbers are automatically converted to the correct
1845 default for the scheme before matching.
1847 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1848 path field of the config key must match the path field of the URL
1849 either exactly or as a prefix of slash-delimited path elements. This means
1850 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1851 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1852 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1853 key with just path `foo/`).
1855 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1856 the config key has a user name it must match the user name in the
1857 URL exactly. If the config key does not have a user name, that
1858 config key will match a URL with any user name (including none),
1859 but at a lower precedence than a config key with a user name.
1862 The list above is ordered by decreasing precedence; a URL that matches
1863 a config key's path is preferred to one that matches its user name. For example,
1864 if the URL is `https://user@example.com/foo/bar` a config key match of
1865 `https://example.com/foo` will be preferred over a config key match of
1866 `https://user@example.com`.
1868 All URLs are normalized before attempting any matching (the password part,
1869 if embedded in the URL, is always ignored for matching purposes) so that
1870 equivalent URLs that are simply spelled differently will match properly.
1871 Environment variable settings always override any matches. The URLs that are
1872 matched against are those given directly to Git commands. This means any URLs
1873 visited as a result of a redirection do not participate in matching.
1875 i18n.commitEncoding::
1876 Character encoding the commit messages are stored in; Git itself
1877 does not care per se, but this information is necessary e.g. when
1878 importing commits from emails or in the gitk graphical history
1879 browser (and possibly at other places in the future or in other
1880 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1882 i18n.logOutputEncoding::
1883 Character encoding the commit messages are converted to when
1884 running 'git log' and friends.
1887 The configuration variables in the 'imap' section are described
1888 in linkgit:git-imap-send[1].
1891 Specify the version with which new index files should be
1892 initialized. This does not affect existing repositories.
1895 Specify the directory from which templates will be copied.
1896 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1899 Specify the program that will be used to browse your working
1900 repository in gitweb. See linkgit:git-instaweb[1].
1903 The HTTP daemon command-line to start gitweb on your working
1904 repository. See linkgit:git-instaweb[1].
1907 If true the web server started by linkgit:git-instaweb[1] will
1908 be bound to the local IP (127.0.0.1).
1910 instaweb.modulePath::
1911 The default module path for linkgit:git-instaweb[1] to use
1912 instead of /usr/lib/apache2/modules. Only used if httpd
1916 The port number to bind the gitweb httpd to. See
1917 linkgit:git-instaweb[1].
1919 interactive.singleKey::
1920 In interactive commands, allow the user to provide one-letter
1921 input with a single key (i.e., without hitting enter).
1922 Currently this is used by the `--patch` mode of
1923 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1924 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1925 setting is silently ignored if portable keystroke input
1926 is not available; requires the Perl module Term::ReadKey.
1928 interactive.diffFilter::
1929 When an interactive command (such as `git add --patch`) shows
1930 a colorized diff, git will pipe the diff through the shell
1931 command defined by this configuration variable. The command may
1932 mark up the diff further for human consumption, provided that it
1933 retains a one-to-one correspondence with the lines in the
1934 original diff. Defaults to disabled (no filtering).
1937 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1938 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1939 override this option with `--no-abbrev-commit`.
1942 Set the default date-time mode for the 'log' command.
1943 Setting a value for log.date is similar to using 'git log''s
1944 `--date` option. See linkgit:git-log[1] for details.
1947 Print out the ref names of any commits that are shown by the log
1948 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1949 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1950 specified, the full ref name (including prefix) will be printed.
1951 This is the same as the log commands '--decorate' option.
1954 If `true`, `git log` will act as if the `--follow` option was used when
1955 a single <path> is given. This has the same limitations as `--follow`,
1956 i.e. it cannot be used to follow multiple files and does not work well
1957 on non-linear history.
1960 If true, the initial commit will be shown as a big creation event.
1961 This is equivalent to a diff against an empty tree.
1962 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1963 normally hide the root commit will now show it. True by default.
1966 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1967 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1970 If true, makes linkgit:git-mailinfo[1] (and therefore
1971 linkgit:git-am[1]) act by default as if the --scissors option
1972 was provided on the command-line. When active, this features
1973 removes everything from the message body before a scissors
1974 line (i.e. consisting mainly of ">8", "8<" and "-").
1977 The location of an augmenting mailmap file. The default
1978 mailmap, located in the root of the repository, is loaded
1979 first, then the mailmap file pointed to by this variable.
1980 The location of the mailmap file may be in a repository
1981 subdirectory, or somewhere outside of the repository itself.
1982 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1985 Like `mailmap.file`, but consider the value as a reference to a
1986 blob in the repository. If both `mailmap.file` and
1987 `mailmap.blob` are given, both are parsed, with entries from
1988 `mailmap.file` taking precedence. In a bare repository, this
1989 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1993 Specify the programs that may be used to display help in the
1994 'man' format. See linkgit:git-help[1].
1997 Specify the command to invoke the specified man viewer. The
1998 specified command is evaluated in shell with the man page
1999 passed as argument. (See linkgit:git-help[1].)
2002 Override the path for the given tool that may be used to
2003 display help in the 'man' format. See linkgit:git-help[1].
2005 include::merge-config.txt[]
2007 mergetool.<tool>.path::
2008 Override the path for the given tool. This is useful in case
2009 your tool is not in the PATH.
2011 mergetool.<tool>.cmd::
2012 Specify the command to invoke the specified merge tool. The
2013 specified command is evaluated in shell with the following
2014 variables available: 'BASE' is the name of a temporary file
2015 containing the common base of the files to be merged, if available;
2016 'LOCAL' is the name of a temporary file containing the contents of
2017 the file on the current branch; 'REMOTE' is the name of a temporary
2018 file containing the contents of the file from the branch being
2019 merged; 'MERGED' contains the name of the file to which the merge
2020 tool should write the results of a successful merge.
2022 mergetool.<tool>.trustExitCode::
2023 For a custom merge command, specify whether the exit code of
2024 the merge command can be used to determine whether the merge was
2025 successful. If this is not set to true then the merge target file
2026 timestamp is checked and the merge assumed to have been successful
2027 if the file has been updated, otherwise the user is prompted to
2028 indicate the success of the merge.
2030 mergetool.meld.hasOutput::
2031 Older versions of `meld` do not support the `--output` option.
2032 Git will attempt to detect whether `meld` supports `--output`
2033 by inspecting the output of `meld --help`. Configuring
2034 `mergetool.meld.hasOutput` will make Git skip these checks and
2035 use the configured value instead. Setting `mergetool.meld.hasOutput`
2036 to `true` tells Git to unconditionally use the `--output` option,
2037 and `false` avoids using `--output`.
2039 mergetool.keepBackup::
2040 After performing a merge, the original file with conflict markers
2041 can be saved as a file with a `.orig` extension. If this variable
2042 is set to `false` then this file is not preserved. Defaults to
2043 `true` (i.e. keep the backup files).
2045 mergetool.keepTemporaries::
2046 When invoking a custom merge tool, Git uses a set of temporary
2047 files to pass to the tool. If the tool returns an error and this
2048 variable is set to `true`, then these temporary files will be
2049 preserved, otherwise they will be removed after the tool has
2050 exited. Defaults to `false`.
2052 mergetool.writeToTemp::
2053 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2054 conflicting files in the worktree by default. Git will attempt
2055 to use a temporary directory for these files when set `true`.
2056 Defaults to `false`.
2059 Prompt before each invocation of the merge resolution program.
2061 notes.mergeStrategy::
2062 Which merge strategy to choose by default when resolving notes
2063 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2064 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2065 section of linkgit:git-notes[1] for more information on each strategy.
2067 notes.<name>.mergeStrategy::
2068 Which merge strategy to choose when doing a notes merge into
2069 refs/notes/<name>. This overrides the more general
2070 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2071 linkgit:git-notes[1] for more information on the available strategies.
2074 The (fully qualified) refname from which to show notes when
2075 showing commit messages. The value of this variable can be set
2076 to a glob, in which case notes from all matching refs will be
2077 shown. You may also specify this configuration variable
2078 several times. A warning will be issued for refs that do not
2079 exist, but a glob that does not match any refs is silently
2082 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2083 environment variable, which must be a colon separated list of refs or
2086 The effective value of "core.notesRef" (possibly overridden by
2087 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2090 notes.rewrite.<command>::
2091 When rewriting commits with <command> (currently `amend` or
2092 `rebase`) and this variable is set to `true`, Git
2093 automatically copies your notes from the original to the
2094 rewritten commit. Defaults to `true`, but see
2095 "notes.rewriteRef" below.
2098 When copying notes during a rewrite (see the
2099 "notes.rewrite.<command>" option), determines what to do if
2100 the target commit already has a note. Must be one of
2101 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2102 Defaults to `concatenate`.
2104 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2105 environment variable.
2108 When copying notes during a rewrite, specifies the (fully
2109 qualified) ref whose notes should be copied. The ref may be a
2110 glob, in which case notes in all matching refs will be copied.
2111 You may also specify this configuration several times.
2113 Does not have a default value; you must configure this variable to
2114 enable note rewriting. Set it to `refs/notes/commits` to enable
2115 rewriting for the default commit notes.
2117 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2118 environment variable, which must be a colon separated list of refs or
2122 The size of the window used by linkgit:git-pack-objects[1] when no
2123 window size is given on the command line. Defaults to 10.
2126 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2127 maximum depth is given on the command line. Defaults to 50.
2130 The maximum size of memory that is consumed by each thread
2131 in linkgit:git-pack-objects[1] for pack window memory when
2132 no limit is given on the command line. The value can be
2133 suffixed with "k", "m", or "g". When left unconfigured (or
2134 set explicitly to 0), there will be no limit.
2137 An integer -1..9, indicating the compression level for objects
2138 in a pack file. -1 is the zlib default. 0 means no
2139 compression, and 1..9 are various speed/size tradeoffs, 9 being
2140 slowest. If not set, defaults to core.compression. If that is
2141 not set, defaults to -1, the zlib default, which is "a default
2142 compromise between speed and compression (currently equivalent
2145 Note that changing the compression level will not automatically recompress
2146 all existing objects. You can force recompression by passing the -F option
2147 to linkgit:git-repack[1].
2149 pack.deltaCacheSize::
2150 The maximum memory in bytes used for caching deltas in
2151 linkgit:git-pack-objects[1] before writing them out to a pack.
2152 This cache is used to speed up the writing object phase by not
2153 having to recompute the final delta result once the best match
2154 for all objects is found. Repacking large repositories on machines
2155 which are tight with memory might be badly impacted by this though,
2156 especially if this cache pushes the system into swapping.
2157 A value of 0 means no limit. The smallest size of 1 byte may be
2158 used to virtually disable this cache. Defaults to 256 MiB.
2160 pack.deltaCacheLimit::
2161 The maximum size of a delta, that is cached in
2162 linkgit:git-pack-objects[1]. This cache is used to speed up the
2163 writing object phase by not having to recompute the final delta
2164 result once the best match for all objects is found. Defaults to 1000.
2167 Specifies the number of threads to spawn when searching for best
2168 delta matches. This requires that linkgit:git-pack-objects[1]
2169 be compiled with pthreads otherwise this option is ignored with a
2170 warning. This is meant to reduce packing time on multiprocessor
2171 machines. The required amount of memory for the delta search window
2172 is however multiplied by the number of threads.
2173 Specifying 0 will cause Git to auto-detect the number of CPU's
2174 and set the number of threads accordingly.
2177 Specify the default pack index version. Valid values are 1 for
2178 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2179 the new pack index with capabilities for packs larger than 4 GB
2180 as well as proper protection against the repacking of corrupted
2181 packs. Version 2 is the default. Note that version 2 is enforced
2182 and this config option ignored whenever the corresponding pack is
2185 If you have an old Git that does not understand the version 2 `*.idx` file,
2186 cloning or fetching over a non native protocol (e.g. "http")
2187 that will copy both `*.pack` file and corresponding `*.idx` file from the
2188 other side may give you a repository that cannot be accessed with your
2189 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2190 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2193 pack.packSizeLimit::
2194 The maximum size of a pack. This setting only affects
2195 packing to a file when repacking, i.e. the git:// protocol
2196 is unaffected. It can be overridden by the `--max-pack-size`
2197 option of linkgit:git-repack[1]. Reaching this limit results
2198 in the creation of multiple packfiles; which in turn prevents
2199 bitmaps from being created.
2200 The minimum size allowed is limited to 1 MiB.
2201 The default is unlimited.
2202 Common unit suffixes of 'k', 'm', or 'g' are
2206 When true, git will use pack bitmaps (if available) when packing
2207 to stdout (e.g., during the server side of a fetch). Defaults to
2208 true. You should not generally need to turn this off unless
2209 you are debugging pack bitmaps.
2211 pack.writeBitmaps (deprecated)::
2212 This is a deprecated synonym for `repack.writeBitmaps`.
2214 pack.writeBitmapHashCache::
2215 When true, git will include a "hash cache" section in the bitmap
2216 index (if one is written). This cache can be used to feed git's
2217 delta heuristics, potentially leading to better deltas between
2218 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2219 between an older, bitmapped pack and objects that have been
2220 pushed since the last gc). The downside is that it consumes 4
2221 bytes per object of disk space, and that JGit's bitmap
2222 implementation does not understand it, causing it to complain if
2223 Git and JGit are used on the same repository. Defaults to false.
2226 If the value is boolean, turns on or off pagination of the
2227 output of a particular Git subcommand when writing to a tty.
2228 Otherwise, turns on pagination for the subcommand using the
2229 pager specified by the value of `pager.<cmd>`. If `--paginate`
2230 or `--no-pager` is specified on the command line, it takes
2231 precedence over this option. To disable pagination for all
2232 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2235 Alias for a --pretty= format string, as specified in
2236 linkgit:git-log[1]. Any aliases defined here can be used just
2237 as the built-in pretty formats could. For example,
2238 running `git config pretty.changelog "format:* %H %s"`
2239 would cause the invocation `git log --pretty=changelog`
2240 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2241 Note that an alias with the same name as a built-in format
2242 will be silently ignored.
2245 By default, Git does not create an extra merge commit when merging
2246 a commit that is a descendant of the current commit. Instead, the
2247 tip of the current branch is fast-forwarded. When set to `false`,
2248 this variable tells Git to create an extra merge commit in such
2249 a case (equivalent to giving the `--no-ff` option from the command
2250 line). When set to `only`, only such fast-forward merges are
2251 allowed (equivalent to giving the `--ff-only` option from the
2252 command line). This setting overrides `merge.ff` when pulling.
2255 When true, rebase branches on top of the fetched branch, instead
2256 of merging the default branch from the default remote when "git
2257 pull" is run. See "branch.<name>.rebase" for setting this on a
2260 When preserve, also pass `--preserve-merges` along to 'git rebase'
2261 so that locally committed merge commits will not be flattened
2262 by running 'git pull'.
2264 When the value is `interactive`, the rebase is run in interactive mode.
2266 *NOTE*: this is a possibly dangerous operation; do *not* use
2267 it unless you understand the implications (see linkgit:git-rebase[1]
2271 The default merge strategy to use when pulling multiple branches
2275 The default merge strategy to use when pulling a single branch.
2278 Defines the action `git push` should take if no refspec is
2279 explicitly given. Different values are well-suited for
2280 specific workflows; for instance, in a purely central workflow
2281 (i.e. the fetch source is equal to the push destination),
2282 `upstream` is probably what you want. Possible values are:
2286 * `nothing` - do not push anything (error out) unless a refspec is
2287 explicitly given. This is primarily meant for people who want to
2288 avoid mistakes by always being explicit.
2290 * `current` - push the current branch to update a branch with the same
2291 name on the receiving end. Works in both central and non-central
2294 * `upstream` - push the current branch back to the branch whose
2295 changes are usually integrated into the current branch (which is
2296 called `@{upstream}`). This mode only makes sense if you are
2297 pushing to the same repository you would normally pull from
2298 (i.e. central workflow).
2300 * `simple` - in centralized workflow, work like `upstream` with an
2301 added safety to refuse to push if the upstream branch's name is
2302 different from the local one.
2304 When pushing to a remote that is different from the remote you normally
2305 pull from, work as `current`. This is the safest option and is suited
2308 This mode has become the default in Git 2.0.
2310 * `matching` - push all branches having the same name on both ends.
2311 This makes the repository you are pushing to remember the set of
2312 branches that will be pushed out (e.g. if you always push 'maint'
2313 and 'master' there and no other branches, the repository you push
2314 to will have these two branches, and your local 'maint' and
2315 'master' will be pushed there).
2317 To use this mode effectively, you have to make sure _all_ the
2318 branches you would push out are ready to be pushed out before
2319 running 'git push', as the whole point of this mode is to allow you
2320 to push all of the branches in one go. If you usually finish work
2321 on only one branch and push out the result, while other branches are
2322 unfinished, this mode is not for you. Also this mode is not
2323 suitable for pushing into a shared central repository, as other
2324 people may add new branches there, or update the tip of existing
2325 branches outside your control.
2327 This used to be the default, but not since Git 2.0 (`simple` is the
2333 If set to true enable '--follow-tags' option by default. You
2334 may override this configuration at time of push by specifying
2338 May be set to a boolean value, or the string 'if-asked'. A true
2339 value causes all pushes to be GPG signed, as if '--signed' is
2340 passed to linkgit:git-push[1]. The string 'if-asked' causes
2341 pushes to be signed if the server supports it, as if
2342 '--signed=if-asked' is passed to 'git push'. A false value may
2343 override a value from a lower-priority config file. An explicit
2344 command-line flag always overrides this config option.
2346 push.recurseSubmodules::
2347 Make sure all submodule commits used by the revisions to be pushed
2348 are available on a remote-tracking branch. If the value is 'check'
2349 then Git will verify that all submodule commits that changed in the
2350 revisions to be pushed are available on at least one remote of the
2351 submodule. If any commits are missing, the push will be aborted and
2352 exit with non-zero status. If the value is 'on-demand' then all
2353 submodules that changed in the revisions to be pushed will be
2354 pushed. If on-demand was not able to push all necessary revisions
2355 it will also be aborted and exit with non-zero status. If the value
2356 is 'no' then default behavior of ignoring submodules when pushing
2357 is retained. You may override this configuration at time of push by
2358 specifying '--recurse-submodules=check|on-demand|no'.
2361 Whether to show a diffstat of what changed upstream since the last
2362 rebase. False by default.
2365 If set to true enable '--autosquash' option by default.
2368 When set to true, automatically create a temporary stash
2369 before the operation begins, and apply it after the operation
2370 ends. This means that you can run rebase on a dirty worktree.
2371 However, use with care: the final stash application after a
2372 successful rebase might result in non-trivial conflicts.
2375 rebase.missingCommitsCheck::
2376 If set to "warn", git rebase -i will print a warning if some
2377 commits are removed (e.g. a line was deleted), however the
2378 rebase will still proceed. If set to "error", it will print
2379 the previous warning and stop the rebase, 'git rebase
2380 --edit-todo' can then be used to correct the error. If set to
2381 "ignore", no checking is done.
2382 To drop a commit without warning or error, use the `drop`
2383 command in the todo-list.
2384 Defaults to "ignore".
2386 rebase.instructionFormat
2387 A format string, as specified in linkgit:git-log[1], to be used for
2388 the instruction list during an interactive rebase. The format will automatically
2389 have the long commit hash prepended to the format.
2391 receive.advertiseAtomic::
2392 By default, git-receive-pack will advertise the atomic push
2393 capability to its clients. If you don't want to this capability
2394 to be advertised, set this variable to false.
2397 By default, git-receive-pack will run "git-gc --auto" after
2398 receiving data from git-push and updating refs. You can stop
2399 it by setting this variable to false.
2401 receive.certNonceSeed::
2402 By setting this variable to a string, `git receive-pack`
2403 will accept a `git push --signed` and verifies it by using
2404 a "nonce" protected by HMAC using this string as a secret
2407 receive.certNonceSlop::
2408 When a `git push --signed` sent a push certificate with a
2409 "nonce" that was issued by a receive-pack serving the same
2410 repository within this many seconds, export the "nonce"
2411 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2412 hooks (instead of what the receive-pack asked the sending
2413 side to include). This may allow writing checks in
2414 `pre-receive` and `post-receive` a bit easier. Instead of
2415 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2416 that records by how many seconds the nonce is stale to
2417 decide if they want to accept the certificate, they only
2418 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2420 receive.fsckObjects::
2421 If it is set to true, git-receive-pack will check all received
2422 objects. It will abort in the case of a malformed object or a
2423 broken link. The result of an abort are only dangling objects.
2424 Defaults to false. If not set, the value of `transfer.fsckObjects`
2427 receive.fsck.<msg-id>::
2428 When `receive.fsckObjects` is set to true, errors can be switched
2429 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2430 setting where the `<msg-id>` is the fsck message ID and the value
2431 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2432 the error/warning with the message ID, e.g. "missingEmail: invalid
2433 author/committer line - missing email" means that setting
2434 `receive.fsck.missingEmail = ignore` will hide that issue.
2436 This feature is intended to support working with legacy repositories
2437 which would not pass pushing when `receive.fsckObjects = true`, allowing
2438 the host to accept repositories with certain known issues but still catch
2441 receive.fsck.skipList::
2442 The path to a sorted list of object names (i.e. one SHA-1 per
2443 line) that are known to be broken in a non-fatal way and should
2444 be ignored. This feature is useful when an established project
2445 should be accepted despite early commits containing errors that
2446 can be safely ignored such as invalid committer email addresses.
2447 Note: corrupt objects cannot be skipped with this setting.
2449 receive.unpackLimit::
2450 If the number of objects received in a push is below this
2451 limit then the objects will be unpacked into loose object
2452 files. However if the number of received objects equals or
2453 exceeds this limit then the received pack will be stored as
2454 a pack, after adding any missing delta bases. Storing the
2455 pack from a push can make the push operation complete faster,
2456 especially on slow filesystems. If not set, the value of
2457 `transfer.unpackLimit` is used instead.
2459 receive.denyDeletes::
2460 If set to true, git-receive-pack will deny a ref update that deletes
2461 the ref. Use this to prevent such a ref deletion via a push.
2463 receive.denyDeleteCurrent::
2464 If set to true, git-receive-pack will deny a ref update that
2465 deletes the currently checked out branch of a non-bare repository.
2467 receive.denyCurrentBranch::
2468 If set to true or "refuse", git-receive-pack will deny a ref update
2469 to the currently checked out branch of a non-bare repository.
2470 Such a push is potentially dangerous because it brings the HEAD
2471 out of sync with the index and working tree. If set to "warn",
2472 print a warning of such a push to stderr, but allow the push to
2473 proceed. If set to false or "ignore", allow such pushes with no
2474 message. Defaults to "refuse".
2476 Another option is "updateInstead" which will update the working
2477 tree if pushing into the current branch. This option is
2478 intended for synchronizing working directories when one side is not easily
2479 accessible via interactive ssh (e.g. a live web site, hence the requirement
2480 that the working directory be clean). This mode also comes in handy when
2481 developing inside a VM to test and fix code on different Operating Systems.
2483 By default, "updateInstead" will refuse the push if the working tree or
2484 the index have any difference from the HEAD, but the `push-to-checkout`
2485 hook can be used to customize this. See linkgit:githooks[5].
2487 receive.denyNonFastForwards::
2488 If set to true, git-receive-pack will deny a ref update which is
2489 not a fast-forward. Use this to prevent such an update via a push,
2490 even if that push is forced. This configuration variable is
2491 set when initializing a shared repository.
2494 This variable is the same as `transfer.hideRefs`, but applies
2495 only to `receive-pack` (and so affects pushes, but not fetches).
2496 An attempt to update or delete a hidden ref by `git push` is
2499 receive.updateServerInfo::
2500 If set to true, git-receive-pack will run git-update-server-info
2501 after receiving data from git-push and updating refs.
2503 receive.shallowUpdate::
2504 If set to true, .git/shallow can be updated when new refs
2505 require new shallow roots. Otherwise those refs are rejected.
2507 remote.pushDefault::
2508 The remote to push to by default. Overrides
2509 `branch.<name>.remote` for all branches, and is overridden by
2510 `branch.<name>.pushRemote` for specific branches.
2513 The URL of a remote repository. See linkgit:git-fetch[1] or
2514 linkgit:git-push[1].
2516 remote.<name>.pushurl::
2517 The push URL of a remote repository. See linkgit:git-push[1].
2519 remote.<name>.proxy::
2520 For remotes that require curl (http, https and ftp), the URL to
2521 the proxy to use for that remote. Set to the empty string to
2522 disable proxying for that remote.
2524 remote.<name>.proxyAuthMethod::
2525 For remotes that require curl (http, https and ftp), the method to use for
2526 authenticating against the proxy in use (probably set in
2527 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2529 remote.<name>.fetch::
2530 The default set of "refspec" for linkgit:git-fetch[1]. See
2531 linkgit:git-fetch[1].
2533 remote.<name>.push::
2534 The default set of "refspec" for linkgit:git-push[1]. See
2535 linkgit:git-push[1].
2537 remote.<name>.mirror::
2538 If true, pushing to this remote will automatically behave
2539 as if the `--mirror` option was given on the command line.
2541 remote.<name>.skipDefaultUpdate::
2542 If true, this remote will be skipped by default when updating
2543 using linkgit:git-fetch[1] or the `update` subcommand of
2544 linkgit:git-remote[1].
2546 remote.<name>.skipFetchAll::
2547 If true, this remote will be skipped by default when updating
2548 using linkgit:git-fetch[1] or the `update` subcommand of
2549 linkgit:git-remote[1].
2551 remote.<name>.receivepack::
2552 The default program to execute on the remote side when pushing. See
2553 option --receive-pack of linkgit:git-push[1].
2555 remote.<name>.uploadpack::
2556 The default program to execute on the remote side when fetching. See
2557 option --upload-pack of linkgit:git-fetch-pack[1].
2559 remote.<name>.tagOpt::
2560 Setting this value to --no-tags disables automatic tag following when
2561 fetching from remote <name>. Setting it to --tags will fetch every
2562 tag from remote <name>, even if they are not reachable from remote
2563 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2564 override this setting. See options --tags and --no-tags of
2565 linkgit:git-fetch[1].
2568 Setting this to a value <vcs> will cause Git to interact with
2569 the remote with the git-remote-<vcs> helper.
2571 remote.<name>.prune::
2572 When set to true, fetching from this remote by default will also
2573 remove any remote-tracking references that no longer exist on the
2574 remote (as if the `--prune` option was given on the command line).
2575 Overrides `fetch.prune` settings, if any.
2578 The list of remotes which are fetched by "git remote update
2579 <group>". See linkgit:git-remote[1].
2581 repack.useDeltaBaseOffset::
2582 By default, linkgit:git-repack[1] creates packs that use
2583 delta-base offset. If you need to share your repository with
2584 Git older than version 1.4.4, either directly or via a dumb
2585 protocol such as http, then you need to set this option to
2586 "false" and repack. Access from old Git versions over the
2587 native protocol are unaffected by this option.
2589 repack.packKeptObjects::
2590 If set to true, makes `git repack` act as if
2591 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2592 details. Defaults to `false` normally, but `true` if a bitmap
2593 index is being written (either via `--write-bitmap-index` or
2594 `repack.writeBitmaps`).
2596 repack.writeBitmaps::
2597 When true, git will write a bitmap index when packing all
2598 objects to disk (e.g., when `git repack -a` is run). This
2599 index can speed up the "counting objects" phase of subsequent
2600 packs created for clones and fetches, at the cost of some disk
2601 space and extra time spent on the initial repack. This has
2602 no effect if multiple packfiles are created.
2606 When set to true, `git-rerere` updates the index with the
2607 resulting contents after it cleanly resolves conflicts using
2608 previously recorded resolution. Defaults to false.
2611 Activate recording of resolved conflicts, so that identical
2612 conflict hunks can be resolved automatically, should they be
2613 encountered again. By default, linkgit:git-rerere[1] is
2614 enabled if there is an `rr-cache` directory under the
2615 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2618 sendemail.identity::
2619 A configuration identity. When given, causes values in the
2620 'sendemail.<identity>' subsection to take precedence over
2621 values in the 'sendemail' section. The default identity is
2622 the value of 'sendemail.identity'.
2624 sendemail.smtpEncryption::
2625 See linkgit:git-send-email[1] for description. Note that this
2626 setting is not subject to the 'identity' mechanism.
2628 sendemail.smtpssl (deprecated)::
2629 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2631 sendemail.smtpsslcertpath::
2632 Path to ca-certificates (either a directory or a single file).
2633 Set it to an empty string to disable certificate verification.
2635 sendemail.<identity>.*::
2636 Identity-specific versions of the 'sendemail.*' parameters
2637 found below, taking precedence over those when the this
2638 identity is selected, through command-line or
2639 'sendemail.identity'.
2641 sendemail.aliasesFile::
2642 sendemail.aliasFileType::
2643 sendemail.annotate::
2647 sendemail.chainReplyTo::
2649 sendemail.envelopeSender::
2651 sendemail.multiEdit::
2652 sendemail.signedoffbycc::
2653 sendemail.smtpPass::
2654 sendemail.suppresscc::
2655 sendemail.suppressFrom::
2657 sendemail.smtpDomain::
2658 sendemail.smtpServer::
2659 sendemail.smtpServerPort::
2660 sendemail.smtpServerOption::
2661 sendemail.smtpUser::
2663 sendemail.transferEncoding::
2664 sendemail.validate::
2666 See linkgit:git-send-email[1] for description.
2668 sendemail.signedoffcc (deprecated)::
2669 Deprecated alias for 'sendemail.signedoffbycc'.
2671 showbranch.default::
2672 The default set of branches for linkgit:git-show-branch[1].
2673 See linkgit:git-show-branch[1].
2675 status.relativePaths::
2676 By default, linkgit:git-status[1] shows paths relative to the
2677 current directory. Setting this variable to `false` shows paths
2678 relative to the repository root (this was the default for Git
2682 Set to true to enable --short by default in linkgit:git-status[1].
2683 The option --no-short takes precedence over this variable.
2686 Set to true to enable --branch by default in linkgit:git-status[1].
2687 The option --no-branch takes precedence over this variable.
2689 status.displayCommentPrefix::
2690 If set to true, linkgit:git-status[1] will insert a comment
2691 prefix before each output line (starting with
2692 `core.commentChar`, i.e. `#` by default). This was the
2693 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2696 status.showUntrackedFiles::
2697 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2698 files which are not currently tracked by Git. Directories which
2699 contain only untracked files, are shown with the directory name
2700 only. Showing untracked files means that Git needs to lstat() all
2701 the files in the whole repository, which might be slow on some
2702 systems. So, this variable controls how the commands displays
2703 the untracked files. Possible values are:
2706 * `no` - Show no untracked files.
2707 * `normal` - Show untracked files and directories.
2708 * `all` - Show also individual files in untracked directories.
2711 If this variable is not specified, it defaults to 'normal'.
2712 This variable can be overridden with the -u|--untracked-files option
2713 of linkgit:git-status[1] and linkgit:git-commit[1].
2715 status.submoduleSummary::
2717 If this is set to a non zero number or true (identical to -1 or an
2718 unlimited number), the submodule summary will be enabled and a
2719 summary of commits for modified submodules will be shown (see
2720 --summary-limit option of linkgit:git-submodule[1]). Please note
2721 that the summary output command will be suppressed for all
2722 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2723 for those submodules where `submodule.<name>.ignore=all`. The only
2724 exception to that rule is that status and commit will show staged
2725 submodule changes. To
2726 also view the summary for ignored submodules you can either use
2727 the --ignore-submodules=dirty command-line option or the 'git
2728 submodule summary' command, which shows a similar output but does
2729 not honor these settings.
2732 If this is set to true, the `git stash show` command without an
2733 option will show the stash in patch form. Defaults to false.
2734 See description of 'show' command in linkgit:git-stash[1].
2737 If this is set to true, the `git stash show` command without an
2738 option will show diffstat of the stash. Defaults to true.
2739 See description of 'show' command in linkgit:git-stash[1].
2741 submodule.<name>.path::
2742 submodule.<name>.url::
2743 The path within this project and URL for a submodule. These
2744 variables are initially populated by 'git submodule init'. See
2745 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2748 submodule.<name>.update::
2749 The default update procedure for a submodule. This variable
2750 is populated by `git submodule init` from the
2751 linkgit:gitmodules[5] file. See description of 'update'
2752 command in linkgit:git-submodule[1].
2754 submodule.<name>.branch::
2755 The remote branch name for a submodule, used by `git submodule
2756 update --remote`. Set this option to override the value found in
2757 the `.gitmodules` file. See linkgit:git-submodule[1] and
2758 linkgit:gitmodules[5] for details.
2760 submodule.<name>.fetchRecurseSubmodules::
2761 This option can be used to control recursive fetching of this
2762 submodule. It can be overridden by using the --[no-]recurse-submodules
2763 command-line option to "git fetch" and "git pull".
2764 This setting will override that from in the linkgit:gitmodules[5]
2767 submodule.<name>.ignore::
2768 Defines under what circumstances "git status" and the diff family show
2769 a submodule as modified. When set to "all", it will never be considered
2770 modified (but it will nonetheless show up in the output of status and
2771 commit when it has been staged), "dirty" will ignore all changes
2772 to the submodules work tree and
2773 takes only differences between the HEAD of the submodule and the commit
2774 recorded in the superproject into account. "untracked" will additionally
2775 let submodules with modified tracked files in their work tree show up.
2776 Using "none" (the default when this option is not set) also shows
2777 submodules that have untracked files in their work tree as changed.
2778 This setting overrides any setting made in .gitmodules for this submodule,
2779 both settings can be overridden on the command line by using the
2780 "--ignore-submodules" option. The 'git submodule' commands are not
2781 affected by this setting.
2783 submodule.fetchJobs::
2784 Specifies how many submodules are fetched/cloned at the same time.
2785 A positive integer allows up to that number of submodules fetched
2786 in parallel. A value of 0 will give some reasonable default.
2787 If unset, it defaults to 1.
2789 tag.forceSignAnnotated::
2790 A boolean to specify whether annotated tags created should be GPG signed.
2791 If `--annotate` is specified on the command line, it takes
2792 precedence over this option.
2795 This variable controls the sort ordering of tags when displayed by
2796 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2797 value of this variable will be used as the default.
2800 This variable can be used to restrict the permission bits of
2801 tar archive entries. The default is 0002, which turns off the
2802 world write bit. The special value "user" indicates that the
2803 archiving user's umask will be used instead. See umask(2) and
2804 linkgit:git-archive[1].
2806 transfer.fsckObjects::
2807 When `fetch.fsckObjects` or `receive.fsckObjects` are
2808 not set, the value of this variable is used instead.
2812 String(s) `receive-pack` and `upload-pack` use to decide which
2813 refs to omit from their initial advertisements. Use more than
2814 one definition to specify multiple prefix strings. A ref that is
2815 under the hierarchies listed in the value of this variable is
2816 excluded, and is hidden when responding to `git push` or `git
2817 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2818 program-specific versions of this config.
2820 You may also include a `!` in front of the ref name to negate the entry,
2821 explicitly exposing it, even if an earlier entry marked it as hidden.
2822 If you have multiple hideRefs values, later entries override earlier ones
2823 (and entries in more-specific config files override less-specific ones).
2825 If a namespace is in use, the namespace prefix is stripped from each
2826 reference before it is matched against `transfer.hiderefs` patterns.
2827 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2828 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2829 is omitted from the advertisements but `refs/heads/master` and
2830 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2831 "have" lines. In order to match refs before stripping, add a `^` in front of
2832 the ref name. If you combine `!` and `^`, `!` must be specified first.
2834 transfer.unpackLimit::
2835 When `fetch.unpackLimit` or `receive.unpackLimit` are
2836 not set, the value of this variable is used instead.
2837 The default value is 100.
2839 uploadarchive.allowUnreachable::
2840 If true, allow clients to use `git archive --remote` to request
2841 any tree, whether reachable from the ref tips or not. See the
2842 discussion in the `SECURITY` section of
2843 linkgit:git-upload-archive[1] for more details. Defaults to
2846 uploadpack.hideRefs::
2847 This variable is the same as `transfer.hideRefs`, but applies
2848 only to `upload-pack` (and so affects only fetches, not pushes).
2849 An attempt to fetch a hidden ref by `git fetch` will fail. See
2850 also `uploadpack.allowTipSHA1InWant`.
2852 uploadpack.allowTipSHA1InWant::
2853 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2854 to accept a fetch request that asks for an object at the tip
2855 of a hidden ref (by default, such a request is rejected).
2856 see also `uploadpack.hideRefs`.
2858 uploadpack.allowReachableSHA1InWant::
2859 Allow `upload-pack` to accept a fetch request that asks for an
2860 object that is reachable from any ref tip. However, note that
2861 calculating object reachability is computationally expensive.
2862 Defaults to `false`.
2864 uploadpack.keepAlive::
2865 When `upload-pack` has started `pack-objects`, there may be a
2866 quiet period while `pack-objects` prepares the pack. Normally
2867 it would output progress information, but if `--quiet` was used
2868 for the fetch, `pack-objects` will output nothing at all until
2869 the pack data begins. Some clients and networks may consider
2870 the server to be hung and give up. Setting this option instructs
2871 `upload-pack` to send an empty keepalive packet every
2872 `uploadpack.keepAlive` seconds. Setting this option to 0
2873 disables keepalive packets entirely. The default is 5 seconds.
2875 url.<base>.insteadOf::
2876 Any URL that starts with this value will be rewritten to
2877 start, instead, with <base>. In cases where some site serves a
2878 large number of repositories, and serves them with multiple
2879 access methods, and some users need to use different access
2880 methods, this feature allows people to specify any of the
2881 equivalent URLs and have Git automatically rewrite the URL to
2882 the best alternative for the particular user, even for a
2883 never-before-seen repository on the site. When more than one
2884 insteadOf strings match a given URL, the longest match is used.
2886 url.<base>.pushInsteadOf::
2887 Any URL that starts with this value will not be pushed to;
2888 instead, it will be rewritten to start with <base>, and the
2889 resulting URL will be pushed to. In cases where some site serves
2890 a large number of repositories, and serves them with multiple
2891 access methods, some of which do not allow push, this feature
2892 allows people to specify a pull-only URL and have Git
2893 automatically use an appropriate URL to push, even for a
2894 never-before-seen repository on the site. When more than one
2895 pushInsteadOf strings match a given URL, the longest match is
2896 used. If a remote has an explicit pushurl, Git will ignore this
2897 setting for that remote.
2900 Your email address to be recorded in any newly created commits.
2901 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2902 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2905 Your full name to be recorded in any newly created commits.
2906 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2907 environment variables. See linkgit:git-commit-tree[1].
2909 user.useConfigOnly::
2910 Instruct Git to avoid trying to guess defaults for 'user.email'
2911 and 'user.name', and instead retrieve the values only from the
2912 configuration. For example, if you have multiple email addresses
2913 and would like to use a different one for each repository, then
2914 with this configuration option set to `true` in the global config
2915 along with a name, Git will prompt you to set up an email before
2916 making new commits in a newly cloned repository.
2917 Defaults to `false`.
2920 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2921 key you want it to automatically when creating a signed tag or
2922 commit, you can override the default selection with this variable.
2923 This option is passed unchanged to gpg's --local-user parameter,
2924 so you may specify a key using any method that gpg supports.
2926 versionsort.prereleaseSuffix::
2927 When version sort is used in linkgit:git-tag[1], prerelease
2928 tags (e.g. "1.0-rc1") may appear after the main release
2929 "1.0". By specifying the suffix "-rc" in this variable,
2930 "1.0-rc1" will appear before "1.0".
2932 This variable can be specified multiple times, once per suffix. The
2933 order of suffixes in the config file determines the sorting order
2934 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2935 is sorted before 1.0-rcXX). The sorting order between different
2936 suffixes is undefined if they are in multiple config files.
2939 Specify a web browser that may be used by some commands.
2940 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]