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