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 a 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
85 expansion. `include.path` can be given multiple times.
87 The included file is expanded immediately, as if its contents had been
88 found at the location of the include directive. If the value of the
89 `include.path` variable is a relative path, the path is considered to
90 be relative to the configuration file in which the include directive
91 was found. See below for examples.
96 You can include a config file from another conditionally by setting a
97 `includeIf.<condition>.path` variable to the name of the file to be
98 included. The variable's value is treated the same way as
99 `include.path`. `includeIf.<condition>.path` can be given multiple times.
101 The condition starts with a keyword followed by a colon and some data
102 whose format and meaning depends on the keyword. Supported keywords
107 The data that follows the keyword `gitdir:` is used as a glob
108 pattern. If the location of the .git directory matches the
109 pattern, the include condition is met.
111 The .git location may be auto-discovered, or come from `$GIT_DIR`
112 environment variable. If the repository is auto discovered via a .git
113 file (e.g. from submodules, or a linked worktree), the .git location
114 would be the final location where the .git directory is, not where the
117 The pattern can contain standard globbing wildcards and two additional
118 ones, `**/` and `/**`, that can match multiple path components. Please
119 refer to linkgit:gitignore[5] for details. For convenience:
121 * If the pattern starts with `~/`, `~` will be substituted with the
122 content of the environment variable `HOME`.
124 * If the pattern starts with `./`, it is replaced with the directory
125 containing the current config file.
127 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
128 will be automatically prepended. For example, the pattern `foo/bar`
129 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
131 * If the pattern ends with `/`, `**` will be automatically added. For
132 example, the pattern `foo/` becomes `foo/**`. In other words, it
133 matches "foo" and everything inside, recursively.
136 This is the same as `gitdir` except that matching is done
137 case-insensitively (e.g. on case-insensitive file sytems)
139 A few more notes on matching via `gitdir` and `gitdir/i`:
141 * Symlinks in `$GIT_DIR` are not resolved before matching.
143 * Note that "../" is not special and will match literally, which is
144 unlikely what you want.
151 ; Don't trust file modes
156 external = /usr/local/bin/diff-wrapper
161 merge = refs/heads/devel
165 gitProxy="ssh" for "kernel.org"
166 gitProxy=default-proxy ; for the rest
169 path = /path/to/foo.inc ; include by absolute path
170 path = foo ; expand "foo" relative to the current file
171 path = ~/foo ; expand "foo" in your `$HOME` directory
173 ; include if $GIT_DIR is /path/to/foo/.git
174 [includeIf "gitdir:/path/to/foo/.git"]
175 path = /path/to/foo.inc
177 ; include for all repositories inside /path/to/group
178 [includeIf "gitdir:/path/to/group/"]
179 path = /path/to/foo.inc
181 ; include for all repositories inside $HOME/to/group
182 [includeIf "gitdir:~/to/group/"]
183 path = /path/to/foo.inc
188 Values of many variables are treated as a simple string, but there
189 are variables that take values of specific types and there are rules
190 as to how to spell them.
194 When a variable is said to take a boolean value, many
195 synonyms are accepted for 'true' and 'false'; these are all
198 true;; Boolean true can be spelled as `yes`, `on`, `true`,
199 or `1`. Also, a variable defined without `= <value>`
202 false;; Boolean false can be spelled as `no`, `off`,
205 When converting value to the canonical form using `--bool` type
206 specifier; 'git config' will ensure that the output is "true" or
207 "false" (spelled in lowercase).
210 The value for many variables that specify various sizes can
211 be suffixed with `k`, `M`,... to mean "scale the number by
212 1024", "by 1024x1024", etc.
215 The value for a variable that takes a color is a list of
216 colors (at most two, one for foreground and one for background)
217 and attributes (as many as you want), separated by spaces.
219 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
220 `blue`, `magenta`, `cyan` and `white`. The first color given is the
221 foreground; the second is the background.
223 Colors may also be given as numbers between 0 and 255; these use ANSI
224 256-color mode (but note that not all terminals may support this). If
225 your terminal supports it, you may also specify 24-bit RGB values as
228 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
229 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
230 The position of any attributes with respect to the colors
231 (before, after, or in between), doesn't matter. Specific attributes may
232 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
235 An empty color string produces no color effect at all. This can be used
236 to avoid coloring specific elements without disabling color entirely.
238 For git's pre-defined color slots, the attributes are meant to be reset
239 at the beginning of each item in the colored output. So setting
240 `color.decorate.branch` to `black` will paint that branch name in a
241 plain `black`, even if the previous thing on the same output line (e.g.
242 opening parenthesis before the list of branch names in `log --decorate`
243 output) is set to be painted with `bold` or some other attribute.
244 However, custom log formats may do more complicated and layered
245 coloring, and the negated forms may be useful there.
248 A variable that takes a pathname value can be given a
249 string that begins with "`~/`" or "`~user/`", and the usual
250 tilde expansion happens to such a string: `~/`
251 is expanded to the value of `$HOME`, and `~user/` to the
252 specified user's home directory.
258 Note that this list is non-comprehensive and not necessarily complete.
259 For command-specific variables, you will find a more detailed description
260 in the appropriate manual page.
262 Other git-related tools may and do use their own variables. When
263 inventing new variables for use in your own tool, make sure their
264 names do not conflict with those that are used by Git itself and
265 other popular tools, and describe them in your documentation.
269 These variables control various optional help messages designed to
270 aid new users. All 'advice.*' variables default to 'true', and you
271 can tell Git that you do not need help by setting these to 'false':
275 Set this variable to 'false' if you want to disable
277 'pushNonFFMatching', 'pushAlreadyExists',
278 'pushFetchFirst', and 'pushNeedsForce'
281 Advice shown when linkgit:git-push[1] fails due to a
282 non-fast-forward update to the current branch.
284 Advice shown when you ran linkgit:git-push[1] and pushed
285 'matching refs' explicitly (i.e. you used ':', or
286 specified a refspec that isn't your current branch) and
287 it resulted in a non-fast-forward error.
289 Shown when linkgit:git-push[1] rejects an update that
290 does not qualify for fast-forwarding (e.g., a tag.)
292 Shown when linkgit:git-push[1] rejects an update that
293 tries to overwrite a remote ref that points at an
294 object we do not have.
296 Shown when linkgit:git-push[1] rejects an update that
297 tries to overwrite a remote ref that points at an
298 object that is not a commit-ish, or make the remote
299 ref point at an object that is not a commit-ish.
301 Show directions on how to proceed from the current
302 state in the output of linkgit:git-status[1], in
303 the template shown when writing commit messages in
304 linkgit:git-commit[1], and in the help message shown
305 by linkgit:git-checkout[1] when switching branch.
307 Advise to consider using the `-u` option to linkgit:git-status[1]
308 when the command takes more than 2 seconds to enumerate untracked
311 Advice shown when linkgit:git-merge[1] refuses to
312 merge to avoid overwriting local changes.
314 Advice shown by various commands when conflicts
315 prevent the operation from being performed.
317 Advice on how to set your identity configuration when
318 your information is guessed from the system username and
321 Advice shown when you used linkgit:git-checkout[1] to
322 move to the detach HEAD state, to instruct how to create
323 a local branch after the fact.
325 Advice that shows the location of the patch file when
326 linkgit:git-am[1] fails to apply it.
328 In case of failure in the output of linkgit:git-rm[1],
329 show directions on how to proceed from the current state.
333 Tells Git if the executable bit of files in the working tree
336 Some filesystems lose the executable bit when a file that is
337 marked as executable is checked out, or checks out an
338 non-executable file with executable bit on.
339 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
340 to see if it handles the executable bit correctly
341 and this variable is automatically set as necessary.
343 A repository, however, may be on a filesystem that handles
344 the filemode correctly, and this variable is set to 'true'
345 when created, but later may be made accessible from another
346 environment that loses the filemode (e.g. exporting ext4 via
347 CIFS mount, visiting a Cygwin created repository with
348 Git for Windows or Eclipse).
349 In such a case it may be necessary to set this variable to 'false'.
350 See linkgit:git-update-index[1].
352 The default is true (when core.filemode is not specified in the config file).
355 (Windows-only) If true, mark newly-created directories and files whose
356 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
357 directory is hidden, but no other files starting with a dot. The
358 default mode is 'dotGitOnly'.
361 If true, this option enables various workarounds to enable
362 Git to work better on filesystems that are not case sensitive,
363 like FAT. For example, if a directory listing finds
364 "makefile" when Git expects "Makefile", Git will assume
365 it is really the same file, and continue to remember it as
368 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
369 will probe and set core.ignoreCase true if appropriate when the repository
372 core.precomposeUnicode::
373 This option is only used by Mac OS implementation of Git.
374 When core.precomposeUnicode=true, Git reverts the unicode decomposition
375 of filenames done by Mac OS. This is useful when sharing a repository
376 between Mac OS and Linux or Windows.
377 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
378 When false, file names are handled fully transparent by Git,
379 which is backward compatible with older versions of Git.
382 If set to true, do not allow checkout of paths that would
383 be considered equivalent to `.git` on an HFS+ filesystem.
384 Defaults to `true` on Mac OS, and `false` elsewhere.
387 If set to true, do not allow checkout of paths that would
388 cause problems with the NTFS filesystem, e.g. conflict with
390 Defaults to `true` on Windows, and `false` elsewhere.
393 If false, the ctime differences between the index and the
394 working tree are ignored; useful when the inode change time
395 is regularly modified by something outside Git (file system
396 crawlers and some backup systems).
397 See linkgit:git-update-index[1]. True by default.
400 If true, the split-index feature of the index will be used.
401 See linkgit:git-update-index[1]. False by default.
403 core.untrackedCache::
404 Determines what to do about the untracked cache feature of the
405 index. It will be kept, if this variable is unset or set to
406 `keep`. It will automatically be added if set to `true`. And
407 it will automatically be removed, if set to `false`. Before
408 setting it to `true`, you should check that mtime is working
409 properly on your system.
410 See linkgit:git-update-index[1]. `keep` by default.
413 Determines which stat fields to match between the index
414 and work tree. The user can set this to 'default' or
415 'minimal'. Default (or explicitly 'default'), is to check
416 all fields, including the sub-second part of mtime and ctime.
419 Commands that output paths (e.g. 'ls-files', 'diff'), will
420 quote "unusual" characters in the pathname by enclosing the
421 pathname in double-quotes and escaping those characters with
422 backslashes in the same way C escapes control characters (e.g.
423 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
424 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
425 UTF-8). If this variable is set to false, bytes higher than
426 0x80 are not considered "unusual" any more. Double-quotes,
427 backslash and control characters are always escaped regardless
428 of the setting of this variable. A simple space character is
429 not considered "unusual". Many commands can output pathnames
430 completely verbatim using the `-z` option. The default value
434 Sets the line ending type to use in the working directory for
435 files that have the `text` property set when core.autocrlf is false.
436 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
437 native line ending. The default value is `native`. See
438 linkgit:gitattributes[5] for more information on end-of-line
442 If true, makes Git check if converting `CRLF` is reversible when
443 end-of-line conversion is active. Git will verify if a command
444 modifies a file in the work tree either directly or indirectly.
445 For example, committing a file followed by checking out the
446 same file should yield the original file in the work tree. If
447 this is not the case for the current setting of
448 `core.autocrlf`, Git will reject the file. The variable can
449 be set to "warn", in which case Git will only warn about an
450 irreversible conversion but continue the operation.
452 CRLF conversion bears a slight chance of corrupting data.
453 When it is enabled, Git will convert CRLF to LF during commit and LF to
454 CRLF during checkout. A file that contains a mixture of LF and
455 CRLF before the commit cannot be recreated by Git. For text
456 files this is the right thing to do: it corrects line endings
457 such that we have only LF line endings in the repository.
458 But for binary files that are accidentally classified as text the
459 conversion can corrupt data.
461 If you recognize such corruption early you can easily fix it by
462 setting the conversion type explicitly in .gitattributes. Right
463 after committing you still have the original file in your work
464 tree and this file is not yet corrupted. You can explicitly tell
465 Git that this file is binary and Git will handle the file
468 Unfortunately, the desired effect of cleaning up text files with
469 mixed line endings and the undesired effect of corrupting binary
470 files cannot be distinguished. In both cases CRLFs are removed
471 in an irreversible way. For text files this is the right thing
472 to do because CRLFs are line endings, while for binary files
473 converting CRLFs corrupts data.
475 Note, this safety check does not mean that a checkout will generate a
476 file identical to the original file for a different setting of
477 `core.eol` and `core.autocrlf`, but only for the current one. For
478 example, a text file with `LF` would be accepted with `core.eol=lf`
479 and could later be checked out with `core.eol=crlf`, in which case the
480 resulting file would contain `CRLF`, although the original file
481 contained `LF`. However, in both work trees the line endings would be
482 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
483 file with mixed line endings would be reported by the `core.safecrlf`
487 Setting this variable to "true" is the same as setting
488 the `text` attribute to "auto" on all files and core.eol to "crlf".
489 Set to true if you want to have `CRLF` line endings in your
490 working directory and the repository has LF line endings.
491 This variable can be set to 'input',
492 in which case no output conversion is performed.
495 If false, symbolic links are checked out as small plain files that
496 contain the link text. linkgit:git-update-index[1] and
497 linkgit:git-add[1] will not change the recorded type to regular
498 file. Useful on filesystems like FAT that do not support
501 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
502 will probe and set core.symlinks false if appropriate when the repository
506 A "proxy command" to execute (as 'command host port') instead
507 of establishing direct connection to the remote server when
508 using the Git protocol for fetching. If the variable value is
509 in the "COMMAND for DOMAIN" format, the command is applied only
510 on hostnames ending with the specified domain string. This variable
511 may be set multiple times and is matched in the given order;
512 the first match wins.
514 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
515 (which always applies universally, without the special "for"
518 The special string `none` can be used as the proxy command to
519 specify that no proxy be used for a given domain pattern.
520 This is useful for excluding servers inside a firewall from
521 proxy use, while defaulting to a common proxy for external domains.
524 If this variable is set, `git fetch` and `git push` will
525 use the specified command instead of `ssh` when they need to
526 connect to a remote system. The command is in the same form as
527 the `GIT_SSH_COMMAND` environment variable and is overridden
528 when the environment variable is set.
531 If true, Git will avoid using lstat() calls to detect if files have
532 changed by setting the "assume-unchanged" bit for those tracked files
533 which it has updated identically in both the index and working tree.
535 When files are modified outside of Git, the user will need to stage
536 the modified files explicitly (e.g. see 'Examples' section in
537 linkgit:git-update-index[1]).
538 Git will not normally detect changes to those files.
540 This is useful on systems where lstat() calls are very slow, such as
541 CIFS/Microsoft Windows.
545 core.preferSymlinkRefs::
546 Instead of the default "symref" format for HEAD
547 and other symbolic reference files, use symbolic links.
548 This is sometimes needed to work with old scripts that
549 expect HEAD to be a symbolic link.
552 If true this repository is assumed to be 'bare' and has no
553 working directory associated with it. If this is the case a
554 number of commands that require a working directory will be
555 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
557 This setting is automatically guessed by linkgit:git-clone[1] or
558 linkgit:git-init[1] when the repository was created. By default a
559 repository that ends in "/.git" is assumed to be not bare (bare =
560 false), while all other repositories are assumed to be bare (bare
564 Set the path to the root of the working tree.
565 If `GIT_COMMON_DIR` environment variable is set, core.worktree
566 is ignored and not used for determining the root of working tree.
567 This can be overridden by the `GIT_WORK_TREE` environment
568 variable and the `--work-tree` command-line option.
569 The value can be an absolute path or relative to the path to
570 the .git directory, which is either specified by --git-dir
571 or GIT_DIR, or automatically discovered.
572 If --git-dir or GIT_DIR is specified but none of
573 --work-tree, GIT_WORK_TREE and core.worktree is specified,
574 the current working directory is regarded as the top level
575 of your working tree.
577 Note that this variable is honored even when set in a configuration
578 file in a ".git" subdirectory of a directory and its value differs
579 from the latter directory (e.g. "/path/to/.git/config" has
580 core.worktree set to "/different/path"), which is most likely a
581 misconfiguration. Running Git commands in the "/path/to" directory will
582 still use "/different/path" as the root of the work tree and can cause
583 confusion unless you know what you are doing (e.g. you are creating a
584 read-only snapshot of the same index to a location different from the
585 repository's usual working tree).
587 core.logAllRefUpdates::
588 Enable the reflog. Updates to a ref <ref> is logged to the file
589 "`$GIT_DIR/logs/<ref>`", by appending the new and old
590 SHA-1, the date/time and the reason of the update, but
591 only when the file exists. If this configuration
592 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
593 file is automatically created for branch heads (i.e. under
594 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
595 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
596 If it is set to `always`, then a missing reflog is automatically
597 created for any ref under `refs/`.
599 This information can be used to determine what commit
600 was the tip of a branch "2 days ago".
602 This value is true by default in a repository that has
603 a working directory associated with it, and false by
604 default in a bare repository.
606 core.repositoryFormatVersion::
607 Internal variable identifying the repository format and layout
610 core.sharedRepository::
611 When 'group' (or 'true'), the repository is made shareable between
612 several users in a group (making sure all the files and objects are
613 group-writable). When 'all' (or 'world' or 'everybody'), the
614 repository will be readable by all users, additionally to being
615 group-shareable. When 'umask' (or 'false'), Git will use permissions
616 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
617 files in the repository will have this mode value. '0xxx' will override
618 user's umask value (whereas the other options will only override
619 requested parts of the user's umask value). Examples: '0660' will make
620 the repo read/write-able for the owner and group, but inaccessible to
621 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
622 repository that is group-readable but not group-writable.
623 See linkgit:git-init[1]. False by default.
625 core.warnAmbiguousRefs::
626 If true, Git will warn you if the ref name you passed it is ambiguous
627 and might match multiple refs in the repository. True by default.
630 An integer -1..9, indicating a default compression level.
631 -1 is the zlib default. 0 means no compression,
632 and 1..9 are various speed/size tradeoffs, 9 being slowest.
633 If set, this provides a default to other compression variables,
634 such as `core.looseCompression` and `pack.compression`.
636 core.looseCompression::
637 An integer -1..9, indicating the compression level for objects that
638 are not in a pack file. -1 is the zlib default. 0 means no
639 compression, and 1..9 are various speed/size tradeoffs, 9 being
640 slowest. If not set, defaults to core.compression. If that is
641 not set, defaults to 1 (best speed).
643 core.packedGitWindowSize::
644 Number of bytes of a pack file to map into memory in a
645 single mapping operation. Larger window sizes may allow
646 your system to process a smaller number of large pack files
647 more quickly. Smaller window sizes will negatively affect
648 performance due to increased calls to the operating system's
649 memory manager, but may improve performance when accessing
650 a large number of large pack files.
652 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
653 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
654 be reasonable for all users/operating systems. You probably do
655 not need to adjust this value.
657 Common unit suffixes of 'k', 'm', or 'g' are supported.
659 core.packedGitLimit::
660 Maximum number of bytes to map simultaneously into memory
661 from pack files. If Git needs to access more than this many
662 bytes at once to complete an operation it will unmap existing
663 regions to reclaim virtual address space within the process.
665 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
666 This should be reasonable for all users/operating systems, except on
667 the largest projects. You probably do not need to adjust this value.
669 Common unit suffixes of 'k', 'm', or 'g' are supported.
671 core.deltaBaseCacheLimit::
672 Maximum number of bytes to reserve for caching base objects
673 that may be referenced by multiple deltified objects. By storing the
674 entire decompressed base objects in a cache Git is able
675 to avoid unpacking and decompressing frequently used base
676 objects multiple times.
678 Default is 96 MiB on all platforms. This should be reasonable
679 for all users/operating systems, except on the largest projects.
680 You probably do not need to adjust this value.
682 Common unit suffixes of 'k', 'm', or 'g' are supported.
684 core.bigFileThreshold::
685 Files larger than this size are stored deflated, without
686 attempting delta compression. Storing large files without
687 delta compression avoids excessive memory usage, at the
688 slight expense of increased disk usage. Additionally files
689 larger than this size are always treated as binary.
691 Default is 512 MiB on all platforms. This should be reasonable
692 for most projects as source code and other text files can still
693 be delta compressed, but larger binary media files won't be.
695 Common unit suffixes of 'k', 'm', or 'g' are supported.
698 Specifies the pathname to the file that contains patterns to
699 describe paths that are not meant to be tracked, in addition
700 to '.gitignore' (per-directory) and '.git/info/exclude'.
701 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
702 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
703 is used instead. See linkgit:gitignore[5].
706 Some commands (e.g. svn and http interfaces) that interactively
707 ask for a password can be told to use an external program given
708 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
709 environment variable. If not set, fall back to the value of the
710 `SSH_ASKPASS` environment variable or, failing that, a simple password
711 prompt. The external program shall be given a suitable prompt as
712 command-line argument and write the password on its STDOUT.
714 core.attributesFile::
715 In addition to '.gitattributes' (per-directory) and
716 '.git/info/attributes', Git looks into this file for attributes
717 (see linkgit:gitattributes[5]). Path expansions are made the same
718 way as for `core.excludesFile`. Its default value is
719 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
720 set or empty, `$HOME/.config/git/attributes` is used instead.
723 By default Git will look for your hooks in the
724 '$GIT_DIR/hooks' directory. Set this to different path,
725 e.g. '/etc/git/hooks', and Git will try to find your hooks in
726 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
727 in '$GIT_DIR/hooks/pre-receive'.
729 The path can be either absolute or relative. A relative path is
730 taken as relative to the directory where the hooks are run (see
731 the "DESCRIPTION" section of linkgit:githooks[5]).
733 This configuration variable is useful in cases where you'd like to
734 centrally configure your Git hooks instead of configuring them on a
735 per-repository basis, or as a more flexible and centralized
736 alternative to having an `init.templateDir` where you've changed
740 Commands such as `commit` and `tag` that let you edit
741 messages by launching an editor use the value of this
742 variable when it is set, and the environment variable
743 `GIT_EDITOR` is not set. See linkgit:git-var[1].
746 Commands such as `commit` and `tag` that let you edit
747 messages consider a line that begins with this character
748 commented, and removes them after the editor returns
751 If set to "auto", `git-commit` would select a character that is not
752 the beginning character of any line in existing commit messages.
754 core.packedRefsTimeout::
755 The length of time, in milliseconds, to retry when trying to
756 lock the `packed-refs` file. Value 0 means not to retry at
757 all; -1 means to try indefinitely. Default is 1000 (i.e.,
761 Text editor used by `git rebase -i` for editing the rebase instruction file.
762 The value is meant to be interpreted by the shell when it is used.
763 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
764 When not configured the default commit message editor is used instead.
767 Text viewer for use by Git commands (e.g., 'less'). The value
768 is meant to be interpreted by the shell. The order of preference
769 is the `$GIT_PAGER` environment variable, then `core.pager`
770 configuration, then `$PAGER`, and then the default chosen at
771 compile time (usually 'less').
773 When the `LESS` environment variable is unset, Git sets it to `FRX`
774 (if `LESS` environment variable is set, Git does not change it at
775 all). If you want to selectively override Git's default setting
776 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
777 be passed to the shell by Git, which will translate the final
778 command to `LESS=FRX less -S`. The environment does not set the
779 `S` option but the command line does, instructing less to truncate
780 long lines. Similarly, setting `core.pager` to `less -+F` will
781 deactivate the `F` option specified by the environment from the
782 command-line, deactivating the "quit if one screen" behavior of
783 `less`. One can specifically activate some flags for particular
784 commands: for example, setting `pager.blame` to `less -S` enables
785 line truncation only for `git blame`.
787 Likewise, when the `LV` environment variable is unset, Git sets it
788 to `-c`. You can override this setting by exporting `LV` with
789 another value or setting `core.pager` to `lv +c`.
792 A comma separated list of common whitespace problems to
793 notice. 'git diff' will use `color.diff.whitespace` to
794 highlight them, and 'git apply --whitespace=error' will
795 consider them as errors. You can prefix `-` to disable
796 any of them (e.g. `-trailing-space`):
798 * `blank-at-eol` treats trailing whitespaces at the end of the line
799 as an error (enabled by default).
800 * `space-before-tab` treats a space character that appears immediately
801 before a tab character in the initial indent part of the line as an
802 error (enabled by default).
803 * `indent-with-non-tab` treats a line that is indented with space
804 characters instead of the equivalent tabs as an error (not enabled by
806 * `tab-in-indent` treats a tab character in the initial indent part of
807 the line as an error (not enabled by default).
808 * `blank-at-eof` treats blank lines added at the end of file as an error
809 (enabled by default).
810 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
812 * `cr-at-eol` treats a carriage-return at the end of line as
813 part of the line terminator, i.e. with it, `trailing-space`
814 does not trigger if the character before such a carriage-return
815 is not a whitespace (not enabled by default).
816 * `tabwidth=<n>` tells how many character positions a tab occupies; this
817 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
818 errors. The default tab width is 8. Allowed values are 1 to 63.
820 core.fsyncObjectFiles::
821 This boolean will enable 'fsync()' when writing object files.
823 This is a total waste of time and effort on a filesystem that orders
824 data writes properly, but can be useful for filesystems that do not use
825 journalling (traditional UNIX filesystems) or that only journal metadata
826 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
829 Enable parallel index preload for operations like 'git diff'
831 This can speed up operations like 'git diff' and 'git status' especially
832 on filesystems like NFS that have weak caching semantics and thus
833 relatively high IO latencies. When enabled, Git will do the
834 index comparison to the filesystem data in parallel, allowing
835 overlapping IO's. Defaults to true.
838 You can set this to 'link', in which case a hardlink followed by
839 a delete of the source are used to make sure that object creation
840 will not overwrite existing objects.
842 On some file system/operating system combinations, this is unreliable.
843 Set this config setting to 'rename' there; However, This will remove the
844 check that makes sure that existing object files will not get overwritten.
847 When showing commit messages, also show notes which are stored in
848 the given ref. The ref must be fully qualified. If the given
849 ref does not exist, it is not an error but means that no
850 notes should be printed.
852 This setting defaults to "refs/notes/commits", and it can be overridden by
853 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
855 core.sparseCheckout::
856 Enable "sparse checkout" feature. See section "Sparse checkout" in
857 linkgit:git-read-tree[1] for more information.
860 Set the length object names are abbreviated to. If
861 unspecified or set to "auto", an appropriate value is
862 computed based on the approximate number of packed objects
863 in your repository, which hopefully is enough for
864 abbreviated object names to stay unique for some time.
865 The minimum length is 4.
868 add.ignore-errors (deprecated)::
869 Tells 'git add' to continue adding files when some files cannot be
870 added due to indexing errors. Equivalent to the `--ignore-errors`
871 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
872 as it does not follow the usual naming convention for configuration
876 Command aliases for the linkgit:git[1] command wrapper - e.g.
877 after defining "alias.last = cat-file commit HEAD", the invocation
878 "git last" is equivalent to "git cat-file commit HEAD". To avoid
879 confusion and troubles with script usage, aliases that
880 hide existing Git commands are ignored. Arguments are split by
881 spaces, the usual shell quoting and escaping is supported.
882 A quote pair or a backslash can be used to quote them.
884 If the alias expansion is prefixed with an exclamation point,
885 it will be treated as a shell command. For example, defining
886 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
887 "git new" is equivalent to running the shell command
888 "gitk --all --not ORIG_HEAD". Note that shell commands will be
889 executed from the top-level directory of a repository, which may
890 not necessarily be the current directory.
891 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
892 from the original current directory. See linkgit:git-rev-parse[1].
895 If true, git-am will call git-mailsplit for patches in mbox format
896 with parameter `--keep-cr`. In this case git-mailsplit will
897 not remove `\r` from lines ending with `\r\n`. Can be overridden
898 by giving `--no-keep-cr` from the command line.
899 See linkgit:git-am[1], linkgit:git-mailsplit[1].
902 By default, `git am` will fail if the patch does not apply cleanly. When
903 set to true, this setting tells `git am` to fall back on 3-way merge if
904 the patch records the identity of blobs it is supposed to apply to and
905 we have those blobs available locally (equivalent to giving the `--3way`
906 option from the command line). Defaults to `false`.
907 See linkgit:git-am[1].
909 apply.ignoreWhitespace::
910 When set to 'change', tells 'git apply' to ignore changes in
911 whitespace, in the same way as the `--ignore-space-change`
913 When set to one of: no, none, never, false tells 'git apply' to
914 respect all whitespace differences.
915 See linkgit:git-apply[1].
918 Tells 'git apply' how to handle whitespaces, in the same way
919 as the `--whitespace` option. See linkgit:git-apply[1].
921 branch.autoSetupMerge::
922 Tells 'git branch' and 'git checkout' to set up new branches
923 so that linkgit:git-pull[1] will appropriately merge from the
924 starting point branch. Note that even if this option is not set,
925 this behavior can be chosen per-branch using the `--track`
926 and `--no-track` options. The valid settings are: `false` -- no
927 automatic setup is done; `true` -- automatic setup is done when the
928 starting point is a remote-tracking branch; `always` --
929 automatic setup is done when the starting point is either a
930 local branch or remote-tracking
931 branch. This option defaults to true.
933 branch.autoSetupRebase::
934 When a new branch is created with 'git branch' or 'git checkout'
935 that tracks another branch, this variable tells Git to set
936 up pull to rebase instead of merge (see "branch.<name>.rebase").
937 When `never`, rebase is never automatically set to true.
938 When `local`, rebase is set to true for tracked branches of
939 other local branches.
940 When `remote`, rebase is set to true for tracked branches of
941 remote-tracking branches.
942 When `always`, rebase will be set to true for all tracking
944 See "branch.autoSetupMerge" for details on how to set up a
945 branch to track another branch.
946 This option defaults to never.
948 branch.<name>.remote::
949 When on branch <name>, it tells 'git fetch' and 'git push'
950 which remote to fetch from/push to. The remote to push to
951 may be overridden with `remote.pushDefault` (for all branches).
952 The remote to push to, for the current branch, may be further
953 overridden by `branch.<name>.pushRemote`. If no remote is
954 configured, or if you are not on any branch, it defaults to
955 `origin` for fetching and `remote.pushDefault` for pushing.
956 Additionally, `.` (a period) is the current local repository
957 (a dot-repository), see `branch.<name>.merge`'s final note below.
959 branch.<name>.pushRemote::
960 When on branch <name>, it overrides `branch.<name>.remote` for
961 pushing. It also overrides `remote.pushDefault` for pushing
962 from branch <name>. When you pull from one place (e.g. your
963 upstream) and push to another place (e.g. your own publishing
964 repository), you would want to set `remote.pushDefault` to
965 specify the remote to push to for all branches, and use this
966 option to override it for a specific branch.
968 branch.<name>.merge::
969 Defines, together with branch.<name>.remote, the upstream branch
970 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
971 branch to merge and can also affect 'git push' (see push.default).
972 When in branch <name>, it tells 'git fetch' the default
973 refspec to be marked for merging in FETCH_HEAD. The value is
974 handled like the remote part of a refspec, and must match a
975 ref which is fetched from the remote given by
976 "branch.<name>.remote".
977 The merge information is used by 'git pull' (which at first calls
978 'git fetch') to lookup the default branch for merging. Without
979 this option, 'git pull' defaults to merge the first refspec fetched.
980 Specify multiple values to get an octopus merge.
981 If you wish to setup 'git pull' so that it merges into <name> from
982 another branch in the local repository, you can point
983 branch.<name>.merge to the desired branch, and use the relative path
984 setting `.` (a period) for branch.<name>.remote.
986 branch.<name>.mergeOptions::
987 Sets default options for merging into branch <name>. The syntax and
988 supported options are the same as those of linkgit:git-merge[1], but
989 option values containing whitespace characters are currently not
992 branch.<name>.rebase::
993 When true, rebase the branch <name> on top of the fetched branch,
994 instead of merging the default branch from the default remote when
995 "git pull" is run. See "pull.rebase" for doing this in a non
996 branch-specific manner.
998 When preserve, also pass `--preserve-merges` along to 'git rebase'
999 so that locally committed merge commits will not be flattened
1000 by running 'git pull'.
1002 When the value is `interactive`, the rebase is run in interactive mode.
1004 *NOTE*: this is a possibly dangerous operation; do *not* use
1005 it unless you understand the implications (see linkgit:git-rebase[1]
1008 branch.<name>.description::
1009 Branch description, can be edited with
1010 `git branch --edit-description`. Branch description is
1011 automatically added in the format-patch cover letter or
1012 request-pull summary.
1014 browser.<tool>.cmd::
1015 Specify the command to invoke the specified browser. The
1016 specified command is evaluated in shell with the URLs passed
1017 as arguments. (See linkgit:git-web{litdd}browse[1].)
1019 browser.<tool>.path::
1020 Override the path for the given tool that may be used to
1021 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1022 working repository in gitweb (see linkgit:git-instaweb[1]).
1024 clean.requireForce::
1025 A boolean to make git-clean do nothing unless given -f,
1026 -i or -n. Defaults to true.
1029 A boolean to enable/disable color in the output of
1030 linkgit:git-branch[1]. May be set to `always`,
1031 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1032 only when the output is to a terminal. If unset, then the
1033 value of `color.ui` is used (`auto` by default).
1035 color.branch.<slot>::
1036 Use customized color for branch coloration. `<slot>` is one of
1037 `current` (the current branch), `local` (a local branch),
1038 `remote` (a remote-tracking branch in refs/remotes/),
1039 `upstream` (upstream tracking branch), `plain` (other
1043 Whether to use ANSI escape sequences to add color to patches.
1044 If this is set to `always`, linkgit:git-diff[1],
1045 linkgit:git-log[1], and linkgit:git-show[1] will use color
1046 for all patches. If it is set to `true` or `auto`, those
1047 commands will only use color when output is to the terminal.
1048 If unset, then the value of `color.ui` is used (`auto` by
1051 This does not affect linkgit:git-format-patch[1] or the
1052 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1053 command line with the `--color[=<when>]` option.
1056 Use customized color for diff colorization. `<slot>` specifies
1057 which part of the patch to use the specified color, and is one
1058 of `context` (context text - `plain` is a historical synonym),
1059 `meta` (metainformation), `frag`
1060 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1061 `new` (added lines), `commit` (commit headers), or `whitespace`
1062 (highlighting whitespace errors).
1064 color.decorate.<slot>::
1065 Use customized color for 'git log --decorate' output. `<slot>` is one
1066 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1067 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1070 When set to `always`, always highlight matches. When `false` (or
1071 `never`), never. When set to `true` or `auto`, use color only
1072 when the output is written to the terminal. If unset, then the
1073 value of `color.ui` is used (`auto` by default).
1076 Use customized color for grep colorization. `<slot>` specifies which
1077 part of the line to use the specified color, and is one of
1081 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1083 filename prefix (when not using `-h`)
1085 function name lines (when using `-p`)
1087 line number prefix (when using `-n`)
1089 matching text (same as setting `matchContext` and `matchSelected`)
1091 matching text in context lines
1093 matching text in selected lines
1095 non-matching text in selected lines
1097 separators between fields on a line (`:`, `-`, and `=`)
1098 and between hunks (`--`)
1102 When set to `always`, always use colors for interactive prompts
1103 and displays (such as those used by "git-add --interactive" and
1104 "git-clean --interactive"). When false (or `never`), never.
1105 When set to `true` or `auto`, use colors only when the output is
1106 to the terminal. If unset, then the value of `color.ui` is
1107 used (`auto` by default).
1109 color.interactive.<slot>::
1110 Use customized color for 'git add --interactive' and 'git clean
1111 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1112 or `error`, for four distinct types of normal output from
1113 interactive commands.
1116 A boolean to enable/disable colored output when the pager is in
1117 use (default is true).
1120 A boolean to enable/disable color in the output of
1121 linkgit:git-show-branch[1]. May be set to `always`,
1122 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1123 only when the output is to a terminal. If unset, then the
1124 value of `color.ui` is used (`auto` by default).
1127 A boolean to enable/disable color in the output of
1128 linkgit:git-status[1]. May be set to `always`,
1129 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1130 only when the output is to a terminal. If unset, then the
1131 value of `color.ui` is used (`auto` by default).
1133 color.status.<slot>::
1134 Use customized color for status colorization. `<slot>` is
1135 one of `header` (the header text of the status message),
1136 `added` or `updated` (files which are added but not committed),
1137 `changed` (files which are changed but not added in the index),
1138 `untracked` (files which are not tracked by Git),
1139 `branch` (the current branch),
1140 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1142 `unmerged` (files which have unmerged changes).
1145 This variable determines the default value for variables such
1146 as `color.diff` and `color.grep` that control the use of color
1147 per command family. Its scope will expand as more commands learn
1148 configuration to set a default for the `--color` option. Set it
1149 to `false` or `never` if you prefer Git commands not to use
1150 color unless enabled explicitly with some other configuration
1151 or the `--color` option. Set it to `always` if you want all
1152 output not intended for machine consumption to use color, to
1153 `true` or `auto` (this is the default since Git 1.8.4) if you
1154 want such output to use color when written to the terminal.
1157 Specify whether supported commands should output in columns.
1158 This variable consists of a list of tokens separated by spaces
1161 These options control when the feature should be enabled
1162 (defaults to 'never'):
1166 always show in columns
1168 never show in columns
1170 show in columns if the output is to the terminal
1173 These options control layout (defaults to 'column'). Setting any
1174 of these implies 'always' if none of 'always', 'never', or 'auto' are
1179 fill columns before rows
1181 fill rows before columns
1186 Finally, these options can be combined with a layout option (defaults
1191 make unequal size columns to utilize more space
1193 make equal size columns
1197 Specify whether to output branch listing in `git branch` in columns.
1198 See `column.ui` for details.
1201 Specify the layout when list items in `git clean -i`, which always
1202 shows files and directories in columns. See `column.ui` for details.
1205 Specify whether to output untracked files in `git status` in columns.
1206 See `column.ui` for details.
1209 Specify whether to output tag listing in `git tag` in columns.
1210 See `column.ui` for details.
1213 This setting overrides the default of the `--cleanup` option in
1214 `git commit`. See linkgit:git-commit[1] for details. Changing the
1215 default can be useful when you always want to keep lines that begin
1216 with comment character `#` in your log message, in which case you
1217 would do `git config commit.cleanup whitespace` (note that you will
1218 have to remove the help lines that begin with `#` in the commit log
1219 template yourself, if you do this).
1223 A boolean to specify whether all commits should be GPG signed.
1224 Use of this option when doing operations such as rebase can
1225 result in a large number of commits being signed. It may be
1226 convenient to use an agent to avoid typing your GPG passphrase
1230 A boolean to enable/disable inclusion of status information in the
1231 commit message template when using an editor to prepare the commit
1232 message. Defaults to true.
1235 Specify the pathname of a file to use as the template for
1236 new commit messages.
1239 A boolean or int to specify the level of verbose with `git commit`.
1240 See linkgit:git-commit[1].
1243 Specify an external helper to be called when a username or
1244 password credential is needed; the helper may consult external
1245 storage to avoid prompting the user for the credentials. Note
1246 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1249 credential.useHttpPath::
1250 When acquiring credentials, consider the "path" component of an http
1251 or https URL to be important. Defaults to false. See
1252 linkgit:gitcredentials[7] for more information.
1254 credential.username::
1255 If no username is set for a network authentication, use this username
1256 by default. See credential.<context>.* below, and
1257 linkgit:gitcredentials[7].
1259 credential.<url>.*::
1260 Any of the credential.* options above can be applied selectively to
1261 some credentials. For example "credential.https://example.com.username"
1262 would set the default username only for https connections to
1263 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1266 credentialCache.ignoreSIGHUP::
1267 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1269 include::diff-config.txt[]
1271 difftool.<tool>.path::
1272 Override the path for the given tool. This is useful in case
1273 your tool is not in the PATH.
1275 difftool.<tool>.cmd::
1276 Specify the command to invoke the specified diff tool.
1277 The specified command is evaluated in shell with the following
1278 variables available: 'LOCAL' is set to the name of the temporary
1279 file containing the contents of the diff pre-image and 'REMOTE'
1280 is set to the name of the temporary file containing the contents
1281 of the diff post-image.
1284 Prompt before each invocation of the diff tool.
1286 fastimport.unpackLimit::
1287 If the number of objects imported by linkgit:git-fast-import[1]
1288 is below this limit, then the objects will be unpacked into
1289 loose object files. However if the number of imported objects
1290 equals or exceeds this limit then the pack will be stored as a
1291 pack. Storing the pack from a fast-import can make the import
1292 operation complete faster, especially on slow filesystems. If
1293 not set, the value of `transfer.unpackLimit` is used instead.
1295 fetch.recurseSubmodules::
1296 This option can be either set to a boolean value or to 'on-demand'.
1297 Setting it to a boolean changes the behavior of fetch and pull to
1298 unconditionally recurse into submodules when set to true or to not
1299 recurse at all when set to false. When set to 'on-demand' (the default
1300 value), fetch and pull will only recurse into a populated submodule
1301 when its superproject retrieves a commit that updates the submodule's
1305 If it is set to true, git-fetch-pack will check all fetched
1306 objects. It will abort in the case of a malformed object or a
1307 broken link. The result of an abort are only dangling objects.
1308 Defaults to false. If not set, the value of `transfer.fsckObjects`
1312 If the number of objects fetched over the Git native
1313 transfer is below this
1314 limit, then the objects will be unpacked into loose object
1315 files. However if the number of received objects equals or
1316 exceeds this limit then the received pack will be stored as
1317 a pack, after adding any missing delta bases. Storing the
1318 pack from a push can make the push operation complete faster,
1319 especially on slow filesystems. If not set, the value of
1320 `transfer.unpackLimit` is used instead.
1323 If true, fetch will automatically behave as if the `--prune`
1324 option was given on the command line. See also `remote.<name>.prune`.
1327 Control how ref update status is printed. Valid values are
1328 `full` and `compact`. Default value is `full`. See section
1329 OUTPUT in linkgit:git-fetch[1] for detail.
1332 Enable multipart/mixed attachments as the default for
1333 'format-patch'. The value can also be a double quoted string
1334 which will enable attachments as the default and set the
1335 value as the boundary. See the --attach option in
1336 linkgit:git-format-patch[1].
1339 Provides the default value for the `--from` option to format-patch.
1340 Accepts a boolean value, or a name and email address. If false,
1341 format-patch defaults to `--no-from`, using commit authors directly in
1342 the "From:" field of patch mails. If true, format-patch defaults to
1343 `--from`, using your committer identity in the "From:" field of patch
1344 mails and including a "From:" field in the body of the patch mail if
1345 different. If set to a non-boolean value, format-patch uses that
1346 value instead of your committer identity. Defaults to false.
1349 A boolean which can enable or disable sequence numbers in patch
1350 subjects. It defaults to "auto" which enables it only if there
1351 is more than one patch. It can be enabled or disabled for all
1352 messages by setting it to "true" or "false". See --numbered
1353 option in linkgit:git-format-patch[1].
1356 Additional email headers to include in a patch to be submitted
1357 by mail. See linkgit:git-format-patch[1].
1361 Additional recipients to include in a patch to be submitted
1362 by mail. See the --to and --cc options in
1363 linkgit:git-format-patch[1].
1365 format.subjectPrefix::
1366 The default for format-patch is to output files with the '[PATCH]'
1367 subject prefix. Use this variable to change that prefix.
1370 The default for format-patch is to output a signature containing
1371 the Git version number. Use this variable to change that default.
1372 Set this variable to the empty string ("") to suppress
1373 signature generation.
1375 format.signatureFile::
1376 Works just like format.signature except the contents of the
1377 file specified by this variable will be used as the signature.
1380 The default for format-patch is to output files with the suffix
1381 `.patch`. Use this variable to change that suffix (make sure to
1382 include the dot if you want it).
1385 The default pretty format for log/show/whatchanged command,
1386 See linkgit:git-log[1], linkgit:git-show[1],
1387 linkgit:git-whatchanged[1].
1390 The default threading style for 'git format-patch'. Can be
1391 a boolean value, or `shallow` or `deep`. `shallow` threading
1392 makes every mail a reply to the head of the series,
1393 where the head is chosen from the cover letter, the
1394 `--in-reply-to`, and the first patch mail, in this order.
1395 `deep` threading makes every mail a reply to the previous one.
1396 A true boolean value is the same as `shallow`, and a false
1397 value disables threading.
1400 A boolean value which lets you enable the `-s/--signoff` option of
1401 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1402 patch should be a conscious act and means that you certify you have
1403 the rights to submit this work under the same open source license.
1404 Please see the 'SubmittingPatches' document for further discussion.
1406 format.coverLetter::
1407 A boolean that controls whether to generate a cover-letter when
1408 format-patch is invoked, but in addition can be set to "auto", to
1409 generate a cover-letter only when there's more than one patch.
1411 format.outputDirectory::
1412 Set a custom directory to store the resulting files instead of the
1413 current working directory.
1415 format.useAutoBase::
1416 A boolean value which lets you enable the `--base=auto` option of
1417 format-patch by default.
1419 filter.<driver>.clean::
1420 The command which is used to convert the content of a worktree
1421 file to a blob upon checkin. See linkgit:gitattributes[5] for
1424 filter.<driver>.smudge::
1425 The command which is used to convert the content of a blob
1426 object to a worktree file upon checkout. See
1427 linkgit:gitattributes[5] for details.
1430 Allows overriding the message type (error, warn or ignore) of a
1431 specific message ID such as `missingEmail`.
1433 For convenience, fsck prefixes the error/warning with the message ID,
1434 e.g. "missingEmail: invalid author/committer line - missing email" means
1435 that setting `fsck.missingEmail = ignore` will hide that issue.
1437 This feature is intended to support working with legacy repositories
1438 which cannot be repaired without disruptive changes.
1441 The path to a sorted list of object names (i.e. one SHA-1 per
1442 line) that are known to be broken in a non-fatal way and should
1443 be ignored. This feature is useful when an established project
1444 should be accepted despite early commits containing errors that
1445 can be safely ignored such as invalid committer email addresses.
1446 Note: corrupt objects cannot be skipped with this setting.
1448 gc.aggressiveDepth::
1449 The depth parameter used in the delta compression
1450 algorithm used by 'git gc --aggressive'. This defaults
1453 gc.aggressiveWindow::
1454 The window size parameter used in the delta compression
1455 algorithm used by 'git gc --aggressive'. This defaults
1459 When there are approximately more than this many loose
1460 objects in the repository, `git gc --auto` will pack them.
1461 Some Porcelain commands use this command to perform a
1462 light-weight garbage collection from time to time. The
1463 default value is 6700. Setting this to 0 disables it.
1466 When there are more than this many packs that are not
1467 marked with `*.keep` file in the repository, `git gc
1468 --auto` consolidates them into one larger pack. The
1469 default value is 50. Setting this to 0 disables it.
1472 Make `git gc --auto` return immediately and run in background
1473 if the system supports it. Default is true.
1476 If the file gc.log exists, then `git gc --auto` won't run
1477 unless that file is more than 'gc.logExpiry' old. Default is
1478 "1.day". See `gc.pruneExpire` for more ways to specify its
1482 Running `git pack-refs` in a repository renders it
1483 unclonable by Git versions prior to 1.5.1.2 over dumb
1484 transports such as HTTP. This variable determines whether
1485 'git gc' runs `git pack-refs`. This can be set to `notbare`
1486 to enable it within all non-bare repos or it can be set to a
1487 boolean value. The default is `true`.
1490 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1491 Override the grace period with this config variable. The value
1492 "now" may be used to disable this grace period and always prune
1493 unreachable objects immediately, or "never" may be used to
1494 suppress pruning. This feature helps prevent corruption when
1495 'git gc' runs concurrently with another process writing to the
1496 repository; see the "NOTES" section of linkgit:git-gc[1].
1498 gc.worktreePruneExpire::
1499 When 'git gc' is run, it calls
1500 'git worktree prune --expire 3.months.ago'.
1501 This config variable can be used to set a different grace
1502 period. The value "now" may be used to disable the grace
1503 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1504 may be used to suppress pruning.
1507 gc.<pattern>.reflogExpire::
1508 'git reflog expire' removes reflog entries older than
1509 this time; defaults to 90 days. The value "now" expires all
1510 entries immediately, and "never" suppresses expiration
1511 altogether. With "<pattern>" (e.g.
1512 "refs/stash") in the middle the setting applies only to
1513 the refs that match the <pattern>.
1515 gc.reflogExpireUnreachable::
1516 gc.<pattern>.reflogExpireUnreachable::
1517 'git reflog expire' removes reflog entries older than
1518 this time and are not reachable from the current tip;
1519 defaults to 30 days. The value "now" expires all entries
1520 immediately, and "never" suppresses expiration altogether.
1521 With "<pattern>" (e.g. "refs/stash")
1522 in the middle, the setting applies only to the refs that
1523 match the <pattern>.
1526 Records of conflicted merge you resolved earlier are
1527 kept for this many days when 'git rerere gc' is run.
1528 The default is 60 days. See linkgit:git-rerere[1].
1530 gc.rerereUnresolved::
1531 Records of conflicted merge you have not resolved are
1532 kept for this many days when 'git rerere gc' is run.
1533 The default is 15 days. See linkgit:git-rerere[1].
1535 gitcvs.commitMsgAnnotation::
1536 Append this string to each commit message. Set to empty string
1537 to disable this feature. Defaults to "via git-CVS emulator".
1540 Whether the CVS server interface is enabled for this repository.
1541 See linkgit:git-cvsserver[1].
1544 Path to a log file where the CVS server interface well... logs
1545 various stuff. See linkgit:git-cvsserver[1].
1547 gitcvs.usecrlfattr::
1548 If true, the server will look up the end-of-line conversion
1549 attributes for files to determine the `-k` modes to use. If
1550 the attributes force Git to treat a file as text,
1551 the `-k` mode will be left blank so CVS clients will
1552 treat it as text. If they suppress text conversion, the file
1553 will be set with '-kb' mode, which suppresses any newline munging
1554 the client might otherwise do. If the attributes do not allow
1555 the file type to be determined, then `gitcvs.allBinary` is
1556 used. See linkgit:gitattributes[5].
1559 This is used if `gitcvs.usecrlfattr` does not resolve
1560 the correct '-kb' mode to use. If true, all
1561 unresolved files are sent to the client in
1562 mode '-kb'. This causes the client to treat them
1563 as binary files, which suppresses any newline munging it
1564 otherwise might do. Alternatively, if it is set to "guess",
1565 then the contents of the file are examined to decide if
1566 it is binary, similar to `core.autocrlf`.
1569 Database used by git-cvsserver to cache revision information
1570 derived from the Git repository. The exact meaning depends on the
1571 used database driver, for SQLite (which is the default driver) this
1572 is a filename. Supports variable substitution (see
1573 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1574 Default: '%Ggitcvs.%m.sqlite'
1577 Used Perl DBI driver. You can specify any available driver
1578 for this here, but it might not work. git-cvsserver is tested
1579 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1580 reported *not* to work with 'DBD::mysql'. Experimental feature.
1581 May not contain double colons (`:`). Default: 'SQLite'.
1582 See linkgit:git-cvsserver[1].
1584 gitcvs.dbUser, gitcvs.dbPass::
1585 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1586 since SQLite has no concept of database users and/or passwords.
1587 'gitcvs.dbUser' supports variable substitution (see
1588 linkgit:git-cvsserver[1] for details).
1590 gitcvs.dbTableNamePrefix::
1591 Database table name prefix. Prepended to the names of any
1592 database tables used, allowing a single database to be used
1593 for several repositories. Supports variable substitution (see
1594 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1595 characters will be replaced with underscores.
1597 All gitcvs variables except for `gitcvs.usecrlfattr` and
1598 `gitcvs.allBinary` can also be specified as
1599 'gitcvs.<access_method>.<varname>' (where 'access_method'
1600 is one of "ext" and "pserver") to make them apply only for the given
1604 gitweb.description::
1607 See linkgit:gitweb[1] for description.
1615 gitweb.remote_heads::
1618 See linkgit:gitweb.conf[5] for description.
1621 If set to true, enable `-n` option by default.
1624 Set the default matching behavior. Using a value of 'basic', 'extended',
1625 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1626 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1627 value 'default' will return to the default matching behavior.
1629 grep.extendedRegexp::
1630 If set to true, enable `--extended-regexp` option by default. This
1631 option is ignored when the `grep.patternType` option is set to a value
1632 other than 'default'.
1635 Number of grep worker threads to use.
1636 See `grep.threads` in linkgit:git-grep[1] for more information.
1638 grep.fallbackToNoIndex::
1639 If set to true, fall back to git grep --no-index if git grep
1640 is executed outside of a git repository. Defaults to false.
1643 Use this custom program instead of "`gpg`" found on `$PATH` when
1644 making or verifying a PGP signature. The program must support the
1645 same command-line interface as GPG, namely, to verify a detached
1646 signature, "`gpg --verify $file - <$signature`" is run, and the
1647 program is expected to signal a good signature by exiting with
1648 code 0, and to generate an ASCII-armored detached signature, the
1649 standard input of "`gpg -bsau $key`" is fed with the contents to be
1650 signed, and the program is expected to send the result to its
1653 gui.commitMsgWidth::
1654 Defines how wide the commit message window is in the
1655 linkgit:git-gui[1]. "75" is the default.
1658 Specifies how many context lines should be used in calls to diff
1659 made by the linkgit:git-gui[1]. The default is "5".
1661 gui.displayUntracked::
1662 Determines if linkgit:git-gui[1] shows untracked files
1663 in the file list. The default is "true".
1666 Specifies the default encoding to use for displaying of
1667 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1668 It can be overridden by setting the 'encoding' attribute
1669 for relevant files (see linkgit:gitattributes[5]).
1670 If this option is not set, the tools default to the
1673 gui.matchTrackingBranch::
1674 Determines if new branches created with linkgit:git-gui[1] should
1675 default to tracking remote branches with matching names or
1676 not. Default: "false".
1678 gui.newBranchTemplate::
1679 Is used as suggested name when creating new branches using the
1682 gui.pruneDuringFetch::
1683 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1684 performing a fetch. The default value is "false".
1687 Determines if linkgit:git-gui[1] should trust the file modification
1688 timestamp or not. By default the timestamps are not trusted.
1690 gui.spellingDictionary::
1691 Specifies the dictionary used for spell checking commit messages in
1692 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1696 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1697 location detection. It makes blame significantly faster on huge
1698 repositories at the expense of less thorough copy detection.
1700 gui.copyBlameThreshold::
1701 Specifies the threshold to use in 'git gui blame' original location
1702 detection, measured in alphanumeric characters. See the
1703 linkgit:git-blame[1] manual for more information on copy detection.
1705 gui.blamehistoryctx::
1706 Specifies the radius of history context in days to show in
1707 linkgit:gitk[1] for the selected commit, when the `Show History
1708 Context` menu item is invoked from 'git gui blame'. If this
1709 variable is set to zero, the whole history is shown.
1711 guitool.<name>.cmd::
1712 Specifies the shell command line to execute when the corresponding item
1713 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1714 mandatory for every tool. The command is executed from the root of
1715 the working directory, and in the environment it receives the name of
1716 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1717 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1718 the head is detached, 'CUR_BRANCH' is empty).
1720 guitool.<name>.needsFile::
1721 Run the tool only if a diff is selected in the GUI. It guarantees
1722 that 'FILENAME' is not empty.
1724 guitool.<name>.noConsole::
1725 Run the command silently, without creating a window to display its
1728 guitool.<name>.noRescan::
1729 Don't rescan the working directory for changes after the tool
1732 guitool.<name>.confirm::
1733 Show a confirmation dialog before actually running the tool.
1735 guitool.<name>.argPrompt::
1736 Request a string argument from the user, and pass it to the tool
1737 through the `ARGS` environment variable. Since requesting an
1738 argument implies confirmation, the 'confirm' option has no effect
1739 if this is enabled. If the option is set to 'true', 'yes', or '1',
1740 the dialog uses a built-in generic prompt; otherwise the exact
1741 value of the variable is used.
1743 guitool.<name>.revPrompt::
1744 Request a single valid revision from the user, and set the
1745 `REVISION` environment variable. In other aspects this option
1746 is similar to 'argPrompt', and can be used together with it.
1748 guitool.<name>.revUnmerged::
1749 Show only unmerged branches in the 'revPrompt' subdialog.
1750 This is useful for tools similar to merge or rebase, but not
1751 for things like checkout or reset.
1753 guitool.<name>.title::
1754 Specifies the title to use for the prompt dialog. The default
1757 guitool.<name>.prompt::
1758 Specifies the general prompt string to display at the top of
1759 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1760 The default value includes the actual command.
1763 Specify the browser that will be used to display help in the
1764 'web' format. See linkgit:git-help[1].
1767 Override the default help format used by linkgit:git-help[1].
1768 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1769 the default. 'web' and 'html' are the same.
1772 Automatically correct and execute mistyped commands after
1773 waiting for the given number of deciseconds (0.1 sec). If more
1774 than one command can be deduced from the entered text, nothing
1775 will be executed. If the value of this option is negative,
1776 the corrected command will be executed immediately. If the
1777 value is 0 - the command will be just shown but not executed.
1778 This is the default.
1781 Specify the path where the HTML documentation resides. File system paths
1782 and URLs are supported. HTML pages will be prefixed with this path when
1783 help is displayed in the 'web' format. This defaults to the documentation
1784 path of your Git installation.
1787 Override the HTTP proxy, normally configured using the 'http_proxy',
1788 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1789 addition to the syntax understood by curl, it is possible to specify a
1790 proxy string with a user name but no password, in which case git will
1791 attempt to acquire one in the same way it does for other credentials. See
1792 linkgit:gitcredentials[7] for more information. The syntax thus is
1793 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1794 on a per-remote basis; see remote.<name>.proxy
1796 http.proxyAuthMethod::
1797 Set the method with which to authenticate against the HTTP proxy. This
1798 only takes effect if the configured proxy string contains a user name part
1799 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1800 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1801 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1802 variable. Possible values are:
1805 * `anyauth` - Automatically pick a suitable authentication method. It is
1806 assumed that the proxy answers an unauthenticated request with a 407
1807 status code and one or more Proxy-authenticate headers with supported
1808 authentication methods. This is the default.
1809 * `basic` - HTTP Basic authentication
1810 * `digest` - HTTP Digest authentication; this prevents the password from being
1811 transmitted to the proxy in clear text
1812 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1814 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1818 Attempt authentication without seeking a username or password. This
1819 can be used to attempt GSS-Negotiate authentication without specifying
1820 a username in the URL, as libcurl normally requires a username for
1824 Control GSSAPI credential delegation. The delegation is disabled
1825 by default in libcurl since version 7.21.7. Set parameter to tell
1826 the server what it is allowed to delegate when it comes to user
1827 credentials. Used with GSS/kerberos. Possible values are:
1830 * `none` - Don't allow any delegation.
1831 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1832 Kerberos service ticket, which is a matter of realm policy.
1833 * `always` - Unconditionally allow the server to delegate.
1838 Pass an additional HTTP header when communicating with a server. If
1839 more than one such entry exists, all of them are added as extra
1840 headers. To allow overriding the settings inherited from the system
1841 config, an empty value will reset the extra headers to the empty list.
1844 The pathname of a file containing previously stored cookie lines,
1845 which should be used
1846 in the Git http session, if they match the server. The file format
1847 of the file to read cookies from should be plain HTTP headers or
1848 the Netscape/Mozilla cookie file format (see `curl(1)`).
1849 NOTE that the file specified with http.cookieFile is used only as
1850 input unless http.saveCookies is set.
1853 If set, store cookies received during requests to the file specified by
1854 http.cookieFile. Has no effect if http.cookieFile is unset.
1857 The SSL version to use when negotiating an SSL connection, if you
1858 want to force the default. The available and default version
1859 depend on whether libcurl was built against NSS or OpenSSL and the
1860 particular configuration of the crypto library in use. Internally
1861 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1862 documentation for more details on the format of this option and
1863 for the ssl version supported. Actually the possible values of
1874 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1875 To force git to use libcurl's default ssl version and ignore any
1876 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1879 http.sslCipherList::
1880 A list of SSL ciphers to use when negotiating an SSL connection.
1881 The available ciphers depend on whether libcurl was built against
1882 NSS or OpenSSL and the particular configuration of the crypto
1883 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1884 option; see the libcurl documentation for more details on the format
1887 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1888 To force git to use libcurl's default cipher list and ignore any
1889 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1893 Whether to verify the SSL certificate when fetching or pushing
1894 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1898 File containing the SSL certificate when fetching or pushing
1899 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1903 File containing the SSL private key when fetching or pushing
1904 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1907 http.sslCertPasswordProtected::
1908 Enable Git's password prompt for the SSL certificate. Otherwise
1909 OpenSSL will prompt the user, possibly many times, if the
1910 certificate or private key is encrypted. Can be overridden by the
1911 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1914 File containing the certificates to verify the peer with when
1915 fetching or pushing over HTTPS. Can be overridden by the
1916 `GIT_SSL_CAINFO` environment variable.
1919 Path containing files with the CA certificates to verify the peer
1920 with when fetching or pushing over HTTPS. Can be overridden
1921 by the `GIT_SSL_CAPATH` environment variable.
1924 Public key of the https service. It may either be the filename of
1925 a PEM or DER encoded public key file or a string starting with
1926 'sha256//' followed by the base64 encoded sha256 hash of the
1927 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1928 exit with an error if this option is set but not supported by
1932 Attempt to use AUTH SSL/TLS and encrypted data transfers
1933 when connecting via regular FTP protocol. This might be needed
1934 if the FTP server requires it for security reasons or you wish
1935 to connect securely whenever remote FTP server supports it.
1936 Default is false since it might trigger certificate verification
1937 errors on misconfigured servers.
1940 How many HTTP requests to launch in parallel. Can be overridden
1941 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1944 The number of curl sessions (counted across slots) to be kept across
1945 requests. They will not be ended with curl_easy_cleanup() until
1946 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1947 value will be capped at 1. Defaults to 1.
1950 Maximum size in bytes of the buffer used by smart HTTP
1951 transports when POSTing data to the remote system.
1952 For requests larger than this buffer size, HTTP/1.1 and
1953 Transfer-Encoding: chunked is used to avoid creating a
1954 massive pack file locally. Default is 1 MiB, which is
1955 sufficient for most requests.
1957 http.lowSpeedLimit, http.lowSpeedTime::
1958 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1959 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1960 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1961 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1964 A boolean which disables using of EPSV ftp command by curl.
1965 This can helpful with some "poor" ftp servers which don't
1966 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1967 environment variable. Default is false (curl will use EPSV).
1970 The HTTP USER_AGENT string presented to an HTTP server. The default
1971 value represents the version of the client Git such as git/1.7.1.
1972 This option allows you to override this value to a more common value
1973 such as Mozilla/4.0. This may be necessary, for instance, if
1974 connecting through a firewall that restricts HTTP connections to a set
1975 of common USER_AGENT strings (but not including those like git/1.7.1).
1976 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
1978 http.followRedirects::
1979 Whether git should follow HTTP redirects. If set to `true`, git
1980 will transparently follow any redirect issued by a server it
1981 encounters. If set to `false`, git will treat all redirects as
1982 errors. If set to `initial`, git will follow redirects only for
1983 the initial request to a remote, but not for subsequent
1984 follow-up HTTP requests. Since git uses the redirected URL as
1985 the base for the follow-up requests, this is generally
1986 sufficient. The default is `initial`.
1989 Any of the http.* options above can be applied selectively to some URLs.
1990 For a config key to match a URL, each element of the config key is
1991 compared to that of the URL, in the following order:
1994 . Scheme (e.g., `https` in `https://example.com/`). This field
1995 must match exactly between the config key and the URL.
1997 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1998 This field must match between the config key and the URL. It is
1999 possible to specify a `*` as part of the host name to match all subdomains
2000 at this level. `https://*.example.com/` for example would match
2001 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2003 . Port number (e.g., `8080` in `http://example.com:8080/`).
2004 This field must match exactly between the config key and the URL.
2005 Omitted port numbers are automatically converted to the correct
2006 default for the scheme before matching.
2008 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2009 path field of the config key must match the path field of the URL
2010 either exactly or as a prefix of slash-delimited path elements. This means
2011 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2012 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2013 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2014 key with just path `foo/`).
2016 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2017 the config key has a user name it must match the user name in the
2018 URL exactly. If the config key does not have a user name, that
2019 config key will match a URL with any user name (including none),
2020 but at a lower precedence than a config key with a user name.
2023 The list above is ordered by decreasing precedence; a URL that matches
2024 a config key's path is preferred to one that matches its user name. For example,
2025 if the URL is `https://user@example.com/foo/bar` a config key match of
2026 `https://example.com/foo` will be preferred over a config key match of
2027 `https://user@example.com`.
2029 All URLs are normalized before attempting any matching (the password part,
2030 if embedded in the URL, is always ignored for matching purposes) so that
2031 equivalent URLs that are simply spelled differently will match properly.
2032 Environment variable settings always override any matches. The URLs that are
2033 matched against are those given directly to Git commands. This means any URLs
2034 visited as a result of a redirection do not participate in matching.
2037 Depending on the value of the environment variables `GIT_SSH` or
2038 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2039 auto-detects whether to adjust its command-line parameters for use
2040 with plink or tortoiseplink, as opposed to the default (OpenSSH).
2042 The config variable `ssh.variant` can be set to override this auto-detection;
2043 valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2044 will be treated as normal ssh. This setting can be overridden via the
2045 environment variable `GIT_SSH_VARIANT`.
2047 i18n.commitEncoding::
2048 Character encoding the commit messages are stored in; Git itself
2049 does not care per se, but this information is necessary e.g. when
2050 importing commits from emails or in the gitk graphical history
2051 browser (and possibly at other places in the future or in other
2052 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2054 i18n.logOutputEncoding::
2055 Character encoding the commit messages are converted to when
2056 running 'git log' and friends.
2059 The configuration variables in the 'imap' section are described
2060 in linkgit:git-imap-send[1].
2063 Specify the version with which new index files should be
2064 initialized. This does not affect existing repositories.
2067 Specify the directory from which templates will be copied.
2068 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2071 Specify the program that will be used to browse your working
2072 repository in gitweb. See linkgit:git-instaweb[1].
2075 The HTTP daemon command-line to start gitweb on your working
2076 repository. See linkgit:git-instaweb[1].
2079 If true the web server started by linkgit:git-instaweb[1] will
2080 be bound to the local IP (127.0.0.1).
2082 instaweb.modulePath::
2083 The default module path for linkgit:git-instaweb[1] to use
2084 instead of /usr/lib/apache2/modules. Only used if httpd
2088 The port number to bind the gitweb httpd to. See
2089 linkgit:git-instaweb[1].
2091 interactive.singleKey::
2092 In interactive commands, allow the user to provide one-letter
2093 input with a single key (i.e., without hitting enter).
2094 Currently this is used by the `--patch` mode of
2095 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2096 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2097 setting is silently ignored if portable keystroke input
2098 is not available; requires the Perl module Term::ReadKey.
2100 interactive.diffFilter::
2101 When an interactive command (such as `git add --patch`) shows
2102 a colorized diff, git will pipe the diff through the shell
2103 command defined by this configuration variable. The command may
2104 mark up the diff further for human consumption, provided that it
2105 retains a one-to-one correspondence with the lines in the
2106 original diff. Defaults to disabled (no filtering).
2109 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2110 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2111 override this option with `--no-abbrev-commit`.
2114 Set the default date-time mode for the 'log' command.
2115 Setting a value for log.date is similar to using 'git log''s
2116 `--date` option. See linkgit:git-log[1] for details.
2119 Print out the ref names of any commits that are shown by the log
2120 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2121 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2122 specified, the full ref name (including prefix) will be printed.
2123 If 'auto' is specified, then if the output is going to a terminal,
2124 the ref names are shown as if 'short' were given, otherwise no ref
2125 names are shown. This is the same as the `--decorate` option
2129 If `true`, `git log` will act as if the `--follow` option was used when
2130 a single <path> is given. This has the same limitations as `--follow`,
2131 i.e. it cannot be used to follow multiple files and does not work well
2132 on non-linear history.
2135 A list of colors, separated by commas, that can be used to draw
2136 history lines in `git log --graph`.
2139 If true, the initial commit will be shown as a big creation event.
2140 This is equivalent to a diff against an empty tree.
2141 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2142 normally hide the root commit will now show it. True by default.
2145 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2146 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2149 If true, makes linkgit:git-mailinfo[1] (and therefore
2150 linkgit:git-am[1]) act by default as if the --scissors option
2151 was provided on the command-line. When active, this features
2152 removes everything from the message body before a scissors
2153 line (i.e. consisting mainly of ">8", "8<" and "-").
2156 The location of an augmenting mailmap file. The default
2157 mailmap, located in the root of the repository, is loaded
2158 first, then the mailmap file pointed to by this variable.
2159 The location of the mailmap file may be in a repository
2160 subdirectory, or somewhere outside of the repository itself.
2161 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2164 Like `mailmap.file`, but consider the value as a reference to a
2165 blob in the repository. If both `mailmap.file` and
2166 `mailmap.blob` are given, both are parsed, with entries from
2167 `mailmap.file` taking precedence. In a bare repository, this
2168 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2172 Specify the programs that may be used to display help in the
2173 'man' format. See linkgit:git-help[1].
2176 Specify the command to invoke the specified man viewer. The
2177 specified command is evaluated in shell with the man page
2178 passed as argument. (See linkgit:git-help[1].)
2181 Override the path for the given tool that may be used to
2182 display help in the 'man' format. See linkgit:git-help[1].
2184 include::merge-config.txt[]
2186 mergetool.<tool>.path::
2187 Override the path for the given tool. This is useful in case
2188 your tool is not in the PATH.
2190 mergetool.<tool>.cmd::
2191 Specify the command to invoke the specified merge tool. The
2192 specified command is evaluated in shell with the following
2193 variables available: 'BASE' is the name of a temporary file
2194 containing the common base of the files to be merged, if available;
2195 'LOCAL' is the name of a temporary file containing the contents of
2196 the file on the current branch; 'REMOTE' is the name of a temporary
2197 file containing the contents of the file from the branch being
2198 merged; 'MERGED' contains the name of the file to which the merge
2199 tool should write the results of a successful merge.
2201 mergetool.<tool>.trustExitCode::
2202 For a custom merge command, specify whether the exit code of
2203 the merge command can be used to determine whether the merge was
2204 successful. If this is not set to true then the merge target file
2205 timestamp is checked and the merge assumed to have been successful
2206 if the file has been updated, otherwise the user is prompted to
2207 indicate the success of the merge.
2209 mergetool.meld.hasOutput::
2210 Older versions of `meld` do not support the `--output` option.
2211 Git will attempt to detect whether `meld` supports `--output`
2212 by inspecting the output of `meld --help`. Configuring
2213 `mergetool.meld.hasOutput` will make Git skip these checks and
2214 use the configured value instead. Setting `mergetool.meld.hasOutput`
2215 to `true` tells Git to unconditionally use the `--output` option,
2216 and `false` avoids using `--output`.
2218 mergetool.keepBackup::
2219 After performing a merge, the original file with conflict markers
2220 can be saved as a file with a `.orig` extension. If this variable
2221 is set to `false` then this file is not preserved. Defaults to
2222 `true` (i.e. keep the backup files).
2224 mergetool.keepTemporaries::
2225 When invoking a custom merge tool, Git uses a set of temporary
2226 files to pass to the tool. If the tool returns an error and this
2227 variable is set to `true`, then these temporary files will be
2228 preserved, otherwise they will be removed after the tool has
2229 exited. Defaults to `false`.
2231 mergetool.writeToTemp::
2232 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2233 conflicting files in the worktree by default. Git will attempt
2234 to use a temporary directory for these files when set `true`.
2235 Defaults to `false`.
2238 Prompt before each invocation of the merge resolution program.
2240 notes.mergeStrategy::
2241 Which merge strategy to choose by default when resolving notes
2242 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2243 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2244 section of linkgit:git-notes[1] for more information on each strategy.
2246 notes.<name>.mergeStrategy::
2247 Which merge strategy to choose when doing a notes merge into
2248 refs/notes/<name>. This overrides the more general
2249 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2250 linkgit:git-notes[1] for more information on the available strategies.
2253 The (fully qualified) refname from which to show notes when
2254 showing commit messages. The value of this variable can be set
2255 to a glob, in which case notes from all matching refs will be
2256 shown. You may also specify this configuration variable
2257 several times. A warning will be issued for refs that do not
2258 exist, but a glob that does not match any refs is silently
2261 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2262 environment variable, which must be a colon separated list of refs or
2265 The effective value of "core.notesRef" (possibly overridden by
2266 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2269 notes.rewrite.<command>::
2270 When rewriting commits with <command> (currently `amend` or
2271 `rebase`) and this variable is set to `true`, Git
2272 automatically copies your notes from the original to the
2273 rewritten commit. Defaults to `true`, but see
2274 "notes.rewriteRef" below.
2277 When copying notes during a rewrite (see the
2278 "notes.rewrite.<command>" option), determines what to do if
2279 the target commit already has a note. Must be one of
2280 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2281 Defaults to `concatenate`.
2283 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2284 environment variable.
2287 When copying notes during a rewrite, specifies the (fully
2288 qualified) ref whose notes should be copied. The ref may be a
2289 glob, in which case notes in all matching refs will be copied.
2290 You may also specify this configuration several times.
2292 Does not have a default value; you must configure this variable to
2293 enable note rewriting. Set it to `refs/notes/commits` to enable
2294 rewriting for the default commit notes.
2296 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2297 environment variable, which must be a colon separated list of refs or
2301 The size of the window used by linkgit:git-pack-objects[1] when no
2302 window size is given on the command line. Defaults to 10.
2305 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2306 maximum depth is given on the command line. Defaults to 50.
2309 The maximum size of memory that is consumed by each thread
2310 in linkgit:git-pack-objects[1] for pack window memory when
2311 no limit is given on the command line. The value can be
2312 suffixed with "k", "m", or "g". When left unconfigured (or
2313 set explicitly to 0), there will be no limit.
2316 An integer -1..9, indicating the compression level for objects
2317 in a pack file. -1 is the zlib default. 0 means no
2318 compression, and 1..9 are various speed/size tradeoffs, 9 being
2319 slowest. If not set, defaults to core.compression. If that is
2320 not set, defaults to -1, the zlib default, which is "a default
2321 compromise between speed and compression (currently equivalent
2324 Note that changing the compression level will not automatically recompress
2325 all existing objects. You can force recompression by passing the -F option
2326 to linkgit:git-repack[1].
2328 pack.deltaCacheSize::
2329 The maximum memory in bytes used for caching deltas in
2330 linkgit:git-pack-objects[1] before writing them out to a pack.
2331 This cache is used to speed up the writing object phase by not
2332 having to recompute the final delta result once the best match
2333 for all objects is found. Repacking large repositories on machines
2334 which are tight with memory might be badly impacted by this though,
2335 especially if this cache pushes the system into swapping.
2336 A value of 0 means no limit. The smallest size of 1 byte may be
2337 used to virtually disable this cache. Defaults to 256 MiB.
2339 pack.deltaCacheLimit::
2340 The maximum size of a delta, that is cached in
2341 linkgit:git-pack-objects[1]. This cache is used to speed up the
2342 writing object phase by not having to recompute the final delta
2343 result once the best match for all objects is found. Defaults to 1000.
2346 Specifies the number of threads to spawn when searching for best
2347 delta matches. This requires that linkgit:git-pack-objects[1]
2348 be compiled with pthreads otherwise this option is ignored with a
2349 warning. This is meant to reduce packing time on multiprocessor
2350 machines. The required amount of memory for the delta search window
2351 is however multiplied by the number of threads.
2352 Specifying 0 will cause Git to auto-detect the number of CPU's
2353 and set the number of threads accordingly.
2356 Specify the default pack index version. Valid values are 1 for
2357 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2358 the new pack index with capabilities for packs larger than 4 GB
2359 as well as proper protection against the repacking of corrupted
2360 packs. Version 2 is the default. Note that version 2 is enforced
2361 and this config option ignored whenever the corresponding pack is
2364 If you have an old Git that does not understand the version 2 `*.idx` file,
2365 cloning or fetching over a non native protocol (e.g. "http")
2366 that will copy both `*.pack` file and corresponding `*.idx` file from the
2367 other side may give you a repository that cannot be accessed with your
2368 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2369 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2372 pack.packSizeLimit::
2373 The maximum size of a pack. This setting only affects
2374 packing to a file when repacking, i.e. the git:// protocol
2375 is unaffected. It can be overridden by the `--max-pack-size`
2376 option of linkgit:git-repack[1]. Reaching this limit results
2377 in the creation of multiple packfiles; which in turn prevents
2378 bitmaps from being created.
2379 The minimum size allowed is limited to 1 MiB.
2380 The default is unlimited.
2381 Common unit suffixes of 'k', 'm', or 'g' are
2385 When true, git will use pack bitmaps (if available) when packing
2386 to stdout (e.g., during the server side of a fetch). Defaults to
2387 true. You should not generally need to turn this off unless
2388 you are debugging pack bitmaps.
2390 pack.writeBitmaps (deprecated)::
2391 This is a deprecated synonym for `repack.writeBitmaps`.
2393 pack.writeBitmapHashCache::
2394 When true, git will include a "hash cache" section in the bitmap
2395 index (if one is written). This cache can be used to feed git's
2396 delta heuristics, potentially leading to better deltas between
2397 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2398 between an older, bitmapped pack and objects that have been
2399 pushed since the last gc). The downside is that it consumes 4
2400 bytes per object of disk space, and that JGit's bitmap
2401 implementation does not understand it, causing it to complain if
2402 Git and JGit are used on the same repository. Defaults to false.
2405 If the value is boolean, turns on or off pagination of the
2406 output of a particular Git subcommand when writing to a tty.
2407 Otherwise, turns on pagination for the subcommand using the
2408 pager specified by the value of `pager.<cmd>`. If `--paginate`
2409 or `--no-pager` is specified on the command line, it takes
2410 precedence over this option. To disable pagination for all
2411 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2414 Alias for a --pretty= format string, as specified in
2415 linkgit:git-log[1]. Any aliases defined here can be used just
2416 as the built-in pretty formats could. For example,
2417 running `git config pretty.changelog "format:* %H %s"`
2418 would cause the invocation `git log --pretty=changelog`
2419 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2420 Note that an alias with the same name as a built-in format
2421 will be silently ignored.
2424 If set, provide a user defined default policy for all protocols which
2425 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2426 if unset, known-safe protocols (http, https, git, ssh, file) have a
2427 default policy of `always`, known-dangerous protocols (ext) have a
2428 default policy of `never`, and all other protocols have a default
2429 policy of `user`. Supported policies:
2433 * `always` - protocol is always able to be used.
2435 * `never` - protocol is never able to be used.
2437 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2438 either unset or has a value of 1. This policy should be used when you want a
2439 protocol to be directly usable by the user but don't want it used by commands which
2440 execute clone/fetch/push commands without user input, e.g. recursive
2441 submodule initialization.
2445 protocol.<name>.allow::
2446 Set a policy to be used by protocol `<name>` with clone/fetch/push
2447 commands. See `protocol.allow` above for the available policies.
2449 The protocol names currently used by git are:
2452 - `file`: any local file-based path (including `file://` URLs,
2455 - `git`: the anonymous git protocol over a direct TCP
2456 connection (or proxy, if configured)
2458 - `ssh`: git over ssh (including `host:path` syntax,
2461 - `http`: git over http, both "smart http" and "dumb http".
2462 Note that this does _not_ include `https`; if you want to configure
2463 both, you must do so individually.
2465 - any external helpers are named by their protocol (e.g., use
2466 `hg` to allow the `git-remote-hg` helper)
2470 By default, Git does not create an extra merge commit when merging
2471 a commit that is a descendant of the current commit. Instead, the
2472 tip of the current branch is fast-forwarded. When set to `false`,
2473 this variable tells Git to create an extra merge commit in such
2474 a case (equivalent to giving the `--no-ff` option from the command
2475 line). When set to `only`, only such fast-forward merges are
2476 allowed (equivalent to giving the `--ff-only` option from the
2477 command line). This setting overrides `merge.ff` when pulling.
2480 When true, rebase branches on top of the fetched branch, instead
2481 of merging the default branch from the default remote when "git
2482 pull" is run. See "branch.<name>.rebase" for setting this on a
2485 When preserve, also pass `--preserve-merges` along to 'git rebase'
2486 so that locally committed merge commits will not be flattened
2487 by running 'git pull'.
2489 When the value is `interactive`, the rebase is run in interactive mode.
2491 *NOTE*: this is a possibly dangerous operation; do *not* use
2492 it unless you understand the implications (see linkgit:git-rebase[1]
2496 The default merge strategy to use when pulling multiple branches
2500 The default merge strategy to use when pulling a single branch.
2503 Defines the action `git push` should take if no refspec is
2504 explicitly given. Different values are well-suited for
2505 specific workflows; for instance, in a purely central workflow
2506 (i.e. the fetch source is equal to the push destination),
2507 `upstream` is probably what you want. Possible values are:
2511 * `nothing` - do not push anything (error out) unless a refspec is
2512 explicitly given. This is primarily meant for people who want to
2513 avoid mistakes by always being explicit.
2515 * `current` - push the current branch to update a branch with the same
2516 name on the receiving end. Works in both central and non-central
2519 * `upstream` - push the current branch back to the branch whose
2520 changes are usually integrated into the current branch (which is
2521 called `@{upstream}`). This mode only makes sense if you are
2522 pushing to the same repository you would normally pull from
2523 (i.e. central workflow).
2525 * `tracking` - This is a deprecated synonym for `upstream`.
2527 * `simple` - in centralized workflow, work like `upstream` with an
2528 added safety to refuse to push if the upstream branch's name is
2529 different from the local one.
2531 When pushing to a remote that is different from the remote you normally
2532 pull from, work as `current`. This is the safest option and is suited
2535 This mode has become the default in Git 2.0.
2537 * `matching` - push all branches having the same name on both ends.
2538 This makes the repository you are pushing to remember the set of
2539 branches that will be pushed out (e.g. if you always push 'maint'
2540 and 'master' there and no other branches, the repository you push
2541 to will have these two branches, and your local 'maint' and
2542 'master' will be pushed there).
2544 To use this mode effectively, you have to make sure _all_ the
2545 branches you would push out are ready to be pushed out before
2546 running 'git push', as the whole point of this mode is to allow you
2547 to push all of the branches in one go. If you usually finish work
2548 on only one branch and push out the result, while other branches are
2549 unfinished, this mode is not for you. Also this mode is not
2550 suitable for pushing into a shared central repository, as other
2551 people may add new branches there, or update the tip of existing
2552 branches outside your control.
2554 This used to be the default, but not since Git 2.0 (`simple` is the
2560 If set to true enable `--follow-tags` option by default. You
2561 may override this configuration at time of push by specifying
2565 May be set to a boolean value, or the string 'if-asked'. A true
2566 value causes all pushes to be GPG signed, as if `--signed` is
2567 passed to linkgit:git-push[1]. The string 'if-asked' causes
2568 pushes to be signed if the server supports it, as if
2569 `--signed=if-asked` is passed to 'git push'. A false value may
2570 override a value from a lower-priority config file. An explicit
2571 command-line flag always overrides this config option.
2573 push.recurseSubmodules::
2574 Make sure all submodule commits used by the revisions to be pushed
2575 are available on a remote-tracking branch. If the value is 'check'
2576 then Git will verify that all submodule commits that changed in the
2577 revisions to be pushed are available on at least one remote of the
2578 submodule. If any commits are missing, the push will be aborted and
2579 exit with non-zero status. If the value is 'on-demand' then all
2580 submodules that changed in the revisions to be pushed will be
2581 pushed. If on-demand was not able to push all necessary revisions
2582 it will also be aborted and exit with non-zero status. If the value
2583 is 'no' then default behavior of ignoring submodules when pushing
2584 is retained. You may override this configuration at time of push by
2585 specifying '--recurse-submodules=check|on-demand|no'.
2588 Whether to show a diffstat of what changed upstream since the last
2589 rebase. False by default.
2592 If set to true enable `--autosquash` option by default.
2595 When set to true, automatically create a temporary stash
2596 before the operation begins, and apply it after the operation
2597 ends. This means that you can run rebase on a dirty worktree.
2598 However, use with care: the final stash application after a
2599 successful rebase might result in non-trivial conflicts.
2602 rebase.missingCommitsCheck::
2603 If set to "warn", git rebase -i will print a warning if some
2604 commits are removed (e.g. a line was deleted), however the
2605 rebase will still proceed. If set to "error", it will print
2606 the previous warning and stop the rebase, 'git rebase
2607 --edit-todo' can then be used to correct the error. If set to
2608 "ignore", no checking is done.
2609 To drop a commit without warning or error, use the `drop`
2610 command in the todo-list.
2611 Defaults to "ignore".
2613 rebase.instructionFormat::
2614 A format string, as specified in linkgit:git-log[1], to be used for
2615 the instruction list during an interactive rebase. The format will automatically
2616 have the long commit hash prepended to the format.
2618 receive.advertiseAtomic::
2619 By default, git-receive-pack will advertise the atomic push
2620 capability to its clients. If you don't want to advertise this
2621 capability, set this variable to false.
2623 receive.advertisePushOptions::
2624 By default, git-receive-pack will advertise the push options
2625 capability to its clients. If you don't want to advertise this
2626 capability, set this variable to false.
2629 By default, git-receive-pack will run "git-gc --auto" after
2630 receiving data from git-push and updating refs. You can stop
2631 it by setting this variable to false.
2633 receive.certNonceSeed::
2634 By setting this variable to a string, `git receive-pack`
2635 will accept a `git push --signed` and verifies it by using
2636 a "nonce" protected by HMAC using this string as a secret
2639 receive.certNonceSlop::
2640 When a `git push --signed` sent a push certificate with a
2641 "nonce" that was issued by a receive-pack serving the same
2642 repository within this many seconds, export the "nonce"
2643 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2644 hooks (instead of what the receive-pack asked the sending
2645 side to include). This may allow writing checks in
2646 `pre-receive` and `post-receive` a bit easier. Instead of
2647 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2648 that records by how many seconds the nonce is stale to
2649 decide if they want to accept the certificate, they only
2650 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2652 receive.fsckObjects::
2653 If it is set to true, git-receive-pack will check all received
2654 objects. It will abort in the case of a malformed object or a
2655 broken link. The result of an abort are only dangling objects.
2656 Defaults to false. If not set, the value of `transfer.fsckObjects`
2659 receive.fsck.<msg-id>::
2660 When `receive.fsckObjects` is set to true, errors can be switched
2661 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2662 setting where the `<msg-id>` is the fsck message ID and the value
2663 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2664 the error/warning with the message ID, e.g. "missingEmail: invalid
2665 author/committer line - missing email" means that setting
2666 `receive.fsck.missingEmail = ignore` will hide that issue.
2668 This feature is intended to support working with legacy repositories
2669 which would not pass pushing when `receive.fsckObjects = true`, allowing
2670 the host to accept repositories with certain known issues but still catch
2673 receive.fsck.skipList::
2674 The path to a sorted list of object names (i.e. one SHA-1 per
2675 line) that are known to be broken in a non-fatal way and should
2676 be ignored. This feature is useful when an established project
2677 should be accepted despite early commits containing errors that
2678 can be safely ignored such as invalid committer email addresses.
2679 Note: corrupt objects cannot be skipped with this setting.
2682 After receiving the pack from the client, `receive-pack` may
2683 produce no output (if `--quiet` was specified) while processing
2684 the pack, causing some networks to drop the TCP connection.
2685 With this option set, if `receive-pack` does not transmit
2686 any data in this phase for `receive.keepAlive` seconds, it will
2687 send a short keepalive packet. The default is 5 seconds; set
2688 to 0 to disable keepalives entirely.
2690 receive.unpackLimit::
2691 If the number of objects received in a push is below this
2692 limit then the objects will be unpacked into loose object
2693 files. However if the number of received objects equals or
2694 exceeds this limit then the received pack will be stored as
2695 a pack, after adding any missing delta bases. Storing the
2696 pack from a push can make the push operation complete faster,
2697 especially on slow filesystems. If not set, the value of
2698 `transfer.unpackLimit` is used instead.
2700 receive.maxInputSize::
2701 If the size of the incoming pack stream is larger than this
2702 limit, then git-receive-pack will error out, instead of
2703 accepting the pack file. If not set or set to 0, then the size
2706 receive.denyDeletes::
2707 If set to true, git-receive-pack will deny a ref update that deletes
2708 the ref. Use this to prevent such a ref deletion via a push.
2710 receive.denyDeleteCurrent::
2711 If set to true, git-receive-pack will deny a ref update that
2712 deletes the currently checked out branch of a non-bare repository.
2714 receive.denyCurrentBranch::
2715 If set to true or "refuse", git-receive-pack will deny a ref update
2716 to the currently checked out branch of a non-bare repository.
2717 Such a push is potentially dangerous because it brings the HEAD
2718 out of sync with the index and working tree. If set to "warn",
2719 print a warning of such a push to stderr, but allow the push to
2720 proceed. If set to false or "ignore", allow such pushes with no
2721 message. Defaults to "refuse".
2723 Another option is "updateInstead" which will update the working
2724 tree if pushing into the current branch. This option is
2725 intended for synchronizing working directories when one side is not easily
2726 accessible via interactive ssh (e.g. a live web site, hence the requirement
2727 that the working directory be clean). This mode also comes in handy when
2728 developing inside a VM to test and fix code on different Operating Systems.
2730 By default, "updateInstead" will refuse the push if the working tree or
2731 the index have any difference from the HEAD, but the `push-to-checkout`
2732 hook can be used to customize this. See linkgit:githooks[5].
2734 receive.denyNonFastForwards::
2735 If set to true, git-receive-pack will deny a ref update which is
2736 not a fast-forward. Use this to prevent such an update via a push,
2737 even if that push is forced. This configuration variable is
2738 set when initializing a shared repository.
2741 This variable is the same as `transfer.hideRefs`, but applies
2742 only to `receive-pack` (and so affects pushes, but not fetches).
2743 An attempt to update or delete a hidden ref by `git push` is
2746 receive.updateServerInfo::
2747 If set to true, git-receive-pack will run git-update-server-info
2748 after receiving data from git-push and updating refs.
2750 receive.shallowUpdate::
2751 If set to true, .git/shallow can be updated when new refs
2752 require new shallow roots. Otherwise those refs are rejected.
2754 remote.pushDefault::
2755 The remote to push to by default. Overrides
2756 `branch.<name>.remote` for all branches, and is overridden by
2757 `branch.<name>.pushRemote` for specific branches.
2760 The URL of a remote repository. See linkgit:git-fetch[1] or
2761 linkgit:git-push[1].
2763 remote.<name>.pushurl::
2764 The push URL of a remote repository. See linkgit:git-push[1].
2766 remote.<name>.proxy::
2767 For remotes that require curl (http, https and ftp), the URL to
2768 the proxy to use for that remote. Set to the empty string to
2769 disable proxying for that remote.
2771 remote.<name>.proxyAuthMethod::
2772 For remotes that require curl (http, https and ftp), the method to use for
2773 authenticating against the proxy in use (probably set in
2774 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2776 remote.<name>.fetch::
2777 The default set of "refspec" for linkgit:git-fetch[1]. See
2778 linkgit:git-fetch[1].
2780 remote.<name>.push::
2781 The default set of "refspec" for linkgit:git-push[1]. See
2782 linkgit:git-push[1].
2784 remote.<name>.mirror::
2785 If true, pushing to this remote will automatically behave
2786 as if the `--mirror` option was given on the command line.
2788 remote.<name>.skipDefaultUpdate::
2789 If true, this remote will be skipped by default when updating
2790 using linkgit:git-fetch[1] or the `update` subcommand of
2791 linkgit:git-remote[1].
2793 remote.<name>.skipFetchAll::
2794 If true, this remote will be skipped by default when updating
2795 using linkgit:git-fetch[1] or the `update` subcommand of
2796 linkgit:git-remote[1].
2798 remote.<name>.receivepack::
2799 The default program to execute on the remote side when pushing. See
2800 option --receive-pack of linkgit:git-push[1].
2802 remote.<name>.uploadpack::
2803 The default program to execute on the remote side when fetching. See
2804 option --upload-pack of linkgit:git-fetch-pack[1].
2806 remote.<name>.tagOpt::
2807 Setting this value to --no-tags disables automatic tag following when
2808 fetching from remote <name>. Setting it to --tags will fetch every
2809 tag from remote <name>, even if they are not reachable from remote
2810 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2811 override this setting. See options --tags and --no-tags of
2812 linkgit:git-fetch[1].
2815 Setting this to a value <vcs> will cause Git to interact with
2816 the remote with the git-remote-<vcs> helper.
2818 remote.<name>.prune::
2819 When set to true, fetching from this remote by default will also
2820 remove any remote-tracking references that no longer exist on the
2821 remote (as if the `--prune` option was given on the command line).
2822 Overrides `fetch.prune` settings, if any.
2825 The list of remotes which are fetched by "git remote update
2826 <group>". See linkgit:git-remote[1].
2828 repack.useDeltaBaseOffset::
2829 By default, linkgit:git-repack[1] creates packs that use
2830 delta-base offset. If you need to share your repository with
2831 Git older than version 1.4.4, either directly or via a dumb
2832 protocol such as http, then you need to set this option to
2833 "false" and repack. Access from old Git versions over the
2834 native protocol are unaffected by this option.
2836 repack.packKeptObjects::
2837 If set to true, makes `git repack` act as if
2838 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2839 details. Defaults to `false` normally, but `true` if a bitmap
2840 index is being written (either via `--write-bitmap-index` or
2841 `repack.writeBitmaps`).
2843 repack.writeBitmaps::
2844 When true, git will write a bitmap index when packing all
2845 objects to disk (e.g., when `git repack -a` is run). This
2846 index can speed up the "counting objects" phase of subsequent
2847 packs created for clones and fetches, at the cost of some disk
2848 space and extra time spent on the initial repack. This has
2849 no effect if multiple packfiles are created.
2853 When set to true, `git-rerere` updates the index with the
2854 resulting contents after it cleanly resolves conflicts using
2855 previously recorded resolution. Defaults to false.
2858 Activate recording of resolved conflicts, so that identical
2859 conflict hunks can be resolved automatically, should they be
2860 encountered again. By default, linkgit:git-rerere[1] is
2861 enabled if there is an `rr-cache` directory under the
2862 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2865 sendemail.identity::
2866 A configuration identity. When given, causes values in the
2867 'sendemail.<identity>' subsection to take precedence over
2868 values in the 'sendemail' section. The default identity is
2869 the value of `sendemail.identity`.
2871 sendemail.smtpEncryption::
2872 See linkgit:git-send-email[1] for description. Note that this
2873 setting is not subject to the 'identity' mechanism.
2875 sendemail.smtpssl (deprecated)::
2876 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2878 sendemail.smtpsslcertpath::
2879 Path to ca-certificates (either a directory or a single file).
2880 Set it to an empty string to disable certificate verification.
2882 sendemail.<identity>.*::
2883 Identity-specific versions of the 'sendemail.*' parameters
2884 found below, taking precedence over those when the this
2885 identity is selected, through command-line or
2886 `sendemail.identity`.
2888 sendemail.aliasesFile::
2889 sendemail.aliasFileType::
2890 sendemail.annotate::
2894 sendemail.chainReplyTo::
2896 sendemail.envelopeSender::
2898 sendemail.multiEdit::
2899 sendemail.signedoffbycc::
2900 sendemail.smtpPass::
2901 sendemail.suppresscc::
2902 sendemail.suppressFrom::
2904 sendemail.smtpDomain::
2905 sendemail.smtpServer::
2906 sendemail.smtpServerPort::
2907 sendemail.smtpServerOption::
2908 sendemail.smtpUser::
2910 sendemail.transferEncoding::
2911 sendemail.validate::
2913 See linkgit:git-send-email[1] for description.
2915 sendemail.signedoffcc (deprecated)::
2916 Deprecated alias for `sendemail.signedoffbycc`.
2918 showbranch.default::
2919 The default set of branches for linkgit:git-show-branch[1].
2920 See linkgit:git-show-branch[1].
2922 splitIndex.maxPercentChange::
2923 When the split index feature is used, this specifies the
2924 percent of entries the split index can contain compared to the
2925 total number of entries in both the split index and the shared
2926 index before a new shared index is written.
2927 The value should be between 0 and 100. If the value is 0 then
2928 a new shared index is always written, if it is 100 a new
2929 shared index is never written.
2930 By default the value is 20, so a new shared index is written
2931 if the number of entries in the split index would be greater
2932 than 20 percent of the total number of entries.
2933 See linkgit:git-update-index[1].
2935 splitIndex.sharedIndexExpire::
2936 When the split index feature is used, shared index files that
2937 were not modified since the time this variable specifies will
2938 be removed when a new shared index file is created. The value
2939 "now" expires all entries immediately, and "never" suppresses
2940 expiration altogether.
2941 The default value is "2.weeks.ago".
2942 Note that a shared index file is considered modified (for the
2943 purpose of expiration) each time a new split-index file is
2944 either created based on it or read from it.
2945 See linkgit:git-update-index[1].
2947 status.relativePaths::
2948 By default, linkgit:git-status[1] shows paths relative to the
2949 current directory. Setting this variable to `false` shows paths
2950 relative to the repository root (this was the default for Git
2954 Set to true to enable --short by default in linkgit:git-status[1].
2955 The option --no-short takes precedence over this variable.
2958 Set to true to enable --branch by default in linkgit:git-status[1].
2959 The option --no-branch takes precedence over this variable.
2961 status.displayCommentPrefix::
2962 If set to true, linkgit:git-status[1] will insert a comment
2963 prefix before each output line (starting with
2964 `core.commentChar`, i.e. `#` by default). This was the
2965 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2968 status.showUntrackedFiles::
2969 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2970 files which are not currently tracked by Git. Directories which
2971 contain only untracked files, are shown with the directory name
2972 only. Showing untracked files means that Git needs to lstat() all
2973 the files in the whole repository, which might be slow on some
2974 systems. So, this variable controls how the commands displays
2975 the untracked files. Possible values are:
2978 * `no` - Show no untracked files.
2979 * `normal` - Show untracked files and directories.
2980 * `all` - Show also individual files in untracked directories.
2983 If this variable is not specified, it defaults to 'normal'.
2984 This variable can be overridden with the -u|--untracked-files option
2985 of linkgit:git-status[1] and linkgit:git-commit[1].
2987 status.submoduleSummary::
2989 If this is set to a non zero number or true (identical to -1 or an
2990 unlimited number), the submodule summary will be enabled and a
2991 summary of commits for modified submodules will be shown (see
2992 --summary-limit option of linkgit:git-submodule[1]). Please note
2993 that the summary output command will be suppressed for all
2994 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2995 for those submodules where `submodule.<name>.ignore=all`. The only
2996 exception to that rule is that status and commit will show staged
2997 submodule changes. To
2998 also view the summary for ignored submodules you can either use
2999 the --ignore-submodules=dirty command-line option or the 'git
3000 submodule summary' command, which shows a similar output but does
3001 not honor these settings.
3004 If this is set to true, the `git stash show` command without an
3005 option will show the stash in patch form. Defaults to false.
3006 See description of 'show' command in linkgit:git-stash[1].
3009 If this is set to true, the `git stash show` command without an
3010 option will show diffstat of the stash. Defaults to true.
3011 See description of 'show' command in linkgit:git-stash[1].
3013 submodule.<name>.url::
3014 The URL for a submodule. This variable is copied from the .gitmodules
3015 file to the git config via 'git submodule init'. The user can change
3016 the configured URL before obtaining the submodule via 'git submodule
3017 update'. If neither submodule.<name>.active or submodule.active are
3018 set, the presence of this variable is used as a fallback to indicate
3019 whether the submodule is of interest to git commands.
3020 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3022 submodule.<name>.update::
3023 The default update procedure for a submodule. This variable
3024 is populated by `git submodule init` from the
3025 linkgit:gitmodules[5] file. See description of 'update'
3026 command in linkgit:git-submodule[1].
3028 submodule.<name>.branch::
3029 The remote branch name for a submodule, used by `git submodule
3030 update --remote`. Set this option to override the value found in
3031 the `.gitmodules` file. See linkgit:git-submodule[1] and
3032 linkgit:gitmodules[5] for details.
3034 submodule.<name>.fetchRecurseSubmodules::
3035 This option can be used to control recursive fetching of this
3036 submodule. It can be overridden by using the --[no-]recurse-submodules
3037 command-line option to "git fetch" and "git pull".
3038 This setting will override that from in the linkgit:gitmodules[5]
3041 submodule.<name>.ignore::
3042 Defines under what circumstances "git status" and the diff family show
3043 a submodule as modified. When set to "all", it will never be considered
3044 modified (but it will nonetheless show up in the output of status and
3045 commit when it has been staged), "dirty" will ignore all changes
3046 to the submodules work tree and
3047 takes only differences between the HEAD of the submodule and the commit
3048 recorded in the superproject into account. "untracked" will additionally
3049 let submodules with modified tracked files in their work tree show up.
3050 Using "none" (the default when this option is not set) also shows
3051 submodules that have untracked files in their work tree as changed.
3052 This setting overrides any setting made in .gitmodules for this submodule,
3053 both settings can be overridden on the command line by using the
3054 "--ignore-submodules" option. The 'git submodule' commands are not
3055 affected by this setting.
3057 submodule.<name>.active::
3058 Boolean value indicating if the submodule is of interest to git
3059 commands. This config option takes precedence over the
3060 submodule.active config option.
3063 A repeated field which contains a pathspec used to match against a
3064 submodule's path to determine if the submodule is of interest to git
3067 submodule.fetchJobs::
3068 Specifies how many submodules are fetched/cloned at the same time.
3069 A positive integer allows up to that number of submodules fetched
3070 in parallel. A value of 0 will give some reasonable default.
3071 If unset, it defaults to 1.
3073 submodule.alternateLocation::
3074 Specifies how the submodules obtain alternates when submodules are
3075 cloned. Possible values are `no`, `superproject`.
3076 By default `no` is assumed, which doesn't add references. When the
3077 value is set to `superproject` the submodule to be cloned computes
3078 its alternates location relative to the superprojects alternate.
3080 submodule.alternateErrorStrategy::
3081 Specifies how to treat errors with the alternates for a submodule
3082 as computed via `submodule.alternateLocation`. Possible values are
3083 `ignore`, `info`, `die`. Default is `die`.
3085 tag.forceSignAnnotated::
3086 A boolean to specify whether annotated tags created should be GPG signed.
3087 If `--annotate` is specified on the command line, it takes
3088 precedence over this option.
3091 This variable controls the sort ordering of tags when displayed by
3092 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3093 value of this variable will be used as the default.
3096 This variable can be used to restrict the permission bits of
3097 tar archive entries. The default is 0002, which turns off the
3098 world write bit. The special value "user" indicates that the
3099 archiving user's umask will be used instead. See umask(2) and
3100 linkgit:git-archive[1].
3102 transfer.fsckObjects::
3103 When `fetch.fsckObjects` or `receive.fsckObjects` are
3104 not set, the value of this variable is used instead.
3108 String(s) `receive-pack` and `upload-pack` use to decide which
3109 refs to omit from their initial advertisements. Use more than
3110 one definition to specify multiple prefix strings. A ref that is
3111 under the hierarchies listed in the value of this variable is
3112 excluded, and is hidden when responding to `git push` or `git
3113 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3114 program-specific versions of this config.
3116 You may also include a `!` in front of the ref name to negate the entry,
3117 explicitly exposing it, even if an earlier entry marked it as hidden.
3118 If you have multiple hideRefs values, later entries override earlier ones
3119 (and entries in more-specific config files override less-specific ones).
3121 If a namespace is in use, the namespace prefix is stripped from each
3122 reference before it is matched against `transfer.hiderefs` patterns.
3123 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3124 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3125 is omitted from the advertisements but `refs/heads/master` and
3126 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3127 "have" lines. In order to match refs before stripping, add a `^` in front of
3128 the ref name. If you combine `!` and `^`, `!` must be specified first.
3130 Even if you hide refs, a client may still be able to steal the target
3131 objects via the techniques described in the "SECURITY" section of the
3132 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3133 separate repository.
3135 transfer.unpackLimit::
3136 When `fetch.unpackLimit` or `receive.unpackLimit` are
3137 not set, the value of this variable is used instead.
3138 The default value is 100.
3140 uploadarchive.allowUnreachable::
3141 If true, allow clients to use `git archive --remote` to request
3142 any tree, whether reachable from the ref tips or not. See the
3143 discussion in the "SECURITY" section of
3144 linkgit:git-upload-archive[1] for more details. Defaults to
3147 uploadpack.hideRefs::
3148 This variable is the same as `transfer.hideRefs`, but applies
3149 only to `upload-pack` (and so affects only fetches, not pushes).
3150 An attempt to fetch a hidden ref by `git fetch` will fail. See
3151 also `uploadpack.allowTipSHA1InWant`.
3153 uploadpack.allowTipSHA1InWant::
3154 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3155 to accept a fetch request that asks for an object at the tip
3156 of a hidden ref (by default, such a request is rejected).
3157 See also `uploadpack.hideRefs`. Even if this is false, a client
3158 may be able to steal objects via the techniques described in the
3159 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3160 best to keep private data in a separate repository.
3162 uploadpack.allowReachableSHA1InWant::
3163 Allow `upload-pack` to accept a fetch request that asks for an
3164 object that is reachable from any ref tip. However, note that
3165 calculating object reachability is computationally expensive.
3166 Defaults to `false`. Even if this is false, a client may be able
3167 to steal objects via the techniques described in the "SECURITY"
3168 section of the linkgit:gitnamespaces[7] man page; it's best to
3169 keep private data in a separate repository.
3171 uploadpack.allowAnySHA1InWant::
3172 Allow `upload-pack` to accept a fetch request that asks for any
3174 Defaults to `false`.
3176 uploadpack.keepAlive::
3177 When `upload-pack` has started `pack-objects`, there may be a
3178 quiet period while `pack-objects` prepares the pack. Normally
3179 it would output progress information, but if `--quiet` was used
3180 for the fetch, `pack-objects` will output nothing at all until
3181 the pack data begins. Some clients and networks may consider
3182 the server to be hung and give up. Setting this option instructs
3183 `upload-pack` to send an empty keepalive packet every
3184 `uploadpack.keepAlive` seconds. Setting this option to 0
3185 disables keepalive packets entirely. The default is 5 seconds.
3187 uploadpack.packObjectsHook::
3188 If this option is set, when `upload-pack` would run
3189 `git pack-objects` to create a packfile for a client, it will
3190 run this shell command instead. The `pack-objects` command and
3191 arguments it _would_ have run (including the `git pack-objects`
3192 at the beginning) are appended to the shell command. The stdin
3193 and stdout of the hook are treated as if `pack-objects` itself
3194 was run. I.e., `upload-pack` will feed input intended for
3195 `pack-objects` to the hook, and expects a completed packfile on
3198 Note that this configuration variable is ignored if it is seen in the
3199 repository-level config (this is a safety measure against fetching from
3200 untrusted repositories).
3202 url.<base>.insteadOf::
3203 Any URL that starts with this value will be rewritten to
3204 start, instead, with <base>. In cases where some site serves a
3205 large number of repositories, and serves them with multiple
3206 access methods, and some users need to use different access
3207 methods, this feature allows people to specify any of the
3208 equivalent URLs and have Git automatically rewrite the URL to
3209 the best alternative for the particular user, even for a
3210 never-before-seen repository on the site. When more than one
3211 insteadOf strings match a given URL, the longest match is used.
3213 url.<base>.pushInsteadOf::
3214 Any URL that starts with this value will not be pushed to;
3215 instead, it will be rewritten to start with <base>, and the
3216 resulting URL will be pushed to. In cases where some site serves
3217 a large number of repositories, and serves them with multiple
3218 access methods, some of which do not allow push, this feature
3219 allows people to specify a pull-only URL and have Git
3220 automatically use an appropriate URL to push, even for a
3221 never-before-seen repository on the site. When more than one
3222 pushInsteadOf strings match a given URL, the longest match is
3223 used. If a remote has an explicit pushurl, Git will ignore this
3224 setting for that remote.
3227 Your email address to be recorded in any newly created commits.
3228 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3229 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3232 Your full name to be recorded in any newly created commits.
3233 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3234 environment variables. See linkgit:git-commit-tree[1].
3236 user.useConfigOnly::
3237 Instruct Git to avoid trying to guess defaults for `user.email`
3238 and `user.name`, and instead retrieve the values only from the
3239 configuration. For example, if you have multiple email addresses
3240 and would like to use a different one for each repository, then
3241 with this configuration option set to `true` in the global config
3242 along with a name, Git will prompt you to set up an email before
3243 making new commits in a newly cloned repository.
3244 Defaults to `false`.
3247 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3248 key you want it to automatically when creating a signed tag or
3249 commit, you can override the default selection with this variable.
3250 This option is passed unchanged to gpg's --local-user parameter,
3251 so you may specify a key using any method that gpg supports.
3253 versionsort.prereleaseSuffix (deprecated)::
3254 Deprecated alias for `versionsort.suffix`. Ignored if
3255 `versionsort.suffix` is set.
3257 versionsort.suffix::
3258 Even when version sort is used in linkgit:git-tag[1], tagnames
3259 with the same base version but different suffixes are still sorted
3260 lexicographically, resulting e.g. in prerelease tags appearing
3261 after the main release (e.g. "1.0-rc1" after "1.0"). This
3262 variable can be specified to determine the sorting order of tags
3263 with different suffixes.
3265 By specifying a single suffix in this variable, any tagname containing
3266 that suffix will appear before the corresponding main release. E.g. if
3267 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3268 "1.0". If specified multiple times, once per suffix, then the order of
3269 suffixes in the configuration will determine the sorting order of tagnames
3270 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3271 configuration, then all "1.0-preX" tags will be listed before any
3272 "1.0-rcX" tags. The placement of the main release tag relative to tags
3273 with various suffixes can be determined by specifying the empty suffix
3274 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3275 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3276 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3279 If more than one suffixes match the same tagname, then that tagname will
3280 be sorted according to the suffix which starts at the earliest position in
3281 the tagname. If more than one different matching suffixes start at
3282 that earliest position, then that tagname will be sorted according to the
3283 longest of those suffixes.
3284 The sorting order between different suffixes is undefined if they are
3285 in multiple config files.
3288 Specify a web browser that may be used by some commands.
3289 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]