Merge branch 'ab/checkout-default-remote'
[git/git.git] / Documentation / config.txt
1 CONFIGURATION FILE
2 ------------------
3
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.
10
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.
19
20 Syntax
21 ~~~~~~
22
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.
26
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.
33
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:
37
38 --------
39 [section "subsection"]
40
41 --------
42
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.
51
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.
56
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.
63
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.
71
72 Inside double quotes, double quote `"` and backslash `\` characters
73 must be escaped: use `\"` for `"` and `\\` for `\`.
74
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.
79
80
81 Includes
82 ~~~~~~~~
83
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.
89
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.
94
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.
100
101 Conditional includes
102 ~~~~~~~~~~~~~~~~~~~~
103
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.
107
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:
111
112 `gitdir`::
113
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:
127
128 * If the pattern starts with `~/`, `~` will be substituted with the
129 content of the environment variable `HOME`.
130
131 * If the pattern starts with `./`, it is replaced with the directory
132 containing the current config file.
133
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`.
137
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.
141
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)
145
146 A few more notes on matching via `gitdir` and `gitdir/i`:
147
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
149
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.
159
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
162
163 Example
164 ~~~~~~~
165
166 # Core variables
167 [core]
168 ; Don't trust file modes
169 filemode = false
170
171 # Our diff algorithm
172 [diff]
173 external = /usr/local/bin/diff-wrapper
174 renames = true
175
176 [branch "devel"]
177 remote = origin
178 merge = refs/heads/devel
179
180 # Proxy settings
181 [core]
182 gitProxy="ssh" for "kernel.org"
183 gitProxy=default-proxy ; for the rest
184
185 [include]
186 path = /path/to/foo.inc ; include by absolute path
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
189
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
193
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
197
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
201
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 = foo.inc
207
208 Values
209 ~~~~~~
210
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.
214
215 boolean::
216
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.
220
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
223 is taken as true.
224
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).
231
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.
236
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.
269
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.
276
277
278 Variables
279 ~~~~~~~~~
280
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.
284
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.
289
290
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 --
373
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).
395
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'.
401
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.
416
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.
425
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.
430
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.
436
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].
443
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.
450
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.
454
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.
463
464 core.checkStat::
465 Determines which stat fields to match between the index
466 and work tree. The user can set this to 'default' or
467 'minimal'. Default (or explicitly 'default'), is to check
468 all fields, including the sub-second part of mtime and ctime.
469
470 core.quotePath::
471 Commands that output paths (e.g. 'ls-files', 'diff'), will
472 quote "unusual" characters in the pathname by enclosing the
473 pathname in double-quotes and escaping those characters with
474 backslashes in the same way C escapes control characters (e.g.
475 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
476 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
477 UTF-8). If this variable is set to false, bytes higher than
478 0x80 are not considered "unusual" any more. Double-quotes,
479 backslash and control characters are always escaped regardless
480 of the setting of this variable. A simple space character is
481 not considered "unusual". Many commands can output pathnames
482 completely verbatim using the `-z` option. The default value
483 is true.
484
485 core.eol::
486 Sets the line ending type to use in the working directory for
487 files that have the `text` property set when core.autocrlf is false.
488 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
489 native line ending. The default value is `native`. See
490 linkgit:gitattributes[5] for more information on end-of-line
491 conversion.
492
493 core.safecrlf::
494 If true, makes Git check if converting `CRLF` is reversible when
495 end-of-line conversion is active. Git will verify if a command
496 modifies a file in the work tree either directly or indirectly.
497 For example, committing a file followed by checking out the
498 same file should yield the original file in the work tree. If
499 this is not the case for the current setting of
500 `core.autocrlf`, Git will reject the file. The variable can
501 be set to "warn", in which case Git will only warn about an
502 irreversible conversion but continue the operation.
503 +
504 CRLF conversion bears a slight chance of corrupting data.
505 When it is enabled, Git will convert CRLF to LF during commit and LF to
506 CRLF during checkout. A file that contains a mixture of LF and
507 CRLF before the commit cannot be recreated by Git. For text
508 files this is the right thing to do: it corrects line endings
509 such that we have only LF line endings in the repository.
510 But for binary files that are accidentally classified as text the
511 conversion can corrupt data.
512 +
513 If you recognize such corruption early you can easily fix it by
514 setting the conversion type explicitly in .gitattributes. Right
515 after committing you still have the original file in your work
516 tree and this file is not yet corrupted. You can explicitly tell
517 Git that this file is binary and Git will handle the file
518 appropriately.
519 +
520 Unfortunately, the desired effect of cleaning up text files with
521 mixed line endings and the undesired effect of corrupting binary
522 files cannot be distinguished. In both cases CRLFs are removed
523 in an irreversible way. For text files this is the right thing
524 to do because CRLFs are line endings, while for binary files
525 converting CRLFs corrupts data.
526 +
527 Note, this safety check does not mean that a checkout will generate a
528 file identical to the original file for a different setting of
529 `core.eol` and `core.autocrlf`, but only for the current one. For
530 example, a text file with `LF` would be accepted with `core.eol=lf`
531 and could later be checked out with `core.eol=crlf`, in which case the
532 resulting file would contain `CRLF`, although the original file
533 contained `LF`. However, in both work trees the line endings would be
534 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
535 file with mixed line endings would be reported by the `core.safecrlf`
536 mechanism.
537
538 core.autocrlf::
539 Setting this variable to "true" is the same as setting
540 the `text` attribute to "auto" on all files and core.eol to "crlf".
541 Set to true if you want to have `CRLF` line endings in your
542 working directory and the repository has LF line endings.
543 This variable can be set to 'input',
544 in which case no output conversion is performed.
545
546 core.checkRoundtripEncoding::
547 A comma and/or whitespace separated list of encodings that Git
548 performs UTF-8 round trip checks on if they are used in an
549 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
550 The default value is `SHIFT-JIS`.
551
552 core.symlinks::
553 If false, symbolic links are checked out as small plain files that
554 contain the link text. linkgit:git-update-index[1] and
555 linkgit:git-add[1] will not change the recorded type to regular
556 file. Useful on filesystems like FAT that do not support
557 symbolic links.
558 +
559 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
560 will probe and set core.symlinks false if appropriate when the repository
561 is created.
562
563 core.gitProxy::
564 A "proxy command" to execute (as 'command host port') instead
565 of establishing direct connection to the remote server when
566 using the Git protocol for fetching. If the variable value is
567 in the "COMMAND for DOMAIN" format, the command is applied only
568 on hostnames ending with the specified domain string. This variable
569 may be set multiple times and is matched in the given order;
570 the first match wins.
571 +
572 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
573 (which always applies universally, without the special "for"
574 handling).
575 +
576 The special string `none` can be used as the proxy command to
577 specify that no proxy be used for a given domain pattern.
578 This is useful for excluding servers inside a firewall from
579 proxy use, while defaulting to a common proxy for external domains.
580
581 core.sshCommand::
582 If this variable is set, `git fetch` and `git push` will
583 use the specified command instead of `ssh` when they need to
584 connect to a remote system. The command is in the same form as
585 the `GIT_SSH_COMMAND` environment variable and is overridden
586 when the environment variable is set.
587
588 core.ignoreStat::
589 If true, Git will avoid using lstat() calls to detect if files have
590 changed by setting the "assume-unchanged" bit for those tracked files
591 which it has updated identically in both the index and working tree.
592 +
593 When files are modified outside of Git, the user will need to stage
594 the modified files explicitly (e.g. see 'Examples' section in
595 linkgit:git-update-index[1]).
596 Git will not normally detect changes to those files.
597 +
598 This is useful on systems where lstat() calls are very slow, such as
599 CIFS/Microsoft Windows.
600 +
601 False by default.
602
603 core.preferSymlinkRefs::
604 Instead of the default "symref" format for HEAD
605 and other symbolic reference files, use symbolic links.
606 This is sometimes needed to work with old scripts that
607 expect HEAD to be a symbolic link.
608
609 core.bare::
610 If true this repository is assumed to be 'bare' and has no
611 working directory associated with it. If this is the case a
612 number of commands that require a working directory will be
613 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
614 +
615 This setting is automatically guessed by linkgit:git-clone[1] or
616 linkgit:git-init[1] when the repository was created. By default a
617 repository that ends in "/.git" is assumed to be not bare (bare =
618 false), while all other repositories are assumed to be bare (bare
619 = true).
620
621 core.worktree::
622 Set the path to the root of the working tree.
623 If `GIT_COMMON_DIR` environment variable is set, core.worktree
624 is ignored and not used for determining the root of working tree.
625 This can be overridden by the `GIT_WORK_TREE` environment
626 variable and the `--work-tree` command-line option.
627 The value can be an absolute path or relative to the path to
628 the .git directory, which is either specified by --git-dir
629 or GIT_DIR, or automatically discovered.
630 If --git-dir or GIT_DIR is specified but none of
631 --work-tree, GIT_WORK_TREE and core.worktree is specified,
632 the current working directory is regarded as the top level
633 of your working tree.
634 +
635 Note that this variable is honored even when set in a configuration
636 file in a ".git" subdirectory of a directory and its value differs
637 from the latter directory (e.g. "/path/to/.git/config" has
638 core.worktree set to "/different/path"), which is most likely a
639 misconfiguration. Running Git commands in the "/path/to" directory will
640 still use "/different/path" as the root of the work tree and can cause
641 confusion unless you know what you are doing (e.g. you are creating a
642 read-only snapshot of the same index to a location different from the
643 repository's usual working tree).
644
645 core.logAllRefUpdates::
646 Enable the reflog. Updates to a ref <ref> is logged to the file
647 "`$GIT_DIR/logs/<ref>`", by appending the new and old
648 SHA-1, the date/time and the reason of the update, but
649 only when the file exists. If this configuration
650 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
651 file is automatically created for branch heads (i.e. under
652 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
653 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
654 If it is set to `always`, then a missing reflog is automatically
655 created for any ref under `refs/`.
656 +
657 This information can be used to determine what commit
658 was the tip of a branch "2 days ago".
659 +
660 This value is true by default in a repository that has
661 a working directory associated with it, and false by
662 default in a bare repository.
663
664 core.repositoryFormatVersion::
665 Internal variable identifying the repository format and layout
666 version.
667
668 core.sharedRepository::
669 When 'group' (or 'true'), the repository is made shareable between
670 several users in a group (making sure all the files and objects are
671 group-writable). When 'all' (or 'world' or 'everybody'), the
672 repository will be readable by all users, additionally to being
673 group-shareable. When 'umask' (or 'false'), Git will use permissions
674 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
675 files in the repository will have this mode value. '0xxx' will override
676 user's umask value (whereas the other options will only override
677 requested parts of the user's umask value). Examples: '0660' will make
678 the repo read/write-able for the owner and group, but inaccessible to
679 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
680 repository that is group-readable but not group-writable.
681 See linkgit:git-init[1]. False by default.
682
683 core.warnAmbiguousRefs::
684 If true, Git will warn you if the ref name you passed it is ambiguous
685 and might match multiple refs in the repository. True by default.
686
687 core.compression::
688 An integer -1..9, indicating a default compression level.
689 -1 is the zlib default. 0 means no compression,
690 and 1..9 are various speed/size tradeoffs, 9 being slowest.
691 If set, this provides a default to other compression variables,
692 such as `core.looseCompression` and `pack.compression`.
693
694 core.looseCompression::
695 An integer -1..9, indicating the compression level for objects that
696 are not in a pack file. -1 is the zlib default. 0 means no
697 compression, and 1..9 are various speed/size tradeoffs, 9 being
698 slowest. If not set, defaults to core.compression. If that is
699 not set, defaults to 1 (best speed).
700
701 core.packedGitWindowSize::
702 Number of bytes of a pack file to map into memory in a
703 single mapping operation. Larger window sizes may allow
704 your system to process a smaller number of large pack files
705 more quickly. Smaller window sizes will negatively affect
706 performance due to increased calls to the operating system's
707 memory manager, but may improve performance when accessing
708 a large number of large pack files.
709 +
710 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
711 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
712 be reasonable for all users/operating systems. You probably do
713 not need to adjust this value.
714 +
715 Common unit suffixes of 'k', 'm', or 'g' are supported.
716
717 core.packedGitLimit::
718 Maximum number of bytes to map simultaneously into memory
719 from pack files. If Git needs to access more than this many
720 bytes at once to complete an operation it will unmap existing
721 regions to reclaim virtual address space within the process.
722 +
723 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
724 unlimited) on 64 bit platforms.
725 This should be reasonable for all users/operating systems, except on
726 the largest projects. You probably do not need to adjust this value.
727 +
728 Common unit suffixes of 'k', 'm', or 'g' are supported.
729
730 core.deltaBaseCacheLimit::
731 Maximum number of bytes to reserve for caching base objects
732 that may be referenced by multiple deltified objects. By storing the
733 entire decompressed base objects in a cache Git is able
734 to avoid unpacking and decompressing frequently used base
735 objects multiple times.
736 +
737 Default is 96 MiB on all platforms. This should be reasonable
738 for all users/operating systems, except on the largest projects.
739 You probably do not need to adjust this value.
740 +
741 Common unit suffixes of 'k', 'm', or 'g' are supported.
742
743 core.bigFileThreshold::
744 Files larger than this size are stored deflated, without
745 attempting delta compression. Storing large files without
746 delta compression avoids excessive memory usage, at the
747 slight expense of increased disk usage. Additionally files
748 larger than this size are always treated as binary.
749 +
750 Default is 512 MiB on all platforms. This should be reasonable
751 for most projects as source code and other text files can still
752 be delta compressed, but larger binary media files won't be.
753 +
754 Common unit suffixes of 'k', 'm', or 'g' are supported.
755
756 core.excludesFile::
757 Specifies the pathname to the file that contains patterns to
758 describe paths that are not meant to be tracked, in addition
759 to '.gitignore' (per-directory) and '.git/info/exclude'.
760 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
761 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
762 is used instead. See linkgit:gitignore[5].
763
764 core.askPass::
765 Some commands (e.g. svn and http interfaces) that interactively
766 ask for a password can be told to use an external program given
767 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
768 environment variable. If not set, fall back to the value of the
769 `SSH_ASKPASS` environment variable or, failing that, a simple password
770 prompt. The external program shall be given a suitable prompt as
771 command-line argument and write the password on its STDOUT.
772
773 core.attributesFile::
774 In addition to '.gitattributes' (per-directory) and
775 '.git/info/attributes', Git looks into this file for attributes
776 (see linkgit:gitattributes[5]). Path expansions are made the same
777 way as for `core.excludesFile`. Its default value is
778 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
779 set or empty, `$HOME/.config/git/attributes` is used instead.
780
781 core.hooksPath::
782 By default Git will look for your hooks in the
783 '$GIT_DIR/hooks' directory. Set this to different path,
784 e.g. '/etc/git/hooks', and Git will try to find your hooks in
785 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
786 in '$GIT_DIR/hooks/pre-receive'.
787 +
788 The path can be either absolute or relative. A relative path is
789 taken as relative to the directory where the hooks are run (see
790 the "DESCRIPTION" section of linkgit:githooks[5]).
791 +
792 This configuration variable is useful in cases where you'd like to
793 centrally configure your Git hooks instead of configuring them on a
794 per-repository basis, or as a more flexible and centralized
795 alternative to having an `init.templateDir` where you've changed
796 default hooks.
797
798 core.editor::
799 Commands such as `commit` and `tag` that let you edit
800 messages by launching an editor use the value of this
801 variable when it is set, and the environment variable
802 `GIT_EDITOR` is not set. See linkgit:git-var[1].
803
804 core.commentChar::
805 Commands such as `commit` and `tag` that let you edit
806 messages consider a line that begins with this character
807 commented, and removes them after the editor returns
808 (default '#').
809 +
810 If set to "auto", `git-commit` would select a character that is not
811 the beginning character of any line in existing commit messages.
812
813 core.filesRefLockTimeout::
814 The length of time, in milliseconds, to retry when trying to
815 lock an individual reference. Value 0 means not to retry at
816 all; -1 means to try indefinitely. Default is 100 (i.e.,
817 retry for 100ms).
818
819 core.packedRefsTimeout::
820 The length of time, in milliseconds, to retry when trying to
821 lock the `packed-refs` file. Value 0 means not to retry at
822 all; -1 means to try indefinitely. Default is 1000 (i.e.,
823 retry for 1 second).
824
825 sequence.editor::
826 Text editor used by `git rebase -i` for editing the rebase instruction file.
827 The value is meant to be interpreted by the shell when it is used.
828 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
829 When not configured the default commit message editor is used instead.
830
831 core.pager::
832 Text viewer for use by Git commands (e.g., 'less'). The value
833 is meant to be interpreted by the shell. The order of preference
834 is the `$GIT_PAGER` environment variable, then `core.pager`
835 configuration, then `$PAGER`, and then the default chosen at
836 compile time (usually 'less').
837 +
838 When the `LESS` environment variable is unset, Git sets it to `FRX`
839 (if `LESS` environment variable is set, Git does not change it at
840 all). If you want to selectively override Git's default setting
841 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
842 be passed to the shell by Git, which will translate the final
843 command to `LESS=FRX less -S`. The environment does not set the
844 `S` option but the command line does, instructing less to truncate
845 long lines. Similarly, setting `core.pager` to `less -+F` will
846 deactivate the `F` option specified by the environment from the
847 command-line, deactivating the "quit if one screen" behavior of
848 `less`. One can specifically activate some flags for particular
849 commands: for example, setting `pager.blame` to `less -S` enables
850 line truncation only for `git blame`.
851 +
852 Likewise, when the `LV` environment variable is unset, Git sets it
853 to `-c`. You can override this setting by exporting `LV` with
854 another value or setting `core.pager` to `lv +c`.
855
856 core.whitespace::
857 A comma separated list of common whitespace problems to
858 notice. 'git diff' will use `color.diff.whitespace` to
859 highlight them, and 'git apply --whitespace=error' will
860 consider them as errors. You can prefix `-` to disable
861 any of them (e.g. `-trailing-space`):
862 +
863 * `blank-at-eol` treats trailing whitespaces at the end of the line
864 as an error (enabled by default).
865 * `space-before-tab` treats a space character that appears immediately
866 before a tab character in the initial indent part of the line as an
867 error (enabled by default).
868 * `indent-with-non-tab` treats a line that is indented with space
869 characters instead of the equivalent tabs as an error (not enabled by
870 default).
871 * `tab-in-indent` treats a tab character in the initial indent part of
872 the line as an error (not enabled by default).
873 * `blank-at-eof` treats blank lines added at the end of file as an error
874 (enabled by default).
875 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
876 `blank-at-eof`.
877 * `cr-at-eol` treats a carriage-return at the end of line as
878 part of the line terminator, i.e. with it, `trailing-space`
879 does not trigger if the character before such a carriage-return
880 is not a whitespace (not enabled by default).
881 * `tabwidth=<n>` tells how many character positions a tab occupies; this
882 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
883 errors. The default tab width is 8. Allowed values are 1 to 63.
884
885 core.fsyncObjectFiles::
886 This boolean will enable 'fsync()' when writing object files.
887 +
888 This is a total waste of time and effort on a filesystem that orders
889 data writes properly, but can be useful for filesystems that do not use
890 journalling (traditional UNIX filesystems) or that only journal metadata
891 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
892
893 core.preloadIndex::
894 Enable parallel index preload for operations like 'git diff'
895 +
896 This can speed up operations like 'git diff' and 'git status' especially
897 on filesystems like NFS that have weak caching semantics and thus
898 relatively high IO latencies. When enabled, Git will do the
899 index comparison to the filesystem data in parallel, allowing
900 overlapping IO's. Defaults to true.
901
902 core.createObject::
903 You can set this to 'link', in which case a hardlink followed by
904 a delete of the source are used to make sure that object creation
905 will not overwrite existing objects.
906 +
907 On some file system/operating system combinations, this is unreliable.
908 Set this config setting to 'rename' there; However, This will remove the
909 check that makes sure that existing object files will not get overwritten.
910
911 core.notesRef::
912 When showing commit messages, also show notes which are stored in
913 the given ref. The ref must be fully qualified. If the given
914 ref does not exist, it is not an error but means that no
915 notes should be printed.
916 +
917 This setting defaults to "refs/notes/commits", and it can be overridden by
918 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
919
920 gc.commitGraph::
921 If true, then gc will rewrite the commit-graph file when
922 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
923 '--auto' the commit-graph will be updated if housekeeping is
924 required. Default is false. See linkgit:git-commit-graph[1]
925 for details.
926
927 core.useReplaceRefs::
928 If set to `false`, behave as if the `--no-replace-objects`
929 option was given on the command line. See linkgit:git[1] and
930 linkgit:git-replace[1] for more information.
931
932 core.sparseCheckout::
933 Enable "sparse checkout" feature. See section "Sparse checkout" in
934 linkgit:git-read-tree[1] for more information.
935
936 core.abbrev::
937 Set the length object names are abbreviated to. If
938 unspecified or set to "auto", an appropriate value is
939 computed based on the approximate number of packed objects
940 in your repository, which hopefully is enough for
941 abbreviated object names to stay unique for some time.
942 The minimum length is 4.
943
944 add.ignoreErrors::
945 add.ignore-errors (deprecated)::
946 Tells 'git add' to continue adding files when some files cannot be
947 added due to indexing errors. Equivalent to the `--ignore-errors`
948 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
949 as it does not follow the usual naming convention for configuration
950 variables.
951
952 alias.*::
953 Command aliases for the linkgit:git[1] command wrapper - e.g.
954 after defining "alias.last = cat-file commit HEAD", the invocation
955 "git last" is equivalent to "git cat-file commit HEAD". To avoid
956 confusion and troubles with script usage, aliases that
957 hide existing Git commands are ignored. Arguments are split by
958 spaces, the usual shell quoting and escaping is supported.
959 A quote pair or a backslash can be used to quote them.
960 +
961 If the alias expansion is prefixed with an exclamation point,
962 it will be treated as a shell command. For example, defining
963 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
964 "git new" is equivalent to running the shell command
965 "gitk --all --not ORIG_HEAD". Note that shell commands will be
966 executed from the top-level directory of a repository, which may
967 not necessarily be the current directory.
968 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
969 from the original current directory. See linkgit:git-rev-parse[1].
970
971 am.keepcr::
972 If true, git-am will call git-mailsplit for patches in mbox format
973 with parameter `--keep-cr`. In this case git-mailsplit will
974 not remove `\r` from lines ending with `\r\n`. Can be overridden
975 by giving `--no-keep-cr` from the command line.
976 See linkgit:git-am[1], linkgit:git-mailsplit[1].
977
978 am.threeWay::
979 By default, `git am` will fail if the patch does not apply cleanly. When
980 set to true, this setting tells `git am` to fall back on 3-way merge if
981 the patch records the identity of blobs it is supposed to apply to and
982 we have those blobs available locally (equivalent to giving the `--3way`
983 option from the command line). Defaults to `false`.
984 See linkgit:git-am[1].
985
986 apply.ignoreWhitespace::
987 When set to 'change', tells 'git apply' to ignore changes in
988 whitespace, in the same way as the `--ignore-space-change`
989 option.
990 When set to one of: no, none, never, false tells 'git apply' to
991 respect all whitespace differences.
992 See linkgit:git-apply[1].
993
994 apply.whitespace::
995 Tells 'git apply' how to handle whitespaces, in the same way
996 as the `--whitespace` option. See linkgit:git-apply[1].
997
998 blame.blankBoundary::
999 Show blank commit object name for boundary commits in
1000 linkgit:git-blame[1]. This option defaults to false.
1001
1002 blame.coloring::
1003 This determines the coloring scheme to be applied to blame
1004 output. It can be 'repeatedLines', 'highlightRecent',
1005 or 'none' which is the default.
1006
1007 blame.date::
1008 Specifies the format used to output dates in linkgit:git-blame[1].
1009 If unset the iso format is used. For supported values,
1010 see the discussion of the `--date` option at linkgit:git-log[1].
1011
1012 blame.showEmail::
1013 Show the author email instead of author name in linkgit:git-blame[1].
1014 This option defaults to false.
1015
1016 blame.showRoot::
1017 Do not treat root commits as boundaries in linkgit:git-blame[1].
1018 This option defaults to false.
1019
1020 branch.autoSetupMerge::
1021 Tells 'git branch' and 'git checkout' to set up new branches
1022 so that linkgit:git-pull[1] will appropriately merge from the
1023 starting point branch. Note that even if this option is not set,
1024 this behavior can be chosen per-branch using the `--track`
1025 and `--no-track` options. The valid settings are: `false` -- no
1026 automatic setup is done; `true` -- automatic setup is done when the
1027 starting point is a remote-tracking branch; `always` --
1028 automatic setup is done when the starting point is either a
1029 local branch or remote-tracking
1030 branch. This option defaults to true.
1031
1032 branch.autoSetupRebase::
1033 When a new branch is created with 'git branch' or 'git checkout'
1034 that tracks another branch, this variable tells Git to set
1035 up pull to rebase instead of merge (see "branch.<name>.rebase").
1036 When `never`, rebase is never automatically set to true.
1037 When `local`, rebase is set to true for tracked branches of
1038 other local branches.
1039 When `remote`, rebase is set to true for tracked branches of
1040 remote-tracking branches.
1041 When `always`, rebase will be set to true for all tracking
1042 branches.
1043 See "branch.autoSetupMerge" for details on how to set up a
1044 branch to track another branch.
1045 This option defaults to never.
1046
1047 branch.<name>.remote::
1048 When on branch <name>, it tells 'git fetch' and 'git push'
1049 which remote to fetch from/push to. The remote to push to
1050 may be overridden with `remote.pushDefault` (for all branches).
1051 The remote to push to, for the current branch, may be further
1052 overridden by `branch.<name>.pushRemote`. If no remote is
1053 configured, or if you are not on any branch, it defaults to
1054 `origin` for fetching and `remote.pushDefault` for pushing.
1055 Additionally, `.` (a period) is the current local repository
1056 (a dot-repository), see `branch.<name>.merge`'s final note below.
1057
1058 branch.<name>.pushRemote::
1059 When on branch <name>, it overrides `branch.<name>.remote` for
1060 pushing. It also overrides `remote.pushDefault` for pushing
1061 from branch <name>. When you pull from one place (e.g. your
1062 upstream) and push to another place (e.g. your own publishing
1063 repository), you would want to set `remote.pushDefault` to
1064 specify the remote to push to for all branches, and use this
1065 option to override it for a specific branch.
1066
1067 branch.<name>.merge::
1068 Defines, together with branch.<name>.remote, the upstream branch
1069 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1070 branch to merge and can also affect 'git push' (see push.default).
1071 When in branch <name>, it tells 'git fetch' the default
1072 refspec to be marked for merging in FETCH_HEAD. The value is
1073 handled like the remote part of a refspec, and must match a
1074 ref which is fetched from the remote given by
1075 "branch.<name>.remote".
1076 The merge information is used by 'git pull' (which at first calls
1077 'git fetch') to lookup the default branch for merging. Without
1078 this option, 'git pull' defaults to merge the first refspec fetched.
1079 Specify multiple values to get an octopus merge.
1080 If you wish to setup 'git pull' so that it merges into <name> from
1081 another branch in the local repository, you can point
1082 branch.<name>.merge to the desired branch, and use the relative path
1083 setting `.` (a period) for branch.<name>.remote.
1084
1085 branch.<name>.mergeOptions::
1086 Sets default options for merging into branch <name>. The syntax and
1087 supported options are the same as those of linkgit:git-merge[1], but
1088 option values containing whitespace characters are currently not
1089 supported.
1090
1091 branch.<name>.rebase::
1092 When true, rebase the branch <name> on top of the fetched branch,
1093 instead of merging the default branch from the default remote when
1094 "git pull" is run. See "pull.rebase" for doing this in a non
1095 branch-specific manner.
1096 +
1097 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1098 so that the local merge commits are included in the rebase (see
1099 linkgit:git-rebase[1] for details).
1100 +
1101 When preserve, also pass `--preserve-merges` along to 'git rebase'
1102 so that locally committed merge commits will not be flattened
1103 by running 'git pull'.
1104 +
1105 When the value is `interactive`, the rebase is run in interactive mode.
1106 +
1107 *NOTE*: this is a possibly dangerous operation; do *not* use
1108 it unless you understand the implications (see linkgit:git-rebase[1]
1109 for details).
1110
1111 branch.<name>.description::
1112 Branch description, can be edited with
1113 `git branch --edit-description`. Branch description is
1114 automatically added in the format-patch cover letter or
1115 request-pull summary.
1116
1117 browser.<tool>.cmd::
1118 Specify the command to invoke the specified browser. The
1119 specified command is evaluated in shell with the URLs passed
1120 as arguments. (See linkgit:git-web{litdd}browse[1].)
1121
1122 browser.<tool>.path::
1123 Override the path for the given tool that may be used to
1124 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1125 working repository in gitweb (see linkgit:git-instaweb[1]).
1126
1127 checkout.defaultRemote::
1128 When you run 'git checkout <something>' and only have one
1129 remote, it may implicitly fall back on checking out and
1130 tracking e.g. 'origin/<something>'. This stops working as soon
1131 as you have more than one remote with a '<something>'
1132 reference. This setting allows for setting the name of a
1133 preferred remote that should always win when it comes to
1134 disambiguation. The typical use-case is to set this to
1135 `origin`.
1136 +
1137 Currently this is used by linkgit:git-checkout[1] when 'git checkout
1138 <something>' will checkout the '<something>' branch on another remote,
1139 and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1140 remote branch. This setting might be used for other checkout-like
1141 commands or functionality in the future.
1142
1143 clean.requireForce::
1144 A boolean to make git-clean do nothing unless given -f,
1145 -i or -n. Defaults to true.
1146
1147 color.advice::
1148 A boolean to enable/disable color in hints (e.g. when a push
1149 failed, see `advice.*` for a list). May be set to `always`,
1150 `false` (or `never`) or `auto` (or `true`), in which case colors
1151 are used only when the error output goes to a terminal. If
1152 unset, then the value of `color.ui` is used (`auto` by default).
1153
1154 color.advice.hint::
1155 Use customized color for hints.
1156
1157 color.blame.highlightRecent::
1158 This can be used to color the metadata of a blame line depending
1159 on age of the line.
1160 +
1161 This setting should be set to a comma-separated list of color and date settings,
1162 starting and ending with a color, the dates should be set from oldest to newest.
1163 The metadata will be colored given the colors if the the line was introduced
1164 before the given timestamp, overwriting older timestamped colors.
1165 +
1166 Instead of an absolute timestamp relative timestamps work as well, e.g.
1167 2.weeks.ago is valid to address anything older than 2 weeks.
1168 +
1169 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1170 everything older than one year blue, recent changes between one month and
1171 one year old are kept white, and lines introduced within the last month are
1172 colored red.
1173
1174 color.blame.repeatedLines::
1175 Use the customized color for the part of git-blame output that
1176 is repeated meta information per line (such as commit id,
1177 author name, date and timezone). Defaults to cyan.
1178
1179 color.branch::
1180 A boolean to enable/disable color in the output of
1181 linkgit:git-branch[1]. May be set to `always`,
1182 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1183 only when the output is to a terminal. If unset, then the
1184 value of `color.ui` is used (`auto` by default).
1185
1186 color.branch.<slot>::
1187 Use customized color for branch coloration. `<slot>` is one of
1188 `current` (the current branch), `local` (a local branch),
1189 `remote` (a remote-tracking branch in refs/remotes/),
1190 `upstream` (upstream tracking branch), `plain` (other
1191 refs).
1192
1193 color.diff::
1194 Whether to use ANSI escape sequences to add color to patches.
1195 If this is set to `always`, linkgit:git-diff[1],
1196 linkgit:git-log[1], and linkgit:git-show[1] will use color
1197 for all patches. If it is set to `true` or `auto`, those
1198 commands will only use color when output is to the terminal.
1199 If unset, then the value of `color.ui` is used (`auto` by
1200 default).
1201 +
1202 This does not affect linkgit:git-format-patch[1] or the
1203 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1204 command line with the `--color[=<when>]` option.
1205
1206 diff.colorMoved::
1207 If set to either a valid `<mode>` or a true value, moved lines
1208 in a diff are colored differently, for details of valid modes
1209 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1210 true the default color mode will be used. When set to false,
1211 moved lines are not colored.
1212
1213 diff.colorMovedWS::
1214 When moved lines are colored using e.g. the `diff.colorMoved` setting,
1215 this option controls the `<mode>` how spaces are treated
1216 for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].
1217
1218 color.diff.<slot>::
1219 Use customized color for diff colorization. `<slot>` specifies
1220 which part of the patch to use the specified color, and is one
1221 of `context` (context text - `plain` is a historical synonym),
1222 `meta` (metainformation), `frag`
1223 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1224 `new` (added lines), `commit` (commit headers), `whitespace`
1225 (highlighting whitespace errors), `oldMoved` (deleted lines),
1226 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1227 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1228 `newMovedAlternativeDimmed` (See the '<mode>'
1229 setting of '--color-moved' in linkgit:git-diff[1] for details),
1230 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1231 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1232
1233 color.decorate.<slot>::
1234 Use customized color for 'git log --decorate' output. `<slot>` is one
1235 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1236 branches, remote-tracking branches, tags, stash and HEAD, respectively
1237 and `grafted` for grafted commits.
1238
1239 color.grep::
1240 When set to `always`, always highlight matches. When `false` (or
1241 `never`), never. When set to `true` or `auto`, use color only
1242 when the output is written to the terminal. If unset, then the
1243 value of `color.ui` is used (`auto` by default).
1244
1245 color.grep.<slot>::
1246 Use customized color for grep colorization. `<slot>` specifies which
1247 part of the line to use the specified color, and is one of
1248 +
1249 --
1250 `context`;;
1251 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1252 `filename`;;
1253 filename prefix (when not using `-h`)
1254 `function`;;
1255 function name lines (when using `-p`)
1256 `lineNumber`;;
1257 line number prefix (when using `-n`)
1258 `column`;;
1259 column number prefix (when using `--column`)
1260 `match`;;
1261 matching text (same as setting `matchContext` and `matchSelected`)
1262 `matchContext`;;
1263 matching text in context lines
1264 `matchSelected`;;
1265 matching text in selected lines
1266 `selected`;;
1267 non-matching text in selected lines
1268 `separator`;;
1269 separators between fields on a line (`:`, `-`, and `=`)
1270 and between hunks (`--`)
1271 --
1272
1273 color.interactive::
1274 When set to `always`, always use colors for interactive prompts
1275 and displays (such as those used by "git-add --interactive" and
1276 "git-clean --interactive"). When false (or `never`), never.
1277 When set to `true` or `auto`, use colors only when the output is
1278 to the terminal. If unset, then the value of `color.ui` is
1279 used (`auto` by default).
1280
1281 color.interactive.<slot>::
1282 Use customized color for 'git add --interactive' and 'git clean
1283 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1284 or `error`, for four distinct types of normal output from
1285 interactive commands.
1286
1287 color.pager::
1288 A boolean to enable/disable colored output when the pager is in
1289 use (default is true).
1290
1291 color.push::
1292 A boolean to enable/disable color in push errors. May be set to
1293 `always`, `false` (or `never`) or `auto` (or `true`), in which
1294 case colors are used only when the error output goes to a terminal.
1295 If unset, then the value of `color.ui` is used (`auto` by default).
1296
1297 color.push.error::
1298 Use customized color for push errors.
1299
1300 color.remote::
1301 If set, keywords at the start of the line are highlighted. The
1302 keywords are "error", "warning", "hint" and "success", and are
1303 matched case-insensitively. May be set to `always`, `false` (or
1304 `never`) or `auto` (or `true`). If unset, then the value of
1305 `color.ui` is used (`auto` by default).
1306
1307 color.remote.<slot>::
1308 Use customized color for each remote keyword. `<slot>` may be
1309 `hint`, `warning`, `success` or `error` which match the
1310 corresponding keyword.
1311
1312 color.showBranch::
1313 A boolean to enable/disable color in the output of
1314 linkgit:git-show-branch[1]. May be set to `always`,
1315 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1316 only when the output is to a terminal. If unset, then the
1317 value of `color.ui` is used (`auto` by default).
1318
1319 color.status::
1320 A boolean to enable/disable color in the output of
1321 linkgit:git-status[1]. May be set to `always`,
1322 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1323 only when the output is to a terminal. If unset, then the
1324 value of `color.ui` is used (`auto` by default).
1325
1326 color.status.<slot>::
1327 Use customized color for status colorization. `<slot>` is
1328 one of `header` (the header text of the status message),
1329 `added` or `updated` (files which are added but not committed),
1330 `changed` (files which are changed but not added in the index),
1331 `untracked` (files which are not tracked by Git),
1332 `branch` (the current branch),
1333 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1334 to red),
1335 `localBranch` or `remoteBranch` (the local and remote branch names,
1336 respectively, when branch and tracking information is displayed in the
1337 status short-format), or
1338 `unmerged` (files which have unmerged changes).
1339
1340 color.transport::
1341 A boolean to enable/disable color when pushes are rejected. May be
1342 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1343 case colors are used only when the error output goes to a terminal.
1344 If unset, then the value of `color.ui` is used (`auto` by default).
1345
1346 color.transport.rejected::
1347 Use customized color when a push was rejected.
1348
1349 color.ui::
1350 This variable determines the default value for variables such
1351 as `color.diff` and `color.grep` that control the use of color
1352 per command family. Its scope will expand as more commands learn
1353 configuration to set a default for the `--color` option. Set it
1354 to `false` or `never` if you prefer Git commands not to use
1355 color unless enabled explicitly with some other configuration
1356 or the `--color` option. Set it to `always` if you want all
1357 output not intended for machine consumption to use color, to
1358 `true` or `auto` (this is the default since Git 1.8.4) if you
1359 want such output to use color when written to the terminal.
1360
1361 column.ui::
1362 Specify whether supported commands should output in columns.
1363 This variable consists of a list of tokens separated by spaces
1364 or commas:
1365 +
1366 These options control when the feature should be enabled
1367 (defaults to 'never'):
1368 +
1369 --
1370 `always`;;
1371 always show in columns
1372 `never`;;
1373 never show in columns
1374 `auto`;;
1375 show in columns if the output is to the terminal
1376 --
1377 +
1378 These options control layout (defaults to 'column'). Setting any
1379 of these implies 'always' if none of 'always', 'never', or 'auto' are
1380 specified.
1381 +
1382 --
1383 `column`;;
1384 fill columns before rows
1385 `row`;;
1386 fill rows before columns
1387 `plain`;;
1388 show in one column
1389 --
1390 +
1391 Finally, these options can be combined with a layout option (defaults
1392 to 'nodense'):
1393 +
1394 --
1395 `dense`;;
1396 make unequal size columns to utilize more space
1397 `nodense`;;
1398 make equal size columns
1399 --
1400
1401 column.branch::
1402 Specify whether to output branch listing in `git branch` in columns.
1403 See `column.ui` for details.
1404
1405 column.clean::
1406 Specify the layout when list items in `git clean -i`, which always
1407 shows files and directories in columns. See `column.ui` for details.
1408
1409 column.status::
1410 Specify whether to output untracked files in `git status` in columns.
1411 See `column.ui` for details.
1412
1413 column.tag::
1414 Specify whether to output tag listing in `git tag` in columns.
1415 See `column.ui` for details.
1416
1417 commit.cleanup::
1418 This setting overrides the default of the `--cleanup` option in
1419 `git commit`. See linkgit:git-commit[1] for details. Changing the
1420 default can be useful when you always want to keep lines that begin
1421 with comment character `#` in your log message, in which case you
1422 would do `git config commit.cleanup whitespace` (note that you will
1423 have to remove the help lines that begin with `#` in the commit log
1424 template yourself, if you do this).
1425
1426 commit.gpgSign::
1427
1428 A boolean to specify whether all commits should be GPG signed.
1429 Use of this option when doing operations such as rebase can
1430 result in a large number of commits being signed. It may be
1431 convenient to use an agent to avoid typing your GPG passphrase
1432 several times.
1433
1434 commit.status::
1435 A boolean to enable/disable inclusion of status information in the
1436 commit message template when using an editor to prepare the commit
1437 message. Defaults to true.
1438
1439 commit.template::
1440 Specify the pathname of a file to use as the template for
1441 new commit messages.
1442
1443 commit.verbose::
1444 A boolean or int to specify the level of verbose with `git commit`.
1445 See linkgit:git-commit[1].
1446
1447 credential.helper::
1448 Specify an external helper to be called when a username or
1449 password credential is needed; the helper may consult external
1450 storage to avoid prompting the user for the credentials. Note
1451 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1452 for details.
1453
1454 credential.useHttpPath::
1455 When acquiring credentials, consider the "path" component of an http
1456 or https URL to be important. Defaults to false. See
1457 linkgit:gitcredentials[7] for more information.
1458
1459 credential.username::
1460 If no username is set for a network authentication, use this username
1461 by default. See credential.<context>.* below, and
1462 linkgit:gitcredentials[7].
1463
1464 credential.<url>.*::
1465 Any of the credential.* options above can be applied selectively to
1466 some credentials. For example "credential.https://example.com.username"
1467 would set the default username only for https connections to
1468 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1469 matched.
1470
1471 credentialCache.ignoreSIGHUP::
1472 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1473
1474 completion.commands::
1475 This is only used by git-completion.bash to add or remove
1476 commands from the list of completed commands. Normally only
1477 porcelain commands and a few select others are completed. You
1478 can add more commands, separated by space, in this
1479 variable. Prefixing the command with '-' will remove it from
1480 the existing list.
1481
1482 include::diff-config.txt[]
1483
1484 difftool.<tool>.path::
1485 Override the path for the given tool. This is useful in case
1486 your tool is not in the PATH.
1487
1488 difftool.<tool>.cmd::
1489 Specify the command to invoke the specified diff tool.
1490 The specified command is evaluated in shell with the following
1491 variables available: 'LOCAL' is set to the name of the temporary
1492 file containing the contents of the diff pre-image and 'REMOTE'
1493 is set to the name of the temporary file containing the contents
1494 of the diff post-image.
1495
1496 difftool.prompt::
1497 Prompt before each invocation of the diff tool.
1498
1499 fastimport.unpackLimit::
1500 If the number of objects imported by linkgit:git-fast-import[1]
1501 is below this limit, then the objects will be unpacked into
1502 loose object files. However if the number of imported objects
1503 equals or exceeds this limit then the pack will be stored as a
1504 pack. Storing the pack from a fast-import can make the import
1505 operation complete faster, especially on slow filesystems. If
1506 not set, the value of `transfer.unpackLimit` is used instead.
1507
1508 fetch.recurseSubmodules::
1509 This option can be either set to a boolean value or to 'on-demand'.
1510 Setting it to a boolean changes the behavior of fetch and pull to
1511 unconditionally recurse into submodules when set to true or to not
1512 recurse at all when set to false. When set to 'on-demand' (the default
1513 value), fetch and pull will only recurse into a populated submodule
1514 when its superproject retrieves a commit that updates the submodule's
1515 reference.
1516
1517 fetch.fsckObjects::
1518 If it is set to true, git-fetch-pack will check all fetched
1519 objects. See `transfer.fsckObjects` for what's
1520 checked. Defaults to false. If not set, the value of
1521 `transfer.fsckObjects` is used instead.
1522
1523 fetch.fsck.<msg-id>::
1524 Acts like `fsck.<msg-id>`, but is used by
1525 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1526 the `fsck.<msg-id>` documentation for details.
1527
1528 fetch.fsck.skipList::
1529 Acts like `fsck.skipList`, but is used by
1530 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1531 the `fsck.skipList` documentation for details.
1532
1533 fetch.unpackLimit::
1534 If the number of objects fetched over the Git native
1535 transfer is below this
1536 limit, then the objects will be unpacked into loose object
1537 files. However if the number of received objects equals or
1538 exceeds this limit then the received pack will be stored as
1539 a pack, after adding any missing delta bases. Storing the
1540 pack from a push can make the push operation complete faster,
1541 especially on slow filesystems. If not set, the value of
1542 `transfer.unpackLimit` is used instead.
1543
1544 fetch.prune::
1545 If true, fetch will automatically behave as if the `--prune`
1546 option was given on the command line. See also `remote.<name>.prune`
1547 and the PRUNING section of linkgit:git-fetch[1].
1548
1549 fetch.pruneTags::
1550 If true, fetch will automatically behave as if the
1551 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1552 if not set already. This allows for setting both this option
1553 and `fetch.prune` to maintain a 1=1 mapping to upstream
1554 refs. See also `remote.<name>.pruneTags` and the PRUNING
1555 section of linkgit:git-fetch[1].
1556
1557 fetch.output::
1558 Control how ref update status is printed. Valid values are
1559 `full` and `compact`. Default value is `full`. See section
1560 OUTPUT in linkgit:git-fetch[1] for detail.
1561
1562 fetch.negotiationAlgorithm::
1563 Control how information about the commits in the local repository is
1564 sent when negotiating the contents of the packfile to be sent by the
1565 server. Set to "skipping" to use an algorithm that skips commits in an
1566 effort to converge faster, but may result in a larger-than-necessary
1567 packfile; The default is "default" which instructs Git to use the default algorithm
1568 that never skips commits (unless the server has acknowledged it or one
1569 of its descendants).
1570 Unknown values will cause 'git fetch' to error out.
1571 +
1572 See also the `--negotiation-tip` option for linkgit:git-fetch[1].
1573
1574 format.attach::
1575 Enable multipart/mixed attachments as the default for
1576 'format-patch'. The value can also be a double quoted string
1577 which will enable attachments as the default and set the
1578 value as the boundary. See the --attach option in
1579 linkgit:git-format-patch[1].
1580
1581 format.from::
1582 Provides the default value for the `--from` option to format-patch.
1583 Accepts a boolean value, or a name and email address. If false,
1584 format-patch defaults to `--no-from`, using commit authors directly in
1585 the "From:" field of patch mails. If true, format-patch defaults to
1586 `--from`, using your committer identity in the "From:" field of patch
1587 mails and including a "From:" field in the body of the patch mail if
1588 different. If set to a non-boolean value, format-patch uses that
1589 value instead of your committer identity. Defaults to false.
1590
1591 format.numbered::
1592 A boolean which can enable or disable sequence numbers in patch
1593 subjects. It defaults to "auto" which enables it only if there
1594 is more than one patch. It can be enabled or disabled for all
1595 messages by setting it to "true" or "false". See --numbered
1596 option in linkgit:git-format-patch[1].
1597
1598 format.headers::
1599 Additional email headers to include in a patch to be submitted
1600 by mail. See linkgit:git-format-patch[1].
1601
1602 format.to::
1603 format.cc::
1604 Additional recipients to include in a patch to be submitted
1605 by mail. See the --to and --cc options in
1606 linkgit:git-format-patch[1].
1607
1608 format.subjectPrefix::
1609 The default for format-patch is to output files with the '[PATCH]'
1610 subject prefix. Use this variable to change that prefix.
1611
1612 format.signature::
1613 The default for format-patch is to output a signature containing
1614 the Git version number. Use this variable to change that default.
1615 Set this variable to the empty string ("") to suppress
1616 signature generation.
1617
1618 format.signatureFile::
1619 Works just like format.signature except the contents of the
1620 file specified by this variable will be used as the signature.
1621
1622 format.suffix::
1623 The default for format-patch is to output files with the suffix
1624 `.patch`. Use this variable to change that suffix (make sure to
1625 include the dot if you want it).
1626
1627 format.pretty::
1628 The default pretty format for log/show/whatchanged command,
1629 See linkgit:git-log[1], linkgit:git-show[1],
1630 linkgit:git-whatchanged[1].
1631
1632 format.thread::
1633 The default threading style for 'git format-patch'. Can be
1634 a boolean value, or `shallow` or `deep`. `shallow` threading
1635 makes every mail a reply to the head of the series,
1636 where the head is chosen from the cover letter, the
1637 `--in-reply-to`, and the first patch mail, in this order.
1638 `deep` threading makes every mail a reply to the previous one.
1639 A true boolean value is the same as `shallow`, and a false
1640 value disables threading.
1641
1642 format.signOff::
1643 A boolean value which lets you enable the `-s/--signoff` option of
1644 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1645 patch should be a conscious act and means that you certify you have
1646 the rights to submit this work under the same open source license.
1647 Please see the 'SubmittingPatches' document for further discussion.
1648
1649 format.coverLetter::
1650 A boolean that controls whether to generate a cover-letter when
1651 format-patch is invoked, but in addition can be set to "auto", to
1652 generate a cover-letter only when there's more than one patch.
1653
1654 format.outputDirectory::
1655 Set a custom directory to store the resulting files instead of the
1656 current working directory.
1657
1658 format.useAutoBase::
1659 A boolean value which lets you enable the `--base=auto` option of
1660 format-patch by default.
1661
1662 filter.<driver>.clean::
1663 The command which is used to convert the content of a worktree
1664 file to a blob upon checkin. See linkgit:gitattributes[5] for
1665 details.
1666
1667 filter.<driver>.smudge::
1668 The command which is used to convert the content of a blob
1669 object to a worktree file upon checkout. See
1670 linkgit:gitattributes[5] for details.
1671
1672 fsck.<msg-id>::
1673 During fsck git may find issues with legacy data which
1674 wouldn't be generated by current versions of git, and which
1675 wouldn't be sent over the wire if `transfer.fsckObjects` was
1676 set. This feature is intended to support working with legacy
1677 repositories containing such data.
1678 +
1679 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1680 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1681 to clone or fetch it set `fetch.fsck.<msg-id>`.
1682 +
1683 The rest of the documentation discusses `fsck.*` for brevity, but the
1684 same applies for the corresponding `receive.fsck.*` and
1685 `fetch.<msg-id>.*`. variables.
1686 +
1687 Unlike variables like `color.ui` and `core.editor` the
1688 `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1689 fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1690 uniformly configure the same fsck settings in different circumstances
1691 all three of them they must all set to the same values.
1692 +
1693 When `fsck.<msg-id>` is set, errors can be switched to warnings and
1694 vice versa by configuring the `fsck.<msg-id>` setting where the
1695 `<msg-id>` is the fsck message ID and the value is one of `error`,
1696 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
1697 with the message ID, e.g. "missingEmail: invalid author/committer line
1698 - missing email" means that setting `fsck.missingEmail = ignore` will
1699 hide that issue.
1700 +
1701 In general, it is better to enumerate existing objects with problems
1702 with `fsck.skipList`, instead of listing the kind of breakages these
1703 problematic objects share to be ignored, as doing the latter will
1704 allow new instances of the same breakages go unnoticed.
1705 +
1706 Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1707 doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1708 will only cause git to warn.
1709
1710 fsck.skipList::
1711 The path to a sorted list of object names (i.e. one SHA-1 per
1712 line) that are known to be broken in a non-fatal way and should
1713 be ignored. This feature is useful when an established project
1714 should be accepted despite early commits containing errors that
1715 can be safely ignored such as invalid committer email addresses.
1716 Note: corrupt objects cannot be skipped with this setting.
1717 +
1718 Like `fsck.<msg-id>` this variable has corresponding
1719 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1720 +
1721 Unlike variables like `color.ui` and `core.editor` the
1722 `receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1723 fall back on the `fsck.skipList` configuration if they aren't set. To
1724 uniformly configure the same fsck settings in different circumstances
1725 all three of them they must all set to the same values.
1726
1727 gc.aggressiveDepth::
1728 The depth parameter used in the delta compression
1729 algorithm used by 'git gc --aggressive'. This defaults
1730 to 50.
1731
1732 gc.aggressiveWindow::
1733 The window size parameter used in the delta compression
1734 algorithm used by 'git gc --aggressive'. This defaults
1735 to 250.
1736
1737 gc.auto::
1738 When there are approximately more than this many loose
1739 objects in the repository, `git gc --auto` will pack them.
1740 Some Porcelain commands use this command to perform a
1741 light-weight garbage collection from time to time. The
1742 default value is 6700. Setting this to 0 disables it.
1743
1744 gc.autoPackLimit::
1745 When there are more than this many packs that are not
1746 marked with `*.keep` file in the repository, `git gc
1747 --auto` consolidates them into one larger pack. The
1748 default value is 50. Setting this to 0 disables it.
1749
1750 gc.autoDetach::
1751 Make `git gc --auto` return immediately and run in background
1752 if the system supports it. Default is true.
1753
1754 gc.bigPackThreshold::
1755 If non-zero, all packs larger than this limit are kept when
1756 `git gc` is run. This is very similar to `--keep-base-pack`
1757 except that all packs that meet the threshold are kept, not
1758 just the base pack. Defaults to zero. Common unit suffixes of
1759 'k', 'm', or 'g' are supported.
1760 +
1761 Note that if the number of kept packs is more than gc.autoPackLimit,
1762 this configuration variable is ignored, all packs except the base pack
1763 will be repacked. After this the number of packs should go below
1764 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1765
1766 gc.logExpiry::
1767 If the file gc.log exists, then `git gc --auto` won't run
1768 unless that file is more than 'gc.logExpiry' old. Default is
1769 "1.day". See `gc.pruneExpire` for more ways to specify its
1770 value.
1771
1772 gc.packRefs::
1773 Running `git pack-refs` in a repository renders it
1774 unclonable by Git versions prior to 1.5.1.2 over dumb
1775 transports such as HTTP. This variable determines whether
1776 'git gc' runs `git pack-refs`. This can be set to `notbare`
1777 to enable it within all non-bare repos or it can be set to a
1778 boolean value. The default is `true`.
1779
1780 gc.pruneExpire::
1781 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1782 Override the grace period with this config variable. The value
1783 "now" may be used to disable this grace period and always prune
1784 unreachable objects immediately, or "never" may be used to
1785 suppress pruning. This feature helps prevent corruption when
1786 'git gc' runs concurrently with another process writing to the
1787 repository; see the "NOTES" section of linkgit:git-gc[1].
1788
1789 gc.worktreePruneExpire::
1790 When 'git gc' is run, it calls
1791 'git worktree prune --expire 3.months.ago'.
1792 This config variable can be used to set a different grace
1793 period. The value "now" may be used to disable the grace
1794 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1795 may be used to suppress pruning.
1796
1797 gc.reflogExpire::
1798 gc.<pattern>.reflogExpire::
1799 'git reflog expire' removes reflog entries older than
1800 this time; defaults to 90 days. The value "now" expires all
1801 entries immediately, and "never" suppresses expiration
1802 altogether. With "<pattern>" (e.g.
1803 "refs/stash") in the middle the setting applies only to
1804 the refs that match the <pattern>.
1805
1806 gc.reflogExpireUnreachable::
1807 gc.<pattern>.reflogExpireUnreachable::
1808 'git reflog expire' removes reflog entries older than
1809 this time and are not reachable from the current tip;
1810 defaults to 30 days. The value "now" expires all entries
1811 immediately, and "never" suppresses expiration altogether.
1812 With "<pattern>" (e.g. "refs/stash")
1813 in the middle, the setting applies only to the refs that
1814 match the <pattern>.
1815
1816 gc.rerereResolved::
1817 Records of conflicted merge you resolved earlier are
1818 kept for this many days when 'git rerere gc' is run.
1819 You can also use more human-readable "1.month.ago", etc.
1820 The default is 60 days. See linkgit:git-rerere[1].
1821
1822 gc.rerereUnresolved::
1823 Records of conflicted merge you have not resolved are
1824 kept for this many days when 'git rerere gc' is run.
1825 You can also use more human-readable "1.month.ago", etc.
1826 The default is 15 days. See linkgit:git-rerere[1].
1827
1828 gitcvs.commitMsgAnnotation::
1829 Append this string to each commit message. Set to empty string
1830 to disable this feature. Defaults to "via git-CVS emulator".
1831
1832 gitcvs.enabled::
1833 Whether the CVS server interface is enabled for this repository.
1834 See linkgit:git-cvsserver[1].
1835
1836 gitcvs.logFile::
1837 Path to a log file where the CVS server interface well... logs
1838 various stuff. See linkgit:git-cvsserver[1].
1839
1840 gitcvs.usecrlfattr::
1841 If true, the server will look up the end-of-line conversion
1842 attributes for files to determine the `-k` modes to use. If
1843 the attributes force Git to treat a file as text,
1844 the `-k` mode will be left blank so CVS clients will
1845 treat it as text. If they suppress text conversion, the file
1846 will be set with '-kb' mode, which suppresses any newline munging
1847 the client might otherwise do. If the attributes do not allow
1848 the file type to be determined, then `gitcvs.allBinary` is
1849 used. See linkgit:gitattributes[5].
1850
1851 gitcvs.allBinary::
1852 This is used if `gitcvs.usecrlfattr` does not resolve
1853 the correct '-kb' mode to use. If true, all
1854 unresolved files are sent to the client in
1855 mode '-kb'. This causes the client to treat them
1856 as binary files, which suppresses any newline munging it
1857 otherwise might do. Alternatively, if it is set to "guess",
1858 then the contents of the file are examined to decide if
1859 it is binary, similar to `core.autocrlf`.
1860
1861 gitcvs.dbName::
1862 Database used by git-cvsserver to cache revision information
1863 derived from the Git repository. The exact meaning depends on the
1864 used database driver, for SQLite (which is the default driver) this
1865 is a filename. Supports variable substitution (see
1866 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1867 Default: '%Ggitcvs.%m.sqlite'
1868
1869 gitcvs.dbDriver::
1870 Used Perl DBI driver. You can specify any available driver
1871 for this here, but it might not work. git-cvsserver is tested
1872 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1873 reported *not* to work with 'DBD::mysql'. Experimental feature.
1874 May not contain double colons (`:`). Default: 'SQLite'.
1875 See linkgit:git-cvsserver[1].
1876
1877 gitcvs.dbUser, gitcvs.dbPass::
1878 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1879 since SQLite has no concept of database users and/or passwords.
1880 'gitcvs.dbUser' supports variable substitution (see
1881 linkgit:git-cvsserver[1] for details).
1882
1883 gitcvs.dbTableNamePrefix::
1884 Database table name prefix. Prepended to the names of any
1885 database tables used, allowing a single database to be used
1886 for several repositories. Supports variable substitution (see
1887 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1888 characters will be replaced with underscores.
1889
1890 All gitcvs variables except for `gitcvs.usecrlfattr` and
1891 `gitcvs.allBinary` can also be specified as
1892 'gitcvs.<access_method>.<varname>' (where 'access_method'
1893 is one of "ext" and "pserver") to make them apply only for the given
1894 access method.
1895
1896 gitweb.category::
1897 gitweb.description::
1898 gitweb.owner::
1899 gitweb.url::
1900 See linkgit:gitweb[1] for description.
1901
1902 gitweb.avatar::
1903 gitweb.blame::
1904 gitweb.grep::
1905 gitweb.highlight::
1906 gitweb.patches::
1907 gitweb.pickaxe::
1908 gitweb.remote_heads::
1909 gitweb.showSizes::
1910 gitweb.snapshot::
1911 See linkgit:gitweb.conf[5] for description.
1912
1913 grep.lineNumber::
1914 If set to true, enable `-n` option by default.
1915
1916 grep.column::
1917 If set to true, enable the `--column` option by default.
1918
1919 grep.patternType::
1920 Set the default matching behavior. Using a value of 'basic', 'extended',
1921 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1922 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1923 value 'default' will return to the default matching behavior.
1924
1925 grep.extendedRegexp::
1926 If set to true, enable `--extended-regexp` option by default. This
1927 option is ignored when the `grep.patternType` option is set to a value
1928 other than 'default'.
1929
1930 grep.threads::
1931 Number of grep worker threads to use.
1932 See `grep.threads` in linkgit:git-grep[1] for more information.
1933
1934 grep.fallbackToNoIndex::
1935 If set to true, fall back to git grep --no-index if git grep
1936 is executed outside of a git repository. Defaults to false.
1937
1938 gpg.program::
1939 Use this custom program instead of "`gpg`" found on `$PATH` when
1940 making or verifying a PGP signature. The program must support the
1941 same command-line interface as GPG, namely, to verify a detached
1942 signature, "`gpg --verify $file - <$signature`" is run, and the
1943 program is expected to signal a good signature by exiting with
1944 code 0, and to generate an ASCII-armored detached signature, the
1945 standard input of "`gpg -bsau $key`" is fed with the contents to be
1946 signed, and the program is expected to send the result to its
1947 standard output.
1948
1949 gpg.format::
1950 Specifies which key format to use when signing with `--gpg-sign`.
1951 Default is "openpgp" and another possible value is "x509".
1952
1953 gpg.<format>.program::
1954 Use this to customize the program used for the signing format you
1955 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1956 be used as a legacy synonym for `gpg.openpgp.program`. The default
1957 value for `gpg.x509.program` is "gpgsm".
1958
1959 gui.commitMsgWidth::
1960 Defines how wide the commit message window is in the
1961 linkgit:git-gui[1]. "75" is the default.
1962
1963 gui.diffContext::
1964 Specifies how many context lines should be used in calls to diff
1965 made by the linkgit:git-gui[1]. The default is "5".
1966
1967 gui.displayUntracked::
1968 Determines if linkgit:git-gui[1] shows untracked files
1969 in the file list. The default is "true".
1970
1971 gui.encoding::
1972 Specifies the default encoding to use for displaying of
1973 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1974 It can be overridden by setting the 'encoding' attribute
1975 for relevant files (see linkgit:gitattributes[5]).
1976 If this option is not set, the tools default to the
1977 locale encoding.
1978
1979 gui.matchTrackingBranch::
1980 Determines if new branches created with linkgit:git-gui[1] should
1981 default to tracking remote branches with matching names or
1982 not. Default: "false".
1983
1984 gui.newBranchTemplate::
1985 Is used as suggested name when creating new branches using the
1986 linkgit:git-gui[1].
1987
1988 gui.pruneDuringFetch::
1989 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1990 performing a fetch. The default value is "false".
1991
1992 gui.trustmtime::
1993 Determines if linkgit:git-gui[1] should trust the file modification
1994 timestamp or not. By default the timestamps are not trusted.
1995
1996 gui.spellingDictionary::
1997 Specifies the dictionary used for spell checking commit messages in
1998 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1999 off.
2000
2001 gui.fastCopyBlame::
2002 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
2003 location detection. It makes blame significantly faster on huge
2004 repositories at the expense of less thorough copy detection.
2005
2006 gui.copyBlameThreshold::
2007 Specifies the threshold to use in 'git gui blame' original location
2008 detection, measured in alphanumeric characters. See the
2009 linkgit:git-blame[1] manual for more information on copy detection.
2010
2011 gui.blamehistoryctx::
2012 Specifies the radius of history context in days to show in
2013 linkgit:gitk[1] for the selected commit, when the `Show History
2014 Context` menu item is invoked from 'git gui blame'. If this
2015 variable is set to zero, the whole history is shown.
2016
2017 guitool.<name>.cmd::
2018 Specifies the shell command line to execute when the corresponding item
2019 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
2020 mandatory for every tool. The command is executed from the root of
2021 the working directory, and in the environment it receives the name of
2022 the tool as `GIT_GUITOOL`, the name of the currently selected file as
2023 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
2024 the head is detached, 'CUR_BRANCH' is empty).
2025
2026 guitool.<name>.needsFile::
2027 Run the tool only if a diff is selected in the GUI. It guarantees
2028 that 'FILENAME' is not empty.
2029
2030 guitool.<name>.noConsole::
2031 Run the command silently, without creating a window to display its
2032 output.
2033
2034 guitool.<name>.noRescan::
2035 Don't rescan the working directory for changes after the tool
2036 finishes execution.
2037
2038 guitool.<name>.confirm::
2039 Show a confirmation dialog before actually running the tool.
2040
2041 guitool.<name>.argPrompt::
2042 Request a string argument from the user, and pass it to the tool
2043 through the `ARGS` environment variable. Since requesting an
2044 argument implies confirmation, the 'confirm' option has no effect
2045 if this is enabled. If the option is set to 'true', 'yes', or '1',
2046 the dialog uses a built-in generic prompt; otherwise the exact
2047 value of the variable is used.
2048
2049 guitool.<name>.revPrompt::
2050 Request a single valid revision from the user, and set the
2051 `REVISION` environment variable. In other aspects this option
2052 is similar to 'argPrompt', and can be used together with it.
2053
2054 guitool.<name>.revUnmerged::
2055 Show only unmerged branches in the 'revPrompt' subdialog.
2056 This is useful for tools similar to merge or rebase, but not
2057 for things like checkout or reset.
2058
2059 guitool.<name>.title::
2060 Specifies the title to use for the prompt dialog. The default
2061 is the tool name.
2062
2063 guitool.<name>.prompt::
2064 Specifies the general prompt string to display at the top of
2065 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
2066 The default value includes the actual command.
2067
2068 help.browser::
2069 Specify the browser that will be used to display help in the
2070 'web' format. See linkgit:git-help[1].
2071
2072 help.format::
2073 Override the default help format used by linkgit:git-help[1].
2074 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2075 the default. 'web' and 'html' are the same.
2076
2077 help.autoCorrect::
2078 Automatically correct and execute mistyped commands after
2079 waiting for the given number of deciseconds (0.1 sec). If more
2080 than one command can be deduced from the entered text, nothing
2081 will be executed. If the value of this option is negative,
2082 the corrected command will be executed immediately. If the
2083 value is 0 - the command will be just shown but not executed.
2084 This is the default.
2085
2086 help.htmlPath::
2087 Specify the path where the HTML documentation resides. File system paths
2088 and URLs are supported. HTML pages will be prefixed with this path when
2089 help is displayed in the 'web' format. This defaults to the documentation
2090 path of your Git installation.
2091
2092 http.proxy::
2093 Override the HTTP proxy, normally configured using the 'http_proxy',
2094 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2095 addition to the syntax understood by curl, it is possible to specify a
2096 proxy string with a user name but no password, in which case git will
2097 attempt to acquire one in the same way it does for other credentials. See
2098 linkgit:gitcredentials[7] for more information. The syntax thus is
2099 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2100 on a per-remote basis; see remote.<name>.proxy
2101
2102 http.proxyAuthMethod::
2103 Set the method with which to authenticate against the HTTP proxy. This
2104 only takes effect if the configured proxy string contains a user name part
2105 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2106 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2107 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2108 variable. Possible values are:
2109 +
2110 --
2111 * `anyauth` - Automatically pick a suitable authentication method. It is
2112 assumed that the proxy answers an unauthenticated request with a 407
2113 status code and one or more Proxy-authenticate headers with supported
2114 authentication methods. This is the default.
2115 * `basic` - HTTP Basic authentication
2116 * `digest` - HTTP Digest authentication; this prevents the password from being
2117 transmitted to the proxy in clear text
2118 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2119 of `curl(1)`)
2120 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2121 --
2122
2123 http.emptyAuth::
2124 Attempt authentication without seeking a username or password. This
2125 can be used to attempt GSS-Negotiate authentication without specifying
2126 a username in the URL, as libcurl normally requires a username for
2127 authentication.
2128
2129 http.delegation::
2130 Control GSSAPI credential delegation. The delegation is disabled
2131 by default in libcurl since version 7.21.7. Set parameter to tell
2132 the server what it is allowed to delegate when it comes to user
2133 credentials. Used with GSS/kerberos. Possible values are:
2134 +
2135 --
2136 * `none` - Don't allow any delegation.
2137 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2138 Kerberos service ticket, which is a matter of realm policy.
2139 * `always` - Unconditionally allow the server to delegate.
2140 --
2141
2142
2143 http.extraHeader::
2144 Pass an additional HTTP header when communicating with a server. If
2145 more than one such entry exists, all of them are added as extra
2146 headers. To allow overriding the settings inherited from the system
2147 config, an empty value will reset the extra headers to the empty list.
2148
2149 http.cookieFile::
2150 The pathname of a file containing previously stored cookie lines,
2151 which should be used
2152 in the Git http session, if they match the server. The file format
2153 of the file to read cookies from should be plain HTTP headers or
2154 the Netscape/Mozilla cookie file format (see `curl(1)`).
2155 NOTE that the file specified with http.cookieFile is used only as
2156 input unless http.saveCookies is set.
2157
2158 http.saveCookies::
2159 If set, store cookies received during requests to the file specified by
2160 http.cookieFile. Has no effect if http.cookieFile is unset.
2161
2162 http.sslVersion::
2163 The SSL version to use when negotiating an SSL connection, if you
2164 want to force the default. The available and default version
2165 depend on whether libcurl was built against NSS or OpenSSL and the
2166 particular configuration of the crypto library in use. Internally
2167 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2168 documentation for more details on the format of this option and
2169 for the ssl version supported. Actually the possible values of
2170 this option are:
2171
2172 - sslv2
2173 - sslv3
2174 - tlsv1
2175 - tlsv1.0
2176 - tlsv1.1
2177 - tlsv1.2
2178 - tlsv1.3
2179
2180 +
2181 Can be overridden by the `GIT_SSL_VERSION` environment variable.
2182 To force git to use libcurl's default ssl version and ignore any
2183 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2184 empty string.
2185
2186 http.sslCipherList::
2187 A list of SSL ciphers to use when negotiating an SSL connection.
2188 The available ciphers depend on whether libcurl was built against
2189 NSS or OpenSSL and the particular configuration of the crypto
2190 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2191 option; see the libcurl documentation for more details on the format
2192 of this list.
2193 +
2194 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2195 To force git to use libcurl's default cipher list and ignore any
2196 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2197 empty string.
2198
2199 http.sslVerify::
2200 Whether to verify the SSL certificate when fetching or pushing
2201 over HTTPS. Defaults to true. Can be overridden by the
2202 `GIT_SSL_NO_VERIFY` environment variable.
2203
2204 http.sslCert::
2205 File containing the SSL certificate when fetching or pushing
2206 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2207 variable.
2208
2209 http.sslKey::
2210 File containing the SSL private key when fetching or pushing
2211 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2212 variable.
2213
2214 http.sslCertPasswordProtected::
2215 Enable Git's password prompt for the SSL certificate. Otherwise
2216 OpenSSL will prompt the user, possibly many times, if the
2217 certificate or private key is encrypted. Can be overridden by the
2218 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2219
2220 http.sslCAInfo::
2221 File containing the certificates to verify the peer with when
2222 fetching or pushing over HTTPS. Can be overridden by the
2223 `GIT_SSL_CAINFO` environment variable.
2224
2225 http.sslCAPath::
2226 Path containing files with the CA certificates to verify the peer
2227 with when fetching or pushing over HTTPS. Can be overridden
2228 by the `GIT_SSL_CAPATH` environment variable.
2229
2230 http.pinnedpubkey::
2231 Public key of the https service. It may either be the filename of
2232 a PEM or DER encoded public key file or a string starting with
2233 'sha256//' followed by the base64 encoded sha256 hash of the
2234 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2235 exit with an error if this option is set but not supported by
2236 cURL.
2237
2238 http.sslTry::
2239 Attempt to use AUTH SSL/TLS and encrypted data transfers
2240 when connecting via regular FTP protocol. This might be needed
2241 if the FTP server requires it for security reasons or you wish
2242 to connect securely whenever remote FTP server supports it.
2243 Default is false since it might trigger certificate verification
2244 errors on misconfigured servers.
2245
2246 http.maxRequests::
2247 How many HTTP requests to launch in parallel. Can be overridden
2248 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2249
2250 http.minSessions::
2251 The number of curl sessions (counted across slots) to be kept across
2252 requests. They will not be ended with curl_easy_cleanup() until
2253 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2254 value will be capped at 1. Defaults to 1.
2255
2256 http.postBuffer::
2257 Maximum size in bytes of the buffer used by smart HTTP
2258 transports when POSTing data to the remote system.
2259 For requests larger than this buffer size, HTTP/1.1 and
2260 Transfer-Encoding: chunked is used to avoid creating a
2261 massive pack file locally. Default is 1 MiB, which is
2262 sufficient for most requests.
2263
2264 http.lowSpeedLimit, http.lowSpeedTime::
2265 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2266 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2267 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2268 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2269
2270 http.noEPSV::
2271 A boolean which disables using of EPSV ftp command by curl.
2272 This can helpful with some "poor" ftp servers which don't
2273 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2274 environment variable. Default is false (curl will use EPSV).
2275
2276 http.userAgent::
2277 The HTTP USER_AGENT string presented to an HTTP server. The default
2278 value represents the version of the client Git such as git/1.7.1.
2279 This option allows you to override this value to a more common value
2280 such as Mozilla/4.0. This may be necessary, for instance, if
2281 connecting through a firewall that restricts HTTP connections to a set
2282 of common USER_AGENT strings (but not including those like git/1.7.1).
2283 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2284
2285 http.followRedirects::
2286 Whether git should follow HTTP redirects. If set to `true`, git
2287 will transparently follow any redirect issued by a server it
2288 encounters. If set to `false`, git will treat all redirects as
2289 errors. If set to `initial`, git will follow redirects only for
2290 the initial request to a remote, but not for subsequent
2291 follow-up HTTP requests. Since git uses the redirected URL as
2292 the base for the follow-up requests, this is generally
2293 sufficient. The default is `initial`.
2294
2295 http.<url>.*::
2296 Any of the http.* options above can be applied selectively to some URLs.
2297 For a config key to match a URL, each element of the config key is
2298 compared to that of the URL, in the following order:
2299 +
2300 --
2301 . Scheme (e.g., `https` in `https://example.com/`). This field
2302 must match exactly between the config key and the URL.
2303
2304 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2305 This field must match between the config key and the URL. It is
2306 possible to specify a `*` as part of the host name to match all subdomains
2307 at this level. `https://*.example.com/` for example would match
2308 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2309
2310 . Port number (e.g., `8080` in `http://example.com:8080/`).
2311 This field must match exactly between the config key and the URL.
2312 Omitted port numbers are automatically converted to the correct
2313 default for the scheme before matching.
2314
2315 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2316 path field of the config key must match the path field of the URL
2317 either exactly or as a prefix of slash-delimited path elements. This means
2318 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2319 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2320 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2321 key with just path `foo/`).
2322
2323 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2324 the config key has a user name it must match the user name in the
2325 URL exactly. If the config key does not have a user name, that
2326 config key will match a URL with any user name (including none),
2327 but at a lower precedence than a config key with a user name.
2328 --
2329 +
2330 The list above is ordered by decreasing precedence; a URL that matches
2331 a config key's path is preferred to one that matches its user name. For example,
2332 if the URL is `https://user@example.com/foo/bar` a config key match of
2333 `https://example.com/foo` will be preferred over a config key match of
2334 `https://user@example.com`.
2335 +
2336 All URLs are normalized before attempting any matching (the password part,
2337 if embedded in the URL, is always ignored for matching purposes) so that
2338 equivalent URLs that are simply spelled differently will match properly.
2339 Environment variable settings always override any matches. The URLs that are
2340 matched against are those given directly to Git commands. This means any URLs
2341 visited as a result of a redirection do not participate in matching.
2342
2343 ssh.variant::
2344 By default, Git determines the command line arguments to use
2345 based on the basename of the configured SSH command (configured
2346 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2347 the config setting `core.sshCommand`). If the basename is
2348 unrecognized, Git will attempt to detect support of OpenSSH
2349 options by first invoking the configured SSH command with the
2350 `-G` (print configuration) option and will subsequently use
2351 OpenSSH options (if that is successful) or no options besides
2352 the host and remote command (if it fails).
2353 +
2354 The config variable `ssh.variant` can be set to override this detection.
2355 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2356 `tortoiseplink`, `simple` (no options except the host and remote command).
2357 The default auto-detection can be explicitly requested using the value
2358 `auto`. Any other value is treated as `ssh`. This setting can also be
2359 overridden via the environment variable `GIT_SSH_VARIANT`.
2360 +
2361 The current command-line parameters used for each variant are as
2362 follows:
2363 +
2364 --
2365
2366 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2367
2368 * `simple` - [username@]host command
2369
2370 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2371
2372 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2373
2374 --
2375 +
2376 Except for the `simple` variant, command-line parameters are likely to
2377 change as git gains new features.
2378
2379 i18n.commitEncoding::
2380 Character encoding the commit messages are stored in; Git itself
2381 does not care per se, but this information is necessary e.g. when
2382 importing commits from emails or in the gitk graphical history
2383 browser (and possibly at other places in the future or in other
2384 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2385
2386 i18n.logOutputEncoding::
2387 Character encoding the commit messages are converted to when
2388 running 'git log' and friends.
2389
2390 imap::
2391 The configuration variables in the 'imap' section are described
2392 in linkgit:git-imap-send[1].
2393
2394 index.version::
2395 Specify the version with which new index files should be
2396 initialized. This does not affect existing repositories.
2397
2398 init.templateDir::
2399 Specify the directory from which templates will be copied.
2400 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2401
2402 instaweb.browser::
2403 Specify the program that will be used to browse your working
2404 repository in gitweb. See linkgit:git-instaweb[1].
2405
2406 instaweb.httpd::
2407 The HTTP daemon command-line to start gitweb on your working
2408 repository. See linkgit:git-instaweb[1].
2409
2410 instaweb.local::
2411 If true the web server started by linkgit:git-instaweb[1] will
2412 be bound to the local IP (127.0.0.1).
2413
2414 instaweb.modulePath::
2415 The default module path for linkgit:git-instaweb[1] to use
2416 instead of /usr/lib/apache2/modules. Only used if httpd
2417 is Apache.
2418
2419 instaweb.port::
2420 The port number to bind the gitweb httpd to. See
2421 linkgit:git-instaweb[1].
2422
2423 interactive.singleKey::
2424 In interactive commands, allow the user to provide one-letter
2425 input with a single key (i.e., without hitting enter).
2426 Currently this is used by the `--patch` mode of
2427 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2428 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2429 setting is silently ignored if portable keystroke input
2430 is not available; requires the Perl module Term::ReadKey.
2431
2432 interactive.diffFilter::
2433 When an interactive command (such as `git add --patch`) shows
2434 a colorized diff, git will pipe the diff through the shell
2435 command defined by this configuration variable. The command may
2436 mark up the diff further for human consumption, provided that it
2437 retains a one-to-one correspondence with the lines in the
2438 original diff. Defaults to disabled (no filtering).
2439
2440 log.abbrevCommit::
2441 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2442 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2443 override this option with `--no-abbrev-commit`.
2444
2445 log.date::
2446 Set the default date-time mode for the 'log' command.
2447 Setting a value for log.date is similar to using 'git log''s
2448 `--date` option. See linkgit:git-log[1] for details.
2449
2450 log.decorate::
2451 Print out the ref names of any commits that are shown by the log
2452 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2453 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2454 specified, the full ref name (including prefix) will be printed.
2455 If 'auto' is specified, then if the output is going to a terminal,
2456 the ref names are shown as if 'short' were given, otherwise no ref
2457 names are shown. This is the same as the `--decorate` option
2458 of the `git log`.
2459
2460 log.follow::
2461 If `true`, `git log` will act as if the `--follow` option was used when
2462 a single <path> is given. This has the same limitations as `--follow`,
2463 i.e. it cannot be used to follow multiple files and does not work well
2464 on non-linear history.
2465
2466 log.graphColors::
2467 A list of colors, separated by commas, that can be used to draw
2468 history lines in `git log --graph`.
2469
2470 log.showRoot::
2471 If true, the initial commit will be shown as a big creation event.
2472 This is equivalent to a diff against an empty tree.
2473 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2474 normally hide the root commit will now show it. True by default.
2475
2476 log.showSignature::
2477 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2478 linkgit:git-whatchanged[1] assume `--show-signature`.
2479
2480 log.mailmap::
2481 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2482 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2483
2484 mailinfo.scissors::
2485 If true, makes linkgit:git-mailinfo[1] (and therefore
2486 linkgit:git-am[1]) act by default as if the --scissors option
2487 was provided on the command-line. When active, this features
2488 removes everything from the message body before a scissors
2489 line (i.e. consisting mainly of ">8", "8<" and "-").
2490
2491 mailmap.file::
2492 The location of an augmenting mailmap file. The default
2493 mailmap, located in the root of the repository, is loaded
2494 first, then the mailmap file pointed to by this variable.
2495 The location of the mailmap file may be in a repository
2496 subdirectory, or somewhere outside of the repository itself.
2497 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2498
2499 mailmap.blob::
2500 Like `mailmap.file`, but consider the value as a reference to a
2501 blob in the repository. If both `mailmap.file` and
2502 `mailmap.blob` are given, both are parsed, with entries from
2503 `mailmap.file` taking precedence. In a bare repository, this
2504 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2505 defaults to empty.
2506
2507 man.viewer::
2508 Specify the programs that may be used to display help in the
2509 'man' format. See linkgit:git-help[1].
2510
2511 man.<tool>.cmd::
2512 Specify the command to invoke the specified man viewer. The
2513 specified command is evaluated in shell with the man page
2514 passed as argument. (See linkgit:git-help[1].)
2515
2516 man.<tool>.path::
2517 Override the path for the given tool that may be used to
2518 display help in the 'man' format. See linkgit:git-help[1].
2519
2520 include::merge-config.txt[]
2521
2522 mergetool.<tool>.path::
2523 Override the path for the given tool. This is useful in case
2524 your tool is not in the PATH.
2525
2526 mergetool.<tool>.cmd::
2527 Specify the command to invoke the specified merge tool. The
2528 specified command is evaluated in shell with the following
2529 variables available: 'BASE' is the name of a temporary file
2530 containing the common base of the files to be merged, if available;
2531 'LOCAL' is the name of a temporary file containing the contents of
2532 the file on the current branch; 'REMOTE' is the name of a temporary
2533 file containing the contents of the file from the branch being
2534 merged; 'MERGED' contains the name of the file to which the merge
2535 tool should write the results of a successful merge.
2536
2537 mergetool.<tool>.trustExitCode::
2538 For a custom merge command, specify whether the exit code of
2539 the merge command can be used to determine whether the merge was
2540 successful. If this is not set to true then the merge target file
2541 timestamp is checked and the merge assumed to have been successful
2542 if the file has been updated, otherwise the user is prompted to
2543 indicate the success of the merge.
2544
2545 mergetool.meld.hasOutput::
2546 Older versions of `meld` do not support the `--output` option.
2547 Git will attempt to detect whether `meld` supports `--output`
2548 by inspecting the output of `meld --help`. Configuring
2549 `mergetool.meld.hasOutput` will make Git skip these checks and
2550 use the configured value instead. Setting `mergetool.meld.hasOutput`
2551 to `true` tells Git to unconditionally use the `--output` option,
2552 and `false` avoids using `--output`.
2553
2554 mergetool.keepBackup::
2555 After performing a merge, the original file with conflict markers
2556 can be saved as a file with a `.orig` extension. If this variable
2557 is set to `false` then this file is not preserved. Defaults to
2558 `true` (i.e. keep the backup files).
2559
2560 mergetool.keepTemporaries::
2561 When invoking a custom merge tool, Git uses a set of temporary
2562 files to pass to the tool. If the tool returns an error and this
2563 variable is set to `true`, then these temporary files will be
2564 preserved, otherwise they will be removed after the tool has
2565 exited. Defaults to `false`.
2566
2567 mergetool.writeToTemp::
2568 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2569 conflicting files in the worktree by default. Git will attempt
2570 to use a temporary directory for these files when set `true`.
2571 Defaults to `false`.
2572
2573 mergetool.prompt::
2574 Prompt before each invocation of the merge resolution program.
2575
2576 notes.mergeStrategy::
2577 Which merge strategy to choose by default when resolving notes
2578 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2579 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2580 section of linkgit:git-notes[1] for more information on each strategy.
2581
2582 notes.<name>.mergeStrategy::
2583 Which merge strategy to choose when doing a notes merge into
2584 refs/notes/<name>. This overrides the more general
2585 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2586 linkgit:git-notes[1] for more information on the available strategies.
2587
2588 notes.displayRef::
2589 The (fully qualified) refname from which to show notes when
2590 showing commit messages. The value of this variable can be set
2591 to a glob, in which case notes from all matching refs will be
2592 shown. You may also specify this configuration variable
2593 several times. A warning will be issued for refs that do not
2594 exist, but a glob that does not match any refs is silently
2595 ignored.
2596 +
2597 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2598 environment variable, which must be a colon separated list of refs or
2599 globs.
2600 +
2601 The effective value of "core.notesRef" (possibly overridden by
2602 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2603 displayed.
2604
2605 notes.rewrite.<command>::
2606 When rewriting commits with <command> (currently `amend` or
2607 `rebase`) and this variable is set to `true`, Git
2608 automatically copies your notes from the original to the
2609 rewritten commit. Defaults to `true`, but see
2610 "notes.rewriteRef" below.
2611
2612 notes.rewriteMode::
2613 When copying notes during a rewrite (see the
2614 "notes.rewrite.<command>" option), determines what to do if
2615 the target commit already has a note. Must be one of
2616 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2617 Defaults to `concatenate`.
2618 +
2619 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2620 environment variable.
2621
2622 notes.rewriteRef::
2623 When copying notes during a rewrite, specifies the (fully
2624 qualified) ref whose notes should be copied. The ref may be a
2625 glob, in which case notes in all matching refs will be copied.
2626 You may also specify this configuration several times.
2627 +
2628 Does not have a default value; you must configure this variable to
2629 enable note rewriting. Set it to `refs/notes/commits` to enable
2630 rewriting for the default commit notes.
2631 +
2632 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2633 environment variable, which must be a colon separated list of refs or
2634 globs.
2635
2636 pack.window::
2637 The size of the window used by linkgit:git-pack-objects[1] when no
2638 window size is given on the command line. Defaults to 10.
2639
2640 pack.depth::
2641 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2642 maximum depth is given on the command line. Defaults to 50.
2643 Maximum value is 4095.
2644
2645 pack.windowMemory::
2646 The maximum size of memory that is consumed by each thread
2647 in linkgit:git-pack-objects[1] for pack window memory when
2648 no limit is given on the command line. The value can be
2649 suffixed with "k", "m", or "g". When left unconfigured (or
2650 set explicitly to 0), there will be no limit.
2651
2652 pack.compression::
2653 An integer -1..9, indicating the compression level for objects
2654 in a pack file. -1 is the zlib default. 0 means no
2655 compression, and 1..9 are various speed/size tradeoffs, 9 being
2656 slowest. If not set, defaults to core.compression. If that is
2657 not set, defaults to -1, the zlib default, which is "a default
2658 compromise between speed and compression (currently equivalent
2659 to level 6)."
2660 +
2661 Note that changing the compression level will not automatically recompress
2662 all existing objects. You can force recompression by passing the -F option
2663 to linkgit:git-repack[1].
2664
2665 pack.deltaCacheSize::
2666 The maximum memory in bytes used for caching deltas in
2667 linkgit:git-pack-objects[1] before writing them out to a pack.
2668 This cache is used to speed up the writing object phase by not
2669 having to recompute the final delta result once the best match
2670 for all objects is found. Repacking large repositories on machines
2671 which are tight with memory might be badly impacted by this though,
2672 especially if this cache pushes the system into swapping.
2673 A value of 0 means no limit. The smallest size of 1 byte may be
2674 used to virtually disable this cache. Defaults to 256 MiB.
2675
2676 pack.deltaCacheLimit::
2677 The maximum size of a delta, that is cached in
2678 linkgit:git-pack-objects[1]. This cache is used to speed up the
2679 writing object phase by not having to recompute the final delta
2680 result once the best match for all objects is found.
2681 Defaults to 1000. Maximum value is 65535.
2682
2683 pack.threads::
2684 Specifies the number of threads to spawn when searching for best
2685 delta matches. This requires that linkgit:git-pack-objects[1]
2686 be compiled with pthreads otherwise this option is ignored with a
2687 warning. This is meant to reduce packing time on multiprocessor
2688 machines. The required amount of memory for the delta search window
2689 is however multiplied by the number of threads.
2690 Specifying 0 will cause Git to auto-detect the number of CPU's
2691 and set the number of threads accordingly.
2692
2693 pack.indexVersion::
2694 Specify the default pack index version. Valid values are 1 for
2695 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2696 the new pack index with capabilities for packs larger than 4 GB
2697 as well as proper protection against the repacking of corrupted
2698 packs. Version 2 is the default. Note that version 2 is enforced
2699 and this config option ignored whenever the corresponding pack is
2700 larger than 2 GB.
2701 +
2702 If you have an old Git that does not understand the version 2 `*.idx` file,
2703 cloning or fetching over a non native protocol (e.g. "http")
2704 that will copy both `*.pack` file and corresponding `*.idx` file from the
2705 other side may give you a repository that cannot be accessed with your
2706 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2707 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2708 the `*.idx` file.
2709
2710 pack.packSizeLimit::
2711 The maximum size of a pack. This setting only affects
2712 packing to a file when repacking, i.e. the git:// protocol
2713 is unaffected. It can be overridden by the `--max-pack-size`
2714 option of linkgit:git-repack[1]. Reaching this limit results
2715 in the creation of multiple packfiles; which in turn prevents
2716 bitmaps from being created.
2717 The minimum size allowed is limited to 1 MiB.
2718 The default is unlimited.
2719 Common unit suffixes of 'k', 'm', or 'g' are
2720 supported.
2721
2722 pack.useBitmaps::
2723 When true, git will use pack bitmaps (if available) when packing
2724 to stdout (e.g., during the server side of a fetch). Defaults to
2725 true. You should not generally need to turn this off unless
2726 you are debugging pack bitmaps.
2727
2728 pack.writeBitmaps (deprecated)::
2729 This is a deprecated synonym for `repack.writeBitmaps`.
2730
2731 pack.writeBitmapHashCache::
2732 When true, git will include a "hash cache" section in the bitmap
2733 index (if one is written). This cache can be used to feed git's
2734 delta heuristics, potentially leading to better deltas between
2735 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2736 between an older, bitmapped pack and objects that have been
2737 pushed since the last gc). The downside is that it consumes 4
2738 bytes per object of disk space, and that JGit's bitmap
2739 implementation does not understand it, causing it to complain if
2740 Git and JGit are used on the same repository. Defaults to false.
2741
2742 pager.<cmd>::
2743 If the value is boolean, turns on or off pagination of the
2744 output of a particular Git subcommand when writing to a tty.
2745 Otherwise, turns on pagination for the subcommand using the
2746 pager specified by the value of `pager.<cmd>`. If `--paginate`
2747 or `--no-pager` is specified on the command line, it takes
2748 precedence over this option. To disable pagination for all
2749 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2750
2751 pretty.<name>::
2752 Alias for a --pretty= format string, as specified in
2753 linkgit:git-log[1]. Any aliases defined here can be used just
2754 as the built-in pretty formats could. For example,
2755 running `git config pretty.changelog "format:* %H %s"`
2756 would cause the invocation `git log --pretty=changelog`
2757 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2758 Note that an alias with the same name as a built-in format
2759 will be silently ignored.
2760
2761 protocol.allow::
2762 If set, provide a user defined default policy for all protocols which
2763 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2764 if unset, known-safe protocols (http, https, git, ssh, file) have a
2765 default policy of `always`, known-dangerous protocols (ext) have a
2766 default policy of `never`, and all other protocols have a default
2767 policy of `user`. Supported policies:
2768 +
2769 --
2770
2771 * `always` - protocol is always able to be used.
2772
2773 * `never` - protocol is never able to be used.
2774
2775 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2776 either unset or has a value of 1. This policy should be used when you want a
2777 protocol to be directly usable by the user but don't want it used by commands which
2778 execute clone/fetch/push commands without user input, e.g. recursive
2779 submodule initialization.
2780
2781 --
2782
2783 protocol.<name>.allow::
2784 Set a policy to be used by protocol `<name>` with clone/fetch/push
2785 commands. See `protocol.allow` above for the available policies.
2786 +
2787 The protocol names currently used by git are:
2788 +
2789 --
2790 - `file`: any local file-based path (including `file://` URLs,
2791 or local paths)
2792
2793 - `git`: the anonymous git protocol over a direct TCP
2794 connection (or proxy, if configured)
2795
2796 - `ssh`: git over ssh (including `host:path` syntax,
2797 `ssh://`, etc).
2798
2799 - `http`: git over http, both "smart http" and "dumb http".
2800 Note that this does _not_ include `https`; if you want to configure
2801 both, you must do so individually.
2802
2803 - any external helpers are named by their protocol (e.g., use
2804 `hg` to allow the `git-remote-hg` helper)
2805 --
2806
2807 protocol.version::
2808 Experimental. If set, clients will attempt to communicate with a
2809 server using the specified protocol version. If unset, no
2810 attempt will be made by the client to communicate using a
2811 particular protocol version, this results in protocol version 0
2812 being used.
2813 Supported versions:
2814 +
2815 --
2816
2817 * `0` - the original wire protocol.
2818
2819 * `1` - the original wire protocol with the addition of a version string
2820 in the initial response from the server.
2821
2822 --
2823
2824 pull.ff::
2825 By default, Git does not create an extra merge commit when merging
2826 a commit that is a descendant of the current commit. Instead, the
2827 tip of the current branch is fast-forwarded. When set to `false`,
2828 this variable tells Git to create an extra merge commit in such
2829 a case (equivalent to giving the `--no-ff` option from the command
2830 line). When set to `only`, only such fast-forward merges are
2831 allowed (equivalent to giving the `--ff-only` option from the
2832 command line). This setting overrides `merge.ff` when pulling.
2833
2834 pull.rebase::
2835 When true, rebase branches on top of the fetched branch, instead
2836 of merging the default branch from the default remote when "git
2837 pull" is run. See "branch.<name>.rebase" for setting this on a
2838 per-branch basis.
2839 +
2840 When `merges`, pass the `--rebase-merges` option to 'git rebase'
2841 so that the local merge commits are included in the rebase (see
2842 linkgit:git-rebase[1] for details).
2843 +
2844 When preserve, also pass `--preserve-merges` along to 'git rebase'
2845 so that locally committed merge commits will not be flattened
2846 by running 'git pull'.
2847 +
2848 When the value is `interactive`, the rebase is run in interactive mode.
2849 +
2850 *NOTE*: this is a possibly dangerous operation; do *not* use
2851 it unless you understand the implications (see linkgit:git-rebase[1]
2852 for details).
2853
2854 pull.octopus::
2855 The default merge strategy to use when pulling multiple branches
2856 at once.
2857
2858 pull.twohead::
2859 The default merge strategy to use when pulling a single branch.
2860
2861 push.default::
2862 Defines the action `git push` should take if no refspec is
2863 explicitly given. Different values are well-suited for
2864 specific workflows; for instance, in a purely central workflow
2865 (i.e. the fetch source is equal to the push destination),
2866 `upstream` is probably what you want. Possible values are:
2867 +
2868 --
2869
2870 * `nothing` - do not push anything (error out) unless a refspec is
2871 explicitly given. This is primarily meant for people who want to
2872 avoid mistakes by always being explicit.
2873
2874 * `current` - push the current branch to update a branch with the same
2875 name on the receiving end. Works in both central and non-central
2876 workflows.
2877
2878 * `upstream` - push the current branch back to the branch whose
2879 changes are usually integrated into the current branch (which is
2880 called `@{upstream}`). This mode only makes sense if you are
2881 pushing to the same repository you would normally pull from
2882 (i.e. central workflow).
2883
2884 * `tracking` - This is a deprecated synonym for `upstream`.
2885
2886 * `simple` - in centralized workflow, work like `upstream` with an
2887 added safety to refuse to push if the upstream branch's name is
2888 different from the local one.
2889 +
2890 When pushing to a remote that is different from the remote you normally
2891 pull from, work as `current`. This is the safest option and is suited
2892 for beginners.
2893 +
2894 This mode has become the default in Git 2.0.
2895
2896 * `matching` - push all branches having the same name on both ends.
2897 This makes the repository you are pushing to remember the set of
2898 branches that will be pushed out (e.g. if you always push 'maint'
2899 and 'master' there and no other branches, the repository you push
2900 to will have these two branches, and your local 'maint' and
2901 'master' will be pushed there).
2902 +
2903 To use this mode effectively, you have to make sure _all_ the
2904 branches you would push out are ready to be pushed out before
2905 running 'git push', as the whole point of this mode is to allow you
2906 to push all of the branches in one go. If you usually finish work
2907 on only one branch and push out the result, while other branches are
2908 unfinished, this mode is not for you. Also this mode is not
2909 suitable for pushing into a shared central repository, as other
2910 people may add new branches there, or update the tip of existing
2911 branches outside your control.
2912 +
2913 This used to be the default, but not since Git 2.0 (`simple` is the
2914 new default).
2915
2916 --
2917
2918 push.followTags::
2919 If set to true enable `--follow-tags` option by default. You
2920 may override this configuration at time of push by specifying
2921 `--no-follow-tags`.
2922
2923 push.gpgSign::
2924 May be set to a boolean value, or the string 'if-asked'. A true
2925 value causes all pushes to be GPG signed, as if `--signed` is
2926 passed to linkgit:git-push[1]. The string 'if-asked' causes
2927 pushes to be signed if the server supports it, as if
2928 `--signed=if-asked` is passed to 'git push'. A false value may
2929 override a value from a lower-priority config file. An explicit
2930 command-line flag always overrides this config option.
2931
2932 push.pushOption::
2933 When no `--push-option=<option>` argument is given from the
2934 command line, `git push` behaves as if each <value> of
2935 this variable is given as `--push-option=<value>`.
2936 +
2937 This is a multi-valued variable, and an empty value can be used in a
2938 higher priority configuration file (e.g. `.git/config` in a
2939 repository) to clear the values inherited from a lower priority
2940 configuration files (e.g. `$HOME/.gitconfig`).
2941 +
2942 --
2943
2944 Example:
2945
2946 /etc/gitconfig
2947 push.pushoption = a
2948 push.pushoption = b
2949
2950 ~/.gitconfig
2951 push.pushoption = c
2952
2953 repo/.git/config
2954 push.pushoption =
2955 push.pushoption = b
2956
2957 This will result in only b (a and c are cleared).
2958
2959 --
2960
2961 push.recurseSubmodules::
2962 Make sure all submodule commits used by the revisions to be pushed
2963 are available on a remote-tracking branch. If the value is 'check'
2964 then Git will verify that all submodule commits that changed in the
2965 revisions to be pushed are available on at least one remote of the
2966 submodule. If any commits are missing, the push will be aborted and
2967 exit with non-zero status. If the value is 'on-demand' then all
2968 submodules that changed in the revisions to be pushed will be
2969 pushed. If on-demand was not able to push all necessary revisions
2970 it will also be aborted and exit with non-zero status. If the value
2971 is 'no' then default behavior of ignoring submodules when pushing
2972 is retained. You may override this configuration at time of push by
2973 specifying '--recurse-submodules=check|on-demand|no'.
2974
2975 include::rebase-config.txt[]
2976
2977 receive.advertiseAtomic::
2978 By default, git-receive-pack will advertise the atomic push
2979 capability to its clients. If you don't want to advertise this
2980 capability, set this variable to false.
2981
2982 receive.advertisePushOptions::
2983 When set to true, git-receive-pack will advertise the push options
2984 capability to its clients. False by default.
2985
2986 receive.autogc::
2987 By default, git-receive-pack will run "git-gc --auto" after
2988 receiving data from git-push and updating refs. You can stop
2989 it by setting this variable to false.
2990
2991 receive.certNonceSeed::
2992 By setting this variable to a string, `git receive-pack`
2993 will accept a `git push --signed` and verifies it by using
2994 a "nonce" protected by HMAC using this string as a secret
2995 key.
2996
2997 receive.certNonceSlop::
2998 When a `git push --signed` sent a push certificate with a
2999 "nonce" that was issued by a receive-pack serving the same
3000 repository within this many seconds, export the "nonce"
3001 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
3002 hooks (instead of what the receive-pack asked the sending
3003 side to include). This may allow writing checks in
3004 `pre-receive` and `post-receive` a bit easier. Instead of
3005 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
3006 that records by how many seconds the nonce is stale to
3007 decide if they want to accept the certificate, they only
3008 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
3009
3010 receive.fsckObjects::
3011 If it is set to true, git-receive-pack will check all received
3012 objects. See `transfer.fsckObjects` for what's checked.
3013 Defaults to false. If not set, the value of
3014 `transfer.fsckObjects` is used instead.
3015
3016 receive.fsck.<msg-id>::
3017 Acts like `fsck.<msg-id>`, but is used by
3018 linkgit:git-receive-pack[1] instead of
3019 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
3020 details.
3021
3022 receive.fsck.skipList::
3023 Acts like `fsck.skipList`, but is used by
3024 linkgit:git-receive-pack[1] instead of
3025 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
3026 details.
3027
3028 receive.keepAlive::
3029 After receiving the pack from the client, `receive-pack` may
3030 produce no output (if `--quiet` was specified) while processing
3031 the pack, causing some networks to drop the TCP connection.
3032 With this option set, if `receive-pack` does not transmit
3033 any data in this phase for `receive.keepAlive` seconds, it will
3034 send a short keepalive packet. The default is 5 seconds; set
3035 to 0 to disable keepalives entirely.
3036
3037 receive.unpackLimit::
3038 If the number of objects received in a push is below this
3039 limit then the objects will be unpacked into loose object
3040 files. However if the number of received objects equals or
3041 exceeds this limit then the received pack will be stored as
3042 a pack, after adding any missing delta bases. Storing the
3043 pack from a push can make the push operation complete faster,
3044 especially on slow filesystems. If not set, the value of
3045 `transfer.unpackLimit` is used instead.
3046
3047 receive.maxInputSize::
3048 If the size of the incoming pack stream is larger than this
3049 limit, then git-receive-pack will error out, instead of
3050 accepting the pack file. If not set or set to 0, then the size
3051 is unlimited.
3052
3053 receive.denyDeletes::
3054 If set to true, git-receive-pack will deny a ref update that deletes
3055 the ref. Use this to prevent such a ref deletion via a push.
3056
3057 receive.denyDeleteCurrent::
3058 If set to true, git-receive-pack will deny a ref update that
3059 deletes the currently checked out branch of a non-bare repository.
3060
3061 receive.denyCurrentBranch::
3062 If set to true or "refuse", git-receive-pack will deny a ref update
3063 to the currently checked out branch of a non-bare repository.
3064 Such a push is potentially dangerous because it brings the HEAD
3065 out of sync with the index and working tree. If set to "warn",
3066 print a warning of such a push to stderr, but allow the push to
3067 proceed. If set to false or "ignore", allow such pushes with no
3068 message. Defaults to "refuse".
3069 +
3070 Another option is "updateInstead" which will update the working
3071 tree if pushing into the current branch. This option is
3072 intended for synchronizing working directories when one side is not easily
3073 accessible via interactive ssh (e.g. a live web site, hence the requirement
3074 that the working directory be clean). This mode also comes in handy when
3075 developing inside a VM to test and fix code on different Operating Systems.
3076 +
3077 By default, "updateInstead" will refuse the push if the working tree or
3078 the index have any difference from the HEAD, but the `push-to-checkout`
3079 hook can be used to customize this. See linkgit:githooks[5].
3080
3081 receive.denyNonFastForwards::
3082 If set to true, git-receive-pack will deny a ref update which is
3083 not a fast-forward. Use this to prevent such an update via a push,
3084 even if that push is forced. This configuration variable is
3085 set when initializing a shared repository.
3086
3087 receive.hideRefs::
3088 This variable is the same as `transfer.hideRefs`, but applies
3089 only to `receive-pack` (and so affects pushes, but not fetches).
3090 An attempt to update or delete a hidden ref by `git push` is
3091 rejected.
3092
3093 receive.updateServerInfo::
3094 If set to true, git-receive-pack will run git-update-server-info
3095 after receiving data from git-push and updating refs.
3096
3097 receive.shallowUpdate::
3098 If set to true, .git/shallow can be updated when new refs
3099 require new shallow roots. Otherwise those refs are rejected.
3100
3101 remote.pushDefault::
3102 The remote to push to by default. Overrides
3103 `branch.<name>.remote` for all branches, and is overridden by
3104 `branch.<name>.pushRemote` for specific branches.
3105
3106 remote.<name>.url::
3107 The URL of a remote repository. See linkgit:git-fetch[1] or
3108 linkgit:git-push[1].
3109
3110 remote.<name>.pushurl::
3111 The push URL of a remote repository. See linkgit:git-push[1].
3112
3113 remote.<name>.proxy::
3114 For remotes that require curl (http, https and ftp), the URL to
3115 the proxy to use for that remote. Set to the empty string to
3116 disable proxying for that remote.
3117
3118 remote.<name>.proxyAuthMethod::
3119 For remotes that require curl (http, https and ftp), the method to use for
3120 authenticating against the proxy in use (probably set in
3121 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3122
3123 remote.<name>.fetch::
3124 The default set of "refspec" for linkgit:git-fetch[1]. See
3125 linkgit:git-fetch[1].
3126
3127 remote.<name>.push::
3128 The default set of "refspec" for linkgit:git-push[1]. See
3129 linkgit:git-push[1].
3130
3131 remote.<name>.mirror::
3132 If true, pushing to this remote will automatically behave
3133 as if the `--mirror` option was given on the command line.
3134
3135 remote.<name>.skipDefaultUpdate::
3136 If true, this remote will be skipped by default when updating
3137 using linkgit:git-fetch[1] or the `update` subcommand of
3138 linkgit:git-remote[1].
3139
3140 remote.<name>.skipFetchAll::
3141 If true, this remote will be skipped by default when updating
3142 using linkgit:git-fetch[1] or the `update` subcommand of
3143 linkgit:git-remote[1].
3144
3145 remote.<name>.receivepack::
3146 The default program to execute on the remote side when pushing. See
3147 option --receive-pack of linkgit:git-push[1].
3148
3149 remote.<name>.uploadpack::
3150 The default program to execute on the remote side when fetching. See
3151 option --upload-pack of linkgit:git-fetch-pack[1].
3152
3153 remote.<name>.tagOpt::
3154 Setting this value to --no-tags disables automatic tag following when
3155 fetching from remote <name>. Setting it to --tags will fetch every
3156 tag from remote <name>, even if they are not reachable from remote
3157 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3158 override this setting. See options --tags and --no-tags of
3159 linkgit:git-fetch[1].
3160
3161 remote.<name>.vcs::
3162 Setting this to a value <vcs> will cause Git to interact with
3163 the remote with the git-remote-<vcs> helper.
3164
3165 remote.<name>.prune::
3166 When set to true, fetching from this remote by default will also
3167 remove any remote-tracking references that no longer exist on the
3168 remote (as if the `--prune` option was given on the command line).
3169 Overrides `fetch.prune` settings, if any.
3170
3171 remote.<name>.pruneTags::
3172 When set to true, fetching from this remote by default will also
3173 remove any local tags that no longer exist on the remote if pruning
3174 is activated in general via `remote.<name>.prune`, `fetch.prune` or
3175 `--prune`. Overrides `fetch.pruneTags` settings, if any.
3176 +
3177 See also `remote.<name>.prune` and the PRUNING section of
3178 linkgit:git-fetch[1].
3179
3180 remotes.<group>::
3181 The list of remotes which are fetched by "git remote update
3182 <group>". See linkgit:git-remote[1].
3183
3184 repack.useDeltaBaseOffset::
3185 By default, linkgit:git-repack[1] creates packs that use
3186 delta-base offset. If you need to share your repository with
3187 Git older than version 1.4.4, either directly or via a dumb
3188 protocol such as http, then you need to set this option to
3189 "false" and repack. Access from old Git versions over the
3190 native protocol are unaffected by this option.
3191
3192 repack.packKeptObjects::
3193 If set to true, makes `git repack` act as if
3194 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3195 details. Defaults to `false` normally, but `true` if a bitmap
3196 index is being written (either via `--write-bitmap-index` or
3197 `repack.writeBitmaps`).
3198
3199 repack.writeBitmaps::
3200 When true, git will write a bitmap index when packing all
3201 objects to disk (e.g., when `git repack -a` is run). This
3202 index can speed up the "counting objects" phase of subsequent
3203 packs created for clones and fetches, at the cost of some disk
3204 space and extra time spent on the initial repack. This has
3205 no effect if multiple packfiles are created.
3206 Defaults to false.
3207
3208 rerere.autoUpdate::
3209 When set to true, `git-rerere` updates the index with the
3210 resulting contents after it cleanly resolves conflicts using
3211 previously recorded resolution. Defaults to false.
3212
3213 rerere.enabled::
3214 Activate recording of resolved conflicts, so that identical
3215 conflict hunks can be resolved automatically, should they be
3216 encountered again. By default, linkgit:git-rerere[1] is
3217 enabled if there is an `rr-cache` directory under the
3218 `$GIT_DIR`, e.g. if "rerere" was previously used in the
3219 repository.
3220
3221 sendemail.identity::
3222 A configuration identity. When given, causes values in the
3223 'sendemail.<identity>' subsection to take precedence over
3224 values in the 'sendemail' section. The default identity is
3225 the value of `sendemail.identity`.
3226
3227 sendemail.smtpEncryption::
3228 See linkgit:git-send-email[1] for description. Note that this
3229 setting is not subject to the 'identity' mechanism.
3230
3231 sendemail.smtpssl (deprecated)::
3232 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3233
3234 sendemail.smtpsslcertpath::
3235 Path to ca-certificates (either a directory or a single file).
3236 Set it to an empty string to disable certificate verification.
3237
3238 sendemail.<identity>.*::
3239 Identity-specific versions of the 'sendemail.*' parameters
3240 found below, taking precedence over those when this
3241 identity is selected, through either the command-line or
3242 `sendemail.identity`.
3243
3244 sendemail.aliasesFile::
3245 sendemail.aliasFileType::
3246 sendemail.annotate::
3247 sendemail.bcc::
3248 sendemail.cc::
3249 sendemail.ccCmd::
3250 sendemail.chainReplyTo::
3251 sendemail.confirm::
3252 sendemail.envelopeSender::
3253 sendemail.from::
3254 sendemail.multiEdit::
3255 sendemail.signedoffbycc::
3256 sendemail.smtpPass::
3257 sendemail.suppresscc::
3258 sendemail.suppressFrom::
3259 sendemail.to::
3260 sendemail.tocmd::
3261 sendemail.smtpDomain::
3262 sendemail.smtpServer::
3263 sendemail.smtpServerPort::
3264 sendemail.smtpServerOption::
3265 sendemail.smtpUser::
3266 sendemail.thread::
3267 sendemail.transferEncoding::
3268 sendemail.validate::
3269 sendemail.xmailer::
3270 See linkgit:git-send-email[1] for description.
3271
3272 sendemail.signedoffcc (deprecated)::
3273 Deprecated alias for `sendemail.signedoffbycc`.
3274
3275 sendemail.smtpBatchSize::
3276 Number of messages to be sent per connection, after that a relogin
3277 will happen. If the value is 0 or undefined, send all messages in
3278 one connection.
3279 See also the `--batch-size` option of linkgit:git-send-email[1].
3280
3281 sendemail.smtpReloginDelay::
3282 Seconds wait before reconnecting to smtp server.
3283 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3284
3285 showbranch.default::
3286 The default set of branches for linkgit:git-show-branch[1].
3287 See linkgit:git-show-branch[1].
3288
3289 splitIndex.maxPercentChange::
3290 When the split index feature is used, this specifies the
3291 percent of entries the split index can contain compared to the
3292 total number of entries in both the split index and the shared
3293 index before a new shared index is written.
3294 The value should be between 0 and 100. If the value is 0 then
3295 a new shared index is always written, if it is 100 a new
3296 shared index is never written.
3297 By default the value is 20, so a new shared index is written
3298 if the number of entries in the split index would be greater
3299 than 20 percent of the total number of entries.
3300 See linkgit:git-update-index[1].
3301
3302 splitIndex.sharedIndexExpire::
3303 When the split index feature is used, shared index files that
3304 were not modified since the time this variable specifies will
3305 be removed when a new shared index file is created. The value
3306 "now" expires all entries immediately, and "never" suppresses
3307 expiration altogether.
3308 The default value is "2.weeks.ago".
3309 Note that a shared index file is considered modified (for the
3310 purpose of expiration) each time a new split-index file is
3311 either created based on it or read from it.
3312 See linkgit:git-update-index[1].
3313
3314 status.relativePaths::
3315 By default, linkgit:git-status[1] shows paths relative to the
3316 current directory. Setting this variable to `false` shows paths
3317 relative to the repository root (this was the default for Git
3318 prior to v1.5.4).
3319
3320 status.short::
3321 Set to true to enable --short by default in linkgit:git-status[1].
3322 The option --no-short takes precedence over this variable.
3323
3324 status.branch::
3325 Set to true to enable --branch by default in linkgit:git-status[1].
3326 The option --no-branch takes precedence over this variable.
3327
3328 status.displayCommentPrefix::
3329 If set to true, linkgit:git-status[1] will insert a comment
3330 prefix before each output line (starting with
3331 `core.commentChar`, i.e. `#` by default). This was the
3332 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3333 Defaults to false.
3334
3335 status.renameLimit::
3336 The number of files to consider when performing rename detection
3337 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3338 the value of diff.renameLimit.
3339
3340 status.renames::
3341 Whether and how Git detects renames in linkgit:git-status[1] and
3342 linkgit:git-commit[1] . If set to "false", rename detection is
3343 disabled. If set to "true", basic rename detection is enabled.
3344 If set to "copies" or "copy", Git will detect copies, as well.
3345 Defaults to the value of diff.renames.
3346
3347 status.showStash::
3348 If set to true, linkgit:git-status[1] will display the number of
3349 entries currently stashed away.
3350 Defaults to false.
3351
3352 status.showUntrackedFiles::
3353 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3354 files which are not currently tracked by Git. Directories which
3355 contain only untracked files, are shown with the directory name
3356 only. Showing untracked files means that Git needs to lstat() all
3357 the files in the whole repository, which might be slow on some
3358 systems. So, this variable controls how the commands displays
3359 the untracked files. Possible values are:
3360 +
3361 --
3362 * `no` - Show no untracked files.
3363 * `normal` - Show untracked files and directories.
3364 * `all` - Show also individual files in untracked directories.
3365 --
3366 +
3367 If this variable is not specified, it defaults to 'normal'.
3368 This variable can be overridden with the -u|--untracked-files option
3369 of linkgit:git-status[1] and linkgit:git-commit[1].
3370
3371 status.submoduleSummary::
3372 Defaults to false.
3373 If this is set to a non zero number or true (identical to -1 or an
3374 unlimited number), the submodule summary will be enabled and a
3375 summary of commits for modified submodules will be shown (see
3376 --summary-limit option of linkgit:git-submodule[1]). Please note
3377 that the summary output command will be suppressed for all
3378 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3379 for those submodules where `submodule.<name>.ignore=all`. The only
3380 exception to that rule is that status and commit will show staged
3381 submodule changes. To
3382 also view the summary for ignored submodules you can either use
3383 the --ignore-submodules=dirty command-line option or the 'git
3384 submodule summary' command, which shows a similar output but does
3385 not honor these settings.
3386
3387 stash.showPatch::
3388 If this is set to true, the `git stash show` command without an
3389 option will show the stash entry in patch form. Defaults to false.
3390 See description of 'show' command in linkgit:git-stash[1].
3391
3392 stash.showStat::
3393 If this is set to true, the `git stash show` command without an
3394 option will show diffstat of the stash entry. Defaults to true.
3395 See description of 'show' command in linkgit:git-stash[1].
3396
3397 submodule.<name>.url::
3398 The URL for a submodule. This variable is copied from the .gitmodules
3399 file to the git config via 'git submodule init'. The user can change
3400 the configured URL before obtaining the submodule via 'git submodule
3401 update'. If neither submodule.<name>.active or submodule.active are
3402 set, the presence of this variable is used as a fallback to indicate
3403 whether the submodule is of interest to git commands.
3404 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3405
3406 submodule.<name>.update::
3407 The method by which a submodule is updated by 'git submodule update',
3408 which is the only affected command, others such as
3409 'git checkout --recurse-submodules' are unaffected. It exists for
3410 historical reasons, when 'git submodule' was the only command to
3411 interact with submodules; settings like `submodule.active`
3412 and `pull.rebase` are more specific. It is populated by
3413 `git submodule init` from the linkgit:gitmodules[5] file.
3414 See description of 'update' command in linkgit:git-submodule[1].
3415
3416 submodule.<name>.branch::
3417 The remote branch name for a submodule, used by `git submodule
3418 update --remote`. Set this option to override the value found in
3419 the `.gitmodules` file. See linkgit:git-submodule[1] and
3420 linkgit:gitmodules[5] for details.
3421
3422 submodule.<name>.fetchRecurseSubmodules::
3423 This option can be used to control recursive fetching of this
3424 submodule. It can be overridden by using the --[no-]recurse-submodules
3425 command-line option to "git fetch" and "git pull".
3426 This setting will override that from in the linkgit:gitmodules[5]
3427 file.
3428
3429 submodule.<name>.ignore::
3430 Defines under what circumstances "git status" and the diff family show
3431 a submodule as modified. When set to "all", it will never be considered
3432 modified (but it will nonetheless show up in the output of status and
3433 commit when it has been staged), "dirty" will ignore all changes
3434 to the submodules work tree and
3435 takes only differences between the HEAD of the submodule and the commit
3436 recorded in the superproject into account. "untracked" will additionally
3437 let submodules with modified tracked files in their work tree show up.
3438 Using "none" (the default when this option is not set) also shows
3439 submodules that have untracked files in their work tree as changed.
3440 This setting overrides any setting made in .gitmodules for this submodule,
3441 both settings can be overridden on the command line by using the
3442 "--ignore-submodules" option. The 'git submodule' commands are not
3443 affected by this setting.
3444
3445 submodule.<name>.active::
3446 Boolean value indicating if the submodule is of interest to git
3447 commands. This config option takes precedence over the
3448 submodule.active config option. See linkgit:gitsubmodules[7] for
3449 details.
3450
3451 submodule.active::
3452 A repeated field which contains a pathspec used to match against a
3453 submodule's path to determine if the submodule is of interest to git
3454 commands. See linkgit:gitsubmodules[7] for details.
3455
3456 submodule.recurse::
3457 Specifies if commands recurse into submodules by default. This
3458 applies to all commands that have a `--recurse-submodules` option,
3459 except `clone`.
3460 Defaults to false.
3461
3462 submodule.fetchJobs::
3463 Specifies how many submodules are fetched/cloned at the same time.
3464 A positive integer allows up to that number of submodules fetched
3465 in parallel. A value of 0 will give some reasonable default.
3466 If unset, it defaults to 1.
3467
3468 submodule.alternateLocation::
3469 Specifies how the submodules obtain alternates when submodules are
3470 cloned. Possible values are `no`, `superproject`.
3471 By default `no` is assumed, which doesn't add references. When the
3472 value is set to `superproject` the submodule to be cloned computes
3473 its alternates location relative to the superprojects alternate.
3474
3475 submodule.alternateErrorStrategy::
3476 Specifies how to treat errors with the alternates for a submodule
3477 as computed via `submodule.alternateLocation`. Possible values are
3478 `ignore`, `info`, `die`. Default is `die`.
3479
3480 tag.forceSignAnnotated::
3481 A boolean to specify whether annotated tags created should be GPG signed.
3482 If `--annotate` is specified on the command line, it takes
3483 precedence over this option.
3484
3485 tag.sort::
3486 This variable controls the sort ordering of tags when displayed by
3487 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3488 value of this variable will be used as the default.
3489
3490 tar.umask::
3491 This variable can be used to restrict the permission bits of
3492 tar archive entries. The default is 0002, which turns off the
3493 world write bit. The special value "user" indicates that the
3494 archiving user's umask will be used instead. See umask(2) and
3495 linkgit:git-archive[1].
3496
3497 transfer.fsckObjects::
3498 When `fetch.fsckObjects` or `receive.fsckObjects` are
3499 not set, the value of this variable is used instead.
3500 Defaults to false.
3501 +
3502 When set, the fetch or receive will abort in the case of a malformed
3503 object or a link to a nonexistent object. In addition, various other
3504 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
3505 and potential security issues like the existence of a `.GIT` directory
3506 or a malicious `.gitmodules` file (see the release notes for v2.2.1
3507 and v2.17.1 for details). Other sanity and security checks may be
3508 added in future releases.
3509 +
3510 On the receiving side, failing fsckObjects will make those objects
3511 unreachable, see "QUARANTINE ENVIRONMENT" in
3512 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
3513 instead be left unreferenced in the repository.
3514 +
3515 Due to the non-quarantine nature of the `fetch.fsckObjects`
3516 implementation it can not be relied upon to leave the object store
3517 clean like `receive.fsckObjects` can.
3518 +
3519 As objects are unpacked they're written to the object store, so there
3520 can be cases where malicious objects get introduced even though the
3521 "fetch" failed, only to have a subsequent "fetch" succeed because only
3522 new incoming objects are checked, not those that have already been
3523 written to the object store. That difference in behavior should not be
3524 relied upon. In the future, such objects may be quarantined for
3525 "fetch" as well.
3526 +
3527 For now, the paranoid need to find some way to emulate the quarantine
3528 environment if they'd like the same protection as "push". E.g. in the
3529 case of an internal mirror do the mirroring in two steps, one to fetch
3530 the untrusted objects, and then do a second "push" (which will use the
3531 quarantine) to another internal repo, and have internal clients
3532 consume this pushed-to repository, or embargo internal fetches and
3533 only allow them once a full "fsck" has run (and no new fetches have
3534 happened in the meantime).
3535
3536 transfer.hideRefs::
3537 String(s) `receive-pack` and `upload-pack` use to decide which
3538 refs to omit from their initial advertisements. Use more than
3539 one definition to specify multiple prefix strings. A ref that is
3540 under the hierarchies listed in the value of this variable is
3541 excluded, and is hidden when responding to `git push` or `git
3542 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3543 program-specific versions of this config.
3544 +
3545 You may also include a `!` in front of the ref name to negate the entry,
3546 explicitly exposing it, even if an earlier entry marked it as hidden.
3547 If you have multiple hideRefs values, later entries override earlier ones
3548 (and entries in more-specific config files override less-specific ones).
3549 +
3550 If a namespace is in use, the namespace prefix is stripped from each
3551 reference before it is matched against `transfer.hiderefs` patterns.
3552 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3553 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3554 is omitted from the advertisements but `refs/heads/master` and
3555 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3556 "have" lines. In order to match refs before stripping, add a `^` in front of
3557 the ref name. If you combine `!` and `^`, `!` must be specified first.
3558 +
3559 Even if you hide refs, a client may still be able to steal the target
3560 objects via the techniques described in the "SECURITY" section of the
3561 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3562 separate repository.
3563
3564 transfer.unpackLimit::
3565 When `fetch.unpackLimit` or `receive.unpackLimit` are
3566 not set, the value of this variable is used instead.
3567 The default value is 100.
3568
3569 uploadarchive.allowUnreachable::
3570 If true, allow clients to use `git archive --remote` to request
3571 any tree, whether reachable from the ref tips or not. See the
3572 discussion in the "SECURITY" section of
3573 linkgit:git-upload-archive[1] for more details. Defaults to
3574 `false`.
3575
3576 uploadpack.hideRefs::
3577 This variable is the same as `transfer.hideRefs`, but applies
3578 only to `upload-pack` (and so affects only fetches, not pushes).
3579 An attempt to fetch a hidden ref by `git fetch` will fail. See
3580 also `uploadpack.allowTipSHA1InWant`.
3581
3582 uploadpack.allowTipSHA1InWant::
3583 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3584 to accept a fetch request that asks for an object at the tip
3585 of a hidden ref (by default, such a request is rejected).
3586 See also `uploadpack.hideRefs`. Even if this is false, a client
3587 may be able to steal objects via the techniques described in the
3588 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3589 best to keep private data in a separate repository.
3590
3591 uploadpack.allowReachableSHA1InWant::
3592 Allow `upload-pack` to accept a fetch request that asks for an
3593 object that is reachable from any ref tip. However, note that
3594 calculating object reachability is computationally expensive.
3595 Defaults to `false`. Even if this is false, a client may be able
3596 to steal objects via the techniques described in the "SECURITY"
3597 section of the linkgit:gitnamespaces[7] man page; it's best to
3598 keep private data in a separate repository.
3599
3600 uploadpack.allowAnySHA1InWant::
3601 Allow `upload-pack` to accept a fetch request that asks for any
3602 object at all.
3603 Defaults to `false`.
3604
3605 uploadpack.keepAlive::
3606 When `upload-pack` has started `pack-objects`, there may be a
3607 quiet period while `pack-objects` prepares the pack. Normally
3608 it would output progress information, but if `--quiet` was used
3609 for the fetch, `pack-objects` will output nothing at all until
3610 the pack data begins. Some clients and networks may consider
3611 the server to be hung and give up. Setting this option instructs
3612 `upload-pack` to send an empty keepalive packet every
3613 `uploadpack.keepAlive` seconds. Setting this option to 0
3614 disables keepalive packets entirely. The default is 5 seconds.
3615
3616 uploadpack.packObjectsHook::
3617 If this option is set, when `upload-pack` would run
3618 `git pack-objects` to create a packfile for a client, it will
3619 run this shell command instead. The `pack-objects` command and
3620 arguments it _would_ have run (including the `git pack-objects`
3621 at the beginning) are appended to the shell command. The stdin
3622 and stdout of the hook are treated as if `pack-objects` itself
3623 was run. I.e., `upload-pack` will feed input intended for
3624 `pack-objects` to the hook, and expects a completed packfile on
3625 stdout.
3626
3627 uploadpack.allowFilter::
3628 If this option is set, `upload-pack` will support partial
3629 clone and partial fetch object filtering.
3630 +
3631 Note that this configuration variable is ignored if it is seen in the
3632 repository-level config (this is a safety measure against fetching from
3633 untrusted repositories).
3634
3635 uploadpack.allowRefInWant::
3636 If this option is set, `upload-pack` will support the `ref-in-want`
3637 feature of the protocol version 2 `fetch` command. This feature
3638 is intended for the benefit of load-balanced servers which may
3639 not have the same view of what OIDs their refs point to due to
3640 replication delay.
3641
3642 url.<base>.insteadOf::
3643 Any URL that starts with this value will be rewritten to
3644 start, instead, with <base>. In cases where some site serves a
3645 large number of repositories, and serves them with multiple
3646 access methods, and some users need to use different access
3647 methods, this feature allows people to specify any of the
3648 equivalent URLs and have Git automatically rewrite the URL to
3649 the best alternative for the particular user, even for a
3650 never-before-seen repository on the site. When more than one
3651 insteadOf strings match a given URL, the longest match is used.
3652 +
3653 Note that any protocol restrictions will be applied to the rewritten
3654 URL. If the rewrite changes the URL to use a custom protocol or remote
3655 helper, you may need to adjust the `protocol.*.allow` config to permit
3656 the request. In particular, protocols you expect to use for submodules
3657 must be set to `always` rather than the default of `user`. See the
3658 description of `protocol.allow` above.
3659
3660 url.<base>.pushInsteadOf::
3661 Any URL that starts with this value will not be pushed to;
3662 instead, it will be rewritten to start with <base>, and the
3663 resulting URL will be pushed to. In cases where some site serves
3664 a large number of repositories, and serves them with multiple
3665 access methods, some of which do not allow push, this feature
3666 allows people to specify a pull-only URL and have Git
3667 automatically use an appropriate URL to push, even for a
3668 never-before-seen repository on the site. When more than one
3669 pushInsteadOf strings match a given URL, the longest match is
3670 used. If a remote has an explicit pushurl, Git will ignore this
3671 setting for that remote.
3672
3673 user.email::
3674 Your email address to be recorded in any newly created commits.
3675 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3676 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3677
3678 user.name::
3679 Your full name to be recorded in any newly created commits.
3680 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3681 environment variables. See linkgit:git-commit-tree[1].
3682
3683 user.useConfigOnly::
3684 Instruct Git to avoid trying to guess defaults for `user.email`
3685 and `user.name`, and instead retrieve the values only from the
3686 configuration. For example, if you have multiple email addresses
3687 and would like to use a different one for each repository, then
3688 with this configuration option set to `true` in the global config
3689 along with a name, Git will prompt you to set up an email before
3690 making new commits in a newly cloned repository.
3691 Defaults to `false`.
3692
3693 user.signingKey::
3694 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3695 key you want it to automatically when creating a signed tag or
3696 commit, you can override the default selection with this variable.
3697 This option is passed unchanged to gpg's --local-user parameter,
3698 so you may specify a key using any method that gpg supports.
3699
3700 versionsort.prereleaseSuffix (deprecated)::
3701 Deprecated alias for `versionsort.suffix`. Ignored if
3702 `versionsort.suffix` is set.
3703
3704 versionsort.suffix::
3705 Even when version sort is used in linkgit:git-tag[1], tagnames
3706 with the same base version but different suffixes are still sorted
3707 lexicographically, resulting e.g. in prerelease tags appearing
3708 after the main release (e.g. "1.0-rc1" after "1.0"). This
3709 variable can be specified to determine the sorting order of tags
3710 with different suffixes.
3711 +
3712 By specifying a single suffix in this variable, any tagname containing
3713 that suffix will appear before the corresponding main release. E.g. if
3714 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3715 "1.0". If specified multiple times, once per suffix, then the order of
3716 suffixes in the configuration will determine the sorting order of tagnames
3717 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3718 configuration, then all "1.0-preX" tags will be listed before any
3719 "1.0-rcX" tags. The placement of the main release tag relative to tags
3720 with various suffixes can be determined by specifying the empty suffix
3721 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3722 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3723 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3724 "v4.8-bfsX".
3725 +
3726 If more than one suffixes match the same tagname, then that tagname will
3727 be sorted according to the suffix which starts at the earliest position in
3728 the tagname. If more than one different matching suffixes start at
3729 that earliest position, then that tagname will be sorted according to the
3730 longest of those suffixes.
3731 The sorting order between different suffixes is undefined if they are
3732 in multiple config files.
3733
3734 web.browser::
3735 Specify a web browser that may be used by some commands.
3736 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3737 may use it.
3738
3739 worktree.guessRemote::
3740 With `add`, if no branch argument, and neither of `-b` nor
3741 `-B` nor `--detach` are given, the command defaults to
3742 creating a new branch from HEAD. If `worktree.guessRemote` is
3743 set to true, `worktree add` tries to find a remote-tracking
3744 branch whose name uniquely matches the new branch name. If
3745 such a branch exists, it is checked out and set as "upstream"
3746 for the new branch. If no such match can be found, it falls
3747 back to creating a new branch from the current HEAD.