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 The `include` and `includeIf` sections allow you to include config
83 directives from another source. These sections behave identically to
84 each other with the exception that `includeIf` sections may be ignored
85 if their condition does not evaluate to true; see "Conditional includes"
88 You can include a config file from another by setting the special
89 `include.path` (or `includeIf.*.path`) variable to the name of the file
90 to be included. The variable takes a pathname as its value, and is
91 subject to tilde expansion. These variables can be given multiple times.
93 The contents of the included file are inserted immediately, as if they
94 had been found at the location of the include directive. If the value of the
95 variable is a relative path, the path is considered to
96 be relative to the configuration file in which the include directive
97 was found. See below for examples.
102 You can include a config file from another conditionally by setting a
103 `includeIf.<condition>.path` variable to the name of the file to be
106 The condition starts with a keyword followed by a colon and some data
107 whose format and meaning depends on the keyword. Supported keywords
112 The data that follows the keyword `gitdir:` is used as a glob
113 pattern. If the location of the .git directory matches the
114 pattern, the include condition is met.
116 The .git location may be auto-discovered, or come from `$GIT_DIR`
117 environment variable. If the repository is auto discovered via a .git
118 file (e.g. from submodules, or a linked worktree), the .git location
119 would be the final location where the .git directory is, not where the
122 The pattern can contain standard globbing wildcards and two additional
123 ones, `**/` and `/**`, that can match multiple path components. Please
124 refer to linkgit:gitignore[5] for details. For convenience:
126 * If the pattern starts with `~/`, `~` will be substituted with the
127 content of the environment variable `HOME`.
129 * If the pattern starts with `./`, it is replaced with the directory
130 containing the current config file.
132 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
133 will be automatically prepended. For example, the pattern `foo/bar`
134 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
136 * If the pattern ends with `/`, `**` will be automatically added. For
137 example, the pattern `foo/` becomes `foo/**`. In other words, it
138 matches "foo" and everything inside, recursively.
141 This is the same as `gitdir` except that matching is done
142 case-insensitively (e.g. on case-insensitive file sytems)
144 A few more notes on matching via `gitdir` and `gitdir/i`:
146 * Symlinks in `$GIT_DIR` are not resolved before matching.
148 * Both the symlink & realpath versions of paths will be matched
149 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
150 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
153 This was not the case in the initial release of this feature in
154 v2.13.0, which only matched the realpath version. Configuration that
155 wants to be compatible with the initial release of this feature needs
156 to either specify only the realpath version, or both versions.
158 * Note that "../" is not special and will match literally, which is
159 unlikely what you want.
166 ; Don't trust file modes
171 external = /usr/local/bin/diff-wrapper
176 merge = refs/heads/devel
180 gitProxy="ssh" for "kernel.org"
181 gitProxy=default-proxy ; for the rest
184 path = /path/to/foo.inc ; include by absolute path
185 path = foo.inc ; find "foo.inc" relative to the current file
186 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
188 ; include if $GIT_DIR is /path/to/foo/.git
189 [includeIf "gitdir:/path/to/foo/.git"]
190 path = /path/to/foo.inc
192 ; include for all repositories inside /path/to/group
193 [includeIf "gitdir:/path/to/group/"]
194 path = /path/to/foo.inc
196 ; include for all repositories inside $HOME/to/group
197 [includeIf "gitdir:~/to/group/"]
198 path = /path/to/foo.inc
200 ; relative paths are always relative to the including
201 ; file (if the condition is true); their location is not
202 ; affected by the condition
203 [includeIf "gitdir:/path/to/group/"]
209 Values of many variables are treated as a simple string, but there
210 are variables that take values of specific types and there are rules
211 as to how to spell them.
215 When a variable is said to take a boolean value, many
216 synonyms are accepted for 'true' and 'false'; these are all
219 true;; Boolean true can be spelled as `yes`, `on`, `true`,
220 or `1`. Also, a variable defined without `= <value>`
223 false;; Boolean false can be spelled as `no`, `off`,
226 When converting value to the canonical form using `--bool` type
227 specifier; 'git config' will ensure that the output is "true" or
228 "false" (spelled in lowercase).
231 The value for many variables that specify various sizes can
232 be suffixed with `k`, `M`,... to mean "scale the number by
233 1024", "by 1024x1024", etc.
236 The value for a variable that takes a color is a list of
237 colors (at most two, one for foreground and one for background)
238 and attributes (as many as you want), separated by spaces.
240 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
241 `blue`, `magenta`, `cyan` and `white`. The first color given is the
242 foreground; the second is the background.
244 Colors may also be given as numbers between 0 and 255; these use ANSI
245 256-color mode (but note that not all terminals may support this). If
246 your terminal supports it, you may also specify 24-bit RGB values as
249 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
250 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
251 The position of any attributes with respect to the colors
252 (before, after, or in between), doesn't matter. Specific attributes may
253 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
256 An empty color string produces no color effect at all. This can be used
257 to avoid coloring specific elements without disabling color entirely.
259 For git's pre-defined color slots, the attributes are meant to be reset
260 at the beginning of each item in the colored output. So setting
261 `color.decorate.branch` to `black` will paint that branch name in a
262 plain `black`, even if the previous thing on the same output line (e.g.
263 opening parenthesis before the list of branch names in `log --decorate`
264 output) is set to be painted with `bold` or some other attribute.
265 However, custom log formats may do more complicated and layered
266 coloring, and the negated forms may be useful there.
269 A variable that takes a pathname value can be given a
270 string that begins with "`~/`" or "`~user/`", and the usual
271 tilde expansion happens to such a string: `~/`
272 is expanded to the value of `$HOME`, and `~user/` to the
273 specified user's home directory.
279 Note that this list is non-comprehensive and not necessarily complete.
280 For command-specific variables, you will find a more detailed description
281 in the appropriate manual page.
283 Other git-related tools may and do use their own variables. When
284 inventing new variables for use in your own tool, make sure their
285 names do not conflict with those that are used by Git itself and
286 other popular tools, and describe them in your documentation.
290 These variables control various optional help messages designed to
291 aid new users. All 'advice.*' variables default to 'true', and you
292 can tell Git that you do not need help by setting these to 'false':
296 Set this variable to 'false' if you want to disable
298 'pushNonFFMatching', 'pushAlreadyExists',
299 'pushFetchFirst', and 'pushNeedsForce'
302 Advice shown when linkgit:git-push[1] fails due to a
303 non-fast-forward update to the current branch.
305 Advice shown when you ran linkgit:git-push[1] and pushed
306 'matching refs' explicitly (i.e. you used ':', or
307 specified a refspec that isn't your current branch) and
308 it resulted in a non-fast-forward error.
310 Shown when linkgit:git-push[1] rejects an update that
311 does not qualify for fast-forwarding (e.g., a tag.)
313 Shown when linkgit:git-push[1] rejects an update that
314 tries to overwrite a remote ref that points at an
315 object we do not have.
317 Shown when linkgit:git-push[1] rejects an update that
318 tries to overwrite a remote ref that points at an
319 object that is not a commit-ish, or make the remote
320 ref point at an object that is not a commit-ish.
322 Show directions on how to proceed from the current
323 state in the output of linkgit:git-status[1], in
324 the template shown when writing commit messages in
325 linkgit:git-commit[1], and in the help message shown
326 by linkgit:git-checkout[1] when switching branch.
328 Advise to consider using the `-u` option to linkgit:git-status[1]
329 when the command takes more than 2 seconds to enumerate untracked
332 Advice shown when linkgit:git-merge[1] refuses to
333 merge to avoid overwriting local changes.
335 Advice shown by various commands when conflicts
336 prevent the operation from being performed.
338 Advice on how to set your identity configuration when
339 your information is guessed from the system username and
342 Advice shown when you used linkgit:git-checkout[1] to
343 move to the detach HEAD state, to instruct how to create
344 a local branch after the fact.
346 Advice that shows the location of the patch file when
347 linkgit:git-am[1] fails to apply it.
349 In case of failure in the output of linkgit:git-rm[1],
350 show directions on how to proceed from the current state.
354 Tells Git if the executable bit of files in the working tree
357 Some filesystems lose the executable bit when a file that is
358 marked as executable is checked out, or checks out a
359 non-executable file with executable bit on.
360 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
361 to see if it handles the executable bit correctly
362 and this variable is automatically set as necessary.
364 A repository, however, may be on a filesystem that handles
365 the filemode correctly, and this variable is set to 'true'
366 when created, but later may be made accessible from another
367 environment that loses the filemode (e.g. exporting ext4 via
368 CIFS mount, visiting a Cygwin created repository with
369 Git for Windows or Eclipse).
370 In such a case it may be necessary to set this variable to 'false'.
371 See linkgit:git-update-index[1].
373 The default is true (when core.filemode is not specified in the config file).
376 (Windows-only) If true, mark newly-created directories and files whose
377 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
378 directory is hidden, but no other files starting with a dot. The
379 default mode is 'dotGitOnly'.
382 If true, this option enables various workarounds to enable
383 Git to work better on filesystems that are not case sensitive,
384 like FAT. For example, if a directory listing finds
385 "makefile" when Git expects "Makefile", Git will assume
386 it is really the same file, and continue to remember it as
389 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
390 will probe and set core.ignoreCase true if appropriate when the repository
393 core.precomposeUnicode::
394 This option is only used by Mac OS implementation of Git.
395 When core.precomposeUnicode=true, Git reverts the unicode decomposition
396 of filenames done by Mac OS. This is useful when sharing a repository
397 between Mac OS and Linux or Windows.
398 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
399 When false, file names are handled fully transparent by Git,
400 which is backward compatible with older versions of Git.
403 If set to true, do not allow checkout of paths that would
404 be considered equivalent to `.git` on an HFS+ filesystem.
405 Defaults to `true` on Mac OS, and `false` elsewhere.
408 If set to true, do not allow checkout of paths that would
409 cause problems with the NTFS filesystem, e.g. conflict with
411 Defaults to `true` on Windows, and `false` elsewhere.
414 If false, the ctime differences between the index and the
415 working tree are ignored; useful when the inode change time
416 is regularly modified by something outside Git (file system
417 crawlers and some backup systems).
418 See linkgit:git-update-index[1]. True by default.
421 If true, the split-index feature of the index will be used.
422 See linkgit:git-update-index[1]. False by default.
424 core.untrackedCache::
425 Determines what to do about the untracked cache feature of the
426 index. It will be kept, if this variable is unset or set to
427 `keep`. It will automatically be added if set to `true`. And
428 it will automatically be removed, if set to `false`. Before
429 setting it to `true`, you should check that mtime is working
430 properly on your system.
431 See linkgit:git-update-index[1]. `keep` by default.
434 Determines which stat fields to match between the index
435 and work tree. The user can set this to 'default' or
436 'minimal'. Default (or explicitly 'default'), is to check
437 all fields, including the sub-second part of mtime and ctime.
440 Commands that output paths (e.g. 'ls-files', 'diff'), will
441 quote "unusual" characters in the pathname by enclosing the
442 pathname in double-quotes and escaping those characters with
443 backslashes in the same way C escapes control characters (e.g.
444 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
445 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
446 UTF-8). If this variable is set to false, bytes higher than
447 0x80 are not considered "unusual" any more. Double-quotes,
448 backslash and control characters are always escaped regardless
449 of the setting of this variable. A simple space character is
450 not considered "unusual". Many commands can output pathnames
451 completely verbatim using the `-z` option. The default value
455 Sets the line ending type to use in the working directory for
456 files that have the `text` property set when core.autocrlf is false.
457 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
458 native line ending. The default value is `native`. See
459 linkgit:gitattributes[5] for more information on end-of-line
463 If true, makes Git check if converting `CRLF` is reversible when
464 end-of-line conversion is active. Git will verify if a command
465 modifies a file in the work tree either directly or indirectly.
466 For example, committing a file followed by checking out the
467 same file should yield the original file in the work tree. If
468 this is not the case for the current setting of
469 `core.autocrlf`, Git will reject the file. The variable can
470 be set to "warn", in which case Git will only warn about an
471 irreversible conversion but continue the operation.
473 CRLF conversion bears a slight chance of corrupting data.
474 When it is enabled, Git will convert CRLF to LF during commit and LF to
475 CRLF during checkout. A file that contains a mixture of LF and
476 CRLF before the commit cannot be recreated by Git. For text
477 files this is the right thing to do: it corrects line endings
478 such that we have only LF line endings in the repository.
479 But for binary files that are accidentally classified as text the
480 conversion can corrupt data.
482 If you recognize such corruption early you can easily fix it by
483 setting the conversion type explicitly in .gitattributes. Right
484 after committing you still have the original file in your work
485 tree and this file is not yet corrupted. You can explicitly tell
486 Git that this file is binary and Git will handle the file
489 Unfortunately, the desired effect of cleaning up text files with
490 mixed line endings and the undesired effect of corrupting binary
491 files cannot be distinguished. In both cases CRLFs are removed
492 in an irreversible way. For text files this is the right thing
493 to do because CRLFs are line endings, while for binary files
494 converting CRLFs corrupts data.
496 Note, this safety check does not mean that a checkout will generate a
497 file identical to the original file for a different setting of
498 `core.eol` and `core.autocrlf`, but only for the current one. For
499 example, a text file with `LF` would be accepted with `core.eol=lf`
500 and could later be checked out with `core.eol=crlf`, in which case the
501 resulting file would contain `CRLF`, although the original file
502 contained `LF`. However, in both work trees the line endings would be
503 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
504 file with mixed line endings would be reported by the `core.safecrlf`
508 Setting this variable to "true" is the same as setting
509 the `text` attribute to "auto" on all files and core.eol to "crlf".
510 Set to true if you want to have `CRLF` line endings in your
511 working directory and the repository has LF line endings.
512 This variable can be set to 'input',
513 in which case no output conversion is performed.
516 If false, symbolic links are checked out as small plain files that
517 contain the link text. linkgit:git-update-index[1] and
518 linkgit:git-add[1] will not change the recorded type to regular
519 file. Useful on filesystems like FAT that do not support
522 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
523 will probe and set core.symlinks false if appropriate when the repository
527 A "proxy command" to execute (as 'command host port') instead
528 of establishing direct connection to the remote server when
529 using the Git protocol for fetching. If the variable value is
530 in the "COMMAND for DOMAIN" format, the command is applied only
531 on hostnames ending with the specified domain string. This variable
532 may be set multiple times and is matched in the given order;
533 the first match wins.
535 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
536 (which always applies universally, without the special "for"
539 The special string `none` can be used as the proxy command to
540 specify that no proxy be used for a given domain pattern.
541 This is useful for excluding servers inside a firewall from
542 proxy use, while defaulting to a common proxy for external domains.
545 If this variable is set, `git fetch` and `git push` will
546 use the specified command instead of `ssh` when they need to
547 connect to a remote system. The command is in the same form as
548 the `GIT_SSH_COMMAND` environment variable and is overridden
549 when the environment variable is set.
552 If true, Git will avoid using lstat() calls to detect if files have
553 changed by setting the "assume-unchanged" bit for those tracked files
554 which it has updated identically in both the index and working tree.
556 When files are modified outside of Git, the user will need to stage
557 the modified files explicitly (e.g. see 'Examples' section in
558 linkgit:git-update-index[1]).
559 Git will not normally detect changes to those files.
561 This is useful on systems where lstat() calls are very slow, such as
562 CIFS/Microsoft Windows.
566 core.preferSymlinkRefs::
567 Instead of the default "symref" format for HEAD
568 and other symbolic reference files, use symbolic links.
569 This is sometimes needed to work with old scripts that
570 expect HEAD to be a symbolic link.
573 If true this repository is assumed to be 'bare' and has no
574 working directory associated with it. If this is the case a
575 number of commands that require a working directory will be
576 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
578 This setting is automatically guessed by linkgit:git-clone[1] or
579 linkgit:git-init[1] when the repository was created. By default a
580 repository that ends in "/.git" is assumed to be not bare (bare =
581 false), while all other repositories are assumed to be bare (bare
585 Set the path to the root of the working tree.
586 If `GIT_COMMON_DIR` environment variable is set, core.worktree
587 is ignored and not used for determining the root of working tree.
588 This can be overridden by the `GIT_WORK_TREE` environment
589 variable and the `--work-tree` command-line option.
590 The value can be an absolute path or relative to the path to
591 the .git directory, which is either specified by --git-dir
592 or GIT_DIR, or automatically discovered.
593 If --git-dir or GIT_DIR is specified but none of
594 --work-tree, GIT_WORK_TREE and core.worktree is specified,
595 the current working directory is regarded as the top level
596 of your working tree.
598 Note that this variable is honored even when set in a configuration
599 file in a ".git" subdirectory of a directory and its value differs
600 from the latter directory (e.g. "/path/to/.git/config" has
601 core.worktree set to "/different/path"), which is most likely a
602 misconfiguration. Running Git commands in the "/path/to" directory will
603 still use "/different/path" as the root of the work tree and can cause
604 confusion unless you know what you are doing (e.g. you are creating a
605 read-only snapshot of the same index to a location different from the
606 repository's usual working tree).
608 core.logAllRefUpdates::
609 Enable the reflog. Updates to a ref <ref> is logged to the file
610 "`$GIT_DIR/logs/<ref>`", by appending the new and old
611 SHA-1, the date/time and the reason of the update, but
612 only when the file exists. If this configuration
613 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
614 file is automatically created for branch heads (i.e. under
615 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
616 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
617 If it is set to `always`, then a missing reflog is automatically
618 created for any ref under `refs/`.
620 This information can be used to determine what commit
621 was the tip of a branch "2 days ago".
623 This value is true by default in a repository that has
624 a working directory associated with it, and false by
625 default in a bare repository.
627 core.repositoryFormatVersion::
628 Internal variable identifying the repository format and layout
631 core.sharedRepository::
632 When 'group' (or 'true'), the repository is made shareable between
633 several users in a group (making sure all the files and objects are
634 group-writable). When 'all' (or 'world' or 'everybody'), the
635 repository will be readable by all users, additionally to being
636 group-shareable. When 'umask' (or 'false'), Git will use permissions
637 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
638 files in the repository will have this mode value. '0xxx' will override
639 user's umask value (whereas the other options will only override
640 requested parts of the user's umask value). Examples: '0660' will make
641 the repo read/write-able for the owner and group, but inaccessible to
642 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
643 repository that is group-readable but not group-writable.
644 See linkgit:git-init[1]. False by default.
646 core.warnAmbiguousRefs::
647 If true, Git will warn you if the ref name you passed it is ambiguous
648 and might match multiple refs in the repository. True by default.
651 An integer -1..9, indicating a default compression level.
652 -1 is the zlib default. 0 means no compression,
653 and 1..9 are various speed/size tradeoffs, 9 being slowest.
654 If set, this provides a default to other compression variables,
655 such as `core.looseCompression` and `pack.compression`.
657 core.looseCompression::
658 An integer -1..9, indicating the compression level for objects that
659 are not in a pack file. -1 is the zlib default. 0 means no
660 compression, and 1..9 are various speed/size tradeoffs, 9 being
661 slowest. If not set, defaults to core.compression. If that is
662 not set, defaults to 1 (best speed).
664 core.packedGitWindowSize::
665 Number of bytes of a pack file to map into memory in a
666 single mapping operation. Larger window sizes may allow
667 your system to process a smaller number of large pack files
668 more quickly. Smaller window sizes will negatively affect
669 performance due to increased calls to the operating system's
670 memory manager, but may improve performance when accessing
671 a large number of large pack files.
673 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
674 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
675 be reasonable for all users/operating systems. You probably do
676 not need to adjust this value.
678 Common unit suffixes of 'k', 'm', or 'g' are supported.
680 core.packedGitLimit::
681 Maximum number of bytes to map simultaneously into memory
682 from pack files. If Git needs to access more than this many
683 bytes at once to complete an operation it will unmap existing
684 regions to reclaim virtual address space within the process.
686 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
687 This should be reasonable for all users/operating systems, except on
688 the largest projects. You probably do not need to adjust this value.
690 Common unit suffixes of 'k', 'm', or 'g' are supported.
692 core.deltaBaseCacheLimit::
693 Maximum number of bytes to reserve for caching base objects
694 that may be referenced by multiple deltified objects. By storing the
695 entire decompressed base objects in a cache Git is able
696 to avoid unpacking and decompressing frequently used base
697 objects multiple times.
699 Default is 96 MiB on all platforms. This should be reasonable
700 for all users/operating systems, except on the largest projects.
701 You probably do not need to adjust this value.
703 Common unit suffixes of 'k', 'm', or 'g' are supported.
705 core.bigFileThreshold::
706 Files larger than this size are stored deflated, without
707 attempting delta compression. Storing large files without
708 delta compression avoids excessive memory usage, at the
709 slight expense of increased disk usage. Additionally files
710 larger than this size are always treated as binary.
712 Default is 512 MiB on all platforms. This should be reasonable
713 for most projects as source code and other text files can still
714 be delta compressed, but larger binary media files won't be.
716 Common unit suffixes of 'k', 'm', or 'g' are supported.
719 Specifies the pathname to the file that contains patterns to
720 describe paths that are not meant to be tracked, in addition
721 to '.gitignore' (per-directory) and '.git/info/exclude'.
722 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
723 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
724 is used instead. See linkgit:gitignore[5].
727 Some commands (e.g. svn and http interfaces) that interactively
728 ask for a password can be told to use an external program given
729 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
730 environment variable. If not set, fall back to the value of the
731 `SSH_ASKPASS` environment variable or, failing that, a simple password
732 prompt. The external program shall be given a suitable prompt as
733 command-line argument and write the password on its STDOUT.
735 core.attributesFile::
736 In addition to '.gitattributes' (per-directory) and
737 '.git/info/attributes', Git looks into this file for attributes
738 (see linkgit:gitattributes[5]). Path expansions are made the same
739 way as for `core.excludesFile`. Its default value is
740 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
741 set or empty, `$HOME/.config/git/attributes` is used instead.
744 By default Git will look for your hooks in the
745 '$GIT_DIR/hooks' directory. Set this to different path,
746 e.g. '/etc/git/hooks', and Git will try to find your hooks in
747 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
748 in '$GIT_DIR/hooks/pre-receive'.
750 The path can be either absolute or relative. A relative path is
751 taken as relative to the directory where the hooks are run (see
752 the "DESCRIPTION" section of linkgit:githooks[5]).
754 This configuration variable is useful in cases where you'd like to
755 centrally configure your Git hooks instead of configuring them on a
756 per-repository basis, or as a more flexible and centralized
757 alternative to having an `init.templateDir` where you've changed
761 Commands such as `commit` and `tag` that let you edit
762 messages by launching an editor use the value of this
763 variable when it is set, and the environment variable
764 `GIT_EDITOR` is not set. See linkgit:git-var[1].
767 Commands such as `commit` and `tag` that let you edit
768 messages consider a line that begins with this character
769 commented, and removes them after the editor returns
772 If set to "auto", `git-commit` would select a character that is not
773 the beginning character of any line in existing commit messages.
775 core.packedRefsTimeout::
776 The length of time, in milliseconds, to retry when trying to
777 lock the `packed-refs` file. Value 0 means not to retry at
778 all; -1 means to try indefinitely. Default is 1000 (i.e.,
782 Text editor used by `git rebase -i` for editing the rebase instruction file.
783 The value is meant to be interpreted by the shell when it is used.
784 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
785 When not configured the default commit message editor is used instead.
788 Text viewer for use by Git commands (e.g., 'less'). The value
789 is meant to be interpreted by the shell. The order of preference
790 is the `$GIT_PAGER` environment variable, then `core.pager`
791 configuration, then `$PAGER`, and then the default chosen at
792 compile time (usually 'less').
794 When the `LESS` environment variable is unset, Git sets it to `FRX`
795 (if `LESS` environment variable is set, Git does not change it at
796 all). If you want to selectively override Git's default setting
797 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
798 be passed to the shell by Git, which will translate the final
799 command to `LESS=FRX less -S`. The environment does not set the
800 `S` option but the command line does, instructing less to truncate
801 long lines. Similarly, setting `core.pager` to `less -+F` will
802 deactivate the `F` option specified by the environment from the
803 command-line, deactivating the "quit if one screen" behavior of
804 `less`. One can specifically activate some flags for particular
805 commands: for example, setting `pager.blame` to `less -S` enables
806 line truncation only for `git blame`.
808 Likewise, when the `LV` environment variable is unset, Git sets it
809 to `-c`. You can override this setting by exporting `LV` with
810 another value or setting `core.pager` to `lv +c`.
813 A comma separated list of common whitespace problems to
814 notice. 'git diff' will use `color.diff.whitespace` to
815 highlight them, and 'git apply --whitespace=error' will
816 consider them as errors. You can prefix `-` to disable
817 any of them (e.g. `-trailing-space`):
819 * `blank-at-eol` treats trailing whitespaces at the end of the line
820 as an error (enabled by default).
821 * `space-before-tab` treats a space character that appears immediately
822 before a tab character in the initial indent part of the line as an
823 error (enabled by default).
824 * `indent-with-non-tab` treats a line that is indented with space
825 characters instead of the equivalent tabs as an error (not enabled by
827 * `tab-in-indent` treats a tab character in the initial indent part of
828 the line as an error (not enabled by default).
829 * `blank-at-eof` treats blank lines added at the end of file as an error
830 (enabled by default).
831 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
833 * `cr-at-eol` treats a carriage-return at the end of line as
834 part of the line terminator, i.e. with it, `trailing-space`
835 does not trigger if the character before such a carriage-return
836 is not a whitespace (not enabled by default).
837 * `tabwidth=<n>` tells how many character positions a tab occupies; this
838 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
839 errors. The default tab width is 8. Allowed values are 1 to 63.
841 core.fsyncObjectFiles::
842 This boolean will enable 'fsync()' when writing object files.
844 This is a total waste of time and effort on a filesystem that orders
845 data writes properly, but can be useful for filesystems that do not use
846 journalling (traditional UNIX filesystems) or that only journal metadata
847 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
850 Enable parallel index preload for operations like 'git diff'
852 This can speed up operations like 'git diff' and 'git status' especially
853 on filesystems like NFS that have weak caching semantics and thus
854 relatively high IO latencies. When enabled, Git will do the
855 index comparison to the filesystem data in parallel, allowing
856 overlapping IO's. Defaults to true.
859 You can set this to 'link', in which case a hardlink followed by
860 a delete of the source are used to make sure that object creation
861 will not overwrite existing objects.
863 On some file system/operating system combinations, this is unreliable.
864 Set this config setting to 'rename' there; However, This will remove the
865 check that makes sure that existing object files will not get overwritten.
868 When showing commit messages, also show notes which are stored in
869 the given ref. The ref must be fully qualified. If the given
870 ref does not exist, it is not an error but means that no
871 notes should be printed.
873 This setting defaults to "refs/notes/commits", and it can be overridden by
874 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
876 core.sparseCheckout::
877 Enable "sparse checkout" feature. See section "Sparse checkout" in
878 linkgit:git-read-tree[1] for more information.
881 Set the length object names are abbreviated to. If
882 unspecified or set to "auto", an appropriate value is
883 computed based on the approximate number of packed objects
884 in your repository, which hopefully is enough for
885 abbreviated object names to stay unique for some time.
888 add.ignore-errors (deprecated)::
889 Tells 'git add' to continue adding files when some files cannot be
890 added due to indexing errors. Equivalent to the `--ignore-errors`
891 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
892 as it does not follow the usual naming convention for configuration
896 Command aliases for the linkgit:git[1] command wrapper - e.g.
897 after defining "alias.last = cat-file commit HEAD", the invocation
898 "git last" is equivalent to "git cat-file commit HEAD". To avoid
899 confusion and troubles with script usage, aliases that
900 hide existing Git commands are ignored. Arguments are split by
901 spaces, the usual shell quoting and escaping is supported.
902 A quote pair or a backslash can be used to quote them.
904 If the alias expansion is prefixed with an exclamation point,
905 it will be treated as a shell command. For example, defining
906 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
907 "git new" is equivalent to running the shell command
908 "gitk --all --not ORIG_HEAD". Note that shell commands will be
909 executed from the top-level directory of a repository, which may
910 not necessarily be the current directory.
911 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
912 from the original current directory. See linkgit:git-rev-parse[1].
915 If true, git-am will call git-mailsplit for patches in mbox format
916 with parameter `--keep-cr`. In this case git-mailsplit will
917 not remove `\r` from lines ending with `\r\n`. Can be overridden
918 by giving `--no-keep-cr` from the command line.
919 See linkgit:git-am[1], linkgit:git-mailsplit[1].
922 By default, `git am` will fail if the patch does not apply cleanly. When
923 set to true, this setting tells `git am` to fall back on 3-way merge if
924 the patch records the identity of blobs it is supposed to apply to and
925 we have those blobs available locally (equivalent to giving the `--3way`
926 option from the command line). Defaults to `false`.
927 See linkgit:git-am[1].
929 apply.ignoreWhitespace::
930 When set to 'change', tells 'git apply' to ignore changes in
931 whitespace, in the same way as the `--ignore-space-change`
933 When set to one of: no, none, never, false tells 'git apply' to
934 respect all whitespace differences.
935 See linkgit:git-apply[1].
938 Tells 'git apply' how to handle whitespaces, in the same way
939 as the `--whitespace` option. See linkgit:git-apply[1].
941 branch.autoSetupMerge::
942 Tells 'git branch' and 'git checkout' to set up new branches
943 so that linkgit:git-pull[1] will appropriately merge from the
944 starting point branch. Note that even if this option is not set,
945 this behavior can be chosen per-branch using the `--track`
946 and `--no-track` options. The valid settings are: `false` -- no
947 automatic setup is done; `true` -- automatic setup is done when the
948 starting point is a remote-tracking branch; `always` --
949 automatic setup is done when the starting point is either a
950 local branch or remote-tracking
951 branch. This option defaults to true.
953 branch.autoSetupRebase::
954 When a new branch is created with 'git branch' or 'git checkout'
955 that tracks another branch, this variable tells Git to set
956 up pull to rebase instead of merge (see "branch.<name>.rebase").
957 When `never`, rebase is never automatically set to true.
958 When `local`, rebase is set to true for tracked branches of
959 other local branches.
960 When `remote`, rebase is set to true for tracked branches of
961 remote-tracking branches.
962 When `always`, rebase will be set to true for all tracking
964 See "branch.autoSetupMerge" for details on how to set up a
965 branch to track another branch.
966 This option defaults to never.
968 branch.<name>.remote::
969 When on branch <name>, it tells 'git fetch' and 'git push'
970 which remote to fetch from/push to. The remote to push to
971 may be overridden with `remote.pushDefault` (for all branches).
972 The remote to push to, for the current branch, may be further
973 overridden by `branch.<name>.pushRemote`. If no remote is
974 configured, or if you are not on any branch, it defaults to
975 `origin` for fetching and `remote.pushDefault` for pushing.
976 Additionally, `.` (a period) is the current local repository
977 (a dot-repository), see `branch.<name>.merge`'s final note below.
979 branch.<name>.pushRemote::
980 When on branch <name>, it overrides `branch.<name>.remote` for
981 pushing. It also overrides `remote.pushDefault` for pushing
982 from branch <name>. When you pull from one place (e.g. your
983 upstream) and push to another place (e.g. your own publishing
984 repository), you would want to set `remote.pushDefault` to
985 specify the remote to push to for all branches, and use this
986 option to override it for a specific branch.
988 branch.<name>.merge::
989 Defines, together with branch.<name>.remote, the upstream branch
990 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
991 branch to merge and can also affect 'git push' (see push.default).
992 When in branch <name>, it tells 'git fetch' the default
993 refspec to be marked for merging in FETCH_HEAD. The value is
994 handled like the remote part of a refspec, and must match a
995 ref which is fetched from the remote given by
996 "branch.<name>.remote".
997 The merge information is used by 'git pull' (which at first calls
998 'git fetch') to lookup the default branch for merging. Without
999 this option, 'git pull' defaults to merge the first refspec fetched.
1000 Specify multiple values to get an octopus merge.
1001 If you wish to setup 'git pull' so that it merges into <name> from
1002 another branch in the local repository, you can point
1003 branch.<name>.merge to the desired branch, and use the relative path
1004 setting `.` (a period) for branch.<name>.remote.
1006 branch.<name>.mergeOptions::
1007 Sets default options for merging into branch <name>. The syntax and
1008 supported options are the same as those of linkgit:git-merge[1], but
1009 option values containing whitespace characters are currently not
1012 branch.<name>.rebase::
1013 When true, rebase the branch <name> on top of the fetched branch,
1014 instead of merging the default branch from the default remote when
1015 "git pull" is run. See "pull.rebase" for doing this in a non
1016 branch-specific manner.
1018 When preserve, also pass `--preserve-merges` along to 'git rebase'
1019 so that locally committed merge commits will not be flattened
1020 by running 'git pull'.
1022 When the value is `interactive`, the rebase is run in interactive mode.
1024 *NOTE*: this is a possibly dangerous operation; do *not* use
1025 it unless you understand the implications (see linkgit:git-rebase[1]
1028 branch.<name>.description::
1029 Branch description, can be edited with
1030 `git branch --edit-description`. Branch description is
1031 automatically added in the format-patch cover letter or
1032 request-pull summary.
1034 browser.<tool>.cmd::
1035 Specify the command to invoke the specified browser. The
1036 specified command is evaluated in shell with the URLs passed
1037 as arguments. (See linkgit:git-web{litdd}browse[1].)
1039 browser.<tool>.path::
1040 Override the path for the given tool that may be used to
1041 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1042 working repository in gitweb (see linkgit:git-instaweb[1]).
1044 clean.requireForce::
1045 A boolean to make git-clean do nothing unless given -f,
1046 -i or -n. Defaults to true.
1049 A boolean to enable/disable color in the output of
1050 linkgit:git-branch[1]. May be set to `always`,
1051 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1052 only when the output is to a terminal. If unset, then the
1053 value of `color.ui` is used (`auto` by default).
1055 color.branch.<slot>::
1056 Use customized color for branch coloration. `<slot>` is one of
1057 `current` (the current branch), `local` (a local branch),
1058 `remote` (a remote-tracking branch in refs/remotes/),
1059 `upstream` (upstream tracking branch), `plain` (other
1063 Whether to use ANSI escape sequences to add color to patches.
1064 If this is set to `always`, linkgit:git-diff[1],
1065 linkgit:git-log[1], and linkgit:git-show[1] will use color
1066 for all patches. If it is set to `true` or `auto`, those
1067 commands will only use color when output is to the terminal.
1068 If unset, then the value of `color.ui` is used (`auto` by
1071 This does not affect linkgit:git-format-patch[1] or the
1072 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1073 command line with the `--color[=<when>]` option.
1076 Use customized color for diff colorization. `<slot>` specifies
1077 which part of the patch to use the specified color, and is one
1078 of `context` (context text - `plain` is a historical synonym),
1079 `meta` (metainformation), `frag`
1080 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1081 `new` (added lines), `commit` (commit headers), or `whitespace`
1082 (highlighting whitespace errors).
1084 color.decorate.<slot>::
1085 Use customized color for 'git log --decorate' output. `<slot>` is one
1086 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1087 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1090 When set to `always`, always highlight matches. When `false` (or
1091 `never`), never. When set to `true` or `auto`, use color only
1092 when the output is written to the terminal. If unset, then the
1093 value of `color.ui` is used (`auto` by default).
1096 Use customized color for grep colorization. `<slot>` specifies which
1097 part of the line to use the specified color, and is one of
1101 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1103 filename prefix (when not using `-h`)
1105 function name lines (when using `-p`)
1107 line number prefix (when using `-n`)
1109 matching text (same as setting `matchContext` and `matchSelected`)
1111 matching text in context lines
1113 matching text in selected lines
1115 non-matching text in selected lines
1117 separators between fields on a line (`:`, `-`, and `=`)
1118 and between hunks (`--`)
1122 When set to `always`, always use colors for interactive prompts
1123 and displays (such as those used by "git-add --interactive" and
1124 "git-clean --interactive"). When false (or `never`), never.
1125 When set to `true` or `auto`, use colors only when the output is
1126 to the terminal. If unset, then the value of `color.ui` is
1127 used (`auto` by default).
1129 color.interactive.<slot>::
1130 Use customized color for 'git add --interactive' and 'git clean
1131 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1132 or `error`, for four distinct types of normal output from
1133 interactive commands.
1136 A boolean to enable/disable colored output when the pager is in
1137 use (default is true).
1140 A boolean to enable/disable color in the output of
1141 linkgit:git-show-branch[1]. May be set to `always`,
1142 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1143 only when the output is to a terminal. If unset, then the
1144 value of `color.ui` is used (`auto` by default).
1147 A boolean to enable/disable color in the output of
1148 linkgit:git-status[1]. May be set to `always`,
1149 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1150 only when the output is to a terminal. If unset, then the
1151 value of `color.ui` is used (`auto` by default).
1153 color.status.<slot>::
1154 Use customized color for status colorization. `<slot>` is
1155 one of `header` (the header text of the status message),
1156 `added` or `updated` (files which are added but not committed),
1157 `changed` (files which are changed but not added in the index),
1158 `untracked` (files which are not tracked by Git),
1159 `branch` (the current branch),
1160 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1162 `localBranch` or `remoteBranch` (the local and remote branch names,
1163 respectively, when branch and tracking information is displayed in the
1164 status short-format), or
1165 `unmerged` (files which have unmerged changes).
1168 This variable determines the default value for variables such
1169 as `color.diff` and `color.grep` that control the use of color
1170 per command family. Its scope will expand as more commands learn
1171 configuration to set a default for the `--color` option. Set it
1172 to `false` or `never` if you prefer Git commands not to use
1173 color unless enabled explicitly with some other configuration
1174 or the `--color` option. Set it to `always` if you want all
1175 output not intended for machine consumption to use color, to
1176 `true` or `auto` (this is the default since Git 1.8.4) if you
1177 want such output to use color when written to the terminal.
1180 Specify whether supported commands should output in columns.
1181 This variable consists of a list of tokens separated by spaces
1184 These options control when the feature should be enabled
1185 (defaults to 'never'):
1189 always show in columns
1191 never show in columns
1193 show in columns if the output is to the terminal
1196 These options control layout (defaults to 'column'). Setting any
1197 of these implies 'always' if none of 'always', 'never', or 'auto' are
1202 fill columns before rows
1204 fill rows before columns
1209 Finally, these options can be combined with a layout option (defaults
1214 make unequal size columns to utilize more space
1216 make equal size columns
1220 Specify whether to output branch listing in `git branch` in columns.
1221 See `column.ui` for details.
1224 Specify the layout when list items in `git clean -i`, which always
1225 shows files and directories in columns. See `column.ui` for details.
1228 Specify whether to output untracked files in `git status` in columns.
1229 See `column.ui` for details.
1232 Specify whether to output tag listing in `git tag` in columns.
1233 See `column.ui` for details.
1236 This setting overrides the default of the `--cleanup` option in
1237 `git commit`. See linkgit:git-commit[1] for details. Changing the
1238 default can be useful when you always want to keep lines that begin
1239 with comment character `#` in your log message, in which case you
1240 would do `git config commit.cleanup whitespace` (note that you will
1241 have to remove the help lines that begin with `#` in the commit log
1242 template yourself, if you do this).
1246 A boolean to specify whether all commits should be GPG signed.
1247 Use of this option when doing operations such as rebase can
1248 result in a large number of commits being signed. It may be
1249 convenient to use an agent to avoid typing your GPG passphrase
1253 A boolean to enable/disable inclusion of status information in the
1254 commit message template when using an editor to prepare the commit
1255 message. Defaults to true.
1258 Specify the pathname of a file to use as the template for
1259 new commit messages.
1262 A boolean or int to specify the level of verbose with `git commit`.
1263 See linkgit:git-commit[1].
1266 Specify an external helper to be called when a username or
1267 password credential is needed; the helper may consult external
1268 storage to avoid prompting the user for the credentials. Note
1269 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1272 credential.useHttpPath::
1273 When acquiring credentials, consider the "path" component of an http
1274 or https URL to be important. Defaults to false. See
1275 linkgit:gitcredentials[7] for more information.
1277 credential.username::
1278 If no username is set for a network authentication, use this username
1279 by default. See credential.<context>.* below, and
1280 linkgit:gitcredentials[7].
1282 credential.<url>.*::
1283 Any of the credential.* options above can be applied selectively to
1284 some credentials. For example "credential.https://example.com.username"
1285 would set the default username only for https connections to
1286 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1289 credentialCache.ignoreSIGHUP::
1290 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1292 include::diff-config.txt[]
1294 difftool.<tool>.path::
1295 Override the path for the given tool. This is useful in case
1296 your tool is not in the PATH.
1298 difftool.<tool>.cmd::
1299 Specify the command to invoke the specified diff tool.
1300 The specified command is evaluated in shell with the following
1301 variables available: 'LOCAL' is set to the name of the temporary
1302 file containing the contents of the diff pre-image and 'REMOTE'
1303 is set to the name of the temporary file containing the contents
1304 of the diff post-image.
1307 Prompt before each invocation of the diff tool.
1309 fastimport.unpackLimit::
1310 If the number of objects imported by linkgit:git-fast-import[1]
1311 is below this limit, then the objects will be unpacked into
1312 loose object files. However if the number of imported objects
1313 equals or exceeds this limit then the pack will be stored as a
1314 pack. Storing the pack from a fast-import can make the import
1315 operation complete faster, especially on slow filesystems. If
1316 not set, the value of `transfer.unpackLimit` is used instead.
1318 fetch.recurseSubmodules::
1319 This option can be either set to a boolean value or to 'on-demand'.
1320 Setting it to a boolean changes the behavior of fetch and pull to
1321 unconditionally recurse into submodules when set to true or to not
1322 recurse at all when set to false. When set to 'on-demand' (the default
1323 value), fetch and pull will only recurse into a populated submodule
1324 when its superproject retrieves a commit that updates the submodule's
1328 If it is set to true, git-fetch-pack will check all fetched
1329 objects. It will abort in the case of a malformed object or a
1330 broken link. The result of an abort are only dangling objects.
1331 Defaults to false. If not set, the value of `transfer.fsckObjects`
1335 If the number of objects fetched over the Git native
1336 transfer is below this
1337 limit, then the objects will be unpacked into loose object
1338 files. However if the number of received objects equals or
1339 exceeds this limit then the received pack will be stored as
1340 a pack, after adding any missing delta bases. Storing the
1341 pack from a push can make the push operation complete faster,
1342 especially on slow filesystems. If not set, the value of
1343 `transfer.unpackLimit` is used instead.
1346 If true, fetch will automatically behave as if the `--prune`
1347 option was given on the command line. See also `remote.<name>.prune`.
1350 Control how ref update status is printed. Valid values are
1351 `full` and `compact`. Default value is `full`. See section
1352 OUTPUT in linkgit:git-fetch[1] for detail.
1355 Enable multipart/mixed attachments as the default for
1356 'format-patch'. The value can also be a double quoted string
1357 which will enable attachments as the default and set the
1358 value as the boundary. See the --attach option in
1359 linkgit:git-format-patch[1].
1362 Provides the default value for the `--from` option to format-patch.
1363 Accepts a boolean value, or a name and email address. If false,
1364 format-patch defaults to `--no-from`, using commit authors directly in
1365 the "From:" field of patch mails. If true, format-patch defaults to
1366 `--from`, using your committer identity in the "From:" field of patch
1367 mails and including a "From:" field in the body of the patch mail if
1368 different. If set to a non-boolean value, format-patch uses that
1369 value instead of your committer identity. Defaults to false.
1372 A boolean which can enable or disable sequence numbers in patch
1373 subjects. It defaults to "auto" which enables it only if there
1374 is more than one patch. It can be enabled or disabled for all
1375 messages by setting it to "true" or "false". See --numbered
1376 option in linkgit:git-format-patch[1].
1379 Additional email headers to include in a patch to be submitted
1380 by mail. See linkgit:git-format-patch[1].
1384 Additional recipients to include in a patch to be submitted
1385 by mail. See the --to and --cc options in
1386 linkgit:git-format-patch[1].
1388 format.subjectPrefix::
1389 The default for format-patch is to output files with the '[PATCH]'
1390 subject prefix. Use this variable to change that prefix.
1393 The default for format-patch is to output a signature containing
1394 the Git version number. Use this variable to change that default.
1395 Set this variable to the empty string ("") to suppress
1396 signature generation.
1398 format.signatureFile::
1399 Works just like format.signature except the contents of the
1400 file specified by this variable will be used as the signature.
1403 The default for format-patch is to output files with the suffix
1404 `.patch`. Use this variable to change that suffix (make sure to
1405 include the dot if you want it).
1408 The default pretty format for log/show/whatchanged command,
1409 See linkgit:git-log[1], linkgit:git-show[1],
1410 linkgit:git-whatchanged[1].
1413 The default threading style for 'git format-patch'. Can be
1414 a boolean value, or `shallow` or `deep`. `shallow` threading
1415 makes every mail a reply to the head of the series,
1416 where the head is chosen from the cover letter, the
1417 `--in-reply-to`, and the first patch mail, in this order.
1418 `deep` threading makes every mail a reply to the previous one.
1419 A true boolean value is the same as `shallow`, and a false
1420 value disables threading.
1423 A boolean value which lets you enable the `-s/--signoff` option of
1424 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1425 patch should be a conscious act and means that you certify you have
1426 the rights to submit this work under the same open source license.
1427 Please see the 'SubmittingPatches' document for further discussion.
1429 format.coverLetter::
1430 A boolean that controls whether to generate a cover-letter when
1431 format-patch is invoked, but in addition can be set to "auto", to
1432 generate a cover-letter only when there's more than one patch.
1434 format.outputDirectory::
1435 Set a custom directory to store the resulting files instead of the
1436 current working directory.
1438 format.useAutoBase::
1439 A boolean value which lets you enable the `--base=auto` option of
1440 format-patch by default.
1442 filter.<driver>.clean::
1443 The command which is used to convert the content of a worktree
1444 file to a blob upon checkin. See linkgit:gitattributes[5] for
1447 filter.<driver>.smudge::
1448 The command which is used to convert the content of a blob
1449 object to a worktree file upon checkout. See
1450 linkgit:gitattributes[5] for details.
1453 Allows overriding the message type (error, warn or ignore) of a
1454 specific message ID such as `missingEmail`.
1456 For convenience, fsck prefixes the error/warning with the message ID,
1457 e.g. "missingEmail: invalid author/committer line - missing email" means
1458 that setting `fsck.missingEmail = ignore` will hide that issue.
1460 This feature is intended to support working with legacy repositories
1461 which cannot be repaired without disruptive changes.
1464 The path to a sorted list of object names (i.e. one SHA-1 per
1465 line) that are known to be broken in a non-fatal way and should
1466 be ignored. This feature is useful when an established project
1467 should be accepted despite early commits containing errors that
1468 can be safely ignored such as invalid committer email addresses.
1469 Note: corrupt objects cannot be skipped with this setting.
1471 gc.aggressiveDepth::
1472 The depth parameter used in the delta compression
1473 algorithm used by 'git gc --aggressive'. This defaults
1476 gc.aggressiveWindow::
1477 The window size parameter used in the delta compression
1478 algorithm used by 'git gc --aggressive'. This defaults
1482 When there are approximately more than this many loose
1483 objects in the repository, `git gc --auto` will pack them.
1484 Some Porcelain commands use this command to perform a
1485 light-weight garbage collection from time to time. The
1486 default value is 6700. Setting this to 0 disables it.
1489 When there are more than this many packs that are not
1490 marked with `*.keep` file in the repository, `git gc
1491 --auto` consolidates them into one larger pack. The
1492 default value is 50. Setting this to 0 disables it.
1495 Make `git gc --auto` return immediately and run in background
1496 if the system supports it. Default is true.
1499 If the file gc.log exists, then `git gc --auto` won't run
1500 unless that file is more than 'gc.logExpiry' old. Default is
1501 "1.day". See `gc.pruneExpire` for more ways to specify its
1505 Running `git pack-refs` in a repository renders it
1506 unclonable by Git versions prior to 1.5.1.2 over dumb
1507 transports such as HTTP. This variable determines whether
1508 'git gc' runs `git pack-refs`. This can be set to `notbare`
1509 to enable it within all non-bare repos or it can be set to a
1510 boolean value. The default is `true`.
1513 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1514 Override the grace period with this config variable. The value
1515 "now" may be used to disable this grace period and always prune
1516 unreachable objects immediately, or "never" may be used to
1517 suppress pruning. This feature helps prevent corruption when
1518 'git gc' runs concurrently with another process writing to the
1519 repository; see the "NOTES" section of linkgit:git-gc[1].
1521 gc.worktreePruneExpire::
1522 When 'git gc' is run, it calls
1523 'git worktree prune --expire 3.months.ago'.
1524 This config variable can be used to set a different grace
1525 period. The value "now" may be used to disable the grace
1526 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1527 may be used to suppress pruning.
1530 gc.<pattern>.reflogExpire::
1531 'git reflog expire' removes reflog entries older than
1532 this time; defaults to 90 days. The value "now" expires all
1533 entries immediately, and "never" suppresses expiration
1534 altogether. With "<pattern>" (e.g.
1535 "refs/stash") in the middle the setting applies only to
1536 the refs that match the <pattern>.
1538 gc.reflogExpireUnreachable::
1539 gc.<pattern>.reflogExpireUnreachable::
1540 'git reflog expire' removes reflog entries older than
1541 this time and are not reachable from the current tip;
1542 defaults to 30 days. The value "now" expires all entries
1543 immediately, and "never" suppresses expiration altogether.
1544 With "<pattern>" (e.g. "refs/stash")
1545 in the middle, the setting applies only to the refs that
1546 match the <pattern>.
1549 Records of conflicted merge you resolved earlier are
1550 kept for this many days when 'git rerere gc' is run.
1551 The default is 60 days. See linkgit:git-rerere[1].
1553 gc.rerereUnresolved::
1554 Records of conflicted merge you have not resolved are
1555 kept for this many days when 'git rerere gc' is run.
1556 The default is 15 days. See linkgit:git-rerere[1].
1558 gitcvs.commitMsgAnnotation::
1559 Append this string to each commit message. Set to empty string
1560 to disable this feature. Defaults to "via git-CVS emulator".
1563 Whether the CVS server interface is enabled for this repository.
1564 See linkgit:git-cvsserver[1].
1567 Path to a log file where the CVS server interface well... logs
1568 various stuff. See linkgit:git-cvsserver[1].
1570 gitcvs.usecrlfattr::
1571 If true, the server will look up the end-of-line conversion
1572 attributes for files to determine the `-k` modes to use. If
1573 the attributes force Git to treat a file as text,
1574 the `-k` mode will be left blank so CVS clients will
1575 treat it as text. If they suppress text conversion, the file
1576 will be set with '-kb' mode, which suppresses any newline munging
1577 the client might otherwise do. If the attributes do not allow
1578 the file type to be determined, then `gitcvs.allBinary` is
1579 used. See linkgit:gitattributes[5].
1582 This is used if `gitcvs.usecrlfattr` does not resolve
1583 the correct '-kb' mode to use. If true, all
1584 unresolved files are sent to the client in
1585 mode '-kb'. This causes the client to treat them
1586 as binary files, which suppresses any newline munging it
1587 otherwise might do. Alternatively, if it is set to "guess",
1588 then the contents of the file are examined to decide if
1589 it is binary, similar to `core.autocrlf`.
1592 Database used by git-cvsserver to cache revision information
1593 derived from the Git repository. The exact meaning depends on the
1594 used database driver, for SQLite (which is the default driver) this
1595 is a filename. Supports variable substitution (see
1596 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1597 Default: '%Ggitcvs.%m.sqlite'
1600 Used Perl DBI driver. You can specify any available driver
1601 for this here, but it might not work. git-cvsserver is tested
1602 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1603 reported *not* to work with 'DBD::mysql'. Experimental feature.
1604 May not contain double colons (`:`). Default: 'SQLite'.
1605 See linkgit:git-cvsserver[1].
1607 gitcvs.dbUser, gitcvs.dbPass::
1608 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1609 since SQLite has no concept of database users and/or passwords.
1610 'gitcvs.dbUser' supports variable substitution (see
1611 linkgit:git-cvsserver[1] for details).
1613 gitcvs.dbTableNamePrefix::
1614 Database table name prefix. Prepended to the names of any
1615 database tables used, allowing a single database to be used
1616 for several repositories. Supports variable substitution (see
1617 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1618 characters will be replaced with underscores.
1620 All gitcvs variables except for `gitcvs.usecrlfattr` and
1621 `gitcvs.allBinary` can also be specified as
1622 'gitcvs.<access_method>.<varname>' (where 'access_method'
1623 is one of "ext" and "pserver") to make them apply only for the given
1627 gitweb.description::
1630 See linkgit:gitweb[1] for description.
1638 gitweb.remote_heads::
1641 See linkgit:gitweb.conf[5] for description.
1644 If set to true, enable `-n` option by default.
1647 Set the default matching behavior. Using a value of 'basic', 'extended',
1648 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1649 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1650 value 'default' will return to the default matching behavior.
1652 grep.extendedRegexp::
1653 If set to true, enable `--extended-regexp` option by default. This
1654 option is ignored when the `grep.patternType` option is set to a value
1655 other than 'default'.
1658 Number of grep worker threads to use.
1659 See `grep.threads` in linkgit:git-grep[1] for more information.
1661 grep.fallbackToNoIndex::
1662 If set to true, fall back to git grep --no-index if git grep
1663 is executed outside of a git repository. Defaults to false.
1666 Use this custom program instead of "`gpg`" found on `$PATH` when
1667 making or verifying a PGP signature. The program must support the
1668 same command-line interface as GPG, namely, to verify a detached
1669 signature, "`gpg --verify $file - <$signature`" is run, and the
1670 program is expected to signal a good signature by exiting with
1671 code 0, and to generate an ASCII-armored detached signature, the
1672 standard input of "`gpg -bsau $key`" is fed with the contents to be
1673 signed, and the program is expected to send the result to its
1676 gui.commitMsgWidth::
1677 Defines how wide the commit message window is in the
1678 linkgit:git-gui[1]. "75" is the default.
1681 Specifies how many context lines should be used in calls to diff
1682 made by the linkgit:git-gui[1]. The default is "5".
1684 gui.displayUntracked::
1685 Determines if linkgit:git-gui[1] shows untracked files
1686 in the file list. The default is "true".
1689 Specifies the default encoding to use for displaying of
1690 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1691 It can be overridden by setting the 'encoding' attribute
1692 for relevant files (see linkgit:gitattributes[5]).
1693 If this option is not set, the tools default to the
1696 gui.matchTrackingBranch::
1697 Determines if new branches created with linkgit:git-gui[1] should
1698 default to tracking remote branches with matching names or
1699 not. Default: "false".
1701 gui.newBranchTemplate::
1702 Is used as suggested name when creating new branches using the
1705 gui.pruneDuringFetch::
1706 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1707 performing a fetch. The default value is "false".
1710 Determines if linkgit:git-gui[1] should trust the file modification
1711 timestamp or not. By default the timestamps are not trusted.
1713 gui.spellingDictionary::
1714 Specifies the dictionary used for spell checking commit messages in
1715 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1719 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1720 location detection. It makes blame significantly faster on huge
1721 repositories at the expense of less thorough copy detection.
1723 gui.copyBlameThreshold::
1724 Specifies the threshold to use in 'git gui blame' original location
1725 detection, measured in alphanumeric characters. See the
1726 linkgit:git-blame[1] manual for more information on copy detection.
1728 gui.blamehistoryctx::
1729 Specifies the radius of history context in days to show in
1730 linkgit:gitk[1] for the selected commit, when the `Show History
1731 Context` menu item is invoked from 'git gui blame'. If this
1732 variable is set to zero, the whole history is shown.
1734 guitool.<name>.cmd::
1735 Specifies the shell command line to execute when the corresponding item
1736 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1737 mandatory for every tool. The command is executed from the root of
1738 the working directory, and in the environment it receives the name of
1739 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1740 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1741 the head is detached, 'CUR_BRANCH' is empty).
1743 guitool.<name>.needsFile::
1744 Run the tool only if a diff is selected in the GUI. It guarantees
1745 that 'FILENAME' is not empty.
1747 guitool.<name>.noConsole::
1748 Run the command silently, without creating a window to display its
1751 guitool.<name>.noRescan::
1752 Don't rescan the working directory for changes after the tool
1755 guitool.<name>.confirm::
1756 Show a confirmation dialog before actually running the tool.
1758 guitool.<name>.argPrompt::
1759 Request a string argument from the user, and pass it to the tool
1760 through the `ARGS` environment variable. Since requesting an
1761 argument implies confirmation, the 'confirm' option has no effect
1762 if this is enabled. If the option is set to 'true', 'yes', or '1',
1763 the dialog uses a built-in generic prompt; otherwise the exact
1764 value of the variable is used.
1766 guitool.<name>.revPrompt::
1767 Request a single valid revision from the user, and set the
1768 `REVISION` environment variable. In other aspects this option
1769 is similar to 'argPrompt', and can be used together with it.
1771 guitool.<name>.revUnmerged::
1772 Show only unmerged branches in the 'revPrompt' subdialog.
1773 This is useful for tools similar to merge or rebase, but not
1774 for things like checkout or reset.
1776 guitool.<name>.title::
1777 Specifies the title to use for the prompt dialog. The default
1780 guitool.<name>.prompt::
1781 Specifies the general prompt string to display at the top of
1782 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1783 The default value includes the actual command.
1786 Specify the browser that will be used to display help in the
1787 'web' format. See linkgit:git-help[1].
1790 Override the default help format used by linkgit:git-help[1].
1791 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1792 the default. 'web' and 'html' are the same.
1795 Automatically correct and execute mistyped commands after
1796 waiting for the given number of deciseconds (0.1 sec). If more
1797 than one command can be deduced from the entered text, nothing
1798 will be executed. If the value of this option is negative,
1799 the corrected command will be executed immediately. If the
1800 value is 0 - the command will be just shown but not executed.
1801 This is the default.
1804 Specify the path where the HTML documentation resides. File system paths
1805 and URLs are supported. HTML pages will be prefixed with this path when
1806 help is displayed in the 'web' format. This defaults to the documentation
1807 path of your Git installation.
1810 Override the HTTP proxy, normally configured using the 'http_proxy',
1811 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1812 addition to the syntax understood by curl, it is possible to specify a
1813 proxy string with a user name but no password, in which case git will
1814 attempt to acquire one in the same way it does for other credentials. See
1815 linkgit:gitcredentials[7] for more information. The syntax thus is
1816 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1817 on a per-remote basis; see remote.<name>.proxy
1819 http.proxyAuthMethod::
1820 Set the method with which to authenticate against the HTTP proxy. This
1821 only takes effect if the configured proxy string contains a user name part
1822 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1823 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1824 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1825 variable. Possible values are:
1828 * `anyauth` - Automatically pick a suitable authentication method. It is
1829 assumed that the proxy answers an unauthenticated request with a 407
1830 status code and one or more Proxy-authenticate headers with supported
1831 authentication methods. This is the default.
1832 * `basic` - HTTP Basic authentication
1833 * `digest` - HTTP Digest authentication; this prevents the password from being
1834 transmitted to the proxy in clear text
1835 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1837 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1841 Attempt authentication without seeking a username or password. This
1842 can be used to attempt GSS-Negotiate authentication without specifying
1843 a username in the URL, as libcurl normally requires a username for
1847 Control GSSAPI credential delegation. The delegation is disabled
1848 by default in libcurl since version 7.21.7. Set parameter to tell
1849 the server what it is allowed to delegate when it comes to user
1850 credentials. Used with GSS/kerberos. Possible values are:
1853 * `none` - Don't allow any delegation.
1854 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1855 Kerberos service ticket, which is a matter of realm policy.
1856 * `always` - Unconditionally allow the server to delegate.
1861 Pass an additional HTTP header when communicating with a server. If
1862 more than one such entry exists, all of them are added as extra
1863 headers. To allow overriding the settings inherited from the system
1864 config, an empty value will reset the extra headers to the empty list.
1867 The pathname of a file containing previously stored cookie lines,
1868 which should be used
1869 in the Git http session, if they match the server. The file format
1870 of the file to read cookies from should be plain HTTP headers or
1871 the Netscape/Mozilla cookie file format (see `curl(1)`).
1872 NOTE that the file specified with http.cookieFile is used only as
1873 input unless http.saveCookies is set.
1876 If set, store cookies received during requests to the file specified by
1877 http.cookieFile. Has no effect if http.cookieFile is unset.
1880 The SSL version to use when negotiating an SSL connection, if you
1881 want to force the default. The available and default version
1882 depend on whether libcurl was built against NSS or OpenSSL and the
1883 particular configuration of the crypto library in use. Internally
1884 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1885 documentation for more details on the format of this option and
1886 for the ssl version supported. Actually the possible values of
1897 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1898 To force git to use libcurl's default ssl version and ignore any
1899 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1902 http.sslCipherList::
1903 A list of SSL ciphers to use when negotiating an SSL connection.
1904 The available ciphers depend on whether libcurl was built against
1905 NSS or OpenSSL and the particular configuration of the crypto
1906 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1907 option; see the libcurl documentation for more details on the format
1910 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1911 To force git to use libcurl's default cipher list and ignore any
1912 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1916 Whether to verify the SSL certificate when fetching or pushing
1917 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1921 File containing the SSL certificate when fetching or pushing
1922 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1926 File containing the SSL private key when fetching or pushing
1927 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1930 http.sslCertPasswordProtected::
1931 Enable Git's password prompt for the SSL certificate. Otherwise
1932 OpenSSL will prompt the user, possibly many times, if the
1933 certificate or private key is encrypted. Can be overridden by the
1934 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1937 File containing the certificates to verify the peer with when
1938 fetching or pushing over HTTPS. Can be overridden by the
1939 `GIT_SSL_CAINFO` environment variable.
1942 Path containing files with the CA certificates to verify the peer
1943 with when fetching or pushing over HTTPS. Can be overridden
1944 by the `GIT_SSL_CAPATH` environment variable.
1947 Public key of the https service. It may either be the filename of
1948 a PEM or DER encoded public key file or a string starting with
1949 'sha256//' followed by the base64 encoded sha256 hash of the
1950 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1951 exit with an error if this option is set but not supported by
1955 Attempt to use AUTH SSL/TLS and encrypted data transfers
1956 when connecting via regular FTP protocol. This might be needed
1957 if the FTP server requires it for security reasons or you wish
1958 to connect securely whenever remote FTP server supports it.
1959 Default is false since it might trigger certificate verification
1960 errors on misconfigured servers.
1963 How many HTTP requests to launch in parallel. Can be overridden
1964 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1967 The number of curl sessions (counted across slots) to be kept across
1968 requests. They will not be ended with curl_easy_cleanup() until
1969 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1970 value will be capped at 1. Defaults to 1.
1973 Maximum size in bytes of the buffer used by smart HTTP
1974 transports when POSTing data to the remote system.
1975 For requests larger than this buffer size, HTTP/1.1 and
1976 Transfer-Encoding: chunked is used to avoid creating a
1977 massive pack file locally. Default is 1 MiB, which is
1978 sufficient for most requests.
1980 http.lowSpeedLimit, http.lowSpeedTime::
1981 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1982 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1983 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1984 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1987 A boolean which disables using of EPSV ftp command by curl.
1988 This can helpful with some "poor" ftp servers which don't
1989 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1990 environment variable. Default is false (curl will use EPSV).
1993 The HTTP USER_AGENT string presented to an HTTP server. The default
1994 value represents the version of the client Git such as git/1.7.1.
1995 This option allows you to override this value to a more common value
1996 such as Mozilla/4.0. This may be necessary, for instance, if
1997 connecting through a firewall that restricts HTTP connections to a set
1998 of common USER_AGENT strings (but not including those like git/1.7.1).
1999 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2001 http.followRedirects::
2002 Whether git should follow HTTP redirects. If set to `true`, git
2003 will transparently follow any redirect issued by a server it
2004 encounters. If set to `false`, git will treat all redirects as
2005 errors. If set to `initial`, git will follow redirects only for
2006 the initial request to a remote, but not for subsequent
2007 follow-up HTTP requests. Since git uses the redirected URL as
2008 the base for the follow-up requests, this is generally
2009 sufficient. The default is `initial`.
2012 Any of the http.* options above can be applied selectively to some URLs.
2013 For a config key to match a URL, each element of the config key is
2014 compared to that of the URL, in the following order:
2017 . Scheme (e.g., `https` in `https://example.com/`). This field
2018 must match exactly between the config key and the URL.
2020 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2021 This field must match between the config key and the URL. It is
2022 possible to specify a `*` as part of the host name to match all subdomains
2023 at this level. `https://*.example.com/` for example would match
2024 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2026 . Port number (e.g., `8080` in `http://example.com:8080/`).
2027 This field must match exactly between the config key and the URL.
2028 Omitted port numbers are automatically converted to the correct
2029 default for the scheme before matching.
2031 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2032 path field of the config key must match the path field of the URL
2033 either exactly or as a prefix of slash-delimited path elements. This means
2034 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2035 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2036 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2037 key with just path `foo/`).
2039 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2040 the config key has a user name it must match the user name in the
2041 URL exactly. If the config key does not have a user name, that
2042 config key will match a URL with any user name (including none),
2043 but at a lower precedence than a config key with a user name.
2046 The list above is ordered by decreasing precedence; a URL that matches
2047 a config key's path is preferred to one that matches its user name. For example,
2048 if the URL is `https://user@example.com/foo/bar` a config key match of
2049 `https://example.com/foo` will be preferred over a config key match of
2050 `https://user@example.com`.
2052 All URLs are normalized before attempting any matching (the password part,
2053 if embedded in the URL, is always ignored for matching purposes) so that
2054 equivalent URLs that are simply spelled differently will match properly.
2055 Environment variable settings always override any matches. The URLs that are
2056 matched against are those given directly to Git commands. This means any URLs
2057 visited as a result of a redirection do not participate in matching.
2060 Depending on the value of the environment variables `GIT_SSH` or
2061 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2062 auto-detects whether to adjust its command-line parameters for use
2063 with plink or tortoiseplink, as opposed to the default (OpenSSH).
2065 The config variable `ssh.variant` can be set to override this auto-detection;
2066 valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2067 will be treated as normal ssh. This setting can be overridden via the
2068 environment variable `GIT_SSH_VARIANT`.
2070 i18n.commitEncoding::
2071 Character encoding the commit messages are stored in; Git itself
2072 does not care per se, but this information is necessary e.g. when
2073 importing commits from emails or in the gitk graphical history
2074 browser (and possibly at other places in the future or in other
2075 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2077 i18n.logOutputEncoding::
2078 Character encoding the commit messages are converted to when
2079 running 'git log' and friends.
2082 The configuration variables in the 'imap' section are described
2083 in linkgit:git-imap-send[1].
2086 Specify the version with which new index files should be
2087 initialized. This does not affect existing repositories.
2090 Specify the directory from which templates will be copied.
2091 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2094 Specify the program that will be used to browse your working
2095 repository in gitweb. See linkgit:git-instaweb[1].
2098 The HTTP daemon command-line to start gitweb on your working
2099 repository. See linkgit:git-instaweb[1].
2102 If true the web server started by linkgit:git-instaweb[1] will
2103 be bound to the local IP (127.0.0.1).
2105 instaweb.modulePath::
2106 The default module path for linkgit:git-instaweb[1] to use
2107 instead of /usr/lib/apache2/modules. Only used if httpd
2111 The port number to bind the gitweb httpd to. See
2112 linkgit:git-instaweb[1].
2114 interactive.singleKey::
2115 In interactive commands, allow the user to provide one-letter
2116 input with a single key (i.e., without hitting enter).
2117 Currently this is used by the `--patch` mode of
2118 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2119 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2120 setting is silently ignored if portable keystroke input
2121 is not available; requires the Perl module Term::ReadKey.
2123 interactive.diffFilter::
2124 When an interactive command (such as `git add --patch`) shows
2125 a colorized diff, git will pipe the diff through the shell
2126 command defined by this configuration variable. The command may
2127 mark up the diff further for human consumption, provided that it
2128 retains a one-to-one correspondence with the lines in the
2129 original diff. Defaults to disabled (no filtering).
2132 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2133 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2134 override this option with `--no-abbrev-commit`.
2137 Set the default date-time mode for the 'log' command.
2138 Setting a value for log.date is similar to using 'git log''s
2139 `--date` option. See linkgit:git-log[1] for details.
2142 Print out the ref names of any commits that are shown by the log
2143 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2144 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2145 specified, the full ref name (including prefix) will be printed.
2146 If 'auto' is specified, then if the output is going to a terminal,
2147 the ref names are shown as if 'short' were given, otherwise no ref
2148 names are shown. This is the same as the `--decorate` option
2152 If `true`, `git log` will act as if the `--follow` option was used when
2153 a single <path> is given. This has the same limitations as `--follow`,
2154 i.e. it cannot be used to follow multiple files and does not work well
2155 on non-linear history.
2158 A list of colors, separated by commas, that can be used to draw
2159 history lines in `git log --graph`.
2162 If true, the initial commit will be shown as a big creation event.
2163 This is equivalent to a diff against an empty tree.
2164 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2165 normally hide the root commit will now show it. True by default.
2168 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2169 linkgit:git-whatchanged[1] assume `--show-signature`.
2172 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2173 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2176 If true, makes linkgit:git-mailinfo[1] (and therefore
2177 linkgit:git-am[1]) act by default as if the --scissors option
2178 was provided on the command-line. When active, this features
2179 removes everything from the message body before a scissors
2180 line (i.e. consisting mainly of ">8", "8<" and "-").
2183 The location of an augmenting mailmap file. The default
2184 mailmap, located in the root of the repository, is loaded
2185 first, then the mailmap file pointed to by this variable.
2186 The location of the mailmap file may be in a repository
2187 subdirectory, or somewhere outside of the repository itself.
2188 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2191 Like `mailmap.file`, but consider the value as a reference to a
2192 blob in the repository. If both `mailmap.file` and
2193 `mailmap.blob` are given, both are parsed, with entries from
2194 `mailmap.file` taking precedence. In a bare repository, this
2195 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2199 Specify the programs that may be used to display help in the
2200 'man' format. See linkgit:git-help[1].
2203 Specify the command to invoke the specified man viewer. The
2204 specified command is evaluated in shell with the man page
2205 passed as argument. (See linkgit:git-help[1].)
2208 Override the path for the given tool that may be used to
2209 display help in the 'man' format. See linkgit:git-help[1].
2211 include::merge-config.txt[]
2213 mergetool.<tool>.path::
2214 Override the path for the given tool. This is useful in case
2215 your tool is not in the PATH.
2217 mergetool.<tool>.cmd::
2218 Specify the command to invoke the specified merge tool. The
2219 specified command is evaluated in shell with the following
2220 variables available: 'BASE' is the name of a temporary file
2221 containing the common base of the files to be merged, if available;
2222 'LOCAL' is the name of a temporary file containing the contents of
2223 the file on the current branch; 'REMOTE' is the name of a temporary
2224 file containing the contents of the file from the branch being
2225 merged; 'MERGED' contains the name of the file to which the merge
2226 tool should write the results of a successful merge.
2228 mergetool.<tool>.trustExitCode::
2229 For a custom merge command, specify whether the exit code of
2230 the merge command can be used to determine whether the merge was
2231 successful. If this is not set to true then the merge target file
2232 timestamp is checked and the merge assumed to have been successful
2233 if the file has been updated, otherwise the user is prompted to
2234 indicate the success of the merge.
2236 mergetool.meld.hasOutput::
2237 Older versions of `meld` do not support the `--output` option.
2238 Git will attempt to detect whether `meld` supports `--output`
2239 by inspecting the output of `meld --help`. Configuring
2240 `mergetool.meld.hasOutput` will make Git skip these checks and
2241 use the configured value instead. Setting `mergetool.meld.hasOutput`
2242 to `true` tells Git to unconditionally use the `--output` option,
2243 and `false` avoids using `--output`.
2245 mergetool.keepBackup::
2246 After performing a merge, the original file with conflict markers
2247 can be saved as a file with a `.orig` extension. If this variable
2248 is set to `false` then this file is not preserved. Defaults to
2249 `true` (i.e. keep the backup files).
2251 mergetool.keepTemporaries::
2252 When invoking a custom merge tool, Git uses a set of temporary
2253 files to pass to the tool. If the tool returns an error and this
2254 variable is set to `true`, then these temporary files will be
2255 preserved, otherwise they will be removed after the tool has
2256 exited. Defaults to `false`.
2258 mergetool.writeToTemp::
2259 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2260 conflicting files in the worktree by default. Git will attempt
2261 to use a temporary directory for these files when set `true`.
2262 Defaults to `false`.
2265 Prompt before each invocation of the merge resolution program.
2267 notes.mergeStrategy::
2268 Which merge strategy to choose by default when resolving notes
2269 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2270 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2271 section of linkgit:git-notes[1] for more information on each strategy.
2273 notes.<name>.mergeStrategy::
2274 Which merge strategy to choose when doing a notes merge into
2275 refs/notes/<name>. This overrides the more general
2276 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2277 linkgit:git-notes[1] for more information on the available strategies.
2280 The (fully qualified) refname from which to show notes when
2281 showing commit messages. The value of this variable can be set
2282 to a glob, in which case notes from all matching refs will be
2283 shown. You may also specify this configuration variable
2284 several times. A warning will be issued for refs that do not
2285 exist, but a glob that does not match any refs is silently
2288 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2289 environment variable, which must be a colon separated list of refs or
2292 The effective value of "core.notesRef" (possibly overridden by
2293 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2296 notes.rewrite.<command>::
2297 When rewriting commits with <command> (currently `amend` or
2298 `rebase`) and this variable is set to `true`, Git
2299 automatically copies your notes from the original to the
2300 rewritten commit. Defaults to `true`, but see
2301 "notes.rewriteRef" below.
2304 When copying notes during a rewrite (see the
2305 "notes.rewrite.<command>" option), determines what to do if
2306 the target commit already has a note. Must be one of
2307 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2308 Defaults to `concatenate`.
2310 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2311 environment variable.
2314 When copying notes during a rewrite, specifies the (fully
2315 qualified) ref whose notes should be copied. The ref may be a
2316 glob, in which case notes in all matching refs will be copied.
2317 You may also specify this configuration several times.
2319 Does not have a default value; you must configure this variable to
2320 enable note rewriting. Set it to `refs/notes/commits` to enable
2321 rewriting for the default commit notes.
2323 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2324 environment variable, which must be a colon separated list of refs or
2328 The size of the window used by linkgit:git-pack-objects[1] when no
2329 window size is given on the command line. Defaults to 10.
2332 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2333 maximum depth is given on the command line. Defaults to 50.
2336 The maximum size of memory that is consumed by each thread
2337 in linkgit:git-pack-objects[1] for pack window memory when
2338 no limit is given on the command line. The value can be
2339 suffixed with "k", "m", or "g". When left unconfigured (or
2340 set explicitly to 0), there will be no limit.
2343 An integer -1..9, indicating the compression level for objects
2344 in a pack file. -1 is the zlib default. 0 means no
2345 compression, and 1..9 are various speed/size tradeoffs, 9 being
2346 slowest. If not set, defaults to core.compression. If that is
2347 not set, defaults to -1, the zlib default, which is "a default
2348 compromise between speed and compression (currently equivalent
2351 Note that changing the compression level will not automatically recompress
2352 all existing objects. You can force recompression by passing the -F option
2353 to linkgit:git-repack[1].
2355 pack.deltaCacheSize::
2356 The maximum memory in bytes used for caching deltas in
2357 linkgit:git-pack-objects[1] before writing them out to a pack.
2358 This cache is used to speed up the writing object phase by not
2359 having to recompute the final delta result once the best match
2360 for all objects is found. Repacking large repositories on machines
2361 which are tight with memory might be badly impacted by this though,
2362 especially if this cache pushes the system into swapping.
2363 A value of 0 means no limit. The smallest size of 1 byte may be
2364 used to virtually disable this cache. Defaults to 256 MiB.
2366 pack.deltaCacheLimit::
2367 The maximum size of a delta, that is cached in
2368 linkgit:git-pack-objects[1]. This cache is used to speed up the
2369 writing object phase by not having to recompute the final delta
2370 result once the best match for all objects is found. Defaults to 1000.
2373 Specifies the number of threads to spawn when searching for best
2374 delta matches. This requires that linkgit:git-pack-objects[1]
2375 be compiled with pthreads otherwise this option is ignored with a
2376 warning. This is meant to reduce packing time on multiprocessor
2377 machines. The required amount of memory for the delta search window
2378 is however multiplied by the number of threads.
2379 Specifying 0 will cause Git to auto-detect the number of CPU's
2380 and set the number of threads accordingly.
2383 Specify the default pack index version. Valid values are 1 for
2384 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2385 the new pack index with capabilities for packs larger than 4 GB
2386 as well as proper protection against the repacking of corrupted
2387 packs. Version 2 is the default. Note that version 2 is enforced
2388 and this config option ignored whenever the corresponding pack is
2391 If you have an old Git that does not understand the version 2 `*.idx` file,
2392 cloning or fetching over a non native protocol (e.g. "http")
2393 that will copy both `*.pack` file and corresponding `*.idx` file from the
2394 other side may give you a repository that cannot be accessed with your
2395 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2396 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2399 pack.packSizeLimit::
2400 The maximum size of a pack. This setting only affects
2401 packing to a file when repacking, i.e. the git:// protocol
2402 is unaffected. It can be overridden by the `--max-pack-size`
2403 option of linkgit:git-repack[1]. Reaching this limit results
2404 in the creation of multiple packfiles; which in turn prevents
2405 bitmaps from being created.
2406 The minimum size allowed is limited to 1 MiB.
2407 The default is unlimited.
2408 Common unit suffixes of 'k', 'm', or 'g' are
2412 When true, git will use pack bitmaps (if available) when packing
2413 to stdout (e.g., during the server side of a fetch). Defaults to
2414 true. You should not generally need to turn this off unless
2415 you are debugging pack bitmaps.
2417 pack.writeBitmaps (deprecated)::
2418 This is a deprecated synonym for `repack.writeBitmaps`.
2420 pack.writeBitmapHashCache::
2421 When true, git will include a "hash cache" section in the bitmap
2422 index (if one is written). This cache can be used to feed git's
2423 delta heuristics, potentially leading to better deltas between
2424 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2425 between an older, bitmapped pack and objects that have been
2426 pushed since the last gc). The downside is that it consumes 4
2427 bytes per object of disk space, and that JGit's bitmap
2428 implementation does not understand it, causing it to complain if
2429 Git and JGit are used on the same repository. Defaults to false.
2432 If the value is boolean, turns on or off pagination of the
2433 output of a particular Git subcommand when writing to a tty.
2434 Otherwise, turns on pagination for the subcommand using the
2435 pager specified by the value of `pager.<cmd>`. If `--paginate`
2436 or `--no-pager` is specified on the command line, it takes
2437 precedence over this option. To disable pagination for all
2438 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2441 Alias for a --pretty= format string, as specified in
2442 linkgit:git-log[1]. Any aliases defined here can be used just
2443 as the built-in pretty formats could. For example,
2444 running `git config pretty.changelog "format:* %H %s"`
2445 would cause the invocation `git log --pretty=changelog`
2446 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2447 Note that an alias with the same name as a built-in format
2448 will be silently ignored.
2451 If set, provide a user defined default policy for all protocols which
2452 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2453 if unset, known-safe protocols (http, https, git, ssh, file) have a
2454 default policy of `always`, known-dangerous protocols (ext) have a
2455 default policy of `never`, and all other protocols have a default
2456 policy of `user`. Supported policies:
2460 * `always` - protocol is always able to be used.
2462 * `never` - protocol is never able to be used.
2464 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2465 either unset or has a value of 1. This policy should be used when you want a
2466 protocol to be directly usable by the user but don't want it used by commands which
2467 execute clone/fetch/push commands without user input, e.g. recursive
2468 submodule initialization.
2472 protocol.<name>.allow::
2473 Set a policy to be used by protocol `<name>` with clone/fetch/push
2474 commands. See `protocol.allow` above for the available policies.
2476 The protocol names currently used by git are:
2479 - `file`: any local file-based path (including `file://` URLs,
2482 - `git`: the anonymous git protocol over a direct TCP
2483 connection (or proxy, if configured)
2485 - `ssh`: git over ssh (including `host:path` syntax,
2488 - `http`: git over http, both "smart http" and "dumb http".
2489 Note that this does _not_ include `https`; if you want to configure
2490 both, you must do so individually.
2492 - any external helpers are named by their protocol (e.g., use
2493 `hg` to allow the `git-remote-hg` helper)
2497 By default, Git does not create an extra merge commit when merging
2498 a commit that is a descendant of the current commit. Instead, the
2499 tip of the current branch is fast-forwarded. When set to `false`,
2500 this variable tells Git to create an extra merge commit in such
2501 a case (equivalent to giving the `--no-ff` option from the command
2502 line). When set to `only`, only such fast-forward merges are
2503 allowed (equivalent to giving the `--ff-only` option from the
2504 command line). This setting overrides `merge.ff` when pulling.
2507 When true, rebase branches on top of the fetched branch, instead
2508 of merging the default branch from the default remote when "git
2509 pull" is run. See "branch.<name>.rebase" for setting this on a
2512 When preserve, also pass `--preserve-merges` along to 'git rebase'
2513 so that locally committed merge commits will not be flattened
2514 by running 'git pull'.
2516 When the value is `interactive`, the rebase is run in interactive mode.
2518 *NOTE*: this is a possibly dangerous operation; do *not* use
2519 it unless you understand the implications (see linkgit:git-rebase[1]
2523 The default merge strategy to use when pulling multiple branches
2527 The default merge strategy to use when pulling a single branch.
2530 Defines the action `git push` should take if no refspec is
2531 explicitly given. Different values are well-suited for
2532 specific workflows; for instance, in a purely central workflow
2533 (i.e. the fetch source is equal to the push destination),
2534 `upstream` is probably what you want. Possible values are:
2538 * `nothing` - do not push anything (error out) unless a refspec is
2539 explicitly given. This is primarily meant for people who want to
2540 avoid mistakes by always being explicit.
2542 * `current` - push the current branch to update a branch with the same
2543 name on the receiving end. Works in both central and non-central
2546 * `upstream` - push the current branch back to the branch whose
2547 changes are usually integrated into the current branch (which is
2548 called `@{upstream}`). This mode only makes sense if you are
2549 pushing to the same repository you would normally pull from
2550 (i.e. central workflow).
2552 * `tracking` - This is a deprecated synonym for `upstream`.
2554 * `simple` - in centralized workflow, work like `upstream` with an
2555 added safety to refuse to push if the upstream branch's name is
2556 different from the local one.
2558 When pushing to a remote that is different from the remote you normally
2559 pull from, work as `current`. This is the safest option and is suited
2562 This mode has become the default in Git 2.0.
2564 * `matching` - push all branches having the same name on both ends.
2565 This makes the repository you are pushing to remember the set of
2566 branches that will be pushed out (e.g. if you always push 'maint'
2567 and 'master' there and no other branches, the repository you push
2568 to will have these two branches, and your local 'maint' and
2569 'master' will be pushed there).
2571 To use this mode effectively, you have to make sure _all_ the
2572 branches you would push out are ready to be pushed out before
2573 running 'git push', as the whole point of this mode is to allow you
2574 to push all of the branches in one go. If you usually finish work
2575 on only one branch and push out the result, while other branches are
2576 unfinished, this mode is not for you. Also this mode is not
2577 suitable for pushing into a shared central repository, as other
2578 people may add new branches there, or update the tip of existing
2579 branches outside your control.
2581 This used to be the default, but not since Git 2.0 (`simple` is the
2587 If set to true enable `--follow-tags` option by default. You
2588 may override this configuration at time of push by specifying
2592 May be set to a boolean value, or the string 'if-asked'. A true
2593 value causes all pushes to be GPG signed, as if `--signed` is
2594 passed to linkgit:git-push[1]. The string 'if-asked' causes
2595 pushes to be signed if the server supports it, as if
2596 `--signed=if-asked` is passed to 'git push'. A false value may
2597 override a value from a lower-priority config file. An explicit
2598 command-line flag always overrides this config option.
2600 push.recurseSubmodules::
2601 Make sure all submodule commits used by the revisions to be pushed
2602 are available on a remote-tracking branch. If the value is 'check'
2603 then Git will verify that all submodule commits that changed in the
2604 revisions to be pushed are available on at least one remote of the
2605 submodule. If any commits are missing, the push will be aborted and
2606 exit with non-zero status. If the value is 'on-demand' then all
2607 submodules that changed in the revisions to be pushed will be
2608 pushed. If on-demand was not able to push all necessary revisions
2609 it will also be aborted and exit with non-zero status. If the value
2610 is 'no' then default behavior of ignoring submodules when pushing
2611 is retained. You may override this configuration at time of push by
2612 specifying '--recurse-submodules=check|on-demand|no'.
2615 Whether to show a diffstat of what changed upstream since the last
2616 rebase. False by default.
2619 If set to true enable `--autosquash` option by default.
2622 When set to true, automatically create a temporary stash
2623 before the operation begins, and apply it after the operation
2624 ends. This means that you can run rebase on a dirty worktree.
2625 However, use with care: the final stash application after a
2626 successful rebase might result in non-trivial conflicts.
2629 rebase.missingCommitsCheck::
2630 If set to "warn", git rebase -i will print a warning if some
2631 commits are removed (e.g. a line was deleted), however the
2632 rebase will still proceed. If set to "error", it will print
2633 the previous warning and stop the rebase, 'git rebase
2634 --edit-todo' can then be used to correct the error. If set to
2635 "ignore", no checking is done.
2636 To drop a commit without warning or error, use the `drop`
2637 command in the todo-list.
2638 Defaults to "ignore".
2640 rebase.instructionFormat::
2641 A format string, as specified in linkgit:git-log[1], to be used for
2642 the instruction list during an interactive rebase. The format will automatically
2643 have the long commit hash prepended to the format.
2645 receive.advertiseAtomic::
2646 By default, git-receive-pack will advertise the atomic push
2647 capability to its clients. If you don't want to advertise this
2648 capability, set this variable to false.
2650 receive.advertisePushOptions::
2651 When set to true, git-receive-pack will advertise the push options
2652 capability to its clients. False by default.
2655 By default, git-receive-pack will run "git-gc --auto" after
2656 receiving data from git-push and updating refs. You can stop
2657 it by setting this variable to false.
2659 receive.certNonceSeed::
2660 By setting this variable to a string, `git receive-pack`
2661 will accept a `git push --signed` and verifies it by using
2662 a "nonce" protected by HMAC using this string as a secret
2665 receive.certNonceSlop::
2666 When a `git push --signed` sent a push certificate with a
2667 "nonce" that was issued by a receive-pack serving the same
2668 repository within this many seconds, export the "nonce"
2669 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2670 hooks (instead of what the receive-pack asked the sending
2671 side to include). This may allow writing checks in
2672 `pre-receive` and `post-receive` a bit easier. Instead of
2673 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2674 that records by how many seconds the nonce is stale to
2675 decide if they want to accept the certificate, they only
2676 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2678 receive.fsckObjects::
2679 If it is set to true, git-receive-pack will check all received
2680 objects. It will abort in the case of a malformed object or a
2681 broken link. The result of an abort are only dangling objects.
2682 Defaults to false. If not set, the value of `transfer.fsckObjects`
2685 receive.fsck.<msg-id>::
2686 When `receive.fsckObjects` is set to true, errors can be switched
2687 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2688 setting where the `<msg-id>` is the fsck message ID and the value
2689 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2690 the error/warning with the message ID, e.g. "missingEmail: invalid
2691 author/committer line - missing email" means that setting
2692 `receive.fsck.missingEmail = ignore` will hide that issue.
2694 This feature is intended to support working with legacy repositories
2695 which would not pass pushing when `receive.fsckObjects = true`, allowing
2696 the host to accept repositories with certain known issues but still catch
2699 receive.fsck.skipList::
2700 The path to a sorted list of object names (i.e. one SHA-1 per
2701 line) that are known to be broken in a non-fatal way and should
2702 be ignored. This feature is useful when an established project
2703 should be accepted despite early commits containing errors that
2704 can be safely ignored such as invalid committer email addresses.
2705 Note: corrupt objects cannot be skipped with this setting.
2708 After receiving the pack from the client, `receive-pack` may
2709 produce no output (if `--quiet` was specified) while processing
2710 the pack, causing some networks to drop the TCP connection.
2711 With this option set, if `receive-pack` does not transmit
2712 any data in this phase for `receive.keepAlive` seconds, it will
2713 send a short keepalive packet. The default is 5 seconds; set
2714 to 0 to disable keepalives entirely.
2716 receive.unpackLimit::
2717 If the number of objects received in a push is below this
2718 limit then the objects will be unpacked into loose object
2719 files. However if the number of received objects equals or
2720 exceeds this limit then the received pack will be stored as
2721 a pack, after adding any missing delta bases. Storing the
2722 pack from a push can make the push operation complete faster,
2723 especially on slow filesystems. If not set, the value of
2724 `transfer.unpackLimit` is used instead.
2726 receive.maxInputSize::
2727 If the size of the incoming pack stream is larger than this
2728 limit, then git-receive-pack will error out, instead of
2729 accepting the pack file. If not set or set to 0, then the size
2732 receive.denyDeletes::
2733 If set to true, git-receive-pack will deny a ref update that deletes
2734 the ref. Use this to prevent such a ref deletion via a push.
2736 receive.denyDeleteCurrent::
2737 If set to true, git-receive-pack will deny a ref update that
2738 deletes the currently checked out branch of a non-bare repository.
2740 receive.denyCurrentBranch::
2741 If set to true or "refuse", git-receive-pack will deny a ref update
2742 to the currently checked out branch of a non-bare repository.
2743 Such a push is potentially dangerous because it brings the HEAD
2744 out of sync with the index and working tree. If set to "warn",
2745 print a warning of such a push to stderr, but allow the push to
2746 proceed. If set to false or "ignore", allow such pushes with no
2747 message. Defaults to "refuse".
2749 Another option is "updateInstead" which will update the working
2750 tree if pushing into the current branch. This option is
2751 intended for synchronizing working directories when one side is not easily
2752 accessible via interactive ssh (e.g. a live web site, hence the requirement
2753 that the working directory be clean). This mode also comes in handy when
2754 developing inside a VM to test and fix code on different Operating Systems.
2756 By default, "updateInstead" will refuse the push if the working tree or
2757 the index have any difference from the HEAD, but the `push-to-checkout`
2758 hook can be used to customize this. See linkgit:githooks[5].
2760 receive.denyNonFastForwards::
2761 If set to true, git-receive-pack will deny a ref update which is
2762 not a fast-forward. Use this to prevent such an update via a push,
2763 even if that push is forced. This configuration variable is
2764 set when initializing a shared repository.
2767 This variable is the same as `transfer.hideRefs`, but applies
2768 only to `receive-pack` (and so affects pushes, but not fetches).
2769 An attempt to update or delete a hidden ref by `git push` is
2772 receive.updateServerInfo::
2773 If set to true, git-receive-pack will run git-update-server-info
2774 after receiving data from git-push and updating refs.
2776 receive.shallowUpdate::
2777 If set to true, .git/shallow can be updated when new refs
2778 require new shallow roots. Otherwise those refs are rejected.
2780 remote.pushDefault::
2781 The remote to push to by default. Overrides
2782 `branch.<name>.remote` for all branches, and is overridden by
2783 `branch.<name>.pushRemote` for specific branches.
2786 The URL of a remote repository. See linkgit:git-fetch[1] or
2787 linkgit:git-push[1].
2789 remote.<name>.pushurl::
2790 The push URL of a remote repository. See linkgit:git-push[1].
2792 remote.<name>.proxy::
2793 For remotes that require curl (http, https and ftp), the URL to
2794 the proxy to use for that remote. Set to the empty string to
2795 disable proxying for that remote.
2797 remote.<name>.proxyAuthMethod::
2798 For remotes that require curl (http, https and ftp), the method to use for
2799 authenticating against the proxy in use (probably set in
2800 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2802 remote.<name>.fetch::
2803 The default set of "refspec" for linkgit:git-fetch[1]. See
2804 linkgit:git-fetch[1].
2806 remote.<name>.push::
2807 The default set of "refspec" for linkgit:git-push[1]. See
2808 linkgit:git-push[1].
2810 remote.<name>.mirror::
2811 If true, pushing to this remote will automatically behave
2812 as if the `--mirror` option was given on the command line.
2814 remote.<name>.skipDefaultUpdate::
2815 If true, this remote will be skipped by default when updating
2816 using linkgit:git-fetch[1] or the `update` subcommand of
2817 linkgit:git-remote[1].
2819 remote.<name>.skipFetchAll::
2820 If true, this remote will be skipped by default when updating
2821 using linkgit:git-fetch[1] or the `update` subcommand of
2822 linkgit:git-remote[1].
2824 remote.<name>.receivepack::
2825 The default program to execute on the remote side when pushing. See
2826 option --receive-pack of linkgit:git-push[1].
2828 remote.<name>.uploadpack::
2829 The default program to execute on the remote side when fetching. See
2830 option --upload-pack of linkgit:git-fetch-pack[1].
2832 remote.<name>.tagOpt::
2833 Setting this value to --no-tags disables automatic tag following when
2834 fetching from remote <name>. Setting it to --tags will fetch every
2835 tag from remote <name>, even if they are not reachable from remote
2836 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2837 override this setting. See options --tags and --no-tags of
2838 linkgit:git-fetch[1].
2841 Setting this to a value <vcs> will cause Git to interact with
2842 the remote with the git-remote-<vcs> helper.
2844 remote.<name>.prune::
2845 When set to true, fetching from this remote by default will also
2846 remove any remote-tracking references that no longer exist on the
2847 remote (as if the `--prune` option was given on the command line).
2848 Overrides `fetch.prune` settings, if any.
2851 The list of remotes which are fetched by "git remote update
2852 <group>". See linkgit:git-remote[1].
2854 repack.useDeltaBaseOffset::
2855 By default, linkgit:git-repack[1] creates packs that use
2856 delta-base offset. If you need to share your repository with
2857 Git older than version 1.4.4, either directly or via a dumb
2858 protocol such as http, then you need to set this option to
2859 "false" and repack. Access from old Git versions over the
2860 native protocol are unaffected by this option.
2862 repack.packKeptObjects::
2863 If set to true, makes `git repack` act as if
2864 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2865 details. Defaults to `false` normally, but `true` if a bitmap
2866 index is being written (either via `--write-bitmap-index` or
2867 `repack.writeBitmaps`).
2869 repack.writeBitmaps::
2870 When true, git will write a bitmap index when packing all
2871 objects to disk (e.g., when `git repack -a` is run). This
2872 index can speed up the "counting objects" phase of subsequent
2873 packs created for clones and fetches, at the cost of some disk
2874 space and extra time spent on the initial repack. This has
2875 no effect if multiple packfiles are created.
2879 When set to true, `git-rerere` updates the index with the
2880 resulting contents after it cleanly resolves conflicts using
2881 previously recorded resolution. Defaults to false.
2884 Activate recording of resolved conflicts, so that identical
2885 conflict hunks can be resolved automatically, should they be
2886 encountered again. By default, linkgit:git-rerere[1] is
2887 enabled if there is an `rr-cache` directory under the
2888 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2891 sendemail.identity::
2892 A configuration identity. When given, causes values in the
2893 'sendemail.<identity>' subsection to take precedence over
2894 values in the 'sendemail' section. The default identity is
2895 the value of `sendemail.identity`.
2897 sendemail.smtpEncryption::
2898 See linkgit:git-send-email[1] for description. Note that this
2899 setting is not subject to the 'identity' mechanism.
2901 sendemail.smtpssl (deprecated)::
2902 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2904 sendemail.smtpsslcertpath::
2905 Path to ca-certificates (either a directory or a single file).
2906 Set it to an empty string to disable certificate verification.
2908 sendemail.<identity>.*::
2909 Identity-specific versions of the 'sendemail.*' parameters
2910 found below, taking precedence over those when the this
2911 identity is selected, through command-line or
2912 `sendemail.identity`.
2914 sendemail.aliasesFile::
2915 sendemail.aliasFileType::
2916 sendemail.annotate::
2920 sendemail.chainReplyTo::
2922 sendemail.envelopeSender::
2924 sendemail.multiEdit::
2925 sendemail.signedoffbycc::
2926 sendemail.smtpPass::
2927 sendemail.suppresscc::
2928 sendemail.suppressFrom::
2930 sendemail.smtpDomain::
2931 sendemail.smtpServer::
2932 sendemail.smtpServerPort::
2933 sendemail.smtpServerOption::
2934 sendemail.smtpUser::
2936 sendemail.transferEncoding::
2937 sendemail.validate::
2939 See linkgit:git-send-email[1] for description.
2941 sendemail.signedoffcc (deprecated)::
2942 Deprecated alias for `sendemail.signedoffbycc`.
2944 showbranch.default::
2945 The default set of branches for linkgit:git-show-branch[1].
2946 See linkgit:git-show-branch[1].
2948 splitIndex.maxPercentChange::
2949 When the split index feature is used, this specifies the
2950 percent of entries the split index can contain compared to the
2951 total number of entries in both the split index and the shared
2952 index before a new shared index is written.
2953 The value should be between 0 and 100. If the value is 0 then
2954 a new shared index is always written, if it is 100 a new
2955 shared index is never written.
2956 By default the value is 20, so a new shared index is written
2957 if the number of entries in the split index would be greater
2958 than 20 percent of the total number of entries.
2959 See linkgit:git-update-index[1].
2961 splitIndex.sharedIndexExpire::
2962 When the split index feature is used, shared index files that
2963 were not modified since the time this variable specifies will
2964 be removed when a new shared index file is created. The value
2965 "now" expires all entries immediately, and "never" suppresses
2966 expiration altogether.
2967 The default value is "2.weeks.ago".
2968 Note that a shared index file is considered modified (for the
2969 purpose of expiration) each time a new split-index file is
2970 either created based on it or read from it.
2971 See linkgit:git-update-index[1].
2973 status.relativePaths::
2974 By default, linkgit:git-status[1] shows paths relative to the
2975 current directory. Setting this variable to `false` shows paths
2976 relative to the repository root (this was the default for Git
2980 Set to true to enable --short by default in linkgit:git-status[1].
2981 The option --no-short takes precedence over this variable.
2984 Set to true to enable --branch by default in linkgit:git-status[1].
2985 The option --no-branch takes precedence over this variable.
2987 status.displayCommentPrefix::
2988 If set to true, linkgit:git-status[1] will insert a comment
2989 prefix before each output line (starting with
2990 `core.commentChar`, i.e. `#` by default). This was the
2991 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2994 status.showUntrackedFiles::
2995 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2996 files which are not currently tracked by Git. Directories which
2997 contain only untracked files, are shown with the directory name
2998 only. Showing untracked files means that Git needs to lstat() all
2999 the files in the whole repository, which might be slow on some
3000 systems. So, this variable controls how the commands displays
3001 the untracked files. Possible values are:
3004 * `no` - Show no untracked files.
3005 * `normal` - Show untracked files and directories.
3006 * `all` - Show also individual files in untracked directories.
3009 If this variable is not specified, it defaults to 'normal'.
3010 This variable can be overridden with the -u|--untracked-files option
3011 of linkgit:git-status[1] and linkgit:git-commit[1].
3013 status.submoduleSummary::
3015 If this is set to a non zero number or true (identical to -1 or an
3016 unlimited number), the submodule summary will be enabled and a
3017 summary of commits for modified submodules will be shown (see
3018 --summary-limit option of linkgit:git-submodule[1]). Please note
3019 that the summary output command will be suppressed for all
3020 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3021 for those submodules where `submodule.<name>.ignore=all`. The only
3022 exception to that rule is that status and commit will show staged
3023 submodule changes. To
3024 also view the summary for ignored submodules you can either use
3025 the --ignore-submodules=dirty command-line option or the 'git
3026 submodule summary' command, which shows a similar output but does
3027 not honor these settings.
3030 If this is set to true, the `git stash show` command without an
3031 option will show the stash in patch form. Defaults to false.
3032 See description of 'show' command in linkgit:git-stash[1].
3035 If this is set to true, the `git stash show` command without an
3036 option will show diffstat of the stash. Defaults to true.
3037 See description of 'show' command in linkgit:git-stash[1].
3039 submodule.<name>.url::
3040 The URL for a submodule. This variable is copied from the .gitmodules
3041 file to the git config via 'git submodule init'. The user can change
3042 the configured URL before obtaining the submodule via 'git submodule
3043 update'. If neither submodule.<name>.active or submodule.active are
3044 set, the presence of this variable is used as a fallback to indicate
3045 whether the submodule is of interest to git commands.
3046 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3048 submodule.<name>.update::
3049 The default update procedure for a submodule. This variable
3050 is populated by `git submodule init` from the
3051 linkgit:gitmodules[5] file. See description of 'update'
3052 command in linkgit:git-submodule[1].
3054 submodule.<name>.branch::
3055 The remote branch name for a submodule, used by `git submodule
3056 update --remote`. Set this option to override the value found in
3057 the `.gitmodules` file. See linkgit:git-submodule[1] and
3058 linkgit:gitmodules[5] for details.
3060 submodule.<name>.fetchRecurseSubmodules::
3061 This option can be used to control recursive fetching of this
3062 submodule. It can be overridden by using the --[no-]recurse-submodules
3063 command-line option to "git fetch" and "git pull".
3064 This setting will override that from in the linkgit:gitmodules[5]
3067 submodule.<name>.ignore::
3068 Defines under what circumstances "git status" and the diff family show
3069 a submodule as modified. When set to "all", it will never be considered
3070 modified (but it will nonetheless show up in the output of status and
3071 commit when it has been staged), "dirty" will ignore all changes
3072 to the submodules work tree and
3073 takes only differences between the HEAD of the submodule and the commit
3074 recorded in the superproject into account. "untracked" will additionally
3075 let submodules with modified tracked files in their work tree show up.
3076 Using "none" (the default when this option is not set) also shows
3077 submodules that have untracked files in their work tree as changed.
3078 This setting overrides any setting made in .gitmodules for this submodule,
3079 both settings can be overridden on the command line by using the
3080 "--ignore-submodules" option. The 'git submodule' commands are not
3081 affected by this setting.
3083 submodule.<name>.active::
3084 Boolean value indicating if the submodule is of interest to git
3085 commands. This config option takes precedence over the
3086 submodule.active config option.
3089 A repeated field which contains a pathspec used to match against a
3090 submodule's path to determine if the submodule is of interest to git
3093 submodule.fetchJobs::
3094 Specifies how many submodules are fetched/cloned at the same time.
3095 A positive integer allows up to that number of submodules fetched
3096 in parallel. A value of 0 will give some reasonable default.
3097 If unset, it defaults to 1.
3099 submodule.alternateLocation::
3100 Specifies how the submodules obtain alternates when submodules are
3101 cloned. Possible values are `no`, `superproject`.
3102 By default `no` is assumed, which doesn't add references. When the
3103 value is set to `superproject` the submodule to be cloned computes
3104 its alternates location relative to the superprojects alternate.
3106 submodule.alternateErrorStrategy::
3107 Specifies how to treat errors with the alternates for a submodule
3108 as computed via `submodule.alternateLocation`. Possible values are
3109 `ignore`, `info`, `die`. Default is `die`.
3111 tag.forceSignAnnotated::
3112 A boolean to specify whether annotated tags created should be GPG signed.
3113 If `--annotate` is specified on the command line, it takes
3114 precedence over this option.
3117 This variable controls the sort ordering of tags when displayed by
3118 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3119 value of this variable will be used as the default.
3122 This variable can be used to restrict the permission bits of
3123 tar archive entries. The default is 0002, which turns off the
3124 world write bit. The special value "user" indicates that the
3125 archiving user's umask will be used instead. See umask(2) and
3126 linkgit:git-archive[1].
3128 transfer.fsckObjects::
3129 When `fetch.fsckObjects` or `receive.fsckObjects` are
3130 not set, the value of this variable is used instead.
3134 String(s) `receive-pack` and `upload-pack` use to decide which
3135 refs to omit from their initial advertisements. Use more than
3136 one definition to specify multiple prefix strings. A ref that is
3137 under the hierarchies listed in the value of this variable is
3138 excluded, and is hidden when responding to `git push` or `git
3139 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3140 program-specific versions of this config.
3142 You may also include a `!` in front of the ref name to negate the entry,
3143 explicitly exposing it, even if an earlier entry marked it as hidden.
3144 If you have multiple hideRefs values, later entries override earlier ones
3145 (and entries in more-specific config files override less-specific ones).
3147 If a namespace is in use, the namespace prefix is stripped from each
3148 reference before it is matched against `transfer.hiderefs` patterns.
3149 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3150 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3151 is omitted from the advertisements but `refs/heads/master` and
3152 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3153 "have" lines. In order to match refs before stripping, add a `^` in front of
3154 the ref name. If you combine `!` and `^`, `!` must be specified first.
3156 Even if you hide refs, a client may still be able to steal the target
3157 objects via the techniques described in the "SECURITY" section of the
3158 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3159 separate repository.
3161 transfer.unpackLimit::
3162 When `fetch.unpackLimit` or `receive.unpackLimit` are
3163 not set, the value of this variable is used instead.
3164 The default value is 100.
3166 uploadarchive.allowUnreachable::
3167 If true, allow clients to use `git archive --remote` to request
3168 any tree, whether reachable from the ref tips or not. See the
3169 discussion in the "SECURITY" section of
3170 linkgit:git-upload-archive[1] for more details. Defaults to
3173 uploadpack.hideRefs::
3174 This variable is the same as `transfer.hideRefs`, but applies
3175 only to `upload-pack` (and so affects only fetches, not pushes).
3176 An attempt to fetch a hidden ref by `git fetch` will fail. See
3177 also `uploadpack.allowTipSHA1InWant`.
3179 uploadpack.allowTipSHA1InWant::
3180 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3181 to accept a fetch request that asks for an object at the tip
3182 of a hidden ref (by default, such a request is rejected).
3183 See also `uploadpack.hideRefs`. Even if this is false, a client
3184 may be able to steal objects via the techniques described in the
3185 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3186 best to keep private data in a separate repository.
3188 uploadpack.allowReachableSHA1InWant::
3189 Allow `upload-pack` to accept a fetch request that asks for an
3190 object that is reachable from any ref tip. However, note that
3191 calculating object reachability is computationally expensive.
3192 Defaults to `false`. Even if this is false, a client may be able
3193 to steal objects via the techniques described in the "SECURITY"
3194 section of the linkgit:gitnamespaces[7] man page; it's best to
3195 keep private data in a separate repository.
3197 uploadpack.allowAnySHA1InWant::
3198 Allow `upload-pack` to accept a fetch request that asks for any
3200 Defaults to `false`.
3202 uploadpack.keepAlive::
3203 When `upload-pack` has started `pack-objects`, there may be a
3204 quiet period while `pack-objects` prepares the pack. Normally
3205 it would output progress information, but if `--quiet` was used
3206 for the fetch, `pack-objects` will output nothing at all until
3207 the pack data begins. Some clients and networks may consider
3208 the server to be hung and give up. Setting this option instructs
3209 `upload-pack` to send an empty keepalive packet every
3210 `uploadpack.keepAlive` seconds. Setting this option to 0
3211 disables keepalive packets entirely. The default is 5 seconds.
3213 uploadpack.packObjectsHook::
3214 If this option is set, when `upload-pack` would run
3215 `git pack-objects` to create a packfile for a client, it will
3216 run this shell command instead. The `pack-objects` command and
3217 arguments it _would_ have run (including the `git pack-objects`
3218 at the beginning) are appended to the shell command. The stdin
3219 and stdout of the hook are treated as if `pack-objects` itself
3220 was run. I.e., `upload-pack` will feed input intended for
3221 `pack-objects` to the hook, and expects a completed packfile on
3224 Note that this configuration variable is ignored if it is seen in the
3225 repository-level config (this is a safety measure against fetching from
3226 untrusted repositories).
3228 url.<base>.insteadOf::
3229 Any URL that starts with this value will be rewritten to
3230 start, instead, with <base>. In cases where some site serves a
3231 large number of repositories, and serves them with multiple
3232 access methods, and some users need to use different access
3233 methods, this feature allows people to specify any of the
3234 equivalent URLs and have Git automatically rewrite the URL to
3235 the best alternative for the particular user, even for a
3236 never-before-seen repository on the site. When more than one
3237 insteadOf strings match a given URL, the longest match is used.
3239 url.<base>.pushInsteadOf::
3240 Any URL that starts with this value will not be pushed to;
3241 instead, it will be rewritten to start with <base>, and the
3242 resulting URL will be pushed to. In cases where some site serves
3243 a large number of repositories, and serves them with multiple
3244 access methods, some of which do not allow push, this feature
3245 allows people to specify a pull-only URL and have Git
3246 automatically use an appropriate URL to push, even for a
3247 never-before-seen repository on the site. When more than one
3248 pushInsteadOf strings match a given URL, the longest match is
3249 used. If a remote has an explicit pushurl, Git will ignore this
3250 setting for that remote.
3253 Your email address to be recorded in any newly created commits.
3254 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3255 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3258 Your full name to be recorded in any newly created commits.
3259 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3260 environment variables. See linkgit:git-commit-tree[1].
3262 user.useConfigOnly::
3263 Instruct Git to avoid trying to guess defaults for `user.email`
3264 and `user.name`, and instead retrieve the values only from the
3265 configuration. For example, if you have multiple email addresses
3266 and would like to use a different one for each repository, then
3267 with this configuration option set to `true` in the global config
3268 along with a name, Git will prompt you to set up an email before
3269 making new commits in a newly cloned repository.
3270 Defaults to `false`.
3273 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3274 key you want it to automatically when creating a signed tag or
3275 commit, you can override the default selection with this variable.
3276 This option is passed unchanged to gpg's --local-user parameter,
3277 so you may specify a key using any method that gpg supports.
3279 versionsort.prereleaseSuffix (deprecated)::
3280 Deprecated alias for `versionsort.suffix`. Ignored if
3281 `versionsort.suffix` is set.
3283 versionsort.suffix::
3284 Even when version sort is used in linkgit:git-tag[1], tagnames
3285 with the same base version but different suffixes are still sorted
3286 lexicographically, resulting e.g. in prerelease tags appearing
3287 after the main release (e.g. "1.0-rc1" after "1.0"). This
3288 variable can be specified to determine the sorting order of tags
3289 with different suffixes.
3291 By specifying a single suffix in this variable, any tagname containing
3292 that suffix will appear before the corresponding main release. E.g. if
3293 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3294 "1.0". If specified multiple times, once per suffix, then the order of
3295 suffixes in the configuration will determine the sorting order of tagnames
3296 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3297 configuration, then all "1.0-preX" tags will be listed before any
3298 "1.0-rcX" tags. The placement of the main release tag relative to tags
3299 with various suffixes can be determined by specifying the empty suffix
3300 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3301 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3302 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3305 If more than one suffixes match the same tagname, then that tagname will
3306 be sorted according to the suffix which starts at the earliest position in
3307 the tagname. If more than one different matching suffixes start at
3308 that earliest position, then that tagname will be sorted according to the
3309 longest of those suffixes.
3310 The sorting order between different suffixes is undefined if they are
3311 in multiple config files.
3314 Specify a web browser that may be used by some commands.
3315 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]