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 literals are `yes`, `on`, `true`,
220 and `1`. Also, a variable defined without `= <value>`
223 false;; Boolean false literals are `no`, `off`, `false`,
224 `0` and the empty string.
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.
352 Advice on what to do when you've accidentally added one
353 git repo inside of another.
355 Advice shown if an hook is ignored because the hook is not
358 Print a message to the terminal whenever Git is waiting for
359 editor input from the user.
363 Tells Git if the executable bit of files in the working tree
366 Some filesystems lose the executable bit when a file that is
367 marked as executable is checked out, or checks out a
368 non-executable file with executable bit on.
369 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
370 to see if it handles the executable bit correctly
371 and this variable is automatically set as necessary.
373 A repository, however, may be on a filesystem that handles
374 the filemode correctly, and this variable is set to 'true'
375 when created, but later may be made accessible from another
376 environment that loses the filemode (e.g. exporting ext4 via
377 CIFS mount, visiting a Cygwin created repository with
378 Git for Windows or Eclipse).
379 In such a case it may be necessary to set this variable to 'false'.
380 See linkgit:git-update-index[1].
382 The default is true (when core.filemode is not specified in the config file).
385 (Windows-only) If true, mark newly-created directories and files whose
386 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
387 directory is hidden, but no other files starting with a dot. The
388 default mode is 'dotGitOnly'.
391 If true, this option enables various workarounds to enable
392 Git to work better on filesystems that are not case sensitive,
393 like FAT. For example, if a directory listing finds
394 "makefile" when Git expects "Makefile", Git will assume
395 it is really the same file, and continue to remember it as
398 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
399 will probe and set core.ignoreCase true if appropriate when the repository
402 core.precomposeUnicode::
403 This option is only used by Mac OS implementation of Git.
404 When core.precomposeUnicode=true, Git reverts the unicode decomposition
405 of filenames done by Mac OS. This is useful when sharing a repository
406 between Mac OS and Linux or Windows.
407 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
408 When false, file names are handled fully transparent by Git,
409 which is backward compatible with older versions of Git.
412 If set to true, do not allow checkout of paths that would
413 be considered equivalent to `.git` on an HFS+ filesystem.
414 Defaults to `true` on Mac OS, and `false` elsewhere.
417 If set to true, do not allow checkout of paths that would
418 cause problems with the NTFS filesystem, e.g. conflict with
420 Defaults to `true` on Windows, and `false` elsewhere.
423 If set, the value of this variable is used as a command which
424 will identify all files that may have changed since the
425 requested date/time. This information is used to speed up git by
426 avoiding unnecessary processing of files that have not changed.
427 See the "fsmonitor-watchman" section of linkgit:githooks[5].
430 If false, the ctime differences between the index and the
431 working tree are ignored; useful when the inode change time
432 is regularly modified by something outside Git (file system
433 crawlers and some backup systems).
434 See linkgit:git-update-index[1]. True by default.
437 If true, the split-index feature of the index will be used.
438 See linkgit:git-update-index[1]. False by default.
440 core.untrackedCache::
441 Determines what to do about the untracked cache feature of the
442 index. It will be kept, if this variable is unset or set to
443 `keep`. It will automatically be added if set to `true`. And
444 it will automatically be removed, if set to `false`. Before
445 setting it to `true`, you should check that mtime is working
446 properly on your system.
447 See linkgit:git-update-index[1]. `keep` by default.
450 Determines which stat fields to match between the index
451 and work tree. The user can set this to 'default' or
452 'minimal'. Default (or explicitly 'default'), is to check
453 all fields, including the sub-second part of mtime and ctime.
456 Commands that output paths (e.g. 'ls-files', 'diff'), will
457 quote "unusual" characters in the pathname by enclosing the
458 pathname in double-quotes and escaping those characters with
459 backslashes in the same way C escapes control characters (e.g.
460 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
461 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
462 UTF-8). If this variable is set to false, bytes higher than
463 0x80 are not considered "unusual" any more. Double-quotes,
464 backslash and control characters are always escaped regardless
465 of the setting of this variable. A simple space character is
466 not considered "unusual". Many commands can output pathnames
467 completely verbatim using the `-z` option. The default value
471 Sets the line ending type to use in the working directory for
472 files that have the `text` property set when core.autocrlf is false.
473 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
474 native line ending. The default value is `native`. See
475 linkgit:gitattributes[5] for more information on end-of-line
479 If true, makes Git check if converting `CRLF` is reversible when
480 end-of-line conversion is active. Git will verify if a command
481 modifies a file in the work tree either directly or indirectly.
482 For example, committing a file followed by checking out the
483 same file should yield the original file in the work tree. If
484 this is not the case for the current setting of
485 `core.autocrlf`, Git will reject the file. The variable can
486 be set to "warn", in which case Git will only warn about an
487 irreversible conversion but continue the operation.
489 CRLF conversion bears a slight chance of corrupting data.
490 When it is enabled, Git will convert CRLF to LF during commit and LF to
491 CRLF during checkout. A file that contains a mixture of LF and
492 CRLF before the commit cannot be recreated by Git. For text
493 files this is the right thing to do: it corrects line endings
494 such that we have only LF line endings in the repository.
495 But for binary files that are accidentally classified as text the
496 conversion can corrupt data.
498 If you recognize such corruption early you can easily fix it by
499 setting the conversion type explicitly in .gitattributes. Right
500 after committing you still have the original file in your work
501 tree and this file is not yet corrupted. You can explicitly tell
502 Git that this file is binary and Git will handle the file
505 Unfortunately, the desired effect of cleaning up text files with
506 mixed line endings and the undesired effect of corrupting binary
507 files cannot be distinguished. In both cases CRLFs are removed
508 in an irreversible way. For text files this is the right thing
509 to do because CRLFs are line endings, while for binary files
510 converting CRLFs corrupts data.
512 Note, this safety check does not mean that a checkout will generate a
513 file identical to the original file for a different setting of
514 `core.eol` and `core.autocrlf`, but only for the current one. For
515 example, a text file with `LF` would be accepted with `core.eol=lf`
516 and could later be checked out with `core.eol=crlf`, in which case the
517 resulting file would contain `CRLF`, although the original file
518 contained `LF`. However, in both work trees the line endings would be
519 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
520 file with mixed line endings would be reported by the `core.safecrlf`
524 Setting this variable to "true" is the same as setting
525 the `text` attribute to "auto" on all files and core.eol to "crlf".
526 Set to true if you want to have `CRLF` line endings in your
527 working directory and the repository has LF line endings.
528 This variable can be set to 'input',
529 in which case no output conversion is performed.
531 core.checkRoundtripEncoding::
532 A comma and/or whitespace separated list of encodings that Git
533 performs UTF-8 round trip checks on if they are used in an
534 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
535 The default value is `SHIFT-JIS`.
538 If false, symbolic links are checked out as small plain files that
539 contain the link text. linkgit:git-update-index[1] and
540 linkgit:git-add[1] will not change the recorded type to regular
541 file. Useful on filesystems like FAT that do not support
544 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
545 will probe and set core.symlinks false if appropriate when the repository
549 A "proxy command" to execute (as 'command host port') instead
550 of establishing direct connection to the remote server when
551 using the Git protocol for fetching. If the variable value is
552 in the "COMMAND for DOMAIN" format, the command is applied only
553 on hostnames ending with the specified domain string. This variable
554 may be set multiple times and is matched in the given order;
555 the first match wins.
557 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
558 (which always applies universally, without the special "for"
561 The special string `none` can be used as the proxy command to
562 specify that no proxy be used for a given domain pattern.
563 This is useful for excluding servers inside a firewall from
564 proxy use, while defaulting to a common proxy for external domains.
567 If this variable is set, `git fetch` and `git push` will
568 use the specified command instead of `ssh` when they need to
569 connect to a remote system. The command is in the same form as
570 the `GIT_SSH_COMMAND` environment variable and is overridden
571 when the environment variable is set.
574 If true, Git will avoid using lstat() calls to detect if files have
575 changed by setting the "assume-unchanged" bit for those tracked files
576 which it has updated identically in both the index and working tree.
578 When files are modified outside of Git, the user will need to stage
579 the modified files explicitly (e.g. see 'Examples' section in
580 linkgit:git-update-index[1]).
581 Git will not normally detect changes to those files.
583 This is useful on systems where lstat() calls are very slow, such as
584 CIFS/Microsoft Windows.
588 core.preferSymlinkRefs::
589 Instead of the default "symref" format for HEAD
590 and other symbolic reference files, use symbolic links.
591 This is sometimes needed to work with old scripts that
592 expect HEAD to be a symbolic link.
595 If true this repository is assumed to be 'bare' and has no
596 working directory associated with it. If this is the case a
597 number of commands that require a working directory will be
598 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
600 This setting is automatically guessed by linkgit:git-clone[1] or
601 linkgit:git-init[1] when the repository was created. By default a
602 repository that ends in "/.git" is assumed to be not bare (bare =
603 false), while all other repositories are assumed to be bare (bare
607 Set the path to the root of the working tree.
608 If `GIT_COMMON_DIR` environment variable is set, core.worktree
609 is ignored and not used for determining the root of working tree.
610 This can be overridden by the `GIT_WORK_TREE` environment
611 variable and the `--work-tree` command-line option.
612 The value can be an absolute path or relative to the path to
613 the .git directory, which is either specified by --git-dir
614 or GIT_DIR, or automatically discovered.
615 If --git-dir or GIT_DIR is specified but none of
616 --work-tree, GIT_WORK_TREE and core.worktree is specified,
617 the current working directory is regarded as the top level
618 of your working tree.
620 Note that this variable is honored even when set in a configuration
621 file in a ".git" subdirectory of a directory and its value differs
622 from the latter directory (e.g. "/path/to/.git/config" has
623 core.worktree set to "/different/path"), which is most likely a
624 misconfiguration. Running Git commands in the "/path/to" directory will
625 still use "/different/path" as the root of the work tree and can cause
626 confusion unless you know what you are doing (e.g. you are creating a
627 read-only snapshot of the same index to a location different from the
628 repository's usual working tree).
630 core.logAllRefUpdates::
631 Enable the reflog. Updates to a ref <ref> is logged to the file
632 "`$GIT_DIR/logs/<ref>`", by appending the new and old
633 SHA-1, the date/time and the reason of the update, but
634 only when the file exists. If this configuration
635 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
636 file is automatically created for branch heads (i.e. under
637 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
638 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
639 If it is set to `always`, then a missing reflog is automatically
640 created for any ref under `refs/`.
642 This information can be used to determine what commit
643 was the tip of a branch "2 days ago".
645 This value is true by default in a repository that has
646 a working directory associated with it, and false by
647 default in a bare repository.
649 core.repositoryFormatVersion::
650 Internal variable identifying the repository format and layout
653 core.sharedRepository::
654 When 'group' (or 'true'), the repository is made shareable between
655 several users in a group (making sure all the files and objects are
656 group-writable). When 'all' (or 'world' or 'everybody'), the
657 repository will be readable by all users, additionally to being
658 group-shareable. When 'umask' (or 'false'), Git will use permissions
659 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
660 files in the repository will have this mode value. '0xxx' will override
661 user's umask value (whereas the other options will only override
662 requested parts of the user's umask value). Examples: '0660' will make
663 the repo read/write-able for the owner and group, but inaccessible to
664 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
665 repository that is group-readable but not group-writable.
666 See linkgit:git-init[1]. False by default.
668 core.warnAmbiguousRefs::
669 If true, Git will warn you if the ref name you passed it is ambiguous
670 and might match multiple refs in the repository. True by default.
673 An integer -1..9, indicating a default compression level.
674 -1 is the zlib default. 0 means no compression,
675 and 1..9 are various speed/size tradeoffs, 9 being slowest.
676 If set, this provides a default to other compression variables,
677 such as `core.looseCompression` and `pack.compression`.
679 core.looseCompression::
680 An integer -1..9, indicating the compression level for objects that
681 are not in a pack file. -1 is the zlib default. 0 means no
682 compression, and 1..9 are various speed/size tradeoffs, 9 being
683 slowest. If not set, defaults to core.compression. If that is
684 not set, defaults to 1 (best speed).
686 core.packedGitWindowSize::
687 Number of bytes of a pack file to map into memory in a
688 single mapping operation. Larger window sizes may allow
689 your system to process a smaller number of large pack files
690 more quickly. Smaller window sizes will negatively affect
691 performance due to increased calls to the operating system's
692 memory manager, but may improve performance when accessing
693 a large number of large pack files.
695 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
696 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
697 be reasonable for all users/operating systems. You probably do
698 not need to adjust this value.
700 Common unit suffixes of 'k', 'm', or 'g' are supported.
702 core.packedGitLimit::
703 Maximum number of bytes to map simultaneously into memory
704 from pack files. If Git needs to access more than this many
705 bytes at once to complete an operation it will unmap existing
706 regions to reclaim virtual address space within the process.
708 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
709 unlimited) on 64 bit platforms.
710 This should be reasonable for all users/operating systems, except on
711 the largest projects. You probably do not need to adjust this value.
713 Common unit suffixes of 'k', 'm', or 'g' are supported.
715 core.deltaBaseCacheLimit::
716 Maximum number of bytes to reserve for caching base objects
717 that may be referenced by multiple deltified objects. By storing the
718 entire decompressed base objects in a cache Git is able
719 to avoid unpacking and decompressing frequently used base
720 objects multiple times.
722 Default is 96 MiB on all platforms. This should be reasonable
723 for all users/operating systems, except on the largest projects.
724 You probably do not need to adjust this value.
726 Common unit suffixes of 'k', 'm', or 'g' are supported.
728 core.bigFileThreshold::
729 Files larger than this size are stored deflated, without
730 attempting delta compression. Storing large files without
731 delta compression avoids excessive memory usage, at the
732 slight expense of increased disk usage. Additionally files
733 larger than this size are always treated as binary.
735 Default is 512 MiB on all platforms. This should be reasonable
736 for most projects as source code and other text files can still
737 be delta compressed, but larger binary media files won't be.
739 Common unit suffixes of 'k', 'm', or 'g' are supported.
742 Specifies the pathname to the file that contains patterns to
743 describe paths that are not meant to be tracked, in addition
744 to '.gitignore' (per-directory) and '.git/info/exclude'.
745 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
746 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
747 is used instead. See linkgit:gitignore[5].
750 Some commands (e.g. svn and http interfaces) that interactively
751 ask for a password can be told to use an external program given
752 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
753 environment variable. If not set, fall back to the value of the
754 `SSH_ASKPASS` environment variable or, failing that, a simple password
755 prompt. The external program shall be given a suitable prompt as
756 command-line argument and write the password on its STDOUT.
758 core.attributesFile::
759 In addition to '.gitattributes' (per-directory) and
760 '.git/info/attributes', Git looks into this file for attributes
761 (see linkgit:gitattributes[5]). Path expansions are made the same
762 way as for `core.excludesFile`. Its default value is
763 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
764 set or empty, `$HOME/.config/git/attributes` is used instead.
767 By default Git will look for your hooks in the
768 '$GIT_DIR/hooks' directory. Set this to different path,
769 e.g. '/etc/git/hooks', and Git will try to find your hooks in
770 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
771 in '$GIT_DIR/hooks/pre-receive'.
773 The path can be either absolute or relative. A relative path is
774 taken as relative to the directory where the hooks are run (see
775 the "DESCRIPTION" section of linkgit:githooks[5]).
777 This configuration variable is useful in cases where you'd like to
778 centrally configure your Git hooks instead of configuring them on a
779 per-repository basis, or as a more flexible and centralized
780 alternative to having an `init.templateDir` where you've changed
784 Commands such as `commit` and `tag` that let you edit
785 messages by launching an editor use the value of this
786 variable when it is set, and the environment variable
787 `GIT_EDITOR` is not set. See linkgit:git-var[1].
790 Commands such as `commit` and `tag` that let you edit
791 messages consider a line that begins with this character
792 commented, and removes them after the editor returns
795 If set to "auto", `git-commit` would select a character that is not
796 the beginning character of any line in existing commit messages.
798 core.filesRefLockTimeout::
799 The length of time, in milliseconds, to retry when trying to
800 lock an individual reference. Value 0 means not to retry at
801 all; -1 means to try indefinitely. Default is 100 (i.e.,
804 core.packedRefsTimeout::
805 The length of time, in milliseconds, to retry when trying to
806 lock the `packed-refs` file. Value 0 means not to retry at
807 all; -1 means to try indefinitely. Default is 1000 (i.e.,
811 Text editor used by `git rebase -i` for editing the rebase instruction file.
812 The value is meant to be interpreted by the shell when it is used.
813 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
814 When not configured the default commit message editor is used instead.
817 Text viewer for use by Git commands (e.g., 'less'). The value
818 is meant to be interpreted by the shell. The order of preference
819 is the `$GIT_PAGER` environment variable, then `core.pager`
820 configuration, then `$PAGER`, and then the default chosen at
821 compile time (usually 'less').
823 When the `LESS` environment variable is unset, Git sets it to `FRX`
824 (if `LESS` environment variable is set, Git does not change it at
825 all). If you want to selectively override Git's default setting
826 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
827 be passed to the shell by Git, which will translate the final
828 command to `LESS=FRX less -S`. The environment does not set the
829 `S` option but the command line does, instructing less to truncate
830 long lines. Similarly, setting `core.pager` to `less -+F` will
831 deactivate the `F` option specified by the environment from the
832 command-line, deactivating the "quit if one screen" behavior of
833 `less`. One can specifically activate some flags for particular
834 commands: for example, setting `pager.blame` to `less -S` enables
835 line truncation only for `git blame`.
837 Likewise, when the `LV` environment variable is unset, Git sets it
838 to `-c`. You can override this setting by exporting `LV` with
839 another value or setting `core.pager` to `lv +c`.
842 A comma separated list of common whitespace problems to
843 notice. 'git diff' will use `color.diff.whitespace` to
844 highlight them, and 'git apply --whitespace=error' will
845 consider them as errors. You can prefix `-` to disable
846 any of them (e.g. `-trailing-space`):
848 * `blank-at-eol` treats trailing whitespaces at the end of the line
849 as an error (enabled by default).
850 * `space-before-tab` treats a space character that appears immediately
851 before a tab character in the initial indent part of the line as an
852 error (enabled by default).
853 * `indent-with-non-tab` treats a line that is indented with space
854 characters instead of the equivalent tabs as an error (not enabled by
856 * `tab-in-indent` treats a tab character in the initial indent part of
857 the line as an error (not enabled by default).
858 * `blank-at-eof` treats blank lines added at the end of file as an error
859 (enabled by default).
860 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
862 * `cr-at-eol` treats a carriage-return at the end of line as
863 part of the line terminator, i.e. with it, `trailing-space`
864 does not trigger if the character before such a carriage-return
865 is not a whitespace (not enabled by default).
866 * `tabwidth=<n>` tells how many character positions a tab occupies; this
867 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
868 errors. The default tab width is 8. Allowed values are 1 to 63.
870 core.fsyncObjectFiles::
871 This boolean will enable 'fsync()' when writing object files.
873 This is a total waste of time and effort on a filesystem that orders
874 data writes properly, but can be useful for filesystems that do not use
875 journalling (traditional UNIX filesystems) or that only journal metadata
876 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
879 Enable parallel index preload for operations like 'git diff'
881 This can speed up operations like 'git diff' and 'git status' especially
882 on filesystems like NFS that have weak caching semantics and thus
883 relatively high IO latencies. When enabled, Git will do the
884 index comparison to the filesystem data in parallel, allowing
885 overlapping IO's. Defaults to true.
888 You can set this to 'link', in which case a hardlink followed by
889 a delete of the source are used to make sure that object creation
890 will not overwrite existing objects.
892 On some file system/operating system combinations, this is unreliable.
893 Set this config setting to 'rename' there; However, This will remove the
894 check that makes sure that existing object files will not get overwritten.
897 When showing commit messages, also show notes which are stored in
898 the given ref. The ref must be fully qualified. If the given
899 ref does not exist, it is not an error but means that no
900 notes should be printed.
902 This setting defaults to "refs/notes/commits", and it can be overridden by
903 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
905 core.sparseCheckout::
906 Enable "sparse checkout" feature. See section "Sparse checkout" in
907 linkgit:git-read-tree[1] for more information.
910 Set the length object names are abbreviated to. If
911 unspecified or set to "auto", an appropriate value is
912 computed based on the approximate number of packed objects
913 in your repository, which hopefully is enough for
914 abbreviated object names to stay unique for some time.
915 The minimum length is 4.
918 add.ignore-errors (deprecated)::
919 Tells 'git add' to continue adding files when some files cannot be
920 added due to indexing errors. Equivalent to the `--ignore-errors`
921 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
922 as it does not follow the usual naming convention for configuration
926 Command aliases for the linkgit:git[1] command wrapper - e.g.
927 after defining "alias.last = cat-file commit HEAD", the invocation
928 "git last" is equivalent to "git cat-file commit HEAD". To avoid
929 confusion and troubles with script usage, aliases that
930 hide existing Git commands are ignored. Arguments are split by
931 spaces, the usual shell quoting and escaping is supported.
932 A quote pair or a backslash can be used to quote them.
934 If the alias expansion is prefixed with an exclamation point,
935 it will be treated as a shell command. For example, defining
936 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
937 "git new" is equivalent to running the shell command
938 "gitk --all --not ORIG_HEAD". Note that shell commands will be
939 executed from the top-level directory of a repository, which may
940 not necessarily be the current directory.
941 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
942 from the original current directory. See linkgit:git-rev-parse[1].
945 If true, git-am will call git-mailsplit for patches in mbox format
946 with parameter `--keep-cr`. In this case git-mailsplit will
947 not remove `\r` from lines ending with `\r\n`. Can be overridden
948 by giving `--no-keep-cr` from the command line.
949 See linkgit:git-am[1], linkgit:git-mailsplit[1].
952 By default, `git am` will fail if the patch does not apply cleanly. When
953 set to true, this setting tells `git am` to fall back on 3-way merge if
954 the patch records the identity of blobs it is supposed to apply to and
955 we have those blobs available locally (equivalent to giving the `--3way`
956 option from the command line). Defaults to `false`.
957 See linkgit:git-am[1].
959 apply.ignoreWhitespace::
960 When set to 'change', tells 'git apply' to ignore changes in
961 whitespace, in the same way as the `--ignore-space-change`
963 When set to one of: no, none, never, false tells 'git apply' to
964 respect all whitespace differences.
965 See linkgit:git-apply[1].
968 Tells 'git apply' how to handle whitespaces, in the same way
969 as the `--whitespace` option. See linkgit:git-apply[1].
972 Do not treat root commits as boundaries in linkgit:git-blame[1].
973 This option defaults to false.
975 blame.blankBoundary::
976 Show blank commit object name for boundary commits in
977 linkgit:git-blame[1]. This option defaults to false.
980 Show the author email instead of author name in linkgit:git-blame[1].
981 This option defaults to false.
984 Specifies the format used to output dates in linkgit:git-blame[1].
985 If unset the iso format is used. For supported values,
986 see the discussion of the `--date` option at linkgit:git-log[1].
988 branch.autoSetupMerge::
989 Tells 'git branch' and 'git checkout' to set up new branches
990 so that linkgit:git-pull[1] will appropriately merge from the
991 starting point branch. Note that even if this option is not set,
992 this behavior can be chosen per-branch using the `--track`
993 and `--no-track` options. The valid settings are: `false` -- no
994 automatic setup is done; `true` -- automatic setup is done when the
995 starting point is a remote-tracking branch; `always` --
996 automatic setup is done when the starting point is either a
997 local branch or remote-tracking
998 branch. This option defaults to true.
1000 branch.autoSetupRebase::
1001 When a new branch is created with 'git branch' or 'git checkout'
1002 that tracks another branch, this variable tells Git to set
1003 up pull to rebase instead of merge (see "branch.<name>.rebase").
1004 When `never`, rebase is never automatically set to true.
1005 When `local`, rebase is set to true for tracked branches of
1006 other local branches.
1007 When `remote`, rebase is set to true for tracked branches of
1008 remote-tracking branches.
1009 When `always`, rebase will be set to true for all tracking
1011 See "branch.autoSetupMerge" for details on how to set up a
1012 branch to track another branch.
1013 This option defaults to never.
1015 branch.<name>.remote::
1016 When on branch <name>, it tells 'git fetch' and 'git push'
1017 which remote to fetch from/push to. The remote to push to
1018 may be overridden with `remote.pushDefault` (for all branches).
1019 The remote to push to, for the current branch, may be further
1020 overridden by `branch.<name>.pushRemote`. If no remote is
1021 configured, or if you are not on any branch, it defaults to
1022 `origin` for fetching and `remote.pushDefault` for pushing.
1023 Additionally, `.` (a period) is the current local repository
1024 (a dot-repository), see `branch.<name>.merge`'s final note below.
1026 branch.<name>.pushRemote::
1027 When on branch <name>, it overrides `branch.<name>.remote` for
1028 pushing. It also overrides `remote.pushDefault` for pushing
1029 from branch <name>. When you pull from one place (e.g. your
1030 upstream) and push to another place (e.g. your own publishing
1031 repository), you would want to set `remote.pushDefault` to
1032 specify the remote to push to for all branches, and use this
1033 option to override it for a specific branch.
1035 branch.<name>.merge::
1036 Defines, together with branch.<name>.remote, the upstream branch
1037 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1038 branch to merge and can also affect 'git push' (see push.default).
1039 When in branch <name>, it tells 'git fetch' the default
1040 refspec to be marked for merging in FETCH_HEAD. The value is
1041 handled like the remote part of a refspec, and must match a
1042 ref which is fetched from the remote given by
1043 "branch.<name>.remote".
1044 The merge information is used by 'git pull' (which at first calls
1045 'git fetch') to lookup the default branch for merging. Without
1046 this option, 'git pull' defaults to merge the first refspec fetched.
1047 Specify multiple values to get an octopus merge.
1048 If you wish to setup 'git pull' so that it merges into <name> from
1049 another branch in the local repository, you can point
1050 branch.<name>.merge to the desired branch, and use the relative path
1051 setting `.` (a period) for branch.<name>.remote.
1053 branch.<name>.mergeOptions::
1054 Sets default options for merging into branch <name>. The syntax and
1055 supported options are the same as those of linkgit:git-merge[1], but
1056 option values containing whitespace characters are currently not
1059 branch.<name>.rebase::
1060 When true, rebase the branch <name> on top of the fetched branch,
1061 instead of merging the default branch from the default remote when
1062 "git pull" is run. See "pull.rebase" for doing this in a non
1063 branch-specific manner.
1065 When preserve, also pass `--preserve-merges` along to 'git rebase'
1066 so that locally committed merge commits will not be flattened
1067 by running 'git pull'.
1069 When the value is `interactive`, the rebase is run in interactive mode.
1071 *NOTE*: this is a possibly dangerous operation; do *not* use
1072 it unless you understand the implications (see linkgit:git-rebase[1]
1075 branch.<name>.description::
1076 Branch description, can be edited with
1077 `git branch --edit-description`. Branch description is
1078 automatically added in the format-patch cover letter or
1079 request-pull summary.
1081 browser.<tool>.cmd::
1082 Specify the command to invoke the specified browser. The
1083 specified command is evaluated in shell with the URLs passed
1084 as arguments. (See linkgit:git-web{litdd}browse[1].)
1086 browser.<tool>.path::
1087 Override the path for the given tool that may be used to
1088 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1089 working repository in gitweb (see linkgit:git-instaweb[1]).
1091 clean.requireForce::
1092 A boolean to make git-clean do nothing unless given -f,
1093 -i or -n. Defaults to true.
1096 A boolean to enable/disable color in the output of
1097 linkgit:git-branch[1]. May be set to `always`,
1098 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1099 only when the output is to a terminal. If unset, then the
1100 value of `color.ui` is used (`auto` by default).
1102 color.branch.<slot>::
1103 Use customized color for branch coloration. `<slot>` is one of
1104 `current` (the current branch), `local` (a local branch),
1105 `remote` (a remote-tracking branch in refs/remotes/),
1106 `upstream` (upstream tracking branch), `plain` (other
1110 Whether to use ANSI escape sequences to add color to patches.
1111 If this is set to `always`, linkgit:git-diff[1],
1112 linkgit:git-log[1], and linkgit:git-show[1] will use color
1113 for all patches. If it is set to `true` or `auto`, those
1114 commands will only use color when output is to the terminal.
1115 If unset, then the value of `color.ui` is used (`auto` by
1118 This does not affect linkgit:git-format-patch[1] or the
1119 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1120 command line with the `--color[=<when>]` option.
1123 If set to either a valid `<mode>` or a true value, moved lines
1124 in a diff are colored differently, for details of valid modes
1125 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1126 true the default color mode will be used. When set to false,
1127 moved lines are not colored.
1130 Use customized color for diff colorization. `<slot>` specifies
1131 which part of the patch to use the specified color, and is one
1132 of `context` (context text - `plain` is a historical synonym),
1133 `meta` (metainformation), `frag`
1134 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1135 `new` (added lines), `commit` (commit headers), `whitespace`
1136 (highlighting whitespace errors), `oldMoved` (deleted lines),
1137 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1138 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1139 and `newMovedAlternativeDimmed` (See the '<mode>'
1140 setting of '--color-moved' in linkgit:git-diff[1] for details).
1142 color.decorate.<slot>::
1143 Use customized color for 'git log --decorate' output. `<slot>` is one
1144 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1145 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1148 When set to `always`, always highlight matches. When `false` (or
1149 `never`), never. When set to `true` or `auto`, use color only
1150 when the output is written to the terminal. If unset, then the
1151 value of `color.ui` is used (`auto` by default).
1154 Use customized color for grep colorization. `<slot>` specifies which
1155 part of the line to use the specified color, and is one of
1159 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1161 filename prefix (when not using `-h`)
1163 function name lines (when using `-p`)
1165 line number prefix (when using `-n`)
1167 matching text (same as setting `matchContext` and `matchSelected`)
1169 matching text in context lines
1171 matching text in selected lines
1173 non-matching text in selected lines
1175 separators between fields on a line (`:`, `-`, and `=`)
1176 and between hunks (`--`)
1180 When set to `always`, always use colors for interactive prompts
1181 and displays (such as those used by "git-add --interactive" and
1182 "git-clean --interactive"). When false (or `never`), never.
1183 When set to `true` or `auto`, use colors only when the output is
1184 to the terminal. If unset, then the value of `color.ui` is
1185 used (`auto` by default).
1187 color.interactive.<slot>::
1188 Use customized color for 'git add --interactive' and 'git clean
1189 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1190 or `error`, for four distinct types of normal output from
1191 interactive commands.
1194 A boolean to enable/disable colored output when the pager is in
1195 use (default is true).
1198 A boolean to enable/disable color in the output of
1199 linkgit:git-show-branch[1]. May be set to `always`,
1200 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1201 only when the output is to a terminal. If unset, then the
1202 value of `color.ui` is used (`auto` by default).
1205 A boolean to enable/disable color in the output of
1206 linkgit:git-status[1]. May be set to `always`,
1207 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1208 only when the output is to a terminal. If unset, then the
1209 value of `color.ui` is used (`auto` by default).
1211 color.status.<slot>::
1212 Use customized color for status colorization. `<slot>` is
1213 one of `header` (the header text of the status message),
1214 `added` or `updated` (files which are added but not committed),
1215 `changed` (files which are changed but not added in the index),
1216 `untracked` (files which are not tracked by Git),
1217 `branch` (the current branch),
1218 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1220 `localBranch` or `remoteBranch` (the local and remote branch names,
1221 respectively, when branch and tracking information is displayed in the
1222 status short-format), or
1223 `unmerged` (files which have unmerged changes).
1226 This variable determines the default value for variables such
1227 as `color.diff` and `color.grep` that control the use of color
1228 per command family. Its scope will expand as more commands learn
1229 configuration to set a default for the `--color` option. Set it
1230 to `false` or `never` if you prefer Git commands not to use
1231 color unless enabled explicitly with some other configuration
1232 or the `--color` option. Set it to `always` if you want all
1233 output not intended for machine consumption to use color, to
1234 `true` or `auto` (this is the default since Git 1.8.4) if you
1235 want such output to use color when written to the terminal.
1238 Specify whether supported commands should output in columns.
1239 This variable consists of a list of tokens separated by spaces
1242 These options control when the feature should be enabled
1243 (defaults to 'never'):
1247 always show in columns
1249 never show in columns
1251 show in columns if the output is to the terminal
1254 These options control layout (defaults to 'column'). Setting any
1255 of these implies 'always' if none of 'always', 'never', or 'auto' are
1260 fill columns before rows
1262 fill rows before columns
1267 Finally, these options can be combined with a layout option (defaults
1272 make unequal size columns to utilize more space
1274 make equal size columns
1278 Specify whether to output branch listing in `git branch` in columns.
1279 See `column.ui` for details.
1282 Specify the layout when list items in `git clean -i`, which always
1283 shows files and directories in columns. See `column.ui` for details.
1286 Specify whether to output untracked files in `git status` in columns.
1287 See `column.ui` for details.
1290 Specify whether to output tag listing in `git tag` in columns.
1291 See `column.ui` for details.
1294 This setting overrides the default of the `--cleanup` option in
1295 `git commit`. See linkgit:git-commit[1] for details. Changing the
1296 default can be useful when you always want to keep lines that begin
1297 with comment character `#` in your log message, in which case you
1298 would do `git config commit.cleanup whitespace` (note that you will
1299 have to remove the help lines that begin with `#` in the commit log
1300 template yourself, if you do this).
1304 A boolean to specify whether all commits should be GPG signed.
1305 Use of this option when doing operations such as rebase can
1306 result in a large number of commits being signed. It may be
1307 convenient to use an agent to avoid typing your GPG passphrase
1311 A boolean to enable/disable inclusion of status information in the
1312 commit message template when using an editor to prepare the commit
1313 message. Defaults to true.
1316 Specify the pathname of a file to use as the template for
1317 new commit messages.
1320 A boolean or int to specify the level of verbose with `git commit`.
1321 See linkgit:git-commit[1].
1324 Specify an external helper to be called when a username or
1325 password credential is needed; the helper may consult external
1326 storage to avoid prompting the user for the credentials. Note
1327 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1330 credential.useHttpPath::
1331 When acquiring credentials, consider the "path" component of an http
1332 or https URL to be important. Defaults to false. See
1333 linkgit:gitcredentials[7] for more information.
1335 credential.username::
1336 If no username is set for a network authentication, use this username
1337 by default. See credential.<context>.* below, and
1338 linkgit:gitcredentials[7].
1340 credential.<url>.*::
1341 Any of the credential.* options above can be applied selectively to
1342 some credentials. For example "credential.https://example.com.username"
1343 would set the default username only for https connections to
1344 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1347 credentialCache.ignoreSIGHUP::
1348 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1350 include::diff-config.txt[]
1352 difftool.<tool>.path::
1353 Override the path for the given tool. This is useful in case
1354 your tool is not in the PATH.
1356 difftool.<tool>.cmd::
1357 Specify the command to invoke the specified diff tool.
1358 The specified command is evaluated in shell with the following
1359 variables available: 'LOCAL' is set to the name of the temporary
1360 file containing the contents of the diff pre-image and 'REMOTE'
1361 is set to the name of the temporary file containing the contents
1362 of the diff post-image.
1365 Prompt before each invocation of the diff tool.
1367 fastimport.unpackLimit::
1368 If the number of objects imported by linkgit:git-fast-import[1]
1369 is below this limit, then the objects will be unpacked into
1370 loose object files. However if the number of imported objects
1371 equals or exceeds this limit then the pack will be stored as a
1372 pack. Storing the pack from a fast-import can make the import
1373 operation complete faster, especially on slow filesystems. If
1374 not set, the value of `transfer.unpackLimit` is used instead.
1376 fetch.recurseSubmodules::
1377 This option can be either set to a boolean value or to 'on-demand'.
1378 Setting it to a boolean changes the behavior of fetch and pull to
1379 unconditionally recurse into submodules when set to true or to not
1380 recurse at all when set to false. When set to 'on-demand' (the default
1381 value), fetch and pull will only recurse into a populated submodule
1382 when its superproject retrieves a commit that updates the submodule's
1386 If it is set to true, git-fetch-pack will check all fetched
1387 objects. It will abort in the case of a malformed object or a
1388 broken link. The result of an abort are only dangling objects.
1389 Defaults to false. If not set, the value of `transfer.fsckObjects`
1393 If the number of objects fetched over the Git native
1394 transfer is below this
1395 limit, then the objects will be unpacked into loose object
1396 files. However if the number of received objects equals or
1397 exceeds this limit then the received pack will be stored as
1398 a pack, after adding any missing delta bases. Storing the
1399 pack from a push can make the push operation complete faster,
1400 especially on slow filesystems. If not set, the value of
1401 `transfer.unpackLimit` is used instead.
1404 If true, fetch will automatically behave as if the `--prune`
1405 option was given on the command line. See also `remote.<name>.prune`.
1408 Control how ref update status is printed. Valid values are
1409 `full` and `compact`. Default value is `full`. See section
1410 OUTPUT in linkgit:git-fetch[1] for detail.
1413 Enable multipart/mixed attachments as the default for
1414 'format-patch'. The value can also be a double quoted string
1415 which will enable attachments as the default and set the
1416 value as the boundary. See the --attach option in
1417 linkgit:git-format-patch[1].
1420 Provides the default value for the `--from` option to format-patch.
1421 Accepts a boolean value, or a name and email address. If false,
1422 format-patch defaults to `--no-from`, using commit authors directly in
1423 the "From:" field of patch mails. If true, format-patch defaults to
1424 `--from`, using your committer identity in the "From:" field of patch
1425 mails and including a "From:" field in the body of the patch mail if
1426 different. If set to a non-boolean value, format-patch uses that
1427 value instead of your committer identity. Defaults to false.
1430 A boolean which can enable or disable sequence numbers in patch
1431 subjects. It defaults to "auto" which enables it only if there
1432 is more than one patch. It can be enabled or disabled for all
1433 messages by setting it to "true" or "false". See --numbered
1434 option in linkgit:git-format-patch[1].
1437 Additional email headers to include in a patch to be submitted
1438 by mail. See linkgit:git-format-patch[1].
1442 Additional recipients to include in a patch to be submitted
1443 by mail. See the --to and --cc options in
1444 linkgit:git-format-patch[1].
1446 format.subjectPrefix::
1447 The default for format-patch is to output files with the '[PATCH]'
1448 subject prefix. Use this variable to change that prefix.
1451 The default for format-patch is to output a signature containing
1452 the Git version number. Use this variable to change that default.
1453 Set this variable to the empty string ("") to suppress
1454 signature generation.
1456 format.signatureFile::
1457 Works just like format.signature except the contents of the
1458 file specified by this variable will be used as the signature.
1461 The default for format-patch is to output files with the suffix
1462 `.patch`. Use this variable to change that suffix (make sure to
1463 include the dot if you want it).
1466 The default pretty format for log/show/whatchanged command,
1467 See linkgit:git-log[1], linkgit:git-show[1],
1468 linkgit:git-whatchanged[1].
1471 The default threading style for 'git format-patch'. Can be
1472 a boolean value, or `shallow` or `deep`. `shallow` threading
1473 makes every mail a reply to the head of the series,
1474 where the head is chosen from the cover letter, the
1475 `--in-reply-to`, and the first patch mail, in this order.
1476 `deep` threading makes every mail a reply to the previous one.
1477 A true boolean value is the same as `shallow`, and a false
1478 value disables threading.
1481 A boolean value which lets you enable the `-s/--signoff` option of
1482 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1483 patch should be a conscious act and means that you certify you have
1484 the rights to submit this work under the same open source license.
1485 Please see the 'SubmittingPatches' document for further discussion.
1487 format.coverLetter::
1488 A boolean that controls whether to generate a cover-letter when
1489 format-patch is invoked, but in addition can be set to "auto", to
1490 generate a cover-letter only when there's more than one patch.
1492 format.outputDirectory::
1493 Set a custom directory to store the resulting files instead of the
1494 current working directory.
1496 format.useAutoBase::
1497 A boolean value which lets you enable the `--base=auto` option of
1498 format-patch by default.
1500 filter.<driver>.clean::
1501 The command which is used to convert the content of a worktree
1502 file to a blob upon checkin. See linkgit:gitattributes[5] for
1505 filter.<driver>.smudge::
1506 The command which is used to convert the content of a blob
1507 object to a worktree file upon checkout. See
1508 linkgit:gitattributes[5] for details.
1511 Allows overriding the message type (error, warn or ignore) of a
1512 specific message ID such as `missingEmail`.
1514 For convenience, fsck prefixes the error/warning with the message ID,
1515 e.g. "missingEmail: invalid author/committer line - missing email" means
1516 that setting `fsck.missingEmail = ignore` will hide that issue.
1518 This feature is intended to support working with legacy repositories
1519 which cannot be repaired without disruptive changes.
1522 The path to a sorted list of object names (i.e. one SHA-1 per
1523 line) that are known to be broken in a non-fatal way and should
1524 be ignored. This feature is useful when an established project
1525 should be accepted despite early commits containing errors that
1526 can be safely ignored such as invalid committer email addresses.
1527 Note: corrupt objects cannot be skipped with this setting.
1529 gc.aggressiveDepth::
1530 The depth parameter used in the delta compression
1531 algorithm used by 'git gc --aggressive'. This defaults
1534 gc.aggressiveWindow::
1535 The window size parameter used in the delta compression
1536 algorithm used by 'git gc --aggressive'. This defaults
1540 When there are approximately more than this many loose
1541 objects in the repository, `git gc --auto` will pack them.
1542 Some Porcelain commands use this command to perform a
1543 light-weight garbage collection from time to time. The
1544 default value is 6700. Setting this to 0 disables it.
1547 When there are more than this many packs that are not
1548 marked with `*.keep` file in the repository, `git gc
1549 --auto` consolidates them into one larger pack. The
1550 default value is 50. Setting this to 0 disables it.
1553 Make `git gc --auto` return immediately and run in background
1554 if the system supports it. Default is true.
1557 If the file gc.log exists, then `git gc --auto` won't run
1558 unless that file is more than 'gc.logExpiry' old. Default is
1559 "1.day". See `gc.pruneExpire` for more ways to specify its
1563 Running `git pack-refs` in a repository renders it
1564 unclonable by Git versions prior to 1.5.1.2 over dumb
1565 transports such as HTTP. This variable determines whether
1566 'git gc' runs `git pack-refs`. This can be set to `notbare`
1567 to enable it within all non-bare repos or it can be set to a
1568 boolean value. The default is `true`.
1571 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1572 Override the grace period with this config variable. The value
1573 "now" may be used to disable this grace period and always prune
1574 unreachable objects immediately, or "never" may be used to
1575 suppress pruning. This feature helps prevent corruption when
1576 'git gc' runs concurrently with another process writing to the
1577 repository; see the "NOTES" section of linkgit:git-gc[1].
1579 gc.worktreePruneExpire::
1580 When 'git gc' is run, it calls
1581 'git worktree prune --expire 3.months.ago'.
1582 This config variable can be used to set a different grace
1583 period. The value "now" may be used to disable the grace
1584 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1585 may be used to suppress pruning.
1588 gc.<pattern>.reflogExpire::
1589 'git reflog expire' removes reflog entries older than
1590 this time; defaults to 90 days. The value "now" expires all
1591 entries immediately, and "never" suppresses expiration
1592 altogether. With "<pattern>" (e.g.
1593 "refs/stash") in the middle the setting applies only to
1594 the refs that match the <pattern>.
1596 gc.reflogExpireUnreachable::
1597 gc.<pattern>.reflogExpireUnreachable::
1598 'git reflog expire' removes reflog entries older than
1599 this time and are not reachable from the current tip;
1600 defaults to 30 days. The value "now" expires all entries
1601 immediately, and "never" suppresses expiration altogether.
1602 With "<pattern>" (e.g. "refs/stash")
1603 in the middle, the setting applies only to the refs that
1604 match the <pattern>.
1607 Records of conflicted merge you resolved earlier are
1608 kept for this many days when 'git rerere gc' is run.
1609 You can also use more human-readable "1.month.ago", etc.
1610 The default is 60 days. See linkgit:git-rerere[1].
1612 gc.rerereUnresolved::
1613 Records of conflicted merge you have not resolved are
1614 kept for this many days when 'git rerere gc' is run.
1615 You can also use more human-readable "1.month.ago", etc.
1616 The default is 15 days. See linkgit:git-rerere[1].
1618 gitcvs.commitMsgAnnotation::
1619 Append this string to each commit message. Set to empty string
1620 to disable this feature. Defaults to "via git-CVS emulator".
1623 Whether the CVS server interface is enabled for this repository.
1624 See linkgit:git-cvsserver[1].
1627 Path to a log file where the CVS server interface well... logs
1628 various stuff. See linkgit:git-cvsserver[1].
1630 gitcvs.usecrlfattr::
1631 If true, the server will look up the end-of-line conversion
1632 attributes for files to determine the `-k` modes to use. If
1633 the attributes force Git to treat a file as text,
1634 the `-k` mode will be left blank so CVS clients will
1635 treat it as text. If they suppress text conversion, the file
1636 will be set with '-kb' mode, which suppresses any newline munging
1637 the client might otherwise do. If the attributes do not allow
1638 the file type to be determined, then `gitcvs.allBinary` is
1639 used. See linkgit:gitattributes[5].
1642 This is used if `gitcvs.usecrlfattr` does not resolve
1643 the correct '-kb' mode to use. If true, all
1644 unresolved files are sent to the client in
1645 mode '-kb'. This causes the client to treat them
1646 as binary files, which suppresses any newline munging it
1647 otherwise might do. Alternatively, if it is set to "guess",
1648 then the contents of the file are examined to decide if
1649 it is binary, similar to `core.autocrlf`.
1652 Database used by git-cvsserver to cache revision information
1653 derived from the Git repository. The exact meaning depends on the
1654 used database driver, for SQLite (which is the default driver) this
1655 is a filename. Supports variable substitution (see
1656 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1657 Default: '%Ggitcvs.%m.sqlite'
1660 Used Perl DBI driver. You can specify any available driver
1661 for this here, but it might not work. git-cvsserver is tested
1662 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1663 reported *not* to work with 'DBD::mysql'. Experimental feature.
1664 May not contain double colons (`:`). Default: 'SQLite'.
1665 See linkgit:git-cvsserver[1].
1667 gitcvs.dbUser, gitcvs.dbPass::
1668 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1669 since SQLite has no concept of database users and/or passwords.
1670 'gitcvs.dbUser' supports variable substitution (see
1671 linkgit:git-cvsserver[1] for details).
1673 gitcvs.dbTableNamePrefix::
1674 Database table name prefix. Prepended to the names of any
1675 database tables used, allowing a single database to be used
1676 for several repositories. Supports variable substitution (see
1677 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1678 characters will be replaced with underscores.
1680 All gitcvs variables except for `gitcvs.usecrlfattr` and
1681 `gitcvs.allBinary` can also be specified as
1682 'gitcvs.<access_method>.<varname>' (where 'access_method'
1683 is one of "ext" and "pserver") to make them apply only for the given
1687 gitweb.description::
1690 See linkgit:gitweb[1] for description.
1698 gitweb.remote_heads::
1701 See linkgit:gitweb.conf[5] for description.
1704 If set to true, enable `-n` option by default.
1707 Set the default matching behavior. Using a value of 'basic', 'extended',
1708 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1709 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1710 value 'default' will return to the default matching behavior.
1712 grep.extendedRegexp::
1713 If set to true, enable `--extended-regexp` option by default. This
1714 option is ignored when the `grep.patternType` option is set to a value
1715 other than 'default'.
1718 Number of grep worker threads to use.
1719 See `grep.threads` in linkgit:git-grep[1] for more information.
1721 grep.fallbackToNoIndex::
1722 If set to true, fall back to git grep --no-index if git grep
1723 is executed outside of a git repository. Defaults to false.
1726 Use this custom program instead of "`gpg`" found on `$PATH` when
1727 making or verifying a PGP signature. The program must support the
1728 same command-line interface as GPG, namely, to verify a detached
1729 signature, "`gpg --verify $file - <$signature`" is run, and the
1730 program is expected to signal a good signature by exiting with
1731 code 0, and to generate an ASCII-armored detached signature, the
1732 standard input of "`gpg -bsau $key`" is fed with the contents to be
1733 signed, and the program is expected to send the result to its
1736 gui.commitMsgWidth::
1737 Defines how wide the commit message window is in the
1738 linkgit:git-gui[1]. "75" is the default.
1741 Specifies how many context lines should be used in calls to diff
1742 made by the linkgit:git-gui[1]. The default is "5".
1744 gui.displayUntracked::
1745 Determines if linkgit:git-gui[1] shows untracked files
1746 in the file list. The default is "true".
1749 Specifies the default encoding to use for displaying of
1750 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1751 It can be overridden by setting the 'encoding' attribute
1752 for relevant files (see linkgit:gitattributes[5]).
1753 If this option is not set, the tools default to the
1756 gui.matchTrackingBranch::
1757 Determines if new branches created with linkgit:git-gui[1] should
1758 default to tracking remote branches with matching names or
1759 not. Default: "false".
1761 gui.newBranchTemplate::
1762 Is used as suggested name when creating new branches using the
1765 gui.pruneDuringFetch::
1766 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1767 performing a fetch. The default value is "false".
1770 Determines if linkgit:git-gui[1] should trust the file modification
1771 timestamp or not. By default the timestamps are not trusted.
1773 gui.spellingDictionary::
1774 Specifies the dictionary used for spell checking commit messages in
1775 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1779 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1780 location detection. It makes blame significantly faster on huge
1781 repositories at the expense of less thorough copy detection.
1783 gui.copyBlameThreshold::
1784 Specifies the threshold to use in 'git gui blame' original location
1785 detection, measured in alphanumeric characters. See the
1786 linkgit:git-blame[1] manual for more information on copy detection.
1788 gui.blamehistoryctx::
1789 Specifies the radius of history context in days to show in
1790 linkgit:gitk[1] for the selected commit, when the `Show History
1791 Context` menu item is invoked from 'git gui blame'. If this
1792 variable is set to zero, the whole history is shown.
1794 guitool.<name>.cmd::
1795 Specifies the shell command line to execute when the corresponding item
1796 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1797 mandatory for every tool. The command is executed from the root of
1798 the working directory, and in the environment it receives the name of
1799 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1800 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1801 the head is detached, 'CUR_BRANCH' is empty).
1803 guitool.<name>.needsFile::
1804 Run the tool only if a diff is selected in the GUI. It guarantees
1805 that 'FILENAME' is not empty.
1807 guitool.<name>.noConsole::
1808 Run the command silently, without creating a window to display its
1811 guitool.<name>.noRescan::
1812 Don't rescan the working directory for changes after the tool
1815 guitool.<name>.confirm::
1816 Show a confirmation dialog before actually running the tool.
1818 guitool.<name>.argPrompt::
1819 Request a string argument from the user, and pass it to the tool
1820 through the `ARGS` environment variable. Since requesting an
1821 argument implies confirmation, the 'confirm' option has no effect
1822 if this is enabled. If the option is set to 'true', 'yes', or '1',
1823 the dialog uses a built-in generic prompt; otherwise the exact
1824 value of the variable is used.
1826 guitool.<name>.revPrompt::
1827 Request a single valid revision from the user, and set the
1828 `REVISION` environment variable. In other aspects this option
1829 is similar to 'argPrompt', and can be used together with it.
1831 guitool.<name>.revUnmerged::
1832 Show only unmerged branches in the 'revPrompt' subdialog.
1833 This is useful for tools similar to merge or rebase, but not
1834 for things like checkout or reset.
1836 guitool.<name>.title::
1837 Specifies the title to use for the prompt dialog. The default
1840 guitool.<name>.prompt::
1841 Specifies the general prompt string to display at the top of
1842 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1843 The default value includes the actual command.
1846 Specify the browser that will be used to display help in the
1847 'web' format. See linkgit:git-help[1].
1850 Override the default help format used by linkgit:git-help[1].
1851 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1852 the default. 'web' and 'html' are the same.
1855 Automatically correct and execute mistyped commands after
1856 waiting for the given number of deciseconds (0.1 sec). If more
1857 than one command can be deduced from the entered text, nothing
1858 will be executed. If the value of this option is negative,
1859 the corrected command will be executed immediately. If the
1860 value is 0 - the command will be just shown but not executed.
1861 This is the default.
1864 Specify the path where the HTML documentation resides. File system paths
1865 and URLs are supported. HTML pages will be prefixed with this path when
1866 help is displayed in the 'web' format. This defaults to the documentation
1867 path of your Git installation.
1870 Override the HTTP proxy, normally configured using the 'http_proxy',
1871 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1872 addition to the syntax understood by curl, it is possible to specify a
1873 proxy string with a user name but no password, in which case git will
1874 attempt to acquire one in the same way it does for other credentials. See
1875 linkgit:gitcredentials[7] for more information. The syntax thus is
1876 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1877 on a per-remote basis; see remote.<name>.proxy
1879 http.proxyAuthMethod::
1880 Set the method with which to authenticate against the HTTP proxy. This
1881 only takes effect if the configured proxy string contains a user name part
1882 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1883 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1884 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1885 variable. Possible values are:
1888 * `anyauth` - Automatically pick a suitable authentication method. It is
1889 assumed that the proxy answers an unauthenticated request with a 407
1890 status code and one or more Proxy-authenticate headers with supported
1891 authentication methods. This is the default.
1892 * `basic` - HTTP Basic authentication
1893 * `digest` - HTTP Digest authentication; this prevents the password from being
1894 transmitted to the proxy in clear text
1895 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1897 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1901 Attempt authentication without seeking a username or password. This
1902 can be used to attempt GSS-Negotiate authentication without specifying
1903 a username in the URL, as libcurl normally requires a username for
1907 Control GSSAPI credential delegation. The delegation is disabled
1908 by default in libcurl since version 7.21.7. Set parameter to tell
1909 the server what it is allowed to delegate when it comes to user
1910 credentials. Used with GSS/kerberos. Possible values are:
1913 * `none` - Don't allow any delegation.
1914 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1915 Kerberos service ticket, which is a matter of realm policy.
1916 * `always` - Unconditionally allow the server to delegate.
1921 Pass an additional HTTP header when communicating with a server. If
1922 more than one such entry exists, all of them are added as extra
1923 headers. To allow overriding the settings inherited from the system
1924 config, an empty value will reset the extra headers to the empty list.
1927 The pathname of a file containing previously stored cookie lines,
1928 which should be used
1929 in the Git http session, if they match the server. The file format
1930 of the file to read cookies from should be plain HTTP headers or
1931 the Netscape/Mozilla cookie file format (see `curl(1)`).
1932 NOTE that the file specified with http.cookieFile is used only as
1933 input unless http.saveCookies is set.
1936 If set, store cookies received during requests to the file specified by
1937 http.cookieFile. Has no effect if http.cookieFile is unset.
1940 The SSL version to use when negotiating an SSL connection, if you
1941 want to force the default. The available and default version
1942 depend on whether libcurl was built against NSS or OpenSSL and the
1943 particular configuration of the crypto library in use. Internally
1944 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1945 documentation for more details on the format of this option and
1946 for the ssl version supported. Actually the possible values of
1957 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1958 To force git to use libcurl's default ssl version and ignore any
1959 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1962 http.sslCipherList::
1963 A list of SSL ciphers to use when negotiating an SSL connection.
1964 The available ciphers depend on whether libcurl was built against
1965 NSS or OpenSSL and the particular configuration of the crypto
1966 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1967 option; see the libcurl documentation for more details on the format
1970 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1971 To force git to use libcurl's default cipher list and ignore any
1972 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1976 Whether to verify the SSL certificate when fetching or pushing
1977 over HTTPS. Defaults to true. Can be overridden by the
1978 `GIT_SSL_NO_VERIFY` environment variable.
1981 File containing the SSL certificate when fetching or pushing
1982 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1986 File containing the SSL private key when fetching or pushing
1987 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1990 http.sslCertPasswordProtected::
1991 Enable Git's password prompt for the SSL certificate. Otherwise
1992 OpenSSL will prompt the user, possibly many times, if the
1993 certificate or private key is encrypted. Can be overridden by the
1994 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1997 File containing the certificates to verify the peer with when
1998 fetching or pushing over HTTPS. Can be overridden by the
1999 `GIT_SSL_CAINFO` environment variable.
2002 Path containing files with the CA certificates to verify the peer
2003 with when fetching or pushing over HTTPS. Can be overridden
2004 by the `GIT_SSL_CAPATH` environment variable.
2007 Public key of the https service. It may either be the filename of
2008 a PEM or DER encoded public key file or a string starting with
2009 'sha256//' followed by the base64 encoded sha256 hash of the
2010 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2011 exit with an error if this option is set but not supported by
2015 Attempt to use AUTH SSL/TLS and encrypted data transfers
2016 when connecting via regular FTP protocol. This might be needed
2017 if the FTP server requires it for security reasons or you wish
2018 to connect securely whenever remote FTP server supports it.
2019 Default is false since it might trigger certificate verification
2020 errors on misconfigured servers.
2023 How many HTTP requests to launch in parallel. Can be overridden
2024 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2027 The number of curl sessions (counted across slots) to be kept across
2028 requests. They will not be ended with curl_easy_cleanup() until
2029 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2030 value will be capped at 1. Defaults to 1.
2033 Maximum size in bytes of the buffer used by smart HTTP
2034 transports when POSTing data to the remote system.
2035 For requests larger than this buffer size, HTTP/1.1 and
2036 Transfer-Encoding: chunked is used to avoid creating a
2037 massive pack file locally. Default is 1 MiB, which is
2038 sufficient for most requests.
2040 http.lowSpeedLimit, http.lowSpeedTime::
2041 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2042 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2043 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2044 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2047 A boolean which disables using of EPSV ftp command by curl.
2048 This can helpful with some "poor" ftp servers which don't
2049 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2050 environment variable. Default is false (curl will use EPSV).
2053 The HTTP USER_AGENT string presented to an HTTP server. The default
2054 value represents the version of the client Git such as git/1.7.1.
2055 This option allows you to override this value to a more common value
2056 such as Mozilla/4.0. This may be necessary, for instance, if
2057 connecting through a firewall that restricts HTTP connections to a set
2058 of common USER_AGENT strings (but not including those like git/1.7.1).
2059 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2061 http.followRedirects::
2062 Whether git should follow HTTP redirects. If set to `true`, git
2063 will transparently follow any redirect issued by a server it
2064 encounters. If set to `false`, git will treat all redirects as
2065 errors. If set to `initial`, git will follow redirects only for
2066 the initial request to a remote, but not for subsequent
2067 follow-up HTTP requests. Since git uses the redirected URL as
2068 the base for the follow-up requests, this is generally
2069 sufficient. The default is `initial`.
2072 Any of the http.* options above can be applied selectively to some URLs.
2073 For a config key to match a URL, each element of the config key is
2074 compared to that of the URL, in the following order:
2077 . Scheme (e.g., `https` in `https://example.com/`). This field
2078 must match exactly between the config key and the URL.
2080 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2081 This field must match between the config key and the URL. It is
2082 possible to specify a `*` as part of the host name to match all subdomains
2083 at this level. `https://*.example.com/` for example would match
2084 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2086 . Port number (e.g., `8080` in `http://example.com:8080/`).
2087 This field must match exactly between the config key and the URL.
2088 Omitted port numbers are automatically converted to the correct
2089 default for the scheme before matching.
2091 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2092 path field of the config key must match the path field of the URL
2093 either exactly or as a prefix of slash-delimited path elements. This means
2094 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2095 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2096 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2097 key with just path `foo/`).
2099 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2100 the config key has a user name it must match the user name in the
2101 URL exactly. If the config key does not have a user name, that
2102 config key will match a URL with any user name (including none),
2103 but at a lower precedence than a config key with a user name.
2106 The list above is ordered by decreasing precedence; a URL that matches
2107 a config key's path is preferred to one that matches its user name. For example,
2108 if the URL is `https://user@example.com/foo/bar` a config key match of
2109 `https://example.com/foo` will be preferred over a config key match of
2110 `https://user@example.com`.
2112 All URLs are normalized before attempting any matching (the password part,
2113 if embedded in the URL, is always ignored for matching purposes) so that
2114 equivalent URLs that are simply spelled differently will match properly.
2115 Environment variable settings always override any matches. The URLs that are
2116 matched against are those given directly to Git commands. This means any URLs
2117 visited as a result of a redirection do not participate in matching.
2120 By default, Git determines the command line arguments to use
2121 based on the basename of the configured SSH command (configured
2122 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2123 the config setting `core.sshCommand`). If the basename is
2124 unrecognized, Git will attempt to detect support of OpenSSH
2125 options by first invoking the configured SSH command with the
2126 `-G` (print configuration) option and will subsequently use
2127 OpenSSH options (if that is successful) or no options besides
2128 the host and remote command (if it fails).
2130 The config variable `ssh.variant` can be set to override this detection.
2131 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2132 `tortoiseplink`, `simple` (no options except the host and remote command).
2133 The default auto-detection can be explicitly requested using the value
2134 `auto`. Any other value is treated as `ssh`. This setting can also be
2135 overridden via the environment variable `GIT_SSH_VARIANT`.
2137 The current command-line parameters used for each variant are as
2142 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2144 * `simple` - [username@]host command
2146 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2148 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2152 Except for the `simple` variant, command-line parameters are likely to
2153 change as git gains new features.
2155 i18n.commitEncoding::
2156 Character encoding the commit messages are stored in; Git itself
2157 does not care per se, but this information is necessary e.g. when
2158 importing commits from emails or in the gitk graphical history
2159 browser (and possibly at other places in the future or in other
2160 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2162 i18n.logOutputEncoding::
2163 Character encoding the commit messages are converted to when
2164 running 'git log' and friends.
2167 The configuration variables in the 'imap' section are described
2168 in linkgit:git-imap-send[1].
2171 Specify the version with which new index files should be
2172 initialized. This does not affect existing repositories.
2175 Specify the directory from which templates will be copied.
2176 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2179 Specify the program that will be used to browse your working
2180 repository in gitweb. See linkgit:git-instaweb[1].
2183 The HTTP daemon command-line to start gitweb on your working
2184 repository. See linkgit:git-instaweb[1].
2187 If true the web server started by linkgit:git-instaweb[1] will
2188 be bound to the local IP (127.0.0.1).
2190 instaweb.modulePath::
2191 The default module path for linkgit:git-instaweb[1] to use
2192 instead of /usr/lib/apache2/modules. Only used if httpd
2196 The port number to bind the gitweb httpd to. See
2197 linkgit:git-instaweb[1].
2199 interactive.singleKey::
2200 In interactive commands, allow the user to provide one-letter
2201 input with a single key (i.e., without hitting enter).
2202 Currently this is used by the `--patch` mode of
2203 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2204 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2205 setting is silently ignored if portable keystroke input
2206 is not available; requires the Perl module Term::ReadKey.
2208 interactive.diffFilter::
2209 When an interactive command (such as `git add --patch`) shows
2210 a colorized diff, git will pipe the diff through the shell
2211 command defined by this configuration variable. The command may
2212 mark up the diff further for human consumption, provided that it
2213 retains a one-to-one correspondence with the lines in the
2214 original diff. Defaults to disabled (no filtering).
2217 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2218 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2219 override this option with `--no-abbrev-commit`.
2222 Set the default date-time mode for the 'log' command.
2223 Setting a value for log.date is similar to using 'git log''s
2224 `--date` option. See linkgit:git-log[1] for details.
2227 Print out the ref names of any commits that are shown by the log
2228 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2229 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2230 specified, the full ref name (including prefix) will be printed.
2231 If 'auto' is specified, then if the output is going to a terminal,
2232 the ref names are shown as if 'short' were given, otherwise no ref
2233 names are shown. This is the same as the `--decorate` option
2237 If `true`, `git log` will act as if the `--follow` option was used when
2238 a single <path> is given. This has the same limitations as `--follow`,
2239 i.e. it cannot be used to follow multiple files and does not work well
2240 on non-linear history.
2243 A list of colors, separated by commas, that can be used to draw
2244 history lines in `git log --graph`.
2247 If true, the initial commit will be shown as a big creation event.
2248 This is equivalent to a diff against an empty tree.
2249 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2250 normally hide the root commit will now show it. True by default.
2253 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2254 linkgit:git-whatchanged[1] assume `--show-signature`.
2257 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2258 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2261 If true, makes linkgit:git-mailinfo[1] (and therefore
2262 linkgit:git-am[1]) act by default as if the --scissors option
2263 was provided on the command-line. When active, this features
2264 removes everything from the message body before a scissors
2265 line (i.e. consisting mainly of ">8", "8<" and "-").
2268 The location of an augmenting mailmap file. The default
2269 mailmap, located in the root of the repository, is loaded
2270 first, then the mailmap file pointed to by this variable.
2271 The location of the mailmap file may be in a repository
2272 subdirectory, or somewhere outside of the repository itself.
2273 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2276 Like `mailmap.file`, but consider the value as a reference to a
2277 blob in the repository. If both `mailmap.file` and
2278 `mailmap.blob` are given, both are parsed, with entries from
2279 `mailmap.file` taking precedence. In a bare repository, this
2280 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2284 Specify the programs that may be used to display help in the
2285 'man' format. See linkgit:git-help[1].
2288 Specify the command to invoke the specified man viewer. The
2289 specified command is evaluated in shell with the man page
2290 passed as argument. (See linkgit:git-help[1].)
2293 Override the path for the given tool that may be used to
2294 display help in the 'man' format. See linkgit:git-help[1].
2296 include::merge-config.txt[]
2298 mergetool.<tool>.path::
2299 Override the path for the given tool. This is useful in case
2300 your tool is not in the PATH.
2302 mergetool.<tool>.cmd::
2303 Specify the command to invoke the specified merge tool. The
2304 specified command is evaluated in shell with the following
2305 variables available: 'BASE' is the name of a temporary file
2306 containing the common base of the files to be merged, if available;
2307 'LOCAL' is the name of a temporary file containing the contents of
2308 the file on the current branch; 'REMOTE' is the name of a temporary
2309 file containing the contents of the file from the branch being
2310 merged; 'MERGED' contains the name of the file to which the merge
2311 tool should write the results of a successful merge.
2313 mergetool.<tool>.trustExitCode::
2314 For a custom merge command, specify whether the exit code of
2315 the merge command can be used to determine whether the merge was
2316 successful. If this is not set to true then the merge target file
2317 timestamp is checked and the merge assumed to have been successful
2318 if the file has been updated, otherwise the user is prompted to
2319 indicate the success of the merge.
2321 mergetool.meld.hasOutput::
2322 Older versions of `meld` do not support the `--output` option.
2323 Git will attempt to detect whether `meld` supports `--output`
2324 by inspecting the output of `meld --help`. Configuring
2325 `mergetool.meld.hasOutput` will make Git skip these checks and
2326 use the configured value instead. Setting `mergetool.meld.hasOutput`
2327 to `true` tells Git to unconditionally use the `--output` option,
2328 and `false` avoids using `--output`.
2330 mergetool.keepBackup::
2331 After performing a merge, the original file with conflict markers
2332 can be saved as a file with a `.orig` extension. If this variable
2333 is set to `false` then this file is not preserved. Defaults to
2334 `true` (i.e. keep the backup files).
2336 mergetool.keepTemporaries::
2337 When invoking a custom merge tool, Git uses a set of temporary
2338 files to pass to the tool. If the tool returns an error and this
2339 variable is set to `true`, then these temporary files will be
2340 preserved, otherwise they will be removed after the tool has
2341 exited. Defaults to `false`.
2343 mergetool.writeToTemp::
2344 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2345 conflicting files in the worktree by default. Git will attempt
2346 to use a temporary directory for these files when set `true`.
2347 Defaults to `false`.
2350 Prompt before each invocation of the merge resolution program.
2352 notes.mergeStrategy::
2353 Which merge strategy to choose by default when resolving notes
2354 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2355 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2356 section of linkgit:git-notes[1] for more information on each strategy.
2358 notes.<name>.mergeStrategy::
2359 Which merge strategy to choose when doing a notes merge into
2360 refs/notes/<name>. This overrides the more general
2361 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2362 linkgit:git-notes[1] for more information on the available strategies.
2365 The (fully qualified) refname from which to show notes when
2366 showing commit messages. The value of this variable can be set
2367 to a glob, in which case notes from all matching refs will be
2368 shown. You may also specify this configuration variable
2369 several times. A warning will be issued for refs that do not
2370 exist, but a glob that does not match any refs is silently
2373 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2374 environment variable, which must be a colon separated list of refs or
2377 The effective value of "core.notesRef" (possibly overridden by
2378 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2381 notes.rewrite.<command>::
2382 When rewriting commits with <command> (currently `amend` or
2383 `rebase`) and this variable is set to `true`, Git
2384 automatically copies your notes from the original to the
2385 rewritten commit. Defaults to `true`, but see
2386 "notes.rewriteRef" below.
2389 When copying notes during a rewrite (see the
2390 "notes.rewrite.<command>" option), determines what to do if
2391 the target commit already has a note. Must be one of
2392 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2393 Defaults to `concatenate`.
2395 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2396 environment variable.
2399 When copying notes during a rewrite, specifies the (fully
2400 qualified) ref whose notes should be copied. The ref may be a
2401 glob, in which case notes in all matching refs will be copied.
2402 You may also specify this configuration several times.
2404 Does not have a default value; you must configure this variable to
2405 enable note rewriting. Set it to `refs/notes/commits` to enable
2406 rewriting for the default commit notes.
2408 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2409 environment variable, which must be a colon separated list of refs or
2413 The size of the window used by linkgit:git-pack-objects[1] when no
2414 window size is given on the command line. Defaults to 10.
2417 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2418 maximum depth is given on the command line. Defaults to 50.
2421 The maximum size of memory that is consumed by each thread
2422 in linkgit:git-pack-objects[1] for pack window memory when
2423 no limit is given on the command line. The value can be
2424 suffixed with "k", "m", or "g". When left unconfigured (or
2425 set explicitly to 0), there will be no limit.
2428 An integer -1..9, indicating the compression level for objects
2429 in a pack file. -1 is the zlib default. 0 means no
2430 compression, and 1..9 are various speed/size tradeoffs, 9 being
2431 slowest. If not set, defaults to core.compression. If that is
2432 not set, defaults to -1, the zlib default, which is "a default
2433 compromise between speed and compression (currently equivalent
2436 Note that changing the compression level will not automatically recompress
2437 all existing objects. You can force recompression by passing the -F option
2438 to linkgit:git-repack[1].
2440 pack.deltaCacheSize::
2441 The maximum memory in bytes used for caching deltas in
2442 linkgit:git-pack-objects[1] before writing them out to a pack.
2443 This cache is used to speed up the writing object phase by not
2444 having to recompute the final delta result once the best match
2445 for all objects is found. Repacking large repositories on machines
2446 which are tight with memory might be badly impacted by this though,
2447 especially if this cache pushes the system into swapping.
2448 A value of 0 means no limit. The smallest size of 1 byte may be
2449 used to virtually disable this cache. Defaults to 256 MiB.
2451 pack.deltaCacheLimit::
2452 The maximum size of a delta, that is cached in
2453 linkgit:git-pack-objects[1]. This cache is used to speed up the
2454 writing object phase by not having to recompute the final delta
2455 result once the best match for all objects is found. Defaults to 1000.
2458 Specifies the number of threads to spawn when searching for best
2459 delta matches. This requires that linkgit:git-pack-objects[1]
2460 be compiled with pthreads otherwise this option is ignored with a
2461 warning. This is meant to reduce packing time on multiprocessor
2462 machines. The required amount of memory for the delta search window
2463 is however multiplied by the number of threads.
2464 Specifying 0 will cause Git to auto-detect the number of CPU's
2465 and set the number of threads accordingly.
2468 Specify the default pack index version. Valid values are 1 for
2469 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2470 the new pack index with capabilities for packs larger than 4 GB
2471 as well as proper protection against the repacking of corrupted
2472 packs. Version 2 is the default. Note that version 2 is enforced
2473 and this config option ignored whenever the corresponding pack is
2476 If you have an old Git that does not understand the version 2 `*.idx` file,
2477 cloning or fetching over a non native protocol (e.g. "http")
2478 that will copy both `*.pack` file and corresponding `*.idx` file from the
2479 other side may give you a repository that cannot be accessed with your
2480 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2481 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2484 pack.packSizeLimit::
2485 The maximum size of a pack. This setting only affects
2486 packing to a file when repacking, i.e. the git:// protocol
2487 is unaffected. It can be overridden by the `--max-pack-size`
2488 option of linkgit:git-repack[1]. Reaching this limit results
2489 in the creation of multiple packfiles; which in turn prevents
2490 bitmaps from being created.
2491 The minimum size allowed is limited to 1 MiB.
2492 The default is unlimited.
2493 Common unit suffixes of 'k', 'm', or 'g' are
2497 When true, git will use pack bitmaps (if available) when packing
2498 to stdout (e.g., during the server side of a fetch). Defaults to
2499 true. You should not generally need to turn this off unless
2500 you are debugging pack bitmaps.
2502 pack.writeBitmaps (deprecated)::
2503 This is a deprecated synonym for `repack.writeBitmaps`.
2505 pack.writeBitmapHashCache::
2506 When true, git will include a "hash cache" section in the bitmap
2507 index (if one is written). This cache can be used to feed git's
2508 delta heuristics, potentially leading to better deltas between
2509 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2510 between an older, bitmapped pack and objects that have been
2511 pushed since the last gc). The downside is that it consumes 4
2512 bytes per object of disk space, and that JGit's bitmap
2513 implementation does not understand it, causing it to complain if
2514 Git and JGit are used on the same repository. Defaults to false.
2517 If the value is boolean, turns on or off pagination of the
2518 output of a particular Git subcommand when writing to a tty.
2519 Otherwise, turns on pagination for the subcommand using the
2520 pager specified by the value of `pager.<cmd>`. If `--paginate`
2521 or `--no-pager` is specified on the command line, it takes
2522 precedence over this option. To disable pagination for all
2523 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2526 Alias for a --pretty= format string, as specified in
2527 linkgit:git-log[1]. Any aliases defined here can be used just
2528 as the built-in pretty formats could. For example,
2529 running `git config pretty.changelog "format:* %H %s"`
2530 would cause the invocation `git log --pretty=changelog`
2531 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2532 Note that an alias with the same name as a built-in format
2533 will be silently ignored.
2536 If set, provide a user defined default policy for all protocols which
2537 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2538 if unset, known-safe protocols (http, https, git, ssh, file) have a
2539 default policy of `always`, known-dangerous protocols (ext) have a
2540 default policy of `never`, and all other protocols have a default
2541 policy of `user`. Supported policies:
2545 * `always` - protocol is always able to be used.
2547 * `never` - protocol is never able to be used.
2549 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2550 either unset or has a value of 1. This policy should be used when you want a
2551 protocol to be directly usable by the user but don't want it used by commands which
2552 execute clone/fetch/push commands without user input, e.g. recursive
2553 submodule initialization.
2557 protocol.<name>.allow::
2558 Set a policy to be used by protocol `<name>` with clone/fetch/push
2559 commands. See `protocol.allow` above for the available policies.
2561 The protocol names currently used by git are:
2564 - `file`: any local file-based path (including `file://` URLs,
2567 - `git`: the anonymous git protocol over a direct TCP
2568 connection (or proxy, if configured)
2570 - `ssh`: git over ssh (including `host:path` syntax,
2573 - `http`: git over http, both "smart http" and "dumb http".
2574 Note that this does _not_ include `https`; if you want to configure
2575 both, you must do so individually.
2577 - any external helpers are named by their protocol (e.g., use
2578 `hg` to allow the `git-remote-hg` helper)
2582 Experimental. If set, clients will attempt to communicate with a
2583 server using the specified protocol version. If unset, no
2584 attempt will be made by the client to communicate using a
2585 particular protocol version, this results in protocol version 0
2591 * `0` - the original wire protocol.
2593 * `1` - the original wire protocol with the addition of a version string
2594 in the initial response from the server.
2599 By default, Git does not create an extra merge commit when merging
2600 a commit that is a descendant of the current commit. Instead, the
2601 tip of the current branch is fast-forwarded. When set to `false`,
2602 this variable tells Git to create an extra merge commit in such
2603 a case (equivalent to giving the `--no-ff` option from the command
2604 line). When set to `only`, only such fast-forward merges are
2605 allowed (equivalent to giving the `--ff-only` option from the
2606 command line). This setting overrides `merge.ff` when pulling.
2609 When true, rebase branches on top of the fetched branch, instead
2610 of merging the default branch from the default remote when "git
2611 pull" is run. See "branch.<name>.rebase" for setting this on a
2614 When preserve, also pass `--preserve-merges` along to 'git rebase'
2615 so that locally committed merge commits will not be flattened
2616 by running 'git pull'.
2618 When the value is `interactive`, the rebase is run in interactive mode.
2620 *NOTE*: this is a possibly dangerous operation; do *not* use
2621 it unless you understand the implications (see linkgit:git-rebase[1]
2625 The default merge strategy to use when pulling multiple branches
2629 The default merge strategy to use when pulling a single branch.
2632 Defines the action `git push` should take if no refspec is
2633 explicitly given. Different values are well-suited for
2634 specific workflows; for instance, in a purely central workflow
2635 (i.e. the fetch source is equal to the push destination),
2636 `upstream` is probably what you want. Possible values are:
2640 * `nothing` - do not push anything (error out) unless a refspec is
2641 explicitly given. This is primarily meant for people who want to
2642 avoid mistakes by always being explicit.
2644 * `current` - push the current branch to update a branch with the same
2645 name on the receiving end. Works in both central and non-central
2648 * `upstream` - push the current branch back to the branch whose
2649 changes are usually integrated into the current branch (which is
2650 called `@{upstream}`). This mode only makes sense if you are
2651 pushing to the same repository you would normally pull from
2652 (i.e. central workflow).
2654 * `tracking` - This is a deprecated synonym for `upstream`.
2656 * `simple` - in centralized workflow, work like `upstream` with an
2657 added safety to refuse to push if the upstream branch's name is
2658 different from the local one.
2660 When pushing to a remote that is different from the remote you normally
2661 pull from, work as `current`. This is the safest option and is suited
2664 This mode has become the default in Git 2.0.
2666 * `matching` - push all branches having the same name on both ends.
2667 This makes the repository you are pushing to remember the set of
2668 branches that will be pushed out (e.g. if you always push 'maint'
2669 and 'master' there and no other branches, the repository you push
2670 to will have these two branches, and your local 'maint' and
2671 'master' will be pushed there).
2673 To use this mode effectively, you have to make sure _all_ the
2674 branches you would push out are ready to be pushed out before
2675 running 'git push', as the whole point of this mode is to allow you
2676 to push all of the branches in one go. If you usually finish work
2677 on only one branch and push out the result, while other branches are
2678 unfinished, this mode is not for you. Also this mode is not
2679 suitable for pushing into a shared central repository, as other
2680 people may add new branches there, or update the tip of existing
2681 branches outside your control.
2683 This used to be the default, but not since Git 2.0 (`simple` is the
2689 If set to true enable `--follow-tags` option by default. You
2690 may override this configuration at time of push by specifying
2694 May be set to a boolean value, or the string 'if-asked'. A true
2695 value causes all pushes to be GPG signed, as if `--signed` is
2696 passed to linkgit:git-push[1]. The string 'if-asked' causes
2697 pushes to be signed if the server supports it, as if
2698 `--signed=if-asked` is passed to 'git push'. A false value may
2699 override a value from a lower-priority config file. An explicit
2700 command-line flag always overrides this config option.
2703 When no `--push-option=<option>` argument is given from the
2704 command line, `git push` behaves as if each <value> of
2705 this variable is given as `--push-option=<value>`.
2707 This is a multi-valued variable, and an empty value can be used in a
2708 higher priority configuration file (e.g. `.git/config` in a
2709 repository) to clear the values inherited from a lower priority
2710 configuration files (e.g. `$HOME/.gitconfig`).
2727 This will result in only b (a and c are cleared).
2731 push.recurseSubmodules::
2732 Make sure all submodule commits used by the revisions to be pushed
2733 are available on a remote-tracking branch. If the value is 'check'
2734 then Git will verify that all submodule commits that changed in the
2735 revisions to be pushed are available on at least one remote of the
2736 submodule. If any commits are missing, the push will be aborted and
2737 exit with non-zero status. If the value is 'on-demand' then all
2738 submodules that changed in the revisions to be pushed will be
2739 pushed. If on-demand was not able to push all necessary revisions
2740 it will also be aborted and exit with non-zero status. If the value
2741 is 'no' then default behavior of ignoring submodules when pushing
2742 is retained. You may override this configuration at time of push by
2743 specifying '--recurse-submodules=check|on-demand|no'.
2745 include::rebase-config.txt[]
2747 receive.advertiseAtomic::
2748 By default, git-receive-pack will advertise the atomic push
2749 capability to its clients. If you don't want to advertise this
2750 capability, set this variable to false.
2752 receive.advertisePushOptions::
2753 When set to true, git-receive-pack will advertise the push options
2754 capability to its clients. False by default.
2757 By default, git-receive-pack will run "git-gc --auto" after
2758 receiving data from git-push and updating refs. You can stop
2759 it by setting this variable to false.
2761 receive.certNonceSeed::
2762 By setting this variable to a string, `git receive-pack`
2763 will accept a `git push --signed` and verifies it by using
2764 a "nonce" protected by HMAC using this string as a secret
2767 receive.certNonceSlop::
2768 When a `git push --signed` sent a push certificate with a
2769 "nonce" that was issued by a receive-pack serving the same
2770 repository within this many seconds, export the "nonce"
2771 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2772 hooks (instead of what the receive-pack asked the sending
2773 side to include). This may allow writing checks in
2774 `pre-receive` and `post-receive` a bit easier. Instead of
2775 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2776 that records by how many seconds the nonce is stale to
2777 decide if they want to accept the certificate, they only
2778 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2780 receive.fsckObjects::
2781 If it is set to true, git-receive-pack will check all received
2782 objects. It will abort in the case of a malformed object or a
2783 broken link. The result of an abort are only dangling objects.
2784 Defaults to false. If not set, the value of `transfer.fsckObjects`
2787 receive.fsck.<msg-id>::
2788 When `receive.fsckObjects` is set to true, errors can be switched
2789 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2790 setting where the `<msg-id>` is the fsck message ID and the value
2791 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2792 the error/warning with the message ID, e.g. "missingEmail: invalid
2793 author/committer line - missing email" means that setting
2794 `receive.fsck.missingEmail = ignore` will hide that issue.
2796 This feature is intended to support working with legacy repositories
2797 which would not pass pushing when `receive.fsckObjects = true`, allowing
2798 the host to accept repositories with certain known issues but still catch
2801 receive.fsck.skipList::
2802 The path to a sorted list of object names (i.e. one SHA-1 per
2803 line) that are known to be broken in a non-fatal way and should
2804 be ignored. This feature is useful when an established project
2805 should be accepted despite early commits containing errors that
2806 can be safely ignored such as invalid committer email addresses.
2807 Note: corrupt objects cannot be skipped with this setting.
2810 After receiving the pack from the client, `receive-pack` may
2811 produce no output (if `--quiet` was specified) while processing
2812 the pack, causing some networks to drop the TCP connection.
2813 With this option set, if `receive-pack` does not transmit
2814 any data in this phase for `receive.keepAlive` seconds, it will
2815 send a short keepalive packet. The default is 5 seconds; set
2816 to 0 to disable keepalives entirely.
2818 receive.unpackLimit::
2819 If the number of objects received in a push is below this
2820 limit then the objects will be unpacked into loose object
2821 files. However if the number of received objects equals or
2822 exceeds this limit then the received pack will be stored as
2823 a pack, after adding any missing delta bases. Storing the
2824 pack from a push can make the push operation complete faster,
2825 especially on slow filesystems. If not set, the value of
2826 `transfer.unpackLimit` is used instead.
2828 receive.maxInputSize::
2829 If the size of the incoming pack stream is larger than this
2830 limit, then git-receive-pack will error out, instead of
2831 accepting the pack file. If not set or set to 0, then the size
2834 receive.denyDeletes::
2835 If set to true, git-receive-pack will deny a ref update that deletes
2836 the ref. Use this to prevent such a ref deletion via a push.
2838 receive.denyDeleteCurrent::
2839 If set to true, git-receive-pack will deny a ref update that
2840 deletes the currently checked out branch of a non-bare repository.
2842 receive.denyCurrentBranch::
2843 If set to true or "refuse", git-receive-pack will deny a ref update
2844 to the currently checked out branch of a non-bare repository.
2845 Such a push is potentially dangerous because it brings the HEAD
2846 out of sync with the index and working tree. If set to "warn",
2847 print a warning of such a push to stderr, but allow the push to
2848 proceed. If set to false or "ignore", allow such pushes with no
2849 message. Defaults to "refuse".
2851 Another option is "updateInstead" which will update the working
2852 tree if pushing into the current branch. This option is
2853 intended for synchronizing working directories when one side is not easily
2854 accessible via interactive ssh (e.g. a live web site, hence the requirement
2855 that the working directory be clean). This mode also comes in handy when
2856 developing inside a VM to test and fix code on different Operating Systems.
2858 By default, "updateInstead" will refuse the push if the working tree or
2859 the index have any difference from the HEAD, but the `push-to-checkout`
2860 hook can be used to customize this. See linkgit:githooks[5].
2862 receive.denyNonFastForwards::
2863 If set to true, git-receive-pack will deny a ref update which is
2864 not a fast-forward. Use this to prevent such an update via a push,
2865 even if that push is forced. This configuration variable is
2866 set when initializing a shared repository.
2869 This variable is the same as `transfer.hideRefs`, but applies
2870 only to `receive-pack` (and so affects pushes, but not fetches).
2871 An attempt to update or delete a hidden ref by `git push` is
2874 receive.updateServerInfo::
2875 If set to true, git-receive-pack will run git-update-server-info
2876 after receiving data from git-push and updating refs.
2878 receive.shallowUpdate::
2879 If set to true, .git/shallow can be updated when new refs
2880 require new shallow roots. Otherwise those refs are rejected.
2882 remote.pushDefault::
2883 The remote to push to by default. Overrides
2884 `branch.<name>.remote` for all branches, and is overridden by
2885 `branch.<name>.pushRemote` for specific branches.
2888 The URL of a remote repository. See linkgit:git-fetch[1] or
2889 linkgit:git-push[1].
2891 remote.<name>.pushurl::
2892 The push URL of a remote repository. See linkgit:git-push[1].
2894 remote.<name>.proxy::
2895 For remotes that require curl (http, https and ftp), the URL to
2896 the proxy to use for that remote. Set to the empty string to
2897 disable proxying for that remote.
2899 remote.<name>.proxyAuthMethod::
2900 For remotes that require curl (http, https and ftp), the method to use for
2901 authenticating against the proxy in use (probably set in
2902 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2904 remote.<name>.fetch::
2905 The default set of "refspec" for linkgit:git-fetch[1]. See
2906 linkgit:git-fetch[1].
2908 remote.<name>.push::
2909 The default set of "refspec" for linkgit:git-push[1]. See
2910 linkgit:git-push[1].
2912 remote.<name>.mirror::
2913 If true, pushing to this remote will automatically behave
2914 as if the `--mirror` option was given on the command line.
2916 remote.<name>.skipDefaultUpdate::
2917 If true, this remote will be skipped by default when updating
2918 using linkgit:git-fetch[1] or the `update` subcommand of
2919 linkgit:git-remote[1].
2921 remote.<name>.skipFetchAll::
2922 If true, this remote will be skipped by default when updating
2923 using linkgit:git-fetch[1] or the `update` subcommand of
2924 linkgit:git-remote[1].
2926 remote.<name>.receivepack::
2927 The default program to execute on the remote side when pushing. See
2928 option --receive-pack of linkgit:git-push[1].
2930 remote.<name>.uploadpack::
2931 The default program to execute on the remote side when fetching. See
2932 option --upload-pack of linkgit:git-fetch-pack[1].
2934 remote.<name>.tagOpt::
2935 Setting this value to --no-tags disables automatic tag following when
2936 fetching from remote <name>. Setting it to --tags will fetch every
2937 tag from remote <name>, even if they are not reachable from remote
2938 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2939 override this setting. See options --tags and --no-tags of
2940 linkgit:git-fetch[1].
2943 Setting this to a value <vcs> will cause Git to interact with
2944 the remote with the git-remote-<vcs> helper.
2946 remote.<name>.prune::
2947 When set to true, fetching from this remote by default will also
2948 remove any remote-tracking references that no longer exist on the
2949 remote (as if the `--prune` option was given on the command line).
2950 Overrides `fetch.prune` settings, if any.
2953 The list of remotes which are fetched by "git remote update
2954 <group>". See linkgit:git-remote[1].
2956 repack.useDeltaBaseOffset::
2957 By default, linkgit:git-repack[1] creates packs that use
2958 delta-base offset. If you need to share your repository with
2959 Git older than version 1.4.4, either directly or via a dumb
2960 protocol such as http, then you need to set this option to
2961 "false" and repack. Access from old Git versions over the
2962 native protocol are unaffected by this option.
2964 repack.packKeptObjects::
2965 If set to true, makes `git repack` act as if
2966 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2967 details. Defaults to `false` normally, but `true` if a bitmap
2968 index is being written (either via `--write-bitmap-index` or
2969 `repack.writeBitmaps`).
2971 repack.writeBitmaps::
2972 When true, git will write a bitmap index when packing all
2973 objects to disk (e.g., when `git repack -a` is run). This
2974 index can speed up the "counting objects" phase of subsequent
2975 packs created for clones and fetches, at the cost of some disk
2976 space and extra time spent on the initial repack. This has
2977 no effect if multiple packfiles are created.
2981 When set to true, `git-rerere` updates the index with the
2982 resulting contents after it cleanly resolves conflicts using
2983 previously recorded resolution. Defaults to false.
2986 Activate recording of resolved conflicts, so that identical
2987 conflict hunks can be resolved automatically, should they be
2988 encountered again. By default, linkgit:git-rerere[1] is
2989 enabled if there is an `rr-cache` directory under the
2990 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2993 sendemail.identity::
2994 A configuration identity. When given, causes values in the
2995 'sendemail.<identity>' subsection to take precedence over
2996 values in the 'sendemail' section. The default identity is
2997 the value of `sendemail.identity`.
2999 sendemail.smtpEncryption::
3000 See linkgit:git-send-email[1] for description. Note that this
3001 setting is not subject to the 'identity' mechanism.
3003 sendemail.smtpssl (deprecated)::
3004 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3006 sendemail.smtpsslcertpath::
3007 Path to ca-certificates (either a directory or a single file).
3008 Set it to an empty string to disable certificate verification.
3010 sendemail.<identity>.*::
3011 Identity-specific versions of the 'sendemail.*' parameters
3012 found below, taking precedence over those when this
3013 identity is selected, through either the command-line or
3014 `sendemail.identity`.
3016 sendemail.aliasesFile::
3017 sendemail.aliasFileType::
3018 sendemail.annotate::
3022 sendemail.chainReplyTo::
3024 sendemail.envelopeSender::
3026 sendemail.multiEdit::
3027 sendemail.signedoffbycc::
3028 sendemail.smtpPass::
3029 sendemail.suppresscc::
3030 sendemail.suppressFrom::
3033 sendemail.smtpDomain::
3034 sendemail.smtpServer::
3035 sendemail.smtpServerPort::
3036 sendemail.smtpServerOption::
3037 sendemail.smtpUser::
3039 sendemail.transferEncoding::
3040 sendemail.validate::
3042 See linkgit:git-send-email[1] for description.
3044 sendemail.signedoffcc (deprecated)::
3045 Deprecated alias for `sendemail.signedoffbycc`.
3047 sendemail.smtpBatchSize::
3048 Number of messages to be sent per connection, after that a relogin
3049 will happen. If the value is 0 or undefined, send all messages in
3051 See also the `--batch-size` option of linkgit:git-send-email[1].
3053 sendemail.smtpReloginDelay::
3054 Seconds wait before reconnecting to smtp server.
3055 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3057 showbranch.default::
3058 The default set of branches for linkgit:git-show-branch[1].
3059 See linkgit:git-show-branch[1].
3061 splitIndex.maxPercentChange::
3062 When the split index feature is used, this specifies the
3063 percent of entries the split index can contain compared to the
3064 total number of entries in both the split index and the shared
3065 index before a new shared index is written.
3066 The value should be between 0 and 100. If the value is 0 then
3067 a new shared index is always written, if it is 100 a new
3068 shared index is never written.
3069 By default the value is 20, so a new shared index is written
3070 if the number of entries in the split index would be greater
3071 than 20 percent of the total number of entries.
3072 See linkgit:git-update-index[1].
3074 splitIndex.sharedIndexExpire::
3075 When the split index feature is used, shared index files that
3076 were not modified since the time this variable specifies will
3077 be removed when a new shared index file is created. The value
3078 "now" expires all entries immediately, and "never" suppresses
3079 expiration altogether.
3080 The default value is "2.weeks.ago".
3081 Note that a shared index file is considered modified (for the
3082 purpose of expiration) each time a new split-index file is
3083 either created based on it or read from it.
3084 See linkgit:git-update-index[1].
3086 status.relativePaths::
3087 By default, linkgit:git-status[1] shows paths relative to the
3088 current directory. Setting this variable to `false` shows paths
3089 relative to the repository root (this was the default for Git
3093 Set to true to enable --short by default in linkgit:git-status[1].
3094 The option --no-short takes precedence over this variable.
3097 Set to true to enable --branch by default in linkgit:git-status[1].
3098 The option --no-branch takes precedence over this variable.
3100 status.displayCommentPrefix::
3101 If set to true, linkgit:git-status[1] will insert a comment
3102 prefix before each output line (starting with
3103 `core.commentChar`, i.e. `#` by default). This was the
3104 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3108 If set to true, linkgit:git-status[1] will display the number of
3109 entries currently stashed away.
3112 status.showUntrackedFiles::
3113 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3114 files which are not currently tracked by Git. Directories which
3115 contain only untracked files, are shown with the directory name
3116 only. Showing untracked files means that Git needs to lstat() all
3117 the files in the whole repository, which might be slow on some
3118 systems. So, this variable controls how the commands displays
3119 the untracked files. Possible values are:
3122 * `no` - Show no untracked files.
3123 * `normal` - Show untracked files and directories.
3124 * `all` - Show also individual files in untracked directories.
3127 If this variable is not specified, it defaults to 'normal'.
3128 This variable can be overridden with the -u|--untracked-files option
3129 of linkgit:git-status[1] and linkgit:git-commit[1].
3131 status.submoduleSummary::
3133 If this is set to a non zero number or true (identical to -1 or an
3134 unlimited number), the submodule summary will be enabled and a
3135 summary of commits for modified submodules will be shown (see
3136 --summary-limit option of linkgit:git-submodule[1]). Please note
3137 that the summary output command will be suppressed for all
3138 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3139 for those submodules where `submodule.<name>.ignore=all`. The only
3140 exception to that rule is that status and commit will show staged
3141 submodule changes. To
3142 also view the summary for ignored submodules you can either use
3143 the --ignore-submodules=dirty command-line option or the 'git
3144 submodule summary' command, which shows a similar output but does
3145 not honor these settings.
3148 If this is set to true, the `git stash show` command without an
3149 option will show the stash entry in patch form. Defaults to false.
3150 See description of 'show' command in linkgit:git-stash[1].
3153 If this is set to true, the `git stash show` command without an
3154 option will show diffstat of the stash entry. Defaults to true.
3155 See description of 'show' command in linkgit:git-stash[1].
3157 submodule.<name>.url::
3158 The URL for a submodule. This variable is copied from the .gitmodules
3159 file to the git config via 'git submodule init'. The user can change
3160 the configured URL before obtaining the submodule via 'git submodule
3161 update'. If neither submodule.<name>.active or submodule.active are
3162 set, the presence of this variable is used as a fallback to indicate
3163 whether the submodule is of interest to git commands.
3164 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3166 submodule.<name>.update::
3167 The method by which a submodule is updated by 'git submodule update',
3168 which is the only affected command, others such as
3169 'git checkout --recurse-submodules' are unaffected. It exists for
3170 historical reasons, when 'git submodule' was the only command to
3171 interact with submodules; settings like `submodule.active`
3172 and `pull.rebase` are more specific. It is populated by
3173 `git submodule init` from the linkgit:gitmodules[5] file.
3174 See description of 'update' command in linkgit:git-submodule[1].
3176 submodule.<name>.branch::
3177 The remote branch name for a submodule, used by `git submodule
3178 update --remote`. Set this option to override the value found in
3179 the `.gitmodules` file. See linkgit:git-submodule[1] and
3180 linkgit:gitmodules[5] for details.
3182 submodule.<name>.fetchRecurseSubmodules::
3183 This option can be used to control recursive fetching of this
3184 submodule. It can be overridden by using the --[no-]recurse-submodules
3185 command-line option to "git fetch" and "git pull".
3186 This setting will override that from in the linkgit:gitmodules[5]
3189 submodule.<name>.ignore::
3190 Defines under what circumstances "git status" and the diff family show
3191 a submodule as modified. When set to "all", it will never be considered
3192 modified (but it will nonetheless show up in the output of status and
3193 commit when it has been staged), "dirty" will ignore all changes
3194 to the submodules work tree and
3195 takes only differences between the HEAD of the submodule and the commit
3196 recorded in the superproject into account. "untracked" will additionally
3197 let submodules with modified tracked files in their work tree show up.
3198 Using "none" (the default when this option is not set) also shows
3199 submodules that have untracked files in their work tree as changed.
3200 This setting overrides any setting made in .gitmodules for this submodule,
3201 both settings can be overridden on the command line by using the
3202 "--ignore-submodules" option. The 'git submodule' commands are not
3203 affected by this setting.
3205 submodule.<name>.active::
3206 Boolean value indicating if the submodule is of interest to git
3207 commands. This config option takes precedence over the
3208 submodule.active config option.
3211 A repeated field which contains a pathspec used to match against a
3212 submodule's path to determine if the submodule is of interest to git
3216 Specifies if commands recurse into submodules by default. This
3217 applies to all commands that have a `--recurse-submodules` option.
3220 submodule.fetchJobs::
3221 Specifies how many submodules are fetched/cloned at the same time.
3222 A positive integer allows up to that number of submodules fetched
3223 in parallel. A value of 0 will give some reasonable default.
3224 If unset, it defaults to 1.
3226 submodule.alternateLocation::
3227 Specifies how the submodules obtain alternates when submodules are
3228 cloned. Possible values are `no`, `superproject`.
3229 By default `no` is assumed, which doesn't add references. When the
3230 value is set to `superproject` the submodule to be cloned computes
3231 its alternates location relative to the superprojects alternate.
3233 submodule.alternateErrorStrategy::
3234 Specifies how to treat errors with the alternates for a submodule
3235 as computed via `submodule.alternateLocation`. Possible values are
3236 `ignore`, `info`, `die`. Default is `die`.
3238 tag.forceSignAnnotated::
3239 A boolean to specify whether annotated tags created should be GPG signed.
3240 If `--annotate` is specified on the command line, it takes
3241 precedence over this option.
3244 This variable controls the sort ordering of tags when displayed by
3245 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3246 value of this variable will be used as the default.
3249 This variable can be used to restrict the permission bits of
3250 tar archive entries. The default is 0002, which turns off the
3251 world write bit. The special value "user" indicates that the
3252 archiving user's umask will be used instead. See umask(2) and
3253 linkgit:git-archive[1].
3255 transfer.fsckObjects::
3256 When `fetch.fsckObjects` or `receive.fsckObjects` are
3257 not set, the value of this variable is used instead.
3261 String(s) `receive-pack` and `upload-pack` use to decide which
3262 refs to omit from their initial advertisements. Use more than
3263 one definition to specify multiple prefix strings. A ref that is
3264 under the hierarchies listed in the value of this variable is
3265 excluded, and is hidden when responding to `git push` or `git
3266 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3267 program-specific versions of this config.
3269 You may also include a `!` in front of the ref name to negate the entry,
3270 explicitly exposing it, even if an earlier entry marked it as hidden.
3271 If you have multiple hideRefs values, later entries override earlier ones
3272 (and entries in more-specific config files override less-specific ones).
3274 If a namespace is in use, the namespace prefix is stripped from each
3275 reference before it is matched against `transfer.hiderefs` patterns.
3276 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3277 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3278 is omitted from the advertisements but `refs/heads/master` and
3279 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3280 "have" lines. In order to match refs before stripping, add a `^` in front of
3281 the ref name. If you combine `!` and `^`, `!` must be specified first.
3283 Even if you hide refs, a client may still be able to steal the target
3284 objects via the techniques described in the "SECURITY" section of the
3285 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3286 separate repository.
3288 transfer.unpackLimit::
3289 When `fetch.unpackLimit` or `receive.unpackLimit` are
3290 not set, the value of this variable is used instead.
3291 The default value is 100.
3293 uploadarchive.allowUnreachable::
3294 If true, allow clients to use `git archive --remote` to request
3295 any tree, whether reachable from the ref tips or not. See the
3296 discussion in the "SECURITY" section of
3297 linkgit:git-upload-archive[1] for more details. Defaults to
3300 uploadpack.hideRefs::
3301 This variable is the same as `transfer.hideRefs`, but applies
3302 only to `upload-pack` (and so affects only fetches, not pushes).
3303 An attempt to fetch a hidden ref by `git fetch` will fail. See
3304 also `uploadpack.allowTipSHA1InWant`.
3306 uploadpack.allowTipSHA1InWant::
3307 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3308 to accept a fetch request that asks for an object at the tip
3309 of a hidden ref (by default, such a request is rejected).
3310 See also `uploadpack.hideRefs`. Even if this is false, a client
3311 may be able to steal objects via the techniques described in the
3312 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3313 best to keep private data in a separate repository.
3315 uploadpack.allowReachableSHA1InWant::
3316 Allow `upload-pack` to accept a fetch request that asks for an
3317 object that is reachable from any ref tip. However, note that
3318 calculating object reachability is computationally expensive.
3319 Defaults to `false`. Even if this is false, a client may be able
3320 to steal objects via the techniques described in the "SECURITY"
3321 section of the linkgit:gitnamespaces[7] man page; it's best to
3322 keep private data in a separate repository.
3324 uploadpack.allowAnySHA1InWant::
3325 Allow `upload-pack` to accept a fetch request that asks for any
3327 Defaults to `false`.
3329 uploadpack.keepAlive::
3330 When `upload-pack` has started `pack-objects`, there may be a
3331 quiet period while `pack-objects` prepares the pack. Normally
3332 it would output progress information, but if `--quiet` was used
3333 for the fetch, `pack-objects` will output nothing at all until
3334 the pack data begins. Some clients and networks may consider
3335 the server to be hung and give up. Setting this option instructs
3336 `upload-pack` to send an empty keepalive packet every
3337 `uploadpack.keepAlive` seconds. Setting this option to 0
3338 disables keepalive packets entirely. The default is 5 seconds.
3340 uploadpack.packObjectsHook::
3341 If this option is set, when `upload-pack` would run
3342 `git pack-objects` to create a packfile for a client, it will
3343 run this shell command instead. The `pack-objects` command and
3344 arguments it _would_ have run (including the `git pack-objects`
3345 at the beginning) are appended to the shell command. The stdin
3346 and stdout of the hook are treated as if `pack-objects` itself
3347 was run. I.e., `upload-pack` will feed input intended for
3348 `pack-objects` to the hook, and expects a completed packfile on
3351 Note that this configuration variable is ignored if it is seen in the
3352 repository-level config (this is a safety measure against fetching from
3353 untrusted repositories).
3355 url.<base>.insteadOf::
3356 Any URL that starts with this value will be rewritten to
3357 start, instead, with <base>. In cases where some site serves a
3358 large number of repositories, and serves them with multiple
3359 access methods, and some users need to use different access
3360 methods, this feature allows people to specify any of the
3361 equivalent URLs and have Git automatically rewrite the URL to
3362 the best alternative for the particular user, even for a
3363 never-before-seen repository on the site. When more than one
3364 insteadOf strings match a given URL, the longest match is used.
3366 Note that any protocol restrictions will be applied to the rewritten
3367 URL. If the rewrite changes the URL to use a custom protocol or remote
3368 helper, you may need to adjust the `protocol.*.allow` config to permit
3369 the request. In particular, protocols you expect to use for submodules
3370 must be set to `always` rather than the default of `user`. See the
3371 description of `protocol.allow` above.
3373 url.<base>.pushInsteadOf::
3374 Any URL that starts with this value will not be pushed to;
3375 instead, it will be rewritten to start with <base>, and the
3376 resulting URL will be pushed to. In cases where some site serves
3377 a large number of repositories, and serves them with multiple
3378 access methods, some of which do not allow push, this feature
3379 allows people to specify a pull-only URL and have Git
3380 automatically use an appropriate URL to push, even for a
3381 never-before-seen repository on the site. When more than one
3382 pushInsteadOf strings match a given URL, the longest match is
3383 used. If a remote has an explicit pushurl, Git will ignore this
3384 setting for that remote.
3387 Your email address to be recorded in any newly created commits.
3388 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3389 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3392 Your full name to be recorded in any newly created commits.
3393 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3394 environment variables. See linkgit:git-commit-tree[1].
3396 user.useConfigOnly::
3397 Instruct Git to avoid trying to guess defaults for `user.email`
3398 and `user.name`, and instead retrieve the values only from the
3399 configuration. For example, if you have multiple email addresses
3400 and would like to use a different one for each repository, then
3401 with this configuration option set to `true` in the global config
3402 along with a name, Git will prompt you to set up an email before
3403 making new commits in a newly cloned repository.
3404 Defaults to `false`.
3407 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3408 key you want it to automatically when creating a signed tag or
3409 commit, you can override the default selection with this variable.
3410 This option is passed unchanged to gpg's --local-user parameter,
3411 so you may specify a key using any method that gpg supports.
3413 versionsort.prereleaseSuffix (deprecated)::
3414 Deprecated alias for `versionsort.suffix`. Ignored if
3415 `versionsort.suffix` is set.
3417 versionsort.suffix::
3418 Even when version sort is used in linkgit:git-tag[1], tagnames
3419 with the same base version but different suffixes are still sorted
3420 lexicographically, resulting e.g. in prerelease tags appearing
3421 after the main release (e.g. "1.0-rc1" after "1.0"). This
3422 variable can be specified to determine the sorting order of tags
3423 with different suffixes.
3425 By specifying a single suffix in this variable, any tagname containing
3426 that suffix will appear before the corresponding main release. E.g. if
3427 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3428 "1.0". If specified multiple times, once per suffix, then the order of
3429 suffixes in the configuration will determine the sorting order of tagnames
3430 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3431 configuration, then all "1.0-preX" tags will be listed before any
3432 "1.0-rcX" tags. The placement of the main release tag relative to tags
3433 with various suffixes can be determined by specifying the empty suffix
3434 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3435 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3436 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3439 If more than one suffixes match the same tagname, then that tagname will
3440 be sorted according to the suffix which starts at the earliest position in
3441 the tagname. If more than one different matching suffixes start at
3442 that earliest position, then that tagname will be sorted according to the
3443 longest of those suffixes.
3444 The sorting order between different suffixes is undefined if they are
3445 in multiple config files.
3448 Specify a web browser that may be used by some commands.
3449 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3452 worktree.guessRemote::
3453 With `add`, if no branch argument, and neither of `-b` nor
3454 `-B` nor `--detach` are given, the command defaults to
3455 creating a new branch from HEAD. If `worktree.guessRemote` is
3456 set to true, `worktree add` tries to find a remote-tracking
3457 branch whose name uniquely matches the new branch name. If
3458 such a branch exists, it is checked out and set as "upstream"
3459 for the new branch. If no such match can be found, it falls
3460 back to creating a new branch from the current HEAD.