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