fsck: use oidset instead of oid_array for skipList
[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
08aefc9e
NTND
940core.sparseCheckout::
941 Enable "sparse checkout" feature. See section "Sparse checkout" in
942 linkgit:git-read-tree[1] for more information.
943
a71f09fe 944core.abbrev::
48d5014d
JH
945 Set the length object names are abbreviated to. If
946 unspecified or set to "auto", an appropriate value is
947 computed based on the approximate number of packed objects
948 in your repository, which hopefully is enough for
949 abbreviated object names to stay unique for some time.
fb87327a 950 The minimum length is 4.
dce96489 951
6b3020a2 952add.ignoreErrors::
502e7f98 953add.ignore-errors (deprecated)::
0b444cdb 954 Tells 'git add' to continue adding files when some files cannot be
bcf9626a 955 added due to indexing errors. Equivalent to the `--ignore-errors`
394e1505
JH
956 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
957 as it does not follow the usual naming convention for configuration
958 variables.
13bd2134 959
4514ad4f 960alias.*::
5162e697 961 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
962 after defining "alias.last = cat-file commit HEAD", the invocation
963 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84 964 confusion and troubles with script usage, aliases that
2de9b711 965 hide existing Git commands are ignored. Arguments are split by
99b41c84 966 spaces, the usual shell quoting and escaping is supported.
a79c3a1b 967 A quote pair or a backslash can be used to quote them.
f368f5a6
JH
968+
969If the alias expansion is prefixed with an exclamation point,
970it will be treated as a shell command. For example, defining
971"alias.new = !gitk --all --not ORIG_HEAD", the invocation
972"git new" is equivalent to running the shell command
595b8dbf
SC
973"gitk --all --not ORIG_HEAD". Note that shell commands will be
974executed from the top-level directory of a repository, which may
975not necessarily be the current directory.
eee7f4a2 976`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
7cf16a14 977from the original current directory. See linkgit:git-rev-parse[1].
dfd42a3c 978
e80d4cbe
SH
979am.keepcr::
980 If true, git-am will call git-mailsplit for patches in mbox format
bcf9626a 981 with parameter `--keep-cr`. In this case git-mailsplit will
6b677a28 982 not remove `\r` from lines ending with `\r\n`. Can be overridden
bcf9626a 983 by giving `--no-keep-cr` from the command line.
e80d4cbe
SH
984 See linkgit:git-am[1], linkgit:git-mailsplit[1].
985
e97a5e76
RL
986am.threeWay::
987 By default, `git am` will fail if the patch does not apply cleanly. When
988 set to true, this setting tells `git am` to fall back on 3-way merge if
989 the patch records the identity of blobs it is supposed to apply to and
990 we have those blobs available locally (equivalent to giving the `--3way`
991 option from the command line). Defaults to `false`.
992 See linkgit:git-am[1].
993
da0005b8 994apply.ignoreWhitespace::
0b444cdb 995 When set to 'change', tells 'git apply' to ignore changes in
bcf9626a 996 whitespace, in the same way as the `--ignore-space-change`
86c91f91 997 option.
0b444cdb 998 When set to one of: no, none, never, false tells 'git apply' to
86c91f91
GB
999 respect all whitespace differences.
1000 See linkgit:git-apply[1].
1001
1ab661dd 1002apply.whitespace::
0b444cdb 1003 Tells 'git apply' how to handle whitespaces, in the same way
bcf9626a 1004 as the `--whitespace` option. See linkgit:git-apply[1].
1ab661dd 1005
de0bc11d
SB
1006blame.blankBoundary::
1007 Show blank commit object name for boundary commits in
1008 linkgit:git-blame[1]. This option defaults to false.
1009
8578037b
NTND
1010blame.coloring::
1011 This determines the coloring scheme to be applied to blame
1012 output. It can be 'repeatedLines', 'highlightRecent',
1013 or 'none' which is the default.
de0bc11d
SB
1014
1015blame.date::
1016 Specifies the format used to output dates in linkgit:git-blame[1].
1017 If unset the iso format is used. For supported values,
1018 see the discussion of the `--date` option at linkgit:git-log[1].
1019
8578037b
NTND
1020blame.showEmail::
1021 Show the author email instead of author name in linkgit:git-blame[1].
1022 This option defaults to false.
1023
1024blame.showRoot::
1025 Do not treat root commits as boundaries in linkgit:git-blame[1].
1026 This option defaults to false.
1027
da0005b8 1028branch.autoSetupMerge::
add0951a 1029 Tells 'git branch' and 'git checkout' to set up new branches
572fc81d
JS
1030 so that linkgit:git-pull[1] will appropriately merge from the
1031 starting point branch. Note that even if this option is not set,
9902387d 1032 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
1033 and `--no-track` options. The valid settings are: `false` -- no
1034 automatic setup is done; `true` -- automatic setup is done when the
29b9a66f
MM
1035 starting point is a remote-tracking branch; `always` --
1036 automatic setup is done when the starting point is either a
1037 local branch or remote-tracking
572fc81d 1038 branch. This option defaults to true.
9902387d 1039
da0005b8 1040branch.autoSetupRebase::
0b444cdb 1041 When a new branch is created with 'git branch' or 'git checkout'
2de9b711 1042 that tracks another branch, this variable tells Git to set
c998ae9b
DS
1043 up pull to rebase instead of merge (see "branch.<name>.rebase").
1044 When `never`, rebase is never automatically set to true.
1045 When `local`, rebase is set to true for tracked branches of
1046 other local branches.
1047 When `remote`, rebase is set to true for tracked branches of
29b9a66f 1048 remote-tracking branches.
c998ae9b
DS
1049 When `always`, rebase will be set to true for all tracking
1050 branches.
da0005b8 1051 See "branch.autoSetupMerge" for details on how to set up a
c998ae9b
DS
1052 branch to track another branch.
1053 This option defaults to never.
1054
560ae1c1
SM
1055branch.sort::
1056 This variable controls the sort ordering of branches when displayed by
1057 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1058 value of this variable will be used as the default.
1059 See linkgit:git-for-each-ref[1] field names for valid values.
1060
648ad18f 1061branch.<name>.remote::
224c2171
RR
1062 When on branch <name>, it tells 'git fetch' and 'git push'
1063 which remote to fetch from/push to. The remote to push to
da0005b8 1064 may be overridden with `remote.pushDefault` (for all branches).
9f765ce6 1065 The remote to push to, for the current branch, may be further
da0005b8 1066 overridden by `branch.<name>.pushRemote`. If no remote is
9f765ce6 1067 configured, or if you are not on any branch, it defaults to
da0005b8 1068 `origin` for fetching and `remote.pushDefault` for pushing.
b85ecea6
PO
1069 Additionally, `.` (a period) is the current local repository
1070 (a dot-repository), see `branch.<name>.merge`'s final note below.
9f765ce6 1071
da0005b8 1072branch.<name>.pushRemote::
9f765ce6 1073 When on branch <name>, it overrides `branch.<name>.remote` for
da0005b8 1074 pushing. It also overrides `remote.pushDefault` for pushing
9f765ce6
RR
1075 from branch <name>. When you pull from one place (e.g. your
1076 upstream) and push to another place (e.g. your own publishing
da0005b8 1077 repository), you would want to set `remote.pushDefault` to
9f765ce6
RR
1078 specify the remote to push to for all branches, and use this
1079 option to override it for a specific branch.
648ad18f 1080
5372806a 1081branch.<name>.merge::
76d3cc50 1082 Defines, together with branch.<name>.remote, the upstream branch
15a147e6 1083 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
0b444cdb
TR
1084 branch to merge and can also affect 'git push' (see push.default).
1085 When in branch <name>, it tells 'git fetch' the default
b888d61c
DB
1086 refspec to be marked for merging in FETCH_HEAD. The value is
1087 handled like the remote part of a refspec, and must match a
1088 ref which is fetched from the remote given by
1089 "branch.<name>.remote".
0b444cdb
TR
1090 The merge information is used by 'git pull' (which at first calls
1091 'git fetch') to lookup the default branch for merging. Without
1092 this option, 'git pull' defaults to merge the first refspec fetched.
62b339a5 1093 Specify multiple values to get an octopus merge.
0b444cdb 1094 If you wish to setup 'git pull' so that it merges into <name> from
9debc324 1095 another branch in the local repository, you can point
b85ecea6
PO
1096 branch.<name>.merge to the desired branch, and use the relative path
1097 setting `.` (a period) for branch.<name>.remote.
5372806a 1098
da0005b8 1099branch.<name>.mergeOptions::
aec7b362 1100 Sets default options for merging into branch <name>. The syntax and
25dcc0d6 1101 supported options are the same as those of linkgit:git-merge[1], but
aec7b362
LH
1102 option values containing whitespace characters are currently not
1103 supported.
1104
cd67e4d4
JS
1105branch.<name>.rebase::
1106 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa 1107 instead of merging the default branch from the default remote when
6b37dff1
ÆAB
1108 "git pull" is run. See "pull.rebase" for doing this in a non
1109 branch-specific manner.
66713ef3 1110+
1131ec98
JS
1111When `merges`, pass the `--rebase-merges` option to 'git rebase'
1112so that the local merge commits are included in the rebase (see
1113linkgit:git-rebase[1] for details).
1114+
d2387107
AS
1115When preserve, also pass `--preserve-merges` along to 'git rebase'
1116so that locally committed merge commits will not be flattened
1117by running 'git pull'.
6b37dff1 1118+
f5eb87b9
JS
1119When the value is `interactive`, the rebase is run in interactive mode.
1120+
6b37dff1
ÆAB
1121*NOTE*: this is a possibly dangerous operation; do *not* use
1122it unless you understand the implications (see linkgit:git-rebase[1]
1123for details).
cd67e4d4 1124
a5ba2cbe
NTND
1125branch.<name>.description::
1126 Branch description, can be edited with
1127 `git branch --edit-description`. Branch description is
1128 automatically added in the format-patch cover letter or
1129 request-pull summary.
1130
1658c614
CC
1131browser.<tool>.cmd::
1132 Specify the command to invoke the specified browser. The
1133 specified command is evaluated in shell with the URLs passed
565e135a 1134 as arguments. (See linkgit:git-web{litdd}browse[1].)
1658c614 1135
584627b4
CC
1136browser.<tool>.path::
1137 Override the path for the given tool that may be used to
23f8239b 1138 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
ab989adf 1139 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 1140
8d7b558b
ÆAB
1141checkout.defaultRemote::
1142 When you run 'git checkout <something>' and only have one
1143 remote, it may implicitly fall back on checking out and
1144 tracking e.g. 'origin/<something>'. This stops working as soon
1145 as you have more than one remote with a '<something>'
1146 reference. This setting allows for setting the name of a
1147 preferred remote that should always win when it comes to
1148 disambiguation. The typical use-case is to set this to
1149 `origin`.
1150+
1151Currently this is used by linkgit:git-checkout[1] when 'git checkout
1152<something>' will checkout the '<something>' branch on another remote,
1153and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1154remote branch. This setting might be used for other checkout-like
1155commands or functionality in the future.
1156
2122591b 1157clean.requireForce::
f85f7947
JX
1158 A boolean to make git-clean do nothing unless given -f,
1159 -i or -n. Defaults to true.
2122591b 1160
79f62e7d
JS
1161color.advice::
1162 A boolean to enable/disable color in hints (e.g. when a push
1163 failed, see `advice.*` for a list). May be set to `always`,
1164 `false` (or `never`) or `auto` (or `true`), in which case colors
1165 are used only when the error output goes to a terminal. If
1166 unset, then the value of `color.ui` is used (`auto` by default).
1167
1168color.advice.hint::
1169 Use customized color for hints.
1170
8578037b
NTND
1171color.blame.highlightRecent::
1172 This can be used to color the metadata of a blame line depending
1173 on age of the line.
1174+
1175This setting should be set to a comma-separated list of color and date settings,
1176starting and ending with a color, the dates should be set from oldest to newest.
1177The metadata will be colored given the colors if the the line was introduced
1178before the given timestamp, overwriting older timestamped colors.
1179+
1180Instead of an absolute timestamp relative timestamps work as well, e.g.
11812.weeks.ago is valid to address anything older than 2 weeks.
1182+
1183It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1184everything older than one year blue, recent changes between one month and
1185one year old are kept white, and lines introduced within the last month are
1186colored red.
1187
1188color.blame.repeatedLines::
1189 Use the customized color for the part of git-blame output that
1190 is repeated meta information per line (such as commit id,
1191 author name, date and timezone). Defaults to cyan.
1192
f3673988
BG
1193color.branch::
1194 A boolean to enable/disable color in the output of
5162e697 1195 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 1196 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1197 only when the output is to a terminal. If unset, then the
1198 value of `color.ui` is used (`auto` by default).
f3673988
BG
1199
1200color.branch.<slot>::
1201 Use customized color for branch coloration. `<slot>` is one of
1202 `current` (the current branch), `local` (a local branch),
dbda21fa
FC
1203 `remote` (a remote-tracking branch in refs/remotes/),
1204 `upstream` (upstream tracking branch), `plain` (other
4f193f20 1205 refs).
f3673988 1206
a159ca0c 1207color.diff::
6999c540
MG
1208 Whether to use ANSI escape sequences to add color to patches.
1209 If this is set to `always`, linkgit:git-diff[1],
1210 linkgit:git-log[1], and linkgit:git-show[1] will use color
1211 for all patches. If it is set to `true` or `auto`, those
1212 commands will only use color when output is to the terminal.
14d16e2b
MM
1213 If unset, then the value of `color.ui` is used (`auto` by
1214 default).
6999c540 1215+
a58088ab 1216This does not affect linkgit:git-format-patch[1] or the
6999c540
MG
1217'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1218command line with the `--color[=<when>]` option.
b5376648 1219
a159ca0c 1220color.diff.<slot>::
4f193f20
MW
1221 Use customized color for diff colorization. `<slot>` specifies
1222 which part of the patch to use the specified color, and is one
74b15bfb
JK
1223 of `context` (context text - `plain` is a historical synonym),
1224 `meta` (metainformation), `frag`
89cb73a1 1225 (hunk header), 'func' (function in hunk header), `old` (removed lines),
61e89eaa
SB
1226 `new` (added lines), `commit` (commit headers), `whitespace`
1227 (highlighting whitespace errors), `oldMoved` (deleted lines),
1228 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1229 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
a7be92ac
JS
1230 `newMovedAlternativeDimmed` (See the '<mode>'
1231 setting of '--color-moved' in linkgit:git-diff[1] for details),
1232 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1233 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
b5376648 1234
5e11bee6
NR
1235color.decorate.<slot>::
1236 Use customized color for 'git log --decorate' output. `<slot>` is one
1237 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
09c4ba41
NTND
1238 branches, remote-tracking branches, tags, stash and HEAD, respectively
1239 and `grafted` for grafted commits.
5e11bee6 1240
7e8f59d5
RS
1241color.grep::
1242 When set to `always`, always highlight matches. When `false` (or
1243 `never`), never. When set to `true` or `auto`, use color only
14d16e2b
MM
1244 when the output is written to the terminal. If unset, then the
1245 value of `color.ui` is used (`auto` by default).
7e8f59d5 1246
55f638bd
ML
1247color.grep.<slot>::
1248 Use customized color for grep colorization. `<slot>` specifies which
1249 part of the line to use the specified color, and is one of
1250+
1251--
00588bb5
ML
1252`context`;;
1253 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
1254`filename`;;
1255 filename prefix (when not using `-h`)
00588bb5
ML
1256`function`;;
1257 function name lines (when using `-p`)
f8a0c6e7 1258`lineNumber`;;
55f638bd 1259 line number prefix (when using `-n`)
6653fec3
TB
1260`column`;;
1261 column number prefix (when using `--column`)
55f638bd 1262`match`;;
79a77109
RS
1263 matching text (same as setting `matchContext` and `matchSelected`)
1264`matchContext`;;
1265 matching text in context lines
1266`matchSelected`;;
1267 matching text in selected lines
00588bb5
ML
1268`selected`;;
1269 non-matching text in selected lines
55f638bd
ML
1270`separator`;;
1271 separators between fields on a line (`:`, `-`, and `=`)
1272 and between hunks (`--`)
1273--
7e8f59d5 1274
b4c61ed6 1275color.interactive::
47ee06f1 1276 When set to `always`, always use colors for interactive prompts
7a9b0b80
JX
1277 and displays (such as those used by "git-add --interactive" and
1278 "git-clean --interactive"). When false (or `never`), never.
1279 When set to `true` or `auto`, use colors only when the output is
14d16e2b
MM
1280 to the terminal. If unset, then the value of `color.ui` is
1281 used (`auto` by default).
b4c61ed6
JH
1282
1283color.interactive.<slot>::
7a9b0b80
JX
1284 Use customized color for 'git add --interactive' and 'git clean
1285 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1286 or `error`, for four distinct types of normal output from
b92c1a28 1287 interactive commands.
b4c61ed6 1288
1d77043b
JH
1289color.pager::
1290 A boolean to enable/disable colored output when the pager is in
1291 use (default is true).
1292
79f62e7d
JS
1293color.push::
1294 A boolean to enable/disable color in push errors. May be set to
1295 `always`, `false` (or `never`) or `auto` (or `true`), in which
1296 case colors are used only when the error output goes to a terminal.
1297 If unset, then the value of `color.ui` is used (`auto` by default).
1298
1299color.push.error::
1300 Use customized color for push errors.
1301
bf1a11f0
HWN
1302color.remote::
1303 If set, keywords at the start of the line are highlighted. The
1304 keywords are "error", "warning", "hint" and "success", and are
1305 matched case-insensitively. May be set to `always`, `false` (or
1306 `never`) or `auto` (or `true`). If unset, then the value of
1307 `color.ui` is used (`auto` by default).
1308
1309color.remote.<slot>::
1310 Use customized color for each remote keyword. `<slot>` may be
1311 `hint`, `warning`, `success` or `error` which match the
1312 corresponding keyword.
1313
da0005b8 1314color.showBranch::
ab07ba2a
MH
1315 A boolean to enable/disable color in the output of
1316 linkgit:git-show-branch[1]. May be set to `always`,
1317 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1318 only when the output is to a terminal. If unset, then the
1319 value of `color.ui` is used (`auto` by default).
ab07ba2a 1320
1d77043b
JH
1321color.status::
1322 A boolean to enable/disable color in the output of
5162e697 1323 linkgit:git-status[1]. May be set to `always`,
cec99d8c 1324 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1325 only when the output is to a terminal. If unset, then the
1326 value of `color.ui` is used (`auto` by default).
1d77043b
JH
1327
1328color.status.<slot>::
1329 Use customized color for status colorization. `<slot>` is
1330 one of `header` (the header text of the status message),
82dca848
SP
1331 `added` or `updated` (files which are added but not committed),
1332 `changed` (files which are changed but not added in the index),
2de9b711 1333 `untracked` (files which are not tracked by Git),
0d6accc0 1334 `branch` (the current branch),
950ce2e2 1335 `nobranch` (the color the 'no branch' warning is shown in, defaulting
93fdf301
SK
1336 to red),
1337 `localBranch` or `remoteBranch` (the local and remote branch names,
1338 respectively, when branch and tracking information is displayed in the
1339 status short-format), or
0d6accc0 1340 `unmerged` (files which have unmerged changes).
1d77043b 1341
79f62e7d
JS
1342color.transport::
1343 A boolean to enable/disable color when pushes are rejected. May be
1344 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1345 case colors are used only when the error output goes to a terminal.
1346 If unset, then the value of `color.ui` is used (`auto` by default).
1347
1348color.transport.rejected::
1349 Use customized color when a push was rejected.
1350
6b2f2d98 1351color.ui::
6999c540
MG
1352 This variable determines the default value for variables such
1353 as `color.diff` and `color.grep` that control the use of color
1354 per command family. Its scope will expand as more commands learn
1355 configuration to set a default for the `--color` option. Set it
4c7f1819
MM
1356 to `false` or `never` if you prefer Git commands not to use
1357 color unless enabled explicitly with some other configuration
1358 or the `--color` option. Set it to `always` if you want all
1359 output not intended for machine consumption to use color, to
1360 `true` or `auto` (this is the default since Git 1.8.4) if you
1361 want such output to use color when written to the terminal.
6b2f2d98 1362
7e29b825
NTND
1363column.ui::
1364 Specify whether supported commands should output in columns.
1365 This variable consists of a list of tokens separated by spaces
1366 or commas:
1367+
5e62cc14
RR
1368These options control when the feature should be enabled
1369(defaults to 'never'):
1370+
7e29b825
NTND
1371--
1372`always`;;
1373 always show in columns
1374`never`;;
1375 never show in columns
1376`auto`;;
1377 show in columns if the output is to the terminal
5e62cc14
RR
1378--
1379+
1380These options control layout (defaults to 'column'). Setting any
1381of these implies 'always' if none of 'always', 'never', or 'auto' are
1382specified.
1383+
1384--
077539d7 1385`column`;;
5e62cc14 1386 fill columns before rows
077539d7
NTND
1387`row`;;
1388 fill rows before columns
7e29b825
NTND
1389`plain`;;
1390 show in one column
5e62cc14
RR
1391--
1392+
1393Finally, these options can be combined with a layout option (defaults
1394to 'nodense'):
1395+
1396--
3f8eccbe
NTND
1397`dense`;;
1398 make unequal size columns to utilize more space
1399`nodense`;;
1400 make equal size columns
7e29b825 1401--
7e29b825 1402
ebe31ef2
NTND
1403column.branch::
1404 Specify whether to output branch listing in `git branch` in columns.
1405 See `column.ui` for details.
1406
1b8fd467
JX
1407column.clean::
1408 Specify the layout when list items in `git clean -i`, which always
1409 shows files and directories in columns. See `column.ui` for details.
1410
323d0530
NTND
1411column.status::
1412 Specify whether to output untracked files in `git status` in columns.
1413 See `column.ui` for details.
1414
d96e3c15
NTND
1415column.tag::
1416 Specify whether to output tag listing in `git tag` in columns.
1417 See `column.ui` for details.
1418
51fb3a3d
RT
1419commit.cleanup::
1420 This setting overrides the default of the `--cleanup` option in
1421 `git commit`. See linkgit:git-commit[1] for details. Changing the
1422 default can be useful when you always want to keep lines that begin
1423 with comment character `#` in your log message, in which case you
1424 would do `git config commit.cleanup whitespace` (note that you will
1425 have to remove the help lines that begin with `#` in the commit log
1426 template yourself, if you do this).
1427
da0005b8 1428commit.gpgSign::
d95bfb12
NV
1429
1430 A boolean to specify whether all commits should be GPG signed.
1431 Use of this option when doing operations such as rebase can
1432 result in a large number of commits being signed. It may be
1433 convenient to use an agent to avoid typing your GPG passphrase
1434 several times.
1435
88955ed2 1436commit.status::
bed575e4
JHI
1437 A boolean to enable/disable inclusion of status information in the
1438 commit message template when using an editor to prepare the commit
1439 message. Defaults to true.
1440
b0f34c3d 1441commit.template::
dca83abd
JH
1442 Specify the pathname of a file to use as the template for
1443 new commit messages.
b0f34c3d 1444
aaab8420
PB
1445commit.verbose::
1446 A boolean or int to specify the level of verbose with `git commit`.
1447 See linkgit:git-commit[1].
1448
a6fc9fd3
JK
1449credential.helper::
1450 Specify an external helper to be called when a username or
1451 password credential is needed; the helper may consult external
24321375
JK
1452 storage to avoid prompting the user for the credentials. Note
1453 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1454 for details.
a6fc9fd3
JK
1455
1456credential.useHttpPath::
1457 When acquiring credentials, consider the "path" component of an http
1458 or https URL to be important. Defaults to false. See
1459 linkgit:gitcredentials[7] for more information.
1460
1461credential.username::
1462 If no username is set for a network authentication, use this username
1463 by default. See credential.<context>.* below, and
1464 linkgit:gitcredentials[7].
1465
1466credential.<url>.*::
1467 Any of the credential.* options above can be applied selectively to
1468 some credentials. For example "credential.https://example.com.username"
1469 would set the default username only for https connections to
1470 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1471 matched.
1472
7f4d4746
NP
1473credentialCache.ignoreSIGHUP::
1474 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1475
6532f374
NTND
1476completion.commands::
1477 This is only used by git-completion.bash to add or remove
1478 commands from the list of completed commands. Normally only
1479 porcelain commands and a few select others are completed. You
1480 can add more commands, separated by space, in this
1481 variable. Prefixing the command with '-' will remove it from
1482 the existing list.
1483
19299a84 1484include::diff-config.txt[]
afcbc8e7
DA
1485
1486difftool.<tool>.path::
1487 Override the path for the given tool. This is useful in case
1488 your tool is not in the PATH.
1489
1490difftool.<tool>.cmd::
1491 Specify the command to invoke the specified diff tool.
1492 The specified command is evaluated in shell with the following
1493 variables available: 'LOCAL' is set to the name of the temporary
1494 file containing the contents of the diff pre-image and 'REMOTE'
1495 is set to the name of the temporary file containing the contents
1496 of the diff post-image.
1497
a904392e
DA
1498difftool.prompt::
1499 Prompt before each invocation of the diff tool.
1500
d9545c7f
EW
1501fastimport.unpackLimit::
1502 If the number of objects imported by linkgit:git-fast-import[1]
1503 is below this limit, then the objects will be unpacked into
1504 loose object files. However if the number of imported objects
1505 equals or exceeds this limit then the pack will be stored as a
1506 pack. Storing the pack from a fast-import can make the import
1507 operation complete faster, especially on slow filesystems. If
1508 not set, the value of `transfer.unpackLimit` is used instead.
1509
be254a0e 1510fetch.recurseSubmodules::
1fb25502
JL
1511 This option can be either set to a boolean value or to 'on-demand'.
1512 Setting it to a boolean changes the behavior of fetch and pull to
1513 unconditionally recurse into submodules when set to true or to not
1514 recurse at all when set to false. When set to 'on-demand' (the default
1515 value), fetch and pull will only recurse into a populated submodule
1516 when its superproject retrieves a commit that updates the submodule's
1517 reference.
be254a0e 1518
5e838ea7
JH
1519fetch.fsckObjects::
1520 If it is set to true, git-fetch-pack will check all fetched
5180dd2e
ÆAB
1521 objects. See `transfer.fsckObjects` for what's
1522 checked. Defaults to false. If not set, the value of
1523 `transfer.fsckObjects` is used instead.
5e838ea7 1524
1362df0d
ÆAB
1525fetch.fsck.<msg-id>::
1526 Acts like `fsck.<msg-id>`, but is used by
1527 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1528 the `fsck.<msg-id>` documentation for details.
1529
1530fetch.fsck.skipList::
1531 Acts like `fsck.skipList`, but is used by
1532 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1533 the `fsck.skipList` documentation for details.
5e838ea7 1534
af7cf268 1535fetch.unpackLimit::
2de9b711 1536 If the number of objects fetched over the Git native
af7cf268
JH
1537 transfer is below this
1538 limit, then the objects will be unpacked into loose object
1539 files. However if the number of received objects equals or
1540 exceeds this limit then the received pack will be stored as
1541 a pack, after adding any missing delta bases. Storing the
1542 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1543 especially on slow filesystems. If not set, the value of
1544 `transfer.unpackLimit` is used instead.
af7cf268 1545
737c5a9c
MS
1546fetch.prune::
1547 If true, fetch will automatically behave as if the `--prune`
627a129b
ÆAB
1548 option was given on the command line. See also `remote.<name>.prune`
1549 and the PRUNING section of linkgit:git-fetch[1].
737c5a9c 1550
97716d21
ÆAB
1551fetch.pruneTags::
1552 If true, fetch will automatically behave as if the
1553 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1554 if not set already. This allows for setting both this option
1555 and `fetch.prune` to maintain a 1=1 mapping to upstream
1556 refs. See also `remote.<name>.pruneTags` and the PRUNING
1557 section of linkgit:git-fetch[1].
737c5a9c 1558
bc437d10
NTND
1559fetch.output::
1560 Control how ref update status is printed. Valid values are
1561 `full` and `compact`. Default value is `full`. See section
1562 OUTPUT in linkgit:git-fetch[1] for detail.
1563
42cc7485
JT
1564fetch.negotiationAlgorithm::
1565 Control how information about the commits in the local repository is
1566 sent when negotiating the contents of the packfile to be sent by the
1567 server. Set to "skipping" to use an algorithm that skips commits in an
1568 effort to converge faster, but may result in a larger-than-necessary
af3a67de 1569 packfile; The default is "default" which instructs Git to use the default algorithm
42cc7485
JT
1570 that never skips commits (unless the server has acknowledged it or one
1571 of its descendants).
af3a67de 1572 Unknown values will cause 'git fetch' to error out.
52660828
ÆAB
1573+
1574See also the `--negotiation-tip` option for linkgit:git-fetch[1].
42cc7485 1575
48d3448d
SB
1576format.attach::
1577 Enable multipart/mixed attachments as the default for
1578 'format-patch'. The value can also be a double quoted string
1579 which will enable attachments as the default and set the
1580 value as the boundary. See the --attach option in
1581 linkgit:git-format-patch[1].
1582
6bc6b6c0
JT
1583format.from::
1584 Provides the default value for the `--from` option to format-patch.
1585 Accepts a boolean value, or a name and email address. If false,
1586 format-patch defaults to `--no-from`, using commit authors directly in
1587 the "From:" field of patch mails. If true, format-patch defaults to
1588 `--from`, using your committer identity in the "From:" field of patch
1589 mails and including a "From:" field in the body of the patch mail if
1590 different. If set to a non-boolean value, format-patch uses that
1591 value instead of your committer identity. Defaults to false.
1592
49604a4d 1593format.numbered::
a567fdcb
BG
1594 A boolean which can enable or disable sequence numbers in patch
1595 subjects. It defaults to "auto" which enables it only if there
1596 is more than one patch. It can be enabled or disabled for all
1597 messages by setting it to "true" or "false". See --numbered
1598 option in linkgit:git-format-patch[1].
49604a4d 1599
1ab661dd
PB
1600format.headers::
1601 Additional email headers to include in a patch to be submitted
5162e697 1602 by mail. See linkgit:git-format-patch[1].
1ab661dd 1603
312a30eb 1604format.to::
48d3448d 1605format.cc::
312a30eb
MV
1606 Additional recipients to include in a patch to be submitted
1607 by mail. See the --to and --cc options in
1608 linkgit:git-format-patch[1].
48d3448d 1609
da0005b8 1610format.subjectPrefix::
48d3448d
SB
1611 The default for format-patch is to output files with the '[PATCH]'
1612 subject prefix. Use this variable to change that prefix.
1613
6622d9c7
SB
1614format.signature::
1615 The default for format-patch is to output a signature containing
2de9b711 1616 the Git version number. Use this variable to change that default.
6622d9c7
SB
1617 Set this variable to the empty string ("") to suppress
1618 signature generation.
1619
da0005b8 1620format.signatureFile::
7022650f
JM
1621 Works just like format.signature except the contents of the
1622 file specified by this variable will be used as the signature.
1623
78cb59c8
JS
1624format.suffix::
1625 The default for format-patch is to output files with the suffix
1626 `.patch`. Use this variable to change that suffix (make sure to
1627 include the dot if you want it).
1ab661dd 1628
94c22a5e
CR
1629format.pretty::
1630 The default pretty format for log/show/whatchanged command,
1631 See linkgit:git-log[1], linkgit:git-show[1],
1632 linkgit:git-whatchanged[1].
1633
30984ed2 1634format.thread::
0b444cdb 1635 The default threading style for 'git format-patch'. Can be
578b62bf
JN
1636 a boolean value, or `shallow` or `deep`. `shallow` threading
1637 makes every mail a reply to the head of the series,
30984ed2 1638 where the head is chosen from the cover letter, the
6cf378f0 1639 `--in-reply-to`, and the first patch mail, in this order.
fd1ff306 1640 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
1641 A true boolean value is the same as `shallow`, and a false
1642 value disables threading.
1643
da0005b8 1644format.signOff::
240ae2b8
FC
1645 A boolean value which lets you enable the `-s/--signoff` option of
1646 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1647 patch should be a conscious act and means that you certify you have
1648 the rights to submit this work under the same open source license.
1649 Please see the 'SubmittingPatches' document for further discussion.
1d1876e9 1650
2a4c2607
FC
1651format.coverLetter::
1652 A boolean that controls whether to generate a cover-letter when
1653 format-patch is invoked, but in addition can be set to "auto", to
1654 generate a cover-letter only when there's more than one patch.
1655
bc6bf2d7
AK
1656format.outputDirectory::
1657 Set a custom directory to store the resulting files instead of the
1658 current working directory.
1659
bb52995f
XY
1660format.useAutoBase::
1661 A boolean value which lets you enable the `--base=auto` option of
1662 format-patch by default.
1663
26488f59
RR
1664filter.<driver>.clean::
1665 The command which is used to convert the content of a worktree
1666 file to a blob upon checkin. See linkgit:gitattributes[5] for
1667 details.
1668
1669filter.<driver>.smudge::
1670 The command which is used to convert the content of a blob
1671 object to a worktree file upon checkout. See
1672 linkgit:gitattributes[5] for details.
1673
2becf00f 1674fsck.<msg-id>::
b2558abd
ÆAB
1675 During fsck git may find issues with legacy data which
1676 wouldn't be generated by current versions of git, and which
1677 wouldn't be sent over the wire if `transfer.fsckObjects` was
1678 set. This feature is intended to support working with legacy
1679 repositories containing such data.
1680+
1681Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1362df0d
ÆAB
1682to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1683to clone or fetch it set `fetch.fsck.<msg-id>`.
b2558abd
ÆAB
1684+
1685The rest of the documentation discusses `fsck.*` for brevity, but the
1362df0d
ÆAB
1686same applies for the corresponding `receive.fsck.*` and
1687`fetch.<msg-id>.*`. variables.
b2558abd 1688+
d786da1c
ÆAB
1689Unlike variables like `color.ui` and `core.editor` the
1690`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1691fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1692uniformly configure the same fsck settings in different circumstances
1693all three of them they must all set to the same values.
1694+
b2558abd
ÆAB
1695When `fsck.<msg-id>` is set, errors can be switched to warnings and
1696vice versa by configuring the `fsck.<msg-id>` setting where the
1697`<msg-id>` is the fsck message ID and the value is one of `error`,
1698`warn` or `ignore`. For convenience, fsck prefixes the error/warning
1699with the message ID, e.g. "missingEmail: invalid author/committer line
1700- missing email" means that setting `fsck.missingEmail = ignore` will
1701hide that issue.
1702+
1703In general, it is better to enumerate existing objects with problems
1704with `fsck.skipList`, instead of listing the kind of breakages these
1705problematic objects share to be ignored, as doing the latter will
1706allow new instances of the same breakages go unnoticed.
8a6d0525
ÆAB
1707+
1708Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1709doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1710will only cause git to warn.
2becf00f 1711
1335f732 1712fsck.skipList::
12b1c50a 1713 The path to a list of object names (i.e. one unabbreviated SHA-1 per
1335f732 1714 line) that are known to be broken in a non-fatal way and should
f706c42b
ÆAB
1715 be ignored. Comments ('#') and empty lines are not supported, and
1716 will error out.
1717+
1718This feature is useful when an established project should be accepted
1719despite early commits containing errors that can be safely ignored
1720such as invalid committer email addresses. Note: corrupt objects
1721cannot be skipped with this setting.
b2558abd 1722+
1362df0d
ÆAB
1723Like `fsck.<msg-id>` this variable has corresponding
1724`receive.fsck.skipList` and `fetch.fsck.skipList` variants.
d786da1c
ÆAB
1725+
1726Unlike variables like `color.ui` and `core.editor` the
1727`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1728fall back on the `fsck.skipList` configuration if they aren't set. To
1729uniformly configure the same fsck settings in different circumstances
1730all three of them they must all set to the same values.
58dc440b
ÆAB
1731+
1732Older versions of Git (before 2.20) documented that the object names
1733list should be sorted. This was never a requirement, the object names
3b41fb0c
RS
1734could appear in any order, but when reading the list we tracked whether
1735the list was sorted for the purposes of an internal binary search
1736implementation, which could save itself some work with an already sorted
1737list. Unless you had a humongous list there was no reason to go out of
1738your way to pre-sort the list. After Git version 2.20 a hash implementation
1739is used instead, so there's now no reason to pre-sort the list.
1335f732 1740
125f8146
NTND
1741gc.aggressiveDepth::
1742 The depth parameter used in the delta compression
1743 algorithm used by 'git gc --aggressive'. This defaults
07e7dbf0 1744 to 50.
125f8146 1745
0d7566a5
TT
1746gc.aggressiveWindow::
1747 The window size parameter used in the delta compression
0b444cdb 1748 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 1749 to 250.
0d7566a5 1750
e9831e83
JH
1751gc.auto::
1752 When there are approximately more than this many loose
1753 objects in the repository, `git gc --auto` will pack them.
1754 Some Porcelain commands use this command to perform a
80cd9cf9
MB
1755 light-weight garbage collection from time to time. The
1756 default value is 6700. Setting this to 0 disables it.
e9831e83 1757
da0005b8 1758gc.autoPackLimit::
17815501
JH
1759 When there are more than this many packs that are not
1760 marked with `*.keep` file in the repository, `git gc
80cd9cf9 1761 --auto` consolidates them into one larger pack. The
97063974 1762 default value is 50. Setting this to 0 disables it.
17815501 1763
da0005b8 1764gc.autoDetach::
f745acb0 1765 Make `git gc --auto` return immediately and run in background
9f673f94
NTND
1766 if the system supports it. Default is true.
1767
55dfe13d
NTND
1768gc.bigPackThreshold::
1769 If non-zero, all packs larger than this limit are kept when
1770 `git gc` is run. This is very similar to `--keep-base-pack`
1771 except that all packs that meet the threshold are kept, not
1772 just the base pack. Defaults to zero. Common unit suffixes of
1773 'k', 'm', or 'g' are supported.
8fc67762
NTND
1774+
1775Note that if the number of kept packs is more than gc.autoPackLimit,
1776this configuration variable is ignored, all packs except the base pack
1777will be repacked. After this the number of packs should go below
1778gc.autoPackLimit and gc.bigPackThreshold should be respected again.
55dfe13d 1779
d915114a
DS
1780gc.writeCommitGraph::
1781 If true, then gc will rewrite the commit-graph file when
1782 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1783 '--auto' the commit-graph will be updated if housekeeping is
1784 required. Default is false. See linkgit:git-commit-graph[1]
1785 for details.
1786
a831c06a
DT
1787gc.logExpiry::
1788 If the file gc.log exists, then `git gc --auto` won't run
1789 unless that file is more than 'gc.logExpiry' old. Default is
1790 "1.day". See `gc.pruneExpire` for more ways to specify its
1791 value.
1792
da0005b8 1793gc.packRefs::
efc266e8
JN
1794 Running `git pack-refs` in a repository renders it
1795 unclonable by Git versions prior to 1.5.1.2 over dumb
1796 transports such as HTTP. This variable determines whether
4be0c352 1797 'git gc' runs `git pack-refs`. This can be set to `notbare`
efc266e8
JN
1798 to enable it within all non-bare repos or it can be set to a
1799 boolean value. The default is `true`.
c2120e5e 1800
da0005b8 1801gc.pruneExpire::
0b444cdb 1802 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33 1803 Override the grace period with this config variable. The value
8cc88166
ES
1804 "now" may be used to disable this grace period and always prune
1805 unreachable objects immediately, or "never" may be used to
f1350d0c
MM
1806 suppress pruning. This feature helps prevent corruption when
1807 'git gc' runs concurrently with another process writing to the
1808 repository; see the "NOTES" section of linkgit:git-gc[1].
25ee9731 1809
114ff888 1810gc.worktreePruneExpire::
b07244f4 1811 When 'git gc' is run, it calls
fe819b4b 1812 'git worktree prune --expire 3.months.ago'.
b07244f4
MH
1813 This config variable can be used to set a different grace
1814 period. The value "now" may be used to disable the grace
f212dcc7 1815 period and prune `$GIT_DIR/worktrees` immediately, or "never"
8cc88166 1816 may be used to suppress pruning.
e3df33bb 1817
da0005b8
NTND
1818gc.reflogExpire::
1819gc.<pattern>.reflogExpire::
0b444cdb 1820 'git reflog expire' removes reflog entries older than
8cc88166
ES
1821 this time; defaults to 90 days. The value "now" expires all
1822 entries immediately, and "never" suppresses expiration
1823 altogether. With "<pattern>" (e.g.
eb523a8d
JH
1824 "refs/stash") in the middle the setting applies only to
1825 the refs that match the <pattern>.
4aec56d1 1826
da0005b8 1827gc.reflogExpireUnreachable::
f04c6904 1828gc.<pattern>.reflogExpireUnreachable::
0b444cdb 1829 'git reflog expire' removes reflog entries older than
4aec56d1 1830 this time and are not reachable from the current tip;
8cc88166
ES
1831 defaults to 30 days. The value "now" expires all entries
1832 immediately, and "never" suppresses expiration altogether.
1833 With "<pattern>" (e.g. "refs/stash")
eb523a8d
JH
1834 in the middle, the setting applies only to the refs that
1835 match the <pattern>.
4aec56d1 1836
da0005b8 1837gc.rerereResolved::
48c32424 1838 Records of conflicted merge you resolved earlier are
0b444cdb 1839 kept for this many days when 'git rerere gc' is run.
6e96cb52 1840 You can also use more human-readable "1.month.ago", etc.
5162e697 1841 The default is 60 days. See linkgit:git-rerere[1].
48c32424 1842
da0005b8 1843gc.rerereUnresolved::
48c32424 1844 Records of conflicted merge you have not resolved are
0b444cdb 1845 kept for this many days when 'git rerere gc' is run.
6e96cb52 1846 You can also use more human-readable "1.month.ago", etc.
5162e697 1847 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1848
da0005b8 1849gitcvs.commitMsgAnnotation::
280514e1
FE
1850 Append this string to each commit message. Set to empty string
1851 to disable this feature. Defaults to "via git-CVS emulator".
1852
1ab661dd 1853gitcvs.enabled::
db218723 1854 Whether the CVS server interface is enabled for this repository.
5162e697 1855 See linkgit:git-cvsserver[1].
1ab661dd 1856
da0005b8 1857gitcvs.logFile::
db218723 1858 Path to a log file where the CVS server interface well... logs
5162e697 1859 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1860
1707adb7 1861gitcvs.usecrlfattr::
5ec3e670 1862 If true, the server will look up the end-of-line conversion
23f8239b 1863 attributes for files to determine the `-k` modes to use. If
2de9b711 1864 the attributes force Git to treat a file as text,
23f8239b 1865 the `-k` mode will be left blank so CVS clients will
5ec3e670 1866 treat it as text. If they suppress text conversion, the file
1168d402 1867 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670 1868 the client might otherwise do. If the attributes do not allow
ae9f6311 1869 the file type to be determined, then `gitcvs.allBinary` is
5ec3e670 1870 used. See linkgit:gitattributes[5].
8a06a632 1871
da0005b8 1872gitcvs.allBinary::
ae9f6311 1873 This is used if `gitcvs.usecrlfattr` does not resolve
90948a42
MO
1874 the correct '-kb' mode to use. If true, all
1875 unresolved files are sent to the client in
1876 mode '-kb'. This causes the client to treat them
1877 as binary files, which suppresses any newline munging it
1878 otherwise might do. Alternatively, if it is set to "guess",
1879 then the contents of the file are examined to decide if
ae9f6311 1880 it is binary, similar to `core.autocrlf`.
abbf5947 1881
da0005b8 1882gitcvs.dbName::
04752868 1883 Database used by git-cvsserver to cache revision information
2de9b711 1884 derived from the Git repository. The exact meaning depends on the
04752868
FL
1885 used database driver, for SQLite (which is the default driver) this
1886 is a filename. Supports variable substitution (see
5162e697 1887 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1888 Default: '%Ggitcvs.%m.sqlite'
1889
da0005b8 1890gitcvs.dbDriver::
04752868 1891 Used Perl DBI driver. You can specify any available driver
240ae2b8 1892 for this here, but it might not work. git-cvsserver is tested
04752868
FL
1893 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1894 reported *not* to work with 'DBD::mysql'. Experimental feature.
1895 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1896 See linkgit:git-cvsserver[1].
eabb0bfd 1897
da0005b8 1898gitcvs.dbUser, gitcvs.dbPass::
ae9f6311 1899 Database user and password. Only useful if setting `gitcvs.dbDriver`,
04752868 1900 since SQLite has no concept of database users and/or passwords.
da0005b8 1901 'gitcvs.dbUser' supports variable substitution (see
5162e697 1902 linkgit:git-cvsserver[1] for details).
04752868 1903
6aeeffd1
JE
1904gitcvs.dbTableNamePrefix::
1905 Database table name prefix. Prepended to the names of any
1906 database tables used, allowing a single database to be used
1907 for several repositories. Supports variable substitution (see
1908 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1909 characters will be replaced with underscores.
1910
ae9f6311
TR
1911All gitcvs variables except for `gitcvs.usecrlfattr` and
1912`gitcvs.allBinary` can also be specified as
8a06a632 1913'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1914is one of "ext" and "pserver") to make them apply only for the given
1915access method.
04752868 1916
cd82323f
JN
1917gitweb.category::
1918gitweb.description::
1919gitweb.owner::
1920gitweb.url::
1921 See linkgit:gitweb[1] for description.
1922
1923gitweb.avatar::
1924gitweb.blame::
1925gitweb.grep::
1926gitweb.highlight::
1927gitweb.patches::
1928gitweb.pickaxe::
1929gitweb.remote_heads::
da0005b8 1930gitweb.showSizes::
cd82323f
JN
1931gitweb.snapshot::
1932 See linkgit:gitweb.conf[5] for description.
1933
b22520a3 1934grep.lineNumber::
23f8239b 1935 If set to true, enable `-n` option by default.
b22520a3 1936
6653fec3
TB
1937grep.column::
1938 If set to true, enable the `--column` option by default.
1939
84befcd0
S
1940grep.patternType::
1941 Set the default matching behavior. Using a value of 'basic', 'extended',
bcf9626a
MM
1942 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1943 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
84befcd0
S
1944 value 'default' will return to the default matching behavior.
1945
b22520a3 1946grep.extendedRegexp::
bcf9626a 1947 If set to true, enable `--extended-regexp` option by default. This
ae9f6311 1948 option is ignored when the `grep.patternType` option is set to a value
84befcd0 1949 other than 'default'.
b22520a3 1950
89f09dd3
VL
1951grep.threads::
1952 Number of grep worker threads to use.
1953 See `grep.threads` in linkgit:git-grep[1] for more information.
1954
ecd9ba61
TG
1955grep.fallbackToNoIndex::
1956 If set to true, fall back to git grep --no-index if git grep
1957 is executed outside of a git repository. Defaults to false.
1958
0c5e70f0 1959gpg.program::
f212dcc7 1960 Use this custom program instead of "`gpg`" found on `$PATH` when
0c5e70f0 1961 making or verifying a PGP signature. The program must support the
06ab60c0 1962 same command-line interface as GPG, namely, to verify a detached
f212dcc7 1963 signature, "`gpg --verify $file - <$signature`" is run, and the
0c5e70f0 1964 program is expected to signal a good signature by exiting with
f745acb0 1965 code 0, and to generate an ASCII-armored detached signature, the
f212dcc7 1966 standard input of "`gpg -bsau $key`" is fed with the contents to be
0c5e70f0
JH
1967 signed, and the program is expected to send the result to its
1968 standard output.
1969
57a8dd75
HS
1970gpg.format::
1971 Specifies which key format to use when signing with `--gpg-sign`.
1e7adb97 1972 Default is "openpgp" and another possible value is "x509".
57a8dd75 1973
b02f51b1
HS
1974gpg.<format>.program::
1975 Use this to customize the program used for the signing format you
1976 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1e7adb97
HS
1977 be used as a legacy synonym for `gpg.openpgp.program`. The default
1978 value for `gpg.x509.program` is "gpgsm".
b02f51b1 1979
da0005b8 1980gui.commitMsgWidth::
d84ae0db
GH
1981 Defines how wide the commit message window is in the
1982 linkgit:git-gui[1]. "75" is the default.
1983
da0005b8 1984gui.diffContext::
d84ae0db
GH
1985 Specifies how many context lines should be used in calls to diff
1986 made by the linkgit:git-gui[1]. The default is "5".
1987
da0005b8 1988gui.displayUntracked::
1cca17df 1989 Determines if linkgit:git-gui[1] shows untracked files
ec9fa62a
MK
1990 in the file list. The default is "true".
1991
a2df1fb2
AG
1992gui.encoding::
1993 Specifies the default encoding to use for displaying of
1994 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1995 It can be overridden by setting the 'encoding' attribute
1996 for relevant files (see linkgit:gitattributes[5]).
1997 If this option is not set, the tools default to the
1998 locale encoding.
1999
da0005b8 2000gui.matchTrackingBranch::
d84ae0db
GH
2001 Determines if new branches created with linkgit:git-gui[1] should
2002 default to tracking remote branches with matching names or
2003 not. Default: "false".
2004
da0005b8 2005gui.newBranchTemplate::
d84ae0db
GH
2006 Is used as suggested name when creating new branches using the
2007 linkgit:git-gui[1].
2008
da0005b8 2009gui.pruneDuringFetch::
8b3f3f84 2010 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
2011 performing a fetch. The default value is "false".
2012
2013gui.trustmtime::
2014 Determines if linkgit:git-gui[1] should trust the file modification
2015 timestamp or not. By default the timestamps are not trusted.
2016
da0005b8 2017gui.spellingDictionary::
d84ae0db
GH
2018 Specifies the dictionary used for spell checking commit messages in
2019 the linkgit:git-gui[1]. When set to "none" spell checking is turned
2020 off.
2021
da0005b8 2022gui.fastCopyBlame::
ca768288 2023 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
2024 location detection. It makes blame significantly faster on huge
2025 repositories at the expense of less thorough copy detection.
2026
da0005b8 2027gui.copyBlameThreshold::
76bac890 2028 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
2029 detection, measured in alphanumeric characters. See the
2030 linkgit:git-blame[1] manual for more information on copy detection.
2031
2032gui.blamehistoryctx::
2033 Specifies the radius of history context in days to show in
2034 linkgit:gitk[1] for the selected commit, when the `Show History
2035 Context` menu item is invoked from 'git gui blame'. If this
2036 variable is set to zero, the whole history is shown.
2037
390c3480
AG
2038guitool.<name>.cmd::
2039 Specifies the shell command line to execute when the corresponding item
2040 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
2041 mandatory for every tool. The command is executed from the root of
2042 the working directory, and in the environment it receives the name of
eee7f4a2 2043 the tool as `GIT_GUITOOL`, the name of the currently selected file as
390c3480
AG
2044 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
2045 the head is detached, 'CUR_BRANCH' is empty).
2046
da0005b8 2047guitool.<name>.needsFile::
390c3480
AG
2048 Run the tool only if a diff is selected in the GUI. It guarantees
2049 that 'FILENAME' is not empty.
2050
da0005b8 2051guitool.<name>.noConsole::
390c3480
AG
2052 Run the command silently, without creating a window to display its
2053 output.
2054
da0005b8 2055guitool.<name>.noRescan::
390c3480
AG
2056 Don't rescan the working directory for changes after the tool
2057 finishes execution.
2058
2059guitool.<name>.confirm::
2060 Show a confirmation dialog before actually running the tool.
2061
da0005b8 2062guitool.<name>.argPrompt::
390c3480 2063 Request a string argument from the user, and pass it to the tool
47d81b5c 2064 through the `ARGS` environment variable. Since requesting an
390c3480
AG
2065 argument implies confirmation, the 'confirm' option has no effect
2066 if this is enabled. If the option is set to 'true', 'yes', or '1',
2067 the dialog uses a built-in generic prompt; otherwise the exact
2068 value of the variable is used.
2069
da0005b8 2070guitool.<name>.revPrompt::
390c3480 2071 Request a single valid revision from the user, and set the
47d81b5c 2072 `REVISION` environment variable. In other aspects this option
da0005b8 2073 is similar to 'argPrompt', and can be used together with it.
390c3480 2074
da0005b8
NTND
2075guitool.<name>.revUnmerged::
2076 Show only unmerged branches in the 'revPrompt' subdialog.
390c3480
AG
2077 This is useful for tools similar to merge or rebase, but not
2078 for things like checkout or reset.
2079
2080guitool.<name>.title::
2081 Specifies the title to use for the prompt dialog. The default
2082 is the tool name.
2083
2084guitool.<name>.prompt::
2085 Specifies the general prompt string to display at the top of
da0005b8 2086 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
390c3480
AG
2087 The default value includes the actual command.
2088
983a9eeb
CC
2089help.browser::
2090 Specify the browser that will be used to display help in the
2091 'web' format. See linkgit:git-help[1].
2092
2093help.format::
2094 Override the default help format used by linkgit:git-help[1].
2095 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2096 the default. 'web' and 'html' are the same.
2097
da0005b8 2098help.autoCorrect::
f0e90716
AR
2099 Automatically correct and execute mistyped commands after
2100 waiting for the given number of deciseconds (0.1 sec). If more
2101 than one command can be deduced from the entered text, nothing
2102 will be executed. If the value of this option is negative,
2103 the corrected command will be executed immediately. If the
2104 value is 0 - the command will be just shown but not executed.
2105 This is the default.
2106
da0005b8 2107help.htmlPath::
b1f809d0
SS
2108 Specify the path where the HTML documentation resides. File system paths
2109 and URLs are supported. HTML pages will be prefixed with this path when
2110 help is displayed in the 'web' format. This defaults to the documentation
2111 path of your Git installation.
2112
9c5665aa 2113http.proxy::
b2c8c6d9 2114 Override the HTTP proxy, normally configured using the 'http_proxy',
372370f1
KF
2115 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2116 addition to the syntax understood by curl, it is possible to specify a
2117 proxy string with a user name but no password, in which case git will
2118 attempt to acquire one in the same way it does for other credentials. See
2119 linkgit:gitcredentials[7] for more information. The syntax thus is
2120 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2121 on a per-remote basis; see remote.<name>.proxy
9c5665aa 2122
ef976395
KF
2123http.proxyAuthMethod::
2124 Set the method with which to authenticate against the HTTP proxy. This
2125 only takes effect if the configured proxy string contains a user name part
2126 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2127 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
eee7f4a2 2128 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
ef976395
KF
2129 variable. Possible values are:
2130+
2131--
2132* `anyauth` - Automatically pick a suitable authentication method. It is
2133 assumed that the proxy answers an unauthenticated request with a 407
2134 status code and one or more Proxy-authenticate headers with supported
2135 authentication methods. This is the default.
2136* `basic` - HTTP Basic authentication
2137* `digest` - HTTP Digest authentication; this prevents the password from being
2138 transmitted to the proxy in clear text
2139* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2140 of `curl(1)`)
2141* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2142--
9c5665aa 2143
121061f6 2144http.emptyAuth::
2145 Attempt authentication without seeking a username or password. This
2146 can be used to attempt GSS-Negotiate authentication without specifying
2147 a username in the URL, as libcurl normally requires a username for
2148 authentication.
2149
26a7b234
PS
2150http.delegation::
2151 Control GSSAPI credential delegation. The delegation is disabled
2152 by default in libcurl since version 7.21.7. Set parameter to tell
2153 the server what it is allowed to delegate when it comes to user
2154 credentials. Used with GSS/kerberos. Possible values are:
2155+
2156--
2157* `none` - Don't allow any delegation.
2158* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2159 Kerberos service ticket, which is a matter of realm policy.
2160* `always` - Unconditionally allow the server to delegate.
2161--
2162
2163
8cb01e2f
JS
2164http.extraHeader::
2165 Pass an additional HTTP header when communicating with a server. If
2166 more than one such entry exists, all of them are added as extra
2167 headers. To allow overriding the settings inherited from the system
2168 config, an empty value will reset the extra headers to the empty list.
2169
da0005b8 2170http.cookieFile::
e5a39ad8
BN
2171 The pathname of a file containing previously stored cookie lines,
2172 which should be used
2de9b711 2173 in the Git http session, if they match the server. The file format
bcfb95dd 2174 of the file to read cookies from should be plain HTTP headers or
1cca17df 2175 the Netscape/Mozilla cookie file format (see `curl(1)`).
06ea368b 2176 NOTE that the file specified with http.cookieFile is used only as
912b2acf
DB
2177 input unless http.saveCookies is set.
2178
da0005b8 2179http.saveCookies::
912b2acf 2180 If set, store cookies received during requests to the file specified by
da0005b8 2181 http.cookieFile. Has no effect if http.cookieFile is unset.
bcfb95dd 2182
01861cb7
EP
2183http.sslVersion::
2184 The SSL version to use when negotiating an SSL connection, if you
2185 want to force the default. The available and default version
2186 depend on whether libcurl was built against NSS or OpenSSL and the
2187 particular configuration of the crypto library in use. Internally
2188 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2189 documentation for more details on the format of this option and
2190 for the ssl version supported. Actually the possible values of
2191 this option are:
2192
2193 - sslv2
2194 - sslv3
2195 - tlsv1
2196 - tlsv1.0
2197 - tlsv1.1
2198 - tlsv1.2
d81b651f 2199 - tlsv1.3
01861cb7
EP
2200
2201+
eee7f4a2 2202Can be overridden by the `GIT_SSL_VERSION` environment variable.
01861cb7 2203To force git to use libcurl's default ssl version and ignore any
eee7f4a2 2204explicit http.sslversion option, set `GIT_SSL_VERSION` to the
01861cb7
EP
2205empty string.
2206
f6f2a9e4
LKS
2207http.sslCipherList::
2208 A list of SSL ciphers to use when negotiating an SSL connection.
2209 The available ciphers depend on whether libcurl was built against
2210 NSS or OpenSSL and the particular configuration of the crypto
2211 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2212 option; see the libcurl documentation for more details on the format
2213 of this list.
2214+
eee7f4a2 2215Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
f6f2a9e4 2216To force git to use libcurl's default cipher list and ignore any
eee7f4a2 2217explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
f6f2a9e4
LKS
2218empty string.
2219
1ab661dd
PB
2220http.sslVerify::
2221 Whether to verify the SSL certificate when fetching or pushing
dec366c9
SR
2222 over HTTPS. Defaults to true. Can be overridden by the
2223 `GIT_SSL_NO_VERIFY` environment variable.
1ab661dd
PB
2224
2225http.sslCert::
2226 File containing the SSL certificate when fetching or pushing
eee7f4a2 2227 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1ab661dd
PB
2228 variable.
2229
2230http.sslKey::
2231 File containing the SSL private key when fetching or pushing
eee7f4a2 2232 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1ab661dd
PB
2233 variable.
2234
754ae192 2235http.sslCertPasswordProtected::
2de9b711 2236 Enable Git's password prompt for the SSL certificate. Otherwise
754ae192
ML
2237 OpenSSL will prompt the user, possibly many times, if the
2238 certificate or private key is encrypted. Can be overridden by the
eee7f4a2 2239 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
754ae192 2240
1ab661dd
PB
2241http.sslCAInfo::
2242 File containing the certificates to verify the peer with when
abda1ef5 2243 fetching or pushing over HTTPS. Can be overridden by the
eee7f4a2 2244 `GIT_SSL_CAINFO` environment variable.
1ab661dd
PB
2245
2246http.sslCAPath::
2247 Path containing files with the CA certificates to verify the peer
37425065 2248 with when fetching or pushing over HTTPS. Can be overridden
eee7f4a2 2249 by the `GIT_SSL_CAPATH` environment variable.
1ab661dd 2250
aeff8a61
CE
2251http.pinnedpubkey::
2252 Public key of the https service. It may either be the filename of
2253 a PEM or DER encoded public key file or a string starting with
2254 'sha256//' followed by the base64 encoded sha256 hash of the
2255 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2256 exit with an error if this option is set but not supported by
2257 cURL.
2258
4bc444eb
MV
2259http.sslTry::
2260 Attempt to use AUTH SSL/TLS and encrypted data transfers
2261 when connecting via regular FTP protocol. This might be needed
2262 if the FTP server requires it for security reasons or you wish
2263 to connect securely whenever remote FTP server supports it.
2264 Default is false since it might trigger certificate verification
2265 errors on misconfigured servers.
2266
1ab661dd 2267http.maxRequests::
abda1ef5 2268 How many HTTP requests to launch in parallel. Can be overridden
eee7f4a2 2269 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1ab661dd 2270
ad75ebe5
TRC
2271http.minSessions::
2272 The number of curl sessions (counted across slots) to be kept across
2273 requests. They will not be ended with curl_easy_cleanup() until
2274 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2275 value will be capped at 1. Defaults to 1.
2276
de1a2fdd
SP
2277http.postBuffer::
2278 Maximum size in bytes of the buffer used by smart HTTP
2279 transports when POSTing data to the remote system.
2280 For requests larger than this buffer size, HTTP/1.1 and
2281 Transfer-Encoding: chunked is used to avoid creating a
2282 massive pack file locally. Default is 1 MiB, which is
2283 sufficient for most requests.
2284
1ab661dd
PB
2285http.lowSpeedLimit, http.lowSpeedTime::
2286 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2287 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
eee7f4a2
TR
2288 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2289 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1ab661dd 2290
3ea099d4
SK
2291http.noEPSV::
2292 A boolean which disables using of EPSV ftp command by curl.
befc9c42 2293 This can helpful with some "poor" ftp servers which don't
eee7f4a2 2294 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
3ea099d4
SK
2295 environment variable. Default is false (curl will use EPSV).
2296
da0005b8 2297http.userAgent::
b1d1058c 2298 The HTTP USER_AGENT string presented to an HTTP server. The default
2de9b711 2299 value represents the version of the client Git such as git/1.7.1.
b1d1058c
SO
2300 This option allows you to override this value to a more common value
2301 such as Mozilla/4.0. This may be necessary, for instance, if
2302 connecting through a firewall that restricts HTTP connections to a set
2303 of common USER_AGENT strings (but not including those like git/1.7.1).
eee7f4a2 2304 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
b1d1058c 2305
50d34137
JK
2306http.followRedirects::
2307 Whether git should follow HTTP redirects. If set to `true`, git
2308 will transparently follow any redirect issued by a server it
2309 encounters. If set to `false`, git will treat all redirects as
2310 errors. If set to `initial`, git will follow redirects only for
2311 the initial request to a remote, but not for subsequent
2312 follow-up HTTP requests. Since git uses the redirected URL as
2313 the base for the follow-up requests, this is generally
2314 sufficient. The default is `initial`.
2315
6a56993b 2316http.<url>.*::
f745acb0 2317 Any of the http.* options above can be applied selectively to some URLs.
6a56993b
KM
2318 For a config key to match a URL, each element of the config key is
2319 compared to that of the URL, in the following order:
2320+
2321--
2322. Scheme (e.g., `https` in `https://example.com/`). This field
2323 must match exactly between the config key and the URL.
2324
2325. Host/domain name (e.g., `example.com` in `https://example.com/`).
a272b9e7
PS
2326 This field must match between the config key and the URL. It is
2327 possible to specify a `*` as part of the host name to match all subdomains
2328 at this level. `https://*.example.com/` for example would match
2329 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
6a56993b
KM
2330
2331. Port number (e.g., `8080` in `http://example.com:8080/`).
2332 This field must match exactly between the config key and the URL.
2333 Omitted port numbers are automatically converted to the correct
2334 default for the scheme before matching.
2335
2336. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2337 path field of the config key must match the path field of the URL
2338 either exactly or as a prefix of slash-delimited path elements. This means
2339 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2340 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2341 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2342 key with just path `foo/`).
2343
2344. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2345 the config key has a user name it must match the user name in the
2346 URL exactly. If the config key does not have a user name, that
2347 config key will match a URL with any user name (including none),
2348 but at a lower precedence than a config key with a user name.
2349--
2350+
2351The list above is ordered by decreasing precedence; a URL that matches
2352a config key's path is preferred to one that matches its user name. For example,
2353if the URL is `https://user@example.com/foo/bar` a config key match of
2354`https://example.com/foo` will be preferred over a config key match of
2355`https://user@example.com`.
2356+
2357All URLs are normalized before attempting any matching (the password part,
2358if embedded in the URL, is always ignored for matching purposes) so that
f745acb0
TA
2359equivalent URLs that are simply spelled differently will match properly.
2360Environment variable settings always override any matches. The URLs that are
6a56993b
KM
2361matched against are those given directly to Git commands. This means any URLs
2362visited as a result of a redirection do not participate in matching.
2363
dd33e077 2364ssh.variant::
0da0e49b
JN
2365 By default, Git determines the command line arguments to use
2366 based on the basename of the configured SSH command (configured
2367 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2368 the config setting `core.sshCommand`). If the basename is
2369 unrecognized, Git will attempt to detect support of OpenSSH
2370 options by first invoking the configured SSH command with the
2371 `-G` (print configuration) option and will subsequently use
2372 OpenSSH options (if that is successful) or no options besides
2373 the host and remote command (if it fails).
2374+
2375The config variable `ssh.variant` can be set to override this detection.
2376Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2377`tortoiseplink`, `simple` (no options except the host and remote command).
2378The default auto-detection can be explicitly requested using the value
2379`auto`. Any other value is treated as `ssh`. This setting can also be
2380overridden via the environment variable `GIT_SSH_VARIANT`.
94b8ae5a
BW
2381+
2382The current command-line parameters used for each variant are as
2383follows:
2384+
2385--
2386
2387* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2388
2389* `simple` - [username@]host command
2390
2391* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2392
2393* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2394
2395--
2396+
2397Except for the `simple` variant, command-line parameters are likely to
2398change as git gains new features.
dd33e077 2399
1ab661dd 2400i18n.commitEncoding::
2de9b711 2401 Character encoding the commit messages are stored in; Git itself
1ab661dd
PB
2402 does not care per se, but this information is necessary e.g. when
2403 importing commits from emails or in the gitk graphical history
2404 browser (and possibly at other places in the future or in other
5162e697 2405 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 2406
d2c11a38
JH
2407i18n.logOutputEncoding::
2408 Character encoding the commit messages are converted to when
0b444cdb 2409 running 'git log' and friends.
d2c11a38 2410
b0f34c3d
MM
2411imap::
2412 The configuration variables in the 'imap' section are described
2413 in linkgit:git-imap-send[1].
2414
3c09d684
TG
2415index.version::
2416 Specify the version with which new index files should be
2417 initialized. This does not affect existing repositories.
2418
da0005b8 2419init.templateDir::
d8a8488d
SD
2420 Specify the directory from which templates will be copied.
2421 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2422
983a9eeb
CC
2423instaweb.browser::
2424 Specify the program that will be used to browse your working
2425 repository in gitweb. See linkgit:git-instaweb[1].
2426
2427instaweb.httpd::
2428 The HTTP daemon command-line to start gitweb on your working
2429 repository. See linkgit:git-instaweb[1].
2430
2431instaweb.local::
2432 If true the web server started by linkgit:git-instaweb[1] will
2433 be bound to the local IP (127.0.0.1).
2434
da0005b8 2435instaweb.modulePath::
6b677a28
VS
2436 The default module path for linkgit:git-instaweb[1] to use
2437 instead of /usr/lib/apache2/modules. Only used if httpd
2438 is Apache.
983a9eeb
CC
2439
2440instaweb.port::
2441 The port number to bind the gitweb httpd to. See
2442 linkgit:git-instaweb[1].
2443
da0005b8 2444interactive.singleKey::
57f6ec02 2445 In interactive commands, allow the user to provide one-letter
ca6ac7f1 2446 input with a single key (i.e., without hitting enter).
6cf378f0 2447 Currently this is used by the `--patch` mode of
e6b57a8a
CI
2448 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2449 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2450 setting is silently ignored if portable keystroke input
8358f1ac 2451 is not available; requires the Perl module Term::ReadKey.
ca6ac7f1 2452
01143847
JK
2453interactive.diffFilter::
2454 When an interactive command (such as `git add --patch`) shows
2455 a colorized diff, git will pipe the diff through the shell
2456 command defined by this configuration variable. The command may
2457 mark up the diff further for human consumption, provided that it
2458 retains a one-to-one correspondence with the lines in the
2459 original diff. Defaults to disabled (no filtering).
2460
0c47695a
JS
2461log.abbrevCommit::
2462 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6cf378f0
JK
2463 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2464 override this option with `--no-abbrev-commit`.
0c47695a 2465
dd0ffd5b 2466log.date::
e860795d
JN
2467 Set the default date-time mode for the 'log' command.
2468 Setting a value for log.date is similar to using 'git log''s
78a84416 2469 `--date` option. See linkgit:git-log[1] for details.
dd0ffd5b 2470
eb734454
SD
2471log.decorate::
2472 Print out the ref names of any commits that are shown by the log
2473 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2474 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2475 specified, the full ref name (including prefix) will be printed.
462cbb41
RJ
2476 If 'auto' is specified, then if the output is going to a terminal,
2477 the ref names are shown as if 'short' were given, otherwise no ref
ce18123c 2478 names are shown. This is the same as the `--decorate` option
462cbb41 2479 of the `git log`.
eb734454 2480
fd8d07ef
EVW
2481log.follow::
2482 If `true`, `git log` will act as if the `--follow` option was used when
2483 a single <path> is given. This has the same limitations as `--follow`,
2484 i.e. it cannot be used to follow multiple files and does not work well
2485 on non-linear history.
2486
73c727d6
NTND
2487log.graphColors::
2488 A list of colors, separated by commas, that can be used to draw
2489 history lines in `git log --graph`.
2490
da0005b8 2491log.showRoot::
0f03ca94
PB
2492 If true, the initial commit will be shown as a big creation event.
2493 This is equivalent to a diff against an empty tree.
5162e697 2494 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
2495 normally hide the root commit will now show it. True by default.
2496
ba4dce78
KM
2497log.showSignature::
2498 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2499 linkgit:git-whatchanged[1] assume `--show-signature`.
2500
e6bb5f78
AP
2501log.mailmap::
2502 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2503 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2504
d5c4b185
MM
2505mailinfo.scissors::
2506 If true, makes linkgit:git-mailinfo[1] (and therefore
2507 linkgit:git-am[1]) act by default as if the --scissors option
2508 was provided on the command-line. When active, this features
2509 removes everything from the message body before a scissors
2510 line (i.e. consisting mainly of ">8", "8<" and "-").
2511
d551a488
MSO
2512mailmap.file::
2513 The location of an augmenting mailmap file. The default
2514 mailmap, located in the root of the repository, is loaded
2515 first, then the mailmap file pointed to by this variable.
2516 The location of the mailmap file may be in a repository
2517 subdirectory, or somewhere outside of the repository itself.
2518 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2519
08610900
JK
2520mailmap.blob::
2521 Like `mailmap.file`, but consider the value as a reference to a
8c473cec
JK
2522 blob in the repository. If both `mailmap.file` and
2523 `mailmap.blob` are given, both are parsed, with entries from
2524 `mailmap.file` taking precedence. In a bare repository, this
2525 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2526 defaults to empty.
08610900 2527
b5578f33 2528man.viewer::
b8322ea8 2529 Specify the programs that may be used to display help in the
b5578f33
CC
2530 'man' format. See linkgit:git-help[1].
2531
0bb64009
CC
2532man.<tool>.cmd::
2533 Specify the command to invoke the specified man viewer. The
2534 specified command is evaluated in shell with the man page
2535 passed as argument. (See linkgit:git-help[1].)
2536
7e8114c0
CC
2537man.<tool>.path::
2538 Override the path for the given tool that may be used to
2539 display help in the 'man' format. See linkgit:git-help[1].
2540
b0f34c3d 2541include::merge-config.txt[]
b5412484 2542
77680caa
JS
2543mergetool.<tool>.path::
2544 Override the path for the given tool. This is useful in case
2545 your tool is not in the PATH.
2546
964473a0
CB
2547mergetool.<tool>.cmd::
2548 Specify the command to invoke the specified merge tool. The
2549 specified command is evaluated in shell with the following
2550 variables available: 'BASE' is the name of a temporary file
2551 containing the common base of the files to be merged, if available;
2552 'LOCAL' is the name of a temporary file containing the contents of
2553 the file on the current branch; 'REMOTE' is the name of a temporary
2554 file containing the contents of the file from the branch being
2555 merged; 'MERGED' contains the name of the file to which the merge
2556 tool should write the results of a successful merge.
2557
2558mergetool.<tool>.trustExitCode::
2559 For a custom merge command, specify whether the exit code of
2560 the merge command can be used to determine whether the merge was
2561 successful. If this is not set to true then the merge target file
2562 timestamp is checked and the merge assumed to have been successful
2563 if the file has been updated, otherwise the user is prompted to
2564 indicate the success of the merge.
2565
b12d0450
DA
2566mergetool.meld.hasOutput::
2567 Older versions of `meld` do not support the `--output` option.
2568 Git will attempt to detect whether `meld` supports `--output`
2569 by inspecting the output of `meld --help`. Configuring
2570 `mergetool.meld.hasOutput` will make Git skip these checks and
2571 use the configured value instead. Setting `mergetool.meld.hasOutput`
2572 to `true` tells Git to unconditionally use the `--output` option,
2573 and `false` avoids using `--output`.
2574
44c36d1c
CB
2575mergetool.keepBackup::
2576 After performing a merge, the original file with conflict markers
2577 can be saved as a file with a `.orig` extension. If this variable
2578 is set to `false` then this file is not preserved. Defaults to
2579 `true` (i.e. keep the backup files).
2580
162eba8b 2581mergetool.keepTemporaries::
2de9b711 2582 When invoking a custom merge tool, Git uses a set of temporary
162eba8b
CB
2583 files to pass to the tool. If the tool returns an error and this
2584 variable is set to `true`, then these temporary files will be
2585 preserved, otherwise they will be removed after the tool has
2586 exited. Defaults to `false`.
2587
8f0cb41d
DA
2588mergetool.writeToTemp::
2589 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2590 conflicting files in the worktree by default. Git will attempt
2591 to use a temporary directory for these files when set `true`.
2592 Defaults to `false`.
2593
682b451f
CB
2594mergetool.prompt::
2595 Prompt before each invocation of the merge resolution program.
2596
d2d68d99
JK
2597notes.mergeStrategy::
2598 Which merge strategy to choose by default when resolving notes
2599 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2600 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2601 section of linkgit:git-notes[1] for more information on each strategy.
2602
4f655e22
JK
2603notes.<name>.mergeStrategy::
2604 Which merge strategy to choose when doing a notes merge into
2605 refs/notes/<name>. This overrides the more general
2606 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2607 linkgit:git-notes[1] for more information on the available strategies.
2608
894a9d33
TR
2609notes.displayRef::
2610 The (fully qualified) refname from which to show notes when
2611 showing commit messages. The value of this variable can be set
2612 to a glob, in which case notes from all matching refs will be
2613 shown. You may also specify this configuration variable
2614 several times. A warning will be issued for refs that do not
2615 exist, but a glob that does not match any refs is silently
2616 ignored.
2617+
2618This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2619environment variable, which must be a colon separated list of refs or
2620globs.
2621+
2622The effective value of "core.notesRef" (possibly overridden by
2623GIT_NOTES_REF) is also implicitly added to the list of refs to be
2624displayed.
2625
6956f858
TR
2626notes.rewrite.<command>::
2627 When rewriting commits with <command> (currently `amend` or
2de9b711 2628 `rebase`) and this variable is set to `true`, Git
6956f858
TR
2629 automatically copies your notes from the original to the
2630 rewritten commit. Defaults to `true`, but see
2631 "notes.rewriteRef" below.
6956f858
TR
2632
2633notes.rewriteMode::
2634 When copying notes during a rewrite (see the
2635 "notes.rewrite.<command>" option), determines what to do if
2636 the target commit already has a note. Must be one of
e48ad1b9
JK
2637 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2638 Defaults to `concatenate`.
6956f858
TR
2639+
2640This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2641environment variable.
2642
2643notes.rewriteRef::
2644 When copying notes during a rewrite, specifies the (fully
2645 qualified) ref whose notes should be copied. The ref may be a
2646 glob, in which case notes in all matching refs will be copied.
2647 You may also specify this configuration several times.
2648+
2649Does not have a default value; you must configure this variable to
2b4aa89c
TR
2650enable note rewriting. Set it to `refs/notes/commits` to enable
2651rewriting for the default commit notes.
cfb88e9a
LAS
2652+
2653This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2654environment variable, which must be a colon separated list of refs or
2655globs.
6956f858 2656
4812a93a 2657pack.window::
5162e697 2658 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
2659 window size is given on the command line. Defaults to 10.
2660
842aaf93 2661pack.depth::
5162e697 2662 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 2663 maximum depth is given on the command line. Defaults to 50.
b5c0cbd8 2664 Maximum value is 4095.
842aaf93 2665
e93b15cd 2666pack.windowMemory::
f4694a8c
RB
2667 The maximum size of memory that is consumed by each thread
2668 in linkgit:git-pack-objects[1] for pack window memory when
2669 no limit is given on the command line. The value can be
2670 suffixed with "k", "m", or "g". When left unconfigured (or
2671 set explicitly to 0), there will be no limit.
e93b15cd 2672
960ccca6
DH
2673pack.compression::
2674 An integer -1..9, indicating the compression level for objects
2675 in a pack file. -1 is the zlib default. 0 means no
2676 compression, and 1..9 are various speed/size tradeoffs, 9 being
2677 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
2678 not set, defaults to -1, the zlib default, which is "a default
2679 compromise between speed and compression (currently equivalent
2680 to level 6)."
89d71f75
JK
2681+
2682Note that changing the compression level will not automatically recompress
2683all existing objects. You can force recompression by passing the -F option
2684to linkgit:git-repack[1].
960ccca6 2685
074b2eea 2686pack.deltaCacheSize::
02783075 2687 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
2688 linkgit:git-pack-objects[1] before writing them out to a pack.
2689 This cache is used to speed up the writing object phase by not
2690 having to recompute the final delta result once the best match
2691 for all objects is found. Repacking large repositories on machines
2692 which are tight with memory might be badly impacted by this though,
2693 especially if this cache pushes the system into swapping.
2694 A value of 0 means no limit. The smallest size of 1 byte may be
2695 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 2696
e3dfddb3 2697pack.deltaCacheLimit::
693b86ff 2698 The maximum size of a delta, that is cached in
5749b0b2
NP
2699 linkgit:git-pack-objects[1]. This cache is used to speed up the
2700 writing object phase by not having to recompute the final delta
0cb3c142
NTND
2701 result once the best match for all objects is found.
2702 Defaults to 1000. Maximum value is 65535.
e3dfddb3 2703
693b86ff
NP
2704pack.threads::
2705 Specifies the number of threads to spawn when searching for best
5162e697 2706 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
2707 be compiled with pthreads otherwise this option is ignored with a
2708 warning. This is meant to reduce packing time on multiprocessor
2709 machines. The required amount of memory for the delta search window
2710 is however multiplied by the number of threads.
2de9b711 2711 Specifying 0 will cause Git to auto-detect the number of CPU's
833e3df1 2712 and set the number of threads accordingly.
693b86ff 2713
4d00bda2
NP
2714pack.indexVersion::
2715 Specify the default pack index version. Valid values are 1 for
2716 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2717 the new pack index with capabilities for packs larger than 4 GB
2718 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
2719 packs. Version 2 is the default. Note that version 2 is enforced
2720 and this config option ignored whenever the corresponding pack is
2721 larger than 2 GB.
2722+
2de9b711 2723If you have an old Git that does not understand the version 2 `*.idx` file,
0d0bac67 2724cloning or fetching over a non native protocol (e.g. "http")
6cf378f0 2725that will copy both `*.pack` file and corresponding `*.idx` file from the
c0a5e2d4 2726other side may give you a repository that cannot be accessed with your
2de9b711 2727older version of Git. If the `*.pack` file is smaller than 2 GB, however,
c0a5e2d4 2728you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
6cf378f0 2729the `*.idx` file.
4d00bda2 2730
dbdbfec4 2731pack.packSizeLimit::
07cf0f24
NP
2732 The maximum size of a pack. This setting only affects
2733 packing to a file when repacking, i.e. the git:// protocol
6cf378f0 2734 is unaffected. It can be overridden by the `--max-pack-size`
9cea46cd
EW
2735 option of linkgit:git-repack[1]. Reaching this limit results
2736 in the creation of multiple packfiles; which in turn prevents
2737 bitmaps from being created.
2738 The minimum size allowed is limited to 1 MiB.
2739 The default is unlimited.
07cf0f24
NP
2740 Common unit suffixes of 'k', 'm', or 'g' are
2741 supported.
2b84b5a8 2742
6b8fda2d
VM
2743pack.useBitmaps::
2744 When true, git will use pack bitmaps (if available) when packing
2745 to stdout (e.g., during the server side of a fetch). Defaults to
2746 true. You should not generally need to turn this off unless
2747 you are debugging pack bitmaps.
2748
da0005b8 2749pack.writeBitmaps (deprecated)::
71d76cb4 2750 This is a deprecated synonym for `repack.writeBitmaps`.
7cc8f971 2751
ae4f07fb
VM
2752pack.writeBitmapHashCache::
2753 When true, git will include a "hash cache" section in the bitmap
2754 index (if one is written). This cache can be used to feed git's
2755 delta heuristics, potentially leading to better deltas between
2756 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2757 between an older, bitmapped pack and objects that have been
2758 pushed since the last gc). The downside is that it consumes 4
2759 bytes per object of disk space, and that JGit's bitmap
2760 implementation does not understand it, causing it to complain if
2761 Git and JGit are used on the same repository. Defaults to false.
2762
4370c2d6 2763pager.<cmd>::
9bad7233 2764 If the value is boolean, turns on or off pagination of the
2de9b711 2765 output of a particular Git subcommand when writing to a tty.
9bad7233 2766 Otherwise, turns on pagination for the subcommand using the
6cf378f0
JK
2767 pager specified by the value of `pager.<cmd>`. If `--paginate`
2768 or `--no-pager` is specified on the command line, it takes
9bad7233
JK
2769 precedence over this option. To disable pagination for all
2770 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 2771
8028184e
WP
2772pretty.<name>::
2773 Alias for a --pretty= format string, as specified in
2774 linkgit:git-log[1]. Any aliases defined here can be used just
2775 as the built-in pretty formats could. For example,
6cf378f0 2776 running `git config pretty.changelog "format:* %H %s"`
8028184e 2777 would cause the invocation `git log --pretty=changelog`
6cf378f0 2778 to be equivalent to running `git log "--pretty=format:* %H %s"`.
8028184e
WP
2779 Note that an alias with the same name as a built-in format
2780 will be silently ignored.
2781
f1762d77
BW
2782protocol.allow::
2783 If set, provide a user defined default policy for all protocols which
2784 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2785 if unset, known-safe protocols (http, https, git, ssh, file) have a
2786 default policy of `always`, known-dangerous protocols (ext) have a
2787 default policy of `never`, and all other protocols have a default
2788 policy of `user`. Supported policies:
2789+
2790--
2791
2792* `always` - protocol is always able to be used.
2793
2794* `never` - protocol is never able to be used.
2795
2796* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2797 either unset or has a value of 1. This policy should be used when you want a
2798 protocol to be directly usable by the user but don't want it used by commands which
2799 execute clone/fetch/push commands without user input, e.g. recursive
2800 submodule initialization.
2801
2802--
2803
2804protocol.<name>.allow::
2805 Set a policy to be used by protocol `<name>` with clone/fetch/push
2806 commands. See `protocol.allow` above for the available policies.
2807+
2808The protocol names currently used by git are:
2809+
2810--
2811 - `file`: any local file-based path (including `file://` URLs,
2812 or local paths)
2813
2814 - `git`: the anonymous git protocol over a direct TCP
2815 connection (or proxy, if configured)
2816
2817 - `ssh`: git over ssh (including `host:path` syntax,
2818 `ssh://`, etc).
2819
2820 - `http`: git over http, both "smart http" and "dumb http".
2821 Note that this does _not_ include `https`; if you want to configure
2822 both, you must do so individually.
2823
2824 - any external helpers are named by their protocol (e.g., use
2825 `hg` to allow the `git-remote-hg` helper)
2826--
2827
373d70ef
BW
2828protocol.version::
2829 Experimental. If set, clients will attempt to communicate with a
2830 server using the specified protocol version. If unset, no
2831 attempt will be made by the client to communicate using a
2832 particular protocol version, this results in protocol version 0
2833 being used.
2834 Supported versions:
2835+
2836--
2837
2838* `0` - the original wire protocol.
2839
2840* `1` - the original wire protocol with the addition of a version string
2841 in the initial response from the server.
2842
2843--
2844
b814da89
DA
2845pull.ff::
2846 By default, Git does not create an extra merge commit when merging
2847 a commit that is a descendant of the current commit. Instead, the
2848 tip of the current branch is fast-forwarded. When set to `false`,
2849 this variable tells Git to create an extra merge commit in such
2850 a case (equivalent to giving the `--no-ff` option from the command
2851 line). When set to `only`, only such fast-forward merges are
2852 allowed (equivalent to giving the `--ff-only` option from the
eb8dc05c 2853 command line). This setting overrides `merge.ff` when pulling.
b814da89 2854
6b37dff1
ÆAB
2855pull.rebase::
2856 When true, rebase branches on top of the fetched branch, instead
2857 of merging the default branch from the default remote when "git
2858 pull" is run. See "branch.<name>.rebase" for setting this on a
2859 per-branch basis.
66713ef3 2860+
1131ec98
JS
2861When `merges`, pass the `--rebase-merges` option to 'git rebase'
2862so that the local merge commits are included in the rebase (see
2863linkgit:git-rebase[1] for details).
2864+
d2387107
AS
2865When preserve, also pass `--preserve-merges` along to 'git rebase'
2866so that locally committed merge commits will not be flattened
2867by running 'git pull'.
6b37dff1 2868+
f5eb87b9
JS
2869When the value is `interactive`, the rebase is run in interactive mode.
2870+
6b37dff1
ÆAB
2871*NOTE*: this is a possibly dangerous operation; do *not* use
2872it unless you understand the implications (see linkgit:git-rebase[1]
2873for details).
2874
1ab661dd
PB
2875pull.octopus::
2876 The default merge strategy to use when pulling multiple branches
2877 at once.
2878
2879pull.twohead::
2880 The default merge strategy to use when pulling a single branch.
2881
52153747 2882push.default::
87a70e4c
RR
2883 Defines the action `git push` should take if no refspec is
2884 explicitly given. Different values are well-suited for
2885 specific workflows; for instance, in a purely central workflow
2886 (i.e. the fetch source is equal to the push destination),
2887 `upstream` is probably what you want. Possible values are:
52153747 2888+
b1290514 2889--
87a70e4c
RR
2890
2891* `nothing` - do not push anything (error out) unless a refspec is
2892 explicitly given. This is primarily meant for people who want to
2893 avoid mistakes by always being explicit.
2894
2895* `current` - push the current branch to update a branch with the same
2896 name on the receiving end. Works in both central and non-central
2897 workflows.
2898
2899* `upstream` - push the current branch back to the branch whose
2900 changes are usually integrated into the current branch (which is
2901 called `@{upstream}`). This mode only makes sense if you are
2902 pushing to the same repository you would normally pull from
2903 (i.e. central workflow).
2904
e4e016f6
ÆAB
2905* `tracking` - This is a deprecated synonym for `upstream`.
2906
ed2b1829
RR
2907* `simple` - in centralized workflow, work like `upstream` with an
2908 added safety to refuse to push if the upstream branch's name is
2909 different from the local one.
b1290514 2910+
ed2b1829
RR
2911When pushing to a remote that is different from the remote you normally
2912pull from, work as `current`. This is the safest option and is suited
2913for beginners.
b1290514 2914+
009055f3 2915This mode has become the default in Git 2.0.
87a70e4c
RR
2916
2917* `matching` - push all branches having the same name on both ends.
2918 This makes the repository you are pushing to remember the set of
2919 branches that will be pushed out (e.g. if you always push 'maint'
2920 and 'master' there and no other branches, the repository you push
2921 to will have these two branches, and your local 'maint' and
2922 'master' will be pushed there).
2923+
2924To use this mode effectively, you have to make sure _all_ the
2925branches you would push out are ready to be pushed out before
2926running 'git push', as the whole point of this mode is to allow you
2927to push all of the branches in one go. If you usually finish work
2928on only one branch and push out the result, while other branches are
2929unfinished, this mode is not for you. Also this mode is not
2930suitable for pushing into a shared central repository, as other
2931people may add new branches there, or update the tip of existing
2932branches outside your control.
2933+
009055f3
JH
2934This used to be the default, but not since Git 2.0 (`simple` is the
2935new default).
87a70e4c
RR
2936
2937--
52153747 2938
a8bc269f 2939push.followTags::
bcf9626a 2940 If set to true enable `--follow-tags` option by default. You
a8bc269f 2941 may override this configuration at time of push by specifying
bcf9626a 2942 `--no-follow-tags`.
a8bc269f 2943
68c757f2
DB
2944push.gpgSign::
2945 May be set to a boolean value, or the string 'if-asked'. A true
bcf9626a 2946 value causes all pushes to be GPG signed, as if `--signed` is
68c757f2
DB
2947 passed to linkgit:git-push[1]. The string 'if-asked' causes
2948 pushes to be signed if the server supports it, as if
bcf9626a 2949 `--signed=if-asked` is passed to 'git push'. A false value may
68c757f2
DB
2950 override a value from a lower-priority config file. An explicit
2951 command-line flag always overrides this config option.
a8bc269f 2952
d8052750
MP
2953push.pushOption::
2954 When no `--push-option=<option>` argument is given from the
2955 command line, `git push` behaves as if each <value> of
2956 this variable is given as `--push-option=<value>`.
2957+
2958This is a multi-valued variable, and an empty value can be used in a
2959higher priority configuration file (e.g. `.git/config` in a
2960repository) to clear the values inherited from a lower priority
2961configuration files (e.g. `$HOME/.gitconfig`).
2962+
2963--
2964
2965Example:
2966
2967/etc/gitconfig
2968 push.pushoption = a
2969 push.pushoption = b
2970
2971~/.gitconfig
2972 push.pushoption = c
2973
2974repo/.git/config
2975 push.pushoption =
2976 push.pushoption = b
2977
2978This will result in only b (a and c are cleared).
2979
2980--
2981
b33a15b0
MC
2982push.recurseSubmodules::
2983 Make sure all submodule commits used by the revisions to be pushed
2984 are available on a remote-tracking branch. If the value is 'check'
2985 then Git will verify that all submodule commits that changed in the
2986 revisions to be pushed are available on at least one remote of the
2987 submodule. If any commits are missing, the push will be aborted and
2988 exit with non-zero status. If the value is 'on-demand' then all
2989 submodules that changed in the revisions to be pushed will be
2990 pushed. If on-demand was not able to push all necessary revisions
2991 it will also be aborted and exit with non-zero status. If the value
2992 is 'no' then default behavior of ignoring submodules when pushing
2993 is retained. You may override this configuration at time of push by
2994 specifying '--recurse-submodules=check|on-demand|no'.
2995
946a9f20 2996include::rebase-config.txt[]
16cf51c7 2997
da0005b8 2998receive.advertiseAtomic::
04b39f19 2999 By default, git-receive-pack will advertise the atomic push
c714e45f
SB
3000 capability to its clients. If you don't want to advertise this
3001 capability, set this variable to false.
3002
3003receive.advertisePushOptions::
b7b744f2
JT
3004 When set to true, git-receive-pack will advertise the push options
3005 capability to its clients. False by default.
04b39f19 3006
77e3efbf
JH
3007receive.autogc::
3008 By default, git-receive-pack will run "git-gc --auto" after
3009 receiving data from git-push and updating refs. You can stop
3010 it by setting this variable to false.
3011
da0005b8 3012receive.certNonceSeed::
b89363e4
JH
3013 By setting this variable to a string, `git receive-pack`
3014 will accept a `git push --signed` and verifies it by using
3015 a "nonce" protected by HMAC using this string as a secret
3016 key.
3017
da0005b8 3018receive.certNonceSlop::
5732373d
JH
3019 When a `git push --signed` sent a push certificate with a
3020 "nonce" that was issued by a receive-pack serving the same
3021 repository within this many seconds, export the "nonce"
3022 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
3023 hooks (instead of what the receive-pack asked the sending
3024 side to include). This may allow writing checks in
3025 `pre-receive` and `post-receive` a bit easier. Instead of
3026 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
3027 that records by how many seconds the nonce is stale to
3028 decide if they want to accept the certificate, they only
3029 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
3030
b0f34c3d
MM
3031receive.fsckObjects::
3032 If it is set to true, git-receive-pack will check all received
5180dd2e
ÆAB
3033 objects. See `transfer.fsckObjects` for what's checked.
3034 Defaults to false. If not set, the value of
3035 `transfer.fsckObjects` is used instead.
b0f34c3d 3036
4b55b9b4 3037receive.fsck.<msg-id>::
b2558abd
ÆAB
3038 Acts like `fsck.<msg-id>`, but is used by
3039 linkgit:git-receive-pack[1] instead of
3040 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
3041 details.
4b55b9b4 3042
cd94c6f9 3043receive.fsck.skipList::
b2558abd
ÆAB
3044 Acts like `fsck.skipList`, but is used by
3045 linkgit:git-receive-pack[1] instead of
3046 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
3047 details.
cd94c6f9 3048
83558686
JK
3049receive.keepAlive::
3050 After receiving the pack from the client, `receive-pack` may
3051 produce no output (if `--quiet` was specified) while processing
3052 the pack, causing some networks to drop the TCP connection.
3053 With this option set, if `receive-pack` does not transmit
3054 any data in this phase for `receive.keepAlive` seconds, it will
3055 send a short keepalive packet. The default is 5 seconds; set
3056 to 0 to disable keepalives entirely.
3057
b0f34c3d
MM
3058receive.unpackLimit::
3059 If the number of objects received in a push is below this
3060 limit then the objects will be unpacked into loose object
3061 files. However if the number of received objects equals or
3062 exceeds this limit then the received pack will be stored as
3063 a pack, after adding any missing delta bases. Storing the
3064 pack from a push can make the push operation complete faster,
3065 especially on slow filesystems. If not set, the value of
3066 `transfer.unpackLimit` is used instead.
3067
c08db5a2
JK
3068receive.maxInputSize::
3069 If the size of the incoming pack stream is larger than this
3070 limit, then git-receive-pack will error out, instead of
3071 accepting the pack file. If not set or set to 0, then the size
3072 is unlimited.
3073
42fc11c1
JH
3074receive.denyDeletes::
3075 If set to true, git-receive-pack will deny a ref update that deletes
3076 the ref. Use this to prevent such a ref deletion via a push.
3077
662c83ff
TR
3078receive.denyDeleteCurrent::
3079 If set to true, git-receive-pack will deny a ref update that
3080 deletes the currently checked out branch of a non-bare repository.
3081
42fc11c1 3082receive.denyCurrentBranch::
f3838ce1 3083 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
3084 to the currently checked out branch of a non-bare repository.
3085 Such a push is potentially dangerous because it brings the HEAD
3086 out of sync with the index and working tree. If set to "warn",
3087 print a warning of such a push to stderr, but allow the push to
3088 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 3089 message. Defaults to "refuse".
1404bcbb
JS
3090+
3091Another option is "updateInstead" which will update the working
08553319 3092tree if pushing into the current branch. This option is
1404bcbb
JS
3093intended for synchronizing working directories when one side is not easily
3094accessible via interactive ssh (e.g. a live web site, hence the requirement
3095that the working directory be clean). This mode also comes in handy when
3096developing inside a VM to test and fix code on different Operating Systems.
08553319
JH
3097+
3098By default, "updateInstead" will refuse the push if the working tree or
3099the index have any difference from the HEAD, but the `push-to-checkout`
3100hook can be used to customize this. See linkgit:githooks[5].
42fc11c1 3101
b0f34c3d
MM
3102receive.denyNonFastForwards::
3103 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 3104 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
3105 even if that push is forced. This configuration variable is
3106 set when initializing a shared repository.
3107
da0005b8 3108receive.hideRefs::
cc118a65
JK
3109 This variable is the same as `transfer.hideRefs`, but applies
3110 only to `receive-pack` (and so affects pushes, but not fetches).
3111 An attempt to update or delete a hidden ref by `git push` is
3112 rejected.
daebaa78 3113
da0005b8 3114receive.updateServerInfo::
77e3efbf
JH
3115 If set to true, git-receive-pack will run git-update-server-info
3116 after receiving data from git-push and updating refs.
3117
da0005b8 3118receive.shallowUpdate::
0a1bc12b
NTND
3119 If set to true, .git/shallow can be updated when new refs
3120 require new shallow roots. Otherwise those refs are rejected.
3121
da0005b8 3122remote.pushDefault::
224c2171 3123 The remote to push to by default. Overrides
9f765ce6 3124 `branch.<name>.remote` for all branches, and is overridden by
da0005b8 3125 `branch.<name>.pushRemote` for specific branches.
224c2171 3126
0cc6d346 3127remote.<name>.url::
5162e697
DM
3128 The URL of a remote repository. See linkgit:git-fetch[1] or
3129 linkgit:git-push[1].
0cc6d346 3130
20346234
MG
3131remote.<name>.pushurl::
3132 The push URL of a remote repository. See linkgit:git-push[1].
3133
14c98218
SV
3134remote.<name>.proxy::
3135 For remotes that require curl (http, https and ftp), the URL to
3136 the proxy to use for that remote. Set to the empty string to
3137 disable proxying for that remote.
3138
ef976395
KF
3139remote.<name>.proxyAuthMethod::
3140 For remotes that require curl (http, https and ftp), the method to use for
3141 authenticating against the proxy in use (probably set in
3142 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3143
0cc6d346 3144remote.<name>.fetch::
5162e697
DM
3145 The default set of "refspec" for linkgit:git-fetch[1]. See
3146 linkgit:git-fetch[1].
0cc6d346
SB
3147
3148remote.<name>.push::
5162e697
DM
3149 The default set of "refspec" for linkgit:git-push[1]. See
3150 linkgit:git-push[1].
0cc6d346 3151
84bb2dfd
PB
3152remote.<name>.mirror::
3153 If true, pushing to this remote will automatically behave
6cf378f0 3154 as if the `--mirror` option was given on the command line.
84bb2dfd 3155
1918278e
TT
3156remote.<name>.skipDefaultUpdate::
3157 If true, this remote will be skipped by default when updating
7cc91a2f
BG
3158 using linkgit:git-fetch[1] or the `update` subcommand of
3159 linkgit:git-remote[1].
3160
3161remote.<name>.skipFetchAll::
3162 If true, this remote will be skipped by default when updating
3163 using linkgit:git-fetch[1] or the `update` subcommand of
3164 linkgit:git-remote[1].
1918278e 3165
060aafc1 3166remote.<name>.receivepack::
5dee29ac 3167 The default program to execute on the remote side when pushing. See
1c262bb7 3168 option --receive-pack of linkgit:git-push[1].
060aafc1 3169
5dee29ac
UKK
3170remote.<name>.uploadpack::