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