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