config: add new index.threads config setting
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
2de9b711
TA
4The Git configuration file contains a number of variables that affect
5the Git commands' behavior. The `.git/config` file in each repository
66e35fcb
SB
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
773002a7 8fallback values for the `.git/config` file. The file `/etc/gitconfig`
66e35fcb 9can be used to store a system-wide default configuration.
5ea5621f 10
2de9b711 11The configuration variables are used by both the Git plumbing
b7ee2266
SB
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
1ab661dd 14dot-separated segment and the section name is everything before the last
e0a4aae8
LP
15dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
a5285b6c
JH
17variables may appear multiple times; we say then that the variable is
18multivalued.
1ab661dd 19
e136f33b
JN
20Syntax
21~~~~~~
22
1ab661dd 23The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
24ignored. The '#' and ';' characters begin comments to the end of line,
25blank lines are ignored.
26
27The file consists of sections and variables. A section begins with
28the name of the section in square brackets and continues until the next
05c3e5c7 29section begins. Section names are case-insensitive. Only alphanumeric
dcb11263 30characters, `-` and `.` are allowed in section names. Each variable
773002a7
SB
31must belong to some section, which means that there must be a section
32header before the first setting of a variable.
e136f33b
JN
33
34Sections can be further divided into subsections. To begin a subsection
35put its name in double quotes, separated by space from the section name,
773002a7 36in the section header, like in the example below:
e136f33b
JN
37
38--------
39 [section "subsection"]
40
41--------
42
b7ee2266 43Subsection names are case sensitive and can contain any characters except
1feb0617
DB
44newline and the null byte. Doublequote `"` and backslash can be included
45by escaping them as `\"` and `\\`, respectively. Backslashes preceding
46other 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.
48Variables may belong directly to a section or to a given subsection. You
49can have `[section]` if you have `[section "subsection"]`, but you don't
50need to.
e136f33b 51
f7376329
CMN
52There is also a deprecated `[section.subsection]` syntax. With this
53syntax, the subsection name is converted to lower-case and is also
54compared case sensitively. These subsection names follow the same
55restrictions as section names.
e136f33b 56
2ceb639f
NS
57All the other lines (and the remainder of the line after the section
58header) are recognized as setting variables, in the form
1c448b3b
JH
59'name = value' (or just 'name', which is a short-hand to say that
60the variable is the boolean "true").
e0a4aae8 61The variable names are case-insensitive, allow only alphanumeric characters
a5285b6c 62and `-`, and must start with an alphabetic character.
e136f33b 63
ff5507ed
JH
64A line that defines a value can be continued to the next line by
65ending it with a `\`; the backquote and the end-of-line are
66stripped. Leading whitespaces after 'name =', the remainder of the
67line after the first comment character '#' or ';', and trailing
68whitespaces of the line are discarded unless they are enclosed in
69double quotes. Internal whitespaces within the value are retained
70verbatim.
e136f33b 71
ff5507ed
JH
72Inside double quotes, double quote `"` and backslash `\` characters
73must be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 74
dcb11263
CJ
75The following escape sequences (beside `\"` and `\\`) are recognized:
76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
a58088ab
JL
77and `\b` for backspace (BS). Other char escape sequences (including octal
78escape sequences) are invalid.
e136f33b 79
1ab661dd 80
9b25a0b5
JK
81Includes
82~~~~~~~~
83
9d71d94d
JK
84The `include` and `includeIf` sections allow you to include config
85directives from another source. These sections behave identically to
86each other with the exception that `includeIf` sections may be ignored
87if their condition does not evaluate to true; see "Conditional includes"
88below.
89
df0233be 90You can include a config file from another by setting the special
9d71d94d
JK
91`include.path` (or `includeIf.*.path`) variable to the name of the file
92to be included. The variable takes a pathname as its value, and is
93subject to tilde expansion. These variables can be given multiple times.
dca83abd 94
a076df28
JK
95The contents of the included file are inserted immediately, as if they
96had been found at the location of the include directive. If the value of the
9d71d94d 97variable is a relative path, the path is considered to
1050e987
NTND
98be relative to the configuration file in which the include directive
99was found. See below for examples.
dca83abd 100
3efd0bed
NTND
101Conditional includes
102~~~~~~~~~~~~~~~~~~~~
103
104You can include a config file from another conditionally by setting a
105`includeIf.<condition>.path` variable to the name of the file to be
9d71d94d 106included.
3efd0bed
NTND
107
108The condition starts with a keyword followed by a colon and some data
109whose format and meaning depends on the keyword. Supported keywords
110are:
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+
118The .git location may be auto-discovered, or come from `$GIT_DIR`
119environment variable. If the repository is auto discovered via a .git
120file (e.g. from submodules, or a linked worktree), the .git location
121would be the final location where the .git directory is, not where the
122.git file is.
123+
124The pattern can contain standard globbing wildcards and two additional
125ones, `**/` and `/**`, that can match multiple path components. Please
126refer 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
146A few more notes on matching via `gitdir` and `gitdir/i`:
147
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
149
0624c63c
ÆAB
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+
155This was not the case in the initial release of this feature in
156v2.13.0, which only matched the realpath version. Configuration that
157wants to be compatible with the initial release of this feature needs
158to either specify only the realpath version, or both versions.
159
3efd0bed
NTND
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
9b25a0b5 162
1ab661dd
PB
163Example
164~~~~~~~
165
166 # Core variables
167 [core]
168 ; Don't trust file modes
169 filemode = false
170
171 # Our diff algorithm
172 [diff]
6bb9e51b 173 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
174 renames = true
175
910c00c8
AK
176 [branch "devel"]
177 remote = origin
178 merge = refs/heads/devel
179
e136f33b
JN
180 # Proxy settings
181 [core]
29093c28 182 gitProxy="ssh" for "kernel.org"
e136f33b 183 gitProxy=default-proxy ; for the rest
910c00c8 184
9b25a0b5
JK
185 [include]
186 path = /path/to/foo.inc ; include by absolute path
ce933ebd
JK
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
9b25a0b5 189
3efd0bed
NTND
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
5f7b91ba 201
994cd6c7
JK
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
5f7b91ba
JH
208Values
209~~~~~~
210
211Values of many variables are treated as a simple string, but there
212are variables that take values of specific types and there are rules
213as to how to spell them.
214
215boolean::
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
7f0a02be
AH
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
5f7b91ba
JH
223 is taken as true.
224
7f0a02be
AH
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
5f7b91ba 227+
bcf9626a 228When converting value to the canonical form using `--bool` type
7f0a02be 229specifier, 'git config' will ensure that the output is "true" or
5f7b91ba
JH
230"false" (spelled in lowercase).
231
232integer::
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
b92c1a28 237color::
adb33566
JK
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.
5f456b3c 241+
adb33566
JK
242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
243`blue`, `magenta`, `cyan` and `white`. The first color given is the
244foreground; the second is the background.
5ee87585 245+
adb33566
JK
246Colors may also be given as numbers between 0 and 255; these use ANSI
247256-color mode (but note that not all terminals may support this). If
248your terminal supports it, you may also specify 24-bit RGB values as
249hex, like `#ff0ab3`.
250+
9dc3515c
JK
251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
252`italic`, and `strike` (for crossed-out or "strikethrough" letters).
253The position of any attributes with respect to the colors
54590a0e
JK
254(before, after, or in between), doesn't matter. Specific attributes may
255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
256`no-ul`, etc).
adb33566 257+
512aba26
JK
258An empty color string produces no color effect at all. This can be used
259to avoid coloring specific elements without disabling color entirely.
260+
adb33566
JK
261For git's pre-defined color slots, the attributes are meant to be reset
262at the beginning of each item in the colored output. So setting
263`color.decorate.branch` to `black` will paint that branch name in a
264plain `black`, even if the previous thing on the same output line (e.g.
265opening parenthesis before the list of branch names in `log --decorate`
266output) is set to be painted with `bold` or some other attribute.
267However, custom log formats may do more complicated and layered
268coloring, and the negated forms may be useful there.
b92c1a28 269
dca83abd
JH
270pathname::
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
5f7b91ba 277
1ab661dd
PB
278Variables
279~~~~~~~~~
280
281Note that this list is non-comprehensive and not necessarily complete.
b8936cf0 282For command-specific variables, you will find a more detailed description
93728b23
CA
283in the appropriate manual page.
284
285Other git-related tools may and do use their own variables. When
286inventing new variables for use in your own tool, make sure their
287names do not conflict with those that are used by Git itself and
288other popular tools, and describe them in your documentation.
289
1ab661dd 290
75194438 291advice.*::
26e94af0
JH
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':
75194438
JK
295+
296--
1184564e 297 pushUpdateRejected::
f25950f3 298 Set this variable to 'false' if you want to disable
009055f3 299 'pushNonFFCurrent',
75e5c0dc
JH
300 'pushNonFFMatching', 'pushAlreadyExists',
301 'pushFetchFirst', and 'pushNeedsForce'
b4505682 302 simultaneously.
f25950f3
CT
303 pushNonFFCurrent::
304 Advice shown when linkgit:git-push[1] fails due to a
305 non-fast-forward update to the current branch.
f25950f3
CT
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.
b4505682
CR
311 pushAlreadyExists::
312 Shown when linkgit:git-push[1] rejects an update that
313 does not qualify for fast-forwarding (e.g., a tag.)
75e5c0dc
JH
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
a8a5406a
RH
321 object that is not a commit-ish, or make the remote
322 ref point at an object that is not a commit-ish.
edf563fb 323 statusHints::
83c750ac 324 Show directions on how to proceed from the current
552755a8 325 state in the output of linkgit:git-status[1], in
83c750ac 326 the template shown when writing commit messages in
552755a8
MM
327 linkgit:git-commit[1], and in the help message shown
328 by linkgit:git-checkout[1] when switching branch.
6a38ef2c
NTND
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.
4c371f91
MM
333 commitBeforeMerge::
334 Advice shown when linkgit:git-merge[1] refuses to
6b677a28 335 merge to avoid overwriting local changes.
d38a30df 336 resolveConflict::
4f021b34 337 Advice shown by various commands when conflicts
d38a30df 338 prevent the operation from being performed.
b706fcfe
JK
339 implicitIdentity::
340 Advice on how to set your identity configuration when
341 your information is guessed from the system username and
26e94af0 342 domain name.
13be3e31 343 detachedHead::
26e94af0 344 Advice shown when you used linkgit:git-checkout[1] to
13be3e31 345 move to the detach HEAD state, to instruct how to create
26e94af0 346 a local branch after the fact.
ad8d5104
ÆAB
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
8d7b558b
ÆAB
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.
14bf2d58
PG
357 amWorkDir::
358 Advice that shows the location of the patch file when
359 linkgit:git-am[1] fails to apply it.
7e309446
MLM
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.
53213994
JK
363 addEmbeddedRepo::
364 Advice on what to do when you've accidentally added one
365 git repo inside of another.
f805a00a 366 ignoredHook::
928f0ab4 367 Advice shown if a hook is ignored because the hook is not
f805a00a 368 set as executable.
abfb04d0
LS
369 waitingForEditor::
370 Print a message to the terminal whenever Git is waiting for
371 editor input from the user.
75194438
JK
372--
373
1ab661dd 374core.fileMode::
ecdab412
TB
375 Tells Git if the executable bit of files in the working tree
376 is to be honored.
7b357240 377+
ecdab412 378Some filesystems lose the executable bit when a file that is
449456ad 379marked as executable is checked out, or checks out a
ecdab412
TB
380non-executable file with executable bit on.
381linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
382to see if it handles the executable bit correctly
383and this variable is automatically set as necessary.
384+
385A repository, however, may be on a filesystem that handles
386the filemode correctly, and this variable is set to 'true'
387when created, but later may be made accessible from another
388environment that loses the filemode (e.g. exporting ext4 via
389CIFS mount, visiting a Cygwin created repository with
390Git for Windows or Eclipse).
391In such a case it may be necessary to set this variable to 'false'.
392See linkgit:git-update-index[1].
393+
394The default is true (when core.filemode is not specified in the config file).
1ab661dd 395
f30afdab
JS
396core.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
da0005b8 402core.ignoreCase::
48294b51 403 Internal variable which enables various workarounds to enable
2de9b711 404 Git to work better on filesystems that are not case sensitive,
48294b51
MS
405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
406 finds "makefile" when Git expects "Makefile", Git will assume
7b357240
MO
407 it is really the same file, and continue to remember it as
408 "Makefile".
409+
410The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
da0005b8 411will probe and set core.ignoreCase true if appropriate when the repository
7b357240 412is created.
48294b51
MS
413+
414Git relies on the proper configuration of this variable for your operating
415and file system. Modifying this value may result in unexpected behavior.
7b357240 416
da0005b8 417core.precomposeUnicode::
2de9b711 418 This option is only used by Mac OS implementation of Git.
da0005b8 419 When core.precomposeUnicode=true, Git reverts the unicode decomposition
76759c7d
TB
420 of filenames done by Mac OS. This is useful when sharing a repository
421 between Mac OS and Linux or Windows.
2de9b711
TA
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.
76759c7d 425
a42643aa
JK
426core.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
2b4c6efc
JS
431core.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
780494b1
BP
437core.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
1ce4790b
AR
444core.trustctime::
445 If false, the ctime differences between the index and the
f7d650c0 446 working tree are ignored; useful when the inode change time
1ce4790b
AR
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
66f9e7a6
CC
451core.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
435ec090
CC
455core.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
da0005b8 464core.checkStat::
9bf5d4c4
JH
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+
475There are implementations of Git that do not leave usable values in
476some fields (e.g. JGit); by excluding these fields from the
477comparison, the `minimal` mode may help interoperability when the
478same repository is used by these other systems at the same time.
c08e4d5b 479
da0005b8 480core.quotePath::
860cd699
AH
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.
9378c161 494
942e7747
EB
495core.eol::
496 Sets the line ending type to use in the working directory for
70ad8c8d
TB
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
942e7747
EB
500 linkgit:gitattributes[5] for more information on end-of-line
501 conversion.
5cb71f82 502
21e5ad50 503core.safecrlf::
2de9b711 504 If true, makes Git check if converting `CRLF` is reversible when
fd6cce9e 505 end-of-line conversion is active. Git will verify if a command
21e5ad50
SP
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
2de9b711
TA
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
21e5ad50
SP
512 irreversible conversion but continue the operation.
513+
514CRLF conversion bears a slight chance of corrupting data.
2de9b711 515When it is enabled, Git will convert CRLF to LF during commit and LF to
21e5ad50 516CRLF during checkout. A file that contains a mixture of LF and
2de9b711 517CRLF before the commit cannot be recreated by Git. For text
21e5ad50
SP
518files this is the right thing to do: it corrects line endings
519such that we have only LF line endings in the repository.
520But for binary files that are accidentally classified as text the
521conversion can corrupt data.
522+
523If you recognize such corruption early you can easily fix it by
524setting the conversion type explicitly in .gitattributes. Right
525after committing you still have the original file in your work
526tree and this file is not yet corrupted. You can explicitly tell
2de9b711 527Git that this file is binary and Git will handle the file
21e5ad50
SP
528appropriately.
529+
530Unfortunately, the desired effect of cleaning up text files with
531mixed line endings and the undesired effect of corrupting binary
532files cannot be distinguished. In both cases CRLFs are removed
533in an irreversible way. For text files this is the right thing
534to do because CRLFs are line endings, while for binary files
535converting CRLFs corrupts data.
536+
537Note, this safety check does not mean that a checkout will generate a
538file identical to the original file for a different setting of
942e7747
EB
539`core.eol` and `core.autocrlf`, but only for the current one. For
540example, a text file with `LF` would be accepted with `core.eol=lf`
541and could later be checked out with `core.eol=crlf`, in which case the
21e5ad50
SP
542resulting file would contain `CRLF`, although the original file
543contained `LF`. However, in both work trees the line endings would be
544consistent, that is either all `LF` or all `CRLF`, but never mixed. A
545file with mixed line endings would be reported by the `core.safecrlf`
546mechanism.
547
942e7747 548core.autocrlf::
65237284
TB
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',
942e7747
EB
554 in which case no output conversion is performed.
555
e92d6225
LS
556core.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
78a8d641
JS
562core.symlinks::
563 If false, symbolic links are checked out as small plain files that
5162e697
DM
564 contain the link text. linkgit:git-update-index[1] and
565 linkgit:git-add[1] will not change the recorded type to regular
78a8d641 566 file. Useful on filesystems like FAT that do not support
7b357240
MO
567 symbolic links.
568+
569The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
570will probe and set core.symlinks false if appropriate when the repository
571is created.
78a8d641 572
1ab661dd
PB
573core.gitProxy::
574 A "proxy command" to execute (as 'command host port') instead
575 of establishing direct connection to the remote server when
2de9b711 576 using the Git protocol for fetching. If the variable value is
1ab661dd
PB
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.
b8936cf0 581+
eee7f4a2 582Can be overridden by the `GIT_PROXY_COMMAND` environment variable
b8936cf0
FD
583(which always applies universally, without the special "for"
584handling).
642d0844
ES
585+
586The special string `none` can be used as the proxy command to
587specify that no proxy be used for a given domain pattern.
588This is useful for excluding servers inside a firewall from
589proxy use, while defaulting to a common proxy for external domains.
1ab661dd 590
3c8ede3f
NTND
591core.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
1ab661dd 598core.ignoreStat::
92be938e
PO
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+
603When files are modified outside of Git, the user will need to stage
604the modified files explicitly (e.g. see 'Examples' section in
605linkgit:git-update-index[1]).
606Git will not normally detect changes to those files.
607+
608This is useful on systems where lstat() calls are very slow, such as
609CIFS/Microsoft Windows.
610+
611False by default.
1ab661dd 612
9f0bb90d
JH
613core.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.
1ab661dd 618
e4a15f40
SP
619core.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
5162e697 623 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 624+
5162e697
DM
625This setting is automatically guessed by linkgit:git-clone[1] or
626linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
627repository that ends in "/.git" is assumed to be not bare (bare =
628false), while all other repositories are assumed to be bare (bare
629= true).
630
892c41b9 631core.worktree::
ea472c1e 632 Set the path to the root of the working tree.
47d81b5c 633 If `GIT_COMMON_DIR` environment variable is set, core.worktree
31e26ebc 634 is ignored and not used for determining the root of working tree.
47d81b5c 635 This can be overridden by the `GIT_WORK_TREE` environment
bcf9626a 636 variable and the `--work-tree` command-line option.
d424a47e 637 The value can be an absolute path or relative to the path to
ea472c1e
JH
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
302cc11a 641 --work-tree, GIT_WORK_TREE and core.worktree is specified,
ea472c1e 642 the current working directory is regarded as the top level
98acf759 643 of your working tree.
ea472c1e
JH
644+
645Note that this variable is honored even when set in a configuration
646file in a ".git" subdirectory of a directory and its value differs
647from the latter directory (e.g. "/path/to/.git/config" has
648core.worktree set to "/different/path"), which is most likely a
2de9b711 649misconfiguration. Running Git commands in the "/path/to" directory will
ea472c1e
JH
650still use "/different/path" as the root of the work tree and can cause
651confusion unless you know what you are doing (e.g. you are creating a
652read-only snapshot of the same index to a location different from the
653repository's usual working tree).
892c41b9 654
6de08ae6 655core.logAllRefUpdates::
14cd5607 656 Enable the reflog. Updates to a ref <ref> is logged to the file
f212dcc7 657 "`$GIT_DIR/logs/<ref>`", by appending the new and old
d5fa1f1a 658 SHA-1, the date/time and the reason of the update, but
4057deb5 659 only when the file exists. If this configuration
d0c93194 660 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
cd8e3711 661 file is automatically created for branch heads (i.e. under
d0c93194
CW
662 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
663 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
341fb286
CW
664 If it is set to `always`, then a missing reflog is automatically
665 created for any ref under `refs/`.
a862f97e
JH
666+
667This information can be used to determine what commit
668was the tip of a branch "2 days ago".
669+
670This value is true by default in a repository that has
671a working directory associated with it, and false by
672default in a bare repository.
6de08ae6 673
1ab661dd
PB
674core.repositoryFormatVersion::
675 Internal variable identifying the repository format and layout
676 version.
677
678core.sharedRepository::
d5dc6a76
JF
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
2de9b711 683 group-shareable. When 'umask' (or 'false'), Git will use permissions
06cbe855
HO
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
098082fb
JH
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
06cbe855
HO
690 repository that is group-readable but not group-writable.
691 See linkgit:git-init[1]. False by default.
1ab661dd
PB
692
693core.warnAmbiguousRefs::
2de9b711 694 If true, Git will warn you if the ref name you passed it is ambiguous
48dfe969 695 and might match multiple refs in the repository. True by default.
1ab661dd 696
3d3e95af 697core.compression::
960ccca6
DH
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.
dec92309 701 If set, this provides a default to other compression variables,
ae9f6311 702 such as `core.looseCompression` and `pack.compression`.
960ccca6 703
da0005b8 704core.looseCompression::
12f6c308 705 An integer -1..9, indicating the compression level for objects that
960ccca6 706 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 707 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 708 slowest. If not set, defaults to core.compression. If that is
de1b2460 709 not set, defaults to 1 (best speed).
12f6c308 710
60bb8b14
SP
711core.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
eb92242f 716 performance due to increased calls to the operating system's
60bb8b14 717 memory manager, but may improve performance when accessing
22bac0ea
SP
718 a large number of large pack files.
719+
720Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
721MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
722be reasonable for all users/operating systems. You probably do
723not need to adjust this value.
eb92242f
SP
724+
725Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 726
77ccc5bb
SP
727core.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.
22bac0ea 732+
b24a8db1
JK
733Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
734unlimited) on 64 bit platforms.
22bac0ea
SP
735This should be reasonable for all users/operating systems, except on
736the largest projects. You probably do not need to adjust this value.
eb92242f
SP
737+
738Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 739
18bdec11
SP
740core.deltaBaseCacheLimit::
741 Maximum number of bytes to reserve for caching base objects
6b677a28 742 that may be referenced by multiple deltified objects. By storing the
18bdec11
SP
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+
4874f544 747Default is 96 MiB on all platforms. This should be reasonable
18bdec11
SP
748for all users/operating systems, except on the largest projects.
749You probably do not need to adjust this value.
750+
751Common unit suffixes of 'k', 'm', or 'g' are supported.
752
5eef828b
SP
753core.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
6bf3b813
NTND
757 slight expense of increased disk usage. Additionally files
758 larger than this size are always treated as binary.
5eef828b
SP
759+
760Default is 512 MiB on all platforms. This should be reasonable
761for most projects as source code and other text files can still
762be delta compressed, but larger binary media files won't be.
763+
764Common unit suffixes of 'k', 'm', or 'g' are supported.
5eef828b 765
da0005b8 766core.excludesFile::
dca83abd
JH
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'.
f212dcc7
BN
770 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
771 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
dc79687e 772 is used instead. See linkgit:gitignore[5].
0ba956d3 773
da0005b8 774core.askPass::
d3e7da89
AK
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
eee7f4a2 777 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
453842c9 778 environment variable. If not set, fall back to the value of the
47d81b5c 779 `SSH_ASKPASS` environment variable or, failing that, a simple password
453842c9 780 prompt. The external program shall be given a suitable prompt as
06ab60c0 781 command-line argument and write the password on its STDOUT.
d3e7da89 782
da0005b8 783core.attributesFile::
6df42ab9 784 In addition to '.gitattributes' (per-directory) and
2de9b711 785 '.git/info/attributes', Git looks into this file for attributes
6df42ab9 786 (see linkgit:gitattributes[5]). Path expansions are made the same
da0005b8 787 way as for `core.excludesFile`. Its default value is
f212dcc7
BN
788 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
789 set or empty, `$HOME/.config/git/attributes` is used instead.
6df42ab9 790
867ad08a
ÆAB
791core.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+
798The path can be either absolute or relative. A relative path is
799taken as relative to the directory where the hooks are run (see
800the "DESCRIPTION" section of linkgit:githooks[5]).
801+
802This configuration variable is useful in cases where you'd like to
803centrally configure your Git hooks instead of configuring them on a
804per-repository basis, or as a more flexible and centralized
805alternative to having an `init.templateDir` where you've changed
806default hooks.
807
ef0c2abf 808core.editor::
e7e183d6
KM
809 Commands such as `commit` and `tag` that let you edit
810 messages by launching an editor use the value of this
ef0c2abf 811 variable when it is set, and the environment variable
b4479f07 812 `GIT_EDITOR` is not set. See linkgit:git-var[1].
ef0c2abf 813
da0005b8 814core.commentChar::
e7e183d6 815 Commands such as `commit` and `tag` that let you edit
eff80a9f
JH
816 messages consider a line that begins with this character
817 commented, and removes them after the editor returns
818 (default '#').
84c9dc2c
NTND
819+
820If set to "auto", `git-commit` would select a character that is not
821the beginning character of any line in existing commit messages.
eff80a9f 822
4ff0f01c
MH
823core.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
f4ab4f3a
MH
829core.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
821881d8 835sequence.editor::
3322ad42 836 Text editor used by `git rebase -i` for editing the rebase instruction file.
821881d8
PO
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
54adf370 841core.pager::
97d01f2a
JH
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+
b3275838 848When the `LESS` environment variable is unset, Git sets it to `FRX`
97d01f2a
JH
849(if `LESS` environment variable is set, Git does not change it at
850all). If you want to selectively override Git's default setting
b3275838 851for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
97d01f2a 852be passed to the shell by Git, which will translate the final
b3275838
MM
853command to `LESS=FRX less -S`. The environment does not set the
854`S` option but the command line does, instructing less to truncate
855long lines. Similarly, setting `core.pager` to `less -+F` will
856deactivate the `F` option specified by the environment from the
857command-line, deactivating the "quit if one screen" behavior of
858`less`. One can specifically activate some flags for particular
859commands: for example, setting `pager.blame` to `less -S` enables
860line truncation only for `git blame`.
e54c1f2d
JN
861+
862Likewise, when the `LV` environment variable is unset, Git sets it
863to `-c`. You can override this setting by exporting `LV` with
864another value or setting `core.pager` to `lv +c`.
54adf370 865
91af7ae5
JH
866core.whitespace::
867 A comma separated list of common whitespace problems to
0b444cdb
TR
868 notice. 'git diff' will use `color.diff.whitespace` to
869 highlight them, and 'git apply --whitespace=error' will
c921cc92
JH
870 consider them as errors. You can prefix `-` to disable
871 any of them (e.g. `-trailing-space`):
91af7ae5 872+
aeb84b05 873* `blank-at-eol` treats trailing whitespaces at the end of the line
91af7ae5
JH
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).
2ce4fee8
WL
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).
3e3ec2ab
CW
881* `tab-in-indent` treats a tab character in the initial indent part of
882 the line as an error (not enabled by default).
77b15bbd
JH
883* `blank-at-eof` treats blank lines added at the end of file as an error
884 (enabled by default).
aeb84b05
JH
885* `trailing-space` is a short-hand to cover both `blank-at-eol` and
886 `blank-at-eof`.
b2979ff5
JH
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).
f4b05a49 891* `tabwidth=<n>` tells how many character positions a tab occupies; this
2de9b711 892 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
f4b05a49 893 errors. The default tab width is 8. Allowed values are 1 to 63.
91af7ae5 894
da0005b8 895core.fsyncObjectFiles::
aafe9fba
LT
896 This boolean will enable 'fsync()' when writing object files.
897+
898This is a total waste of time and effort on a filesystem that orders
899data writes properly, but can be useful for filesystems that do not use
900journalling (traditional UNIX filesystems) or that only journal metadata
901and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
902
da0005b8 903core.preloadIndex::
671c9b7e
LT
904 Enable parallel index preload for operations like 'git diff'
905+
906This can speed up operations like 'git diff' and 'git status' especially
907on filesystems like NFS that have weak caching semantics and thus
299e2987 908relatively high IO latencies. When enabled, Git will do the
671c9b7e 909index comparison to the filesystem data in parallel, allowing
299e2987 910overlapping IO's. Defaults to true.
671c9b7e 911
348df166
JS
912core.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+
917On some file system/operating system combinations, this is unreliable.
918Set this config setting to 'rename' there; However, This will remove the
919check that makes sure that existing object files will not get overwritten.
be66a6c4 920
a97a7468
JS
921core.notesRef::
922 When showing commit messages, also show notes which are stored in
9eb3f816
JN
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.
a97a7468 926+
9eb3f816 927This setting defaults to "refs/notes/commits", and it can be overridden by
eee7f4a2 928the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
a97a7468 929
d915114a
DS
930core.commitGraph::
931 If true, then git will read the commit-graph file (if it exists)
932 to parse the graph structure of commits. Defaults to false. See
933 linkgit:git-commit-graph[1] for more information.
1b70dfd5 934
da4398d6
JK
935core.useReplaceRefs::
936 If set to `false`, behave as if the `--no-replace-objects`
937 option was given on the command line. See linkgit:git[1] and
938 linkgit:git-replace[1] for more information.
939
c4d25228
DS
940core.multiPackIndex::
941 Use the multi-pack-index file to track multiple packfiles using a
942 single index. See link:technical/multi-pack-index.html[the
943 multi-pack-index design document].
944
08aefc9e
NTND
945core.sparseCheckout::
946 Enable "sparse checkout" feature. See section "Sparse checkout" in
947 linkgit:git-read-tree[1] for more information.
948
a71f09fe 949core.abbrev::
48d5014d
JH
950 Set the length object names are abbreviated to. If
951 unspecified or set to "auto", an appropriate value is
952 computed based on the approximate number of packed objects
953 in your repository, which hopefully is enough for
954 abbreviated object names to stay unique for some time.
fb87327a 955 The minimum length is 4.
dce96489 956
6b3020a2 957add.ignoreErrors::
502e7f98 958add.ignore-errors (deprecated)::
0b444cdb 959 Tells 'git add' to continue adding files when some files cannot be
bcf9626a 960 added due to indexing errors. Equivalent to the `--ignore-errors`
394e1505
JH
961 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
962 as it does not follow the usual naming convention for configuration
963 variables.
13bd2134 964
4514ad4f 965alias.*::
5162e697 966 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
967 after defining "alias.last = cat-file commit HEAD", the invocation
968 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84 969 confusion and troubles with script usage, aliases that
2de9b711 970 hide existing Git commands are ignored. Arguments are split by
99b41c84 971 spaces, the usual shell quoting and escaping is supported.
a79c3a1b 972 A quote pair or a backslash can be used to quote them.
f368f5a6
JH
973+
974If the alias expansion is prefixed with an exclamation point,
975it will be treated as a shell command. For example, defining
976"alias.new = !gitk --all --not ORIG_HEAD", the invocation
977"git new" is equivalent to running the shell command
595b8dbf
SC
978"gitk --all --not ORIG_HEAD". Note that shell commands will be
979executed from the top-level directory of a repository, which may
980not necessarily be the current directory.
eee7f4a2 981`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
7cf16a14 982from the original current directory. See linkgit:git-rev-parse[1].
dfd42a3c 983
e80d4cbe
SH
984am.keepcr::
985 If true, git-am will call git-mailsplit for patches in mbox format
bcf9626a 986 with parameter `--keep-cr`. In this case git-mailsplit will
6b677a28 987 not remove `\r` from lines ending with `\r\n`. Can be overridden
bcf9626a 988 by giving `--no-keep-cr` from the command line.
e80d4cbe
SH
989 See linkgit:git-am[1], linkgit:git-mailsplit[1].
990
e97a5e76
RL
991am.threeWay::
992 By default, `git am` will fail if the patch does not apply cleanly. When
993 set to true, this setting tells `git am` to fall back on 3-way merge if
994 the patch records the identity of blobs it is supposed to apply to and
995 we have those blobs available locally (equivalent to giving the `--3way`
996 option from the command line). Defaults to `false`.
997 See linkgit:git-am[1].
998
da0005b8 999apply.ignoreWhitespace::
0b444cdb 1000 When set to 'change', tells 'git apply' to ignore changes in
bcf9626a 1001 whitespace, in the same way as the `--ignore-space-change`
86c91f91 1002 option.
0b444cdb 1003 When set to one of: no, none, never, false tells 'git apply' to
86c91f91
GB
1004 respect all whitespace differences.
1005 See linkgit:git-apply[1].
1006
1ab661dd 1007apply.whitespace::
0b444cdb 1008 Tells 'git apply' how to handle whitespaces, in the same way
bcf9626a 1009 as the `--whitespace` option. See linkgit:git-apply[1].
1ab661dd 1010
de0bc11d
SB
1011blame.blankBoundary::
1012 Show blank commit object name for boundary commits in
1013 linkgit:git-blame[1]. This option defaults to false.
1014
8578037b
NTND
1015blame.coloring::
1016 This determines the coloring scheme to be applied to blame
1017 output. It can be 'repeatedLines', 'highlightRecent',
1018 or 'none' which is the default.
de0bc11d
SB
1019
1020blame.date::
1021 Specifies the format used to output dates in linkgit:git-blame[1].
1022 If unset the iso format is used. For supported values,
1023 see the discussion of the `--date` option at linkgit:git-log[1].
1024
8578037b
NTND
1025blame.showEmail::
1026 Show the author email instead of author name in linkgit:git-blame[1].
1027 This option defaults to false.
1028
1029blame.showRoot::
1030 Do not treat root commits as boundaries in linkgit:git-blame[1].
1031 This option defaults to false.
1032
da0005b8 1033branch.autoSetupMerge::
add0951a 1034 Tells 'git branch' and 'git checkout' to set up new branches
572fc81d
JS
1035 so that linkgit:git-pull[1] will appropriately merge from the
1036 starting point branch. Note that even if this option is not set,
9902387d 1037 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
1038 and `--no-track` options. The valid settings are: `false` -- no
1039 automatic setup is done; `true` -- automatic setup is done when the
29b9a66f
MM
1040 starting point is a remote-tracking branch; `always` --
1041 automatic setup is done when the starting point is either a
1042 local branch or remote-tracking
572fc81d 1043 branch. This option defaults to true.
9902387d 1044
da0005b8 1045branch.autoSetupRebase::
0b444cdb 1046 When a new branch is created with 'git branch' or 'git checkout'
2de9b711 1047 that tracks another branch, this variable tells Git to set
c998ae9b
DS
1048 up pull to rebase instead of merge (see "branch.<name>.rebase").
1049 When `never`, rebase is never automatically set to true.
1050 When `local`, rebase is set to true for tracked branches of
1051 other local branches.
1052 When `remote`, rebase is set to true for tracked branches of
29b9a66f 1053 remote-tracking branches.
c998ae9b
DS
1054 When `always`, rebase will be set to true for all tracking
1055 branches.
da0005b8 1056 See "branch.autoSetupMerge" for details on how to set up a
c998ae9b
DS
1057 branch to track another branch.
1058 This option defaults to never.
1059
560ae1c1
SM
1060branch.sort::
1061 This variable controls the sort ordering of branches when displayed by
1062 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1063 value of this variable will be used as the default.
1064 See linkgit:git-for-each-ref[1] field names for valid values.
1065
648ad18f 1066branch.<name>.remote::
224c2171
RR
1067 When on branch <name>, it tells 'git fetch' and 'git push'
1068 which remote to fetch from/push to. The remote to push to
da0005b8 1069 may be overridden with `remote.pushDefault` (for all branches).
9f765ce6 1070 The remote to push to, for the current branch, may be further
da0005b8 1071 overridden by `branch.<name>.pushRemote`. If no remote is
9f765ce6 1072 configured, or if you are not on any branch, it defaults to
da0005b8 1073 `origin` for fetching and `remote.pushDefault` for pushing.
b85ecea6
PO
1074 Additionally, `.` (a period) is the current local repository
1075 (a dot-repository), see `branch.<name>.merge`'s final note below.
9f765ce6 1076
da0005b8 1077branch.<name>.pushRemote::
9f765ce6 1078 When on branch <name>, it overrides `branch.<name>.remote` for
da0005b8 1079 pushing. It also overrides `remote.pushDefault` for pushing
9f765ce6
RR
1080 from branch <name>. When you pull from one place (e.g. your
1081 upstream) and push to another place (e.g. your own publishing
da0005b8 1082 repository), you would want to set `remote.pushDefault` to
9f765ce6
RR
1083 specify the remote to push to for all branches, and use this
1084 option to override it for a specific branch.
648ad18f 1085
5372806a 1086branch.<name>.merge::
76d3cc50 1087 Defines, together with branch.<name>.remote, the upstream branch
15a147e6 1088 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
0b444cdb
TR
1089 branch to merge and can also affect 'git push' (see push.default).
1090 When in branch <name>, it tells 'git fetch' the default
b888d61c
DB
1091 refspec to be marked for merging in FETCH_HEAD. The value is
1092 handled like the remote part of a refspec, and must match a
1093 ref which is fetched from the remote given by
1094 "branch.<name>.remote".
0b444cdb
TR
1095 The merge information is used by 'git pull' (which at first calls
1096 'git fetch') to lookup the default branch for merging. Without
1097 this option, 'git pull' defaults to merge the first refspec fetched.
62b339a5 1098 Specify multiple values to get an octopus merge.
0b444cdb 1099 If you wish to setup 'git pull' so that it merges into <name> from
9debc324 1100 another branch in the local repository, you can point
b85ecea6
PO
1101 branch.<name>.merge to the desired branch, and use the relative path
1102 setting `.` (a period) for branch.<name>.remote.
5372806a 1103
da0005b8 1104branch.<name>.mergeOptions::
aec7b362 1105 Sets default options for merging into branch <name>. The syntax and
25dcc0d6 1106 supported options are the same as those of linkgit:git-merge[1], but
aec7b362
LH
1107 option values containing whitespace characters are currently not
1108 supported.
1109
cd67e4d4
JS
1110branch.<name>.rebase::
1111 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa 1112 instead of merging the default branch from the default remote when
6b37dff1
ÆAB
1113 "git pull" is run. See "pull.rebase" for doing this in a non
1114 branch-specific manner.
66713ef3 1115+
1131ec98
JS
1116When `merges`, pass the `--rebase-merges` option to 'git rebase'
1117so that the local merge commits are included in the rebase (see
1118linkgit:git-rebase[1] for details).
1119+
d2387107
AS
1120When preserve, also pass `--preserve-merges` along to 'git rebase'
1121so that locally committed merge commits will not be flattened
1122by running 'git pull'.
6b37dff1 1123+
f5eb87b9
JS
1124When the value is `interactive`, the rebase is run in interactive mode.
1125+
6b37dff1
ÆAB
1126*NOTE*: this is a possibly dangerous operation; do *not* use
1127it unless you understand the implications (see linkgit:git-rebase[1]
1128for details).
cd67e4d4 1129
a5ba2cbe
NTND
1130branch.<name>.description::
1131 Branch description, can be edited with
1132 `git branch --edit-description`. Branch description is
1133 automatically added in the format-patch cover letter or
1134 request-pull summary.
1135
1658c614
CC
1136browser.<tool>.cmd::
1137 Specify the command to invoke the specified browser. The
1138 specified command is evaluated in shell with the URLs passed
565e135a 1139 as arguments. (See linkgit:git-web{litdd}browse[1].)
1658c614 1140
584627b4
CC
1141browser.<tool>.path::
1142 Override the path for the given tool that may be used to
23f8239b 1143 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
ab989adf 1144 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 1145
8d7b558b
ÆAB
1146checkout.defaultRemote::
1147 When you run 'git checkout <something>' and only have one
1148 remote, it may implicitly fall back on checking out and
1149 tracking e.g. 'origin/<something>'. This stops working as soon
1150 as you have more than one remote with a '<something>'
1151 reference. This setting allows for setting the name of a
1152 preferred remote that should always win when it comes to
1153 disambiguation. The typical use-case is to set this to
1154 `origin`.
1155+
1156Currently this is used by linkgit:git-checkout[1] when 'git checkout
1157<something>' will checkout the '<something>' branch on another remote,
1158and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1159remote branch. This setting might be used for other checkout-like
1160commands or functionality in the future.
1161
60129c61 1162checkout.optimizeNewBranch::
fa655d84
BP
1163 Optimizes the performance of "git checkout -b <new_branch>" when
1164 using sparse-checkout. When set to true, git will not update the
1165 repo based on the current sparse-checkout settings. This means it
1166 will not update the skip-worktree bit in the index nor add/remove
1167 files in the working directory to reflect the current sparse checkout
1168 settings nor will it show the local changes.
1169
2122591b 1170clean.requireForce::
f85f7947
JX
1171 A boolean to make git-clean do nothing unless given -f,
1172 -i or -n. Defaults to true.
2122591b 1173
79f62e7d
JS
1174color.advice::
1175 A boolean to enable/disable color in hints (e.g. when a push
1176 failed, see `advice.*` for a list). May be set to `always`,
1177 `false` (or `never`) or `auto` (or `true`), in which case colors
1178 are used only when the error output goes to a terminal. If
1179 unset, then the value of `color.ui` is used (`auto` by default).
1180
1181color.advice.hint::
1182 Use customized color for hints.
1183
8578037b
NTND
1184color.blame.highlightRecent::
1185 This can be used to color the metadata of a blame line depending
1186 on age of the line.
1187+
1188This setting should be set to a comma-separated list of color and date settings,
1189starting and ending with a color, the dates should be set from oldest to newest.
1190The metadata will be colored given the colors if the the line was introduced
1191before the given timestamp, overwriting older timestamped colors.
1192+
1193Instead of an absolute timestamp relative timestamps work as well, e.g.
11942.weeks.ago is valid to address anything older than 2 weeks.
1195+
1196It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1197everything older than one year blue, recent changes between one month and
1198one year old are kept white, and lines introduced within the last month are
1199colored red.
1200
1201color.blame.repeatedLines::
1202 Use the customized color for the part of git-blame output that
1203 is repeated meta information per line (such as commit id,
1204 author name, date and timezone). Defaults to cyan.
1205
f3673988
BG
1206color.branch::
1207 A boolean to enable/disable color in the output of
5162e697 1208 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 1209 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1210 only when the output is to a terminal. If unset, then the
1211 value of `color.ui` is used (`auto` by default).
f3673988
BG
1212
1213color.branch.<slot>::
1214 Use customized color for branch coloration. `<slot>` is one of
1215 `current` (the current branch), `local` (a local branch),
dbda21fa
FC
1216 `remote` (a remote-tracking branch in refs/remotes/),
1217 `upstream` (upstream tracking branch), `plain` (other
4f193f20 1218 refs).
f3673988 1219
a159ca0c 1220color.diff::
6999c540
MG
1221 Whether to use ANSI escape sequences to add color to patches.
1222 If this is set to `always`, linkgit:git-diff[1],
1223 linkgit:git-log[1], and linkgit:git-show[1] will use color
1224 for all patches. If it is set to `true` or `auto`, those
1225 commands will only use color when output is to the terminal.
14d16e2b
MM
1226 If unset, then the value of `color.ui` is used (`auto` by
1227 default).
6999c540 1228+
a58088ab 1229This does not affect linkgit:git-format-patch[1] or the
6999c540
MG
1230'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1231command line with the `--color[=<when>]` option.
b5376648 1232
a159ca0c 1233color.diff.<slot>::
4f193f20
MW
1234 Use customized color for diff colorization. `<slot>` specifies
1235 which part of the patch to use the specified color, and is one
74b15bfb
JK
1236 of `context` (context text - `plain` is a historical synonym),
1237 `meta` (metainformation), `frag`
89cb73a1 1238 (hunk header), 'func' (function in hunk header), `old` (removed lines),
61e89eaa
SB
1239 `new` (added lines), `commit` (commit headers), `whitespace`
1240 (highlighting whitespace errors), `oldMoved` (deleted lines),
1241 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1242 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
a7be92ac
JS
1243 `newMovedAlternativeDimmed` (See the '<mode>'
1244 setting of '--color-moved' in linkgit:git-diff[1] for details),
1245 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1246 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
b5376648 1247
5e11bee6
NR
1248color.decorate.<slot>::
1249 Use customized color for 'git log --decorate' output. `<slot>` is one
1250 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
09c4ba41
NTND
1251 branches, remote-tracking branches, tags, stash and HEAD, respectively
1252 and `grafted` for grafted commits.
5e11bee6 1253
7e8f59d5
RS
1254color.grep::
1255 When set to `always`, always highlight matches. When `false` (or
1256 `never`), never. When set to `true` or `auto`, use color only
14d16e2b
MM
1257 when the output is written to the terminal. If unset, then the
1258 value of `color.ui` is used (`auto` by default).
7e8f59d5 1259
55f638bd
ML
1260color.grep.<slot>::
1261 Use customized color for grep colorization. `<slot>` specifies which
1262 part of the line to use the specified color, and is one of
1263+
1264--
00588bb5
ML
1265`context`;;
1266 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
1267`filename`;;
1268 filename prefix (when not using `-h`)
00588bb5
ML
1269`function`;;
1270 function name lines (when using `-p`)
f8a0c6e7 1271`lineNumber`;;
55f638bd 1272 line number prefix (when using `-n`)
6653fec3
TB
1273`column`;;
1274 column number prefix (when using `--column`)
55f638bd 1275`match`;;
79a77109
RS
1276 matching text (same as setting `matchContext` and `matchSelected`)
1277`matchContext`;;
1278 matching text in context lines
1279`matchSelected`;;
1280 matching text in selected lines
00588bb5
ML
1281`selected`;;
1282 non-matching text in selected lines
55f638bd
ML
1283`separator`;;
1284 separators between fields on a line (`:`, `-`, and `=`)
1285 and between hunks (`--`)
1286--
7e8f59d5 1287
b4c61ed6 1288color.interactive::
47ee06f1 1289 When set to `always`, always use colors for interactive prompts
7a9b0b80
JX
1290 and displays (such as those used by "git-add --interactive" and
1291 "git-clean --interactive"). When false (or `never`), never.
1292 When set to `true` or `auto`, use colors only when the output is
14d16e2b
MM
1293 to the terminal. If unset, then the value of `color.ui` is
1294 used (`auto` by default).
b4c61ed6
JH
1295
1296color.interactive.<slot>::
7a9b0b80
JX
1297 Use customized color for 'git add --interactive' and 'git clean
1298 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1299 or `error`, for four distinct types of normal output from
b92c1a28 1300 interactive commands.
b4c61ed6 1301
1d77043b
JH
1302color.pager::
1303 A boolean to enable/disable colored output when the pager is in
1304 use (default is true).
1305
79f62e7d
JS
1306color.push::
1307 A boolean to enable/disable color in push errors. May be set to
1308 `always`, `false` (or `never`) or `auto` (or `true`), in which
1309 case colors are used only when the error output goes to a terminal.
1310 If unset, then the value of `color.ui` is used (`auto` by default).
1311
1312color.push.error::
1313 Use customized color for push errors.
1314
bf1a11f0
HWN
1315color.remote::
1316 If set, keywords at the start of the line are highlighted. The
1317 keywords are "error", "warning", "hint" and "success", and are
1318 matched case-insensitively. May be set to `always`, `false` (or
1319 `never`) or `auto` (or `true`). If unset, then the value of
1320 `color.ui` is used (`auto` by default).
1321
1322color.remote.<slot>::
1323 Use customized color for each remote keyword. `<slot>` may be
1324 `hint`, `warning`, `success` or `error` which match the
1325 corresponding keyword.
1326
da0005b8 1327color.showBranch::
ab07ba2a
MH
1328 A boolean to enable/disable color in the output of
1329 linkgit:git-show-branch[1]. May be set to `always`,
1330 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1331 only when the output is to a terminal. If unset, then the
1332 value of `color.ui` is used (`auto` by default).
ab07ba2a 1333
1d77043b
JH
1334color.status::
1335 A boolean to enable/disable color in the output of
5162e697 1336 linkgit:git-status[1]. May be set to `always`,
cec99d8c 1337 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1338 only when the output is to a terminal. If unset, then the
1339 value of `color.ui` is used (`auto` by default).
1d77043b
JH
1340
1341color.status.<slot>::
1342 Use customized color for status colorization. `<slot>` is
1343 one of `header` (the header text of the status message),
82dca848
SP
1344 `added` or `updated` (files which are added but not committed),
1345 `changed` (files which are changed but not added in the index),
2de9b711 1346 `untracked` (files which are not tracked by Git),
0d6accc0 1347 `branch` (the current branch),
950ce2e2 1348 `nobranch` (the color the 'no branch' warning is shown in, defaulting
93fdf301
SK
1349 to red),
1350 `localBranch` or `remoteBranch` (the local and remote branch names,
1351 respectively, when branch and tracking information is displayed in the
1352 status short-format), or
0d6accc0 1353 `unmerged` (files which have unmerged changes).
1d77043b 1354
79f62e7d
JS
1355color.transport::
1356 A boolean to enable/disable color when pushes are rejected. May be
1357 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1358 case colors are used only when the error output goes to a terminal.
1359 If unset, then the value of `color.ui` is used (`auto` by default).
1360
1361color.transport.rejected::
1362 Use customized color when a push was rejected.
1363
6b2f2d98 1364color.ui::
6999c540
MG
1365 This variable determines the default value for variables such
1366 as `color.diff` and `color.grep` that control the use of color
1367 per command family. Its scope will expand as more commands learn
1368 configuration to set a default for the `--color` option. Set it
4c7f1819
MM
1369 to `false` or `never` if you prefer Git commands not to use
1370 color unless enabled explicitly with some other configuration
1371 or the `--color` option. Set it to `always` if you want all
1372 output not intended for machine consumption to use color, to
1373 `true` or `auto` (this is the default since Git 1.8.4) if you
1374 want such output to use color when written to the terminal.
6b2f2d98 1375
7e29b825
NTND
1376column.ui::
1377 Specify whether supported commands should output in columns.
1378 This variable consists of a list of tokens separated by spaces
1379 or commas:
1380+
5e62cc14
RR
1381These options control when the feature should be enabled
1382(defaults to 'never'):
1383+
7e29b825
NTND
1384--
1385`always`;;
1386 always show in columns
1387`never`;;
1388 never show in columns
1389`auto`;;
1390 show in columns if the output is to the terminal
5e62cc14
RR
1391--
1392+
1393These options control layout (defaults to 'column'). Setting any
1394of these implies 'always' if none of 'always', 'never', or 'auto' are
1395specified.
1396+
1397--
077539d7 1398`column`;;
5e62cc14 1399 fill columns before rows
077539d7
NTND
1400`row`;;
1401 fill rows before columns
7e29b825
NTND
1402`plain`;;
1403 show in one column
5e62cc14
RR
1404--
1405+
1406Finally, these options can be combined with a layout option (defaults
1407to 'nodense'):
1408+
1409--
3f8eccbe
NTND
1410`dense`;;
1411 make unequal size columns to utilize more space
1412`nodense`;;
1413 make equal size columns
7e29b825 1414--
7e29b825 1415
ebe31ef2
NTND
1416column.branch::
1417 Specify whether to output branch listing in `git branch` in columns.
1418 See `column.ui` for details.
1419
1b8fd467
JX
1420column.clean::
1421 Specify the layout when list items in `git clean -i`, which always
1422 shows files and directories in columns. See `column.ui` for details.
1423
323d0530
NTND
1424column.status::
1425 Specify whether to output untracked files in `git status` in columns.
1426 See `column.ui` for details.
1427
d96e3c15
NTND
1428column.tag::
1429 Specify whether to output tag listing in `git tag` in columns.
1430 See `column.ui` for details.
1431
51fb3a3d
RT
1432commit.cleanup::
1433 This setting overrides the default of the `--cleanup` option in
1434 `git commit`. See linkgit:git-commit[1] for details. Changing the
1435 default can be useful when you always want to keep lines that begin
1436 with comment character `#` in your log message, in which case you
1437 would do `git config commit.cleanup whitespace` (note that you will
1438 have to remove the help lines that begin with `#` in the commit log
1439 template yourself, if you do this).
1440
da0005b8 1441commit.gpgSign::
d95bfb12
NV
1442
1443 A boolean to specify whether all commits should be GPG signed.
1444 Use of this option when doing operations such as rebase can
1445 result in a large number of commits being signed. It may be
1446 convenient to use an agent to avoid typing your GPG passphrase
1447 several times.
1448
88955ed2 1449commit.status::
bed575e4
JHI
1450 A boolean to enable/disable inclusion of status information in the
1451 commit message template when using an editor to prepare the commit
1452 message. Defaults to true.
1453
b0f34c3d 1454commit.template::
dca83abd
JH
1455 Specify the pathname of a file to use as the template for
1456 new commit messages.
b0f34c3d 1457
aaab8420
PB
1458commit.verbose::
1459 A boolean or int to specify the level of verbose with `git commit`.
1460 See linkgit:git-commit[1].
1461
a6fc9fd3
JK
1462credential.helper::
1463 Specify an external helper to be called when a username or
1464 password credential is needed; the helper may consult external
24321375
JK
1465 storage to avoid prompting the user for the credentials. Note
1466 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1467 for details.
a6fc9fd3
JK
1468
1469credential.useHttpPath::
1470 When acquiring credentials, consider the "path" component of an http
1471 or https URL to be important. Defaults to false. See
1472 linkgit:gitcredentials[7] for more information.
1473
1474credential.username::
1475 If no username is set for a network authentication, use this username
1476 by default. See credential.<context>.* below, and
1477 linkgit:gitcredentials[7].
1478
1479credential.<url>.*::
1480 Any of the credential.* options above can be applied selectively to
1481 some credentials. For example "credential.https://example.com.username"
1482 would set the default username only for https connections to
1483 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1484 matched.
1485
7f4d4746
NP
1486credentialCache.ignoreSIGHUP::
1487 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1488
6532f374
NTND
1489completion.commands::
1490 This is only used by git-completion.bash to add or remove
1491 commands from the list of completed commands. Normally only
1492 porcelain commands and a few select others are completed. You
1493 can add more commands, separated by space, in this
1494 variable. Prefixing the command with '-' will remove it from
1495 the existing list.
1496
19299a84 1497include::diff-config.txt[]
afcbc8e7
DA
1498
1499difftool.<tool>.path::
1500 Override the path for the given tool. This is useful in case
1501 your tool is not in the PATH.
1502
1503difftool.<tool>.cmd::
1504 Specify the command to invoke the specified diff tool.
1505 The specified command is evaluated in shell with the following
1506 variables available: 'LOCAL' is set to the name of the temporary
1507 file containing the contents of the diff pre-image and 'REMOTE'
1508 is set to the name of the temporary file containing the contents
1509 of the diff post-image.
1510
a904392e
DA
1511difftool.prompt::
1512 Prompt before each invocation of the diff tool.
1513
d9545c7f
EW
1514fastimport.unpackLimit::
1515 If the number of objects imported by linkgit:git-fast-import[1]
1516 is below this limit, then the objects will be unpacked into
1517 loose object files. However if the number of imported objects
1518 equals or exceeds this limit then the pack will be stored as a
1519 pack. Storing the pack from a fast-import can make the import
1520 operation complete faster, especially on slow filesystems. If
1521 not set, the value of `transfer.unpackLimit` is used instead.
1522
be254a0e 1523fetch.recurseSubmodules::
1fb25502
JL
1524 This option can be either set to a boolean value or to 'on-demand'.
1525 Setting it to a boolean changes the behavior of fetch and pull to
1526 unconditionally recurse into submodules when set to true or to not
1527 recurse at all when set to false. When set to 'on-demand' (the default
1528 value), fetch and pull will only recurse into a populated submodule
1529 when its superproject retrieves a commit that updates the submodule's
1530 reference.
be254a0e 1531
5e838ea7
JH
1532fetch.fsckObjects::
1533 If it is set to true, git-fetch-pack will check all fetched
5180dd2e
ÆAB
1534 objects. See `transfer.fsckObjects` for what's
1535 checked. Defaults to false. If not set, the value of
1536 `transfer.fsckObjects` is used instead.
5e838ea7 1537
1362df0d
ÆAB
1538fetch.fsck.<msg-id>::
1539 Acts like `fsck.<msg-id>`, but is used by
1540 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1541 the `fsck.<msg-id>` documentation for details.
1542
1543fetch.fsck.skipList::
1544 Acts like `fsck.skipList`, but is used by
1545 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1546 the `fsck.skipList` documentation for details.
5e838ea7 1547
af7cf268 1548fetch.unpackLimit::
2de9b711 1549 If the number of objects fetched over the Git native
af7cf268
JH
1550 transfer is below this
1551 limit, then the objects will be unpacked into loose object
1552 files. However if the number of received objects equals or
1553 exceeds this limit then the received pack will be stored as
1554 a pack, after adding any missing delta bases. Storing the
1555 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1556 especially on slow filesystems. If not set, the value of
1557 `transfer.unpackLimit` is used instead.
af7cf268 1558
737c5a9c
MS
1559fetch.prune::
1560 If true, fetch will automatically behave as if the `--prune`
627a129b
ÆAB
1561 option was given on the command line. See also `remote.<name>.prune`
1562 and the PRUNING section of linkgit:git-fetch[1].
737c5a9c 1563
97716d21
ÆAB
1564fetch.pruneTags::
1565 If true, fetch will automatically behave as if the
1566 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1567 if not set already. This allows for setting both this option
1568 and `fetch.prune` to maintain a 1=1 mapping to upstream
1569 refs. See also `remote.<name>.pruneTags` and the PRUNING
1570 section of linkgit:git-fetch[1].
737c5a9c 1571
bc437d10
NTND
1572fetch.output::
1573 Control how ref update status is printed. Valid values are
1574 `full` and `compact`. Default value is `full`. See section
1575 OUTPUT in linkgit:git-fetch[1] for detail.
1576
42cc7485
JT
1577fetch.negotiationAlgorithm::
1578 Control how information about the commits in the local repository is
1579 sent when negotiating the contents of the packfile to be sent by the
1580 server. Set to "skipping" to use an algorithm that skips commits in an
1581 effort to converge faster, but may result in a larger-than-necessary
af3a67de 1582 packfile; The default is "default" which instructs Git to use the default algorithm
42cc7485
JT
1583 that never skips commits (unless the server has acknowledged it or one
1584 of its descendants).
af3a67de 1585 Unknown values will cause 'git fetch' to error out.
52660828
ÆAB
1586+
1587See also the `--negotiation-tip` option for linkgit:git-fetch[1].
42cc7485 1588
48d3448d
SB
1589format.attach::
1590 Enable multipart/mixed attachments as the default for
1591 'format-patch'. The value can also be a double quoted string
1592 which will enable attachments as the default and set the
1593 value as the boundary. See the --attach option in
1594 linkgit:git-format-patch[1].
1595
6bc6b6c0
JT
1596format.from::
1597 Provides the default value for the `--from` option to format-patch.
1598 Accepts a boolean value, or a name and email address. If false,
1599 format-patch defaults to `--no-from`, using commit authors directly in
1600 the "From:" field of patch mails. If true, format-patch defaults to
1601 `--from`, using your committer identity in the "From:" field of patch
1602 mails and including a "From:" field in the body of the patch mail if
1603 different. If set to a non-boolean value, format-patch uses that
1604 value instead of your committer identity. Defaults to false.
1605
49604a4d 1606format.numbered::
a567fdcb
BG
1607 A boolean which can enable or disable sequence numbers in patch
1608 subjects. It defaults to "auto" which enables it only if there
1609 is more than one patch. It can be enabled or disabled for all
1610 messages by setting it to "true" or "false". See --numbered
1611 option in linkgit:git-format-patch[1].
49604a4d 1612
1ab661dd
PB
1613format.headers::
1614 Additional email headers to include in a patch to be submitted
5162e697 1615 by mail. See linkgit:git-format-patch[1].
1ab661dd 1616
312a30eb 1617format.to::
48d3448d 1618format.cc::
312a30eb
MV
1619 Additional recipients to include in a patch to be submitted
1620 by mail. See the --to and --cc options in
1621 linkgit:git-format-patch[1].
48d3448d 1622
da0005b8 1623format.subjectPrefix::
48d3448d
SB
1624 The default for format-patch is to output files with the '[PATCH]'
1625 subject prefix. Use this variable to change that prefix.
1626
6622d9c7
SB
1627format.signature::
1628 The default for format-patch is to output a signature containing
2de9b711 1629 the Git version number. Use this variable to change that default.
6622d9c7
SB
1630 Set this variable to the empty string ("") to suppress
1631 signature generation.
1632
da0005b8 1633format.signatureFile::
7022650f
JM
1634 Works just like format.signature except the contents of the
1635 file specified by this variable will be used as the signature.
1636
78cb59c8
JS
1637format.suffix::
1638 The default for format-patch is to output files with the suffix
1639 `.patch`. Use this variable to change that suffix (make sure to
1640 include the dot if you want it).
1ab661dd 1641
94c22a5e
CR
1642format.pretty::
1643 The default pretty format for log/show/whatchanged command,
1644 See linkgit:git-log[1], linkgit:git-show[1],
1645 linkgit:git-whatchanged[1].
1646
30984ed2 1647format.thread::
0b444cdb 1648 The default threading style for 'git format-patch'. Can be
578b62bf
JN
1649 a boolean value, or `shallow` or `deep`. `shallow` threading
1650 makes every mail a reply to the head of the series,
30984ed2 1651 where the head is chosen from the cover letter, the
6cf378f0 1652 `--in-reply-to`, and the first patch mail, in this order.
fd1ff306 1653 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
1654 A true boolean value is the same as `shallow`, and a false
1655 value disables threading.
1656
da0005b8 1657format.signOff::
240ae2b8
FC
1658 A boolean value which lets you enable the `-s/--signoff` option of
1659 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1660 patch should be a conscious act and means that you certify you have
1661 the rights to submit this work under the same open source license.
1662 Please see the 'SubmittingPatches' document for further discussion.
1d1876e9 1663
2a4c2607
FC
1664format.coverLetter::
1665 A boolean that controls whether to generate a cover-letter when
1666 format-patch is invoked, but in addition can be set to "auto", to
1667 generate a cover-letter only when there's more than one patch.
1668
bc6bf2d7
AK
1669format.outputDirectory::
1670 Set a custom directory to store the resulting files instead of the
1671 current working directory.
1672
bb52995f
XY
1673format.useAutoBase::
1674 A boolean value which lets you enable the `--base=auto` option of
1675 format-patch by default.
1676
26488f59
RR
1677filter.<driver>.clean::
1678 The command which is used to convert the content of a worktree
1679 file to a blob upon checkin. See linkgit:gitattributes[5] for
1680 details.
1681
1682filter.<driver>.smudge::
1683 The command which is used to convert the content of a blob
1684 object to a worktree file upon checkout. See
1685 linkgit:gitattributes[5] for details.
1686
2becf00f 1687fsck.<msg-id>::
b2558abd
ÆAB
1688 During fsck git may find issues with legacy data which
1689 wouldn't be generated by current versions of git, and which
1690 wouldn't be sent over the wire if `transfer.fsckObjects` was
1691 set. This feature is intended to support working with legacy
1692 repositories containing such data.
1693+
1694Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1362df0d
ÆAB
1695to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1696to clone or fetch it set `fetch.fsck.<msg-id>`.
b2558abd
ÆAB
1697+
1698The rest of the documentation discusses `fsck.*` for brevity, but the
1362df0d
ÆAB
1699same applies for the corresponding `receive.fsck.*` and
1700`fetch.<msg-id>.*`. variables.
b2558abd 1701+
d786da1c
ÆAB
1702Unlike variables like `color.ui` and `core.editor` the
1703`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1704fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1705uniformly configure the same fsck settings in different circumstances
1706all three of them they must all set to the same values.
1707+
b2558abd
ÆAB
1708When `fsck.<msg-id>` is set, errors can be switched to warnings and
1709vice versa by configuring the `fsck.<msg-id>` setting where the
1710`<msg-id>` is the fsck message ID and the value is one of `error`,
1711`warn` or `ignore`. For convenience, fsck prefixes the error/warning
1712with the message ID, e.g. "missingEmail: invalid author/committer line
1713- missing email" means that setting `fsck.missingEmail = ignore` will
1714hide that issue.
1715+
1716In general, it is better to enumerate existing objects with problems
1717with `fsck.skipList`, instead of listing the kind of breakages these
1718problematic objects share to be ignored, as doing the latter will
1719allow new instances of the same breakages go unnoticed.
8a6d0525
ÆAB
1720+
1721Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1722doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1723will only cause git to warn.
2becf00f 1724
1335f732
JS
1725fsck.skipList::
1726 The path to a sorted list of object names (i.e. one SHA-1 per
1727 line) that are known to be broken in a non-fatal way and should
1728 be ignored. This feature is useful when an established project
1729 should be accepted despite early commits containing errors that
1730 can be safely ignored such as invalid committer email addresses.
1731 Note: corrupt objects cannot be skipped with this setting.
b2558abd 1732+
1362df0d
ÆAB
1733Like `fsck.<msg-id>` this variable has corresponding
1734`receive.fsck.skipList` and `fetch.fsck.skipList` variants.
d786da1c
ÆAB
1735+
1736Unlike variables like `color.ui` and `core.editor` the
1737`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1738fall back on the `fsck.skipList` configuration if they aren't set. To
1739uniformly configure the same fsck settings in different circumstances
1740all three of them they must all set to the same values.
1335f732 1741
125f8146
NTND
1742gc.aggressiveDepth::
1743 The depth parameter used in the delta compression
1744 algorithm used by 'git gc --aggressive'. This defaults
07e7dbf0 1745 to 50.
125f8146 1746
0d7566a5
TT
1747gc.aggressiveWindow::
1748 The window size parameter used in the delta compression
0b444cdb 1749 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 1750 to 250.
0d7566a5 1751
e9831e83
JH
1752gc.auto::
1753 When there are approximately more than this many loose
1754 objects in the repository, `git gc --auto` will pack them.
1755 Some Porcelain commands use this command to perform a
80cd9cf9
MB
1756 light-weight garbage collection from time to time. The
1757 default value is 6700. Setting this to 0 disables it.
e9831e83 1758
da0005b8 1759gc.autoPackLimit::
17815501
JH
1760 When there are more than this many packs that are not
1761 marked with `*.keep` file in the repository, `git gc
80cd9cf9 1762 --auto` consolidates them into one larger pack. The
97063974 1763 default value is 50. Setting this to 0 disables it.
17815501 1764
da0005b8 1765gc.autoDetach::
f745acb0 1766 Make `git gc --auto` return immediately and run in background
9f673f94
NTND
1767 if the system supports it. Default is true.
1768
55dfe13d
NTND
1769gc.bigPackThreshold::
1770 If non-zero, all packs larger than this limit are kept when
1771 `git gc` is run. This is very similar to `--keep-base-pack`
1772 except that all packs that meet the threshold are kept, not
1773 just the base pack. Defaults to zero. Common unit suffixes of
1774 'k', 'm', or 'g' are supported.
8fc67762
NTND
1775+
1776Note that if the number of kept packs is more than gc.autoPackLimit,
1777this configuration variable is ignored, all packs except the base pack
1778will be repacked. After this the number of packs should go below
1779gc.autoPackLimit and gc.bigPackThreshold should be respected again.
55dfe13d 1780
d915114a
DS
1781gc.writeCommitGraph::
1782 If true, then gc will rewrite the commit-graph file when
1783 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1784 '--auto' the commit-graph will be updated if housekeeping is
1785 required. Default is false. See linkgit:git-commit-graph[1]
1786 for details.
1787
a831c06a
DT
1788gc.logExpiry::
1789 If the file gc.log exists, then `git gc --auto` won't run
1790 unless that file is more than 'gc.logExpiry' old. Default is
1791 "1.day". See `gc.pruneExpire` for more ways to specify its
1792 value.
1793
da0005b8 1794gc.packRefs::
efc266e8
JN
1795 Running `git pack-refs` in a repository renders it
1796 unclonable by Git versions prior to 1.5.1.2 over dumb
1797 transports such as HTTP. This variable determines whether
4be0c352 1798 'git gc' runs `git pack-refs`. This can be set to `notbare`
efc266e8
JN
1799 to enable it within all non-bare repos or it can be set to a
1800 boolean value. The default is `true`.
c2120e5e 1801
da0005b8 1802gc.pruneExpire::
0b444cdb 1803 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33 1804 Override the grace period with this config variable. The value
8cc88166
ES
1805 "now" may be used to disable this grace period and always prune
1806 unreachable objects immediately, or "never" may be used to
f1350d0c
MM
1807 suppress pruning. This feature helps prevent corruption when
1808 'git gc' runs concurrently with another process writing to the
1809 repository; see the "NOTES" section of linkgit:git-gc[1].
25ee9731 1810
114ff888 1811gc.worktreePruneExpire::
b07244f4 1812 When 'git gc' is run, it calls
fe819b4b 1813 'git worktree prune --expire 3.months.ago'.
b07244f4
MH
1814 This config variable can be used to set a different grace
1815 period. The value "now" may be used to disable the grace
f212dcc7 1816 period and prune `$GIT_DIR/worktrees` immediately, or "never"
8cc88166 1817 may be used to suppress pruning.
e3df33bb 1818
da0005b8
NTND
1819gc.reflogExpire::
1820gc.<pattern>.reflogExpire::
0b444cdb 1821 'git reflog expire' removes reflog entries older than
8cc88166
ES
1822 this time; defaults to 90 days. The value "now" expires all
1823 entries immediately, and "never" suppresses expiration
1824 altogether. With "<pattern>" (e.g.
eb523a8d
JH
1825 "refs/stash") in the middle the setting applies only to
1826 the refs that match the <pattern>.
4aec56d1 1827
da0005b8 1828gc.reflogExpireUnreachable::
f04c6904 1829gc.<pattern>.reflogExpireUnreachable::
0b444cdb 1830 'git reflog expire' removes reflog entries older than
4aec56d1 1831 this time and are not reachable from the current tip;
8cc88166
ES
1832 defaults to 30 days. The value "now" expires all entries
1833 immediately, and "never" suppresses expiration altogether.
1834 With "<pattern>" (e.g. "refs/stash")
eb523a8d
JH
1835 in the middle, the setting applies only to the refs that
1836 match the <pattern>.
4aec56d1 1837
da0005b8 1838gc.rerereResolved::
48c32424 1839 Records of conflicted merge you resolved earlier are
0b444cdb 1840 kept for this many days when 'git rerere gc' is run.
6e96cb52 1841 You can also use more human-readable "1.month.ago", etc.
5162e697 1842 The default is 60 days. See linkgit:git-rerere[1].
48c32424 1843
da0005b8 1844gc.rerereUnresolved::
48c32424 1845 Records of conflicted merge you have not resolved are
0b444cdb 1846 kept for this many days when 'git rerere gc' is run.
6e96cb52 1847 You can also use more human-readable "1.month.ago", etc.
5162e697 1848 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1849
da0005b8 1850gitcvs.commitMsgAnnotation::
280514e1
FE
1851 Append this string to each commit message. Set to empty string
1852 to disable this feature. Defaults to "via git-CVS emulator".
1853
1ab661dd 1854gitcvs.enabled::
db218723 1855 Whether the CVS server interface is enabled for this repository.
5162e697 1856 See linkgit:git-cvsserver[1].
1ab661dd 1857
da0005b8 1858gitcvs.logFile::
db218723 1859 Path to a log file where the CVS server interface well... logs
5162e697 1860 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1861
1707adb7 1862gitcvs.usecrlfattr::
5ec3e670 1863 If true, the server will look up the end-of-line conversion
23f8239b 1864 attributes for files to determine the `-k` modes to use. If
2de9b711 1865 the attributes force Git to treat a file as text,
23f8239b 1866 the `-k` mode will be left blank so CVS clients will
5ec3e670 1867 treat it as text. If they suppress text conversion, the file
1168d402 1868 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670 1869 the client might otherwise do. If the attributes do not allow
ae9f6311 1870 the file type to be determined, then `gitcvs.allBinary` is
5ec3e670 1871 used. See linkgit:gitattributes[5].
8a06a632 1872
da0005b8 1873gitcvs.allBinary::
ae9f6311 1874 This is used if `gitcvs.usecrlfattr` does not resolve
90948a42
MO
1875 the correct '-kb' mode to use. If true, all
1876 unresolved files are sent to the client in
1877 mode '-kb'. This causes the client to treat them
1878 as binary files, which suppresses any newline munging it
1879 otherwise might do. Alternatively, if it is set to "guess",
1880 then the contents of the file are examined to decide if
ae9f6311 1881 it is binary, similar to `core.autocrlf`.
abbf5947 1882
da0005b8 1883gitcvs.dbName::
04752868 1884 Database used by git-cvsserver to cache revision information
2de9b711 1885 derived from the Git repository. The exact meaning depends on the
04752868
FL
1886 used database driver, for SQLite (which is the default driver) this
1887 is a filename. Supports variable substitution (see
5162e697 1888 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1889 Default: '%Ggitcvs.%m.sqlite'
1890
da0005b8 1891gitcvs.dbDriver::
04752868 1892 Used Perl DBI driver. You can specify any available driver
240ae2b8 1893 for this here, but it might not work. git-cvsserver is tested
04752868
FL
1894 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1895 reported *not* to work with 'DBD::mysql'. Experimental feature.
1896 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1897 See linkgit:git-cvsserver[1].
eabb0bfd 1898
da0005b8 1899gitcvs.dbUser, gitcvs.dbPass::
ae9f6311 1900 Database user and password. Only useful if setting `gitcvs.dbDriver`,
04752868 1901 since SQLite has no concept of database users and/or passwords.
da0005b8 1902 'gitcvs.dbUser' supports variable substitution (see
5162e697 1903 linkgit:git-cvsserver[1] for details).
04752868 1904
6aeeffd1
JE
1905gitcvs.dbTableNamePrefix::
1906 Database table name prefix. Prepended to the names of any
1907 database tables used, allowing a single database to be used
1908 for several repositories. Supports variable substitution (see
1909 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1910 characters will be replaced with underscores.
1911
ae9f6311
TR
1912All gitcvs variables except for `gitcvs.usecrlfattr` and
1913`gitcvs.allBinary` can also be specified as
8a06a632 1914'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1915is one of "ext" and "pserver") to make them apply only for the given
1916access method.
04752868 1917
cd82323f
JN
1918gitweb.category::
1919gitweb.description::
1920gitweb.owner::
1921gitweb.url::
1922 See linkgit:gitweb[1] for description.
1923
1924gitweb.avatar::
1925gitweb.blame::
1926gitweb.grep::
1927gitweb.highlight::
1928gitweb.patches::
1929gitweb.pickaxe::
1930gitweb.remote_heads::
da0005b8 1931gitweb.showSizes::
cd82323f
JN
1932gitweb.snapshot::
1933 See linkgit:gitweb.conf[5] for description.
1934
b22520a3 1935grep.lineNumber::
23f8239b 1936 If set to true, enable `-n` option by default.
b22520a3 1937
6653fec3
TB
1938grep.column::
1939 If set to true, enable the `--column` option by default.
1940
84befcd0
S
1941grep.patternType::
1942 Set the default matching behavior. Using a value of 'basic', 'extended',
bcf9626a
MM
1943 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1944 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
84befcd0
S
1945 value 'default' will return to the default matching behavior.
1946
b22520a3 1947grep.extendedRegexp::
bcf9626a 1948 If set to true, enable `--extended-regexp` option by default. This
ae9f6311 1949 option is ignored when the `grep.patternType` option is set to a value
84befcd0 1950 other than 'default'.
b22520a3 1951
89f09dd3
VL
1952grep.threads::
1953 Number of grep worker threads to use.
1954 See `grep.threads` in linkgit:git-grep[1] for more information.
1955
ecd9ba61
TG
1956grep.fallbackToNoIndex::
1957 If set to true, fall back to git grep --no-index if git grep
1958 is executed outside of a git repository. Defaults to false.
1959
0c5e70f0 1960gpg.program::
f212dcc7 1961 Use this custom program instead of "`gpg`" found on `$PATH` when
0c5e70f0 1962 making or verifying a PGP signature. The program must support the
06ab60c0 1963 same command-line interface as GPG, namely, to verify a detached
f212dcc7 1964 signature, "`gpg --verify $file - <$signature`" is run, and the
0c5e70f0 1965 program is expected to signal a good signature by exiting with
f745acb0 1966 code 0, and to generate an ASCII-armored detached signature, the
f212dcc7 1967 standard input of "`gpg -bsau $key`" is fed with the contents to be
0c5e70f0
JH
1968 signed, and the program is expected to send the result to its
1969 standard output.
1970
57a8dd75
HS
1971gpg.format::
1972 Specifies which key format to use when signing with `--gpg-sign`.
1e7adb97 1973 Default is "openpgp" and another possible value is "x509".
57a8dd75 1974
b02f51b1
HS
1975gpg.<format>.program::
1976 Use this to customize the program used for the signing format you
1977 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1e7adb97
HS
1978 be used as a legacy synonym for `gpg.openpgp.program`. The default
1979 value for `gpg.x509.program` is "gpgsm".
b02f51b1 1980
da0005b8 1981gui.commitMsgWidth::
d84ae0db
GH
1982 Defines how wide the commit message window is in the
1983 linkgit:git-gui[1]. "75" is the default.
1984
da0005b8 1985gui.diffContext::
d84ae0db
GH
1986 Specifies how many context lines should be used in calls to diff
1987 made by the linkgit:git-gui[1]. The default is "5".
1988
da0005b8 1989gui.displayUntracked::
1cca17df 1990 Determines if linkgit:git-gui[1] shows untracked files
ec9fa62a
MK
1991 in the file list. The default is "true".
1992
a2df1fb2
AG
1993gui.encoding::
1994 Specifies the default encoding to use for displaying of
1995 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1996 It can be overridden by setting the 'encoding' attribute
1997 for relevant files (see linkgit:gitattributes[5]).
1998 If this option is not set, the tools default to the
1999 locale encoding.
2000
da0005b8 2001gui.matchTrackingBranch::
d84ae0db
GH
2002 Determines if new branches created with linkgit:git-gui[1] should
2003 default to tracking remote branches with matching names or
2004 not. Default: "false".
2005
da0005b8 2006gui.newBranchTemplate::
d84ae0db
GH
2007 Is used as suggested name when creating new branches using the
2008 linkgit:git-gui[1].
2009
da0005b8 2010gui.pruneDuringFetch::
8b3f3f84 2011 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
2012 performing a fetch. The default value is "false".
2013
2014gui.trustmtime::
2015 Determines if linkgit:git-gui[1] should trust the file modification
2016 timestamp or not. By default the timestamps are not trusted.
2017
da0005b8 2018gui.spellingDictionary::
d84ae0db
GH
2019 Specifies the dictionary used for spell checking commit messages in
2020 the linkgit:git-gui[1]. When set to "none" spell checking is turned
2021 off.
2022
da0005b8 2023gui.fastCopyBlame::
ca768288 2024 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
2025 location detection. It makes blame significantly faster on huge
2026 repositories at the expense of less thorough copy detection.
2027
da0005b8 2028gui.copyBlameThreshold::
76bac890 2029 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
2030 detection, measured in alphanumeric characters. See the
2031 linkgit:git-blame[1] manual for more information on copy detection.
2032
2033gui.blamehistoryctx::
2034 Specifies the radius of history context in days to show in
2035 linkgit:gitk[1] for the selected commit, when the `Show History
2036 Context` menu item is invoked from 'git gui blame'. If this
2037 variable is set to zero, the whole history is shown.
2038
390c3480
AG
2039guitool.<name>.cmd::
2040 Specifies the shell command line to execute when the corresponding item
2041 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
2042 mandatory for every tool. The command is executed from the root of
2043 the working directory, and in the environment it receives the name of
eee7f4a2 2044 the tool as `GIT_GUITOOL`, the name of the currently selected file as
390c3480
AG
2045 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
2046 the head is detached, 'CUR_BRANCH' is empty).
2047
da0005b8 2048guitool.<name>.needsFile::
390c3480
AG
2049 Run the tool only if a diff is selected in the GUI. It guarantees
2050 that 'FILENAME' is not empty.
2051
da0005b8 2052guitool.<name>.noConsole::
390c3480
AG
2053 Run the command silently, without creating a window to display its
2054 output.
2055
da0005b8 2056guitool.<name>.noRescan::
390c3480
AG
2057 Don't rescan the working directory for changes after the tool
2058 finishes execution.
2059
2060guitool.<name>.confirm::
2061 Show a confirmation dialog before actually running the tool.
2062
da0005b8 2063guitool.<name>.argPrompt::
390c3480 2064 Request a string argument from the user, and pass it to the tool
47d81b5c 2065 through the `ARGS` environment variable. Since requesting an
390c3480
AG
2066 argument implies confirmation, the 'confirm' option has no effect
2067 if this is enabled. If the option is set to 'true', 'yes', or '1',
2068 the dialog uses a built-in generic prompt; otherwise the exact
2069 value of the variable is used.
2070
da0005b8 2071guitool.<name>.revPrompt::
390c3480 2072 Request a single valid revision from the user, and set the
47d81b5c 2073 `REVISION` environment variable. In other aspects this option
da0005b8 2074 is similar to 'argPrompt', and can be used together with it.
390c3480 2075
da0005b8
NTND
2076guitool.<name>.revUnmerged::
2077 Show only unmerged branches in the 'revPrompt' subdialog.
390c3480
AG
2078 This is useful for tools similar to merge or rebase, but not
2079 for things like checkout or reset.
2080
2081guitool.<name>.title::
2082 Specifies the title to use for the prompt dialog. The default
2083 is the tool name.
2084
2085guitool.<name>.prompt::
2086 Specifies the general prompt string to display at the top of
da0005b8 2087 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
390c3480
AG
2088 The default value includes the actual command.
2089
983a9eeb
CC
2090help.browser::
2091 Specify the browser that will be used to display help in the
2092 'web' format. See linkgit:git-help[1].
2093
2094help.format::
2095 Override the default help format used by linkgit:git-help[1].
2096 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2097 the default. 'web' and 'html' are the same.
2098
da0005b8 2099help.autoCorrect::
f0e90716
AR
2100 Automatically correct and execute mistyped commands after
2101 waiting for the given number of deciseconds (0.1 sec). If more
2102 than one command can be deduced from the entered text, nothing
2103 will be executed. If the value of this option is negative,
2104 the corrected command will be executed immediately. If the
2105 value is 0 - the command will be just shown but not executed.
2106 This is the default.
2107
da0005b8 2108help.htmlPath::
b1f809d0
SS
2109 Specify the path where the HTML documentation resides. File system paths
2110 and URLs are supported. HTML pages will be prefixed with this path when
2111 help is displayed in the 'web' format. This defaults to the documentation
2112 path of your Git installation.
2113
9c5665aa 2114http.proxy::
b2c8c6d9 2115 Override the HTTP proxy, normally configured using the 'http_proxy',
372370f1
KF
2116 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2117 addition to the syntax understood by curl, it is possible to specify a
2118 proxy string with a user name but no password, in which case git will
2119 attempt to acquire one in the same way it does for other credentials. See
2120 linkgit:gitcredentials[7] for more information. The syntax thus is
2121 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2122 on a per-remote basis; see remote.<name>.proxy
9c5665aa 2123
ef976395
KF
2124http.proxyAuthMethod::
2125 Set the method with which to authenticate against the HTTP proxy. This
2126 only takes effect if the configured proxy string contains a user name part
2127 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2128 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
eee7f4a2 2129 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
ef976395
KF
2130 variable. Possible values are:
2131+
2132--
2133* `anyauth` - Automatically pick a suitable authentication method. It is
2134 assumed that the proxy answers an unauthenticated request with a 407
2135 status code and one or more Proxy-authenticate headers with supported
2136 authentication methods. This is the default.
2137* `basic` - HTTP Basic authentication
2138* `digest` - HTTP Digest authentication; this prevents the password from being
2139 transmitted to the proxy in clear text
2140* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2141 of `curl(1)`)
2142* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2143--
9c5665aa 2144
121061f6 2145http.emptyAuth::
2146 Attempt authentication without seeking a username or password. This
2147 can be used to attempt GSS-Negotiate authentication without specifying
2148 a username in the URL, as libcurl normally requires a username for
2149 authentication.
2150
26a7b234
PS
2151http.delegation::
2152 Control GSSAPI credential delegation. The delegation is disabled
2153 by default in libcurl since version 7.21.7. Set parameter to tell
2154 the server what it is allowed to delegate when it comes to user
2155 credentials. Used with GSS/kerberos. Possible values are:
2156+
2157--
2158* `none` - Don't allow any delegation.
2159* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2160 Kerberos service ticket, which is a matter of realm policy.
2161* `always` - Unconditionally allow the server to delegate.
2162--
2163
2164
8cb01e2f
JS
2165http.extraHeader::
2166 Pass an additional HTTP header when communicating with a server. If
2167 more than one such entry exists, all of them are added as extra
2168 headers. To allow overriding the settings inherited from the system
2169 config, an empty value will reset the extra headers to the empty list.
2170
da0005b8 2171http.cookieFile::
e5a39ad8
BN
2172 The pathname of a file containing previously stored cookie lines,
2173 which should be used
2de9b711 2174 in the Git http session, if they match the server. The file format
bcfb95dd 2175 of the file to read cookies from should be plain HTTP headers or
1cca17df 2176 the Netscape/Mozilla cookie file format (see `curl(1)`).
06ea368b 2177 NOTE that the file specified with http.cookieFile is used only as
912b2acf
DB
2178 input unless http.saveCookies is set.
2179
da0005b8 2180http.saveCookies::
912b2acf 2181 If set, store cookies received during requests to the file specified by
da0005b8 2182 http.cookieFile. Has no effect if http.cookieFile is unset.
bcfb95dd 2183
01861cb7
EP
2184http.sslVersion::
2185 The SSL version to use when negotiating an SSL connection, if you
2186 want to force the default. The available and default version
2187 depend on whether libcurl was built against NSS or OpenSSL and the
2188 particular configuration of the crypto library in use. Internally
2189 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2190 documentation for more details on the format of this option and
2191 for the ssl version supported. Actually the possible values of
2192 this option are:
2193
2194 - sslv2
2195 - sslv3
2196 - tlsv1
2197 - tlsv1.0
2198 - tlsv1.1
2199 - tlsv1.2
d81b651f 2200 - tlsv1.3
01861cb7
EP
2201
2202+
eee7f4a2 2203Can be overridden by the `GIT_SSL_VERSION` environment variable.
01861cb7 2204To force git to use libcurl's default ssl version and ignore any
eee7f4a2 2205explicit http.sslversion option, set `GIT_SSL_VERSION` to the
01861cb7
EP
2206empty string.
2207
f6f2a9e4
LKS
2208http.sslCipherList::
2209 A list of SSL ciphers to use when negotiating an SSL connection.
2210 The available ciphers depend on whether libcurl was built against
2211 NSS or OpenSSL and the particular configuration of the crypto
2212 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2213 option; see the libcurl documentation for more details on the format
2214 of this list.
2215+
eee7f4a2 2216Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
f6f2a9e4 2217To force git to use libcurl's default cipher list and ignore any
eee7f4a2 2218explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
f6f2a9e4
LKS
2219empty string.
2220
1ab661dd
PB
2221http.sslVerify::
2222 Whether to verify the SSL certificate when fetching or pushing
dec366c9
SR
2223 over HTTPS. Defaults to true. Can be overridden by the
2224 `GIT_SSL_NO_VERIFY` environment variable.
1ab661dd
PB
2225
2226http.sslCert::
2227 File containing the SSL certificate when fetching or pushing
eee7f4a2 2228 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1ab661dd
PB
2229 variable.
2230
2231http.sslKey::
2232 File containing the SSL private key when fetching or pushing
eee7f4a2 2233 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1ab661dd
PB
2234 variable.
2235
754ae192 2236http.sslCertPasswordProtected::
2de9b711 2237 Enable Git's password prompt for the SSL certificate. Otherwise
754ae192
ML
2238 OpenSSL will prompt the user, possibly many times, if the
2239 certificate or private key is encrypted. Can be overridden by the
eee7f4a2 2240 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
754ae192 2241
1ab661dd
PB
2242http.sslCAInfo::
2243 File containing the certificates to verify the peer with when
abda1ef5 2244 fetching or pushing over HTTPS. Can be overridden by the
eee7f4a2 2245 `GIT_SSL_CAINFO` environment variable.
1ab661dd
PB
2246
2247http.sslCAPath::
2248 Path containing files with the CA certificates to verify the peer
37425065 2249 with when fetching or pushing over HTTPS. Can be overridden
eee7f4a2 2250 by the `GIT_SSL_CAPATH` environment variable.
1ab661dd 2251
aeff8a61
CE
2252http.pinnedpubkey::
2253 Public key of the https service. It may either be the filename of
2254 a PEM or DER encoded public key file or a string starting with
2255 'sha256//' followed by the base64 encoded sha256 hash of the
2256 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2257 exit with an error if this option is set but not supported by
2258 cURL.
2259
4bc444eb
MV
2260http.sslTry::
2261 Attempt to use AUTH SSL/TLS and encrypted data transfers
2262 when connecting via regular FTP protocol. This might be needed
2263 if the FTP server requires it for security reasons or you wish
2264 to connect securely whenever remote FTP server supports it.
2265 Default is false since it might trigger certificate verification
2266 errors on misconfigured servers.
2267
1ab661dd 2268http.maxRequests::
abda1ef5 2269 How many HTTP requests to launch in parallel. Can be overridden
eee7f4a2 2270 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1ab661dd 2271
ad75ebe5
TRC
2272http.minSessions::
2273 The number of curl sessions (counted across slots) to be kept across
2274 requests. They will not be ended with curl_easy_cleanup() until
2275 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2276 value will be capped at 1. Defaults to 1.
2277
de1a2fdd
SP
2278http.postBuffer::
2279 Maximum size in bytes of the buffer used by smart HTTP
2280 transports when POSTing data to the remote system.
2281 For requests larger than this buffer size, HTTP/1.1 and
2282 Transfer-Encoding: chunked is used to avoid creating a
2283 massive pack file locally. Default is 1 MiB, which is
2284 sufficient for most requests.
2285
1ab661dd
PB
2286http.lowSpeedLimit, http.lowSpeedTime::
2287 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2288 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
eee7f4a2
TR
2289 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2290 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1ab661dd 2291
3ea099d4
SK
2292http.noEPSV::
2293 A boolean which disables using of EPSV ftp command by curl.
befc9c42 2294 This can helpful with some "poor" ftp servers which don't
eee7f4a2 2295 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
3ea099d4
SK
2296 environment variable. Default is false (curl will use EPSV).
2297
da0005b8 2298http.userAgent::
b1d1058c 2299 The HTTP USER_AGENT string presented to an HTTP server. The default
2de9b711 2300 value represents the version of the client Git such as git/1.7.1.
b1d1058c
SO
2301 This option allows you to override this value to a more common value
2302 such as Mozilla/4.0. This may be necessary, for instance, if
2303 connecting through a firewall that restricts HTTP connections to a set
2304 of common USER_AGENT strings (but not including those like git/1.7.1).
eee7f4a2 2305 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
b1d1058c 2306
50d34137
JK
2307http.followRedirects::
2308 Whether git should follow HTTP redirects. If set to `true`, git
2309 will transparently follow any redirect issued by a server it
2310 encounters. If set to `false`, git will treat all redirects as
2311 errors. If set to `initial`, git will follow redirects only for
2312 the initial request to a remote, but not for subsequent
2313 follow-up HTTP requests. Since git uses the redirected URL as
2314 the base for the follow-up requests, this is generally
2315 sufficient. The default is `initial`.
2316
6a56993b 2317http.<url>.*::
f745acb0 2318 Any of the http.* options above can be applied selectively to some URLs.
6a56993b
KM
2319 For a config key to match a URL, each element of the config key is
2320 compared to that of the URL, in the following order:
2321+
2322--
2323. Scheme (e.g., `https` in `https://example.com/`). This field
2324 must match exactly between the config key and the URL.
2325
2326. Host/domain name (e.g., `example.com` in `https://example.com/`).
a272b9e7
PS
2327 This field must match between the config key and the URL. It is
2328 possible to specify a `*` as part of the host name to match all subdomains
2329 at this level. `https://*.example.com/` for example would match
2330 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
6a56993b
KM
2331
2332. Port number (e.g., `8080` in `http://example.com:8080/`).
2333 This field must match exactly between the config key and the URL.
2334 Omitted port numbers are automatically converted to the correct
2335 default for the scheme before matching.
2336
2337. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2338 path field of the config key must match the path field of the URL
2339 either exactly or as a prefix of slash-delimited path elements. This means
2340 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2341 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2342 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2343 key with just path `foo/`).
2344
2345. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2346 the config key has a user name it must match the user name in the
2347 URL exactly. If the config key does not have a user name, that
2348 config key will match a URL with any user name (including none),
2349 but at a lower precedence than a config key with a user name.
2350--
2351+
2352The list above is ordered by decreasing precedence; a URL that matches
2353a config key's path is preferred to one that matches its user name. For example,
2354if the URL is `https://user@example.com/foo/bar` a config key match of
2355`https://example.com/foo` will be preferred over a config key match of
2356`https://user@example.com`.
2357+
2358All URLs are normalized before attempting any matching (the password part,
2359if embedded in the URL, is always ignored for matching purposes) so that
f745acb0
TA
2360equivalent URLs that are simply spelled differently will match properly.
2361Environment variable settings always override any matches. The URLs that are
6a56993b
KM
2362matched against are those given directly to Git commands. This means any URLs
2363visited as a result of a redirection do not participate in matching.
2364
dd33e077 2365ssh.variant::
0da0e49b
JN
2366 By default, Git determines the command line arguments to use
2367 based on the basename of the configured SSH command (configured
2368 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2369 the config setting `core.sshCommand`). If the basename is
2370 unrecognized, Git will attempt to detect support of OpenSSH
2371 options by first invoking the configured SSH command with the
2372 `-G` (print configuration) option and will subsequently use
2373 OpenSSH options (if that is successful) or no options besides
2374 the host and remote command (if it fails).
2375+
2376The config variable `ssh.variant` can be set to override this detection.
2377Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2378`tortoiseplink`, `simple` (no options except the host and remote command).
2379The default auto-detection can be explicitly requested using the value
2380`auto`. Any other value is treated as `ssh`. This setting can also be
2381overridden via the environment variable `GIT_SSH_VARIANT`.
94b8ae5a
BW
2382+
2383The current command-line parameters used for each variant are as
2384follows:
2385+
2386--
2387
2388* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2389
2390* `simple` - [username@]host command
2391
2392* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2393
2394* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2395
2396--
2397+
2398Except for the `simple` variant, command-line parameters are likely to
2399change as git gains new features.
dd33e077 2400
1ab661dd 2401i18n.commitEncoding::
2de9b711 2402 Character encoding the commit messages are stored in; Git itself
1ab661dd
PB
2403 does not care per se, but this information is necessary e.g. when
2404 importing commits from emails or in the gitk graphical history
2405 browser (and possibly at other places in the future or in other
5162e697 2406 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 2407
d2c11a38
JH
2408i18n.logOutputEncoding::
2409 Character encoding the commit messages are converted to when
0b444cdb 2410 running 'git log' and friends.
d2c11a38 2411
b0f34c3d
MM
2412imap::
2413 The configuration variables in the 'imap' section are described
2414 in linkgit:git-imap-send[1].
2415
c780b9cf
BP
2416index.threads::
2417 Specifies the number of threads to spawn when loading the index.
2418 This is meant to reduce index load time on multiprocessor machines.
2419 Specifying 0 or 'true' will cause Git to auto-detect the number of
2420 CPU's and set the number of threads accordingly. Specifying 1 or
2421 'false' will disable multithreading. Defaults to 'true'.
2422
3c09d684
TG
2423index.version::
2424 Specify the version with which new index files should be
2425 initialized. This does not affect existing repositories.
2426
da0005b8 2427init.templateDir::
d8a8488d
SD
2428 Specify the directory from which templates will be copied.
2429 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2430
983a9eeb
CC
2431instaweb.browser::
2432 Specify the program that will be used to browse your working
2433 repository in gitweb. See linkgit:git-instaweb[1].
2434
2435instaweb.httpd::
2436 The HTTP daemon command-line to start gitweb on your working
2437 repository. See linkgit:git-instaweb[1].
2438
2439instaweb.local::
2440 If true the web server started by linkgit:git-instaweb[1] will
2441 be bound to the local IP (127.0.0.1).
2442
da0005b8 2443instaweb.modulePath::
6b677a28
VS
2444 The default module path for linkgit:git-instaweb[1] to use
2445 instead of /usr/lib/apache2/modules. Only used if httpd
2446 is Apache.
983a9eeb
CC
2447
2448instaweb.port::
2449 The port number to bind the gitweb httpd to. See
2450 linkgit:git-instaweb[1].
2451
da0005b8 2452interactive.singleKey::
57f6ec02 2453 In interactive commands, allow the user to provide one-letter
ca6ac7f1 2454 input with a single key (i.e., without hitting enter).
6cf378f0 2455 Currently this is used by the `--patch` mode of
e6b57a8a
CI
2456 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2457 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2458 setting is silently ignored if portable keystroke input
8358f1ac 2459 is not available; requires the Perl module Term::ReadKey.
ca6ac7f1 2460
01143847
JK
2461interactive.diffFilter::
2462 When an interactive command (such as `git add --patch`) shows
2463 a colorized diff, git will pipe the diff through the shell
2464 command defined by this configuration variable. The command may
2465 mark up the diff further for human consumption, provided that it
2466 retains a one-to-one correspondence with the lines in the
2467 original diff. Defaults to disabled (no filtering).
2468
0c47695a
JS
2469log.abbrevCommit::
2470 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6cf378f0
JK
2471 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2472 override this option with `--no-abbrev-commit`.
0c47695a 2473
dd0ffd5b 2474log.date::
e860795d
JN
2475 Set the default date-time mode for the 'log' command.
2476 Setting a value for log.date is similar to using 'git log''s
78a84416 2477 `--date` option. See linkgit:git-log[1] for details.
dd0ffd5b 2478
eb734454
SD
2479log.decorate::
2480 Print out the ref names of any commits that are shown by the log
2481 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2482 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2483 specified, the full ref name (including prefix) will be printed.
462cbb41
RJ
2484 If 'auto' is specified, then if the output is going to a terminal,
2485 the ref names are shown as if 'short' were given, otherwise no ref
ce18123c 2486 names are shown. This is the same as the `--decorate` option
462cbb41 2487 of the `git log`.
eb734454 2488
fd8d07ef
EVW
2489log.follow::
2490 If `true`, `git log` will act as if the `--follow` option was used when
2491 a single <path> is given. This has the same limitations as `--follow`,
2492 i.e. it cannot be used to follow multiple files and does not work well
2493 on non-linear history.
2494
73c727d6
NTND
2495log.graphColors::
2496 A list of colors, separated by commas, that can be used to draw
2497 history lines in `git log --graph`.
2498
da0005b8 2499log.showRoot::
0f03ca94
PB
2500 If true, the initial commit will be shown as a big creation event.
2501 This is equivalent to a diff against an empty tree.
5162e697 2502 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
2503 normally hide the root commit will now show it. True by default.
2504
ba4dce78
KM
2505log.showSignature::
2506 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2507 linkgit:git-whatchanged[1] assume `--show-signature`.
2508
e6bb5f78
AP
2509log.mailmap::
2510 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2511 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2512
d5c4b185
MM
2513mailinfo.scissors::
2514 If true, makes linkgit:git-mailinfo[1] (and therefore
2515 linkgit:git-am[1]) act by default as if the --scissors option
2516 was provided on the command-line. When active, this features
2517 removes everything from the message body before a scissors
2518 line (i.e. consisting mainly of ">8", "8<" and "-").
2519
d551a488
MSO
2520mailmap.file::
2521 The location of an augmenting mailmap file. The default
2522 mailmap, located in the root of the repository, is loaded
2523 first, then the mailmap file pointed to by this variable.
2524 The location of the mailmap file may be in a repository
2525 subdirectory, or somewhere outside of the repository itself.
2526 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2527
08610900
JK
2528mailmap.blob::
2529 Like `mailmap.file`, but consider the value as a reference to a
8c473cec
JK
2530 blob in the repository. If both `mailmap.file` and
2531 `mailmap.blob` are given, both are parsed, with entries from
2532 `mailmap.file` taking precedence. In a bare repository, this
2533 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2534 defaults to empty.
08610900 2535
b5578f33 2536man.viewer::
b8322ea8 2537 Specify the programs that may be used to display help in the
b5578f33
CC
2538 'man' format. See linkgit:git-help[1].
2539
0bb64009
CC
2540man.<tool>.cmd::
2541 Specify the command to invoke the specified man viewer. The
2542 specified command is evaluated in shell with the man page
2543 passed as argument. (See linkgit:git-help[1].)
2544
7e8114c0
CC
2545man.<tool>.path::
2546 Override the path for the given tool that may be used to
2547 display help in the 'man' format. See linkgit:git-help[1].
2548
b0f34c3d 2549include::merge-config.txt[]
b5412484 2550
77680caa
JS
2551mergetool.<tool>.path::
2552 Override the path for the given tool. This is useful in case
2553 your tool is not in the PATH.
2554
964473a0
CB
2555mergetool.<tool>.cmd::
2556 Specify the command to invoke the specified merge tool. The
2557 specified command is evaluated in shell with the following
2558 variables available: 'BASE' is the name of a temporary file
2559 containing the common base of the files to be merged, if available;
2560 'LOCAL' is the name of a temporary file containing the contents of
2561 the file on the current branch; 'REMOTE' is the name of a temporary
2562 file containing the contents of the file from the branch being
2563 merged; 'MERGED' contains the name of the file to which the merge
2564 tool should write the results of a successful merge.
2565
2566mergetool.<tool>.trustExitCode::
2567 For a custom merge command, specify whether the exit code of
2568 the merge command can be used to determine whether the merge was
2569 successful. If this is not set to true then the merge target file
2570 timestamp is checked and the merge assumed to have been successful
2571 if the file has been updated, otherwise the user is prompted to
2572 indicate the success of the merge.
2573
b12d0450
DA
2574mergetool.meld.hasOutput::
2575 Older versions of `meld` do not support the `--output` option.
2576 Git will attempt to detect whether `meld` supports `--output`
2577 by inspecting the output of `meld --help`. Configuring
2578 `mergetool.meld.hasOutput` will make Git skip these checks and
2579 use the configured value instead. Setting `mergetool.meld.hasOutput`
2580 to `true` tells Git to unconditionally use the `--output` option,
2581 and `false` avoids using `--output`.
2582
44c36d1c
CB
2583mergetool.keepBackup::
2584 After performing a merge, the original file with conflict markers
2585 can be saved as a file with a `.orig` extension. If this variable
2586 is set to `false` then this file is not preserved. Defaults to
2587 `true` (i.e. keep the backup files).
2588
162eba8b 2589mergetool.keepTemporaries::
2de9b711 2590 When invoking a custom merge tool, Git uses a set of temporary
162eba8b
CB
2591 files to pass to the tool. If the tool returns an error and this
2592 variable is set to `true`, then these temporary files will be
2593 preserved, otherwise they will be removed after the tool has
2594 exited. Defaults to `false`.
2595
8f0cb41d
DA
2596mergetool.writeToTemp::
2597 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2598 conflicting files in the worktree by default. Git will attempt
2599 to use a temporary directory for these files when set `true`.
2600 Defaults to `false`.
2601
682b451f
CB
2602mergetool.prompt::
2603 Prompt before each invocation of the merge resolution program.
2604
d2d68d99
JK
2605notes.mergeStrategy::
2606 Which merge strategy to choose by default when resolving notes
2607 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2608 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2609 section of linkgit:git-notes[1] for more information on each strategy.
2610
4f655e22
JK
2611notes.<name>.mergeStrategy::
2612 Which merge strategy to choose when doing a notes merge into
2613 refs/notes/<name>. This overrides the more general
2614 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2615 linkgit:git-notes[1] for more information on the available strategies.
2616
894a9d33
TR
2617notes.displayRef::
2618 The (fully qualified) refname from which to show notes when
2619 showing commit messages. The value of this variable can be set
2620 to a glob, in which case notes from all matching refs will be
2621 shown. You may also specify this configuration variable
2622 several times. A warning will be issued for refs that do not
2623 exist, but a glob that does not match any refs is silently
2624 ignored.
2625+
2626This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2627environment variable, which must be a colon separated list of refs or
2628globs.
2629+
2630The effective value of "core.notesRef" (possibly overridden by
2631GIT_NOTES_REF) is also implicitly added to the list of refs to be
2632displayed.
2633
6956f858
TR
2634notes.rewrite.<command>::
2635 When rewriting commits with <command> (currently `amend` or
2de9b711 2636 `rebase`) and this variable is set to `true`, Git
6956f858
TR
2637 automatically copies your notes from the original to the
2638 rewritten commit. Defaults to `true`, but see
2639 "notes.rewriteRef" below.
6956f858
TR
2640
2641notes.rewriteMode::
2642 When copying notes during a rewrite (see the
2643 "notes.rewrite.<command>" option), determines what to do if
2644 the target commit already has a note. Must be one of
e48ad1b9
JK
2645 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2646 Defaults to `concatenate`.
6956f858
TR
2647+
2648This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2649environment variable.
2650
2651notes.rewriteRef::
2652 When copying notes during a rewrite, specifies the (fully
2653 qualified) ref whose notes should be copied. The ref may be a
2654 glob, in which case notes in all matching refs will be copied.
2655 You may also specify this configuration several times.
2656+
2657Does not have a default value; you must configure this variable to
2b4aa89c
TR
2658enable note rewriting. Set it to `refs/notes/commits` to enable
2659rewriting for the default commit notes.
cfb88e9a
LAS
2660+
2661This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2662environment variable, which must be a colon separated list of refs or
2663globs.
6956f858 2664
4812a93a 2665pack.window::
5162e697 2666 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
2667 window size is given on the command line. Defaults to 10.
2668
842aaf93 2669pack.depth::
5162e697 2670 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 2671 maximum depth is given on the command line. Defaults to 50.
b5c0cbd8 2672 Maximum value is 4095.
842aaf93 2673
e93b15cd 2674pack.windowMemory::
f4694a8c
RB
2675 The maximum size of memory that is consumed by each thread
2676 in linkgit:git-pack-objects[1] for pack window memory when
2677 no limit is given on the command line. The value can be
2678 suffixed with "k", "m", or "g". When left unconfigured (or
2679 set explicitly to 0), there will be no limit.
e93b15cd 2680
960ccca6
DH
2681pack.compression::
2682 An integer -1..9, indicating the compression level for objects
2683 in a pack file. -1 is the zlib default. 0 means no
2684 compression, and 1..9 are various speed/size tradeoffs, 9 being
2685 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
2686 not set, defaults to -1, the zlib default, which is "a default
2687 compromise between speed and compression (currently equivalent
2688 to level 6)."
89d71f75
JK
2689+
2690Note that changing the compression level will not automatically recompress
2691all existing objects. You can force recompression by passing the -F option
2692to linkgit:git-repack[1].
960ccca6 2693
28b8a730
JK
2694pack.island::
2695 An extended regular expression configuring a set of delta
2696 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
2697 for details.
2698
2699pack.islandCore::
2700 Specify an island name which gets to have its objects be
2701 packed first. This creates a kind of pseudo-pack at the front
2702 of one pack, so that the objects from the specified island are
2703 hopefully faster to copy into any pack that should be served
2704 to a user requesting these objects. In practice this means
2705 that the island specified should likely correspond to what is
2706 the most commonly cloned in the repo. See also "DELTA ISLANDS"
2707 in linkgit:git-pack-objects[1].
2708
074b2eea 2709pack.deltaCacheSize::
02783075 2710 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
2711 linkgit:git-pack-objects[1] before writing them out to a pack.
2712 This cache is used to speed up the writing object phase by not
2713 having to recompute the final delta result once the best match
2714 for all objects is found. Repacking large repositories on machines
2715 which are tight with memory might be badly impacted by this though,
2716 especially if this cache pushes the system into swapping.
2717 A value of 0 means no limit. The smallest size of 1 byte may be
2718 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 2719
e3dfddb3 2720pack.deltaCacheLimit::
693b86ff 2721 The maximum size of a delta, that is cached in
5749b0b2
NP
2722 linkgit:git-pack-objects[1]. This cache is used to speed up the
2723 writing object phase by not having to recompute the final delta
0cb3c142
NTND
2724 result once the best match for all objects is found.
2725 Defaults to 1000. Maximum value is 65535.
e3dfddb3 2726
693b86ff
NP
2727pack.threads::
2728 Specifies the number of threads to spawn when searching for best
5162e697 2729 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
2730 be compiled with pthreads otherwise this option is ignored with a
2731 warning. This is meant to reduce packing time on multiprocessor
2732 machines. The required amount of memory for the delta search window
2733 is however multiplied by the number of threads.
2de9b711 2734 Specifying 0 will cause Git to auto-detect the number of CPU's
833e3df1 2735 and set the number of threads accordingly.
693b86ff 2736
4d00bda2
NP
2737pack.indexVersion::
2738 Specify the default pack index version. Valid values are 1 for
2739 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2740 the new pack index with capabilities for packs larger than 4 GB
2741 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
2742 packs. Version 2 is the default. Note that version 2 is enforced
2743 and this config option ignored whenever the corresponding pack is
2744 larger than 2 GB.
2745+
2de9b711 2746If you have an old Git that does not understand the version 2 `*.idx` file,
0d0bac67 2747cloning or fetching over a non native protocol (e.g. "http")
6cf378f0 2748that will copy both `*.pack` file and corresponding `*.idx` file from the
c0a5e2d4 2749other side may give you a repository that cannot be accessed with your
2de9b711 2750older version of Git. If the `*.pack` file is smaller than 2 GB, however,
c0a5e2d4 2751you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
6cf378f0 2752the `*.idx` file.
4d00bda2 2753
dbdbfec4 2754pack.packSizeLimit::
07cf0f24
NP
2755 The maximum size of a pack. This setting only affects
2756 packing to a file when repacking, i.e. the git:// protocol
6cf378f0 2757 is unaffected. It can be overridden by the `--max-pack-size`
9cea46cd
EW
2758 option of linkgit:git-repack[1]. Reaching this limit results
2759 in the creation of multiple packfiles; which in turn prevents
2760 bitmaps from being created.
2761 The minimum size allowed is limited to 1 MiB.
2762 The default is unlimited.
07cf0f24
NP
2763 Common unit suffixes of 'k', 'm', or 'g' are
2764 supported.
2b84b5a8 2765
6b8fda2d
VM
2766pack.useBitmaps::
2767 When true, git will use pack bitmaps (if available) when packing
2768 to stdout (e.g., during the server side of a fetch). Defaults to
2769 true. You should not generally need to turn this off unless
2770 you are debugging pack bitmaps.
2771
da0005b8 2772pack.writeBitmaps (deprecated)::
71d76cb4 2773 This is a deprecated synonym for `repack.writeBitmaps`.
7cc8f971 2774
ae4f07fb
VM
2775pack.writeBitmapHashCache::
2776 When true, git will include a "hash cache" section in the bitmap
2777 index (if one is written). This cache can be used to feed git's
2778 delta heuristics, potentially leading to better deltas between
2779 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2780 between an older, bitmapped pack and objects that have been
2781 pushed since the last gc). The downside is that it consumes 4
2782 bytes per object of disk space, and that JGit's bitmap
2783 implementation does not understand it, causing it to complain if
2784 Git and JGit are used on the same repository. Defaults to false.
2785
4370c2d6 2786pager.<cmd>::
9bad7233 2787 If the value is boolean, turns on or off pagination of the
2de9b711 2788 output of a particular Git subcommand when writing to a tty.
9bad7233 2789 Otherwise, turns on pagination for the subcommand using the
6cf378f0
JK
2790 pager specified by the value of `pager.<cmd>`. If `--paginate`
2791 or `--no-pager` is specified on the command line, it takes
9bad7233
JK
2792 precedence over this option. To disable pagination for all
2793 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 2794
8028184e
WP
2795pretty.<name>::
2796 Alias for a --pretty= format string, as specified in
2797 linkgit:git-log[1]. Any aliases defined here can be used just
2798 as the built-in pretty formats could. For example,
6cf378f0 2799 running `git config pretty.changelog "format:* %H %s"`
8028184e 2800 would cause the invocation `git log --pretty=changelog`
6cf378f0 2801 to be equivalent to running `git log "--pretty=format:* %H %s"`.
8028184e
WP
2802 Note that an alias with the same name as a built-in format
2803 will be silently ignored.
2804
f1762d77
BW
2805protocol.allow::
2806 If set, provide a user defined default policy for all protocols which
2807 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2808 if unset, known-safe protocols (http, https, git, ssh, file) have a
2809 default policy of `always`, known-dangerous protocols (ext) have a
2810 default policy of `never`, and all other protocols have a default
2811 policy of `user`. Supported policies:
2812+
2813--
2814
2815* `always` - protocol is always able to be used.
2816
2817* `never` - protocol is never able to be used.
2818
2819* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2820 either unset or has a value of 1. This policy should be used when you want a
2821 protocol to be directly usable by the user but don't want it used by commands which
2822 execute clone/fetch/push commands without user input, e.g. recursive
2823 submodule initialization.
2824
2825--
2826
2827protocol.<name>.allow::
2828 Set a policy to be used by protocol `<name>` with clone/fetch/push
2829 commands. See `protocol.allow` above for the available policies.
2830+
2831The protocol names currently used by git are:
2832+
2833--
2834 - `file`: any local file-based path (including `file://` URLs,
2835 or local paths)
2836
2837 - `git`: the anonymous git protocol over a direct TCP
2838 connection (or proxy, if configured)
2839
2840 - `ssh`: git over ssh (including `host:path` syntax,
2841 `ssh://`, etc).
2842
2843 - `http`: git over http, both "smart http" and "dumb http".
2844 Note that this does _not_ include `https`; if you want to configure
2845 both, you must do so individually.
2846
2847 - any external helpers are named by their protocol (e.g., use
2848 `hg` to allow the `git-remote-hg` helper)
2849--
2850
373d70ef
BW
2851protocol.version::
2852 Experimental. If set, clients will attempt to communicate with a
2853 server using the specified protocol version. If unset, no
2854 attempt will be made by the client to communicate using a
2855 particular protocol version, this results in protocol version 0
2856 being used.
2857 Supported versions:
2858+
2859--
2860
2861* `0` - the original wire protocol.
2862
2863* `1` - the original wire protocol with the addition of a version string
2864 in the initial response from the server.
2865
db2d36fa
BW
2866* `2` - link:technical/protocol-v2.html[wire protocol version 2].
2867
373d70ef
BW
2868--
2869
b814da89
DA
2870pull.ff::
2871 By default, Git does not create an extra merge commit when merging
2872 a commit that is a descendant of the current commit. Instead, the
2873 tip of the current branch is fast-forwarded. When set to `false`,
2874 this variable tells Git to create an extra merge commit in such
2875 a case (equivalent to giving the `--no-ff` option from the command
2876 line). When set to `only`, only such fast-forward merges are
2877 allowed (equivalent to giving the `--ff-only` option from the
eb8dc05c 2878 command line). This setting overrides `merge.ff` when pulling.
b814da89 2879
6b37dff1
ÆAB
2880pull.rebase::
2881 When true, rebase branches on top of the fetched branch, instead
2882 of merging the default branch from the default remote when "git
2883 pull" is run. See "branch.<name>.rebase" for setting this on a
2884 per-branch basis.
66713ef3 2885+
1131ec98
JS
2886When `merges`, pass the `--rebase-merges` option to 'git rebase'
2887so that the local merge commits are included in the rebase (see
2888linkgit:git-rebase[1] for details).
2889+
d2387107
AS
2890When preserve, also pass `--preserve-merges` along to 'git rebase'
2891so that locally committed merge commits will not be flattened
2892by running 'git pull'.
6b37dff1 2893+
f5eb87b9
JS
2894When the value is `interactive`, the rebase is run in interactive mode.
2895+
6b37dff1
ÆAB
2896*NOTE*: this is a possibly dangerous operation; do *not* use
2897it unless you understand the implications (see linkgit:git-rebase[1]
2898for details).
2899
1ab661dd
PB
2900pull.octopus::
2901 The default merge strategy to use when pulling multiple branches
2902 at once.
2903
2904pull.twohead::
2905 The default merge strategy to use when pulling a single branch.
2906
52153747 2907push.default::
87a70e4c
RR
2908 Defines the action `git push` should take if no refspec is
2909 explicitly given. Different values are well-suited for
2910 specific workflows; for instance, in a purely central workflow
2911 (i.e. the fetch source is equal to the push destination),
2912 `upstream` is probably what you want. Possible values are:
52153747 2913+
b1290514 2914--
87a70e4c
RR
2915
2916* `nothing` - do not push anything (error out) unless a refspec is
2917 explicitly given. This is primarily meant for people who want to
2918 avoid mistakes by always being explicit.
2919
2920* `current` - push the current branch to update a branch with the same
2921 name on the receiving end. Works in both central and non-central
2922 workflows.
2923
2924* `upstream` - push the current branch back to the branch whose
2925 changes are usually integrated into the current branch (which is
2926 called `@{upstream}`). This mode only makes sense if you are
2927 pushing to the same repository you would normally pull from
2928 (i.e. central workflow).
2929
e4e016f6
ÆAB
2930* `tracking` - This is a deprecated synonym for `upstream`.
2931
ed2b1829
RR
2932* `simple` - in centralized workflow, work like `upstream` with an
2933 added safety to refuse to push if the upstream branch's name is
2934 different from the local one.
b1290514 2935+
ed2b1829
RR
2936When pushing to a remote that is different from the remote you normally
2937pull from, work as `current`. This is the safest option and is suited
2938for beginners.
b1290514 2939+
009055f3 2940This mode has become the default in Git 2.0.
87a70e4c
RR
2941
2942* `matching` - push all branches having the same name on both ends.
2943 This makes the repository you are pushing to remember the set of
2944 branches that will be pushed out (e.g. if you always push 'maint'
2945 and 'master' there and no other branches, the repository you push
2946 to will have these two branches, and your local 'maint' and
2947 'master' will be pushed there).
2948+
2949To use this mode effectively, you have to make sure _all_ the
2950branches you would push out are ready to be pushed out before
2951running 'git push', as the whole point of this mode is to allow you
2952to push all of the branches in one go. If you usually finish work
2953on only one branch and push out the result, while other branches are
2954unfinished, this mode is not for you. Also this mode is not
2955suitable for pushing into a shared central repository, as other
2956people may add new branches there, or update the tip of existing
2957branches outside your control.
2958+
009055f3
JH
2959This used to be the default, but not since Git 2.0 (`simple` is the
2960new default).
87a70e4c
RR
2961
2962--
52153747 2963
a8bc269f 2964push.followTags::
bcf9626a 2965 If set to true enable `--follow-tags` option by default. You
a8bc269f 2966 may override this configuration at time of push by specifying
bcf9626a 2967 `--no-follow-tags`.
a8bc269f 2968
68c757f2
DB
2969push.gpgSign::
2970 May be set to a boolean value, or the string 'if-asked'. A true
bcf9626a 2971 value causes all pushes to be GPG signed, as if `--signed` is
68c757f2
DB
2972 passed to linkgit:git-push[1]. The string 'if-asked' causes
2973 pushes to be signed if the server supports it, as if
bcf9626a 2974 `--signed=if-asked` is passed to 'git push'. A false value may
68c757f2
DB
2975 override a value from a lower-priority config file. An explicit
2976 command-line flag always overrides this config option.
a8bc269f 2977
d8052750
MP
2978push.pushOption::
2979 When no `--push-option=<option>` argument is given from the
2980 command line, `git push` behaves as if each <value> of
2981 this variable is given as `--push-option=<value>`.
2982+
2983This is a multi-valued variable, and an empty value can be used in a
2984higher priority configuration file (e.g. `.git/config` in a
2985repository) to clear the values inherited from a lower priority
2986configuration files (e.g. `$HOME/.gitconfig`).
2987+
2988--
2989
2990Example:
2991
2992/etc/gitconfig
2993 push.pushoption = a
2994 push.pushoption = b
2995
2996~/.gitconfig
2997 push.pushoption = c
2998
2999repo/.git/config
3000 push.pushoption =
3001 push.pushoption = b
3002
3003This will result in only b (a and c are cleared).
3004
3005--
3006
b33a15b0
MC
3007push.recurseSubmodules::
3008 Make sure all submodule commits used by the revisions to be pushed
3009 are available on a remote-tracking branch. If the value is 'check'
3010 then Git will verify that all submodule commits that changed in the
3011 revisions to be pushed are available on at least one remote of the
3012 submodule. If any commits are missing, the push will be aborted and
3013 exit with non-zero status. If the value is 'on-demand' then all
3014 submodules that changed in the revisions to be pushed will be
3015 pushed. If on-demand was not able to push all necessary revisions
3016 it will also be aborted and exit with non-zero status. If the value
3017 is 'no' then default behavior of ignoring submodules when pushing
3018 is retained. You may override this configuration at time of push by
3019 specifying '--recurse-submodules=check|on-demand|no'.
3020
946a9f20 3021include::rebase-config.txt[]
16cf51c7 3022
da0005b8 3023receive.advertiseAtomic::
04b39f19 3024 By default, git-receive-pack will advertise the atomic push
c714e45f
SB
3025 capability to its clients. If you don't want to advertise this
3026 capability, set this variable to false.
3027
3028receive.advertisePushOptions::
b7b744f2
JT
3029 When set to true, git-receive-pack will advertise the push options
3030 capability to its clients. False by default.
04b39f19 3031
77e3efbf
JH
3032receive.autogc::
3033 By default, git-receive-pack will run "git-gc --auto" after
3034 receiving data from git-push and updating refs. You can stop
3035 it by setting this variable to false.
3036
da0005b8 3037receive.certNonceSeed::
b89363e4
JH
3038 By setting this variable to a string, `git receive-pack`
3039 will accept a `git push --signed` and verifies it by using
3040 a "nonce" protected by HMAC using this string as a secret
3041 key.
3042
da0005b8 3043receive.certNonceSlop::
5732373d
JH
3044 When a `git push --signed` sent a push certificate with a
3045 "nonce" that was issued by a receive-pack serving the same
3046 repository within this many seconds, export the "nonce"
3047 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
3048 hooks (instead of what the receive-pack asked the sending
3049 side to include). This may allow writing checks in
3050 `pre-receive` and `post-receive` a bit easier. Instead of
3051 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
3052 that records by how many seconds the nonce is stale to
3053 decide if they want to accept the certificate, they only
3054 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
3055
b0f34c3d
MM
3056receive.fsckObjects::
3057 If it is set to true, git-receive-pack will check all received
5180dd2e
ÆAB
3058 objects. See `transfer.fsckObjects` for what's checked.
3059 Defaults to false. If not set, the value of
3060 `transfer.fsckObjects` is used instead.
b0f34c3d 3061
4b55b9b4 3062receive.fsck.<msg-id>::
b2558abd
ÆAB
3063 Acts like `fsck.<msg-id>`, but is used by
3064 linkgit:git-receive-pack[1] instead of
3065 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
3066 details.
4b55b9b4 3067
cd94c6f9 3068receive.fsck.skipList::
b2558abd
ÆAB
3069 Acts like `fsck.skipList`, but is used by
3070 linkgit:git-receive-pack[1] instead of
3071 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
3072 details.
cd94c6f9 3073
83558686
JK
3074receive.keepAlive::
3075 After receiving the pack from the client, `receive-pack` may
3076 produce no output (if `--quiet` was specified) while processing
3077 the pack, causing some networks to drop the TCP connection.
3078 With this option set, if `receive-pack` does not transmit
3079 any data in this phase for `receive.keepAlive` seconds, it will
3080 send a short keepalive packet. The default is 5 seconds; set
3081 to 0 to disable keepalives entirely.
3082
b0f34c3d
MM
3083receive.unpackLimit::
3084 If the number of objects received in a push is below this
3085 limit then the objects will be unpacked into loose object
3086 files. However if the number of received objects equals or
3087 exceeds this limit then the received pack will be stored as
3088 a pack, after adding any missing delta bases. Storing the
3089 pack from a push can make the push operation complete faster,
3090 especially on slow filesystems. If not set, the value of
3091 `transfer.unpackLimit` is used instead.
3092
c08db5a2
JK
3093receive.maxInputSize::
3094 If the size of the incoming pack stream is larger than this
3095 limit, then git-receive-pack will error out, instead of
3096 accepting the pack file. If not set or set to 0, then the size
3097 is unlimited.
3098
42fc11c1
JH
3099receive.denyDeletes::
3100 If set to true, git-receive-pack will deny a ref update that deletes
3101 the ref. Use this to prevent such a ref deletion via a push.
3102
662c83ff
TR
3103receive.denyDeleteCurrent::
3104 If set to true, git-receive-pack will deny a ref update that
3105 deletes the currently checked out branch of a non-bare repository.
3106
42fc11c1 3107receive.denyCurrentBranch::
f3838ce1 3108 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
3109 to the currently checked out branch of a non-bare repository.
3110 Such a push is potentially dangerous because it brings the HEAD
3111 out of sync with the index and working tree. If set to "warn",
3112 print a warning of such a push to stderr, but allow the push to
3113 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 3114 message. Defaults to "refuse".
1404bcbb
JS
3115+
3116Another option is "updateInstead" which will update the working
08553319 3117tree if pushing into the current branch. This option is
1404bcbb
JS
3118intended for synchronizing working directories when one side is not easily
3119accessible via interactive ssh (e.g. a live web site, hence the requirement
3120that the working directory be clean). This mode also comes in handy when
3121developing inside a VM to test and fix code on different Operating Systems.
08553319
JH
3122+
3123By default, "updateInstead" will refuse the push if the working tree or
3124the index have any difference from the HEAD, but the `push-to-checkout`
3125hook can be used to customize this. See linkgit:githooks[5].
42fc11c1 3126
b0f34c3d
MM
3127receive.denyNonFastForwards::
3128 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 3129 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
3130 even if that push is forced. This configuration variable is
3131 set when initializing a shared repository.
3132
da0005b8 3133receive.hideRefs::
cc118a65
JK
3134 This variable is the same as `transfer.hideRefs`, but applies
3135 only to `receive-pack` (and so affects pushes, but not fetches).
3136 An attempt to update or delete a hidden ref by `git push` is
3137 rejected.
daebaa78 3138
da0005b8 3139receive.updateServerInfo::
77e3efbf
JH
3140 If set to true, git-receive-pack will run git-update-server-info
3141 after receiving data from git-push and updating refs.
3142
da0005b8 3143receive.shallowUpdate::
0a1bc12b
NTND
3144 If set to true, .git/shallow can be updated when new refs
3145 require new shallow roots. Otherwise those refs are rejected.
3146
da0005b8 3147remote.pushDefault::
224c2171 3148 The remote to push to by default. Overrides
9f765ce6 3149 `branch.<name>.remote` for all branches, and is overridden by
da0005b8 3150 `branch.<name>.pushRemote` for specific branches.
224c2171 3151
0cc6d346 3152remote.<name>.url::
5162e697
DM
3153 The URL of a remote repository. See linkgit:git-fetch[1] or
3154 linkgit:git-push[1].
0cc6d346 3155
20346234
MG
3156remote.<name>.pushurl::
3157 The push URL of a remote repository. See linkgit:git-push[1].
3158
14c98218
SV
3159remote.<name>.proxy::
3160 For remotes that require curl (http, https and ftp), the URL to
3161 the proxy to use for that remote. Set to the empty string to
3162 disable proxying for that remote.
3163
ef976395
KF
3164remote.<name>.proxyAuthMethod::
3165 For remotes that require curl (http, https and ftp), the method to use for
3166 authenticating against the proxy in use (probably set in
3167 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3168
0cc6d346 3169remote.<name>.fetch::
5162e697
DM
3170 The default set of "refspec" for linkgit:git-fetch[1]. See
3171 linkgit:git-fetch[1].
0cc6d346
SB
3172
3173remote.<name>.push::
5162e697
DM
3174 The default set of "refspec" for linkgit:git-push[1]. See
3175 linkgit:git-push[1].
0cc6d346 3176