Merge branch 'ds/multi-pack-verify'
[git/git.git] / Documentation / config.txt
2 ------------------
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
18 multivalued.
20 Syntax
21 ~~~~~~
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:
38 --------
39 [section "subsection"]
41 --------
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
50 need to.
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
70 verbatim.
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.
81 Includes
82 ~~~~~~~~
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"
88 below.
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.
101 Conditional includes
102 ~~~~~~~~~~~~~~~~~~~~
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
106 included.
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
110 are:
112 `gitdir`::
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.
117 +
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
122 .git file is.
123 +
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.
142 `gitdir/i`::
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`
153 will match.
154 +
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.
163 Example
164 ~~~~~~~
166 # Core variables
167 [core]
168 ; Don't trust file modes
169 filemode = false
171 # Our diff algorithm
172 [diff]
173 external = /usr/local/bin/diff-wrapper
174 renames = true
176 [branch "devel"]
177 remote = origin
178 merge = refs/heads/devel
180 # Proxy settings
181 [core]
182 gitProxy="ssh" for ""
183 gitProxy=default-proxy ; for the rest
185 [include]
186 path = /path/to/ ; include by absolute path
187 path = ; find "" relative to the current file
188 path = ~/ ; find "" 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/
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/
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/"]
206 path =
208 Values
209 ~~~~~~
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.
215 boolean::
217 When a variable is said to take a boolean value, many
218 synonyms are accepted for 'true' and 'false'; these are all
219 case-insensitive.
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
223 is taken as true.
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
227 +
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).
232 integer::
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.
237 color::
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.
241 +
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.
245 +
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
249 hex, like `#ff0ab3`.
250 +
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`,
256 `no-ul`, etc).
257 +
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.
260 +
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.
270 pathname::
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.
278 Variables
279 ~~~~~~~~~
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.
291 advice.*::
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':
295 +
296 --
297 pushUpdateRejected::
298 Set this variable to 'false' if you want to disable
299 'pushNonFFCurrent',
300 'pushNonFFMatching', 'pushAlreadyExists',
301 'pushFetchFirst', and 'pushNeedsForce'
302 simultaneously.
303 pushNonFFCurrent::
304 Advice shown when linkgit:git-push[1] fails due to a
305 non-fast-forward update to the current branch.
306 pushNonFFMatching::
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.
311 pushAlreadyExists::
312 Shown when linkgit:git-push[1] rejects an update that
313 does not qualify for fast-forwarding (e.g., a tag.)
314 pushFetchFirst::
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.
318 pushNeedsForce::
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.
323 statusHints::
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.
329 statusUoption::
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
332 files.
333 commitBeforeMerge::
334 Advice shown when linkgit:git-merge[1] refuses to
335 merge to avoid overwriting local changes.
336 resolveConflict::
337 Advice shown by various commands when conflicts
338 prevent the operation from being performed.
339 implicitIdentity::
340 Advice on how to set your identity configuration when
341 your information is guessed from the system username and
342 domain name.
343 detachedHead::
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.
347 checkoutAmbiguousRemoteBranchName::
348 Advice shown when the argument to
349 linkgit:git-checkout[1] ambiguously resolves to a
350 remote tracking branch on more than one remote in
351 situations where an unambiguous argument would have
352 otherwise caused a remote-tracking branch to be
353 checked out. See the `checkout.defaultRemote`
354 configuration variable for how to set a given remote
355 to used by default in some situations where this
356 advice would be printed.
357 amWorkDir::
358 Advice that shows the location of the patch file when
359 linkgit:git-am[1] fails to apply it.
360 rmHints::
361 In case of failure in the output of linkgit:git-rm[1],
362 show directions on how to proceed from the current state.
363 addEmbeddedRepo::
364 Advice on what to do when you've accidentally added one
365 git repo inside of another.
366 ignoredHook::
367 Advice shown if a hook is ignored because the hook is not
368 set as executable.
369 waitingForEditor::
370 Print a message to the terminal whenever Git is waiting for
371 editor input from the user.
372 --
374 core.fileMode::
375 Tells Git if the executable bit of files in the working tree
376 is to be honored.
377 +
378 Some filesystems lose the executable bit when a file that is
379 marked as executable is checked out, or checks out a
380 non-executable file with executable bit on.
381 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
382 to see if it handles the executable bit correctly
383 and this variable is automatically set as necessary.
384 +
385 A repository, however, may be on a filesystem that handles
386 the filemode correctly, and this variable is set to 'true'
387 when created, but later may be made accessible from another
388 environment that loses the filemode (e.g. exporting ext4 via
389 CIFS mount, visiting a Cygwin created repository with
390 Git for Windows or Eclipse).
391 In such a case it may be necessary to set this variable to 'false'.
392 See linkgit:git-update-index[1].
393 +
394 The default is true (when core.filemode is not specified in the config file).
396 core.hideDotFiles::
397 (Windows-only) If true, mark newly-created directories and files whose
398 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
399 directory is hidden, but no other files starting with a dot. The
400 default mode is 'dotGitOnly'.
402 core.ignoreCase::
403 Internal variable which enables various workarounds to enable
404 Git to work better on filesystems that are not case sensitive,
405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
406 finds "makefile" when Git expects "Makefile", Git will assume
407 it is really the same file, and continue to remember it as
408 "Makefile".
409 +
410 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
411 will probe and set core.ignoreCase true if appropriate when the repository
412 is created.
413 +
414 Git relies on the proper configuration of this variable for your operating
415 and file system. Modifying this value may result in unexpected behavior.
417 core.precomposeUnicode::
418 This option is only used by Mac OS implementation of Git.
419 When core.precomposeUnicode=true, Git reverts the unicode decomposition
420 of filenames done by Mac OS. This is useful when sharing a repository
421 between Mac OS and Linux or Windows.
422 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
423 When false, file names are handled fully transparent by Git,
424 which is backward compatible with older versions of Git.
426 core.protectHFS::
427 If set to true, do not allow checkout of paths that would
428 be considered equivalent to `.git` on an HFS+ filesystem.
429 Defaults to `true` on Mac OS, and `false` elsewhere.
431 core.protectNTFS::
432 If set to true, do not allow checkout of paths that would
433 cause problems with the NTFS filesystem, e.g. conflict with
434 8.3 "short" names.
435 Defaults to `true` on Windows, and `false` elsewhere.
437 core.fsmonitor::
438 If set, the value of this variable is used as a command which
439 will identify all files that may have changed since the
440 requested date/time. This information is used to speed up git by
441 avoiding unnecessary processing of files that have not changed.
442 See the "fsmonitor-watchman" section of linkgit:githooks[5].
444 core.trustctime::
445 If false, the ctime differences between the index and the
446 working tree are ignored; useful when the inode change time
447 is regularly modified by something outside Git (file system
448 crawlers and some backup systems).
449 See linkgit:git-update-index[1]. True by default.
451 core.splitIndex::
452 If true, the split-index feature of the index will be used.
453 See linkgit:git-update-index[1]. False by default.
455 core.untrackedCache::
456 Determines what to do about the untracked cache feature of the
457 index. It will be kept, if this variable is unset or set to
458 `keep`. It will automatically be added if set to `true`. And
459 it will automatically be removed, if set to `false`. Before
460 setting it to `true`, you should check that mtime is working
461 properly on your system.
462 See linkgit:git-update-index[1]. `keep` by default.
464 core.checkStat::
465 When missing or is set to `default`, many fields in the stat
466 structure are checked to detect if a file has been modified
467 since Git looked at it. When this configuration variable is
468 set to `minimal`, sub-second part of mtime and ctime, the
469 uid and gid of the owner of the file, the inode number (and
470 the device number, if Git was compiled to use it), are
471 excluded from the check among these fields, leaving only the
472 whole-second part of mtime (and ctime, if `core.trustCtime`
473 is set) and the filesize to be checked.
474 +
475 There are implementations of Git that do not leave usable values in
476 some fields (e.g. JGit); by excluding these fields from the
477 comparison, the `minimal` mode may help interoperability when the
478 same repository is used by these other systems at the same time.
480 core.quotePath::
481 Commands that output paths (e.g. 'ls-files', 'diff'), will
482 quote "unusual" characters in the pathname by enclosing the
483 pathname in double-quotes and escaping those characters with
484 backslashes in the same way C escapes control characters (e.g.
485 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
486 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
487 UTF-8). If this variable is set to false, bytes higher than
488 0x80 are not considered "unusual" any more. Double-quotes,
489 backslash and control characters are always escaped regardless
490 of the setting of this variable. A simple space character is
491 not considered "unusual". Many commands can output pathnames
492 completely verbatim using the `-z` option. The default value
493 is true.
495 core.eol::
496 Sets the line ending type to use in the working directory for
497 files that have the `text` property set when core.autocrlf is false.
498 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
499 native line ending. The default value is `native`. See
500 linkgit:gitattributes[5] for more information on end-of-line
501 conversion.
503 core.safecrlf::
504 If true, makes Git check if converting `CRLF` is reversible when
505 end-of-line conversion is active. Git will verify if a command
506 modifies a file in the work tree either directly or indirectly.
507 For example, committing a file followed by checking out the
508 same file should yield the original file in the work tree. If
509 this is not the case for the current setting of
510 `core.autocrlf`, Git will reject the file. The variable can
511 be set to "warn", in which case Git will only warn about an
512 irreversible conversion but continue the operation.
513 +
514 CRLF conversion bears a slight chance of corrupting data.
515 When it is enabled, Git will convert CRLF to LF during commit and LF to
516 CRLF during checkout. A file that contains a mixture of LF and
517 CRLF before the commit cannot be recreated by Git. For text
518 files this is the right thing to do: it corrects line endings
519 such that we have only LF line endings in the repository.
520 But for binary files that are accidentally classified as text the
521 conversion can corrupt data.
522 +
523 If you recognize such corruption early you can easily fix it by
524 setting the conversion type explicitly in .gitattributes. Right
525 after committing you still have the original file in your work
526 tree and this file is not yet corrupted. You can explicitly tell
527 Git that this file is binary and Git will handle the file
528 appropriately.
529 +
530 Unfortunately, the desired effect of cleaning up text files with
531 mixed line endings and the undesired effect of corrupting binary
532 files cannot be distinguished. In both cases CRLFs are removed
533 in an irreversible way. For text files this is the right thing
534 to do because CRLFs are line endings, while for binary files
535 converting CRLFs corrupts data.
536 +
537 Note, this safety check does not mean that a checkout will generate a
538 file identical to the original file for a different setting of
539 `core.eol` and `core.autocrlf`, but only for the current one. For
540 example, a text file with `LF` would be accepted with `core.eol=lf`
541 and could later be checked out with `core.eol=crlf`, in which case the
542 resulting file would contain `CRLF`, although the original file
543 contained `LF`. However, in both work trees the line endings would be
544 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
545 file with mixed line endings would be reported by the `core.safecrlf`
546 mechanism.
548 core.autocrlf::
549 Setting this variable to "true" is the same as setting
550 the `text` attribute to "auto" on all files and core.eol to "crlf".
551 Set to true if you want to have `CRLF` line endings in your
552 working directory and the repository has LF line endings.
553 This variable can be set to 'input',
554 in which case no output conversion is performed.
556 core.checkRoundtripEncoding::
557 A comma and/or whitespace separated list of encodings that Git
558 performs UTF-8 round trip checks on if they are used in an
559 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
560 The default value is `SHIFT-JIS`.
562 core.symlinks::
563 If false, symbolic links are checked out as small plain files that
564 contain the link text. linkgit:git-update-index[1] and
565 linkgit:git-add[1] will not change the recorded type to regular
566 file. Useful on filesystems like FAT that do not support
567 symbolic links.
568 +
569 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
570 will probe and set core.symlinks false if appropriate when the repository
571 is created.
573 core.gitProxy::
574 A "proxy command" to execute (as 'command host port') instead
575 of establishing direct connection to the remote server when
576 using the Git protocol for fetching. If the variable value is
577 in the "COMMAND for DOMAIN" format, the command is applied only
578 on hostnames ending with the specified domain string. This variable
579 may be set multiple times and is matched in the given order;
580 the first match wins.
581 +
582 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
583 (which always applies universally, without the special "for"
584 handling).
585 +
586 The special string `none` can be used as the proxy command to
587 specify that no proxy be used for a given domain pattern.
588 This is useful for excluding servers inside a firewall from
589 proxy use, while defaulting to a common proxy for external domains.
591 core.sshCommand::
592 If this variable is set, `git fetch` and `git push` will
593 use the specified command instead of `ssh` when they need to
594 connect to a remote system. The command is in the same form as
595 the `GIT_SSH_COMMAND` environment variable and is overridden
596 when the environment variable is set.
598 core.ignoreStat::
599 If true, Git will avoid using lstat() calls to detect if files have
600 changed by setting the "assume-unchanged" bit for those tracked files
601 which it has updated identically in both the index and working tree.
602 +
603 When files are modified outside of Git, the user will need to stage
604 the modified files explicitly (e.g. see 'Examples' section in
605 linkgit:git-update-index[1]).
606 Git will not normally detect changes to those files.
607 +
608 This is useful on systems where lstat() calls are very slow, such as
609 CIFS/Microsoft Windows.
610 +
611 False by default.
613 core.preferSymlinkRefs::
614 Instead of the default "symref" format for HEAD
615 and other symbolic reference files, use symbolic links.
616 This is sometimes needed to work with old scripts that
617 expect HEAD to be a symbolic link.
619 core.bare::
620 If true this repository is assumed to be 'bare' and has no
621 working directory associated with it. If this is the case a
622 number of commands that require a working directory will be
623 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
624 +
625 This setting is automatically guessed by linkgit:git-clone[1] or
626 linkgit:git-init[1] when the repository was created. By default a
627 repository that ends in "/.git" is assumed to be not bare (bare =
628 false), while all other repositories are assumed to be bare (bare
629 = true).
631 core.worktree::
632 Set the path to the root of the working tree.
633 If `GIT_COMMON_DIR` environment variable is set, core.worktree
634 is ignored and not used for determining the root of working tree.
635 This can be overridden by the `GIT_WORK_TREE` environment
636 variable and the `--work-tree` command-line option.
637 The value can be an absolute path or relative to the path to
638 the .git directory, which is either specified by --git-dir
639 or GIT_DIR, or automatically discovered.
640 If --git-dir or GIT_DIR is specified but none of
641 --work-tree, GIT_WORK_TREE and core.worktree is specified,
642 the current working directory is regarded as the top level
643 of your working tree.
644 +
645 Note that this variable is honored even when set in a configuration
646 file in a ".git" subdirectory of a directory and its value differs
647 from the latter directory (e.g. "/path/to/.git/config" has
648 core.worktree set to "/different/path"), which is most likely a
649 misconfiguration. Running Git commands in the "/path/to" directory will
650 still use "/different/path" as the root of the work tree and can cause
651 confusion unless you know what you are doing (e.g. you are creating a
652 read-only snapshot of the same index to a location different from the
653 repository's usual working tree).
655 core.logAllRefUpdates::
656 Enable the reflog. Updates to a ref <ref> is logged to the file
657 "`$GIT_DIR/logs/<ref>`", by appending the new and old
658 SHA-1, the date/time and the reason of the update, but
659 only when the file exists. If this configuration
660 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
661 file is automatically created for branch heads (i.e. under
662 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
663 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
664 If it is set to `always`, then a missing reflog is automatically
665 created for any ref under `refs/`.
666 +
667 This information can be used to determine what commit
668 was the tip of a branch "2 days ago".
669 +
670 This value is true by default in a repository that has
671 a working directory associated with it, and false by
672 default in a bare repository.
674 core.repositoryFormatVersion::
675 Internal variable identifying the repository format and layout
676 version.
678 core.sharedRepository::
679 When 'group' (or 'true'), the repository is made shareable between
680 several users in a group (making sure all the files and objects are
681 group-writable). When 'all' (or 'world' or 'everybody'), the
682 repository will be readable by all users, additionally to being
683 group-shareable. When 'umask' (or 'false'), Git will use permissions
684 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
685 files in the repository will have this mode value. '0xxx' will override
686 user's umask value (whereas the other options will only override
687 requested parts of the user's umask value). Examples: '0660' will make
688 the repo read/write-able for the owner and group, but inaccessible to
689 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
690 repository that is group-readable but not group-writable.
691 See linkgit:git-init[1]. False by default.
693 core.warnAmbiguousRefs::
694 If true, Git will warn you if the ref name you passed it is ambiguous
695 and might match multiple refs in the repository. True by default.
697 core.compression::
698 An integer -1..9, indicating a default compression level.
699 -1 is the zlib default. 0 means no compression,
700 and 1..9 are various speed/size tradeoffs, 9 being slowest.
701 If set, this provides a default to other compression variables,
702 such as `core.looseCompression` and `pack.compression`.
704 core.looseCompression::
705 An integer -1..9, indicating the compression level for objects that
706 are not in a pack file. -1 is the zlib default. 0 means no
707 compression, and 1..9 are various speed/size tradeoffs, 9 being
708 slowest. If not set, defaults to core.compression. If that is
709 not set, defaults to 1 (best speed).
711 core.packedGitWindowSize::
712 Number of bytes of a pack file to map into memory in a
713 single mapping operation. Larger window sizes may allow
714 your system to process a smaller number of large pack files
715 more quickly. Smaller window sizes will negatively affect
716 performance due to increased calls to the operating system's
717 memory manager, but may improve performance when accessing
718 a large number of large pack files.
719 +
720 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
721 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
722 be reasonable for all users/operating systems. You probably do
723 not need to adjust this value.
724 +
725 Common unit suffixes of 'k', 'm', or 'g' are supported.
727 core.packedGitLimit::
728 Maximum number of bytes to map simultaneously into memory
729 from pack files. If Git needs to access more than this many
730 bytes at once to complete an operation it will unmap existing
731 regions to reclaim virtual address space within the process.
732 +
733 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
734 unlimited) on 64 bit platforms.
735 This should be reasonable for all users/operating systems, except on
736 the largest projects. You probably do not need to adjust this value.
737 +
738 Common unit suffixes of 'k', 'm', or 'g' are supported.
740 core.deltaBaseCacheLimit::
741 Maximum number of bytes to reserve for caching base objects
742 that may be referenced by multiple deltified objects. By storing the
743 entire decompressed base objects in a cache Git is able
744 to avoid unpacking and decompressing frequently used base
745 objects multiple times.
746 +
747 Default is 96 MiB on all platforms. This should be reasonable
748 for all users/operating systems, except on the largest projects.
749 You probably do not need to adjust this value.
750 +
751 Common unit suffixes of 'k', 'm', or 'g' are supported.
753 core.bigFileThreshold::
754 Files larger than this size are stored deflated, without
755 attempting delta compression. Storing large files without
756 delta compression avoids excessive memory usage, at the
757 slight expense of increased disk usage. Additionally files
758 larger than this size are always treated as binary.
759 +
760 Default is 512 MiB on all platforms. This should be reasonable
761 for most projects as source code and other text files can still
762 be delta compressed, but larger binary media files won't be.
763 +
764 Common unit suffixes of 'k', 'm', or 'g' are supported.
766 core.excludesFile::
767 Specifies the pathname to the file that contains patterns to
768 describe paths that are not meant to be tracked, in addition
769 to '.gitignore' (per-directory) and '.git/info/exclude'.
770 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
771 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
772 is used instead. See linkgit:gitignore[5].
774 core.askPass::
775 Some commands (e.g. svn and http interfaces) that interactively
776 ask for a password can be told to use an external program given
777 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
778 environment variable. If not set, fall back to the value of the
779 `SSH_ASKPASS` environment variable or, failing that, a simple password
780 prompt. The external program shall be given a suitable prompt as
781 command-line argument and write the password on its STDOUT.
783 core.attributesFile::
784 In addition to '.gitattributes' (per-directory) and
785 '.git/info/attributes', Git looks into this file for attributes
786 (see linkgit:gitattributes[5]). Path expansions are made the same
787 way as for `core.excludesFile`. Its default value is
788 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
789 set or empty, `$HOME/.config/git/attributes` is used instead.
791 core.hooksPath::
792 By default Git will look for your hooks in the
793 '$GIT_DIR/hooks' directory. Set this to different path,
794 e.g. '/etc/git/hooks', and Git will try to find your hooks in
795 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
796 in '$GIT_DIR/hooks/pre-receive'.
797 +
798 The path can be either absolute or relative. A relative path is
799 taken as relative to the directory where the hooks are run (see
800 the "DESCRIPTION" section of linkgit:githooks[5]).
801 +
802 This configuration variable is useful in cases where you'd like to
803 centrally configure your Git hooks instead of configuring them on a
804 per-repository basis, or as a more flexible and centralized
805 alternative to having an `init.templateDir` where you've changed
806 default hooks.
808 core.editor::
809 Commands such as `commit` and `tag` that let you edit
810 messages by launching an editor use the value of this
811 variable when it is set, and the environment variable
812 `GIT_EDITOR` is not set. See linkgit:git-var[1].
814 core.commentChar::
815 Commands such as `commit` and `tag` that let you edit
816 messages consider a line that begins with this character
817 commented, and removes them after the editor returns
818 (default '#').
819 +
820 If set to "auto", `git-commit` would select a character that is not
821 the beginning character of any line in existing commit messages.
823 core.filesRefLockTimeout::
824 The length of time, in milliseconds, to retry when trying to
825 lock an individual reference. Value 0 means not to retry at
826 all; -1 means to try indefinitely. Default is 100 (i.e.,
827 retry for 100ms).
829 core.packedRefsTimeout::
830 The length of time, in milliseconds, to retry when trying to
831 lock the `packed-refs` file. Value 0 means not to retry at
832 all; -1 means to try indefinitely. Default is 1000 (i.e.,
833 retry for 1 second).
835 core.pager::
836 Text viewer for use by Git commands (e.g., 'less'). The value
837 is meant to be interpreted by the shell. The order of preference
838 is the `$GIT_PAGER` environment variable, then `core.pager`
839 configuration, then `$PAGER`, and then the default chosen at
840 compile time (usually 'less').
841 +
842 When the `LESS` environment variable is unset, Git sets it to `FRX`
843 (if `LESS` environment variable is set, Git does not change it at
844 all). If you want to selectively override Git's default setting
845 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
846 be passed to the shell by Git, which will translate the final
847 command to `LESS=FRX less -S`. The environment does not set the
848 `S` option but the command line does, instructing less to truncate
849 long lines. Similarly, setting `core.pager` to `less -+F` will
850 deactivate the `F` option specified by the environment from the
851 command-line, deactivating the "quit if one screen" behavior of
852 `less`. One can specifically activate some flags for particular
853 commands: for example, setting `pager.blame` to `less -S` enables
854 line truncation only for `git blame`.
855 +
856 Likewise, when the `LV` environment variable is unset, Git sets it
857 to `-c`. You can override this setting by exporting `LV` with
858 another value or setting `core.pager` to `lv +c`.
860 core.whitespace::
861 A comma separated list of common whitespace problems to
862 notice. 'git diff' will use `color.diff.whitespace` to
863 highlight them, and 'git apply --whitespace=error' will
864 consider them as errors. You can prefix `-` to disable
865 any of them (e.g. `-trailing-space`):
866 +
867 * `blank-at-eol` treats trailing whitespaces at the end of the line
868 as an error (enabled by default).
869 * `space-before-tab` treats a space character that appears immediately
870 before a tab character in the initial indent part of the line as an
871 error (enabled by default).
872 * `indent-with-non-tab` treats a line that is indented with space
873 characters instead of the equivalent tabs as an error (not enabled by
874 default).
875 * `tab-in-indent` treats a tab character in the initial indent part of
876 the line as an error (not enabled by default).
877 * `blank-at-eof` treats blank lines added at the end of file as an error
878 (enabled by default).
879 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
880 `blank-at-eof`.
881 * `cr-at-eol` treats a carriage-return at the end of line as
882 part of the line terminator, i.e. with it, `trailing-space`
883 does not trigger if the character before such a carriage-return
884 is not a whitespace (not enabled by default).
885 * `tabwidth=<n>` tells how many character positions a tab occupies; this
886 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
887 errors. The default tab width is 8. Allowed values are 1 to 63.
889 core.fsyncObjectFiles::
890 This boolean will enable 'fsync()' when writing object files.
891 +
892 This is a total waste of time and effort on a filesystem that orders
893 data writes properly, but can be useful for filesystems that do not use
894 journalling (traditional UNIX filesystems) or that only journal metadata
895 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
897 core.preloadIndex::
898 Enable parallel index preload for operations like 'git diff'
899 +
900 This can speed up operations like 'git diff' and 'git status' especially
901 on filesystems like NFS that have weak caching semantics and thus
902 relatively high IO latencies. When enabled, Git will do the
903 index comparison to the filesystem data in parallel, allowing
904 overlapping IO's. Defaults to true.
906 core.createObject::
907 You can set this to 'link', in which case a hardlink followed by
908 a delete of the source are used to make sure that object creation
909 will not overwrite existing objects.
910 +
911 On some file system/operating system combinations, this is unreliable.
912 Set this config setting to 'rename' there; However, This will remove the
913 check that makes sure that existing object files will not get overwritten.
915 core.notesRef::
916 When showing commit messages, also show notes which are stored in
917 the given ref. The ref must be fully qualified. If the given
918 ref does not exist, it is not an error but means that no
919 notes should be printed.
920 +
921 This setting defaults to "refs/notes/commits", and it can be overridden by
922 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
924 core.commitGraph::
925 If true, then git will read the commit-graph file (if it exists)
926 to parse the graph structure of commits. Defaults to false. See
927 linkgit:git-commit-graph[1] for more information.
929 core.useReplaceRefs::
930 If set to `false`, behave as if the `--no-replace-objects`
931 option was given on the command line. See linkgit:git[1] and
932 linkgit:git-replace[1] for more information.
934 core.multiPackIndex::
935 Use the multi-pack-index file to track multiple packfiles using a
936 single index. See link:technical/multi-pack-index.html[the
937 multi-pack-index design document].
939 core.sparseCheckout::
940 Enable "sparse checkout" feature. See section "Sparse checkout" in
941 linkgit:git-read-tree[1] for more information.
943 core.abbrev::
944 Set the length object names are abbreviated to. If
945 unspecified or set to "auto", an appropriate value is
946 computed based on the approximate number of packed objects
947 in your repository, which hopefully is enough for
948 abbreviated object names to stay unique for some time.
949 The minimum length is 4.
951 add.ignoreErrors::
952 add.ignore-errors (deprecated)::
953 Tells 'git add' to continue adding files when some files cannot be
954 added due to indexing errors. Equivalent to the `--ignore-errors`
955 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
956 as it does not follow the usual naming convention for configuration
957 variables.
959 alias.*::
960 Command aliases for the linkgit:git[1] command wrapper - e.g.
961 after defining "alias.last = cat-file commit HEAD", the invocation
962 "git last" is equivalent to "git cat-file commit HEAD". To avoid
963 confusion and troubles with script usage, aliases that
964 hide existing Git commands are ignored. Arguments are split by
965 spaces, the usual shell quoting and escaping is supported.
966 A quote pair or a backslash can be used to quote them.
967 +
968 If the alias expansion is prefixed with an exclamation point,
969 it will be treated as a shell command. For example, defining
970 " = !gitk --all --not ORIG_HEAD", the invocation
971 "git new" is equivalent to running the shell command
972 "gitk --all --not ORIG_HEAD". Note that shell commands will be
973 executed from the top-level directory of a repository, which may
974 not necessarily be the current directory.
975 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
976 from the original current directory. See linkgit:git-rev-parse[1].
978 am.keepcr::
979 If true, git-am will call git-mailsplit for patches in mbox format
980 with parameter `--keep-cr`. In this case git-mailsplit will
981 not remove `\r` from lines ending with `\r\n`. Can be overridden
982 by giving `--no-keep-cr` from the command line.
983 See linkgit:git-am[1], linkgit:git-mailsplit[1].
985 am.threeWay::
986 By default, `git am` will fail if the patch does not apply cleanly. When
987 set to true, this setting tells `git am` to fall back on 3-way merge if
988 the patch records the identity of blobs it is supposed to apply to and
989 we have those blobs available locally (equivalent to giving the `--3way`
990 option from the command line). Defaults to `false`.
991 See linkgit:git-am[1].
993 apply.ignoreWhitespace::
994 When set to 'change', tells 'git apply' to ignore changes in
995 whitespace, in the same way as the `--ignore-space-change`
996 option.
997 When set to one of: no, none, never, false tells 'git apply' to
998 respect all whitespace differences.
999 See linkgit:git-apply[1].
1001 apply.whitespace::
1002 Tells 'git apply' how to handle whitespaces, in the same way
1003 as the `--whitespace` option. See linkgit:git-apply[1].
1005 blame.blankBoundary::
1006 Show blank commit object name for boundary commits in
1007 linkgit:git-blame[1]. This option defaults to false.
1009 blame.coloring::
1010 This determines the coloring scheme to be applied to blame
1011 output. It can be 'repeatedLines', 'highlightRecent',
1012 or 'none' which is the default.
1015 Specifies the format used to output dates in linkgit:git-blame[1].
1016 If unset the iso format is used. For supported values,
1017 see the discussion of the `--date` option at linkgit:git-log[1].
1019 blame.showEmail::
1020 Show the author email instead of author name in linkgit:git-blame[1].
1021 This option defaults to false.
1023 blame.showRoot::
1024 Do not treat root commits as boundaries in linkgit:git-blame[1].
1025 This option defaults to false.
1027 branch.autoSetupMerge::
1028 Tells 'git branch' and 'git checkout' to set up new branches
1029 so that linkgit:git-pull[1] will appropriately merge from the
1030 starting point branch. Note that even if this option is not set,
1031 this behavior can be chosen per-branch using the `--track`
1032 and `--no-track` options. The valid settings are: `false` -- no
1033 automatic setup is done; `true` -- automatic setup is done when the
1034 starting point is a remote-tracking branch; `always` --
1035 automatic setup is done when the starting point is either a
1036 local branch or remote-tracking
1037 branch. This option defaults to true.
1039 branch.autoSetupRebase::
1040 When a new branch is created with 'git branch' or 'git checkout'
1041 that tracks another branch, this variable tells Git to set
1042 up pull to rebase instead of merge (see "branch.<name>.rebase").
1043 When `never`, rebase is never automatically set to true.
1044 When `local`, rebase is set to true for tracked branches of
1045 other local branches.
1046 When `remote`, rebase is set to true for tracked branches of
1047 remote-tracking branches.
1048 When `always`, rebase will be set to true for all tracking
1049 branches.
1050 See "branch.autoSetupMerge" for details on how to set up a
1051 branch to track another branch.
1052 This option defaults to never.
1054 branch.sort::
1055 This variable controls the sort ordering of branches when displayed by
1056 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1057 value of this variable will be used as the default.
1058 See linkgit:git-for-each-ref[1] field names for valid values.
1060 branch.<name>.remote::
1061 When on branch <name>, it tells 'git fetch' and 'git push'
1062 which remote to fetch from/push to. The remote to push to
1063 may be overridden with `remote.pushDefault` (for all branches).
1064 The remote to push to, for the current branch, may be further
1065 overridden by `branch.<name>.pushRemote`. If no remote is
1066 configured, or if you are not on any branch, it defaults to
1067 `origin` for fetching and `remote.pushDefault` for pushing.
1068 Additionally, `.` (a period) is the current local repository
1069 (a dot-repository), see `branch.<name>.merge`'s final note below.
1071 branch.<name>.pushRemote::
1072 When on branch <name>, it overrides `branch.<name>.remote` for
1073 pushing. It also overrides `remote.pushDefault` for pushing
1074 from branch <name>. When you pull from one place (e.g. your
1075 upstream) and push to another place (e.g. your own publishing
1076 repository), you would want to set `remote.pushDefault` to
1077 specify the remote to push to for all branches, and use this
1078 option to override it for a specific branch.
1080 branch.<name>.merge::
1081 Defines, together with branch.<name>.remote, the upstream branch
1082 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1083 branch to merge and can also affect 'git push' (see push.default).
1084 When in branch <name>, it tells 'git fetch' the default
1085 refspec to be marked for merging in FETCH_HEAD. The value is
1086 handled like the remote part of a refspec, and must match a
1087 ref which is fetched from the remote given by
1088 "branch.<name>.remote".
1089 The merge information is used by 'git pull' (which at first calls
1090 'git fetch') to lookup the default branch for merging. Without
1091 this option, 'git pull' defaults to merge the first refspec fetched.
1092 Specify multiple values to get an octopus merge.
1093 If you wish to setup 'git pull' so that it merges into <name> from
1094 another branch in the local repository, you can point
1095 branch.<name>.merge to the desired branch, and use the relative path
1096 setting `.` (a period) for branch.<name>.remote.
1098 branch.<name>.mergeOptions::
1099 Sets default options for merging into branch <name>. The syntax and
1100 supported options are the same as those of linkgit:git-merge[1], but
1101 option values containing whitespace characters are currently not
1102 supported.
1104 branch.<name>.rebase::
1105 When true, rebase the branch <name> on top of the fetched branch,
1106 instead of merging the default branch from the default remote when
1107 "git pull" is run. See "pull.rebase" for doing this in a non
1108 branch-specific manner.
1109 +
1110 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1111 so that the local merge commits are included in the rebase (see
1112 linkgit:git-rebase[1] for details).
1113 +
1114 When preserve, also pass `--preserve-merges` along to 'git rebase'
1115 so that locally committed merge commits will not be flattened
1116 by running 'git pull'.
1117 +
1118 When the value is `interactive`, the rebase is run in interactive mode.
1119 +
1120 *NOTE*: this is a possibly dangerous operation; do *not* use
1121 it unless you understand the implications (see linkgit:git-rebase[1]
1122 for details).
1124 branch.<name>.description::
1125 Branch description, can be edited with
1126 `git branch --edit-description`. Branch description is
1127 automatically added in the format-patch cover letter or
1128 request-pull summary.
1130 browser.<tool>.cmd::
1131 Specify the command to invoke the specified browser. The
1132 specified command is evaluated in shell with the URLs passed
1133 as arguments. (See linkgit:git-web{litdd}browse[1].)
1135 browser.<tool>.path::
1136 Override the path for the given tool that may be used to
1137 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1138 working repository in gitweb (see linkgit:git-instaweb[1]).
1140 checkout.defaultRemote::
1141 When you run 'git checkout <something>' and only have one
1142 remote, it may implicitly fall back on checking out and
1143 tracking e.g. 'origin/<something>'. This stops working as soon
1144 as you have more than one remote with a '<something>'
1145 reference. This setting allows for setting the name of a
1146 preferred remote that should always win when it comes to
1147 disambiguation. The typical use-case is to set this to
1148 `origin`.
1149 +
1150 Currently this is used by linkgit:git-checkout[1] when 'git checkout
1151 <something>' will checkout the '<something>' branch on another remote,
1152 and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1153 remote branch. This setting might be used for other checkout-like
1154 commands or functionality in the future.
1156 checkout.optimizeNewBranch::
1157 Optimizes the performance of "git checkout -b <new_branch>" when
1158 using sparse-checkout. When set to true, git will not update the
1159 repo based on the current sparse-checkout settings. This means it
1160 will not update the skip-worktree bit in the index nor add/remove
1161 files in the working directory to reflect the current sparse checkout
1162 settings nor will it show the local changes.
1164 clean.requireForce::
1165 A boolean to make git-clean do nothing unless given -f,
1166 -i or -n. Defaults to true.
1168 color.advice::
1169 A boolean to enable/disable color in hints (e.g. when a push
1170 failed, see `advice.*` for a list). May be set to `always`,
1171 `false` (or `never`) or `auto` (or `true`), in which case colors
1172 are used only when the error output goes to a terminal. If
1173 unset, then the value of `color.ui` is used (`auto` by default).
1175 color.advice.hint::
1176 Use customized color for hints.
1178 color.blame.highlightRecent::
1179 This can be used to color the metadata of a blame line depending
1180 on age of the line.
1181 +
1182 This setting should be set to a comma-separated list of color and date settings,
1183 starting and ending with a color, the dates should be set from oldest to newest.
1184 The metadata will be colored given the colors if the the line was introduced
1185 before the given timestamp, overwriting older timestamped colors.
1186 +
1187 Instead of an absolute timestamp relative timestamps work as well, e.g.
1188 2.weeks.ago is valid to address anything older than 2 weeks.
1189 +
1190 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1191 everything older than one year blue, recent changes between one month and
1192 one year old are kept white, and lines introduced within the last month are
1193 colored red.
1195 color.blame.repeatedLines::
1196 Use the customized color for the part of git-blame output that
1197 is repeated meta information per line (such as commit id,
1198 author name, date and timezone). Defaults to cyan.
1200 color.branch::
1201 A boolean to enable/disable color in the output of
1202 linkgit:git-branch[1]. May be set to `always`,
1203 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1204 only when the output is to a terminal. If unset, then the
1205 value of `color.ui` is used (`auto` by default).
1207 color.branch.<slot>::
1208 Use customized color for branch coloration. `<slot>` is one of
1209 `current` (the current branch), `local` (a local branch),
1210 `remote` (a remote-tracking branch in refs/remotes/),
1211 `upstream` (upstream tracking branch), `plain` (other
1212 refs).
1214 color.diff::
1215 Whether to use ANSI escape sequences to add color to patches.
1216 If this is set to `always`, linkgit:git-diff[1],
1217 linkgit:git-log[1], and linkgit:git-show[1] will use color
1218 for all patches. If it is set to `true` or `auto`, those
1219 commands will only use color when output is to the terminal.
1220 If unset, then the value of `color.ui` is used (`auto` by
1221 default).
1222 +
1223 This does not affect linkgit:git-format-patch[1] or the
1224 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1225 command line with the `--color[=<when>]` option.
1227 color.diff.<slot>::
1228 Use customized color for diff colorization. `<slot>` specifies
1229 which part of the patch to use the specified color, and is one
1230 of `context` (context text - `plain` is a historical synonym),
1231 `meta` (metainformation), `frag`
1232 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1233 `new` (added lines), `commit` (commit headers), `whitespace`
1234 (highlighting whitespace errors), `oldMoved` (deleted lines),
1235 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1236 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1237 `newMovedAlternativeDimmed` (See the '<mode>'
1238 setting of '--color-moved' in linkgit:git-diff[1] for details),
1239 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1240 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1242 color.decorate.<slot>::
1243 Use customized color for 'git log --decorate' output. `<slot>` is one
1244 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1245 branches, remote-tracking branches, tags, stash and HEAD, respectively
1246 and `grafted` for grafted commits.
1248 color.grep::
1249 When set to `always`, always highlight matches. When `false` (or
1250 `never`), never. When set to `true` or `auto`, use color only
1251 when the output is written to the terminal. If unset, then the
1252 value of `color.ui` is used (`auto` by default).
1254 color.grep.<slot>::
1255 Use customized color for grep colorization. `<slot>` specifies which
1256 part of the line to use the specified color, and is one of
1257 +
1258 --
1259 `context`;;
1260 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1261 `filename`;;
1262 filename prefix (when not using `-h`)
1263 `function`;;
1264 function name lines (when using `-p`)
1265 `lineNumber`;;
1266 line number prefix (when using `-n`)
1267 `column`;;
1268 column number prefix (when using `--column`)
1269 `match`;;
1270 matching text (same as setting `matchContext` and `matchSelected`)
1271 `matchContext`;;
1272 matching text in context lines
1273 `matchSelected`;;
1274 matching text in selected lines
1275 `selected`;;
1276 non-matching text in selected lines
1277 `separator`;;
1278 separators between fields on a line (`:`, `-`, and `=`)
1279 and between hunks (`--`)
1280 --
1282 color.interactive::
1283 When set to `always`, always use colors for interactive prompts
1284 and displays (such as those used by "git-add --interactive" and
1285 "git-clean --interactive"). When false (or `never`), never.
1286 When set to `true` or `auto`, use colors only when the output is
1287 to the terminal. If unset, then the value of `color.ui` is
1288 used (`auto` by default).
1290 color.interactive.<slot>::
1291 Use customized color for 'git add --interactive' and 'git clean
1292 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1293 or `error`, for four distinct types of normal output from
1294 interactive commands.
1296 color.pager::
1297 A boolean to enable/disable colored output when the pager is in
1298 use (default is true).
1300 color.push::
1301 A boolean to enable/disable color in push errors. May be set to
1302 `always`, `false` (or `never`) or `auto` (or `true`), in which
1303 case colors are used only when the error output goes to a terminal.
1304 If unset, then the value of `color.ui` is used (`auto` by default).
1306 color.push.error::
1307 Use customized color for push errors.
1309 color.remote::
1310 If set, keywords at the start of the line are highlighted. The
1311 keywords are "error", "warning", "hint" and "success", and are
1312 matched case-insensitively. May be set to `always`, `false` (or
1313 `never`) or `auto` (or `true`). If unset, then the value of
1314 `color.ui` is used (`auto` by default).
1316 color.remote.<slot>::
1317 Use customized color for each remote keyword. `<slot>` may be
1318 `hint`, `warning`, `success` or `error` which match the
1319 corresponding keyword.
1321 color.showBranch::
1322 A boolean to enable/disable color in the output of
1323 linkgit:git-show-branch[1]. May be set to `always`,
1324 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1325 only when the output is to a terminal. If unset, then the
1326 value of `color.ui` is used (`auto` by default).
1328 color.status::
1329 A boolean to enable/disable color in the output of
1330 linkgit:git-status[1]. May be set to `always`,
1331 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1332 only when the output is to a terminal. If unset, then the
1333 value of `color.ui` is used (`auto` by default).
1335 color.status.<slot>::
1336 Use customized color for status colorization. `<slot>` is
1337 one of `header` (the header text of the status message),
1338 `added` or `updated` (files which are added but not committed),
1339 `changed` (files which are changed but not added in the index),
1340 `untracked` (files which are not tracked by Git),
1341 `branch` (the current branch),
1342 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1343 to red),
1344 `localBranch` or `remoteBranch` (the local and remote branch names,
1345 respectively, when branch and tracking information is displayed in the
1346 status short-format), or
1347 `unmerged` (files which have unmerged changes).
1349 color.transport::
1350 A boolean to enable/disable color when pushes are rejected. May be
1351 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1352 case colors are used only when the error output goes to a terminal.
1353 If unset, then the value of `color.ui` is used (`auto` by default).
1355 color.transport.rejected::
1356 Use customized color when a push was rejected.
1358 color.ui::
1359 This variable determines the default value for variables such
1360 as `color.diff` and `color.grep` that control the use of color
1361 per command family. Its scope will expand as more commands learn
1362 configuration to set a default for the `--color` option. Set it
1363 to `false` or `never` if you prefer Git commands not to use
1364 color unless enabled explicitly with some other configuration
1365 or the `--color` option. Set it to `always` if you want all
1366 output not intended for machine consumption to use color, to
1367 `true` or `auto` (this is the default since Git 1.8.4) if you
1368 want such output to use color when written to the terminal.
1370 column.ui::
1371 Specify whether supported commands should output in columns.
1372 This variable consists of a list of tokens separated by spaces
1373 or commas:
1374 +
1375 These options control when the feature should be enabled
1376 (defaults to 'never'):
1377 +
1378 --
1379 `always`;;
1380 always show in columns
1381 `never`;;
1382 never show in columns
1383 `auto`;;
1384 show in columns if the output is to the terminal
1385 --
1386 +
1387 These options control layout (defaults to 'column'). Setting any
1388 of these implies 'always' if none of 'always', 'never', or 'auto' are
1389 specified.
1390 +
1391 --
1392 `column`;;
1393 fill columns before rows
1394 `row`;;
1395 fill rows before columns
1396 `plain`;;
1397 show in one column
1398 --
1399 +
1400 Finally, these options can be combined with a layout option (defaults
1401 to 'nodense'):
1402 +
1403 --
1404 `dense`;;
1405 make unequal size columns to utilize more space
1406 `nodense`;;
1407 make equal size columns
1408 --
1410 column.branch::
1411 Specify whether to output branch listing in `git branch` in columns.
1412 See `column.ui` for details.
1414 column.clean::
1415 Specify the layout when list items in `git clean -i`, which always
1416 shows files and directories in columns. See `column.ui` for details.
1418 column.status::
1419 Specify whether to output untracked files in `git status` in columns.
1420 See `column.ui` for details.
1422 column.tag::
1423 Specify whether to output tag listing in `git tag` in columns.
1424 See `column.ui` for details.
1426 commit.cleanup::
1427 This setting overrides the default of the `--cleanup` option in
1428 `git commit`. See linkgit:git-commit[1] for details. Changing the
1429 default can be useful when you always want to keep lines that begin
1430 with comment character `#` in your log message, in which case you
1431 would do `git config commit.cleanup whitespace` (note that you will
1432 have to remove the help lines that begin with `#` in the commit log
1433 template yourself, if you do this).
1435 commit.gpgSign::
1437 A boolean to specify whether all commits should be GPG signed.
1438 Use of this option when doing operations such as rebase can
1439 result in a large number of commits being signed. It may be
1440 convenient to use an agent to avoid typing your GPG passphrase
1441 several times.
1443 commit.status::
1444 A boolean to enable/disable inclusion of status information in the
1445 commit message template when using an editor to prepare the commit
1446 message. Defaults to true.
1448 commit.template::
1449 Specify the pathname of a file to use as the template for
1450 new commit messages.
1452 commit.verbose::
1453 A boolean or int to specify the level of verbose with `git commit`.
1454 See linkgit:git-commit[1].
1456 credential.helper::
1457 Specify an external helper to be called when a username or
1458 password credential is needed; the helper may consult external
1459 storage to avoid prompting the user for the credentials. Note
1460 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1461 for details.
1463 credential.useHttpPath::
1464 When acquiring credentials, consider the "path" component of an http
1465 or https URL to be important. Defaults to false. See
1466 linkgit:gitcredentials[7] for more information.
1468 credential.username::
1469 If no username is set for a network authentication, use this username
1470 by default. See credential.<context>.* below, and
1471 linkgit:gitcredentials[7].
1473 credential.<url>.*::
1474 Any of the credential.* options above can be applied selectively to
1475 some credentials. For example "credential."
1476 would set the default username only for https connections to
1477 See linkgit:gitcredentials[7] for details on how URLs are
1478 matched.
1480 credentialCache.ignoreSIGHUP::
1481 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1483 completion.commands::
1484 This is only used by git-completion.bash to add or remove
1485 commands from the list of completed commands. Normally only
1486 porcelain commands and a few select others are completed. You
1487 can add more commands, separated by space, in this
1488 variable. Prefixing the command with '-' will remove it from
1489 the existing list.
1491 include::diff-config.txt[]
1493 difftool.<tool>.path::
1494 Override the path for the given tool. This is useful in case
1495 your tool is not in the PATH.
1497 difftool.<tool>.cmd::
1498 Specify the command to invoke the specified diff tool.
1499 The specified command is evaluated in shell with the following
1500 variables available: 'LOCAL' is set to the name of the temporary
1501 file containing the contents of the diff pre-image and 'REMOTE'
1502 is set to the name of the temporary file containing the contents
1503 of the diff post-image.
1505 difftool.prompt::
1506 Prompt before each invocation of the diff tool.
1508 fastimport.unpackLimit::
1509 If the number of objects imported by linkgit:git-fast-import[1]
1510 is below this limit, then the objects will be unpacked into
1511 loose object files. However if the number of imported objects
1512 equals or exceeds this limit then the pack will be stored as a
1513 pack. Storing the pack from a fast-import can make the import
1514 operation complete faster, especially on slow filesystems. If
1515 not set, the value of `transfer.unpackLimit` is used instead.
1517 include::fetch-config.txt[]
1519 include::format-config.txt[]
1521 filter.<driver>.clean::
1522 The command which is used to convert the content of a worktree
1523 file to a blob upon checkin. See linkgit:gitattributes[5] for
1524 details.
1526 filter.<driver>.smudge::
1527 The command which is used to convert the content of a blob
1528 object to a worktree file upon checkout. See
1529 linkgit:gitattributes[5] for details.
1531 fsck.<msg-id>::
1532 During fsck git may find issues with legacy data which
1533 wouldn't be generated by current versions of git, and which
1534 wouldn't be sent over the wire if `transfer.fsckObjects` was
1535 set. This feature is intended to support working with legacy
1536 repositories containing such data.
1537 +
1538 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1539 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1540 to clone or fetch it set `fetch.fsck.<msg-id>`.
1541 +
1542 The rest of the documentation discusses `fsck.*` for brevity, but the
1543 same applies for the corresponding `receive.fsck.*` and
1544 `fetch.<msg-id>.*`. variables.
1545 +
1546 Unlike variables like `color.ui` and `core.editor` the
1547 `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1548 fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1549 uniformly configure the same fsck settings in different circumstances
1550 all three of them they must all set to the same values.
1551 +
1552 When `fsck.<msg-id>` is set, errors can be switched to warnings and
1553 vice versa by configuring the `fsck.<msg-id>` setting where the
1554 `<msg-id>` is the fsck message ID and the value is one of `error`,
1555 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
1556 with the message ID, e.g. "missingEmail: invalid author/committer line
1557 - missing email" means that setting `fsck.missingEmail = ignore` will
1558 hide that issue.
1559 +
1560 In general, it is better to enumerate existing objects with problems
1561 with `fsck.skipList`, instead of listing the kind of breakages these
1562 problematic objects share to be ignored, as doing the latter will
1563 allow new instances of the same breakages go unnoticed.
1564 +
1565 Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1566 doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1567 will only cause git to warn.
1569 fsck.skipList::
1570 The path to a sorted list of object names (i.e. one SHA-1 per
1571 line) that are known to be broken in a non-fatal way and should
1572 be ignored. This feature is useful when an established project
1573 should be accepted despite early commits containing errors that
1574 can be safely ignored such as invalid committer email addresses.
1575 Note: corrupt objects cannot be skipped with this setting.
1576 +
1577 Like `fsck.<msg-id>` this variable has corresponding
1578 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1579 +
1580 Unlike variables like `color.ui` and `core.editor` the
1581 `receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1582 fall back on the `fsck.skipList` configuration if they aren't set. To
1583 uniformly configure the same fsck settings in different circumstances
1584 all three of them they must all set to the same values.
1586 gc.aggressiveDepth::
1587 The depth parameter used in the delta compression
1588 algorithm used by 'git gc --aggressive'. This defaults
1589 to 50.
1591 gc.aggressiveWindow::
1592 The window size parameter used in the delta compression
1593 algorithm used by 'git gc --aggressive'. This defaults
1594 to 250.
1597 When there are approximately more than this many loose
1598 objects in the repository, `git gc --auto` will pack them.
1599 Some Porcelain commands use this command to perform a
1600 light-weight garbage collection from time to time. The
1601 default value is 6700. Setting this to 0 disables it.
1603 gc.autoPackLimit::
1604 When there are more than this many packs that are not
1605 marked with `*.keep` file in the repository, `git gc
1606 --auto` consolidates them into one larger pack. The
1607 default value is 50. Setting this to 0 disables it.
1609 gc.autoDetach::
1610 Make `git gc --auto` return immediately and run in background
1611 if the system supports it. Default is true.
1613 gc.bigPackThreshold::
1614 If non-zero, all packs larger than this limit are kept when
1615 `git gc` is run. This is very similar to `--keep-base-pack`
1616 except that all packs that meet the threshold are kept, not
1617 just the base pack. Defaults to zero. Common unit suffixes of
1618 'k', 'm', or 'g' are supported.
1619 +
1620 Note that if the number of kept packs is more than gc.autoPackLimit,
1621 this configuration variable is ignored, all packs except the base pack
1622 will be repacked. After this the number of packs should go below
1623 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1625 gc.writeCommitGraph::
1626 If true, then gc will rewrite the commit-graph file when
1627 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1628 '--auto' the commit-graph will be updated if housekeeping is
1629 required. Default is false. See linkgit:git-commit-graph[1]
1630 for details.
1632 gc.logExpiry::
1633 If the file gc.log exists, then `git gc --auto` won't run
1634 unless that file is more than 'gc.logExpiry' old. Default is
1635 "". See `gc.pruneExpire` for more ways to specify its
1636 value.
1638 gc.packRefs::
1639 Running `git pack-refs` in a repository renders it
1640 unclonable by Git versions prior to over dumb
1641 transports such as HTTP. This variable determines whether
1642 'git gc' runs `git pack-refs`. This can be set to `notbare`
1643 to enable it within all non-bare repos or it can be set to a
1644 boolean value. The default is `true`.
1646 gc.pruneExpire::
1647 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1648 Override the grace period with this config variable. The value
1649 "now" may be used to disable this grace period and always prune
1650 unreachable objects immediately, or "never" may be used to
1651 suppress pruning. This feature helps prevent corruption when
1652 'git gc' runs concurrently with another process writing to the
1653 repository; see the "NOTES" section of linkgit:git-gc[1].
1655 gc.worktreePruneExpire::
1656 When 'git gc' is run, it calls
1657 'git worktree prune --expire 3.months.ago'.
1658 This config variable can be used to set a different grace
1659 period. The value "now" may be used to disable the grace
1660 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1661 may be used to suppress pruning.
1663 gc.reflogExpire::
1664 gc.<pattern>.reflogExpire::
1665 'git reflog expire' removes reflog entries older than
1666 this time; defaults to 90 days. The value "now" expires all
1667 entries immediately, and "never" suppresses expiration
1668 altogether. With "<pattern>" (e.g.
1669 "refs/stash") in the middle the setting applies only to
1670 the refs that match the <pattern>.
1672 gc.reflogExpireUnreachable::
1673 gc.<pattern>.reflogExpireUnreachable::
1674 'git reflog expire' removes reflog entries older than
1675 this time and are not reachable from the current tip;
1676 defaults to 30 days. The value "now" expires all entries
1677 immediately, and "never" suppresses expiration altogether.
1678 With "<pattern>" (e.g. "refs/stash")
1679 in the middle, the setting applies only to the refs that
1680 match the <pattern>.
1682 gc.rerereResolved::
1683 Records of conflicted merge you resolved earlier are
1684 kept for this many days when 'git rerere gc' is run.
1685 You can also use more human-readable "1.month.ago", etc.
1686 The default is 60 days. See linkgit:git-rerere[1].
1688 gc.rerereUnresolved::
1689 Records of conflicted merge you have not resolved are
1690 kept for this many days when 'git rerere gc' is run.
1691 You can also use more human-readable "1.month.ago", etc.
1692 The default is 15 days. See linkgit:git-rerere[1].
1694 include::gitcvs-config.txt[]
1696 gitweb.category::
1697 gitweb.description::
1698 gitweb.owner::
1699 gitweb.url::
1700 See linkgit:gitweb[1] for description.
1702 gitweb.avatar::
1703 gitweb.blame::
1704 gitweb.grep::
1705 gitweb.highlight::
1706 gitweb.patches::
1707 gitweb.pickaxe::
1708 gitweb.remote_heads::
1709 gitweb.showSizes::
1710 gitweb.snapshot::
1711 See linkgit:gitweb.conf[5] for description.
1713 grep.lineNumber::
1714 If set to true, enable `-n` option by default.
1716 grep.column::
1717 If set to true, enable the `--column` option by default.
1719 grep.patternType::
1720 Set the default matching behavior. Using a value of 'basic', 'extended',
1721 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1722 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1723 value 'default' will return to the default matching behavior.
1725 grep.extendedRegexp::
1726 If set to true, enable `--extended-regexp` option by default. This
1727 option is ignored when the `grep.patternType` option is set to a value
1728 other than 'default'.
1730 grep.threads::
1731 Number of grep worker threads to use.
1732 See `grep.threads` in linkgit:git-grep[1] for more information.
1734 grep.fallbackToNoIndex::
1735 If set to true, fall back to git grep --no-index if git grep
1736 is executed outside of a git repository. Defaults to false.
1738 gpg.program::
1739 Use this custom program instead of "`gpg`" found on `$PATH` when
1740 making or verifying a PGP signature. The program must support the
1741 same command-line interface as GPG, namely, to verify a detached
1742 signature, "`gpg --verify $file - <$signature`" is run, and the
1743 program is expected to signal a good signature by exiting with
1744 code 0, and to generate an ASCII-armored detached signature, the
1745 standard input of "`gpg -bsau $key`" is fed with the contents to be
1746 signed, and the program is expected to send the result to its
1747 standard output.
1749 gpg.format::
1750 Specifies which key format to use when signing with `--gpg-sign`.
1751 Default is "openpgp" and another possible value is "x509".
1753 gpg.<format>.program::
1754 Use this to customize the program used for the signing format you
1755 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1756 be used as a legacy synonym for `gpg.openpgp.program`. The default
1757 value for `gpg.x509.program` is "gpgsm".
1759 include::gui-config.txt[]
1761 guitool.<name>.cmd::
1762 Specifies the shell command line to execute when the corresponding item
1763 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1764 mandatory for every tool. The command is executed from the root of
1765 the working directory, and in the environment it receives the name of
1766 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1767 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1768 the head is detached, 'CUR_BRANCH' is empty).
1770 guitool.<name>.needsFile::
1771 Run the tool only if a diff is selected in the GUI. It guarantees
1772 that 'FILENAME' is not empty.
1774 guitool.<name>.noConsole::
1775 Run the command silently, without creating a window to display its
1776 output.
1778 guitool.<name>.noRescan::
1779 Don't rescan the working directory for changes after the tool
1780 finishes execution.
1782 guitool.<name>.confirm::
1783 Show a confirmation dialog before actually running the tool.
1785 guitool.<name>.argPrompt::
1786 Request a string argument from the user, and pass it to the tool
1787 through the `ARGS` environment variable. Since requesting an
1788 argument implies confirmation, the 'confirm' option has no effect
1789 if this is enabled. If the option is set to 'true', 'yes', or '1',
1790 the dialog uses a built-in generic prompt; otherwise the exact
1791 value of the variable is used.
1793 guitool.<name>.revPrompt::
1794 Request a single valid revision from the user, and set the
1795 `REVISION` environment variable. In other aspects this option
1796 is similar to 'argPrompt', and can be used together with it.
1798 guitool.<name>.revUnmerged::
1799 Show only unmerged branches in the 'revPrompt' subdialog.
1800 This is useful for tools similar to merge or rebase, but not
1801 for things like checkout or reset.
1803 guitool.<name>.title::
1804 Specifies the title to use for the prompt dialog. The default
1805 is the tool name.
1807 guitool.<name>.prompt::
1808 Specifies the general prompt string to display at the top of
1809 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1810 The default value includes the actual command.
1812 help.browser::
1813 Specify the browser that will be used to display help in the
1814 'web' format. See linkgit:git-help[1].
1816 help.format::
1817 Override the default help format used by linkgit:git-help[1].
1818 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1819 the default. 'web' and 'html' are the same.
1821 help.autoCorrect::
1822 Automatically correct and execute mistyped commands after
1823 waiting for the given number of deciseconds (0.1 sec). If more
1824 than one command can be deduced from the entered text, nothing
1825 will be executed. If the value of this option is negative,
1826 the corrected command will be executed immediately. If the
1827 value is 0 - the command will be just shown but not executed.
1828 This is the default.
1830 help.htmlPath::
1831 Specify the path where the HTML documentation resides. File system paths
1832 and URLs are supported. HTML pages will be prefixed with this path when
1833 help is displayed in the 'web' format. This defaults to the documentation
1834 path of your Git installation.
1836 http.proxy::
1837 Override the HTTP proxy, normally configured using the 'http_proxy',
1838 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1839 addition to the syntax understood by curl, it is possible to specify a
1840 proxy string with a user name but no password, in which case git will
1841 attempt to acquire one in the same way it does for other credentials. See
1842 linkgit:gitcredentials[7] for more information. The syntax thus is
1843 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1844 on a per-remote basis; see remote.<name>.proxy
1846 http.proxyAuthMethod::
1847 Set the method with which to authenticate against the HTTP proxy. This
1848 only takes effect if the configured proxy string contains a user name part
1849 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1850 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1851 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1852 variable. Possible values are:
1853 +
1854 --
1855 * `anyauth` - Automatically pick a suitable authentication method. It is
1856 assumed that the proxy answers an unauthenticated request with a 407
1857 status code and one or more Proxy-authenticate headers with supported
1858 authentication methods. This is the default.
1859 * `basic` - HTTP Basic authentication
1860 * `digest` - HTTP Digest authentication; this prevents the password from being
1861 transmitted to the proxy in clear text
1862 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1863 of `curl(1)`)
1864 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1865 --
1867 http.emptyAuth::
1868 Attempt authentication without seeking a username or password. This
1869 can be used to attempt GSS-Negotiate authentication without specifying
1870 a username in the URL, as libcurl normally requires a username for
1871 authentication.
1873 http.delegation::
1874 Control GSSAPI credential delegation. The delegation is disabled
1875 by default in libcurl since version 7.21.7. Set parameter to tell
1876 the server what it is allowed to delegate when it comes to user
1877 credentials. Used with GSS/kerberos. Possible values are:
1878 +
1879 --
1880 * `none` - Don't allow any delegation.
1881 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1882 Kerberos service ticket, which is a matter of realm policy.
1883 * `always` - Unconditionally allow the server to delegate.
1884 --
1887 http.extraHeader::
1888 Pass an additional HTTP header when communicating with a server. If
1889 more than one such entry exists, all of them are added as extra
1890 headers. To allow overriding the settings inherited from the system
1891 config, an empty value will reset the extra headers to the empty list.
1893 http.cookieFile::
1894 The pathname of a file containing previously stored cookie lines,
1895 which should be used
1896 in the Git http session, if they match the server. The file format
1897 of the file to read cookies from should be plain HTTP headers or
1898 the Netscape/Mozilla cookie file format (see `curl(1)`).
1899 NOTE that the file specified with http.cookieFile is used only as
1900 input unless http.saveCookies is set.
1902 http.saveCookies::
1903 If set, store cookies received during requests to the file specified by
1904 http.cookieFile. Has no effect if http.cookieFile is unset.
1906 http.sslVersion::
1907 The SSL version to use when negotiating an SSL connection, if you
1908 want to force the default. The available and default version
1909 depend on whether libcurl was built against NSS or OpenSSL and the
1910 particular configuration of the crypto library in use. Internally
1911 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1912 documentation for more details on the format of this option and
1913 for the ssl version supported. Actually the possible values of
1914 this option are:
1916 - sslv2
1917 - sslv3
1918 - tlsv1
1919 - tlsv1.0
1920 - tlsv1.1
1921 - tlsv1.2
1922 - tlsv1.3
1924 +
1925 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1926 To force git to use libcurl's default ssl version and ignore any
1927 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1928 empty string.
1930 http.sslCipherList::
1931 A list of SSL ciphers to use when negotiating an SSL connection.
1932 The available ciphers depend on whether libcurl was built against
1933 NSS or OpenSSL and the particular configuration of the crypto
1934 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1935 option; see the libcurl documentation for more details on the format
1936 of this list.
1937 +
1938 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1939 To force git to use libcurl's default cipher list and ignore any
1940 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1941 empty string.
1943 http.sslVerify::
1944 Whether to verify the SSL certificate when fetching or pushing
1945 over HTTPS. Defaults to true. Can be overridden by the
1946 `GIT_SSL_NO_VERIFY` environment variable.
1948 http.sslCert::
1949 File containing the SSL certificate when fetching or pushing
1950 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1951 variable.
1953 http.sslKey::
1954 File containing the SSL private key when fetching or pushing
1955 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1956 variable.
1958 http.sslCertPasswordProtected::
1959 Enable Git's password prompt for the SSL certificate. Otherwise
1960 OpenSSL will prompt the user, possibly many times, if the
1961 certificate or private key is encrypted. Can be overridden by the
1962 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1964 http.sslCAInfo::
1965 File containing the certificates to verify the peer with when
1966 fetching or pushing over HTTPS. Can be overridden by the
1967 `GIT_SSL_CAINFO` environment variable.
1969 http.sslCAPath::
1970 Path containing files with the CA certificates to verify the peer
1971 with when fetching or pushing over HTTPS. Can be overridden
1972 by the `GIT_SSL_CAPATH` environment variable.
1974 http.pinnedpubkey::
1975 Public key of the https service. It may either be the filename of
1976 a PEM or DER encoded public key file or a string starting with
1977 'sha256//' followed by the base64 encoded sha256 hash of the
1978 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1979 exit with an error if this option is set but not supported by
1980 cURL.
1982 http.sslTry::
1983 Attempt to use AUTH SSL/TLS and encrypted data transfers
1984 when connecting via regular FTP protocol. This might be needed
1985 if the FTP server requires it for security reasons or you wish
1986 to connect securely whenever remote FTP server supports it.
1987 Default is false since it might trigger certificate verification
1988 errors on misconfigured servers.
1990 http.maxRequests::
1991 How many HTTP requests to launch in parallel. Can be overridden
1992 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1994 http.minSessions::
1995 The number of curl sessions (counted across slots) to be kept across
1996 requests. They will not be ended with curl_easy_cleanup() until
1997 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1998 value will be capped at 1. Defaults to 1.
2000 http.postBuffer::
2001 Maximum size in bytes of the buffer used by smart HTTP
2002 transports when POSTing data to the remote system.
2003 For requests larger than this buffer size, HTTP/1.1 and
2004 Transfer-Encoding: chunked is used to avoid creating a
2005 massive pack file locally. Default is 1 MiB, which is
2006 sufficient for most requests.
2008 http.lowSpeedLimit, http.lowSpeedTime::
2009 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2010 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2011 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2012 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2014 http.noEPSV::
2015 A boolean which disables using of EPSV ftp command by curl.
2016 This can helpful with some "poor" ftp servers which don't
2017 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2018 environment variable. Default is false (curl will use EPSV).
2020 http.userAgent::
2021 The HTTP USER_AGENT string presented to an HTTP server. The default
2022 value represents the version of the client Git such as git/1.7.1.
2023 This option allows you to override this value to a more common value
2024 such as Mozilla/4.0. This may be necessary, for instance, if
2025 connecting through a firewall that restricts HTTP connections to a set
2026 of common USER_AGENT strings (but not including those like git/1.7.1).
2027 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2029 http.followRedirects::
2030 Whether git should follow HTTP redirects. If set to `true`, git
2031 will transparently follow any redirect issued by a server it
2032 encounters. If set to `false`, git will treat all redirects as
2033 errors. If set to `initial`, git will follow redirects only for
2034 the initial request to a remote, but not for subsequent
2035 follow-up HTTP requests. Since git uses the redirected URL as
2036 the base for the follow-up requests, this is generally
2037 sufficient. The default is `initial`.
2039 http.<url>.*::
2040 Any of the http.* options above can be applied selectively to some URLs.
2041 For a config key to match a URL, each element of the config key is
2042 compared to that of the URL, in the following order:
2043 +
2044 --
2045 . Scheme (e.g., `https` in ``). This field
2046 must match exactly between the config key and the URL.
2048 . Host/domain name (e.g., `` in ``).
2049 This field must match between the config key and the URL. It is
2050 possible to specify a `*` as part of the host name to match all subdomains
2051 at this level. `https://*` for example would match
2052 ``, but not ``.
2054 . Port number (e.g., `8080` in ``).
2055 This field must match exactly between the config key and the URL.
2056 Omitted port numbers are automatically converted to the correct
2057 default for the scheme before matching.
2059 . Path (e.g., `repo.git` in ``). The
2060 path field of the config key must match the path field of the URL
2061 either exactly or as a prefix of slash-delimited path elements. This means
2062 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2063 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2064 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2065 key with just path `foo/`).
2067 . User name (e.g., `user` in ``). If
2068 the config key has a user name it must match the user name in the
2069 URL exactly. If the config key does not have a user name, that
2070 config key will match a URL with any user name (including none),
2071 but at a lower precedence than a config key with a user name.
2072 --
2073 +
2074 The list above is ordered by decreasing precedence; a URL that matches
2075 a config key's path is preferred to one that matches its user name. For example,
2076 if the URL is `` a config key match of
2077 `` will be preferred over a config key match of
2078 ``.
2079 +
2080 All URLs are normalized before attempting any matching (the password part,
2081 if embedded in the URL, is always ignored for matching purposes) so that
2082 equivalent URLs that are simply spelled differently will match properly.
2083 Environment variable settings always override any matches. The URLs that are
2084 matched against are those given directly to Git commands. This means any URLs
2085 visited as a result of a redirection do not participate in matching.
2087 ssh.variant::
2088 By default, Git determines the command line arguments to use
2089 based on the basename of the configured SSH command (configured
2090 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2091 the config setting `core.sshCommand`). If the basename is
2092 unrecognized, Git will attempt to detect support of OpenSSH
2093 options by first invoking the configured SSH command with the
2094 `-G` (print configuration) option and will subsequently use
2095 OpenSSH options (if that is successful) or no options besides
2096 the host and remote command (if it fails).
2097 +
2098 The config variable `ssh.variant` can be set to override this detection.
2099 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2100 `tortoiseplink`, `simple` (no options except the host and remote command).
2101 The default auto-detection can be explicitly requested using the value
2102 `auto`. Any other value is treated as `ssh`. This setting can also be
2103 overridden via the environment variable `GIT_SSH_VARIANT`.
2104 +
2105 The current command-line parameters used for each variant are as
2106 follows:
2107 +
2108 --
2110 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2112 * `simple` - [username@]host command
2114 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2116 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2118 --
2119 +
2120 Except for the `simple` variant, command-line parameters are likely to
2121 change as git gains new features.
2123 i18n.commitEncoding::
2124 Character encoding the commit messages are stored in; Git itself
2125 does not care per se, but this information is necessary e.g. when
2126 importing commits from emails or in the gitk graphical history
2127 browser (and possibly at other places in the future or in other
2128 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2130 i18n.logOutputEncoding::
2131 Character encoding the commit messages are converted to when
2132 running 'git log' and friends.
2134 imap::
2135 The configuration variables in the 'imap' section are described
2136 in linkgit:git-imap-send[1].
2138 index.version::
2139 Specify the version with which new index files should be
2140 initialized. This does not affect existing repositories.
2142 init.templateDir::
2143 Specify the directory from which templates will be copied.
2144 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2146 instaweb.browser::
2147 Specify the program that will be used to browse your working
2148 repository in gitweb. See linkgit:git-instaweb[1].
2150 instaweb.httpd::
2151 The HTTP daemon command-line to start gitweb on your working
2152 repository. See linkgit:git-instaweb[1].
2154 instaweb.local::
2155 If true the web server started by linkgit:git-instaweb[1] will
2156 be bound to the local IP (
2158 instaweb.modulePath::
2159 The default module path for linkgit:git-instaweb[1] to use
2160 instead of /usr/lib/apache2/modules. Only used if httpd
2161 is Apache.
2163 instaweb.port::
2164 The port number to bind the gitweb httpd to. See
2165 linkgit:git-instaweb[1].
2167 interactive.singleKey::
2168 In interactive commands, allow the user to provide one-letter
2169 input with a single key (i.e., without hitting enter).
2170 Currently this is used by the `--patch` mode of
2171 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2172 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2173 setting is silently ignored if portable keystroke input
2174 is not available; requires the Perl module Term::ReadKey.
2176 interactive.diffFilter::
2177 When an interactive command (such as `git add --patch`) shows
2178 a colorized diff, git will pipe the diff through the shell
2179 command defined by this configuration variable. The command may
2180 mark up the diff further for human consumption, provided that it
2181 retains a one-to-one correspondence with the lines in the
2182 original diff. Defaults to disabled (no filtering).
2184 log.abbrevCommit::
2185 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2186 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2187 override this option with `--no-abbrev-commit`.
2190 Set the default date-time mode for the 'log' command.
2191 Setting a value for is similar to using 'git log''s
2192 `--date` option. See linkgit:git-log[1] for details.
2194 log.decorate::
2195 Print out the ref names of any commits that are shown by the log
2196 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2197 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2198 specified, the full ref name (including prefix) will be printed.
2199 If 'auto' is specified, then if the output is going to a terminal,
2200 the ref names are shown as if 'short' were given, otherwise no ref
2201 names are shown. This is the same as the `--decorate` option
2202 of the `git log`.
2204 log.follow::
2205 If `true`, `git log` will act as if the `--follow` option was used when
2206 a single <path> is given. This has the same limitations as `--follow`,
2207 i.e. it cannot be used to follow multiple files and does not work well
2208 on non-linear history.
2210 log.graphColors::
2211 A list of colors, separated by commas, that can be used to draw
2212 history lines in `git log --graph`.
2214 log.showRoot::
2215 If true, the initial commit will be shown as a big creation event.
2216 This is equivalent to a diff against an empty tree.
2217 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2218 normally hide the root commit will now show it. True by default.
2220 log.showSignature::
2221 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2222 linkgit:git-whatchanged[1] assume `--show-signature`.
2224 log.mailmap::
2225 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2226 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2228 mailinfo.scissors::
2229 If true, makes linkgit:git-mailinfo[1] (and therefore
2230 linkgit:git-am[1]) act by default as if the --scissors option
2231 was provided on the command-line. When active, this features
2232 removes everything from the message body before a scissors
2233 line (i.e. consisting mainly of ">8", "8<" and "-").
2235 mailmap.file::
2236 The location of an augmenting mailmap file. The default
2237 mailmap, located in the root of the repository, is loaded
2238 first, then the mailmap file pointed to by this variable.
2239 The location of the mailmap file may be in a repository
2240 subdirectory, or somewhere outside of the repository itself.
2241 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2243 mailmap.blob::
2244 Like `mailmap.file`, but consider the value as a reference to a
2245 blob in the repository. If both `mailmap.file` and
2246 `mailmap.blob` are given, both are parsed, with entries from
2247 `mailmap.file` taking precedence. In a bare repository, this
2248 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2249 defaults to empty.
2251 man.viewer::
2252 Specify the programs that may be used to display help in the
2253 'man' format. See linkgit:git-help[1].
2255 man.<tool>.cmd::
2256 Specify the command to invoke the specified man viewer. The
2257 specified command is evaluated in shell with the man page
2258 passed as argument. (See linkgit:git-help[1].)
2260 man.<tool>.path::
2261 Override the path for the given tool that may be used to
2262 display help in the 'man' format. See linkgit:git-help[1].
2264 include::merge-config.txt[]
2266 mergetool.<tool>.path::
2267 Override the path for the given tool. This is useful in case
2268 your tool is not in the PATH.
2270 mergetool.<tool>.cmd::
2271 Specify the command to invoke the specified merge tool. The
2272 specified command is evaluated in shell with the following
2273 variables available: 'BASE' is the name of a temporary file
2274 containing the common base of the files to be merged, if available;
2275 'LOCAL' is the name of a temporary file containing the contents of
2276 the file on the current branch; 'REMOTE' is the name of a temporary
2277 file containing the contents of the file from the branch being
2278 merged; 'MERGED' contains the name of the file to which the merge
2279 tool should write the results of a successful merge.
2281 mergetool.<tool>.trustExitCode::
2282 For a custom merge command, specify whether the exit code of
2283 the merge command can be used to determine whether the merge was
2284 successful. If this is not set to true then the merge target file
2285 timestamp is checked and the merge assumed to have been successful
2286 if the file has been updated, otherwise the user is prompted to
2287 indicate the success of the merge.
2289 mergetool.meld.hasOutput::
2290 Older versions of `meld` do not support the `--output` option.
2291 Git will attempt to detect whether `meld` supports `--output`
2292 by inspecting the output of `meld --help`. Configuring
2293 `mergetool.meld.hasOutput` will make Git skip these checks and
2294 use the configured value instead. Setting `mergetool.meld.hasOutput`
2295 to `true` tells Git to unconditionally use the `--output` option,
2296 and `false` avoids using `--output`.
2298 mergetool.keepBackup::
2299 After performing a merge, the original file with conflict markers
2300 can be saved as a file with a `.orig` extension. If this variable
2301 is set to `false` then this file is not preserved. Defaults to
2302 `true` (i.e. keep the backup files).
2304 mergetool.keepTemporaries::
2305 When invoking a custom merge tool, Git uses a set of temporary
2306 files to pass to the tool. If the tool returns an error and this
2307 variable is set to `true`, then these temporary files will be
2308 preserved, otherwise they will be removed after the tool has
2309 exited. Defaults to `false`.
2311 mergetool.writeToTemp::
2312 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2313 conflicting files in the worktree by default. Git will attempt
2314 to use a temporary directory for these files when set `true`.
2315 Defaults to `false`.
2317 mergetool.prompt::
2318 Prompt before each invocation of the merge resolution program.
2320 notes.mergeStrategy::
2321 Which merge strategy to choose by default when resolving notes
2322 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2323 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2324 section of linkgit:git-notes[1] for more information on each strategy.
2326 notes.<name>.mergeStrategy::
2327 Which merge strategy to choose when doing a notes merge into
2328 refs/notes/<name>. This overrides the more general
2329 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2330 linkgit:git-notes[1] for more information on the available strategies.
2332 notes.displayRef::
2333 The (fully qualified) refname from which to show notes when
2334 showing commit messages. The value of this variable can be set
2335 to a glob, in which case notes from all matching refs will be
2336 shown. You may also specify this configuration variable
2337 several times. A warning will be issued for refs that do not
2338 exist, but a glob that does not match any refs is silently
2339 ignored.
2340 +
2341 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2342 environment variable, which must be a colon separated list of refs or
2343 globs.
2344 +
2345 The effective value of "core.notesRef" (possibly overridden by
2346 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2347 displayed.
2349 notes.rewrite.<command>::
2350 When rewriting commits with <command> (currently `amend` or
2351 `rebase`) and this variable is set to `true`, Git
2352 automatically copies your notes from the original to the
2353 rewritten commit. Defaults to `true`, but see
2354 "notes.rewriteRef" below.
2356 notes.rewriteMode::
2357 When copying notes during a rewrite (see the
2358 "notes.rewrite.<command>" option), determines what to do if
2359 the target commit already has a note. Must be one of
2360 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2361 Defaults to `concatenate`.
2362 +
2363 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2364 environment variable.
2366 notes.rewriteRef::
2367 When copying notes during a rewrite, specifies the (fully
2368 qualified) ref whose notes should be copied. The ref may be a
2369 glob, in which case notes in all matching refs will be copied.
2370 You may also specify this configuration several times.
2371 +
2372 Does not have a default value; you must configure this variable to
2373 enable note rewriting. Set it to `refs/notes/commits` to enable
2374 rewriting for the default commit notes.
2375 +
2376 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2377 environment variable, which must be a colon separated list of refs or
2378 globs.
2380 pack.window::
2381 The size of the window used by linkgit:git-pack-objects[1] when no
2382 window size is given on the command line. Defaults to 10.
2384 pack.depth::
2385 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2386 maximum depth is given on the command line. Defaults to 50.
2387 Maximum value is 4095.
2389 pack.windowMemory::
2390 The maximum size of memory that is consumed by each thread
2391 in linkgit:git-pack-objects[1] for pack window memory when
2392 no limit is given on the command line. The value can be
2393 suffixed with "k", "m", or "g". When left unconfigured (or
2394 set explicitly to 0), there will be no limit.
2396 pack.compression::
2397 An integer -1..9, indicating the compression level for objects
2398 in a pack file. -1 is the zlib default. 0 means no
2399 compression, and 1..9 are various speed/size tradeoffs, 9 being
2400 slowest. If not set, defaults to core.compression. If that is
2401 not set, defaults to -1, the zlib default, which is "a default
2402 compromise between speed and compression (currently equivalent
2403 to level 6)."
2404 +
2405 Note that changing the compression level will not automatically recompress
2406 all existing objects. You can force recompression by passing the -F option
2407 to linkgit:git-repack[1].
2409 pack.island::
2410 An extended regular expression configuring a set of delta
2411 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
2412 for details.
2414 pack.islandCore::
2415 Specify an island name which gets to have its objects be
2416 packed first. This creates a kind of pseudo-pack at the front
2417 of one pack, so that the objects from the specified island are
2418 hopefully faster to copy into any pack that should be served
2419 to a user requesting these objects. In practice this means
2420 that the island specified should likely correspond to what is
2421 the most commonly cloned in the repo. See also "DELTA ISLANDS"
2422 in linkgit:git-pack-objects[1].
2424 pack.deltaCacheSize::
2425 The maximum memory in bytes used for caching deltas in
2426 linkgit:git-pack-objects[1] before writing them out to a pack.
2427 This cache is used to speed up the writing object phase by not
2428 having to recompute the final delta result once the best match
2429 for all objects is found. Repacking large repositories on machines
2430 which are tight with memory might be badly impacted by this though,
2431 especially if this cache pushes the system into swapping.
2432 A value of 0 means no limit. The smallest size of 1 byte may be
2433 used to virtually disable this cache. Defaults to 256 MiB.
2435 pack.deltaCacheLimit::
2436 The maximum size of a delta, that is cached in
2437 linkgit:git-pack-objects[1]. This cache is used to speed up the
2438 writing object phase by not having to recompute the final delta
2439 result once the best match for all objects is found.
2440 Defaults to 1000. Maximum value is 65535.
2442 pack.threads::
2443 Specifies the number of threads to spawn when searching for best
2444 delta matches. This requires that linkgit:git-pack-objects[1]
2445 be compiled with pthreads otherwise this option is ignored with a
2446 warning. This is meant to reduce packing time on multiprocessor
2447 machines. The required amount of memory for the delta search window
2448 is however multiplied by the number of threads.
2449 Specifying 0 will cause Git to auto-detect the number of CPU's
2450 and set the number of threads accordingly.
2452 pack.indexVersion::
2453 Specify the default pack index version. Valid values are 1 for
2454 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2455 the new pack index with capabilities for packs larger than 4 GB
2456 as well as proper protection against the repacking of corrupted
2457 packs. Version 2 is the default. Note that version 2 is enforced
2458 and this config option ignored whenever the corresponding pack is
2459 larger than 2 GB.
2460 +
2461 If you have an old Git that does not understand the version 2 `*.idx` file,
2462 cloning or fetching over a non native protocol (e.g. "http")
2463 that will copy both `*.pack` file and corresponding `*.idx` file from the
2464 other side may give you a repository that cannot be accessed with your
2465 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2466 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2467 the `*.idx` file.
2469 pack.packSizeLimit::
2470 The maximum size of a pack. This setting only affects
2471 packing to a file when repacking, i.e. the git:// protocol
2472 is unaffected. It can be overridden by the `--max-pack-size`
2473 option of linkgit:git-repack[1]. Reaching this limit results
2474 in the creation of multiple packfiles; which in turn prevents
2475 bitmaps from being created.
2476 The minimum size allowed is limited to 1 MiB.
2477 The default is unlimited.
2478 Common unit suffixes of 'k', 'm', or 'g' are
2479 supported.
2481 pack.useBitmaps::
2482 When true, git will use pack bitmaps (if available) when packing
2483 to stdout (e.g., during the server side of a fetch). Defaults to
2484 true. You should not generally need to turn this off unless
2485 you are debugging pack bitmaps.
2487 pack.writeBitmaps (deprecated)::
2488 This is a deprecated synonym for `repack.writeBitmaps`.
2490 pack.writeBitmapHashCache::
2491 When true, git will include a "hash cache" section in the bitmap
2492 index (if one is written). This cache can be used to feed git's
2493 delta heuristics, potentially leading to better deltas between
2494 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2495 between an older, bitmapped pack and objects that have been
2496 pushed since the last gc). The downside is that it consumes 4
2497 bytes per object of disk space, and that JGit's bitmap
2498 implementation does not understand it, causing it to complain if
2499 Git and JGit are used on the same repository. Defaults to false.
2501 pager.<cmd>::
2502 If the value is boolean, turns on or off pagination of the
2503 output of a particular Git subcommand when writing to a tty.
2504 Otherwise, turns on pagination for the subcommand using the
2505 pager specified by the value of `pager.<cmd>`. If `--paginate`
2506 or `--no-pager` is specified on the command line, it takes
2507 precedence over this option. To disable pagination for all
2508 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2510 pretty.<name>::
2511 Alias for a --pretty= format string, as specified in
2512 linkgit:git-log[1]. Any aliases defined here can be used just
2513 as the built-in pretty formats could. For example,
2514 running `git config pretty.changelog "format:* %H %s"`
2515 would cause the invocation `git log --pretty=changelog`
2516 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2517 Note that an alias with the same name as a built-in format
2518 will be silently ignored.
2520 protocol.allow::
2521 If set, provide a user defined default policy for all protocols which
2522 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2523 if unset, known-safe protocols (http, https, git, ssh, file) have a
2524 default policy of `always`, known-dangerous protocols (ext) have a
2525 default policy of `never`, and all other protocols have a default
2526 policy of `user`. Supported policies:
2527 +
2528 --
2530 * `always` - protocol is always able to be used.
2532 * `never` - protocol is never able to be used.
2534 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2535 either unset or has a value of 1. This policy should be used when you want a
2536 protocol to be directly usable by the user but don't want it used by commands which
2537 execute clone/fetch/push commands without user input, e.g. recursive
2538 submodule initialization.
2540 --
2542 protocol.<name>.allow::
2543 Set a policy to be used by protocol `<name>` with clone/fetch/push
2544 commands. See `protocol.allow` above for the available policies.
2545 +
2546 The protocol names currently used by git are:
2547 +
2548 --
2549 - `file`: any local file-based path (including `file://` URLs,
2550 or local paths)
2552 - `git`: the anonymous git protocol over a direct TCP
2553 connection (or proxy, if configured)
2555 - `ssh`: git over ssh (including `host:path` syntax,
2556 `ssh://`, etc).
2558 - `http`: git over http, both "smart http" and "dumb http".
2559 Note that this does _not_ include `https`; if you want to configure
2560 both, you must do so individually.
2562 - any external helpers are named by their protocol (e.g., use
2563 `hg` to allow the `git-remote-hg` helper)
2564 --
2566 protocol.version::
2567 Experimental. If set, clients will attempt to communicate with a
2568 server using the specified protocol version. If unset, no
2569 attempt will be made by the client to communicate using a
2570 particular protocol version, this results in protocol version 0
2571 being used.
2572 Supported versions:
2573 +
2574 --
2576 * `0` - the original wire protocol.
2578 * `1` - the original wire protocol with the addition of a version string
2579 in the initial response from the server.
2581 * `2` - link:technical/protocol-v2.html[wire protocol version 2].
2583 --
2585 include::pull-config.txt[]
2587 include::push-config.txt[]
2589 include::rebase-config.txt[]
2591 include::receive-config.txt[]
2593 remote.pushDefault::
2594 The remote to push to by default. Overrides
2595 `branch.<name>.remote` for all branches, and is overridden by
2596 `branch.<name>.pushRemote` for specific branches.
2598 remote.<name>.url::
2599 The URL of a remote repository. See linkgit:git-fetch[1] or
2600 linkgit:git-push[1].
2602 remote.<name>.pushurl::
2603 The push URL of a remote repository. See linkgit:git-push[1].
2605 remote.<name>.proxy::
2606 For remotes that require curl (http, https and ftp), the URL to
2607 the proxy to use for that remote. Set to the empty string to
2608 disable proxying for that remote.
2610 remote.<name>.proxyAuthMethod::
2611 For remotes that require curl (http, https and ftp), the method to use for
2612 authenticating against the proxy in use (probably set in
2613 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2615 remote.<name>.fetch::
2616 The default set of "refspec" for linkgit:git-fetch[1]. See
2617 linkgit:git-fetch[1].
2619 remote.<name>.push::
2620 The default set of "refspec" for linkgit:git-push[1]. See
2621 linkgit:git-push[1].
2623 remote.<name>.mirror::
2624 If true, pushing to this remote will automatically behave
2625 as if the `--mirror` option was given on the command line.
2627 remote.<name>.skipDefaultUpdate::
2628 If true, this remote will be skipped by default when updating
2629 using linkgit:git-fetch[1] or the `update` subcommand of
2630 linkgit:git-remote[1].
2632 remote.<name>.skipFetchAll::
2633 If true, this remote will be skipped by default when updating
2634 using linkgit:git-fetch[1] or the `update` subcommand of
2635 linkgit:git-remote[1].
2637 remote.<name>.receivepack::
2638 The default program to execute on the remote side when pushing. See
2639 option --receive-pack of linkgit:git-push[1].
2641 remote.<name>.uploadpack::
2642 The default program to execute on the remote side when fetching. See
2643 option --upload-pack of linkgit:git-fetch-pack[1].
2645 remote.<name>.tagOpt::
2646 Setting this value to --no-tags disables automatic tag following when
2647 fetching from remote <name>. Setting it to --tags will fetch every
2648 tag from remote <name>, even if they are not reachable from remote
2649 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2650 override this setting. See options --tags and --no-tags of
2651 linkgit:git-fetch[1].
2653 remote.<name>.vcs::
2654 Setting this to a value <vcs> will cause Git to interact with
2655 the remote with the git-remote-<vcs> helper.
2657 remote.<name>.prune::
2658 When set to true, fetching from this remote by default will also
2659 remove any remote-tracking references that no longer exist on the
2660 remote (as if the `--prune` option was given on the command line).
2661 Overrides `fetch.prune` settings, if any.
2663 remote.<name>.pruneTags::
2664 When set to true, fetching from this remote by default will also
2665 remove any local tags that no longer exist on the remote if pruning
2666 is activated in general via `remote.<name>.prune`, `fetch.prune` or
2667 `--prune`. Overrides `fetch.pruneTags` settings, if any.
2668 +
2669 See also `remote.<name>.prune` and the PRUNING section of
2670 linkgit:git-fetch[1].
2672 remotes.<group>::
2673 The list of remotes which are fetched by "git remote update
2674 <group>". See linkgit:git-remote[1].
2676 repack.useDeltaBaseOffset::
2677 By default, linkgit:git-repack[1] creates packs that use
2678 delta-base offset. If you need to share your repository with
2679 Git older than version 1.4.4, either directly or via a dumb
2680 protocol such as http, then you need to set this option to
2681 "false" and repack. Access from old Git versions over the
2682 native protocol are unaffected by this option.
2684 repack.packKeptObjects::
2685 If set to true, makes `git repack` act as if
2686 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2687 details. Defaults to `false` normally, but `true` if a bitmap
2688 index is being written (either via `--write-bitmap-index` or
2689 `repack.writeBitmaps`).
2691 repack.useDeltaIslands::
2692 If set to true, makes `git repack` act as if `--delta-islands`
2693 was passed. Defaults to `false`.
2695 repack.writeBitmaps::
2696 When true, git will write a bitmap index when packing all
2697 objects to disk (e.g., when `git repack -a` is run). This
2698 index can speed up the "counting objects" phase of subsequent
2699 packs created for clones and fetches, at the cost of some disk
2700 space and extra time spent on the initial repack. This has
2701 no effect if multiple packfiles are created.
2702 Defaults to false.
2704 rerere.autoUpdate::
2705 When set to true, `git-rerere` updates the index with the
2706 resulting contents after it cleanly resolves conflicts using
2707 previously recorded resolution. Defaults to false.
2709 rerere.enabled::
2710 Activate recording of resolved conflicts, so that identical
2711 conflict hunks can be resolved automatically, should they be
2712 encountered again. By default, linkgit:git-rerere[1] is
2713 enabled if there is an `rr-cache` directory under the
2714 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2715 repository.
2717 include::sendemail-config.txt[]
2719 sequence.editor::
2720 Text editor used by `git rebase -i` for editing the rebase instruction file.
2721 The value is meant to be interpreted by the shell when it is used.
2722 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
2723 When not configured the default commit message editor is used instead.
2725 showBranch.default::
2726 The default set of branches for linkgit:git-show-branch[1].
2727 See linkgit:git-show-branch[1].
2729 splitIndex.maxPercentChange::
2730 When the split index feature is used, this specifies the
2731 percent of entries the split index can contain compared to the
2732 total number of entries in both the split index and the shared
2733 index before a new shared index is written.
2734 The value should be between 0 and 100. If the value is 0 then
2735 a new shared index is always written, if it is 100 a new
2736 shared index is never written.
2737 By default the value is 20, so a new shared index is written
2738 if the number of entries in the split index would be greater
2739 than 20 percent of the total number of entries.
2740 See linkgit:git-update-index[1].
2742 splitIndex.sharedIndexExpire::
2743 When the split index feature is used, shared index files that
2744 were not modified since the time this variable specifies will
2745 be removed when a new shared index file is created. The value
2746 "now" expires all entries immediately, and "never" suppresses
2747 expiration altogether.
2748 The default value is "2.weeks.ago".
2749 Note that a shared index file is considered modified (for the
2750 purpose of expiration) each time a new split-index file is
2751 either created based on it or read from it.
2752 See linkgit:git-update-index[1].
2754 status.relativePaths::
2755 By default, linkgit:git-status[1] shows paths relative to the
2756 current directory. Setting this variable to `false` shows paths
2757 relative to the repository root (this was the default for Git
2758 prior to v1.5.4).
2760 status.short::
2761 Set to true to enable --short by default in linkgit:git-status[1].
2762 The option --no-short takes precedence over this variable.
2764 status.branch::
2765 Set to true to enable --branch by default in linkgit:git-status[1].
2766 The option --no-branch takes precedence over this variable.
2768 status.displayCommentPrefix::
2769 If set to true, linkgit:git-status[1] will insert a comment
2770 prefix before each output line (starting with
2771 `core.commentChar`, i.e. `#` by default). This was the
2772 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2773 Defaults to false.
2775 status.renameLimit::
2776 The number of files to consider when performing rename detection
2777 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
2778 the value of diff.renameLimit.
2780 status.renames::
2781 Whether and how Git detects renames in linkgit:git-status[1] and
2782 linkgit:git-commit[1] . If set to "false", rename detection is
2783 disabled. If set to "true", basic rename detection is enabled.
2784 If set to "copies" or "copy", Git will detect copies, as well.
2785 Defaults to the value of diff.renames.
2787 status.showStash::
2788 If set to true, linkgit:git-status[1] will display the number of
2789 entries currently stashed away.
2790 Defaults to false.
2792 status.showUntrackedFiles::
2793 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2794 files which are not currently tracked by Git. Directories which
2795 contain only untracked files, are shown with the directory name
2796 only. Showing untracked files means that Git needs to lstat() all
2797 the files in the whole repository, which might be slow on some
2798 systems. So, this variable controls how the commands displays
2799 the untracked files. Possible values are:
2800 +
2801 --
2802 * `no` - Show no untracked files.
2803 * `normal` - Show untracked files and directories.
2804 * `all` - Show also individual files in untracked directories.
2805 --
2806 +
2807 If this variable is not specified, it defaults to 'normal'.
2808 This variable can be overridden with the -u|--untracked-files option
2809 of linkgit:git-status[1] and linkgit:git-commit[1].
2811 status.submoduleSummary::
2812 Defaults to false.
2813 If this is set to a non zero number or true (identical to -1 or an
2814 unlimited number), the submodule summary will be enabled and a
2815 summary of commits for modified submodules will be shown (see
2816 --summary-limit option of linkgit:git-submodule[1]). Please note
2817 that the summary output command will be suppressed for all
2818 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2819 for those submodules where `submodule.<name>.ignore=all`. The only
2820 exception to that rule is that status and commit will show staged
2821 submodule changes. To
2822 also view the summary for ignored submodules you can either use
2823 the --ignore-submodules=dirty command-line option or the 'git
2824 submodule summary' command, which shows a similar output but does
2825 not honor these settings.
2827 stash.showPatch::
2828 If this is set to true, the `git stash show` command without an
2829 option will show the stash entry in patch form. Defaults to false.
2830 See description of 'show' command in linkgit:git-stash[1].
2832 stash.showStat::
2833 If this is set to true, the `git stash show` command without an
2834 option will show diffstat of the stash entry. Defaults to true.
2835 See description of 'show' command in linkgit:git-stash[1].
2837 include::submodule-config.txt[]
2839 tag.forceSignAnnotated::
2840 A boolean to specify whether annotated tags created should be GPG signed.
2841 If `--annotate` is specified on the command line, it takes
2842 precedence over this option.
2844 tag.sort::
2845 This variable controls the sort ordering of tags when displayed by
2846 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2847 value of this variable will be used as the default.
2849 tar.umask::
2850 This variable can be used to restrict the permission bits of
2851 tar archive entries. The default is 0002, which turns off the
2852 world write bit. The special value "user" indicates that the
2853 archiving user's umask will be used instead. See umask(2) and
2854 linkgit:git-archive[1].
2856 transfer.fsckObjects::
2857 When `fetch.fsckObjects` or `receive.fsckObjects` are
2858 not set, the value of this variable is used instead.
2859 Defaults to false.
2860 +
2861 When set, the fetch or receive will abort in the case of a malformed
2862 object or a link to a nonexistent object. In addition, various other
2863 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
2864 and potential security issues like the existence of a `.GIT` directory
2865 or a malicious `.gitmodules` file (see the release notes for v2.2.1
2866 and v2.17.1 for details). Other sanity and security checks may be
2867 added in future releases.
2868 +
2869 On the receiving side, failing fsckObjects will make those objects
2870 unreachable, see "QUARANTINE ENVIRONMENT" in
2871 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
2872 instead be left unreferenced in the repository.
2873 +
2874 Due to the non-quarantine nature of the `fetch.fsckObjects`
2875 implementation it can not be relied upon to leave the object store
2876 clean like `receive.fsckObjects` can.
2877 +
2878 As objects are unpacked they're written to the object store, so there
2879 can be cases where malicious objects get introduced even though the
2880 "fetch" failed, only to have a subsequent "fetch" succeed because only
2881 new incoming objects are checked, not those that have already been
2882 written to the object store. That difference in behavior should not be
2883 relied upon. In the future, such objects may be quarantined for
2884 "fetch" as well.
2885 +
2886 For now, the paranoid need to find some way to emulate the quarantine
2887 environment if they'd like the same protection as "push". E.g. in the
2888 case of an internal mirror do the mirroring in two steps, one to fetch
2889 the untrusted objects, and then do a second "push" (which will use the
2890 quarantine) to another internal repo, and have internal clients
2891 consume this pushed-to repository, or embargo internal fetches and
2892 only allow them once a full "fsck" has run (and no new fetches have
2893 happened in the meantime).
2895 transfer.hideRefs::
2896 String(s) `receive-pack` and `upload-pack` use to decide which
2897 refs to omit from their initial advertisements. Use more than
2898 one definition to specify multiple prefix strings. A ref that is
2899 under the hierarchies listed in the value of this variable is
2900 excluded, and is hidden when responding to `git push` or `git
2901 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2902 program-specific versions of this config.
2903 +
2904 You may also include a `!` in front of the ref name to negate the entry,
2905 explicitly exposing it, even if an earlier entry marked it as hidden.
2906 If you have multiple hideRefs values, later entries override earlier ones
2907 (and entries in more-specific config files override less-specific ones).
2908 +
2909 If a namespace is in use, the namespace prefix is stripped from each
2910 reference before it is matched against `transfer.hiderefs` patterns.
2911 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2912 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2913 is omitted from the advertisements but `refs/heads/master` and
2914 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2915 "have" lines. In order to match refs before stripping, add a `^` in front of
2916 the ref name. If you combine `!` and `^`, `!` must be specified first.
2917 +
2918 Even if you hide refs, a client may still be able to steal the target
2919 objects via the techniques described in the "SECURITY" section of the
2920 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
2921 separate repository.
2923 transfer.unpackLimit::
2924 When `fetch.unpackLimit` or `receive.unpackLimit` are
2925 not set, the value of this variable is used instead.
2926 The default value is 100.
2928 uploadarchive.allowUnreachable::
2929 If true, allow clients to use `git archive --remote` to request
2930 any tree, whether reachable from the ref tips or not. See the
2931 discussion in the "SECURITY" section of
2932 linkgit:git-upload-archive[1] for more details. Defaults to
2933 `false`.
2935 uploadpack.hideRefs::
2936 This variable is the same as `transfer.hideRefs`, but applies
2937 only to `upload-pack` (and so affects only fetches, not pushes).
2938 An attempt to fetch a hidden ref by `git fetch` will fail. See
2939 also `uploadpack.allowTipSHA1InWant`.
2941 uploadpack.allowTipSHA1InWant::
2942 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2943 to accept a fetch request that asks for an object at the tip
2944 of a hidden ref (by default, such a request is rejected).
2945 See also `uploadpack.hideRefs`. Even if this is false, a client
2946 may be able to steal objects via the techniques described in the
2947 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
2948 best to keep private data in a separate repository.
2950 uploadpack.allowReachableSHA1InWant::
2951 Allow `upload-pack` to accept a fetch request that asks for an
2952 object that is reachable from any ref tip. However, note that
2953 calculating object reachability is computationally expensive.
2954 Defaults to `false`. Even if this is false, a client may be able
2955 to steal objects via the techniques described in the "SECURITY"
2956 section of the linkgit:gitnamespaces[7] man page; it's best to
2957 keep private data in a separate repository.
2959 uploadpack.allowAnySHA1InWant::
2960 Allow `upload-pack` to accept a fetch request that asks for any
2961 object at all.
2962 Defaults to `false`.
2964 uploadpack.keepAlive::
2965 When `upload-pack` has started `pack-objects`, there may be a
2966 quiet period while `pack-objects` prepares the pack. Normally
2967 it would output progress information, but if `--quiet` was used
2968 for the fetch, `pack-objects` will output nothing at all until
2969 the pack data begins. Some clients and networks may consider
2970 the server to be hung and give up. Setting this option instructs
2971 `upload-pack` to send an empty keepalive packet every
2972 `uploadpack.keepAlive` seconds. Setting this option to 0
2973 disables keepalive packets entirely. The default is 5 seconds.
2975 uploadpack.packObjectsHook::
2976 If this option is set, when `upload-pack` would run
2977 `git pack-objects` to create a packfile for a client, it will
2978 run this shell command instead. The `pack-objects` command and
2979 arguments it _would_ have run (including the `git pack-objects`
2980 at the beginning) are appended to the shell command. The stdin
2981 and stdout of the hook are treated as if `pack-objects` itself
2982 was run. I.e., `upload-pack` will feed input intended for
2983 `pack-objects` to the hook, and expects a completed packfile on
2984 stdout.
2986 uploadpack.allowFilter::
2987 If this option is set, `upload-pack` will support partial
2988 clone and partial fetch object filtering.
2989 +
2990 Note that this configuration variable is ignored if it is seen in the
2991 repository-level config (this is a safety measure against fetching from
2992 untrusted repositories).
2994 uploadpack.allowRefInWant::
2995 If this option is set, `upload-pack` will support the `ref-in-want`
2996 feature of the protocol version 2 `fetch` command. This feature
2997 is intended for the benefit of load-balanced servers which may
2998 not have the same view of what OIDs their refs point to due to
2999 replication delay.
3001 url.<base>.insteadOf::
3002 Any URL that starts with this value will be rewritten to
3003 start, instead, with <base>. In cases where some site serves a
3004 large number of repositories, and serves them with multiple
3005 access methods, and some users need to use different access
3006 methods, this feature allows people to specify any of the
3007 equivalent URLs and have Git automatically rewrite the URL to
3008 the best alternative for the particular user, even for a
3009 never-before-seen repository on the site. When more than one
3010 insteadOf strings match a given URL, the longest match is used.
3011 +
3012 Note that any protocol restrictions will be applied to the rewritten
3013 URL. If the rewrite changes the URL to use a custom protocol or remote
3014 helper, you may need to adjust the `protocol.*.allow` config to permit
3015 the request. In particular, protocols you expect to use for submodules
3016 must be set to `always` rather than the default of `user`. See the
3017 description of `protocol.allow` above.
3019 url.<base>.pushInsteadOf::
3020 Any URL that starts with this value will not be pushed to;
3021 instead, it will be rewritten to start with <base>, and the
3022 resulting URL will be pushed to. In cases where some site serves
3023 a large number of repositories, and serves them with multiple
3024 access methods, some of which do not allow push, this feature
3025 allows people to specify a pull-only URL and have Git
3026 automatically use an appropriate URL to push, even for a
3027 never-before-seen repository on the site. When more than one
3028 pushInsteadOf strings match a given URL, the longest match is
3029 used. If a remote has an explicit pushurl, Git will ignore this
3030 setting for that remote.
3033 Your email address to be recorded in any newly created commits.
3034 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3035 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3038 Your full name to be recorded in any newly created commits.
3039 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3040 environment variables. See linkgit:git-commit-tree[1].
3042 user.useConfigOnly::
3043 Instruct Git to avoid trying to guess defaults for ``
3044 and ``, and instead retrieve the values only from the
3045 configuration. For example, if you have multiple email addresses
3046 and would like to use a different one for each repository, then
3047 with this configuration option set to `true` in the global config
3048 along with a name, Git will prompt you to set up an email before
3049 making new commits in a newly cloned repository.
3050 Defaults to `false`.
3052 user.signingKey::
3053 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3054 key you want it to automatically when creating a signed tag or
3055 commit, you can override the default selection with this variable.
3056 This option is passed unchanged to gpg's --local-user parameter,
3057 so you may specify a key using any method that gpg supports.
3059 versionsort.prereleaseSuffix (deprecated)::
3060 Deprecated alias for `versionsort.suffix`. Ignored if
3061 `versionsort.suffix` is set.
3063 versionsort.suffix::
3064 Even when version sort is used in linkgit:git-tag[1], tagnames
3065 with the same base version but different suffixes are still sorted
3066 lexicographically, resulting e.g. in prerelease tags appearing
3067 after the main release (e.g. "1.0-rc1" after "1.0"). This
3068 variable can be specified to determine the sorting order of tags
3069 with different suffixes.
3070 +
3071 By specifying a single suffix in this variable, any tagname containing
3072 that suffix will appear before the corresponding main release. E.g. if
3073 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3074 "1.0". If specified multiple times, once per suffix, then the order of
3075 suffixes in the configuration will determine the sorting order of tagnames
3076 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3077 configuration, then all "1.0-preX" tags will be listed before any
3078 "1.0-rcX" tags. The placement of the main release tag relative to tags
3079 with various suffixes can be determined by specifying the empty suffix
3080 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3081 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3082 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3083 "v4.8-bfsX".
3084 +
3085 If more than one suffixes match the same tagname, then that tagname will
3086 be sorted according to the suffix which starts at the earliest position in
3087 the tagname. If more than one different matching suffixes start at
3088 that earliest position, then that tagname will be sorted according to the
3089 longest of those suffixes.
3090 The sorting order between different suffixes is undefined if they are
3091 in multiple config files.
3093 web.browser::
3094 Specify a web browser that may be used by some commands.
3095 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3096 may use it.
3098 worktree.guessRemote::
3099 With `add`, if no branch argument, and neither of `-b` nor
3100 `-B` nor `--detach` are given, the command defaults to
3101 creating a new branch from HEAD. If `worktree.guessRemote` is
3102 set to true, `worktree add` tries to find a remote-tracking
3103 branch whose name uniquely matches the new branch name. If
3104 such a branch exists, it is checked out and set as "upstream"
3105 for the new branch. If no such match can be found, it falls
3106 back to creating a new branch from the current HEAD.