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