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