push: Provide situational hints for non-fast-forward errors
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
773002a7 5the git command's 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
b7ee2266
SB
11The configuration variables are used by both the git plumbing
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
17variables may appear multiple times.
1ab661dd 18
e136f33b
JN
19Syntax
20~~~~~~
21
1ab661dd 22The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
23ignored. The '#' and ';' characters begin comments to the end of line,
24blank lines are ignored.
25
26The file consists of sections and variables. A section begins with
27the name of the section in square brackets and continues until the next
28section begins. Section names are not case sensitive. Only alphanumeric
dcb11263 29characters, `-` and `.` are allowed in section names. Each variable
773002a7
SB
30must belong to some section, which means that there must be a section
31header before the first setting of a variable.
e136f33b
JN
32
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
773002a7 35in the section header, like in the example below:
e136f33b
JN
36
37--------
38 [section "subsection"]
39
40--------
41
b7ee2266
SB
42Subsection names are case sensitive and can contain any characters except
43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44respectively). Section headers cannot span multiple
e136f33b
JN
45lines. Variables may belong directly to a section or to a given subsection.
46You can have `[section]` if you have `[section "subsection"]`, but you
47don't need to.
48
f7376329
CMN
49There is also a deprecated `[section.subsection]` syntax. With this
50syntax, the subsection name is converted to lower-case and is also
51compared case sensitively. These subsection names follow the same
52restrictions as section names.
e136f33b 53
2ceb639f
NS
54All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
e136f33b
JN
56'name = value'. If there is no equal sign on the line, the entire line
57is taken as 'name' and the variable is recognized as boolean "true".
e0a4aae8
LP
58The variable names are case-insensitive, allow only alphanumeric characters
59and `-`, and must start with an alphabetic character. There can be more
60than one value for a given variable; we say then that the variable is
61multivalued.
e136f33b
JN
62
63Leading and trailing whitespace in a variable value is discarded.
64Internal whitespace within a variable value is retained verbatim.
65
66The values following the equals sign in variable assign are all either
67a string, an integer, or a boolean. Boolean values may be given as yes/no,
18b19e44 681/0, true/false or on/off. Case is not significant in boolean values, when
e136f33b 69converting value to the canonical form using '--bool' type specifier;
0b444cdb 70'git config' will ensure that the output is "true" or "false".
e136f33b
JN
71
72String values may be entirely or partially enclosed in double quotes.
773002a7
SB
73You need to enclose variable values in double quotes if you want to
74preserve leading or trailing whitespace, or if the variable value contains
75comment characters (i.e. it contains '#' or ';').
76Double quote `"` and backslash `\` characters in variable values must
dcb11263 77be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 78
dcb11263
CJ
79The following escape sequences (beside `\"` and `\\`) are recognized:
80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81and `\b` for backspace (BS). No other char escape sequence, nor octal
e136f33b
JN
82char sequences are valid.
83
773002a7 84Variable values ending in a `\` are continued on the next line in the
e136f33b
JN
85customary UNIX fashion.
86
773002a7 87Some variables may require a special value format.
1ab661dd 88
9b25a0b5
JK
89Includes
90~~~~~~~~
91
92You can include one config file from another by setting the special
93`include.path` variable to the name of the file to be included. The
94included file is expanded immediately, as if its contents had been
95found at the location of the include directive. If the value of the
96`include.path` variable is a relative path, the path is considered to be
97relative to the configuration file in which the include directive was
98found. See below for examples.
99
1ab661dd
PB
100Example
101~~~~~~~
102
103 # Core variables
104 [core]
105 ; Don't trust file modes
106 filemode = false
107
108 # Our diff algorithm
109 [diff]
6bb9e51b 110 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
111 renames = true
112
910c00c8
AK
113 [branch "devel"]
114 remote = origin
115 merge = refs/heads/devel
116
e136f33b
JN
117 # Proxy settings
118 [core]
29093c28 119 gitProxy="ssh" for "kernel.org"
e136f33b 120 gitProxy=default-proxy ; for the rest
910c00c8 121
9b25a0b5
JK
122 [include]
123 path = /path/to/foo.inc ; include by absolute path
124 path = foo ; expand "foo" relative to the current file
125
1ab661dd
PB
126Variables
127~~~~~~~~~
128
129Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
130For command-specific variables, you will find a more detailed description
131in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
132porcelain configuration variables in the respective porcelain documentation.
133
75194438 134advice.*::
26e94af0
JH
135 These variables control various optional help messages designed to
136 aid new users. All 'advice.*' variables default to 'true', and you
137 can tell Git that you do not need help by setting these to 'false':
75194438
JK
138+
139--
140 pushNonFastForward::
f25950f3
CT
141 Set this variable to 'false' if you want to disable
142 'pushNonFFCurrent', 'pushNonFFDefault', and
143 'pushNonFFMatching' simultaneously.
144 pushNonFFCurrent::
145 Advice shown when linkgit:git-push[1] fails due to a
146 non-fast-forward update to the current branch.
147 pushNonFFDefault::
148 Advice to set 'push.default' to 'upstream' or 'current'
149 when you ran linkgit:git-push[1] and pushed 'matching
150 refs' by default (i.e. you did not provide an explicit
151 refspec, and no 'push.default' configuration was set)
152 and it resulted in a non-fast-forward error.
153 pushNonFFMatching::
154 Advice shown when you ran linkgit:git-push[1] and pushed
155 'matching refs' explicitly (i.e. you used ':', or
156 specified a refspec that isn't your current branch) and
157 it resulted in a non-fast-forward error.
edf563fb
JK
158 statusHints::
159 Directions on how to stage/unstage/add shown in the
160 output of linkgit:git-status[1] and the template shown
26e94af0 161 when writing commit messages.
4c371f91
MM
162 commitBeforeMerge::
163 Advice shown when linkgit:git-merge[1] refuses to
6b677a28 164 merge to avoid overwriting local changes.
d38a30df
MM
165 resolveConflict::
166 Advices shown by various commands when conflicts
167 prevent the operation from being performed.
b706fcfe
JK
168 implicitIdentity::
169 Advice on how to set your identity configuration when
170 your information is guessed from the system username and
26e94af0 171 domain name.
13be3e31 172 detachedHead::
26e94af0 173 Advice shown when you used linkgit:git-checkout[1] to
13be3e31 174 move to the detach HEAD state, to instruct how to create
26e94af0 175 a local branch after the fact.
75194438
JK
176--
177
1ab661dd
PB
178core.fileMode::
179 If false, the executable bit differences between the index and
f7d650c0 180 the working tree are ignored; useful on broken filesystems like FAT.
7b357240
MO
181 See linkgit:git-update-index[1].
182+
183The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
184will probe and set core.fileMode false if appropriate when the
185repository is created.
1ab661dd 186
adbc0b6b
DP
187core.ignoreCygwinFSTricks::
188 This option is only used by Cygwin implementation of Git. If false,
189 the Cygwin stat() and lstat() functions are used. This may be useful
190 if your repository consists of a few separate directories joined in
191 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
192 whenever it is possible and falls back to Cygwin functions only to
193 handle symbol links. The native mode is more than twice faster than
7faee6b8
ML
194 normal Cygwin l/stat() functions. True by default, unless core.filemode
195 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
196 POSIX emulation is required to support core.filemode.
adbc0b6b 197
7b357240
MO
198core.ignorecase::
199 If true, this option enables various workarounds to enable
200 git to work better on filesystems that are not case sensitive,
201 like FAT. For example, if a directory listing finds
202 "makefile" when git expects "Makefile", git will assume
203 it is really the same file, and continue to remember it as
204 "Makefile".
205+
206The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
207will probe and set core.ignorecase true if appropriate when the repository
208is created.
209
1ce4790b
AR
210core.trustctime::
211 If false, the ctime differences between the index and the
f7d650c0 212 working tree are ignored; useful when the inode change time
1ce4790b
AR
213 is regularly modified by something outside Git (file system
214 crawlers and some backup systems).
215 See linkgit:git-update-index[1]. True by default.
216
9378c161 217core.quotepath::
5833d730
JN
218 The commands that output paths (e.g. 'ls-files',
219 'diff'), when not given the `-z` option, will quote
9378c161
JH
220 "unusual" characters in the pathname by enclosing the
221 pathname in a double-quote pair and with backslashes the
222 same way strings in C source code are quoted. If this
223 variable is set to false, the bytes higher than 0x80 are
224 not quoted but output as verbatim. Note that double
225 quote, backslash and control characters are always
226 quoted without `-z` regardless of the setting of this
227 variable.
228
942e7747
EB
229core.eol::
230 Sets the line ending type to use in the working directory for
231 files that have the `text` property set. Alternatives are
232 'lf', 'crlf' and 'native', which uses the platform's native
233 line ending. The default value is `native`. See
234 linkgit:gitattributes[5] for more information on end-of-line
235 conversion.
5cb71f82 236
21e5ad50 237core.safecrlf::
fd6cce9e
EB
238 If true, makes git check if converting `CRLF` is reversible when
239 end-of-line conversion is active. Git will verify if a command
21e5ad50
SP
240 modifies a file in the work tree either directly or indirectly.
241 For example, committing a file followed by checking out the
242 same file should yield the original file in the work tree. If
243 this is not the case for the current setting of
244 `core.autocrlf`, git will reject the file. The variable can
245 be set to "warn", in which case git will only warn about an
246 irreversible conversion but continue the operation.
247+
248CRLF conversion bears a slight chance of corrupting data.
942e7747 249When it is enabled, git will convert CRLF to LF during commit and LF to
21e5ad50
SP
250CRLF during checkout. A file that contains a mixture of LF and
251CRLF before the commit cannot be recreated by git. For text
252files this is the right thing to do: it corrects line endings
253such that we have only LF line endings in the repository.
254But for binary files that are accidentally classified as text the
255conversion can corrupt data.
256+
257If you recognize such corruption early you can easily fix it by
258setting the conversion type explicitly in .gitattributes. Right
259after committing you still have the original file in your work
260tree and this file is not yet corrupted. You can explicitly tell
261git that this file is binary and git will handle the file
262appropriately.
263+
264Unfortunately, the desired effect of cleaning up text files with
265mixed line endings and the undesired effect of corrupting binary
266files cannot be distinguished. In both cases CRLFs are removed
267in an irreversible way. For text files this is the right thing
268to do because CRLFs are line endings, while for binary files
269converting CRLFs corrupts data.
270+
271Note, this safety check does not mean that a checkout will generate a
272file identical to the original file for a different setting of
942e7747
EB
273`core.eol` and `core.autocrlf`, but only for the current one. For
274example, a text file with `LF` would be accepted with `core.eol=lf`
275and could later be checked out with `core.eol=crlf`, in which case the
21e5ad50
SP
276resulting file would contain `CRLF`, although the original file
277contained `LF`. However, in both work trees the line endings would be
278consistent, that is either all `LF` or all `CRLF`, but never mixed. A
279file with mixed line endings would be reported by the `core.safecrlf`
280mechanism.
281
942e7747
EB
282core.autocrlf::
283 Setting this variable to "true" is almost the same as setting
284 the `text` attribute to "auto" on all files except that text
285 files are not guaranteed to be normalized: files that contain
286 `CRLF` in the repository will not be touched. Use this
287 setting if you want to have `CRLF` line endings in your
288 working directory even though the repository does not have
289 normalized line endings. This variable can be set to 'input',
290 in which case no output conversion is performed.
291
78a8d641
JS
292core.symlinks::
293 If false, symbolic links are checked out as small plain files that
5162e697
DM
294 contain the link text. linkgit:git-update-index[1] and
295 linkgit:git-add[1] will not change the recorded type to regular
78a8d641 296 file. Useful on filesystems like FAT that do not support
7b357240
MO
297 symbolic links.
298+
299The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
300will probe and set core.symlinks false if appropriate when the repository
301is created.
78a8d641 302
1ab661dd
PB
303core.gitProxy::
304 A "proxy command" to execute (as 'command host port') instead
305 of establishing direct connection to the remote server when
306 using the git protocol for fetching. If the variable value is
307 in the "COMMAND for DOMAIN" format, the command is applied only
308 on hostnames ending with the specified domain string. This variable
309 may be set multiple times and is matched in the given order;
310 the first match wins.
b8936cf0
FD
311+
312Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
313(which always applies universally, without the special "for"
314handling).
642d0844
ES
315+
316The special string `none` can be used as the proxy command to
317specify that no proxy be used for a given domain pattern.
318This is useful for excluding servers inside a firewall from
319proxy use, while defaulting to a common proxy for external domains.
1ab661dd
PB
320
321core.ignoreStat::
b7f685a7
MSO
322 If true, commands which modify both the working tree and the index
323 will mark the updated paths with the "assume unchanged" bit in the
324 index. These marked files are then assumed to stay unchanged in the
f7d650c0 325 working tree, until you mark them otherwise manually - Git will not
b7f685a7
MSO
326 detect the file changes by lstat() calls. This is useful on systems
327 where those are very slow, such as Microsoft Windows.
328 See linkgit:git-update-index[1].
1ab661dd
PB
329 False by default.
330
9f0bb90d
JH
331core.preferSymlinkRefs::
332 Instead of the default "symref" format for HEAD
333 and other symbolic reference files, use symbolic links.
334 This is sometimes needed to work with old scripts that
335 expect HEAD to be a symbolic link.
1ab661dd 336
e4a15f40
SP
337core.bare::
338 If true this repository is assumed to be 'bare' and has no
339 working directory associated with it. If this is the case a
340 number of commands that require a working directory will be
5162e697 341 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 342+
5162e697
DM
343This setting is automatically guessed by linkgit:git-clone[1] or
344linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
345repository that ends in "/.git" is assumed to be not bare (bare =
346false), while all other repositories are assumed to be bare (bare
347= true).
348
892c41b9 349core.worktree::
ea472c1e 350 Set the path to the root of the working tree.
06ada152 351 This can be overridden by the GIT_WORK_TREE environment
ea472c1e 352 variable and the '--work-tree' command line option.
d424a47e 353 The value can be an absolute path or relative to the path to
ea472c1e
JH
354 the .git directory, which is either specified by --git-dir
355 or GIT_DIR, or automatically discovered.
356 If --git-dir or GIT_DIR is specified but none of
302cc11a 357 --work-tree, GIT_WORK_TREE and core.worktree is specified,
ea472c1e 358 the current working directory is regarded as the top level
98acf759 359 of your working tree.
ea472c1e
JH
360+
361Note that this variable is honored even when set in a configuration
362file in a ".git" subdirectory of a directory and its value differs
363from the latter directory (e.g. "/path/to/.git/config" has
364core.worktree set to "/different/path"), which is most likely a
365misconfiguration. Running git commands in the "/path/to" directory will
366still use "/different/path" as the root of the work tree and can cause
367confusion unless you know what you are doing (e.g. you are creating a
368read-only snapshot of the same index to a location different from the
369repository's usual working tree).
892c41b9 370
6de08ae6 371core.logAllRefUpdates::
14cd5607 372 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
373 "$GIT_DIR/logs/<ref>", by appending the new and old
374 SHA1, the date/time and the reason of the update, but
375 only when the file exists. If this configuration
376 variable is set to true, missing "$GIT_DIR/logs/<ref>"
cd8e3711
BW
377 file is automatically created for branch heads (i.e. under
378 refs/heads/), remote refs (i.e. under refs/remotes/),
379 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
a862f97e
JH
380+
381This information can be used to determine what commit
382was the tip of a branch "2 days ago".
383+
384This value is true by default in a repository that has
385a working directory associated with it, and false by
386default in a bare repository.
6de08ae6 387
1ab661dd
PB
388core.repositoryFormatVersion::
389 Internal variable identifying the repository format and layout
390 version.
391
392core.sharedRepository::
d5dc6a76
JF
393 When 'group' (or 'true'), the repository is made shareable between
394 several users in a group (making sure all the files and objects are
395 group-writable). When 'all' (or 'world' or 'everybody'), the
396 repository will be readable by all users, additionally to being
397 group-shareable. When 'umask' (or 'false'), git will use permissions
06cbe855
HO
398 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
399 files in the repository will have this mode value. '0xxx' will override
098082fb
JH
400 user's umask value (whereas the other options will only override
401 requested parts of the user's umask value). Examples: '0660' will make
402 the repo read/write-able for the owner and group, but inaccessible to
403 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
06cbe855
HO
404 repository that is group-readable but not group-writable.
405 See linkgit:git-init[1]. False by default.
1ab661dd
PB
406
407core.warnAmbiguousRefs::
408 If true, git will warn you if the ref name you passed it is ambiguous
409 and might match multiple refs in the .git/refs/ tree. True by default.
410
3d3e95af 411core.compression::
960ccca6
DH
412 An integer -1..9, indicating a default compression level.
413 -1 is the zlib default. 0 means no compression,
414 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
415 If set, this provides a default to other compression variables,
416 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
417
418core.loosecompression::
12f6c308 419 An integer -1..9, indicating the compression level for objects that
960ccca6 420 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 421 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 422 slowest. If not set, defaults to core.compression. If that is
de1b2460 423 not set, defaults to 1 (best speed).
12f6c308 424
60bb8b14
SP
425core.packedGitWindowSize::
426 Number of bytes of a pack file to map into memory in a
427 single mapping operation. Larger window sizes may allow
428 your system to process a smaller number of large pack files
429 more quickly. Smaller window sizes will negatively affect
eb92242f 430 performance due to increased calls to the operating system's
60bb8b14 431 memory manager, but may improve performance when accessing
22bac0ea
SP
432 a large number of large pack files.
433+
434Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
435MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
436be reasonable for all users/operating systems. You probably do
437not need to adjust this value.
eb92242f
SP
438+
439Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 440
77ccc5bb
SP
441core.packedGitLimit::
442 Maximum number of bytes to map simultaneously into memory
443 from pack files. If Git needs to access more than this many
444 bytes at once to complete an operation it will unmap existing
445 regions to reclaim virtual address space within the process.
22bac0ea
SP
446+
447Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
448This should be reasonable for all users/operating systems, except on
449the largest projects. You probably do not need to adjust this value.
eb92242f
SP
450+
451Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 452
18bdec11
SP
453core.deltaBaseCacheLimit::
454 Maximum number of bytes to reserve for caching base objects
6b677a28 455 that may be referenced by multiple deltified objects. By storing the
18bdec11
SP
456 entire decompressed base objects in a cache Git is able
457 to avoid unpacking and decompressing frequently used base
458 objects multiple times.
459+
460Default is 16 MiB on all platforms. This should be reasonable
461for all users/operating systems, except on the largest projects.
462You probably do not need to adjust this value.
463+
464Common unit suffixes of 'k', 'm', or 'g' are supported.
465
5eef828b
SP
466core.bigFileThreshold::
467 Files larger than this size are stored deflated, without
468 attempting delta compression. Storing large files without
469 delta compression avoids excessive memory usage, at the
470 slight expense of increased disk usage.
471+
472Default is 512 MiB on all platforms. This should be reasonable
473for most projects as source code and other text files can still
474be delta compressed, but larger binary media files won't be.
475+
476Common unit suffixes of 'k', 'm', or 'g' are supported.
5eef828b 477
e8964a5b 478core.excludesfile::
0ba956d3
JS
479 In addition to '.gitignore' (per-directory) and
480 '.git/info/exclude', git looks into this file for patterns
0f7fb21a
JH
481 of files which are not meant to be tracked. "{tilde}/" is expanded
482 to the value of `$HOME` and "{tilde}user/" to the specified user's
df2a79f4 483 home directory. See linkgit:gitignore[5].
0ba956d3 484
d3e7da89
AK
485core.askpass::
486 Some commands (e.g. svn and http interfaces) that interactively
487 ask for a password can be told to use an external program given
453842c9
KF
488 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
489 environment variable. If not set, fall back to the value of the
490 'SSH_ASKPASS' environment variable or, failing that, a simple password
491 prompt. The external program shall be given a suitable prompt as
492 command line argument and write the password on its STDOUT.
d3e7da89 493
6df42ab9
PO
494core.attributesfile::
495 In addition to '.gitattributes' (per-directory) and
496 '.git/info/attributes', git looks into this file for attributes
497 (see linkgit:gitattributes[5]). Path expansions are made the same
498 way as for `core.excludesfile`.
499
ef0c2abf
AR
500core.editor::
501 Commands such as `commit` and `tag` that lets you edit
02783075 502 messages by launching an editor uses the value of this
ef0c2abf 503 variable when it is set, and the environment variable
b4479f07 504 `GIT_EDITOR` is not set. See linkgit:git-var[1].
ef0c2abf 505
821881d8
PO
506sequence.editor::
507 Text editor used by `git rebase -i` for editing the rebase insn file.
508 The value is meant to be interpreted by the shell when it is used.
509 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
510 When not configured the default commit message editor is used instead.
511
54adf370 512core.pager::
ab54cd6c
JN
513 The command that git will use to paginate output. Can
514 be overridden with the `GIT_PAGER` environment
515 variable. Note that git sets the `LESS` environment
516 variable to `FRSX` if it is unset when it runs the
517 pager. One can change these settings by setting the
fee75457
CF
518 `LESS` variable to some other value. Alternately,
519 these settings can be overridden on a project or
520 global basis by setting the `core.pager` option.
521 Setting `core.pager` has no affect on the `LESS`
522 environment variable behaviour above, so if you want
523 to override git's default settings this way, you need
524 to be explicit. For example, to disable the S option
525 in a backward compatible manner, set `core.pager`
dcb11263 526 to `less -+$LESS -FRX`. This will be passed to the
fee75457 527 shell by git, which will translate the final command to
dcb11263 528 `LESS=FRSX less -+FRSX -FRX`.
54adf370 529
91af7ae5
JH
530core.whitespace::
531 A comma separated list of common whitespace problems to
0b444cdb
TR
532 notice. 'git diff' will use `color.diff.whitespace` to
533 highlight them, and 'git apply --whitespace=error' will
c921cc92
JH
534 consider them as errors. You can prefix `-` to disable
535 any of them (e.g. `-trailing-space`):
91af7ae5 536+
aeb84b05 537* `blank-at-eol` treats trailing whitespaces at the end of the line
91af7ae5
JH
538 as an error (enabled by default).
539* `space-before-tab` treats a space character that appears immediately
540 before a tab character in the initial indent part of the line as an
541 error (enabled by default).
542* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 543 space characters as an error (not enabled by default).
3e3ec2ab
CW
544* `tab-in-indent` treats a tab character in the initial indent part of
545 the line as an error (not enabled by default).
77b15bbd
JH
546* `blank-at-eof` treats blank lines added at the end of file as an error
547 (enabled by default).
aeb84b05
JH
548* `trailing-space` is a short-hand to cover both `blank-at-eol` and
549 `blank-at-eof`.
b2979ff5
JH
550* `cr-at-eol` treats a carriage-return at the end of line as
551 part of the line terminator, i.e. with it, `trailing-space`
552 does not trigger if the character before such a carriage-return
553 is not a whitespace (not enabled by default).
f4b05a49
JS
554* `tabwidth=<n>` tells how many character positions a tab occupies; this
555 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
556 errors. The default tab width is 8. Allowed values are 1 to 63.
91af7ae5 557
aafe9fba
LT
558core.fsyncobjectfiles::
559 This boolean will enable 'fsync()' when writing object files.
560+
561This is a total waste of time and effort on a filesystem that orders
562data writes properly, but can be useful for filesystems that do not use
563journalling (traditional UNIX filesystems) or that only journal metadata
564and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
565
671c9b7e
LT
566core.preloadindex::
567 Enable parallel index preload for operations like 'git diff'
568+
569This can speed up operations like 'git diff' and 'git status' especially
570on filesystems like NFS that have weak caching semantics and thus
571relatively high IO latencies. With this set to 'true', git will do the
572index comparison to the filesystem data in parallel, allowing
573overlapping IO's.
574
348df166
JS
575core.createObject::
576 You can set this to 'link', in which case a hardlink followed by
577 a delete of the source are used to make sure that object creation
578 will not overwrite existing objects.
579+
580On some file system/operating system combinations, this is unreliable.
581Set this config setting to 'rename' there; However, This will remove the
582check that makes sure that existing object files will not get overwritten.
be66a6c4 583
a97a7468
JS
584core.notesRef::
585 When showing commit messages, also show notes which are stored in
9eb3f816
JN
586 the given ref. The ref must be fully qualified. If the given
587 ref does not exist, it is not an error but means that no
588 notes should be printed.
a97a7468 589+
9eb3f816
JN
590This setting defaults to "refs/notes/commits", and it can be overridden by
591the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
a97a7468 592
08aefc9e
NTND
593core.sparseCheckout::
594 Enable "sparse checkout" feature. See section "Sparse checkout" in
595 linkgit:git-read-tree[1] for more information.
596
a71f09fe 597core.abbrev::
dce96489
LT
598 Set the length object names are abbreviated to. If unspecified,
599 many commands abbreviate to 7 hexdigits, which may not be enough
600 for abbreviated object names to stay unique for sufficiently long
601 time.
602
13bd2134 603add.ignore-errors::
6b3020a2 604add.ignoreErrors::
0b444cdb 605 Tells 'git add' to continue adding files when some files cannot be
13bd2134 606 added due to indexing errors. Equivalent to the '--ignore-errors'
6b3020a2
JN
607 option of linkgit:git-add[1]. Older versions of git accept only
608 `add.ignore-errors`, which does not follow the usual naming
609 convention for configuration variables. Newer versions of git
610 honor `add.ignoreErrors` as well.
13bd2134 611
4514ad4f 612alias.*::
5162e697 613 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
614 after defining "alias.last = cat-file commit HEAD", the invocation
615 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
616 confusion and troubles with script usage, aliases that
617 hide existing git commands are ignored. Arguments are split by
618 spaces, the usual shell quoting and escaping is supported.
619 quote pair and a backslash can be used to quote them.
f368f5a6
JH
620+
621If the alias expansion is prefixed with an exclamation point,
622it will be treated as a shell command. For example, defining
623"alias.new = !gitk --all --not ORIG_HEAD", the invocation
624"git new" is equivalent to running the shell command
595b8dbf
SC
625"gitk --all --not ORIG_HEAD". Note that shell commands will be
626executed from the top-level directory of a repository, which may
627not necessarily be the current directory.
7cf16a14
MG
628'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
629from the original current directory. See linkgit:git-rev-parse[1].
dfd42a3c 630
e80d4cbe
SH
631am.keepcr::
632 If true, git-am will call git-mailsplit for patches in mbox format
633 with parameter '--keep-cr'. In this case git-mailsplit will
6b677a28 634 not remove `\r` from lines ending with `\r\n`. Can be overridden
e80d4cbe
SH
635 by giving '--no-keep-cr' from the command line.
636 See linkgit:git-am[1], linkgit:git-mailsplit[1].
637
86c91f91 638apply.ignorewhitespace::
0b444cdb 639 When set to 'change', tells 'git apply' to ignore changes in
86c91f91
GB
640 whitespace, in the same way as the '--ignore-space-change'
641 option.
0b444cdb 642 When set to one of: no, none, never, false tells 'git apply' to
86c91f91
GB
643 respect all whitespace differences.
644 See linkgit:git-apply[1].
645
1ab661dd 646apply.whitespace::
0b444cdb 647 Tells 'git apply' how to handle whitespaces, in the same way
5162e697 648 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 649
9902387d 650branch.autosetupmerge::
add0951a 651 Tells 'git branch' and 'git checkout' to set up new branches
572fc81d
JS
652 so that linkgit:git-pull[1] will appropriately merge from the
653 starting point branch. Note that even if this option is not set,
9902387d 654 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
655 and `--no-track` options. The valid settings are: `false` -- no
656 automatic setup is done; `true` -- automatic setup is done when the
29b9a66f
MM
657 starting point is a remote-tracking branch; `always` --
658 automatic setup is done when the starting point is either a
659 local branch or remote-tracking
572fc81d 660 branch. This option defaults to true.
9902387d 661
c998ae9b 662branch.autosetuprebase::
0b444cdb 663 When a new branch is created with 'git branch' or 'git checkout'
c998ae9b
DS
664 that tracks another branch, this variable tells git to set
665 up pull to rebase instead of merge (see "branch.<name>.rebase").
666 When `never`, rebase is never automatically set to true.
667 When `local`, rebase is set to true for tracked branches of
668 other local branches.
669 When `remote`, rebase is set to true for tracked branches of
29b9a66f 670 remote-tracking branches.
c998ae9b
DS
671 When `always`, rebase will be set to true for all tracking
672 branches.
673 See "branch.autosetupmerge" for details on how to set up a
674 branch to track another branch.
675 This option defaults to never.
676
648ad18f 677branch.<name>.remote::
0b444cdb 678 When in branch <name>, it tells 'git fetch' and 'git push' which
76d3cc50
SB
679 remote to fetch from/push to. It defaults to `origin` if no remote is
680 configured. `origin` is also used if you are not on any branch.
648ad18f 681
5372806a 682branch.<name>.merge::
76d3cc50 683 Defines, together with branch.<name>.remote, the upstream branch
15a147e6 684 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
0b444cdb
TR
685 branch to merge and can also affect 'git push' (see push.default).
686 When in branch <name>, it tells 'git fetch' the default
b888d61c
DB
687 refspec to be marked for merging in FETCH_HEAD. The value is
688 handled like the remote part of a refspec, and must match a
689 ref which is fetched from the remote given by
690 "branch.<name>.remote".
0b444cdb
TR
691 The merge information is used by 'git pull' (which at first calls
692 'git fetch') to lookup the default branch for merging. Without
693 this option, 'git pull' defaults to merge the first refspec fetched.
62b339a5 694 Specify multiple values to get an octopus merge.
0b444cdb 695 If you wish to setup 'git pull' so that it merges into <name> from
9debc324
PB
696 another branch in the local repository, you can point
697 branch.<name>.merge to the desired branch, and use the special setting
698 `.` (a period) for branch.<name>.remote.
5372806a 699
aec7b362
LH
700branch.<name>.mergeoptions::
701 Sets default options for merging into branch <name>. The syntax and
25dcc0d6 702 supported options are the same as those of linkgit:git-merge[1], but
aec7b362
LH
703 option values containing whitespace characters are currently not
704 supported.
705
cd67e4d4
JS
706branch.<name>.rebase::
707 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa 708 instead of merging the default branch from the default remote when
6b37dff1
ÆAB
709 "git pull" is run. See "pull.rebase" for doing this in a non
710 branch-specific manner.
711+
712*NOTE*: this is a possibly dangerous operation; do *not* use
713it unless you understand the implications (see linkgit:git-rebase[1]
714for details).
cd67e4d4 715
1658c614
CC
716browser.<tool>.cmd::
717 Specify the command to invoke the specified browser. The
718 specified command is evaluated in shell with the URLs passed
565e135a 719 as arguments. (See linkgit:git-web{litdd}browse[1].)
1658c614 720
584627b4
CC
721browser.<tool>.path::
722 Override the path for the given tool that may be used to
ab989adf
CC
723 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
724 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 725
2122591b 726clean.requireForce::
562ca192
JH
727 A boolean to make git-clean do nothing unless given -f
728 or -n. Defaults to true.
2122591b 729
f3673988
BG
730color.branch::
731 A boolean to enable/disable color in the output of
5162e697 732 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 733 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
734 only when the output is to a terminal. Defaults to false.
735
736color.branch.<slot>::
737 Use customized color for branch coloration. `<slot>` is one of
738 `current` (the current branch), `local` (a local branch),
8b3f3f84 739 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
740 refs).
741+
742The value for these configuration variables is a list of colors (at most
743two) and attributes (at most one), separated by spaces. The colors
744accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
745`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
746`blink` and `reverse`. The first color given is the foreground; the
747second is the background. The position of the attribute, if any,
748doesn't matter.
f3673988 749
a159ca0c 750color.diff::
6999c540
MG
751 Whether to use ANSI escape sequences to add color to patches.
752 If this is set to `always`, linkgit:git-diff[1],
753 linkgit:git-log[1], and linkgit:git-show[1] will use color
754 for all patches. If it is set to `true` or `auto`, those
755 commands will only use color when output is to the terminal.
756 Defaults to false.
757+
758This does not affect linkgit:git-format-patch[1] nor the
759'git-diff-{asterisk}' plumbing commands. Can be overridden on the
760command line with the `--color[=<when>]` option.
b5376648 761
a159ca0c 762color.diff.<slot>::
4f193f20
MW
763 Use customized color for diff colorization. `<slot>` specifies
764 which part of the patch to use the specified color, and is one
765 of `plain` (context text), `meta` (metainformation), `frag`
89cb73a1
BW
766 (hunk header), 'func' (function in hunk header), `old` (removed lines),
767 `new` (added lines), `commit` (commit headers), or `whitespace`
768 (highlighting whitespace errors). The values of these variables may be
769 specified as in color.branch.<slot>.
b5376648 770
5e11bee6
NR
771color.decorate.<slot>::
772 Use customized color for 'git log --decorate' output. `<slot>` is one
773 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
0e615b25 774 branches, remote-tracking branches, tags, stash and HEAD, respectively.
5e11bee6 775
7e8f59d5
RS
776color.grep::
777 When set to `always`, always highlight matches. When `false` (or
778 `never`), never. When set to `true` or `auto`, use color only
779 when the output is written to the terminal. Defaults to `false`.
780
55f638bd
ML
781color.grep.<slot>::
782 Use customized color for grep colorization. `<slot>` specifies which
783 part of the line to use the specified color, and is one of
784+
785--
00588bb5
ML
786`context`;;
787 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
788`filename`;;
789 filename prefix (when not using `-h`)
00588bb5
ML
790`function`;;
791 function name lines (when using `-p`)
55f638bd
ML
792`linenumber`;;
793 line number prefix (when using `-n`)
794`match`;;
795 matching text
00588bb5
ML
796`selected`;;
797 non-matching text in selected lines
55f638bd
ML
798`separator`;;
799 separators between fields on a line (`:`, `-`, and `=`)
800 and between hunks (`--`)
801--
802+
803The values of these variables may be specified as in color.branch.<slot>.
7e8f59d5 804
b4c61ed6 805color.interactive::
47ee06f1 806 When set to `always`, always use colors for interactive prompts
467c0197 807 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
808 When false (or `never`), never. When set to `true` or `auto`, use
809 colors only when the output is to the terminal. Defaults to false.
810
811color.interactive.<slot>::
0b444cdb 812 Use customized color for 'git add --interactive'
a3019736
TR
813 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
814 four distinct types of normal output from interactive
57f6ec02 815 commands. The values of these variables may be specified as
b4c61ed6
JH
816 in color.branch.<slot>.
817
1d77043b
JH
818color.pager::
819 A boolean to enable/disable colored output when the pager is in
820 use (default is true).
821
ab07ba2a
MH
822color.showbranch::
823 A boolean to enable/disable color in the output of
824 linkgit:git-show-branch[1]. May be set to `always`,
825 `false` (or `never`) or `auto` (or `true`), in which case colors are used
826 only when the output is to a terminal. Defaults to false.
827
1d77043b
JH
828color.status::
829 A boolean to enable/disable color in the output of
5162e697 830 linkgit:git-status[1]. May be set to `always`,
cec99d8c 831 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
832 only when the output is to a terminal. Defaults to false.
833
834color.status.<slot>::
835 Use customized color for status colorization. `<slot>` is
836 one of `header` (the header text of the status message),
82dca848
SP
837 `added` or `updated` (files which are added but not committed),
838 `changed` (files which are changed but not added in the index),
1d282327
AA
839 `untracked` (files which are not tracked by git),
840 `branch` (the current branch), or
950ce2e2
CP
841 `nobranch` (the color the 'no branch' warning is shown in, defaulting
842 to red). The values of these variables may be specified as in
843 color.branch.<slot>.
1d77043b 844
6b2f2d98 845color.ui::
6999c540
MG
846 This variable determines the default value for variables such
847 as `color.diff` and `color.grep` that control the use of color
848 per command family. Its scope will expand as more commands learn
849 configuration to set a default for the `--color` option. Set it
850 to `always` if you want all output not intended for machine
851 consumption to use color, to `true` or `auto` if you want such
852 output to use color when written to the terminal, or to `false` or
853 `never` if you prefer git commands not to use color unless enabled
854 explicitly with some other configuration or the `--color` option.
6b2f2d98 855
88955ed2 856commit.status::
bed575e4
JHI
857 A boolean to enable/disable inclusion of status information in the
858 commit message template when using an editor to prepare the commit
859 message. Defaults to true.
860
b0f34c3d
MM
861commit.template::
862 Specify a file to use as the template for new commit messages.
0f7fb21a 863 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
df2a79f4 864 specified user's home directory.
b0f34c3d 865
a6fc9fd3
JK
866credential.helper::
867 Specify an external helper to be called when a username or
868 password credential is needed; the helper may consult external
869 storage to avoid prompting the user for the credentials. See
870 linkgit:gitcredentials[7] for details.
871
872credential.useHttpPath::
873 When acquiring credentials, consider the "path" component of an http
874 or https URL to be important. Defaults to false. See
875 linkgit:gitcredentials[7] for more information.
876
877credential.username::
878 If no username is set for a network authentication, use this username
879 by default. See credential.<context>.* below, and
880 linkgit:gitcredentials[7].
881
882credential.<url>.*::
883 Any of the credential.* options above can be applied selectively to
884 some credentials. For example "credential.https://example.com.username"
885 would set the default username only for https connections to
886 example.com. See linkgit:gitcredentials[7] for details on how URLs are
887 matched.
888
19299a84 889include::diff-config.txt[]
afcbc8e7
DA
890
891difftool.<tool>.path::
892 Override the path for the given tool. This is useful in case
893 your tool is not in the PATH.
894
895difftool.<tool>.cmd::
896 Specify the command to invoke the specified diff tool.
897 The specified command is evaluated in shell with the following
898 variables available: 'LOCAL' is set to the name of the temporary
899 file containing the contents of the diff pre-image and 'REMOTE'
900 is set to the name of the temporary file containing the contents
901 of the diff post-image.
902
a904392e
DA
903difftool.prompt::
904 Prompt before each invocation of the diff tool.
905
ae3b970a 906diff.wordRegex::
98a4d87b
BSSJ
907 A POSIX Extended Regular Expression used to determine what is a "word"
908 when performing word-by-word difference calculations. Character
909 sequences that match the regular expression are "words", all other
910 characters are *ignorable* whitespace.
911
be254a0e 912fetch.recurseSubmodules::
1fb25502
JL
913 This option can be either set to a boolean value or to 'on-demand'.
914 Setting it to a boolean changes the behavior of fetch and pull to
915 unconditionally recurse into submodules when set to true or to not
916 recurse at all when set to false. When set to 'on-demand' (the default
917 value), fetch and pull will only recurse into a populated submodule
918 when its superproject retrieves a commit that updates the submodule's
919 reference.
be254a0e 920
5e838ea7
JH
921fetch.fsckObjects::
922 If it is set to true, git-fetch-pack will check all fetched
923 objects. It will abort in the case of a malformed object or a
924 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
925 Defaults to false. If not set, the value of `transfer.fsckObjects`
926 is used instead.
5e838ea7 927
af7cf268
JH
928fetch.unpackLimit::
929 If the number of objects fetched over the git native
930 transfer is below this
931 limit, then the objects will be unpacked into loose object
932 files. However if the number of received objects equals or
933 exceeds this limit then the received pack will be stored as
934 a pack, after adding any missing delta bases. Storing the
935 pack from a push can make the push operation complete faster,
80cd9cf9
MB
936 especially on slow filesystems. If not set, the value of
937 `transfer.unpackLimit` is used instead.
af7cf268 938
48d3448d
SB
939format.attach::
940 Enable multipart/mixed attachments as the default for
941 'format-patch'. The value can also be a double quoted string
942 which will enable attachments as the default and set the
943 value as the boundary. See the --attach option in
944 linkgit:git-format-patch[1].
945
49604a4d 946format.numbered::
a567fdcb
BG
947 A boolean which can enable or disable sequence numbers in patch
948 subjects. It defaults to "auto" which enables it only if there
949 is more than one patch. It can be enabled or disabled for all
950 messages by setting it to "true" or "false". See --numbered
951 option in linkgit:git-format-patch[1].
49604a4d 952
1ab661dd
PB
953format.headers::
954 Additional email headers to include in a patch to be submitted
5162e697 955 by mail. See linkgit:git-format-patch[1].
1ab661dd 956
312a30eb 957format.to::
48d3448d 958format.cc::
312a30eb
MV
959 Additional recipients to include in a patch to be submitted
960 by mail. See the --to and --cc options in
961 linkgit:git-format-patch[1].
48d3448d
SB
962
963format.subjectprefix::
964 The default for format-patch is to output files with the '[PATCH]'
965 subject prefix. Use this variable to change that prefix.
966
6622d9c7
SB
967format.signature::
968 The default for format-patch is to output a signature containing
969 the git version number. Use this variable to change that default.
970 Set this variable to the empty string ("") to suppress
971 signature generation.
972
78cb59c8
JS
973format.suffix::
974 The default for format-patch is to output files with the suffix
975 `.patch`. Use this variable to change that suffix (make sure to
976 include the dot if you want it).
1ab661dd 977
94c22a5e
CR
978format.pretty::
979 The default pretty format for log/show/whatchanged command,
980 See linkgit:git-log[1], linkgit:git-show[1],
981 linkgit:git-whatchanged[1].
982
30984ed2 983format.thread::
0b444cdb 984 The default threading style for 'git format-patch'. Can be
578b62bf
JN
985 a boolean value, or `shallow` or `deep`. `shallow` threading
986 makes every mail a reply to the head of the series,
30984ed2
TR
987 where the head is chosen from the cover letter, the
988 `\--in-reply-to`, and the first patch mail, in this order.
fd1ff306 989 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
990 A true boolean value is the same as `shallow`, and a false
991 value disables threading.
992
1d1876e9
HV
993format.signoff::
994 A boolean value which lets you enable the `-s/--signoff` option of
995 format-patch by default. *Note:* Adding the Signed-off-by: line to a
996 patch should be a conscious act and means that you certify you have
997 the rights to submit this work under the same open source license.
998 Please see the 'SubmittingPatches' document for further discussion.
999
26488f59
RR
1000filter.<driver>.clean::
1001 The command which is used to convert the content of a worktree
1002 file to a blob upon checkin. See linkgit:gitattributes[5] for
1003 details.
1004
1005filter.<driver>.smudge::
1006 The command which is used to convert the content of a blob
1007 object to a worktree file upon checkout. See
1008 linkgit:gitattributes[5] for details.
1009
0d7566a5
TT
1010gc.aggressiveWindow::
1011 The window size parameter used in the delta compression
0b444cdb 1012 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 1013 to 250.
0d7566a5 1014
e9831e83
JH
1015gc.auto::
1016 When there are approximately more than this many loose
1017 objects in the repository, `git gc --auto` will pack them.
1018 Some Porcelain commands use this command to perform a
80cd9cf9
MB
1019 light-weight garbage collection from time to time. The
1020 default value is 6700. Setting this to 0 disables it.
e9831e83 1021
17815501
JH
1022gc.autopacklimit::
1023 When there are more than this many packs that are not
1024 marked with `*.keep` file in the repository, `git gc
80cd9cf9 1025 --auto` consolidates them into one larger pack. The
97063974 1026 default value is 50. Setting this to 0 disables it.
17815501 1027
c2120e5e 1028gc.packrefs::
efc266e8
JN
1029 Running `git pack-refs` in a repository renders it
1030 unclonable by Git versions prior to 1.5.1.2 over dumb
1031 transports such as HTTP. This variable determines whether
4be0c352 1032 'git gc' runs `git pack-refs`. This can be set to `notbare`
efc266e8
JN
1033 to enable it within all non-bare repos or it can be set to a
1034 boolean value. The default is `true`.
c2120e5e 1035
25ee9731 1036gc.pruneexpire::
0b444cdb 1037 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33
NP
1038 Override the grace period with this config variable. The value
1039 "now" may be used to disable this grace period and always prune
1040 unreachable objects immediately.
25ee9731 1041
4aec56d1 1042gc.reflogexpire::
eb523a8d 1043gc.<pattern>.reflogexpire::
0b444cdb 1044 'git reflog expire' removes reflog entries older than
eb523a8d
JH
1045 this time; defaults to 90 days. With "<pattern>" (e.g.
1046 "refs/stash") in the middle the setting applies only to
1047 the refs that match the <pattern>.
4aec56d1
JH
1048
1049gc.reflogexpireunreachable::
eb523a8d 1050gc.<ref>.reflogexpireunreachable::
0b444cdb 1051 'git reflog expire' removes reflog entries older than
4aec56d1 1052 this time and are not reachable from the current tip;
eb523a8d
JH
1053 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1054 in the middle, the setting applies only to the refs that
1055 match the <pattern>.
4aec56d1 1056
48c32424
JH
1057gc.rerereresolved::
1058 Records of conflicted merge you resolved earlier are
0b444cdb 1059 kept for this many days when 'git rerere gc' is run.
5162e697 1060 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
1061
1062gc.rerereunresolved::
1063 Records of conflicted merge you have not resolved are
0b444cdb 1064 kept for this many days when 'git rerere gc' is run.
5162e697 1065 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1066
280514e1
FE
1067gitcvs.commitmsgannotation::
1068 Append this string to each commit message. Set to empty string
1069 to disable this feature. Defaults to "via git-CVS emulator".
1070
1ab661dd 1071gitcvs.enabled::
db218723 1072 Whether the CVS server interface is enabled for this repository.
5162e697 1073 See linkgit:git-cvsserver[1].
1ab661dd
PB
1074
1075gitcvs.logfile::
db218723 1076 Path to a log file where the CVS server interface well... logs
5162e697 1077 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1078
1707adb7 1079gitcvs.usecrlfattr::
5ec3e670
EB
1080 If true, the server will look up the end-of-line conversion
1081 attributes for files to determine the '-k' modes to use. If
1082 the attributes force git to treat a file as text,
6b677a28 1083 the '-k' mode will be left blank so CVS clients will
5ec3e670 1084 treat it as text. If they suppress text conversion, the file
1168d402 1085 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670
EB
1086 the client might otherwise do. If the attributes do not allow
1087 the file type to be determined, then 'gitcvs.allbinary' is
1088 used. See linkgit:gitattributes[5].
8a06a632 1089
eabb0bfd 1090gitcvs.allbinary::
90948a42
MO
1091 This is used if 'gitcvs.usecrlfattr' does not resolve
1092 the correct '-kb' mode to use. If true, all
1093 unresolved files are sent to the client in
1094 mode '-kb'. This causes the client to treat them
1095 as binary files, which suppresses any newline munging it
1096 otherwise might do. Alternatively, if it is set to "guess",
1097 then the contents of the file are examined to decide if
1098 it is binary, similar to 'core.autocrlf'.
abbf5947 1099
04752868
FL
1100gitcvs.dbname::
1101 Database used by git-cvsserver to cache revision information
1102 derived from the git repository. The exact meaning depends on the
1103 used database driver, for SQLite (which is the default driver) this
1104 is a filename. Supports variable substitution (see
5162e697 1105 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1106 Default: '%Ggitcvs.%m.sqlite'
1107
1108gitcvs.dbdriver::
1109 Used Perl DBI driver. You can specify any available driver
1110 for this here, but it might not work. git-cvsserver is tested
1111 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1112 reported *not* to work with 'DBD::mysql'. Experimental feature.
1113 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1114 See linkgit:git-cvsserver[1].
eabb0bfd 1115
04752868
FL
1116gitcvs.dbuser, gitcvs.dbpass::
1117 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1118 since SQLite has no concept of database users and/or passwords.
1119 'gitcvs.dbuser' supports variable substitution (see
5162e697 1120 linkgit:git-cvsserver[1] for details).
04752868 1121
6aeeffd1
JE
1122gitcvs.dbTableNamePrefix::
1123 Database table name prefix. Prepended to the names of any
1124 database tables used, allowing a single database to be used
1125 for several repositories. Supports variable substitution (see
1126 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1127 characters will be replaced with underscores.
1128
8a06a632
MO
1129All gitcvs variables except for 'gitcvs.usecrlfattr' and
1130'gitcvs.allbinary' can also be specified as
1131'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1132is one of "ext" and "pserver") to make them apply only for the given
1133access method.
04752868 1134
cd82323f
JN
1135gitweb.category::
1136gitweb.description::
1137gitweb.owner::
1138gitweb.url::
1139 See linkgit:gitweb[1] for description.
1140
1141gitweb.avatar::
1142gitweb.blame::
1143gitweb.grep::
1144gitweb.highlight::
1145gitweb.patches::
1146gitweb.pickaxe::
1147gitweb.remote_heads::
1148gitweb.showsizes::
1149gitweb.snapshot::
1150 See linkgit:gitweb.conf[5] for description.
1151
b22520a3
JR
1152grep.lineNumber::
1153 If set to true, enable '-n' option by default.
1154
1155grep.extendedRegexp::
1156 If set to true, enable '--extended-regexp' option by default.
1157
0c5e70f0
JH
1158gpg.program::
1159 Use this custom program instead of "gpg" found on $PATH when
1160 making or verifying a PGP signature. The program must support the
1161 same command line interface as GPG, namely, to verify a detached
1162 signature, "gpg --verify $file - <$signature" is run, and the
1163 program is expected to signal a good signature by exiting with
1164 code 0, and to generate an ascii-armored detached signature, the
1165 standard input of "gpg -bsau $key" is fed with the contents to be
1166 signed, and the program is expected to send the result to its
1167 standard output.
1168
d84ae0db
GH
1169gui.commitmsgwidth::
1170 Defines how wide the commit message window is in the
1171 linkgit:git-gui[1]. "75" is the default.
1172
1173gui.diffcontext::
1174 Specifies how many context lines should be used in calls to diff
1175 made by the linkgit:git-gui[1]. The default is "5".
1176
a2df1fb2
AG
1177gui.encoding::
1178 Specifies the default encoding to use for displaying of
1179 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1180 It can be overridden by setting the 'encoding' attribute
1181 for relevant files (see linkgit:gitattributes[5]).
1182 If this option is not set, the tools default to the
1183 locale encoding.
1184
d84ae0db
GH
1185gui.matchtrackingbranch::
1186 Determines if new branches created with linkgit:git-gui[1] should
1187 default to tracking remote branches with matching names or
1188 not. Default: "false".
1189
1190gui.newbranchtemplate::
1191 Is used as suggested name when creating new branches using the
1192 linkgit:git-gui[1].
1193
1194gui.pruneduringfetch::
8b3f3f84 1195 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
1196 performing a fetch. The default value is "false".
1197
1198gui.trustmtime::
1199 Determines if linkgit:git-gui[1] should trust the file modification
1200 timestamp or not. By default the timestamps are not trusted.
1201
1202gui.spellingdictionary::
1203 Specifies the dictionary used for spell checking commit messages in
1204 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1205 off.
1206
a2df1fb2 1207gui.fastcopyblame::
ca768288 1208 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
1209 location detection. It makes blame significantly faster on huge
1210 repositories at the expense of less thorough copy detection.
1211
1212gui.copyblamethreshold::
76bac890 1213 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
1214 detection, measured in alphanumeric characters. See the
1215 linkgit:git-blame[1] manual for more information on copy detection.
1216
1217gui.blamehistoryctx::
1218 Specifies the radius of history context in days to show in
1219 linkgit:gitk[1] for the selected commit, when the `Show History
1220 Context` menu item is invoked from 'git gui blame'. If this
1221 variable is set to zero, the whole history is shown.
1222
390c3480
AG
1223guitool.<name>.cmd::
1224 Specifies the shell command line to execute when the corresponding item
1225 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1226 mandatory for every tool. The command is executed from the root of
1227 the working directory, and in the environment it receives the name of
1228 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1229 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1230 the head is detached, 'CUR_BRANCH' is empty).
1231
1232guitool.<name>.needsfile::
1233 Run the tool only if a diff is selected in the GUI. It guarantees
1234 that 'FILENAME' is not empty.
1235
1236guitool.<name>.noconsole::
1237 Run the command silently, without creating a window to display its
1238 output.
1239
1240guitool.<name>.norescan::
1241 Don't rescan the working directory for changes after the tool
1242 finishes execution.
1243
1244guitool.<name>.confirm::
1245 Show a confirmation dialog before actually running the tool.
1246
1247guitool.<name>.argprompt::
1248 Request a string argument from the user, and pass it to the tool
1249 through the 'ARGS' environment variable. Since requesting an
1250 argument implies confirmation, the 'confirm' option has no effect
1251 if this is enabled. If the option is set to 'true', 'yes', or '1',
1252 the dialog uses a built-in generic prompt; otherwise the exact
1253 value of the variable is used.
1254
1255guitool.<name>.revprompt::
1256 Request a single valid revision from the user, and set the
1257 'REVISION' environment variable. In other aspects this option
1258 is similar to 'argprompt', and can be used together with it.
1259
1260guitool.<name>.revunmerged::
1261 Show only unmerged branches in the 'revprompt' subdialog.
1262 This is useful for tools similar to merge or rebase, but not
1263 for things like checkout or reset.
1264
1265guitool.<name>.title::
1266 Specifies the title to use for the prompt dialog. The default
1267 is the tool name.
1268
1269guitool.<name>.prompt::
1270 Specifies the general prompt string to display at the top of
1271 the dialog, before subsections for 'argprompt' and 'revprompt'.
1272 The default value includes the actual command.
1273
983a9eeb
CC
1274help.browser::
1275 Specify the browser that will be used to display help in the
1276 'web' format. See linkgit:git-help[1].
1277
1278help.format::
1279 Override the default help format used by linkgit:git-help[1].
1280 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1281 the default. 'web' and 'html' are the same.
1282
f0e90716
AR
1283help.autocorrect::
1284 Automatically correct and execute mistyped commands after
1285 waiting for the given number of deciseconds (0.1 sec). If more
1286 than one command can be deduced from the entered text, nothing
1287 will be executed. If the value of this option is negative,
1288 the corrected command will be executed immediately. If the
1289 value is 0 - the command will be just shown but not executed.
1290 This is the default.
1291
9c5665aa 1292http.proxy::
b2c8c6d9
CB
1293 Override the HTTP proxy, normally configured using the 'http_proxy',
1294 'https_proxy', and 'all_proxy' environment variables (see
1295 `curl(1)`). This can be overridden on a per-remote basis; see
1296 remote.<name>.proxy
9c5665aa 1297
bcfb95dd
DB
1298http.cookiefile::
1299 File containing previously stored cookie lines which should be used
1300 in the git http session, if they match the server. The file format
1301 of the file to read cookies from should be plain HTTP headers or
1302 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1303 NOTE that the file specified with http.cookiefile is only used as
1304 input. No cookies will be stored in the file.
1305
1ab661dd
PB
1306http.sslVerify::
1307 Whether to verify the SSL certificate when fetching or pushing
37425065 1308 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
1309 variable.
1310
1311http.sslCert::
1312 File containing the SSL certificate when fetching or pushing
37425065 1313 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
1314 variable.
1315
1316http.sslKey::
1317 File containing the SSL private key when fetching or pushing
abda1ef5 1318 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
1319 variable.
1320
754ae192
ML
1321http.sslCertPasswordProtected::
1322 Enable git's password prompt for the SSL certificate. Otherwise
1323 OpenSSL will prompt the user, possibly many times, if the
1324 certificate or private key is encrypted. Can be overridden by the
1325 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1326
1ab661dd
PB
1327http.sslCAInfo::
1328 File containing the certificates to verify the peer with when
abda1ef5 1329 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
1330 'GIT_SSL_CAINFO' environment variable.
1331
1332http.sslCAPath::
1333 Path containing files with the CA certificates to verify the peer
37425065 1334 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
1335 by the 'GIT_SSL_CAPATH' environment variable.
1336
1337http.maxRequests::
abda1ef5 1338 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
1339 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1340
ad75ebe5
TRC
1341http.minSessions::
1342 The number of curl sessions (counted across slots) to be kept across
1343 requests. They will not be ended with curl_easy_cleanup() until
1344 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1345 value will be capped at 1. Defaults to 1.
1346
de1a2fdd
SP
1347http.postBuffer::
1348 Maximum size in bytes of the buffer used by smart HTTP
1349 transports when POSTing data to the remote system.
1350 For requests larger than this buffer size, HTTP/1.1 and
1351 Transfer-Encoding: chunked is used to avoid creating a
1352 massive pack file locally. Default is 1 MiB, which is
1353 sufficient for most requests.
1354
1ab661dd
PB
1355http.lowSpeedLimit, http.lowSpeedTime::
1356 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1357 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 1358 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
1359 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1360
3ea099d4
SK
1361http.noEPSV::
1362 A boolean which disables using of EPSV ftp command by curl.
befc9c42 1363 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
1364 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1365 environment variable. Default is false (curl will use EPSV).
1366
b1d1058c
SO
1367http.useragent::
1368 The HTTP USER_AGENT string presented to an HTTP server. The default
1369 value represents the version of the client git such as git/1.7.1.
1370 This option allows you to override this value to a more common value
1371 such as Mozilla/4.0. This may be necessary, for instance, if
1372 connecting through a firewall that restricts HTTP connections to a set
1373 of common USER_AGENT strings (but not including those like git/1.7.1).
1374 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1375
1ab661dd
PB
1376i18n.commitEncoding::
1377 Character encoding the commit messages are stored in; git itself
1378 does not care per se, but this information is necessary e.g. when
1379 importing commits from emails or in the gitk graphical history
1380 browser (and possibly at other places in the future or in other
5162e697 1381 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 1382
d2c11a38
JH
1383i18n.logOutputEncoding::
1384 Character encoding the commit messages are converted to when
0b444cdb 1385 running 'git log' and friends.
d2c11a38 1386
b0f34c3d
MM
1387imap::
1388 The configuration variables in the 'imap' section are described
1389 in linkgit:git-imap-send[1].
1390
d8a8488d
SD
1391init.templatedir::
1392 Specify the directory from which templates will be copied.
1393 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1394
983a9eeb
CC
1395instaweb.browser::
1396 Specify the program that will be used to browse your working
1397 repository in gitweb. See linkgit:git-instaweb[1].
1398
1399instaweb.httpd::
1400 The HTTP daemon command-line to start gitweb on your working
1401 repository. See linkgit:git-instaweb[1].
1402
1403instaweb.local::
1404 If true the web server started by linkgit:git-instaweb[1] will
1405 be bound to the local IP (127.0.0.1).
1406
1407instaweb.modulepath::
6b677a28
VS
1408 The default module path for linkgit:git-instaweb[1] to use
1409 instead of /usr/lib/apache2/modules. Only used if httpd
1410 is Apache.
983a9eeb
CC
1411
1412instaweb.port::
1413 The port number to bind the gitweb httpd to. See
1414 linkgit:git-instaweb[1].
1415
ca6ac7f1 1416interactive.singlekey::
57f6ec02 1417 In interactive commands, allow the user to provide one-letter
ca6ac7f1 1418 input with a single key (i.e., without hitting enter).
31be5d87 1419 Currently this is used by the `\--patch` mode of
e6b57a8a
CI
1420 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1421 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1422 setting is silently ignored if portable keystroke input
1423 is not available.
ca6ac7f1 1424
0c47695a
JS
1425log.abbrevCommit::
1426 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1427 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1428 override this option with `\--no-abbrev-commit`.
1429
dd0ffd5b 1430log.date::
e860795d
JN
1431 Set the default date-time mode for the 'log' command.
1432 Setting a value for log.date is similar to using 'git log''s
1433 `\--date` option. Possible values are `relative`, `local`,
1434 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1435 for details.
dd0ffd5b 1436
eb734454
SD
1437log.decorate::
1438 Print out the ref names of any commits that are shown by the log
1439 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1440 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1441 specified, the full ref name (including prefix) will be printed.
1442 This is the same as the log commands '--decorate' option.
1443
0f03ca94
PB
1444log.showroot::
1445 If true, the initial commit will be shown as a big creation event.
1446 This is equivalent to a diff against an empty tree.
5162e697 1447 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1448 normally hide the root commit will now show it. True by default.
1449
d551a488
MSO
1450mailmap.file::
1451 The location of an augmenting mailmap file. The default
1452 mailmap, located in the root of the repository, is loaded
1453 first, then the mailmap file pointed to by this variable.
1454 The location of the mailmap file may be in a repository
1455 subdirectory, or somewhere outside of the repository itself.
1456 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1457
b5578f33 1458man.viewer::
b8322ea8 1459 Specify the programs that may be used to display help in the
b5578f33
CC
1460 'man' format. See linkgit:git-help[1].
1461
0bb64009
CC
1462man.<tool>.cmd::
1463 Specify the command to invoke the specified man viewer. The
1464 specified command is evaluated in shell with the man page
1465 passed as argument. (See linkgit:git-help[1].)
1466
7e8114c0
CC
1467man.<tool>.path::
1468 Override the path for the given tool that may be used to
1469 display help in the 'man' format. See linkgit:git-help[1].
1470
b0f34c3d 1471include::merge-config.txt[]
b5412484 1472
77680caa
JS
1473mergetool.<tool>.path::
1474 Override the path for the given tool. This is useful in case
1475 your tool is not in the PATH.
1476
964473a0
CB
1477mergetool.<tool>.cmd::
1478 Specify the command to invoke the specified merge tool. The
1479 specified command is evaluated in shell with the following
1480 variables available: 'BASE' is the name of a temporary file
1481 containing the common base of the files to be merged, if available;
1482 'LOCAL' is the name of a temporary file containing the contents of
1483 the file on the current branch; 'REMOTE' is the name of a temporary
1484 file containing the contents of the file from the branch being
1485 merged; 'MERGED' contains the name of the file to which the merge
1486 tool should write the results of a successful merge.
1487
1488mergetool.<tool>.trustExitCode::
1489 For a custom merge command, specify whether the exit code of
1490 the merge command can be used to determine whether the merge was
1491 successful. If this is not set to true then the merge target file
1492 timestamp is checked and the merge assumed to have been successful
1493 if the file has been updated, otherwise the user is prompted to
1494 indicate the success of the merge.
1495
44c36d1c
CB
1496mergetool.keepBackup::
1497 After performing a merge, the original file with conflict markers
1498 can be saved as a file with a `.orig` extension. If this variable
1499 is set to `false` then this file is not preserved. Defaults to
1500 `true` (i.e. keep the backup files).
1501
162eba8b
CB
1502mergetool.keepTemporaries::
1503 When invoking a custom merge tool, git uses a set of temporary
1504 files to pass to the tool. If the tool returns an error and this
1505 variable is set to `true`, then these temporary files will be
1506 preserved, otherwise they will be removed after the tool has
1507 exited. Defaults to `false`.
1508
682b451f
CB
1509mergetool.prompt::
1510 Prompt before each invocation of the merge resolution program.
1511
894a9d33
TR
1512notes.displayRef::
1513 The (fully qualified) refname from which to show notes when
1514 showing commit messages. The value of this variable can be set
1515 to a glob, in which case notes from all matching refs will be
1516 shown. You may also specify this configuration variable
1517 several times. A warning will be issued for refs that do not
1518 exist, but a glob that does not match any refs is silently
1519 ignored.
1520+
1521This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1522environment variable, which must be a colon separated list of refs or
1523globs.
1524+
1525The effective value of "core.notesRef" (possibly overridden by
1526GIT_NOTES_REF) is also implicitly added to the list of refs to be
1527displayed.
1528
6956f858
TR
1529notes.rewrite.<command>::
1530 When rewriting commits with <command> (currently `amend` or
1531 `rebase`) and this variable is set to `true`, git
1532 automatically copies your notes from the original to the
1533 rewritten commit. Defaults to `true`, but see
1534 "notes.rewriteRef" below.
6956f858
TR
1535
1536notes.rewriteMode::
1537 When copying notes during a rewrite (see the
1538 "notes.rewrite.<command>" option), determines what to do if
1539 the target commit already has a note. Must be one of
1540 `overwrite`, `concatenate`, or `ignore`. Defaults to
1541 `concatenate`.
1542+
1543This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1544environment variable.
1545
1546notes.rewriteRef::
1547 When copying notes during a rewrite, specifies the (fully
1548 qualified) ref whose notes should be copied. The ref may be a
1549 glob, in which case notes in all matching refs will be copied.
1550 You may also specify this configuration several times.
1551+
1552Does not have a default value; you must configure this variable to
2b4aa89c
TR
1553enable note rewriting. Set it to `refs/notes/commits` to enable
1554rewriting for the default commit notes.
cfb88e9a
LAS
1555+
1556This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1557environment variable, which must be a colon separated list of refs or
1558globs.
6956f858 1559
4812a93a 1560pack.window::
5162e697 1561 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
1562 window size is given on the command line. Defaults to 10.
1563
842aaf93 1564pack.depth::
5162e697 1565 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 1566 maximum depth is given on the command line. Defaults to 50.
842aaf93 1567
e93b15cd 1568pack.windowMemory::
5162e697 1569 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
1570 when no limit is given on the command line. The value can be
1571 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1572 limit.
1573
960ccca6
DH
1574pack.compression::
1575 An integer -1..9, indicating the compression level for objects
1576 in a pack file. -1 is the zlib default. 0 means no
1577 compression, and 1..9 are various speed/size tradeoffs, 9 being
1578 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
1579 not set, defaults to -1, the zlib default, which is "a default
1580 compromise between speed and compression (currently equivalent
1581 to level 6)."
89d71f75
JK
1582+
1583Note that changing the compression level will not automatically recompress
1584all existing objects. You can force recompression by passing the -F option
1585to linkgit:git-repack[1].
960ccca6 1586
074b2eea 1587pack.deltaCacheSize::
02783075 1588 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
1589 linkgit:git-pack-objects[1] before writing them out to a pack.
1590 This cache is used to speed up the writing object phase by not
1591 having to recompute the final delta result once the best match
1592 for all objects is found. Repacking large repositories on machines
1593 which are tight with memory might be badly impacted by this though,
1594 especially if this cache pushes the system into swapping.
1595 A value of 0 means no limit. The smallest size of 1 byte may be
1596 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 1597
e3dfddb3 1598pack.deltaCacheLimit::
693b86ff 1599 The maximum size of a delta, that is cached in
5749b0b2
NP
1600 linkgit:git-pack-objects[1]. This cache is used to speed up the
1601 writing object phase by not having to recompute the final delta
1602 result once the best match for all objects is found. Defaults to 1000.
e3dfddb3 1603
693b86ff
NP
1604pack.threads::
1605 Specifies the number of threads to spawn when searching for best
5162e697 1606 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
1607 be compiled with pthreads otherwise this option is ignored with a
1608 warning. This is meant to reduce packing time on multiprocessor
1609 machines. The required amount of memory for the delta search window
1610 is however multiplied by the number of threads.
833e3df1
AE
1611 Specifying 0 will cause git to auto-detect the number of CPU's
1612 and set the number of threads accordingly.
693b86ff 1613
4d00bda2
NP
1614pack.indexVersion::
1615 Specify the default pack index version. Valid values are 1 for
1616 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1617 the new pack index with capabilities for packs larger than 4 GB
1618 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
1619 packs. Version 2 is the default. Note that version 2 is enforced
1620 and this config option ignored whenever the corresponding pack is
1621 larger than 2 GB.
1622+
1623If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1624cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1625that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1626other side may give you a repository that cannot be accessed with your
1627older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1628you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1629the `{asterisk}.idx` file.
4d00bda2 1630
dbdbfec4 1631pack.packSizeLimit::
07cf0f24
NP
1632 The maximum size of a pack. This setting only affects
1633 packing to a file when repacking, i.e. the git:// protocol
1634 is unaffected. It can be overridden by the `\--max-pack-size`
1635 option of linkgit:git-repack[1]. The minimum size allowed is
1636 limited to 1 MiB. The default is unlimited.
1637 Common unit suffixes of 'k', 'm', or 'g' are
1638 supported.
2b84b5a8 1639
4370c2d6 1640pager.<cmd>::
9bad7233
JK
1641 If the value is boolean, turns on or off pagination of the
1642 output of a particular git subcommand when writing to a tty.
1643 Otherwise, turns on pagination for the subcommand using the
1644 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1645 or `\--no-pager` is specified on the command line, it takes
1646 precedence over this option. To disable pagination for all
1647 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 1648
8028184e
WP
1649pretty.<name>::
1650 Alias for a --pretty= format string, as specified in
1651 linkgit:git-log[1]. Any aliases defined here can be used just
1652 as the built-in pretty formats could. For example,
1653 running `git config pretty.changelog "format:{asterisk} %H %s"`
1654 would cause the invocation `git log --pretty=changelog`
1655 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1656 Note that an alias with the same name as a built-in format
1657 will be silently ignored.
1658
6b37dff1
ÆAB
1659pull.rebase::
1660 When true, rebase branches on top of the fetched branch, instead
1661 of merging the default branch from the default remote when "git
1662 pull" is run. See "branch.<name>.rebase" for setting this on a
1663 per-branch basis.
1664+
1665*NOTE*: this is a possibly dangerous operation; do *not* use
1666it unless you understand the implications (see linkgit:git-rebase[1]
1667for details).
1668
1ab661dd
PB
1669pull.octopus::
1670 The default merge strategy to use when pulling multiple branches
1671 at once.
1672
1673pull.twohead::
1674 The default merge strategy to use when pulling a single branch.
1675
52153747
FAG
1676push.default::
1677 Defines the action git push should take if no refspec is given
1678 on the command line, no refspec is configured in the remote, and
1679 no refspec is implied by any of the options given on the command
01eadafc 1680 line. Possible values are:
52153747 1681+
9373bdc4
CF
1682* `nothing` - do not push anything.
1683* `matching` - push all matching branches.
52153747 1684 All branches having the same name in both ends are considered to be
01eadafc 1685 matching. This is the default.
53c40311
JH
1686* `upstream` - push the current branch to its upstream branch.
1687* `tracking` - deprecated synonym for `upstream`.
9373bdc4 1688* `current` - push the current branch to a branch of the same name.
52153747 1689
a9c3821c
TAV
1690rebase.stat::
1691 Whether to show a diffstat of what changed upstream since the last
1692 rebase. False by default.
1693
dd1e5b31
HV
1694rebase.autosquash::
1695 If set to true enable '--autosquash' option by default.
1696
77e3efbf
JH
1697receive.autogc::
1698 By default, git-receive-pack will run "git-gc --auto" after
1699 receiving data from git-push and updating refs. You can stop
1700 it by setting this variable to false.
1701
b0f34c3d
MM
1702receive.fsckObjects::
1703 If it is set to true, git-receive-pack will check all received
1704 objects. It will abort in the case of a malformed object or a
1705 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
1706 Defaults to false. If not set, the value of `transfer.fsckObjects`
1707 is used instead.
b0f34c3d
MM
1708
1709receive.unpackLimit::
1710 If the number of objects received in a push is below this
1711 limit then the objects will be unpacked into loose object
1712 files. However if the number of received objects equals or
1713 exceeds this limit then the received pack will be stored as
1714 a pack, after adding any missing delta bases. Storing the
1715 pack from a push can make the push operation complete faster,
1716 especially on slow filesystems. If not set, the value of
1717 `transfer.unpackLimit` is used instead.
1718
42fc11c1
JH
1719receive.denyDeletes::
1720 If set to true, git-receive-pack will deny a ref update that deletes
1721 the ref. Use this to prevent such a ref deletion via a push.
1722
662c83ff
TR
1723receive.denyDeleteCurrent::
1724 If set to true, git-receive-pack will deny a ref update that
1725 deletes the currently checked out branch of a non-bare repository.
1726
42fc11c1 1727receive.denyCurrentBranch::
f3838ce1 1728 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
1729 to the currently checked out branch of a non-bare repository.
1730 Such a push is potentially dangerous because it brings the HEAD
1731 out of sync with the index and working tree. If set to "warn",
1732 print a warning of such a push to stderr, but allow the push to
1733 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 1734 message. Defaults to "refuse".
42fc11c1 1735
b0f34c3d
MM
1736receive.denyNonFastForwards::
1737 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 1738 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
1739 even if that push is forced. This configuration variable is
1740 set when initializing a shared repository.
1741
77e3efbf
JH
1742receive.updateserverinfo::
1743 If set to true, git-receive-pack will run git-update-server-info
1744 after receiving data from git-push and updating refs.
1745
0cc6d346 1746remote.<name>.url::
5162e697
DM
1747 The URL of a remote repository. See linkgit:git-fetch[1] or
1748 linkgit:git-push[1].
0cc6d346 1749
20346234
MG
1750remote.<name>.pushurl::
1751 The push URL of a remote repository. See linkgit:git-push[1].
1752
14c98218
SV
1753remote.<name>.proxy::
1754 For remotes that require curl (http, https and ftp), the URL to
1755 the proxy to use for that remote. Set to the empty string to
1756 disable proxying for that remote.
1757
0cc6d346 1758remote.<name>.fetch::
5162e697
DM
1759 The default set of "refspec" for linkgit:git-fetch[1]. See
1760 linkgit:git-fetch[1].
0cc6d346
SB
1761
1762remote.<name>.push::
5162e697
DM
1763 The default set of "refspec" for linkgit:git-push[1]. See
1764 linkgit:git-push[1].
0cc6d346 1765
84bb2dfd
PB
1766remote.<name>.mirror::
1767 If true, pushing to this remote will automatically behave
1768 as if the `\--mirror` option was given on the command line.
1769
1918278e
TT
1770remote.<name>.skipDefaultUpdate::
1771 If true, this remote will be skipped by default when updating
7cc91a2f
BG
1772 using linkgit:git-fetch[1] or the `update` subcommand of
1773 linkgit:git-remote[1].
1774
1775remote.<name>.skipFetchAll::
1776 If true, this remote will be skipped by default when updating
1777 using linkgit:git-fetch[1] or the `update` subcommand of
1778 linkgit:git-remote[1].
1918278e 1779
060aafc1 1780remote.<name>.receivepack::
5dee29ac 1781 The default program to execute on the remote side when pushing. See
79f43f3d 1782 option \--receive-pack of linkgit:git-push[1].
060aafc1 1783
5dee29ac
UKK
1784remote.<name>.uploadpack::
1785 The default program to execute on the remote side when fetching. See
79f43f3d 1786 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1787
047f636d 1788remote.<name>.tagopt::
79f43f3d 1789 Setting this value to \--no-tags disables automatic tag following when
944163a4
ST
1790 fetching from remote <name>. Setting it to \--tags will fetch every
1791 tag from remote <name>, even if they are not reachable from remote
ed368546
DJ
1792 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1793 override this setting. See options \--tags and \--no-tags of
1794 linkgit:git-fetch[1].
047f636d 1795
c578f51d
DB
1796remote.<name>.vcs::
1797 Setting this to a value <vcs> will cause git to interact with
1798 the remote with the git-remote-<vcs> helper.
1799
1918278e
TT
1800remotes.<group>::
1801 The list of remotes which are fetched by "git remote update
5162e697 1802 <group>". See linkgit:git-remote[1].
1918278e 1803
b6945f57 1804repack.usedeltabaseoffset::
22c79eab
NP
1805 By default, linkgit:git-repack[1] creates packs that use
1806 delta-base offset. If you need to share your repository with
1807 git older than version 1.4.4, either directly or via a dumb
1808 protocol such as http, then you need to set this option to
1809 "false" and repack. Access from old git versions over the
1810 native protocol are unaffected by this option.
b6945f57 1811
b0f34c3d
MM
1812rerere.autoupdate::
1813 When set to true, `git-rerere` updates the index with the
1814 resulting contents after it cleanly resolves conflicts using
1815 previously recorded resolution. Defaults to false.
1816
1817rerere.enabled::
1818 Activate recording of resolved conflicts, so that identical
07b88a00
TR
1819 conflict hunks can be resolved automatically, should they be
1820 encountered again. By default, linkgit:git-rerere[1] is
1821 enabled if there is an `rr-cache` directory under the
b6fb7fed
JH
1822 `$GIT_DIR`, e.g. if "rerere" was previously used in the
1823 repository.
b0f34c3d 1824
65180c66
YD
1825sendemail.identity::
1826 A configuration identity. When given, causes values in the
1827 'sendemail.<identity>' subsection to take precedence over
1828 values in the 'sendemail' section. The default identity is
1829 the value of 'sendemail.identity'.
1830
1831sendemail.smtpencryption::
1832 See linkgit:git-send-email[1] for description. Note that this
1833 setting is not subject to the 'identity' mechanism.
1834
1835sendemail.smtpssl::
1836 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1837
1838sendemail.<identity>.*::
1839 Identity-specific versions of the 'sendemail.*' parameters
1840 found below, taking precedence over those when the this
1841 identity is selected, through command-line or
1842 'sendemail.identity'.
1843
1844sendemail.aliasesfile::
1845sendemail.aliasfiletype::
1846sendemail.bcc::
1847sendemail.cc::
1848sendemail.cccmd::
1849sendemail.chainreplyto::
1850sendemail.confirm::
1851sendemail.envelopesender::
1852sendemail.from::
1853sendemail.multiedit::
1854sendemail.signedoffbycc::
1855sendemail.smtppass::
1856sendemail.suppresscc::
1857sendemail.suppressfrom::
1858sendemail.to::
69cf7bfd 1859sendemail.smtpdomain::
65180c66
YD
1860sendemail.smtpserver::
1861sendemail.smtpserverport::
052fbea2 1862sendemail.smtpserveroption::
65180c66
YD
1863sendemail.smtpuser::
1864sendemail.thread::
1865sendemail.validate::
1866 See linkgit:git-send-email[1] for description.
1867
1868sendemail.signedoffcc::
1869 Deprecated alias for 'sendemail.signedoffbycc'.
1870
1ab661dd 1871showbranch.default::
5162e697
DM
1872 The default set of branches for linkgit:git-show-branch[1].
1873 See linkgit:git-show-branch[1].
1ab661dd 1874
46f721c8 1875status.relativePaths::
5162e697 1876 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1877 current directory. Setting this variable to `false` shows paths
1878 relative to the repository root (this was the default for git
1879 prior to v1.5.4).
1880
d6293d1f
MSO
1881status.showUntrackedFiles::
1882 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1883 files which are not currently tracked by Git. Directories which
1884 contain only untracked files, are shown with the directory name
1885 only. Showing untracked files means that Git needs to lstat() all
1886 all the files in the whole repository, which might be slow on some
1887 systems. So, this variable controls how the commands displays
1888 the untracked files. Possible values are:
1889+
1890--
9373bdc4
CF
1891* `no` - Show no untracked files.
1892* `normal` - Show untracked files and directories.
1893* `all` - Show also individual files in untracked directories.
d6293d1f
MSO
1894--
1895+
1896If this variable is not specified, it defaults to 'normal'.
1897This variable can be overridden with the -u|--untracked-files option
1898of linkgit:git-status[1] and linkgit:git-commit[1].
1899
4b2343fa
MG
1900status.submodulesummary::
1901 Defaults to false.
1902 If this is set to a non zero number or true (identical to -1 or an
1903 unlimited number), the submodule summary will be enabled and a
1904 summary of commits for modified submodules will be shown (see
1905 --summary-limit option of linkgit:git-submodule[1]).
1906
0ad0a61f
JN
1907submodule.<name>.path::
1908submodule.<name>.url::
1909submodule.<name>.update::
1910 The path within this project, URL, and the updating strategy
1911 for a submodule. These variables are initially populated
1912 by 'git submodule init'; edit them to override the
1913 URL and other values found in the `.gitmodules` file. See
1914 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1915
c1a3c364 1916submodule.<name>.fetchRecurseSubmodules::
bf42b384 1917 This option can be used to control recursive fetching of this
469bfc96 1918 submodule. It can be overridden by using the --[no-]recurse-submodules
c1a3c364
JL
1919 command line option to "git fetch" and "git pull".
1920 This setting will override that from in the linkgit:gitmodules[5]
1921 file.
1922
aee9c7d6
JL
1923submodule.<name>.ignore::
1924 Defines under what circumstances "git status" and the diff family show
1925 a submodule as modified. When set to "all", it will never be considered
1926 modified, "dirty" will ignore all changes to the submodules work tree and
1927 takes only differences between the HEAD of the submodule and the commit
1928 recorded in the superproject into account. "untracked" will additionally
1929 let submodules with modified tracked files in their work tree show up.
1930 Using "none" (the default when this option is not set) also shows
1931 submodules that have untracked files in their work tree as changed.
302ad7a9 1932 This setting overrides any setting made in .gitmodules for this submodule,
3776ea9d 1933 both settings can be overridden on the command line by using the
be4f2b40 1934 "--ignore-submodules" option.
aee9c7d6 1935
ce1a79b6 1936tar.umask::
687157c7
RS
1937 This variable can be used to restrict the permission bits of
1938 tar archive entries. The default is 0002, which turns off the
1939 world write bit. The special value "user" indicates that the
1940 archiving user's umask will be used instead. See umask(2) and
5162e697 1941 linkgit:git-archive[1].
ce1a79b6 1942
dab76d3a
JH
1943transfer.fsckObjects::
1944 When `fetch.fsckObjects` or `receive.fsckObjects` are
1945 not set, the value of this variable is used instead.
1946 Defaults to false.
1947
b0f34c3d
MM
1948transfer.unpackLimit::
1949 When `fetch.unpackLimit` or `receive.unpackLimit` are
1950 not set, the value of this variable is used instead.
1951 The default value is 100.
1952
55029ae4
DB
1953url.<base>.insteadOf::
1954 Any URL that starts with this value will be rewritten to
1955 start, instead, with <base>. In cases where some site serves a
1956 large number of repositories, and serves them with multiple
1957 access methods, and some users need to use different access
1958 methods, this feature allows people to specify any of the
1959 equivalent URLs and have git automatically rewrite the URL to
1960 the best alternative for the particular user, even for a
844112ca
JH
1961 never-before-seen repository on the site. When more than one
1962 insteadOf strings match a given URL, the longest match is used.
55029ae4 1963
1c2eafb8
JT
1964url.<base>.pushInsteadOf::
1965 Any URL that starts with this value will not be pushed to;
1966 instead, it will be rewritten to start with <base>, and the
1967 resulting URL will be pushed to. In cases where some site serves
1968 a large number of repositories, and serves them with multiple
1969 access methods, some of which do not allow push, this feature
1970 allows people to specify a pull-only URL and have git
1971 automatically use an appropriate URL to push, even for a
1972 never-before-seen repository on the site. When more than one
1973 pushInsteadOf strings match a given URL, the longest match is
1974 used. If a remote has an explicit pushurl, git will ignore this
1975 setting for that remote.
1976
1ab661dd
PB
1977user.email::
1978 Your email address to be recorded in any newly created commits.
28a94f88 1979 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1980 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1981
1982user.name::
1983 Your full name to be recorded in any newly created commits.
abda1ef5 1984 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1985 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1986
d67778ec 1987user.signingkey::
5162e697 1988 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1989 automatically when creating a signed tag, you can override the
1990 default selection with this variable. This option is passed
1991 unchanged to gpg's --local-user parameter, so you may specify a key
1992 using any method that gpg supports.
1993
983a9eeb
CC
1994web.browser::
1995 Specify a web browser that may be used by some commands.
1996 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1997 may use it.