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 and the null byte. Doublequote `"` and backslash can be included
45 by escaping them as `\"` and `\\`, respectively. Backslashes preceding
46 other characters are dropped when reading; for example, `\t` is read as
47 `t` and `\0` is read as `0` Section headers cannot span multiple lines.
48 Variables may belong directly to a section or to a given subsection. You
49 can have `[section]` if you have `[section "subsection"]`, but you don't
52 There is also a deprecated `[section.subsection]` syntax. With this
53 syntax, the subsection name is converted to lower-case and is also
54 compared case sensitively. These subsection names follow the same
55 restrictions as section names.
57 All the other lines (and the remainder of the line after the section
58 header) are recognized as setting variables, in the form
59 'name = value' (or just 'name', which is a short-hand to say that
60 the variable is the boolean "true").
61 The variable names are case-insensitive, allow only alphanumeric characters
62 and `-`, and must start with an alphabetic character.
64 A line that defines a value can be continued to the next line by
65 ending it with a `\`; the backquote and the end-of-line are
66 stripped. Leading whitespaces after 'name =', the remainder of the
67 line after the first comment character '#' or ';', and trailing
68 whitespaces of the line are discarded unless they are enclosed in
69 double quotes. Internal whitespaces within the value are retained
72 Inside double quotes, double quote `"` and backslash `\` characters
73 must be escaped: use `\"` for `"` and `\\` for `\`.
75 The following escape sequences (beside `\"` and `\\`) are recognized:
76 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77 and `\b` for backspace (BS). Other char escape sequences (including octal
78 escape sequences) are invalid.
84 The `include` and `includeIf` sections allow you to include config
85 directives from another source. These sections behave identically to
86 each other with the exception that `includeIf` sections may be ignored
87 if their condition does not evaluate to true; see "Conditional includes"
90 You can include a config file from another by setting the special
91 `include.path` (or `includeIf.*.path`) variable to the name of the file
92 to be included. The variable takes a pathname as its value, and is
93 subject to tilde expansion. These variables can be given multiple times.
95 The contents of the included file are inserted immediately, as if they
96 had been found at the location of the include directive. If the value of the
97 variable is a relative path, the path is considered to
98 be relative to the configuration file in which the include directive
99 was found. See below for examples.
104 You can include a config file from another conditionally by setting a
105 `includeIf.<condition>.path` variable to the name of the file to be
108 The condition starts with a keyword followed by a colon and some data
109 whose format and meaning depends on the keyword. Supported keywords
114 The data that follows the keyword `gitdir:` is used as a glob
115 pattern. If the location of the .git directory matches the
116 pattern, the include condition is met.
118 The .git location may be auto-discovered, or come from `$GIT_DIR`
119 environment variable. If the repository is auto discovered via a .git
120 file (e.g. from submodules, or a linked worktree), the .git location
121 would be the final location where the .git directory is, not where the
124 The pattern can contain standard globbing wildcards and two additional
125 ones, `**/` and `/**`, that can match multiple path components. Please
126 refer to linkgit:gitignore[5] for details. For convenience:
128 * If the pattern starts with `~/`, `~` will be substituted with the
129 content of the environment variable `HOME`.
131 * If the pattern starts with `./`, it is replaced with the directory
132 containing the current config file.
134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
135 will be automatically prepended. For example, the pattern `foo/bar`
136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
138 * If the pattern ends with `/`, `**` will be automatically added. For
139 example, the pattern `foo/` becomes `foo/**`. In other words, it
140 matches "foo" and everything inside, recursively.
143 This is the same as `gitdir` except that matching is done
144 case-insensitively (e.g. on case-insensitive file sytems)
146 A few more notes on matching via `gitdir` and `gitdir/i`:
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
150 * Both the symlink & realpath versions of paths will be matched
151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
155 This was not the case in the initial release of this feature in
156 v2.13.0, which only matched the realpath version. Configuration that
157 wants to be compatible with the initial release of this feature needs
158 to either specify only the realpath version, or both versions.
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
168 ; Don't trust file modes
173 external = /usr/local/bin/diff-wrapper
178 merge = refs/heads/devel
182 gitProxy="ssh" for "kernel.org"
183 gitProxy=default-proxy ; for the rest
186 path = /path/to/foo.inc ; include by absolute path
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
202 ; relative paths are always relative to the including
203 ; file (if the condition is true); their location is not
204 ; affected by the condition
205 [includeIf "gitdir:/path/to/group/"]
211 Values of many variables are treated as a simple string, but there
212 are variables that take values of specific types and there are rules
213 as to how to spell them.
217 When a variable is said to take a boolean value, many
218 synonyms are accepted for 'true' and 'false'; these are all
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
228 When converting value to the canonical form using `--bool` type
229 specifier, 'git config' will ensure that the output is "true" or
230 "false" (spelled in lowercase).
233 The value for many variables that specify various sizes can
234 be suffixed with `k`, `M`,... to mean "scale the number by
235 1024", "by 1024x1024", etc.
238 The value for a variable that takes a color is a list of
239 colors (at most two, one for foreground and one for background)
240 and attributes (as many as you want), separated by spaces.
242 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
243 `blue`, `magenta`, `cyan` and `white`. The first color given is the
244 foreground; the second is the background.
246 Colors may also be given as numbers between 0 and 255; these use ANSI
247 256-color mode (but note that not all terminals may support this). If
248 your terminal supports it, you may also specify 24-bit RGB values as
251 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
252 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
253 The position of any attributes with respect to the colors
254 (before, after, or in between), doesn't matter. Specific attributes may
255 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
258 An empty color string produces no color effect at all. This can be used
259 to avoid coloring specific elements without disabling color entirely.
261 For git's pre-defined color slots, the attributes are meant to be reset
262 at the beginning of each item in the colored output. So setting
263 `color.decorate.branch` to `black` will paint that branch name in a
264 plain `black`, even if the previous thing on the same output line (e.g.
265 opening parenthesis before the list of branch names in `log --decorate`
266 output) is set to be painted with `bold` or some other attribute.
267 However, custom log formats may do more complicated and layered
268 coloring, and the negated forms may be useful there.
271 A variable that takes a pathname value can be given a
272 string that begins with "`~/`" or "`~user/`", and the usual
273 tilde expansion happens to such a string: `~/`
274 is expanded to the value of `$HOME`, and `~user/` to the
275 specified user's home directory.
281 Note that this list is non-comprehensive and not necessarily complete.
282 For command-specific variables, you will find a more detailed description
283 in the appropriate manual page.
285 Other git-related tools may and do use their own variables. When
286 inventing new variables for use in your own tool, make sure their
287 names do not conflict with those that are used by Git itself and
288 other popular tools, and describe them in your documentation.
292 These variables control various optional help messages designed to
293 aid new users. All 'advice.*' variables default to 'true', and you
294 can tell Git that you do not need help by setting these to 'false':
298 Set this variable to 'false' if you want to disable
300 'pushNonFFMatching', 'pushAlreadyExists',
301 'pushFetchFirst', and 'pushNeedsForce'
304 Advice shown when linkgit:git-push[1] fails due to a
305 non-fast-forward update to the current branch.
307 Advice shown when you ran linkgit:git-push[1] and pushed
308 'matching refs' explicitly (i.e. you used ':', or
309 specified a refspec that isn't your current branch) and
310 it resulted in a non-fast-forward error.
312 Shown when linkgit:git-push[1] rejects an update that
313 does not qualify for fast-forwarding (e.g., a tag.)
315 Shown when linkgit:git-push[1] rejects an update that
316 tries to overwrite a remote ref that points at an
317 object we do not have.
319 Shown when linkgit:git-push[1] rejects an update that
320 tries to overwrite a remote ref that points at an
321 object that is not a commit-ish, or make the remote
322 ref point at an object that is not a commit-ish.
324 Show directions on how to proceed from the current
325 state in the output of linkgit:git-status[1], in
326 the template shown when writing commit messages in
327 linkgit:git-commit[1], and in the help message shown
328 by linkgit:git-checkout[1] when switching branch.
330 Advise to consider using the `-u` option to linkgit:git-status[1]
331 when the command takes more than 2 seconds to enumerate untracked
334 Advice shown when linkgit:git-merge[1] refuses to
335 merge to avoid overwriting local changes.
337 Advice shown by various commands when conflicts
338 prevent the operation from being performed.
340 Advice on how to set your identity configuration when
341 your information is guessed from the system username and
344 Advice shown when you used linkgit:git-checkout[1] to
345 move to the detach HEAD state, to instruct how to create
346 a local branch after the fact.
348 Advice that shows the location of the patch file when
349 linkgit:git-am[1] fails to apply it.
351 In case of failure in the output of linkgit:git-rm[1],
352 show directions on how to proceed from the current state.
354 Advice on what to do when you've accidentally added one
355 git repo inside of another.
357 Advice shown if an hook is ignored because the hook is not
360 Print a message to the terminal whenever Git is waiting for
361 editor input from the user.
365 Tells Git if the executable bit of files in the working tree
368 Some filesystems lose the executable bit when a file that is
369 marked as executable is checked out, or checks out a
370 non-executable file with executable bit on.
371 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
372 to see if it handles the executable bit correctly
373 and this variable is automatically set as necessary.
375 A repository, however, may be on a filesystem that handles
376 the filemode correctly, and this variable is set to 'true'
377 when created, but later may be made accessible from another
378 environment that loses the filemode (e.g. exporting ext4 via
379 CIFS mount, visiting a Cygwin created repository with
380 Git for Windows or Eclipse).
381 In such a case it may be necessary to set this variable to 'false'.
382 See linkgit:git-update-index[1].
384 The default is true (when core.filemode is not specified in the config file).
387 (Windows-only) If true, mark newly-created directories and files whose
388 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
389 directory is hidden, but no other files starting with a dot. The
390 default mode is 'dotGitOnly'.
393 If true, this option enables various workarounds to enable
394 Git to work better on filesystems that are not case sensitive,
395 like FAT. For example, if a directory listing finds
396 "makefile" when Git expects "Makefile", Git will assume
397 it is really the same file, and continue to remember it as
400 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
401 will probe and set core.ignoreCase true if appropriate when the repository
404 core.precomposeUnicode::
405 This option is only used by Mac OS implementation of Git.
406 When core.precomposeUnicode=true, Git reverts the unicode decomposition
407 of filenames done by Mac OS. This is useful when sharing a repository
408 between Mac OS and Linux or Windows.
409 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
410 When false, file names are handled fully transparent by Git,
411 which is backward compatible with older versions of Git.
414 If set to true, do not allow checkout of paths that would
415 be considered equivalent to `.git` on an HFS+ filesystem.
416 Defaults to `true` on Mac OS, and `false` elsewhere.
419 If set to true, do not allow checkout of paths that would
420 cause problems with the NTFS filesystem, e.g. conflict with
422 Defaults to `true` on Windows, and `false` elsewhere.
425 If set, the value of this variable is used as a command which
426 will identify all files that may have changed since the
427 requested date/time. This information is used to speed up git by
428 avoiding unnecessary processing of files that have not changed.
429 See the "fsmonitor-watchman" section of linkgit:githooks[5].
432 If false, the ctime differences between the index and the
433 working tree are ignored; useful when the inode change time
434 is regularly modified by something outside Git (file system
435 crawlers and some backup systems).
436 See linkgit:git-update-index[1]. True by default.
439 If true, the split-index feature of the index will be used.
440 See linkgit:git-update-index[1]. False by default.
442 core.untrackedCache::
443 Determines what to do about the untracked cache feature of the
444 index. It will be kept, if this variable is unset or set to
445 `keep`. It will automatically be added if set to `true`. And
446 it will automatically be removed, if set to `false`. Before
447 setting it to `true`, you should check that mtime is working
448 properly on your system.
449 See linkgit:git-update-index[1]. `keep` by default.
452 Determines which stat fields to match between the index
453 and work tree. The user can set this to 'default' or
454 'minimal'. Default (or explicitly 'default'), is to check
455 all fields, including the sub-second part of mtime and ctime.
458 Commands that output paths (e.g. 'ls-files', 'diff'), will
459 quote "unusual" characters in the pathname by enclosing the
460 pathname in double-quotes and escaping those characters with
461 backslashes in the same way C escapes control characters (e.g.
462 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
463 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
464 UTF-8). If this variable is set to false, bytes higher than
465 0x80 are not considered "unusual" any more. Double-quotes,
466 backslash and control characters are always escaped regardless
467 of the setting of this variable. A simple space character is
468 not considered "unusual". Many commands can output pathnames
469 completely verbatim using the `-z` option. The default value
473 Sets the line ending type to use in the working directory for
474 files that have the `text` property set when core.autocrlf is false.
475 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
476 native line ending. The default value is `native`. See
477 linkgit:gitattributes[5] for more information on end-of-line
481 If true, makes Git check if converting `CRLF` is reversible when
482 end-of-line conversion is active. Git will verify if a command
483 modifies a file in the work tree either directly or indirectly.
484 For example, committing a file followed by checking out the
485 same file should yield the original file in the work tree. If
486 this is not the case for the current setting of
487 `core.autocrlf`, Git will reject the file. The variable can
488 be set to "warn", in which case Git will only warn about an
489 irreversible conversion but continue the operation.
491 CRLF conversion bears a slight chance of corrupting data.
492 When it is enabled, Git will convert CRLF to LF during commit and LF to
493 CRLF during checkout. A file that contains a mixture of LF and
494 CRLF before the commit cannot be recreated by Git. For text
495 files this is the right thing to do: it corrects line endings
496 such that we have only LF line endings in the repository.
497 But for binary files that are accidentally classified as text the
498 conversion can corrupt data.
500 If you recognize such corruption early you can easily fix it by
501 setting the conversion type explicitly in .gitattributes. Right
502 after committing you still have the original file in your work
503 tree and this file is not yet corrupted. You can explicitly tell
504 Git that this file is binary and Git will handle the file
507 Unfortunately, the desired effect of cleaning up text files with
508 mixed line endings and the undesired effect of corrupting binary
509 files cannot be distinguished. In both cases CRLFs are removed
510 in an irreversible way. For text files this is the right thing
511 to do because CRLFs are line endings, while for binary files
512 converting CRLFs corrupts data.
514 Note, this safety check does not mean that a checkout will generate a
515 file identical to the original file for a different setting of
516 `core.eol` and `core.autocrlf`, but only for the current one. For
517 example, a text file with `LF` would be accepted with `core.eol=lf`
518 and could later be checked out with `core.eol=crlf`, in which case the
519 resulting file would contain `CRLF`, although the original file
520 contained `LF`. However, in both work trees the line endings would be
521 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
522 file with mixed line endings would be reported by the `core.safecrlf`
526 Setting this variable to "true" is the same as setting
527 the `text` attribute to "auto" on all files and core.eol to "crlf".
528 Set to true if you want to have `CRLF` line endings in your
529 working directory and the repository has LF line endings.
530 This variable can be set to 'input',
531 in which case no output conversion is performed.
534 If false, symbolic links are checked out as small plain files that
535 contain the link text. linkgit:git-update-index[1] and
536 linkgit:git-add[1] will not change the recorded type to regular
537 file. Useful on filesystems like FAT that do not support
540 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
541 will probe and set core.symlinks false if appropriate when the repository
545 A "proxy command" to execute (as 'command host port') instead
546 of establishing direct connection to the remote server when
547 using the Git protocol for fetching. If the variable value is
548 in the "COMMAND for DOMAIN" format, the command is applied only
549 on hostnames ending with the specified domain string. This variable
550 may be set multiple times and is matched in the given order;
551 the first match wins.
553 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
554 (which always applies universally, without the special "for"
557 The special string `none` can be used as the proxy command to
558 specify that no proxy be used for a given domain pattern.
559 This is useful for excluding servers inside a firewall from
560 proxy use, while defaulting to a common proxy for external domains.
563 If this variable is set, `git fetch` and `git push` will
564 use the specified command instead of `ssh` when they need to
565 connect to a remote system. The command is in the same form as
566 the `GIT_SSH_COMMAND` environment variable and is overridden
567 when the environment variable is set.
570 If true, Git will avoid using lstat() calls to detect if files have
571 changed by setting the "assume-unchanged" bit for those tracked files
572 which it has updated identically in both the index and working tree.
574 When files are modified outside of Git, the user will need to stage
575 the modified files explicitly (e.g. see 'Examples' section in
576 linkgit:git-update-index[1]).
577 Git will not normally detect changes to those files.
579 This is useful on systems where lstat() calls are very slow, such as
580 CIFS/Microsoft Windows.
584 core.preferSymlinkRefs::
585 Instead of the default "symref" format for HEAD
586 and other symbolic reference files, use symbolic links.
587 This is sometimes needed to work with old scripts that
588 expect HEAD to be a symbolic link.
591 If true this repository is assumed to be 'bare' and has no
592 working directory associated with it. If this is the case a
593 number of commands that require a working directory will be
594 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
596 This setting is automatically guessed by linkgit:git-clone[1] or
597 linkgit:git-init[1] when the repository was created. By default a
598 repository that ends in "/.git" is assumed to be not bare (bare =
599 false), while all other repositories are assumed to be bare (bare
603 Set the path to the root of the working tree.
604 If `GIT_COMMON_DIR` environment variable is set, core.worktree
605 is ignored and not used for determining the root of working tree.
606 This can be overridden by the `GIT_WORK_TREE` environment
607 variable and the `--work-tree` command-line option.
608 The value can be an absolute path or relative to the path to
609 the .git directory, which is either specified by --git-dir
610 or GIT_DIR, or automatically discovered.
611 If --git-dir or GIT_DIR is specified but none of
612 --work-tree, GIT_WORK_TREE and core.worktree is specified,
613 the current working directory is regarded as the top level
614 of your working tree.
616 Note that this variable is honored even when set in a configuration
617 file in a ".git" subdirectory of a directory and its value differs
618 from the latter directory (e.g. "/path/to/.git/config" has
619 core.worktree set to "/different/path"), which is most likely a
620 misconfiguration. Running Git commands in the "/path/to" directory will
621 still use "/different/path" as the root of the work tree and can cause
622 confusion unless you know what you are doing (e.g. you are creating a
623 read-only snapshot of the same index to a location different from the
624 repository's usual working tree).
626 core.logAllRefUpdates::
627 Enable the reflog. Updates to a ref <ref> is logged to the file
628 "`$GIT_DIR/logs/<ref>`", by appending the new and old
629 SHA-1, the date/time and the reason of the update, but
630 only when the file exists. If this configuration
631 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
632 file is automatically created for branch heads (i.e. under
633 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
634 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
635 If it is set to `always`, then a missing reflog is automatically
636 created for any ref under `refs/`.
638 This information can be used to determine what commit
639 was the tip of a branch "2 days ago".
641 This value is true by default in a repository that has
642 a working directory associated with it, and false by
643 default in a bare repository.
645 core.repositoryFormatVersion::
646 Internal variable identifying the repository format and layout
649 core.sharedRepository::
650 When 'group' (or 'true'), the repository is made shareable between
651 several users in a group (making sure all the files and objects are
652 group-writable). When 'all' (or 'world' or 'everybody'), the
653 repository will be readable by all users, additionally to being
654 group-shareable. When 'umask' (or 'false'), Git will use permissions
655 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
656 files in the repository will have this mode value. '0xxx' will override
657 user's umask value (whereas the other options will only override
658 requested parts of the user's umask value). Examples: '0660' will make
659 the repo read/write-able for the owner and group, but inaccessible to
660 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
661 repository that is group-readable but not group-writable.
662 See linkgit:git-init[1]. False by default.
664 core.warnAmbiguousRefs::
665 If true, Git will warn you if the ref name you passed it is ambiguous
666 and might match multiple refs in the repository. True by default.
669 An integer -1..9, indicating a default compression level.
670 -1 is the zlib default. 0 means no compression,
671 and 1..9 are various speed/size tradeoffs, 9 being slowest.
672 If set, this provides a default to other compression variables,
673 such as `core.looseCompression` and `pack.compression`.
675 core.looseCompression::
676 An integer -1..9, indicating the compression level for objects that
677 are not in a pack file. -1 is the zlib default. 0 means no
678 compression, and 1..9 are various speed/size tradeoffs, 9 being
679 slowest. If not set, defaults to core.compression. If that is
680 not set, defaults to 1 (best speed).
682 core.packedGitWindowSize::
683 Number of bytes of a pack file to map into memory in a
684 single mapping operation. Larger window sizes may allow
685 your system to process a smaller number of large pack files
686 more quickly. Smaller window sizes will negatively affect
687 performance due to increased calls to the operating system's
688 memory manager, but may improve performance when accessing
689 a large number of large pack files.
691 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
692 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
693 be reasonable for all users/operating systems. You probably do
694 not need to adjust this value.
696 Common unit suffixes of 'k', 'm', or 'g' are supported.
698 core.packedGitLimit::
699 Maximum number of bytes to map simultaneously into memory
700 from pack files. If Git needs to access more than this many
701 bytes at once to complete an operation it will unmap existing
702 regions to reclaim virtual address space within the process.
704 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
705 unlimited) on 64 bit platforms.
706 This should be reasonable for all users/operating systems, except on
707 the largest projects. You probably do not need to adjust this value.
709 Common unit suffixes of 'k', 'm', or 'g' are supported.
711 core.deltaBaseCacheLimit::
712 Maximum number of bytes to reserve for caching base objects
713 that may be referenced by multiple deltified objects. By storing the
714 entire decompressed base objects in a cache Git is able
715 to avoid unpacking and decompressing frequently used base
716 objects multiple times.
718 Default is 96 MiB on all platforms. This should be reasonable
719 for all users/operating systems, except on the largest projects.
720 You probably do not need to adjust this value.
722 Common unit suffixes of 'k', 'm', or 'g' are supported.
724 core.bigFileThreshold::
725 Files larger than this size are stored deflated, without
726 attempting delta compression. Storing large files without
727 delta compression avoids excessive memory usage, at the
728 slight expense of increased disk usage. Additionally files
729 larger than this size are always treated as binary.
731 Default is 512 MiB on all platforms. This should be reasonable
732 for most projects as source code and other text files can still
733 be delta compressed, but larger binary media files won't be.
735 Common unit suffixes of 'k', 'm', or 'g' are supported.
738 Specifies the pathname to the file that contains patterns to
739 describe paths that are not meant to be tracked, in addition
740 to '.gitignore' (per-directory) and '.git/info/exclude'.
741 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
742 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
743 is used instead. See linkgit:gitignore[5].
746 Some commands (e.g. svn and http interfaces) that interactively
747 ask for a password can be told to use an external program given
748 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
749 environment variable. If not set, fall back to the value of the
750 `SSH_ASKPASS` environment variable or, failing that, a simple password
751 prompt. The external program shall be given a suitable prompt as
752 command-line argument and write the password on its STDOUT.
754 core.attributesFile::
755 In addition to '.gitattributes' (per-directory) and
756 '.git/info/attributes', Git looks into this file for attributes
757 (see linkgit:gitattributes[5]). Path expansions are made the same
758 way as for `core.excludesFile`. Its default value is
759 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
760 set or empty, `$HOME/.config/git/attributes` is used instead.
763 By default Git will look for your hooks in the
764 '$GIT_DIR/hooks' directory. Set this to different path,
765 e.g. '/etc/git/hooks', and Git will try to find your hooks in
766 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
767 in '$GIT_DIR/hooks/pre-receive'.
769 The path can be either absolute or relative. A relative path is
770 taken as relative to the directory where the hooks are run (see
771 the "DESCRIPTION" section of linkgit:githooks[5]).
773 This configuration variable is useful in cases where you'd like to
774 centrally configure your Git hooks instead of configuring them on a
775 per-repository basis, or as a more flexible and centralized
776 alternative to having an `init.templateDir` where you've changed
780 Commands such as `commit` and `tag` that let you edit
781 messages by launching an editor use the value of this
782 variable when it is set, and the environment variable
783 `GIT_EDITOR` is not set. See linkgit:git-var[1].
786 Commands such as `commit` and `tag` that let you edit
787 messages consider a line that begins with this character
788 commented, and removes them after the editor returns
791 If set to "auto", `git-commit` would select a character that is not
792 the beginning character of any line in existing commit messages.
794 core.filesRefLockTimeout::
795 The length of time, in milliseconds, to retry when trying to
796 lock an individual reference. Value 0 means not to retry at
797 all; -1 means to try indefinitely. Default is 100 (i.e.,
800 core.packedRefsTimeout::
801 The length of time, in milliseconds, to retry when trying to
802 lock the `packed-refs` file. Value 0 means not to retry at
803 all; -1 means to try indefinitely. Default is 1000 (i.e.,
807 Text editor used by `git rebase -i` for editing the rebase instruction file.
808 The value is meant to be interpreted by the shell when it is used.
809 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
810 When not configured the default commit message editor is used instead.
813 Text viewer for use by Git commands (e.g., 'less'). The value
814 is meant to be interpreted by the shell. The order of preference
815 is the `$GIT_PAGER` environment variable, then `core.pager`
816 configuration, then `$PAGER`, and then the default chosen at
817 compile time (usually 'less').
819 When the `LESS` environment variable is unset, Git sets it to `FRX`
820 (if `LESS` environment variable is set, Git does not change it at
821 all). If you want to selectively override Git's default setting
822 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
823 be passed to the shell by Git, which will translate the final
824 command to `LESS=FRX less -S`. The environment does not set the
825 `S` option but the command line does, instructing less to truncate
826 long lines. Similarly, setting `core.pager` to `less -+F` will
827 deactivate the `F` option specified by the environment from the
828 command-line, deactivating the "quit if one screen" behavior of
829 `less`. One can specifically activate some flags for particular
830 commands: for example, setting `pager.blame` to `less -S` enables
831 line truncation only for `git blame`.
833 Likewise, when the `LV` environment variable is unset, Git sets it
834 to `-c`. You can override this setting by exporting `LV` with
835 another value or setting `core.pager` to `lv +c`.
838 A comma separated list of common whitespace problems to
839 notice. 'git diff' will use `color.diff.whitespace` to
840 highlight them, and 'git apply --whitespace=error' will
841 consider them as errors. You can prefix `-` to disable
842 any of them (e.g. `-trailing-space`):
844 * `blank-at-eol` treats trailing whitespaces at the end of the line
845 as an error (enabled by default).
846 * `space-before-tab` treats a space character that appears immediately
847 before a tab character in the initial indent part of the line as an
848 error (enabled by default).
849 * `indent-with-non-tab` treats a line that is indented with space
850 characters instead of the equivalent tabs as an error (not enabled by
852 * `tab-in-indent` treats a tab character in the initial indent part of
853 the line as an error (not enabled by default).
854 * `blank-at-eof` treats blank lines added at the end of file as an error
855 (enabled by default).
856 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
858 * `cr-at-eol` treats a carriage-return at the end of line as
859 part of the line terminator, i.e. with it, `trailing-space`
860 does not trigger if the character before such a carriage-return
861 is not a whitespace (not enabled by default).
862 * `tabwidth=<n>` tells how many character positions a tab occupies; this
863 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
864 errors. The default tab width is 8. Allowed values are 1 to 63.
866 core.fsyncObjectFiles::
867 This boolean will enable 'fsync()' when writing object files.
869 This is a total waste of time and effort on a filesystem that orders
870 data writes properly, but can be useful for filesystems that do not use
871 journalling (traditional UNIX filesystems) or that only journal metadata
872 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
875 Enable parallel index preload for operations like 'git diff'
877 This can speed up operations like 'git diff' and 'git status' especially
878 on filesystems like NFS that have weak caching semantics and thus
879 relatively high IO latencies. When enabled, Git will do the
880 index comparison to the filesystem data in parallel, allowing
881 overlapping IO's. Defaults to true.
884 You can set this to 'link', in which case a hardlink followed by
885 a delete of the source are used to make sure that object creation
886 will not overwrite existing objects.
888 On some file system/operating system combinations, this is unreliable.
889 Set this config setting to 'rename' there; However, This will remove the
890 check that makes sure that existing object files will not get overwritten.
893 When showing commit messages, also show notes which are stored in
894 the given ref. The ref must be fully qualified. If the given
895 ref does not exist, it is not an error but means that no
896 notes should be printed.
898 This setting defaults to "refs/notes/commits", and it can be overridden by
899 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
901 core.sparseCheckout::
902 Enable "sparse checkout" feature. See section "Sparse checkout" in
903 linkgit:git-read-tree[1] for more information.
906 Set the length object names are abbreviated to. If
907 unspecified or set to "auto", an appropriate value is
908 computed based on the approximate number of packed objects
909 in your repository, which hopefully is enough for
910 abbreviated object names to stay unique for some time.
911 The minimum length is 4.
914 add.ignore-errors (deprecated)::
915 Tells 'git add' to continue adding files when some files cannot be
916 added due to indexing errors. Equivalent to the `--ignore-errors`
917 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
918 as it does not follow the usual naming convention for configuration
922 Command aliases for the linkgit:git[1] command wrapper - e.g.
923 after defining "alias.last = cat-file commit HEAD", the invocation
924 "git last" is equivalent to "git cat-file commit HEAD". To avoid
925 confusion and troubles with script usage, aliases that
926 hide existing Git commands are ignored. Arguments are split by
927 spaces, the usual shell quoting and escaping is supported.
928 A quote pair or a backslash can be used to quote them.
930 If the alias expansion is prefixed with an exclamation point,
931 it will be treated as a shell command. For example, defining
932 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
933 "git new" is equivalent to running the shell command
934 "gitk --all --not ORIG_HEAD". Note that shell commands will be
935 executed from the top-level directory of a repository, which may
936 not necessarily be the current directory.
937 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
938 from the original current directory. See linkgit:git-rev-parse[1].
941 If true, git-am will call git-mailsplit for patches in mbox format
942 with parameter `--keep-cr`. In this case git-mailsplit will
943 not remove `\r` from lines ending with `\r\n`. Can be overridden
944 by giving `--no-keep-cr` from the command line.
945 See linkgit:git-am[1], linkgit:git-mailsplit[1].
948 By default, `git am` will fail if the patch does not apply cleanly. When
949 set to true, this setting tells `git am` to fall back on 3-way merge if
950 the patch records the identity of blobs it is supposed to apply to and
951 we have those blobs available locally (equivalent to giving the `--3way`
952 option from the command line). Defaults to `false`.
953 See linkgit:git-am[1].
955 apply.ignoreWhitespace::
956 When set to 'change', tells 'git apply' to ignore changes in
957 whitespace, in the same way as the `--ignore-space-change`
959 When set to one of: no, none, never, false tells 'git apply' to
960 respect all whitespace differences.
961 See linkgit:git-apply[1].
964 Tells 'git apply' how to handle whitespaces, in the same way
965 as the `--whitespace` option. See linkgit:git-apply[1].
968 Do not treat root commits as boundaries in linkgit:git-blame[1].
969 This option defaults to false.
971 blame.blankBoundary::
972 Show blank commit object name for boundary commits in
973 linkgit:git-blame[1]. This option defaults to false.
976 Show the author email instead of author name in linkgit:git-blame[1].
977 This option defaults to false.
980 Specifies the format used to output dates in linkgit:git-blame[1].
981 If unset the iso format is used. For supported values,
982 see the discussion of the `--date` option at linkgit:git-log[1].
984 branch.autoSetupMerge::
985 Tells 'git branch' and 'git checkout' to set up new branches
986 so that linkgit:git-pull[1] will appropriately merge from the
987 starting point branch. Note that even if this option is not set,
988 this behavior can be chosen per-branch using the `--track`
989 and `--no-track` options. The valid settings are: `false` -- no
990 automatic setup is done; `true` -- automatic setup is done when the
991 starting point is a remote-tracking branch; `always` --
992 automatic setup is done when the starting point is either a
993 local branch or remote-tracking
994 branch. This option defaults to true.
996 branch.autoSetupRebase::
997 When a new branch is created with 'git branch' or 'git checkout'
998 that tracks another branch, this variable tells Git to set
999 up pull to rebase instead of merge (see "branch.<name>.rebase").
1000 When `never`, rebase is never automatically set to true.
1001 When `local`, rebase is set to true for tracked branches of
1002 other local branches.
1003 When `remote`, rebase is set to true for tracked branches of
1004 remote-tracking branches.
1005 When `always`, rebase will be set to true for all tracking
1007 See "branch.autoSetupMerge" for details on how to set up a
1008 branch to track another branch.
1009 This option defaults to never.
1011 branch.<name>.remote::
1012 When on branch <name>, it tells 'git fetch' and 'git push'
1013 which remote to fetch from/push to. The remote to push to
1014 may be overridden with `remote.pushDefault` (for all branches).
1015 The remote to push to, for the current branch, may be further
1016 overridden by `branch.<name>.pushRemote`. If no remote is
1017 configured, or if you are not on any branch, it defaults to
1018 `origin` for fetching and `remote.pushDefault` for pushing.
1019 Additionally, `.` (a period) is the current local repository
1020 (a dot-repository), see `branch.<name>.merge`'s final note below.
1022 branch.<name>.pushRemote::
1023 When on branch <name>, it overrides `branch.<name>.remote` for
1024 pushing. It also overrides `remote.pushDefault` for pushing
1025 from branch <name>. When you pull from one place (e.g. your
1026 upstream) and push to another place (e.g. your own publishing
1027 repository), you would want to set `remote.pushDefault` to
1028 specify the remote to push to for all branches, and use this
1029 option to override it for a specific branch.
1031 branch.<name>.merge::
1032 Defines, together with branch.<name>.remote, the upstream branch
1033 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1034 branch to merge and can also affect 'git push' (see push.default).
1035 When in branch <name>, it tells 'git fetch' the default
1036 refspec to be marked for merging in FETCH_HEAD. The value is
1037 handled like the remote part of a refspec, and must match a
1038 ref which is fetched from the remote given by
1039 "branch.<name>.remote".
1040 The merge information is used by 'git pull' (which at first calls
1041 'git fetch') to lookup the default branch for merging. Without
1042 this option, 'git pull' defaults to merge the first refspec fetched.
1043 Specify multiple values to get an octopus merge.
1044 If you wish to setup 'git pull' so that it merges into <name> from
1045 another branch in the local repository, you can point
1046 branch.<name>.merge to the desired branch, and use the relative path
1047 setting `.` (a period) for branch.<name>.remote.
1049 branch.<name>.mergeOptions::
1050 Sets default options for merging into branch <name>. The syntax and
1051 supported options are the same as those of linkgit:git-merge[1], but
1052 option values containing whitespace characters are currently not
1055 branch.<name>.rebase::
1056 When true, rebase the branch <name> on top of the fetched branch,
1057 instead of merging the default branch from the default remote when
1058 "git pull" is run. See "pull.rebase" for doing this in a non
1059 branch-specific manner.
1061 When preserve, also pass `--preserve-merges` along to 'git rebase'
1062 so that locally committed merge commits will not be flattened
1063 by running 'git pull'.
1065 When the value is `interactive`, the rebase is run in interactive mode.
1067 *NOTE*: this is a possibly dangerous operation; do *not* use
1068 it unless you understand the implications (see linkgit:git-rebase[1]
1071 branch.<name>.description::
1072 Branch description, can be edited with
1073 `git branch --edit-description`. Branch description is
1074 automatically added in the format-patch cover letter or
1075 request-pull summary.
1077 browser.<tool>.cmd::
1078 Specify the command to invoke the specified browser. The
1079 specified command is evaluated in shell with the URLs passed
1080 as arguments. (See linkgit:git-web{litdd}browse[1].)
1082 browser.<tool>.path::
1083 Override the path for the given tool that may be used to
1084 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1085 working repository in gitweb (see linkgit:git-instaweb[1]).
1087 clean.requireForce::
1088 A boolean to make git-clean do nothing unless given -f,
1089 -i or -n. Defaults to true.
1092 A boolean to enable/disable color in hints (e.g. when a push
1093 failed, see `advice.*` for a list). May be set to `always`,
1094 `false` (or `never`) or `auto` (or `true`), in which case colors
1095 are used only when the error output goes to a terminal. If
1096 unset, then the value of `color.ui` is used (`auto` by default).
1099 Use customized color for hints.
1102 A boolean to enable/disable color in the output of
1103 linkgit:git-branch[1]. May be set to `always`,
1104 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1105 only when the output is to a terminal. If unset, then the
1106 value of `color.ui` is used (`auto` by default).
1108 color.branch.<slot>::
1109 Use customized color for branch coloration. `<slot>` is one of
1110 `current` (the current branch), `local` (a local branch),
1111 `remote` (a remote-tracking branch in refs/remotes/),
1112 `upstream` (upstream tracking branch), `plain` (other
1116 Whether to use ANSI escape sequences to add color to patches.
1117 If this is set to `always`, linkgit:git-diff[1],
1118 linkgit:git-log[1], and linkgit:git-show[1] will use color
1119 for all patches. If it is set to `true` or `auto`, those
1120 commands will only use color when output is to the terminal.
1121 If unset, then the value of `color.ui` is used (`auto` by
1124 This does not affect linkgit:git-format-patch[1] or the
1125 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1126 command line with the `--color[=<when>]` option.
1129 If set to either a valid `<mode>` or a true value, moved lines
1130 in a diff are colored differently, for details of valid modes
1131 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1132 true the default color mode will be used. When set to false,
1133 moved lines are not colored.
1136 Use customized color for diff colorization. `<slot>` specifies
1137 which part of the patch to use the specified color, and is one
1138 of `context` (context text - `plain` is a historical synonym),
1139 `meta` (metainformation), `frag`
1140 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1141 `new` (added lines), `commit` (commit headers), `whitespace`
1142 (highlighting whitespace errors), `oldMoved` (deleted lines),
1143 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1144 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1145 and `newMovedAlternativeDimmed` (See the '<mode>'
1146 setting of '--color-moved' in linkgit:git-diff[1] for details).
1148 color.decorate.<slot>::
1149 Use customized color for 'git log --decorate' output. `<slot>` is one
1150 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1151 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1154 When set to `always`, always highlight matches. When `false` (or
1155 `never`), never. When set to `true` or `auto`, use color only
1156 when the output is written to the terminal. If unset, then the
1157 value of `color.ui` is used (`auto` by default).
1160 Use customized color for grep colorization. `<slot>` specifies which
1161 part of the line to use the specified color, and is one of
1165 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1167 filename prefix (when not using `-h`)
1169 function name lines (when using `-p`)
1171 line number prefix (when using `-n`)
1173 matching text (same as setting `matchContext` and `matchSelected`)
1175 matching text in context lines
1177 matching text in selected lines
1179 non-matching text in selected lines
1181 separators between fields on a line (`:`, `-`, and `=`)
1182 and between hunks (`--`)
1186 When set to `always`, always use colors for interactive prompts
1187 and displays (such as those used by "git-add --interactive" and
1188 "git-clean --interactive"). When false (or `never`), never.
1189 When set to `true` or `auto`, use colors only when the output is
1190 to the terminal. If unset, then the value of `color.ui` is
1191 used (`auto` by default).
1193 color.interactive.<slot>::
1194 Use customized color for 'git add --interactive' and 'git clean
1195 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1196 or `error`, for four distinct types of normal output from
1197 interactive commands.
1200 A boolean to enable/disable colored output when the pager is in
1201 use (default is true).
1204 A boolean to enable/disable color in push errors. May be set to
1205 `always`, `false` (or `never`) or `auto` (or `true`), in which
1206 case colors are used only when the error output goes to a terminal.
1207 If unset, then the value of `color.ui` is used (`auto` by default).
1210 Use customized color for push errors.
1213 A boolean to enable/disable color in the output of
1214 linkgit:git-show-branch[1]. May be set to `always`,
1215 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1216 only when the output is to a terminal. If unset, then the
1217 value of `color.ui` is used (`auto` by default).
1220 A boolean to enable/disable color in the output of
1221 linkgit:git-status[1]. May be set to `always`,
1222 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1223 only when the output is to a terminal. If unset, then the
1224 value of `color.ui` is used (`auto` by default).
1226 color.status.<slot>::
1227 Use customized color for status colorization. `<slot>` is
1228 one of `header` (the header text of the status message),
1229 `added` or `updated` (files which are added but not committed),
1230 `changed` (files which are changed but not added in the index),
1231 `untracked` (files which are not tracked by Git),
1232 `branch` (the current branch),
1233 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1235 `localBranch` or `remoteBranch` (the local and remote branch names,
1236 respectively, when branch and tracking information is displayed in the
1237 status short-format), or
1238 `unmerged` (files which have unmerged changes).
1241 A boolean to enable/disable color when pushes are rejected. May be
1242 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1243 case colors are used only when the error output goes to a terminal.
1244 If unset, then the value of `color.ui` is used (`auto` by default).
1246 color.transport.rejected::
1247 Use customized color when a push was rejected.
1250 This variable determines the default value for variables such
1251 as `color.diff` and `color.grep` that control the use of color
1252 per command family. Its scope will expand as more commands learn
1253 configuration to set a default for the `--color` option. Set it
1254 to `false` or `never` if you prefer Git commands not to use
1255 color unless enabled explicitly with some other configuration
1256 or the `--color` option. Set it to `always` if you want all
1257 output not intended for machine consumption to use color, to
1258 `true` or `auto` (this is the default since Git 1.8.4) if you
1259 want such output to use color when written to the terminal.
1262 Specify whether supported commands should output in columns.
1263 This variable consists of a list of tokens separated by spaces
1266 These options control when the feature should be enabled
1267 (defaults to 'never'):
1271 always show in columns
1273 never show in columns
1275 show in columns if the output is to the terminal
1278 These options control layout (defaults to 'column'). Setting any
1279 of these implies 'always' if none of 'always', 'never', or 'auto' are
1284 fill columns before rows
1286 fill rows before columns
1291 Finally, these options can be combined with a layout option (defaults
1296 make unequal size columns to utilize more space
1298 make equal size columns
1302 Specify whether to output branch listing in `git branch` in columns.
1303 See `column.ui` for details.
1306 Specify the layout when list items in `git clean -i`, which always
1307 shows files and directories in columns. See `column.ui` for details.
1310 Specify whether to output untracked files in `git status` in columns.
1311 See `column.ui` for details.
1314 Specify whether to output tag listing in `git tag` in columns.
1315 See `column.ui` for details.
1318 This setting overrides the default of the `--cleanup` option in
1319 `git commit`. See linkgit:git-commit[1] for details. Changing the
1320 default can be useful when you always want to keep lines that begin
1321 with comment character `#` in your log message, in which case you
1322 would do `git config commit.cleanup whitespace` (note that you will
1323 have to remove the help lines that begin with `#` in the commit log
1324 template yourself, if you do this).
1328 A boolean to specify whether all commits should be GPG signed.
1329 Use of this option when doing operations such as rebase can
1330 result in a large number of commits being signed. It may be
1331 convenient to use an agent to avoid typing your GPG passphrase
1335 A boolean to enable/disable inclusion of status information in the
1336 commit message template when using an editor to prepare the commit
1337 message. Defaults to true.
1340 Specify the pathname of a file to use as the template for
1341 new commit messages.
1344 A boolean or int to specify the level of verbose with `git commit`.
1345 See linkgit:git-commit[1].
1348 Specify an external helper to be called when a username or
1349 password credential is needed; the helper may consult external
1350 storage to avoid prompting the user for the credentials. Note
1351 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1354 credential.useHttpPath::
1355 When acquiring credentials, consider the "path" component of an http
1356 or https URL to be important. Defaults to false. See
1357 linkgit:gitcredentials[7] for more information.
1359 credential.username::
1360 If no username is set for a network authentication, use this username
1361 by default. See credential.<context>.* below, and
1362 linkgit:gitcredentials[7].
1364 credential.<url>.*::
1365 Any of the credential.* options above can be applied selectively to
1366 some credentials. For example "credential.https://example.com.username"
1367 would set the default username only for https connections to
1368 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1371 credentialCache.ignoreSIGHUP::
1372 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1374 include::diff-config.txt[]
1376 difftool.<tool>.path::
1377 Override the path for the given tool. This is useful in case
1378 your tool is not in the PATH.
1380 difftool.<tool>.cmd::
1381 Specify the command to invoke the specified diff tool.
1382 The specified command is evaluated in shell with the following
1383 variables available: 'LOCAL' is set to the name of the temporary
1384 file containing the contents of the diff pre-image and 'REMOTE'
1385 is set to the name of the temporary file containing the contents
1386 of the diff post-image.
1389 Prompt before each invocation of the diff tool.
1391 fastimport.unpackLimit::
1392 If the number of objects imported by linkgit:git-fast-import[1]
1393 is below this limit, then the objects will be unpacked into
1394 loose object files. However if the number of imported objects
1395 equals or exceeds this limit then the pack will be stored as a
1396 pack. Storing the pack from a fast-import can make the import
1397 operation complete faster, especially on slow filesystems. If
1398 not set, the value of `transfer.unpackLimit` is used instead.
1400 fetch.recurseSubmodules::
1401 This option can be either set to a boolean value or to 'on-demand'.
1402 Setting it to a boolean changes the behavior of fetch and pull to
1403 unconditionally recurse into submodules when set to true or to not
1404 recurse at all when set to false. When set to 'on-demand' (the default
1405 value), fetch and pull will only recurse into a populated submodule
1406 when its superproject retrieves a commit that updates the submodule's
1410 If it is set to true, git-fetch-pack will check all fetched
1411 objects. It will abort in the case of a malformed object or a
1412 broken link. The result of an abort are only dangling objects.
1413 Defaults to false. If not set, the value of `transfer.fsckObjects`
1417 If the number of objects fetched over the Git native
1418 transfer is below this
1419 limit, then the objects will be unpacked into loose object
1420 files. However if the number of received objects equals or
1421 exceeds this limit then the received pack will be stored as
1422 a pack, after adding any missing delta bases. Storing the
1423 pack from a push can make the push operation complete faster,
1424 especially on slow filesystems. If not set, the value of
1425 `transfer.unpackLimit` is used instead.
1428 If true, fetch will automatically behave as if the `--prune`
1429 option was given on the command line. See also `remote.<name>.prune`
1430 and the PRUNING section of linkgit:git-fetch[1].
1433 If true, fetch will automatically behave as if the
1434 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1435 if not set already. This allows for setting both this option
1436 and `fetch.prune` to maintain a 1=1 mapping to upstream
1437 refs. See also `remote.<name>.pruneTags` and the PRUNING
1438 section of linkgit:git-fetch[1].
1441 Control how ref update status is printed. Valid values are
1442 `full` and `compact`. Default value is `full`. See section
1443 OUTPUT in linkgit:git-fetch[1] for detail.
1446 Enable multipart/mixed attachments as the default for
1447 'format-patch'. The value can also be a double quoted string
1448 which will enable attachments as the default and set the
1449 value as the boundary. See the --attach option in
1450 linkgit:git-format-patch[1].
1453 Provides the default value for the `--from` option to format-patch.
1454 Accepts a boolean value, or a name and email address. If false,
1455 format-patch defaults to `--no-from`, using commit authors directly in
1456 the "From:" field of patch mails. If true, format-patch defaults to
1457 `--from`, using your committer identity in the "From:" field of patch
1458 mails and including a "From:" field in the body of the patch mail if
1459 different. If set to a non-boolean value, format-patch uses that
1460 value instead of your committer identity. Defaults to false.
1463 A boolean which can enable or disable sequence numbers in patch
1464 subjects. It defaults to "auto" which enables it only if there
1465 is more than one patch. It can be enabled or disabled for all
1466 messages by setting it to "true" or "false". See --numbered
1467 option in linkgit:git-format-patch[1].
1470 Additional email headers to include in a patch to be submitted
1471 by mail. See linkgit:git-format-patch[1].
1475 Additional recipients to include in a patch to be submitted
1476 by mail. See the --to and --cc options in
1477 linkgit:git-format-patch[1].
1479 format.subjectPrefix::
1480 The default for format-patch is to output files with the '[PATCH]'
1481 subject prefix. Use this variable to change that prefix.
1484 The default for format-patch is to output a signature containing
1485 the Git version number. Use this variable to change that default.
1486 Set this variable to the empty string ("") to suppress
1487 signature generation.
1489 format.signatureFile::
1490 Works just like format.signature except the contents of the
1491 file specified by this variable will be used as the signature.
1494 The default for format-patch is to output files with the suffix
1495 `.patch`. Use this variable to change that suffix (make sure to
1496 include the dot if you want it).
1499 The default pretty format for log/show/whatchanged command,
1500 See linkgit:git-log[1], linkgit:git-show[1],
1501 linkgit:git-whatchanged[1].
1504 The default threading style for 'git format-patch'. Can be
1505 a boolean value, or `shallow` or `deep`. `shallow` threading
1506 makes every mail a reply to the head of the series,
1507 where the head is chosen from the cover letter, the
1508 `--in-reply-to`, and the first patch mail, in this order.
1509 `deep` threading makes every mail a reply to the previous one.
1510 A true boolean value is the same as `shallow`, and a false
1511 value disables threading.
1514 A boolean value which lets you enable the `-s/--signoff` option of
1515 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1516 patch should be a conscious act and means that you certify you have
1517 the rights to submit this work under the same open source license.
1518 Please see the 'SubmittingPatches' document for further discussion.
1520 format.coverLetter::
1521 A boolean that controls whether to generate a cover-letter when
1522 format-patch is invoked, but in addition can be set to "auto", to
1523 generate a cover-letter only when there's more than one patch.
1525 format.outputDirectory::
1526 Set a custom directory to store the resulting files instead of the
1527 current working directory.
1529 format.useAutoBase::
1530 A boolean value which lets you enable the `--base=auto` option of
1531 format-patch by default.
1533 filter.<driver>.clean::
1534 The command which is used to convert the content of a worktree
1535 file to a blob upon checkin. See linkgit:gitattributes[5] for
1538 filter.<driver>.smudge::
1539 The command which is used to convert the content of a blob
1540 object to a worktree file upon checkout. See
1541 linkgit:gitattributes[5] for details.
1544 Allows overriding the message type (error, warn or ignore) of a
1545 specific message ID such as `missingEmail`.
1547 For convenience, fsck prefixes the error/warning with the message ID,
1548 e.g. "missingEmail: invalid author/committer line - missing email" means
1549 that setting `fsck.missingEmail = ignore` will hide that issue.
1551 This feature is intended to support working with legacy repositories
1552 which cannot be repaired without disruptive changes.
1555 The path to a sorted list of object names (i.e. one SHA-1 per
1556 line) that are known to be broken in a non-fatal way and should
1557 be ignored. This feature is useful when an established project
1558 should be accepted despite early commits containing errors that
1559 can be safely ignored such as invalid committer email addresses.
1560 Note: corrupt objects cannot be skipped with this setting.
1562 gc.aggressiveDepth::
1563 The depth parameter used in the delta compression
1564 algorithm used by 'git gc --aggressive'. This defaults
1567 gc.aggressiveWindow::
1568 The window size parameter used in the delta compression
1569 algorithm used by 'git gc --aggressive'. This defaults
1573 When there are approximately more than this many loose
1574 objects in the repository, `git gc --auto` will pack them.
1575 Some Porcelain commands use this command to perform a
1576 light-weight garbage collection from time to time. The
1577 default value is 6700. Setting this to 0 disables it.
1580 When there are more than this many packs that are not
1581 marked with `*.keep` file in the repository, `git gc
1582 --auto` consolidates them into one larger pack. The
1583 default value is 50. Setting this to 0 disables it.
1586 Make `git gc --auto` return immediately and run in background
1587 if the system supports it. Default is true.
1590 If the file gc.log exists, then `git gc --auto` won't run
1591 unless that file is more than 'gc.logExpiry' old. Default is
1592 "1.day". See `gc.pruneExpire` for more ways to specify its
1596 Running `git pack-refs` in a repository renders it
1597 unclonable by Git versions prior to 1.5.1.2 over dumb
1598 transports such as HTTP. This variable determines whether
1599 'git gc' runs `git pack-refs`. This can be set to `notbare`
1600 to enable it within all non-bare repos or it can be set to a
1601 boolean value. The default is `true`.
1604 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1605 Override the grace period with this config variable. The value
1606 "now" may be used to disable this grace period and always prune
1607 unreachable objects immediately, or "never" may be used to
1608 suppress pruning. This feature helps prevent corruption when
1609 'git gc' runs concurrently with another process writing to the
1610 repository; see the "NOTES" section of linkgit:git-gc[1].
1612 gc.worktreePruneExpire::
1613 When 'git gc' is run, it calls
1614 'git worktree prune --expire 3.months.ago'.
1615 This config variable can be used to set a different grace
1616 period. The value "now" may be used to disable the grace
1617 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1618 may be used to suppress pruning.
1621 gc.<pattern>.reflogExpire::
1622 'git reflog expire' removes reflog entries older than
1623 this time; defaults to 90 days. The value "now" expires all
1624 entries immediately, and "never" suppresses expiration
1625 altogether. With "<pattern>" (e.g.
1626 "refs/stash") in the middle the setting applies only to
1627 the refs that match the <pattern>.
1629 gc.reflogExpireUnreachable::
1630 gc.<pattern>.reflogExpireUnreachable::
1631 'git reflog expire' removes reflog entries older than
1632 this time and are not reachable from the current tip;
1633 defaults to 30 days. The value "now" expires all entries
1634 immediately, and "never" suppresses expiration altogether.
1635 With "<pattern>" (e.g. "refs/stash")
1636 in the middle, the setting applies only to the refs that
1637 match the <pattern>.
1640 Records of conflicted merge you resolved earlier are
1641 kept for this many days when 'git rerere gc' is run.
1642 You can also use more human-readable "1.month.ago", etc.
1643 The default is 60 days. See linkgit:git-rerere[1].
1645 gc.rerereUnresolved::
1646 Records of conflicted merge you have not resolved are
1647 kept for this many days when 'git rerere gc' is run.
1648 You can also use more human-readable "1.month.ago", etc.
1649 The default is 15 days. See linkgit:git-rerere[1].
1651 gitcvs.commitMsgAnnotation::
1652 Append this string to each commit message. Set to empty string
1653 to disable this feature. Defaults to "via git-CVS emulator".
1656 Whether the CVS server interface is enabled for this repository.
1657 See linkgit:git-cvsserver[1].
1660 Path to a log file where the CVS server interface well... logs
1661 various stuff. See linkgit:git-cvsserver[1].
1663 gitcvs.usecrlfattr::
1664 If true, the server will look up the end-of-line conversion
1665 attributes for files to determine the `-k` modes to use. If
1666 the attributes force Git to treat a file as text,
1667 the `-k` mode will be left blank so CVS clients will
1668 treat it as text. If they suppress text conversion, the file
1669 will be set with '-kb' mode, which suppresses any newline munging
1670 the client might otherwise do. If the attributes do not allow
1671 the file type to be determined, then `gitcvs.allBinary` is
1672 used. See linkgit:gitattributes[5].
1675 This is used if `gitcvs.usecrlfattr` does not resolve
1676 the correct '-kb' mode to use. If true, all
1677 unresolved files are sent to the client in
1678 mode '-kb'. This causes the client to treat them
1679 as binary files, which suppresses any newline munging it
1680 otherwise might do. Alternatively, if it is set to "guess",
1681 then the contents of the file are examined to decide if
1682 it is binary, similar to `core.autocrlf`.
1685 Database used by git-cvsserver to cache revision information
1686 derived from the Git repository. The exact meaning depends on the
1687 used database driver, for SQLite (which is the default driver) this
1688 is a filename. Supports variable substitution (see
1689 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1690 Default: '%Ggitcvs.%m.sqlite'
1693 Used Perl DBI driver. You can specify any available driver
1694 for this here, but it might not work. git-cvsserver is tested
1695 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1696 reported *not* to work with 'DBD::mysql'. Experimental feature.
1697 May not contain double colons (`:`). Default: 'SQLite'.
1698 See linkgit:git-cvsserver[1].
1700 gitcvs.dbUser, gitcvs.dbPass::
1701 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1702 since SQLite has no concept of database users and/or passwords.
1703 'gitcvs.dbUser' supports variable substitution (see
1704 linkgit:git-cvsserver[1] for details).
1706 gitcvs.dbTableNamePrefix::
1707 Database table name prefix. Prepended to the names of any
1708 database tables used, allowing a single database to be used
1709 for several repositories. Supports variable substitution (see
1710 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1711 characters will be replaced with underscores.
1713 All gitcvs variables except for `gitcvs.usecrlfattr` and
1714 `gitcvs.allBinary` can also be specified as
1715 'gitcvs.<access_method>.<varname>' (where 'access_method'
1716 is one of "ext" and "pserver") to make them apply only for the given
1720 gitweb.description::
1723 See linkgit:gitweb[1] for description.
1731 gitweb.remote_heads::
1734 See linkgit:gitweb.conf[5] for description.
1737 If set to true, enable `-n` option by default.
1740 Set the default matching behavior. Using a value of 'basic', 'extended',
1741 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1742 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1743 value 'default' will return to the default matching behavior.
1745 grep.extendedRegexp::
1746 If set to true, enable `--extended-regexp` option by default. This
1747 option is ignored when the `grep.patternType` option is set to a value
1748 other than 'default'.
1751 Number of grep worker threads to use.
1752 See `grep.threads` in linkgit:git-grep[1] for more information.
1754 grep.fallbackToNoIndex::
1755 If set to true, fall back to git grep --no-index if git grep
1756 is executed outside of a git repository. Defaults to false.
1759 Use this custom program instead of "`gpg`" found on `$PATH` when
1760 making or verifying a PGP signature. The program must support the
1761 same command-line interface as GPG, namely, to verify a detached
1762 signature, "`gpg --verify $file - <$signature`" is run, and the
1763 program is expected to signal a good signature by exiting with
1764 code 0, and to generate an ASCII-armored detached signature, the
1765 standard input of "`gpg -bsau $key`" is fed with the contents to be
1766 signed, and the program is expected to send the result to its
1769 gui.commitMsgWidth::
1770 Defines how wide the commit message window is in the
1771 linkgit:git-gui[1]. "75" is the default.
1774 Specifies how many context lines should be used in calls to diff
1775 made by the linkgit:git-gui[1]. The default is "5".
1777 gui.displayUntracked::
1778 Determines if linkgit:git-gui[1] shows untracked files
1779 in the file list. The default is "true".
1782 Specifies the default encoding to use for displaying of
1783 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1784 It can be overridden by setting the 'encoding' attribute
1785 for relevant files (see linkgit:gitattributes[5]).
1786 If this option is not set, the tools default to the
1789 gui.matchTrackingBranch::
1790 Determines if new branches created with linkgit:git-gui[1] should
1791 default to tracking remote branches with matching names or
1792 not. Default: "false".
1794 gui.newBranchTemplate::
1795 Is used as suggested name when creating new branches using the
1798 gui.pruneDuringFetch::
1799 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1800 performing a fetch. The default value is "false".
1803 Determines if linkgit:git-gui[1] should trust the file modification
1804 timestamp or not. By default the timestamps are not trusted.
1806 gui.spellingDictionary::
1807 Specifies the dictionary used for spell checking commit messages in
1808 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1812 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1813 location detection. It makes blame significantly faster on huge
1814 repositories at the expense of less thorough copy detection.
1816 gui.copyBlameThreshold::
1817 Specifies the threshold to use in 'git gui blame' original location
1818 detection, measured in alphanumeric characters. See the
1819 linkgit:git-blame[1] manual for more information on copy detection.
1821 gui.blamehistoryctx::
1822 Specifies the radius of history context in days to show in
1823 linkgit:gitk[1] for the selected commit, when the `Show History
1824 Context` menu item is invoked from 'git gui blame'. If this
1825 variable is set to zero, the whole history is shown.
1827 guitool.<name>.cmd::
1828 Specifies the shell command line to execute when the corresponding item
1829 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1830 mandatory for every tool. The command is executed from the root of
1831 the working directory, and in the environment it receives the name of
1832 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1833 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1834 the head is detached, 'CUR_BRANCH' is empty).
1836 guitool.<name>.needsFile::
1837 Run the tool only if a diff is selected in the GUI. It guarantees
1838 that 'FILENAME' is not empty.
1840 guitool.<name>.noConsole::
1841 Run the command silently, without creating a window to display its
1844 guitool.<name>.noRescan::
1845 Don't rescan the working directory for changes after the tool
1848 guitool.<name>.confirm::
1849 Show a confirmation dialog before actually running the tool.
1851 guitool.<name>.argPrompt::
1852 Request a string argument from the user, and pass it to the tool
1853 through the `ARGS` environment variable. Since requesting an
1854 argument implies confirmation, the 'confirm' option has no effect
1855 if this is enabled. If the option is set to 'true', 'yes', or '1',
1856 the dialog uses a built-in generic prompt; otherwise the exact
1857 value of the variable is used.
1859 guitool.<name>.revPrompt::
1860 Request a single valid revision from the user, and set the
1861 `REVISION` environment variable. In other aspects this option
1862 is similar to 'argPrompt', and can be used together with it.
1864 guitool.<name>.revUnmerged::
1865 Show only unmerged branches in the 'revPrompt' subdialog.
1866 This is useful for tools similar to merge or rebase, but not
1867 for things like checkout or reset.
1869 guitool.<name>.title::
1870 Specifies the title to use for the prompt dialog. The default
1873 guitool.<name>.prompt::
1874 Specifies the general prompt string to display at the top of
1875 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1876 The default value includes the actual command.
1879 Specify the browser that will be used to display help in the
1880 'web' format. See linkgit:git-help[1].
1883 Override the default help format used by linkgit:git-help[1].
1884 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1885 the default. 'web' and 'html' are the same.
1888 Automatically correct and execute mistyped commands after
1889 waiting for the given number of deciseconds (0.1 sec). If more
1890 than one command can be deduced from the entered text, nothing
1891 will be executed. If the value of this option is negative,
1892 the corrected command will be executed immediately. If the
1893 value is 0 - the command will be just shown but not executed.
1894 This is the default.
1897 Specify the path where the HTML documentation resides. File system paths
1898 and URLs are supported. HTML pages will be prefixed with this path when
1899 help is displayed in the 'web' format. This defaults to the documentation
1900 path of your Git installation.
1903 Override the HTTP proxy, normally configured using the 'http_proxy',
1904 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1905 addition to the syntax understood by curl, it is possible to specify a
1906 proxy string with a user name but no password, in which case git will
1907 attempt to acquire one in the same way it does for other credentials. See
1908 linkgit:gitcredentials[7] for more information. The syntax thus is
1909 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1910 on a per-remote basis; see remote.<name>.proxy
1912 http.proxyAuthMethod::
1913 Set the method with which to authenticate against the HTTP proxy. This
1914 only takes effect if the configured proxy string contains a user name part
1915 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1916 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1917 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1918 variable. Possible values are:
1921 * `anyauth` - Automatically pick a suitable authentication method. It is
1922 assumed that the proxy answers an unauthenticated request with a 407
1923 status code and one or more Proxy-authenticate headers with supported
1924 authentication methods. This is the default.
1925 * `basic` - HTTP Basic authentication
1926 * `digest` - HTTP Digest authentication; this prevents the password from being
1927 transmitted to the proxy in clear text
1928 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1930 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1934 Attempt authentication without seeking a username or password. This
1935 can be used to attempt GSS-Negotiate authentication without specifying
1936 a username in the URL, as libcurl normally requires a username for
1940 Control GSSAPI credential delegation. The delegation is disabled
1941 by default in libcurl since version 7.21.7. Set parameter to tell
1942 the server what it is allowed to delegate when it comes to user
1943 credentials. Used with GSS/kerberos. Possible values are:
1946 * `none` - Don't allow any delegation.
1947 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1948 Kerberos service ticket, which is a matter of realm policy.
1949 * `always` - Unconditionally allow the server to delegate.
1954 Pass an additional HTTP header when communicating with a server. If
1955 more than one such entry exists, all of them are added as extra
1956 headers. To allow overriding the settings inherited from the system
1957 config, an empty value will reset the extra headers to the empty list.
1960 The pathname of a file containing previously stored cookie lines,
1961 which should be used
1962 in the Git http session, if they match the server. The file format
1963 of the file to read cookies from should be plain HTTP headers or
1964 the Netscape/Mozilla cookie file format (see `curl(1)`).
1965 NOTE that the file specified with http.cookieFile is used only as
1966 input unless http.saveCookies is set.
1969 If set, store cookies received during requests to the file specified by
1970 http.cookieFile. Has no effect if http.cookieFile is unset.
1973 The SSL version to use when negotiating an SSL connection, if you
1974 want to force the default. The available and default version
1975 depend on whether libcurl was built against NSS or OpenSSL and the
1976 particular configuration of the crypto library in use. Internally
1977 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1978 documentation for more details on the format of this option and
1979 for the ssl version supported. Actually the possible values of
1991 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1992 To force git to use libcurl's default ssl version and ignore any
1993 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1996 http.sslCipherList::
1997 A list of SSL ciphers to use when negotiating an SSL connection.
1998 The available ciphers depend on whether libcurl was built against
1999 NSS or OpenSSL and the particular configuration of the crypto
2000 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2001 option; see the libcurl documentation for more details on the format
2004 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2005 To force git to use libcurl's default cipher list and ignore any
2006 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2010 Whether to verify the SSL certificate when fetching or pushing
2011 over HTTPS. Defaults to true. Can be overridden by the
2012 `GIT_SSL_NO_VERIFY` environment variable.
2015 File containing the SSL certificate when fetching or pushing
2016 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2020 File containing the SSL private key when fetching or pushing
2021 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2024 http.sslCertPasswordProtected::
2025 Enable Git's password prompt for the SSL certificate. Otherwise
2026 OpenSSL will prompt the user, possibly many times, if the
2027 certificate or private key is encrypted. Can be overridden by the
2028 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2031 File containing the certificates to verify the peer with when
2032 fetching or pushing over HTTPS. Can be overridden by the
2033 `GIT_SSL_CAINFO` environment variable.
2036 Path containing files with the CA certificates to verify the peer
2037 with when fetching or pushing over HTTPS. Can be overridden
2038 by the `GIT_SSL_CAPATH` environment variable.
2041 Public key of the https service. It may either be the filename of
2042 a PEM or DER encoded public key file or a string starting with
2043 'sha256//' followed by the base64 encoded sha256 hash of the
2044 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2045 exit with an error if this option is set but not supported by
2049 Attempt to use AUTH SSL/TLS and encrypted data transfers
2050 when connecting via regular FTP protocol. This might be needed
2051 if the FTP server requires it for security reasons or you wish
2052 to connect securely whenever remote FTP server supports it.
2053 Default is false since it might trigger certificate verification
2054 errors on misconfigured servers.
2057 How many HTTP requests to launch in parallel. Can be overridden
2058 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2061 The number of curl sessions (counted across slots) to be kept across
2062 requests. They will not be ended with curl_easy_cleanup() until
2063 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2064 value will be capped at 1. Defaults to 1.
2067 Maximum size in bytes of the buffer used by smart HTTP
2068 transports when POSTing data to the remote system.
2069 For requests larger than this buffer size, HTTP/1.1 and
2070 Transfer-Encoding: chunked is used to avoid creating a
2071 massive pack file locally. Default is 1 MiB, which is
2072 sufficient for most requests.
2074 http.lowSpeedLimit, http.lowSpeedTime::
2075 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2076 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2077 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2078 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2081 A boolean which disables using of EPSV ftp command by curl.
2082 This can helpful with some "poor" ftp servers which don't
2083 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2084 environment variable. Default is false (curl will use EPSV).
2087 The HTTP USER_AGENT string presented to an HTTP server. The default
2088 value represents the version of the client Git such as git/1.7.1.
2089 This option allows you to override this value to a more common value
2090 such as Mozilla/4.0. This may be necessary, for instance, if
2091 connecting through a firewall that restricts HTTP connections to a set
2092 of common USER_AGENT strings (but not including those like git/1.7.1).
2093 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2095 http.followRedirects::
2096 Whether git should follow HTTP redirects. If set to `true`, git
2097 will transparently follow any redirect issued by a server it
2098 encounters. If set to `false`, git will treat all redirects as
2099 errors. If set to `initial`, git will follow redirects only for
2100 the initial request to a remote, but not for subsequent
2101 follow-up HTTP requests. Since git uses the redirected URL as
2102 the base for the follow-up requests, this is generally
2103 sufficient. The default is `initial`.
2106 Any of the http.* options above can be applied selectively to some URLs.
2107 For a config key to match a URL, each element of the config key is
2108 compared to that of the URL, in the following order:
2111 . Scheme (e.g., `https` in `https://example.com/`). This field
2112 must match exactly between the config key and the URL.
2114 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2115 This field must match between the config key and the URL. It is
2116 possible to specify a `*` as part of the host name to match all subdomains
2117 at this level. `https://*.example.com/` for example would match
2118 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2120 . Port number (e.g., `8080` in `http://example.com:8080/`).
2121 This field must match exactly between the config key and the URL.
2122 Omitted port numbers are automatically converted to the correct
2123 default for the scheme before matching.
2125 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2126 path field of the config key must match the path field of the URL
2127 either exactly or as a prefix of slash-delimited path elements. This means
2128 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2129 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2130 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2131 key with just path `foo/`).
2133 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2134 the config key has a user name it must match the user name in the
2135 URL exactly. If the config key does not have a user name, that
2136 config key will match a URL with any user name (including none),
2137 but at a lower precedence than a config key with a user name.
2140 The list above is ordered by decreasing precedence; a URL that matches
2141 a config key's path is preferred to one that matches its user name. For example,
2142 if the URL is `https://user@example.com/foo/bar` a config key match of
2143 `https://example.com/foo` will be preferred over a config key match of
2144 `https://user@example.com`.
2146 All URLs are normalized before attempting any matching (the password part,
2147 if embedded in the URL, is always ignored for matching purposes) so that
2148 equivalent URLs that are simply spelled differently will match properly.
2149 Environment variable settings always override any matches. The URLs that are
2150 matched against are those given directly to Git commands. This means any URLs
2151 visited as a result of a redirection do not participate in matching.
2154 By default, Git determines the command line arguments to use
2155 based on the basename of the configured SSH command (configured
2156 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2157 the config setting `core.sshCommand`). If the basename is
2158 unrecognized, Git will attempt to detect support of OpenSSH
2159 options by first invoking the configured SSH command with the
2160 `-G` (print configuration) option and will subsequently use
2161 OpenSSH options (if that is successful) or no options besides
2162 the host and remote command (if it fails).
2164 The config variable `ssh.variant` can be set to override this detection.
2165 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2166 `tortoiseplink`, `simple` (no options except the host and remote command).
2167 The default auto-detection can be explicitly requested using the value
2168 `auto`. Any other value is treated as `ssh`. This setting can also be
2169 overridden via the environment variable `GIT_SSH_VARIANT`.
2171 The current command-line parameters used for each variant are as
2176 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2178 * `simple` - [username@]host command
2180 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2182 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2186 Except for the `simple` variant, command-line parameters are likely to
2187 change as git gains new features.
2189 i18n.commitEncoding::
2190 Character encoding the commit messages are stored in; Git itself
2191 does not care per se, but this information is necessary e.g. when
2192 importing commits from emails or in the gitk graphical history
2193 browser (and possibly at other places in the future or in other
2194 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2196 i18n.logOutputEncoding::
2197 Character encoding the commit messages are converted to when
2198 running 'git log' and friends.
2201 The configuration variables in the 'imap' section are described
2202 in linkgit:git-imap-send[1].
2205 Specify the version with which new index files should be
2206 initialized. This does not affect existing repositories.
2209 Specify the directory from which templates will be copied.
2210 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2213 Specify the program that will be used to browse your working
2214 repository in gitweb. See linkgit:git-instaweb[1].
2217 The HTTP daemon command-line to start gitweb on your working
2218 repository. See linkgit:git-instaweb[1].
2221 If true the web server started by linkgit:git-instaweb[1] will
2222 be bound to the local IP (127.0.0.1).
2224 instaweb.modulePath::
2225 The default module path for linkgit:git-instaweb[1] to use
2226 instead of /usr/lib/apache2/modules. Only used if httpd
2230 The port number to bind the gitweb httpd to. See
2231 linkgit:git-instaweb[1].
2233 interactive.singleKey::
2234 In interactive commands, allow the user to provide one-letter
2235 input with a single key (i.e., without hitting enter).
2236 Currently this is used by the `--patch` mode of
2237 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2238 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2239 setting is silently ignored if portable keystroke input
2240 is not available; requires the Perl module Term::ReadKey.
2242 interactive.diffFilter::
2243 When an interactive command (such as `git add --patch`) shows
2244 a colorized diff, git will pipe the diff through the shell
2245 command defined by this configuration variable. The command may
2246 mark up the diff further for human consumption, provided that it
2247 retains a one-to-one correspondence with the lines in the
2248 original diff. Defaults to disabled (no filtering).
2251 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2252 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2253 override this option with `--no-abbrev-commit`.
2256 Set the default date-time mode for the 'log' command.
2257 Setting a value for log.date is similar to using 'git log''s
2258 `--date` option. See linkgit:git-log[1] for details.
2261 Print out the ref names of any commits that are shown by the log
2262 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2263 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2264 specified, the full ref name (including prefix) will be printed.
2265 If 'auto' is specified, then if the output is going to a terminal,
2266 the ref names are shown as if 'short' were given, otherwise no ref
2267 names are shown. This is the same as the `--decorate` option
2271 If `true`, `git log` will act as if the `--follow` option was used when
2272 a single <path> is given. This has the same limitations as `--follow`,
2273 i.e. it cannot be used to follow multiple files and does not work well
2274 on non-linear history.
2277 A list of colors, separated by commas, that can be used to draw
2278 history lines in `git log --graph`.
2281 If true, the initial commit will be shown as a big creation event.
2282 This is equivalent to a diff against an empty tree.
2283 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2284 normally hide the root commit will now show it. True by default.
2287 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2288 linkgit:git-whatchanged[1] assume `--show-signature`.
2291 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2292 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2295 If true, makes linkgit:git-mailinfo[1] (and therefore
2296 linkgit:git-am[1]) act by default as if the --scissors option
2297 was provided on the command-line. When active, this features
2298 removes everything from the message body before a scissors
2299 line (i.e. consisting mainly of ">8", "8<" and "-").
2302 The location of an augmenting mailmap file. The default
2303 mailmap, located in the root of the repository, is loaded
2304 first, then the mailmap file pointed to by this variable.
2305 The location of the mailmap file may be in a repository
2306 subdirectory, or somewhere outside of the repository itself.
2307 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2310 Like `mailmap.file`, but consider the value as a reference to a
2311 blob in the repository. If both `mailmap.file` and
2312 `mailmap.blob` are given, both are parsed, with entries from
2313 `mailmap.file` taking precedence. In a bare repository, this
2314 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2318 Specify the programs that may be used to display help in the
2319 'man' format. See linkgit:git-help[1].
2322 Specify the command to invoke the specified man viewer. The
2323 specified command is evaluated in shell with the man page
2324 passed as argument. (See linkgit:git-help[1].)
2327 Override the path for the given tool that may be used to
2328 display help in the 'man' format. See linkgit:git-help[1].
2330 include::merge-config.txt[]
2332 mergetool.<tool>.path::
2333 Override the path for the given tool. This is useful in case
2334 your tool is not in the PATH.
2336 mergetool.<tool>.cmd::
2337 Specify the command to invoke the specified merge tool. The
2338 specified command is evaluated in shell with the following
2339 variables available: 'BASE' is the name of a temporary file
2340 containing the common base of the files to be merged, if available;
2341 'LOCAL' is the name of a temporary file containing the contents of
2342 the file on the current branch; 'REMOTE' is the name of a temporary
2343 file containing the contents of the file from the branch being
2344 merged; 'MERGED' contains the name of the file to which the merge
2345 tool should write the results of a successful merge.
2347 mergetool.<tool>.trustExitCode::
2348 For a custom merge command, specify whether the exit code of
2349 the merge command can be used to determine whether the merge was
2350 successful. If this is not set to true then the merge target file
2351 timestamp is checked and the merge assumed to have been successful
2352 if the file has been updated, otherwise the user is prompted to
2353 indicate the success of the merge.
2355 mergetool.meld.hasOutput::
2356 Older versions of `meld` do not support the `--output` option.
2357 Git will attempt to detect whether `meld` supports `--output`
2358 by inspecting the output of `meld --help`. Configuring
2359 `mergetool.meld.hasOutput` will make Git skip these checks and
2360 use the configured value instead. Setting `mergetool.meld.hasOutput`
2361 to `true` tells Git to unconditionally use the `--output` option,
2362 and `false` avoids using `--output`.
2364 mergetool.keepBackup::
2365 After performing a merge, the original file with conflict markers
2366 can be saved as a file with a `.orig` extension. If this variable
2367 is set to `false` then this file is not preserved. Defaults to
2368 `true` (i.e. keep the backup files).
2370 mergetool.keepTemporaries::
2371 When invoking a custom merge tool, Git uses a set of temporary
2372 files to pass to the tool. If the tool returns an error and this
2373 variable is set to `true`, then these temporary files will be
2374 preserved, otherwise they will be removed after the tool has
2375 exited. Defaults to `false`.
2377 mergetool.writeToTemp::
2378 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2379 conflicting files in the worktree by default. Git will attempt
2380 to use a temporary directory for these files when set `true`.
2381 Defaults to `false`.
2384 Prompt before each invocation of the merge resolution program.
2386 notes.mergeStrategy::
2387 Which merge strategy to choose by default when resolving notes
2388 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2389 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2390 section of linkgit:git-notes[1] for more information on each strategy.
2392 notes.<name>.mergeStrategy::
2393 Which merge strategy to choose when doing a notes merge into
2394 refs/notes/<name>. This overrides the more general
2395 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2396 linkgit:git-notes[1] for more information on the available strategies.
2399 The (fully qualified) refname from which to show notes when
2400 showing commit messages. The value of this variable can be set
2401 to a glob, in which case notes from all matching refs will be
2402 shown. You may also specify this configuration variable
2403 several times. A warning will be issued for refs that do not
2404 exist, but a glob that does not match any refs is silently
2407 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2408 environment variable, which must be a colon separated list of refs or
2411 The effective value of "core.notesRef" (possibly overridden by
2412 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2415 notes.rewrite.<command>::
2416 When rewriting commits with <command> (currently `amend` or
2417 `rebase`) and this variable is set to `true`, Git
2418 automatically copies your notes from the original to the
2419 rewritten commit. Defaults to `true`, but see
2420 "notes.rewriteRef" below.
2423 When copying notes during a rewrite (see the
2424 "notes.rewrite.<command>" option), determines what to do if
2425 the target commit already has a note. Must be one of
2426 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2427 Defaults to `concatenate`.
2429 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2430 environment variable.
2433 When copying notes during a rewrite, specifies the (fully
2434 qualified) ref whose notes should be copied. The ref may be a
2435 glob, in which case notes in all matching refs will be copied.
2436 You may also specify this configuration several times.
2438 Does not have a default value; you must configure this variable to
2439 enable note rewriting. Set it to `refs/notes/commits` to enable
2440 rewriting for the default commit notes.
2442 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2443 environment variable, which must be a colon separated list of refs or
2447 The size of the window used by linkgit:git-pack-objects[1] when no
2448 window size is given on the command line. Defaults to 10.
2451 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2452 maximum depth is given on the command line. Defaults to 50.
2455 The maximum size of memory that is consumed by each thread
2456 in linkgit:git-pack-objects[1] for pack window memory when
2457 no limit is given on the command line. The value can be
2458 suffixed with "k", "m", or "g". When left unconfigured (or
2459 set explicitly to 0), there will be no limit.
2462 An integer -1..9, indicating the compression level for objects
2463 in a pack file. -1 is the zlib default. 0 means no
2464 compression, and 1..9 are various speed/size tradeoffs, 9 being
2465 slowest. If not set, defaults to core.compression. If that is
2466 not set, defaults to -1, the zlib default, which is "a default
2467 compromise between speed and compression (currently equivalent
2470 Note that changing the compression level will not automatically recompress
2471 all existing objects. You can force recompression by passing the -F option
2472 to linkgit:git-repack[1].
2474 pack.deltaCacheSize::
2475 The maximum memory in bytes used for caching deltas in
2476 linkgit:git-pack-objects[1] before writing them out to a pack.
2477 This cache is used to speed up the writing object phase by not
2478 having to recompute the final delta result once the best match
2479 for all objects is found. Repacking large repositories on machines
2480 which are tight with memory might be badly impacted by this though,
2481 especially if this cache pushes the system into swapping.
2482 A value of 0 means no limit. The smallest size of 1 byte may be
2483 used to virtually disable this cache. Defaults to 256 MiB.
2485 pack.deltaCacheLimit::
2486 The maximum size of a delta, that is cached in
2487 linkgit:git-pack-objects[1]. This cache is used to speed up the
2488 writing object phase by not having to recompute the final delta
2489 result once the best match for all objects is found. Defaults to 1000.
2492 Specifies the number of threads to spawn when searching for best
2493 delta matches. This requires that linkgit:git-pack-objects[1]
2494 be compiled with pthreads otherwise this option is ignored with a
2495 warning. This is meant to reduce packing time on multiprocessor
2496 machines. The required amount of memory for the delta search window
2497 is however multiplied by the number of threads.
2498 Specifying 0 will cause Git to auto-detect the number of CPU's
2499 and set the number of threads accordingly.
2502 Specify the default pack index version. Valid values are 1 for
2503 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2504 the new pack index with capabilities for packs larger than 4 GB
2505 as well as proper protection against the repacking of corrupted
2506 packs. Version 2 is the default. Note that version 2 is enforced
2507 and this config option ignored whenever the corresponding pack is
2510 If you have an old Git that does not understand the version 2 `*.idx` file,
2511 cloning or fetching over a non native protocol (e.g. "http")
2512 that will copy both `*.pack` file and corresponding `*.idx` file from the
2513 other side may give you a repository that cannot be accessed with your
2514 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2515 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2518 pack.packSizeLimit::
2519 The maximum size of a pack. This setting only affects
2520 packing to a file when repacking, i.e. the git:// protocol
2521 is unaffected. It can be overridden by the `--max-pack-size`
2522 option of linkgit:git-repack[1]. Reaching this limit results
2523 in the creation of multiple packfiles; which in turn prevents
2524 bitmaps from being created.
2525 The minimum size allowed is limited to 1 MiB.
2526 The default is unlimited.
2527 Common unit suffixes of 'k', 'm', or 'g' are
2531 When true, git will use pack bitmaps (if available) when packing
2532 to stdout (e.g., during the server side of a fetch). Defaults to
2533 true. You should not generally need to turn this off unless
2534 you are debugging pack bitmaps.
2536 pack.writeBitmaps (deprecated)::
2537 This is a deprecated synonym for `repack.writeBitmaps`.
2539 pack.writeBitmapHashCache::
2540 When true, git will include a "hash cache" section in the bitmap
2541 index (if one is written). This cache can be used to feed git's
2542 delta heuristics, potentially leading to better deltas between
2543 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2544 between an older, bitmapped pack and objects that have been
2545 pushed since the last gc). The downside is that it consumes 4
2546 bytes per object of disk space, and that JGit's bitmap
2547 implementation does not understand it, causing it to complain if
2548 Git and JGit are used on the same repository. Defaults to false.
2551 If the value is boolean, turns on or off pagination of the
2552 output of a particular Git subcommand when writing to a tty.
2553 Otherwise, turns on pagination for the subcommand using the
2554 pager specified by the value of `pager.<cmd>`. If `--paginate`
2555 or `--no-pager` is specified on the command line, it takes
2556 precedence over this option. To disable pagination for all
2557 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2560 Alias for a --pretty= format string, as specified in
2561 linkgit:git-log[1]. Any aliases defined here can be used just
2562 as the built-in pretty formats could. For example,
2563 running `git config pretty.changelog "format:* %H %s"`
2564 would cause the invocation `git log --pretty=changelog`
2565 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2566 Note that an alias with the same name as a built-in format
2567 will be silently ignored.
2570 If set, provide a user defined default policy for all protocols which
2571 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2572 if unset, known-safe protocols (http, https, git, ssh, file) have a
2573 default policy of `always`, known-dangerous protocols (ext) have a
2574 default policy of `never`, and all other protocols have a default
2575 policy of `user`. Supported policies:
2579 * `always` - protocol is always able to be used.
2581 * `never` - protocol is never able to be used.
2583 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2584 either unset or has a value of 1. This policy should be used when you want a
2585 protocol to be directly usable by the user but don't want it used by commands which
2586 execute clone/fetch/push commands without user input, e.g. recursive
2587 submodule initialization.
2591 protocol.<name>.allow::
2592 Set a policy to be used by protocol `<name>` with clone/fetch/push
2593 commands. See `protocol.allow` above for the available policies.
2595 The protocol names currently used by git are:
2598 - `file`: any local file-based path (including `file://` URLs,
2601 - `git`: the anonymous git protocol over a direct TCP
2602 connection (or proxy, if configured)
2604 - `ssh`: git over ssh (including `host:path` syntax,
2607 - `http`: git over http, both "smart http" and "dumb http".
2608 Note that this does _not_ include `https`; if you want to configure
2609 both, you must do so individually.
2611 - any external helpers are named by their protocol (e.g., use
2612 `hg` to allow the `git-remote-hg` helper)
2616 Experimental. If set, clients will attempt to communicate with a
2617 server using the specified protocol version. If unset, no
2618 attempt will be made by the client to communicate using a
2619 particular protocol version, this results in protocol version 0
2625 * `0` - the original wire protocol.
2627 * `1` - the original wire protocol with the addition of a version string
2628 in the initial response from the server.
2633 By default, Git does not create an extra merge commit when merging
2634 a commit that is a descendant of the current commit. Instead, the
2635 tip of the current branch is fast-forwarded. When set to `false`,
2636 this variable tells Git to create an extra merge commit in such
2637 a case (equivalent to giving the `--no-ff` option from the command
2638 line). When set to `only`, only such fast-forward merges are
2639 allowed (equivalent to giving the `--ff-only` option from the
2640 command line). This setting overrides `merge.ff` when pulling.
2643 When true, rebase branches on top of the fetched branch, instead
2644 of merging the default branch from the default remote when "git
2645 pull" is run. See "branch.<name>.rebase" for setting this on a
2648 When preserve, also pass `--preserve-merges` along to 'git rebase'
2649 so that locally committed merge commits will not be flattened
2650 by running 'git pull'.
2652 When the value is `interactive`, the rebase is run in interactive mode.
2654 *NOTE*: this is a possibly dangerous operation; do *not* use
2655 it unless you understand the implications (see linkgit:git-rebase[1]
2659 The default merge strategy to use when pulling multiple branches
2663 The default merge strategy to use when pulling a single branch.
2666 Defines the action `git push` should take if no refspec is
2667 explicitly given. Different values are well-suited for
2668 specific workflows; for instance, in a purely central workflow
2669 (i.e. the fetch source is equal to the push destination),
2670 `upstream` is probably what you want. Possible values are:
2674 * `nothing` - do not push anything (error out) unless a refspec is
2675 explicitly given. This is primarily meant for people who want to
2676 avoid mistakes by always being explicit.
2678 * `current` - push the current branch to update a branch with the same
2679 name on the receiving end. Works in both central and non-central
2682 * `upstream` - push the current branch back to the branch whose
2683 changes are usually integrated into the current branch (which is
2684 called `@{upstream}`). This mode only makes sense if you are
2685 pushing to the same repository you would normally pull from
2686 (i.e. central workflow).
2688 * `tracking` - This is a deprecated synonym for `upstream`.
2690 * `simple` - in centralized workflow, work like `upstream` with an
2691 added safety to refuse to push if the upstream branch's name is
2692 different from the local one.
2694 When pushing to a remote that is different from the remote you normally
2695 pull from, work as `current`. This is the safest option and is suited
2698 This mode has become the default in Git 2.0.
2700 * `matching` - push all branches having the same name on both ends.
2701 This makes the repository you are pushing to remember the set of
2702 branches that will be pushed out (e.g. if you always push 'maint'
2703 and 'master' there and no other branches, the repository you push
2704 to will have these two branches, and your local 'maint' and
2705 'master' will be pushed there).
2707 To use this mode effectively, you have to make sure _all_ the
2708 branches you would push out are ready to be pushed out before
2709 running 'git push', as the whole point of this mode is to allow you
2710 to push all of the branches in one go. If you usually finish work
2711 on only one branch and push out the result, while other branches are
2712 unfinished, this mode is not for you. Also this mode is not
2713 suitable for pushing into a shared central repository, as other
2714 people may add new branches there, or update the tip of existing
2715 branches outside your control.
2717 This used to be the default, but not since Git 2.0 (`simple` is the
2723 If set to true enable `--follow-tags` option by default. You
2724 may override this configuration at time of push by specifying
2728 May be set to a boolean value, or the string 'if-asked'. A true
2729 value causes all pushes to be GPG signed, as if `--signed` is
2730 passed to linkgit:git-push[1]. The string 'if-asked' causes
2731 pushes to be signed if the server supports it, as if
2732 `--signed=if-asked` is passed to 'git push'. A false value may
2733 override a value from a lower-priority config file. An explicit
2734 command-line flag always overrides this config option.
2737 When no `--push-option=<option>` argument is given from the
2738 command line, `git push` behaves as if each <value> of
2739 this variable is given as `--push-option=<value>`.
2741 This is a multi-valued variable, and an empty value can be used in a
2742 higher priority configuration file (e.g. `.git/config` in a
2743 repository) to clear the values inherited from a lower priority
2744 configuration files (e.g. `$HOME/.gitconfig`).
2761 This will result in only b (a and c are cleared).
2765 push.recurseSubmodules::
2766 Make sure all submodule commits used by the revisions to be pushed
2767 are available on a remote-tracking branch. If the value is 'check'
2768 then Git will verify that all submodule commits that changed in the
2769 revisions to be pushed are available on at least one remote of the
2770 submodule. If any commits are missing, the push will be aborted and
2771 exit with non-zero status. If the value is 'on-demand' then all
2772 submodules that changed in the revisions to be pushed will be
2773 pushed. If on-demand was not able to push all necessary revisions
2774 it will also be aborted and exit with non-zero status. If the value
2775 is 'no' then default behavior of ignoring submodules when pushing
2776 is retained. You may override this configuration at time of push by
2777 specifying '--recurse-submodules=check|on-demand|no'.
2779 include::rebase-config.txt[]
2781 receive.advertiseAtomic::
2782 By default, git-receive-pack will advertise the atomic push
2783 capability to its clients. If you don't want to advertise this
2784 capability, set this variable to false.
2786 receive.advertisePushOptions::
2787 When set to true, git-receive-pack will advertise the push options
2788 capability to its clients. False by default.
2791 By default, git-receive-pack will run "git-gc --auto" after
2792 receiving data from git-push and updating refs. You can stop
2793 it by setting this variable to false.
2795 receive.certNonceSeed::
2796 By setting this variable to a string, `git receive-pack`
2797 will accept a `git push --signed` and verifies it by using
2798 a "nonce" protected by HMAC using this string as a secret
2801 receive.certNonceSlop::
2802 When a `git push --signed` sent a push certificate with a
2803 "nonce" that was issued by a receive-pack serving the same
2804 repository within this many seconds, export the "nonce"
2805 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2806 hooks (instead of what the receive-pack asked the sending
2807 side to include). This may allow writing checks in
2808 `pre-receive` and `post-receive` a bit easier. Instead of
2809 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2810 that records by how many seconds the nonce is stale to
2811 decide if they want to accept the certificate, they only
2812 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2814 receive.fsckObjects::
2815 If it is set to true, git-receive-pack will check all received
2816 objects. It will abort in the case of a malformed object or a
2817 broken link. The result of an abort are only dangling objects.
2818 Defaults to false. If not set, the value of `transfer.fsckObjects`
2821 receive.fsck.<msg-id>::
2822 When `receive.fsckObjects` is set to true, errors can be switched
2823 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2824 setting where the `<msg-id>` is the fsck message ID and the value
2825 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2826 the error/warning with the message ID, e.g. "missingEmail: invalid
2827 author/committer line - missing email" means that setting
2828 `receive.fsck.missingEmail = ignore` will hide that issue.
2830 This feature is intended to support working with legacy repositories
2831 which would not pass pushing when `receive.fsckObjects = true`, allowing
2832 the host to accept repositories with certain known issues but still catch
2835 receive.fsck.skipList::
2836 The path to a sorted list of object names (i.e. one SHA-1 per
2837 line) that are known to be broken in a non-fatal way and should
2838 be ignored. This feature is useful when an established project
2839 should be accepted despite early commits containing errors that
2840 can be safely ignored such as invalid committer email addresses.
2841 Note: corrupt objects cannot be skipped with this setting.
2844 After receiving the pack from the client, `receive-pack` may
2845 produce no output (if `--quiet` was specified) while processing
2846 the pack, causing some networks to drop the TCP connection.
2847 With this option set, if `receive-pack` does not transmit
2848 any data in this phase for `receive.keepAlive` seconds, it will
2849 send a short keepalive packet. The default is 5 seconds; set
2850 to 0 to disable keepalives entirely.
2852 receive.unpackLimit::
2853 If the number of objects received in a push is below this
2854 limit then the objects will be unpacked into loose object
2855 files. However if the number of received objects equals or
2856 exceeds this limit then the received pack will be stored as
2857 a pack, after adding any missing delta bases. Storing the
2858 pack from a push can make the push operation complete faster,
2859 especially on slow filesystems. If not set, the value of
2860 `transfer.unpackLimit` is used instead.
2862 receive.maxInputSize::
2863 If the size of the incoming pack stream is larger than this
2864 limit, then git-receive-pack will error out, instead of
2865 accepting the pack file. If not set or set to 0, then the size
2868 receive.denyDeletes::
2869 If set to true, git-receive-pack will deny a ref update that deletes
2870 the ref. Use this to prevent such a ref deletion via a push.
2872 receive.denyDeleteCurrent::
2873 If set to true, git-receive-pack will deny a ref update that
2874 deletes the currently checked out branch of a non-bare repository.
2876 receive.denyCurrentBranch::
2877 If set to true or "refuse", git-receive-pack will deny a ref update
2878 to the currently checked out branch of a non-bare repository.
2879 Such a push is potentially dangerous because it brings the HEAD
2880 out of sync with the index and working tree. If set to "warn",
2881 print a warning of such a push to stderr, but allow the push to
2882 proceed. If set to false or "ignore", allow such pushes with no
2883 message. Defaults to "refuse".
2885 Another option is "updateInstead" which will update the working
2886 tree if pushing into the current branch. This option is
2887 intended for synchronizing working directories when one side is not easily
2888 accessible via interactive ssh (e.g. a live web site, hence the requirement
2889 that the working directory be clean). This mode also comes in handy when
2890 developing inside a VM to test and fix code on different Operating Systems.
2892 By default, "updateInstead" will refuse the push if the working tree or
2893 the index have any difference from the HEAD, but the `push-to-checkout`
2894 hook can be used to customize this. See linkgit:githooks[5].
2896 receive.denyNonFastForwards::
2897 If set to true, git-receive-pack will deny a ref update which is
2898 not a fast-forward. Use this to prevent such an update via a push,
2899 even if that push is forced. This configuration variable is
2900 set when initializing a shared repository.
2903 This variable is the same as `transfer.hideRefs`, but applies
2904 only to `receive-pack` (and so affects pushes, but not fetches).
2905 An attempt to update or delete a hidden ref by `git push` is
2908 receive.updateServerInfo::
2909 If set to true, git-receive-pack will run git-update-server-info
2910 after receiving data from git-push and updating refs.
2912 receive.shallowUpdate::
2913 If set to true, .git/shallow can be updated when new refs
2914 require new shallow roots. Otherwise those refs are rejected.
2916 remote.pushDefault::
2917 The remote to push to by default. Overrides
2918 `branch.<name>.remote` for all branches, and is overridden by
2919 `branch.<name>.pushRemote` for specific branches.
2922 The URL of a remote repository. See linkgit:git-fetch[1] or
2923 linkgit:git-push[1].
2925 remote.<name>.pushurl::
2926 The push URL of a remote repository. See linkgit:git-push[1].
2928 remote.<name>.proxy::
2929 For remotes that require curl (http, https and ftp), the URL to
2930 the proxy to use for that remote. Set to the empty string to
2931 disable proxying for that remote.
2933 remote.<name>.proxyAuthMethod::
2934 For remotes that require curl (http, https and ftp), the method to use for
2935 authenticating against the proxy in use (probably set in
2936 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2938 remote.<name>.fetch::
2939 The default set of "refspec" for linkgit:git-fetch[1]. See
2940 linkgit:git-fetch[1].
2942 remote.<name>.push::
2943 The default set of "refspec" for linkgit:git-push[1]. See
2944 linkgit:git-push[1].
2946 remote.<name>.mirror::
2947 If true, pushing to this remote will automatically behave
2948 as if the `--mirror` option was given on the command line.
2950 remote.<name>.skipDefaultUpdate::
2951 If true, this remote will be skipped by default when updating
2952 using linkgit:git-fetch[1] or the `update` subcommand of
2953 linkgit:git-remote[1].
2955 remote.<name>.skipFetchAll::
2956 If true, this remote will be skipped by default when updating
2957 using linkgit:git-fetch[1] or the `update` subcommand of
2958 linkgit:git-remote[1].
2960 remote.<name>.receivepack::
2961 The default program to execute on the remote side when pushing. See
2962 option --receive-pack of linkgit:git-push[1].
2964 remote.<name>.uploadpack::
2965 The default program to execute on the remote side when fetching. See
2966 option --upload-pack of linkgit:git-fetch-pack[1].
2968 remote.<name>.tagOpt::
2969 Setting this value to --no-tags disables automatic tag following when
2970 fetching from remote <name>. Setting it to --tags will fetch every
2971 tag from remote <name>, even if they are not reachable from remote
2972 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2973 override this setting. See options --tags and --no-tags of
2974 linkgit:git-fetch[1].
2977 Setting this to a value <vcs> will cause Git to interact with
2978 the remote with the git-remote-<vcs> helper.
2980 remote.<name>.prune::
2981 When set to true, fetching from this remote by default will also
2982 remove any remote-tracking references that no longer exist on the
2983 remote (as if the `--prune` option was given on the command line).
2984 Overrides `fetch.prune` settings, if any.
2986 remote.<name>.pruneTags::
2987 When set to true, fetching from this remote by default will also
2988 remove any local tags that no longer exist on the remote if pruning
2989 is activated in general via `remote.<name>.prune`, `fetch.prune` or
2990 `--prune`. Overrides `fetch.pruneTags` settings, if any.
2992 See also `remote.<name>.prune` and the PRUNING section of
2993 linkgit:git-fetch[1].
2996 The list of remotes which are fetched by "git remote update
2997 <group>". See linkgit:git-remote[1].
2999 repack.useDeltaBaseOffset::
3000 By default, linkgit:git-repack[1] creates packs that use
3001 delta-base offset. If you need to share your repository with
3002 Git older than version 1.4.4, either directly or via a dumb
3003 protocol such as http, then you need to set this option to
3004 "false" and repack. Access from old Git versions over the
3005 native protocol are unaffected by this option.
3007 repack.packKeptObjects::
3008 If set to true, makes `git repack` act as if
3009 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3010 details. Defaults to `false` normally, but `true` if a bitmap
3011 index is being written (either via `--write-bitmap-index` or
3012 `repack.writeBitmaps`).
3014 repack.writeBitmaps::
3015 When true, git will write a bitmap index when packing all
3016 objects to disk (e.g., when `git repack -a` is run). This
3017 index can speed up the "counting objects" phase of subsequent
3018 packs created for clones and fetches, at the cost of some disk
3019 space and extra time spent on the initial repack. This has
3020 no effect if multiple packfiles are created.
3024 When set to true, `git-rerere` updates the index with the
3025 resulting contents after it cleanly resolves conflicts using
3026 previously recorded resolution. Defaults to false.
3029 Activate recording of resolved conflicts, so that identical
3030 conflict hunks can be resolved automatically, should they be
3031 encountered again. By default, linkgit:git-rerere[1] is
3032 enabled if there is an `rr-cache` directory under the
3033 `$GIT_DIR`, e.g. if "rerere" was previously used in the
3036 sendemail.identity::
3037 A configuration identity. When given, causes values in the
3038 'sendemail.<identity>' subsection to take precedence over
3039 values in the 'sendemail' section. The default identity is
3040 the value of `sendemail.identity`.
3042 sendemail.smtpEncryption::
3043 See linkgit:git-send-email[1] for description. Note that this
3044 setting is not subject to the 'identity' mechanism.
3046 sendemail.smtpssl (deprecated)::
3047 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3049 sendemail.smtpsslcertpath::
3050 Path to ca-certificates (either a directory or a single file).
3051 Set it to an empty string to disable certificate verification.
3053 sendemail.<identity>.*::
3054 Identity-specific versions of the 'sendemail.*' parameters
3055 found below, taking precedence over those when this
3056 identity is selected, through either the command-line or
3057 `sendemail.identity`.
3059 sendemail.aliasesFile::
3060 sendemail.aliasFileType::
3061 sendemail.annotate::
3065 sendemail.chainReplyTo::
3067 sendemail.envelopeSender::
3069 sendemail.multiEdit::
3070 sendemail.signedoffbycc::
3071 sendemail.smtpPass::
3072 sendemail.suppresscc::
3073 sendemail.suppressFrom::
3076 sendemail.smtpDomain::
3077 sendemail.smtpServer::
3078 sendemail.smtpServerPort::
3079 sendemail.smtpServerOption::
3080 sendemail.smtpUser::
3082 sendemail.transferEncoding::
3083 sendemail.validate::
3085 See linkgit:git-send-email[1] for description.
3087 sendemail.signedoffcc (deprecated)::
3088 Deprecated alias for `sendemail.signedoffbycc`.
3090 sendemail.smtpBatchSize::
3091 Number of messages to be sent per connection, after that a relogin
3092 will happen. If the value is 0 or undefined, send all messages in
3094 See also the `--batch-size` option of linkgit:git-send-email[1].
3096 sendemail.smtpReloginDelay::
3097 Seconds wait before reconnecting to smtp server.
3098 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3100 showbranch.default::
3101 The default set of branches for linkgit:git-show-branch[1].
3102 See linkgit:git-show-branch[1].
3104 splitIndex.maxPercentChange::
3105 When the split index feature is used, this specifies the
3106 percent of entries the split index can contain compared to the
3107 total number of entries in both the split index and the shared
3108 index before a new shared index is written.
3109 The value should be between 0 and 100. If the value is 0 then
3110 a new shared index is always written, if it is 100 a new
3111 shared index is never written.
3112 By default the value is 20, so a new shared index is written
3113 if the number of entries in the split index would be greater
3114 than 20 percent of the total number of entries.
3115 See linkgit:git-update-index[1].
3117 splitIndex.sharedIndexExpire::
3118 When the split index feature is used, shared index files that
3119 were not modified since the time this variable specifies will
3120 be removed when a new shared index file is created. The value
3121 "now" expires all entries immediately, and "never" suppresses
3122 expiration altogether.
3123 The default value is "2.weeks.ago".
3124 Note that a shared index file is considered modified (for the
3125 purpose of expiration) each time a new split-index file is
3126 either created based on it or read from it.
3127 See linkgit:git-update-index[1].
3129 status.relativePaths::
3130 By default, linkgit:git-status[1] shows paths relative to the
3131 current directory. Setting this variable to `false` shows paths
3132 relative to the repository root (this was the default for Git
3136 Set to true to enable --short by default in linkgit:git-status[1].
3137 The option --no-short takes precedence over this variable.
3140 Set to true to enable --branch by default in linkgit:git-status[1].
3141 The option --no-branch takes precedence over this variable.
3143 status.displayCommentPrefix::
3144 If set to true, linkgit:git-status[1] will insert a comment
3145 prefix before each output line (starting with
3146 `core.commentChar`, i.e. `#` by default). This was the
3147 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3151 If set to true, linkgit:git-status[1] will display the number of
3152 entries currently stashed away.
3155 status.showUntrackedFiles::
3156 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3157 files which are not currently tracked by Git. Directories which
3158 contain only untracked files, are shown with the directory name
3159 only. Showing untracked files means that Git needs to lstat() all
3160 the files in the whole repository, which might be slow on some
3161 systems. So, this variable controls how the commands displays
3162 the untracked files. Possible values are:
3165 * `no` - Show no untracked files.
3166 * `normal` - Show untracked files and directories.
3167 * `all` - Show also individual files in untracked directories.
3170 If this variable is not specified, it defaults to 'normal'.
3171 This variable can be overridden with the -u|--untracked-files option
3172 of linkgit:git-status[1] and linkgit:git-commit[1].
3174 status.submoduleSummary::
3176 If this is set to a non zero number or true (identical to -1 or an
3177 unlimited number), the submodule summary will be enabled and a
3178 summary of commits for modified submodules will be shown (see
3179 --summary-limit option of linkgit:git-submodule[1]). Please note
3180 that the summary output command will be suppressed for all
3181 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3182 for those submodules where `submodule.<name>.ignore=all`. The only
3183 exception to that rule is that status and commit will show staged
3184 submodule changes. To
3185 also view the summary for ignored submodules you can either use
3186 the --ignore-submodules=dirty command-line option or the 'git
3187 submodule summary' command, which shows a similar output but does
3188 not honor these settings.
3191 If this is set to true, the `git stash show` command without an
3192 option will show the stash entry in patch form. Defaults to false.
3193 See description of 'show' command in linkgit:git-stash[1].
3196 If this is set to true, the `git stash show` command without an
3197 option will show diffstat of the stash entry. Defaults to true.
3198 See description of 'show' command in linkgit:git-stash[1].
3200 submodule.<name>.url::
3201 The URL for a submodule. This variable is copied from the .gitmodules
3202 file to the git config via 'git submodule init'. The user can change
3203 the configured URL before obtaining the submodule via 'git submodule
3204 update'. If neither submodule.<name>.active or submodule.active are
3205 set, the presence of this variable is used as a fallback to indicate
3206 whether the submodule is of interest to git commands.
3207 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3209 submodule.<name>.update::
3210 The method by which a submodule is updated by 'git submodule update',
3211 which is the only affected command, others such as
3212 'git checkout --recurse-submodules' are unaffected. It exists for
3213 historical reasons, when 'git submodule' was the only command to
3214 interact with submodules; settings like `submodule.active`
3215 and `pull.rebase` are more specific. It is populated by
3216 `git submodule init` from the linkgit:gitmodules[5] file.
3217 See description of 'update' command in linkgit:git-submodule[1].
3219 submodule.<name>.branch::
3220 The remote branch name for a submodule, used by `git submodule
3221 update --remote`. Set this option to override the value found in
3222 the `.gitmodules` file. See linkgit:git-submodule[1] and
3223 linkgit:gitmodules[5] for details.
3225 submodule.<name>.fetchRecurseSubmodules::
3226 This option can be used to control recursive fetching of this
3227 submodule. It can be overridden by using the --[no-]recurse-submodules
3228 command-line option to "git fetch" and "git pull".
3229 This setting will override that from in the linkgit:gitmodules[5]
3232 submodule.<name>.ignore::
3233 Defines under what circumstances "git status" and the diff family show
3234 a submodule as modified. When set to "all", it will never be considered
3235 modified (but it will nonetheless show up in the output of status and
3236 commit when it has been staged), "dirty" will ignore all changes
3237 to the submodules work tree and
3238 takes only differences between the HEAD of the submodule and the commit
3239 recorded in the superproject into account. "untracked" will additionally
3240 let submodules with modified tracked files in their work tree show up.
3241 Using "none" (the default when this option is not set) also shows
3242 submodules that have untracked files in their work tree as changed.
3243 This setting overrides any setting made in .gitmodules for this submodule,
3244 both settings can be overridden on the command line by using the
3245 "--ignore-submodules" option. The 'git submodule' commands are not
3246 affected by this setting.
3248 submodule.<name>.active::
3249 Boolean value indicating if the submodule is of interest to git
3250 commands. This config option takes precedence over the
3251 submodule.active config option.
3254 A repeated field which contains a pathspec used to match against a
3255 submodule's path to determine if the submodule is of interest to git
3259 Specifies if commands recurse into submodules by default. This
3260 applies to all commands that have a `--recurse-submodules` option,
3264 submodule.fetchJobs::
3265 Specifies how many submodules are fetched/cloned at the same time.
3266 A positive integer allows up to that number of submodules fetched
3267 in parallel. A value of 0 will give some reasonable default.
3268 If unset, it defaults to 1.
3270 submodule.alternateLocation::
3271 Specifies how the submodules obtain alternates when submodules are
3272 cloned. Possible values are `no`, `superproject`.
3273 By default `no` is assumed, which doesn't add references. When the
3274 value is set to `superproject` the submodule to be cloned computes
3275 its alternates location relative to the superprojects alternate.
3277 submodule.alternateErrorStrategy::
3278 Specifies how to treat errors with the alternates for a submodule
3279 as computed via `submodule.alternateLocation`. Possible values are
3280 `ignore`, `info`, `die`. Default is `die`.
3282 tag.forceSignAnnotated::
3283 A boolean to specify whether annotated tags created should be GPG signed.
3284 If `--annotate` is specified on the command line, it takes
3285 precedence over this option.
3288 This variable controls the sort ordering of tags when displayed by
3289 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3290 value of this variable will be used as the default.
3293 This variable can be used to restrict the permission bits of
3294 tar archive entries. The default is 0002, which turns off the
3295 world write bit. The special value "user" indicates that the
3296 archiving user's umask will be used instead. See umask(2) and
3297 linkgit:git-archive[1].
3299 transfer.fsckObjects::
3300 When `fetch.fsckObjects` or `receive.fsckObjects` are
3301 not set, the value of this variable is used instead.
3305 String(s) `receive-pack` and `upload-pack` use to decide which
3306 refs to omit from their initial advertisements. Use more than
3307 one definition to specify multiple prefix strings. A ref that is
3308 under the hierarchies listed in the value of this variable is
3309 excluded, and is hidden when responding to `git push` or `git
3310 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3311 program-specific versions of this config.
3313 You may also include a `!` in front of the ref name to negate the entry,
3314 explicitly exposing it, even if an earlier entry marked it as hidden.
3315 If you have multiple hideRefs values, later entries override earlier ones
3316 (and entries in more-specific config files override less-specific ones).
3318 If a namespace is in use, the namespace prefix is stripped from each
3319 reference before it is matched against `transfer.hiderefs` patterns.
3320 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3321 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3322 is omitted from the advertisements but `refs/heads/master` and
3323 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3324 "have" lines. In order to match refs before stripping, add a `^` in front of
3325 the ref name. If you combine `!` and `^`, `!` must be specified first.
3327 Even if you hide refs, a client may still be able to steal the target
3328 objects via the techniques described in the "SECURITY" section of the
3329 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3330 separate repository.
3332 transfer.unpackLimit::
3333 When `fetch.unpackLimit` or `receive.unpackLimit` are
3334 not set, the value of this variable is used instead.
3335 The default value is 100.
3337 uploadarchive.allowUnreachable::
3338 If true, allow clients to use `git archive --remote` to request
3339 any tree, whether reachable from the ref tips or not. See the
3340 discussion in the "SECURITY" section of
3341 linkgit:git-upload-archive[1] for more details. Defaults to
3344 uploadpack.hideRefs::
3345 This variable is the same as `transfer.hideRefs`, but applies
3346 only to `upload-pack` (and so affects only fetches, not pushes).
3347 An attempt to fetch a hidden ref by `git fetch` will fail. See
3348 also `uploadpack.allowTipSHA1InWant`.
3350 uploadpack.allowTipSHA1InWant::
3351 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3352 to accept a fetch request that asks for an object at the tip
3353 of a hidden ref (by default, such a request is rejected).
3354 See also `uploadpack.hideRefs`. Even if this is false, a client
3355 may be able to steal objects via the techniques described in the
3356 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3357 best to keep private data in a separate repository.
3359 uploadpack.allowReachableSHA1InWant::
3360 Allow `upload-pack` to accept a fetch request that asks for an
3361 object that is reachable from any ref tip. However, note that
3362 calculating object reachability is computationally expensive.
3363 Defaults to `false`. Even if this is false, a client may be able
3364 to steal objects via the techniques described in the "SECURITY"
3365 section of the linkgit:gitnamespaces[7] man page; it's best to
3366 keep private data in a separate repository.
3368 uploadpack.allowAnySHA1InWant::
3369 Allow `upload-pack` to accept a fetch request that asks for any
3371 Defaults to `false`.
3373 uploadpack.keepAlive::
3374 When `upload-pack` has started `pack-objects`, there may be a
3375 quiet period while `pack-objects` prepares the pack. Normally
3376 it would output progress information, but if `--quiet` was used
3377 for the fetch, `pack-objects` will output nothing at all until
3378 the pack data begins. Some clients and networks may consider
3379 the server to be hung and give up. Setting this option instructs
3380 `upload-pack` to send an empty keepalive packet every
3381 `uploadpack.keepAlive` seconds. Setting this option to 0
3382 disables keepalive packets entirely. The default is 5 seconds.
3384 uploadpack.packObjectsHook::
3385 If this option is set, when `upload-pack` would run
3386 `git pack-objects` to create a packfile for a client, it will
3387 run this shell command instead. The `pack-objects` command and
3388 arguments it _would_ have run (including the `git pack-objects`
3389 at the beginning) are appended to the shell command. The stdin
3390 and stdout of the hook are treated as if `pack-objects` itself
3391 was run. I.e., `upload-pack` will feed input intended for
3392 `pack-objects` to the hook, and expects a completed packfile on
3395 uploadpack.allowFilter::
3396 If this option is set, `upload-pack` will support partial
3397 clone and partial fetch object filtering.
3399 Note that this configuration variable is ignored if it is seen in the
3400 repository-level config (this is a safety measure against fetching from
3401 untrusted repositories).
3403 url.<base>.insteadOf::
3404 Any URL that starts with this value will be rewritten to
3405 start, instead, with <base>. In cases where some site serves a
3406 large number of repositories, and serves them with multiple
3407 access methods, and some users need to use different access
3408 methods, this feature allows people to specify any of the
3409 equivalent URLs and have Git automatically rewrite the URL to
3410 the best alternative for the particular user, even for a
3411 never-before-seen repository on the site. When more than one
3412 insteadOf strings match a given URL, the longest match is used.
3414 Note that any protocol restrictions will be applied to the rewritten
3415 URL. If the rewrite changes the URL to use a custom protocol or remote
3416 helper, you may need to adjust the `protocol.*.allow` config to permit
3417 the request. In particular, protocols you expect to use for submodules
3418 must be set to `always` rather than the default of `user`. See the
3419 description of `protocol.allow` above.
3421 url.<base>.pushInsteadOf::
3422 Any URL that starts with this value will not be pushed to;
3423 instead, it will be rewritten to start with <base>, and the
3424 resulting URL will be pushed to. In cases where some site serves
3425 a large number of repositories, and serves them with multiple
3426 access methods, some of which do not allow push, this feature
3427 allows people to specify a pull-only URL and have Git
3428 automatically use an appropriate URL to push, even for a
3429 never-before-seen repository on the site. When more than one
3430 pushInsteadOf strings match a given URL, the longest match is
3431 used. If a remote has an explicit pushurl, Git will ignore this
3432 setting for that remote.
3435 Your email address to be recorded in any newly created commits.
3436 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3437 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3440 Your full name to be recorded in any newly created commits.
3441 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3442 environment variables. See linkgit:git-commit-tree[1].
3444 user.useConfigOnly::
3445 Instruct Git to avoid trying to guess defaults for `user.email`
3446 and `user.name`, and instead retrieve the values only from the
3447 configuration. For example, if you have multiple email addresses
3448 and would like to use a different one for each repository, then
3449 with this configuration option set to `true` in the global config
3450 along with a name, Git will prompt you to set up an email before
3451 making new commits in a newly cloned repository.
3452 Defaults to `false`.
3455 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3456 key you want it to automatically when creating a signed tag or
3457 commit, you can override the default selection with this variable.
3458 This option is passed unchanged to gpg's --local-user parameter,
3459 so you may specify a key using any method that gpg supports.
3461 versionsort.prereleaseSuffix (deprecated)::
3462 Deprecated alias for `versionsort.suffix`. Ignored if
3463 `versionsort.suffix` is set.
3465 versionsort.suffix::
3466 Even when version sort is used in linkgit:git-tag[1], tagnames
3467 with the same base version but different suffixes are still sorted
3468 lexicographically, resulting e.g. in prerelease tags appearing
3469 after the main release (e.g. "1.0-rc1" after "1.0"). This
3470 variable can be specified to determine the sorting order of tags
3471 with different suffixes.
3473 By specifying a single suffix in this variable, any tagname containing
3474 that suffix will appear before the corresponding main release. E.g. if
3475 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3476 "1.0". If specified multiple times, once per suffix, then the order of
3477 suffixes in the configuration will determine the sorting order of tagnames
3478 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3479 configuration, then all "1.0-preX" tags will be listed before any
3480 "1.0-rcX" tags. The placement of the main release tag relative to tags
3481 with various suffixes can be determined by specifying the empty suffix
3482 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3483 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3484 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3487 If more than one suffixes match the same tagname, then that tagname will
3488 be sorted according to the suffix which starts at the earliest position in
3489 the tagname. If more than one different matching suffixes start at
3490 that earliest position, then that tagname will be sorted according to the
3491 longest of those suffixes.
3492 The sorting order between different suffixes is undefined if they are
3493 in multiple config files.
3496 Specify a web browser that may be used by some commands.
3497 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3500 worktree.guessRemote::
3501 With `add`, if no branch argument, and neither of `-b` nor
3502 `-B` nor `--detach` are given, the command defaults to
3503 creating a new branch from HEAD. If `worktree.guessRemote` is
3504 set to true, `worktree add` tries to find a remote-tracking
3505 branch whose name uniquely matches the new branch name. If
3506 such a branch exists, it is checked out and set as "upstream"
3507 for the new branch. If no such match can be found, it falls
3508 back to creating a new branch from the current HEAD.