compat/bswap.h: fix endianness detection
[git/git.git] / Documentation / config.txt
2 ------------------
4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times.
19 Syntax
20 ~~~~~~
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored. The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables. A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins. Section names are not case sensitive. Only alphanumeric
29 characters, `-` and `.` are allowed in section names. Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections. To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
37 --------
38 [section "subsection"]
40 --------
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively). Section headers cannot span multiple
45 lines. Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
47 don't need to.
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'. If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character. There can be more
60 than one value for a given variable; we say then that the variable is
61 multivalued.
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean. Boolean values may be given as yes/no,
68 1/0, true/false or on/off. Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS). Other char escape sequences (including octal
82 escape sequences) are invalid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
89 Includes
90 ~~~~~~~~
92 You 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
94 included file is expanded immediately, as if its contents had been
95 found 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
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
102 Example
103 ~~~~~~~
105 # Core variables
106 [core]
107 ; Don't trust file modes
108 filemode = false
110 # Our diff algorithm
111 [diff]
112 external = /usr/local/bin/diff-wrapper
113 renames = true
115 [branch "devel"]
116 remote = origin
117 merge = refs/heads/devel
119 # Proxy settings
120 [core]
121 gitProxy="ssh" for ""
122 gitProxy=default-proxy ; for the rest
124 [include]
125 path = /path/to/ ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
129 Variables
130 ~~~~~~~~~
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page.
136 Other git-related tools may and do use their own variables. When
137 inventing new variables for use in your own tool, make sure their
138 names do not conflict with those that are used by Git itself and
139 other popular tools, and describe them in your documentation.
142 advice.*::
143 These variables control various optional help messages designed to
144 aid new users. All 'advice.*' variables default to 'true', and you
145 can tell Git that you do not need help by setting these to 'false':
146 +
147 --
148 pushUpdateRejected::
149 Set this variable to 'false' if you want to disable
150 'pushNonFFCurrent',
151 'pushNonFFMatching', 'pushAlreadyExists',
152 'pushFetchFirst', and 'pushNeedsForce'
153 simultaneously.
154 pushNonFFCurrent::
155 Advice shown when linkgit:git-push[1] fails due to a
156 non-fast-forward update to the current branch.
157 pushNonFFMatching::
158 Advice shown when you ran linkgit:git-push[1] and pushed
159 'matching refs' explicitly (i.e. you used ':', or
160 specified a refspec that isn't your current branch) and
161 it resulted in a non-fast-forward error.
162 pushAlreadyExists::
163 Shown when linkgit:git-push[1] rejects an update that
164 does not qualify for fast-forwarding (e.g., a tag.)
165 pushFetchFirst::
166 Shown when linkgit:git-push[1] rejects an update that
167 tries to overwrite a remote ref that points at an
168 object we do not have.
169 pushNeedsForce::
170 Shown when linkgit:git-push[1] rejects an update that
171 tries to overwrite a remote ref that points at an
172 object that is not a commit-ish, or make the remote
173 ref point at an object that is not a commit-ish.
174 statusHints::
175 Show directions on how to proceed from the current
176 state in the output of linkgit:git-status[1], in
177 the template shown when writing commit messages in
178 linkgit:git-commit[1], and in the help message shown
179 by linkgit:git-checkout[1] when switching branch.
180 statusUoption::
181 Advise to consider using the `-u` option to linkgit:git-status[1]
182 when the command takes more than 2 seconds to enumerate untracked
183 files.
184 commitBeforeMerge::
185 Advice shown when linkgit:git-merge[1] refuses to
186 merge to avoid overwriting local changes.
187 resolveConflict::
188 Advice shown by various commands when conflicts
189 prevent the operation from being performed.
190 implicitIdentity::
191 Advice on how to set your identity configuration when
192 your information is guessed from the system username and
193 domain name.
194 detachedHead::
195 Advice shown when you used linkgit:git-checkout[1] to
196 move to the detach HEAD state, to instruct how to create
197 a local branch after the fact.
198 amWorkDir::
199 Advice that shows the location of the patch file when
200 linkgit:git-am[1] fails to apply it.
201 rmHints::
202 In case of failure in the output of linkgit:git-rm[1],
203 show directions on how to proceed from the current state.
204 --
206 core.fileMode::
207 If false, the executable bit differences between the index and
208 the working tree are ignored; useful on broken filesystems like FAT.
209 See linkgit:git-update-index[1].
210 +
211 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
212 will probe and set core.fileMode false if appropriate when the
213 repository is created.
215 core.ignorecase::
216 If true, this option enables various workarounds to enable
217 Git to work better on filesystems that are not case sensitive,
218 like FAT. For example, if a directory listing finds
219 "makefile" when Git expects "Makefile", Git will assume
220 it is really the same file, and continue to remember it as
221 "Makefile".
222 +
223 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
224 will probe and set core.ignorecase true if appropriate when the repository
225 is created.
227 core.precomposeunicode::
228 This option is only used by Mac OS implementation of Git.
229 When core.precomposeunicode=true, Git reverts the unicode decomposition
230 of filenames done by Mac OS. This is useful when sharing a repository
231 between Mac OS and Linux or Windows.
232 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
233 When false, file names are handled fully transparent by Git,
234 which is backward compatible with older versions of Git.
236 core.trustctime::
237 If false, the ctime differences between the index and the
238 working tree are ignored; useful when the inode change time
239 is regularly modified by something outside Git (file system
240 crawlers and some backup systems).
241 See linkgit:git-update-index[1]. True by default.
243 core.checkstat::
244 Determines which stat fields to match between the index
245 and work tree. The user can set this to 'default' or
246 'minimal'. Default (or explicitly 'default'), is to check
247 all fields, including the sub-second part of mtime and ctime.
249 core.quotepath::
250 The commands that output paths (e.g. 'ls-files',
251 'diff'), when not given the `-z` option, will quote
252 "unusual" characters in the pathname by enclosing the
253 pathname in a double-quote pair and with backslashes the
254 same way strings in C source code are quoted. If this
255 variable is set to false, the bytes higher than 0x80 are
256 not quoted but output as verbatim. Note that double
257 quote, backslash and control characters are always
258 quoted without `-z` regardless of the setting of this
259 variable.
261 core.eol::
262 Sets the line ending type to use in the working directory for
263 files that have the `text` property set. Alternatives are
264 'lf', 'crlf' and 'native', which uses the platform's native
265 line ending. The default value is `native`. See
266 linkgit:gitattributes[5] for more information on end-of-line
267 conversion.
269 core.safecrlf::
270 If true, makes Git check if converting `CRLF` is reversible when
271 end-of-line conversion is active. Git will verify if a command
272 modifies a file in the work tree either directly or indirectly.
273 For example, committing a file followed by checking out the
274 same file should yield the original file in the work tree. If
275 this is not the case for the current setting of
276 `core.autocrlf`, Git will reject the file. The variable can
277 be set to "warn", in which case Git will only warn about an
278 irreversible conversion but continue the operation.
279 +
280 CRLF conversion bears a slight chance of corrupting data.
281 When it is enabled, Git will convert CRLF to LF during commit and LF to
282 CRLF during checkout. A file that contains a mixture of LF and
283 CRLF before the commit cannot be recreated by Git. For text
284 files this is the right thing to do: it corrects line endings
285 such that we have only LF line endings in the repository.
286 But for binary files that are accidentally classified as text the
287 conversion can corrupt data.
288 +
289 If you recognize such corruption early you can easily fix it by
290 setting the conversion type explicitly in .gitattributes. Right
291 after committing you still have the original file in your work
292 tree and this file is not yet corrupted. You can explicitly tell
293 Git that this file is binary and Git will handle the file
294 appropriately.
295 +
296 Unfortunately, the desired effect of cleaning up text files with
297 mixed line endings and the undesired effect of corrupting binary
298 files cannot be distinguished. In both cases CRLFs are removed
299 in an irreversible way. For text files this is the right thing
300 to do because CRLFs are line endings, while for binary files
301 converting CRLFs corrupts data.
302 +
303 Note, this safety check does not mean that a checkout will generate a
304 file identical to the original file for a different setting of
305 `core.eol` and `core.autocrlf`, but only for the current one. For
306 example, a text file with `LF` would be accepted with `core.eol=lf`
307 and could later be checked out with `core.eol=crlf`, in which case the
308 resulting file would contain `CRLF`, although the original file
309 contained `LF`. However, in both work trees the line endings would be
310 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
311 file with mixed line endings would be reported by the `core.safecrlf`
312 mechanism.
314 core.autocrlf::
315 Setting this variable to "true" is almost the same as setting
316 the `text` attribute to "auto" on all files except that text
317 files are not guaranteed to be normalized: files that contain
318 `CRLF` in the repository will not be touched. Use this
319 setting if you want to have `CRLF` line endings in your
320 working directory even though the repository does not have
321 normalized line endings. This variable can be set to 'input',
322 in which case no output conversion is performed.
324 core.symlinks::
325 If false, symbolic links are checked out as small plain files that
326 contain the link text. linkgit:git-update-index[1] and
327 linkgit:git-add[1] will not change the recorded type to regular
328 file. Useful on filesystems like FAT that do not support
329 symbolic links.
330 +
331 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
332 will probe and set core.symlinks false if appropriate when the repository
333 is created.
335 core.gitProxy::
336 A "proxy command" to execute (as 'command host port') instead
337 of establishing direct connection to the remote server when
338 using the Git protocol for fetching. If the variable value is
339 in the "COMMAND for DOMAIN" format, the command is applied only
340 on hostnames ending with the specified domain string. This variable
341 may be set multiple times and is matched in the given order;
342 the first match wins.
343 +
344 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
345 (which always applies universally, without the special "for"
346 handling).
347 +
348 The special string `none` can be used as the proxy command to
349 specify that no proxy be used for a given domain pattern.
350 This is useful for excluding servers inside a firewall from
351 proxy use, while defaulting to a common proxy for external domains.
353 core.ignoreStat::
354 If true, commands which modify both the working tree and the index
355 will mark the updated paths with the "assume unchanged" bit in the
356 index. These marked files are then assumed to stay unchanged in the
357 working tree, until you mark them otherwise manually - Git will not
358 detect the file changes by lstat() calls. This is useful on systems
359 where those are very slow, such as Microsoft Windows.
360 See linkgit:git-update-index[1].
361 False by default.
363 core.preferSymlinkRefs::
364 Instead of the default "symref" format for HEAD
365 and other symbolic reference files, use symbolic links.
366 This is sometimes needed to work with old scripts that
367 expect HEAD to be a symbolic link.
369 core.bare::
370 If true this repository is assumed to be 'bare' and has no
371 working directory associated with it. If this is the case a
372 number of commands that require a working directory will be
373 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
374 +
375 This setting is automatically guessed by linkgit:git-clone[1] or
376 linkgit:git-init[1] when the repository was created. By default a
377 repository that ends in "/.git" is assumed to be not bare (bare =
378 false), while all other repositories are assumed to be bare (bare
379 = true).
381 core.worktree::
382 Set the path to the root of the working tree.
383 This can be overridden by the GIT_WORK_TREE environment
384 variable and the '--work-tree' command line option.
385 The value can be an absolute path or relative to the path to
386 the .git directory, which is either specified by --git-dir
387 or GIT_DIR, or automatically discovered.
388 If --git-dir or GIT_DIR is specified but none of
389 --work-tree, GIT_WORK_TREE and core.worktree is specified,
390 the current working directory is regarded as the top level
391 of your working tree.
392 +
393 Note that this variable is honored even when set in a configuration
394 file in a ".git" subdirectory of a directory and its value differs
395 from the latter directory (e.g. "/path/to/.git/config" has
396 core.worktree set to "/different/path"), which is most likely a
397 misconfiguration. Running Git commands in the "/path/to" directory will
398 still use "/different/path" as the root of the work tree and can cause
399 confusion unless you know what you are doing (e.g. you are creating a
400 read-only snapshot of the same index to a location different from the
401 repository's usual working tree).
403 core.logAllRefUpdates::
404 Enable the reflog. Updates to a ref <ref> is logged to the file
405 "$GIT_DIR/logs/<ref>", by appending the new and old
406 SHA-1, the date/time and the reason of the update, but
407 only when the file exists. If this configuration
408 variable is set to true, missing "$GIT_DIR/logs/<ref>"
409 file is automatically created for branch heads (i.e. under
410 refs/heads/), remote refs (i.e. under refs/remotes/),
411 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
412 +
413 This information can be used to determine what commit
414 was the tip of a branch "2 days ago".
415 +
416 This value is true by default in a repository that has
417 a working directory associated with it, and false by
418 default in a bare repository.
420 core.repositoryFormatVersion::
421 Internal variable identifying the repository format and layout
422 version.
424 core.sharedRepository::
425 When 'group' (or 'true'), the repository is made shareable between
426 several users in a group (making sure all the files and objects are
427 group-writable). When 'all' (or 'world' or 'everybody'), the
428 repository will be readable by all users, additionally to being
429 group-shareable. When 'umask' (or 'false'), Git will use permissions
430 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
431 files in the repository will have this mode value. '0xxx' will override
432 user's umask value (whereas the other options will only override
433 requested parts of the user's umask value). Examples: '0660' will make
434 the repo read/write-able for the owner and group, but inaccessible to
435 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
436 repository that is group-readable but not group-writable.
437 See linkgit:git-init[1]. False by default.
439 core.warnAmbiguousRefs::
440 If true, Git will warn you if the ref name you passed it is ambiguous
441 and might match multiple refs in the repository. True by default.
443 core.compression::
444 An integer -1..9, indicating a default compression level.
445 -1 is the zlib default. 0 means no compression,
446 and 1..9 are various speed/size tradeoffs, 9 being slowest.
447 If set, this provides a default to other compression variables,
448 such as 'core.loosecompression' and 'pack.compression'.
450 core.loosecompression::
451 An integer -1..9, indicating the compression level for objects that
452 are not in a pack file. -1 is the zlib default. 0 means no
453 compression, and 1..9 are various speed/size tradeoffs, 9 being
454 slowest. If not set, defaults to core.compression. If that is
455 not set, defaults to 1 (best speed).
457 core.packedGitWindowSize::
458 Number of bytes of a pack file to map into memory in a
459 single mapping operation. Larger window sizes may allow
460 your system to process a smaller number of large pack files
461 more quickly. Smaller window sizes will negatively affect
462 performance due to increased calls to the operating system's
463 memory manager, but may improve performance when accessing
464 a large number of large pack files.
465 +
466 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
467 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
468 be reasonable for all users/operating systems. You probably do
469 not need to adjust this value.
470 +
471 Common unit suffixes of 'k', 'm', or 'g' are supported.
473 core.packedGitLimit::
474 Maximum number of bytes to map simultaneously into memory
475 from pack files. If Git needs to access more than this many
476 bytes at once to complete an operation it will unmap existing
477 regions to reclaim virtual address space within the process.
478 +
479 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
480 This should be reasonable for all users/operating systems, except on
481 the largest projects. You probably do not need to adjust this value.
482 +
483 Common unit suffixes of 'k', 'm', or 'g' are supported.
485 core.deltaBaseCacheLimit::
486 Maximum number of bytes to reserve for caching base objects
487 that may be referenced by multiple deltified objects. By storing the
488 entire decompressed base objects in a cache Git is able
489 to avoid unpacking and decompressing frequently used base
490 objects multiple times.
491 +
492 Default is 16 MiB on all platforms. This should be reasonable
493 for all users/operating systems, except on the largest projects.
494 You probably do not need to adjust this value.
495 +
496 Common unit suffixes of 'k', 'm', or 'g' are supported.
498 core.bigFileThreshold::
499 Files larger than this size are stored deflated, without
500 attempting delta compression. Storing large files without
501 delta compression avoids excessive memory usage, at the
502 slight expense of increased disk usage.
503 +
504 Default is 512 MiB on all platforms. This should be reasonable
505 for most projects as source code and other text files can still
506 be delta compressed, but larger binary media files won't be.
507 +
508 Common unit suffixes of 'k', 'm', or 'g' are supported.
510 core.excludesfile::
511 In addition to '.gitignore' (per-directory) and
512 '.git/info/exclude', Git looks into this file for patterns
513 of files which are not meant to be tracked. "`~/`" is expanded
514 to the value of `$HOME` and "`~user/`" to the specified user's
515 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
516 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
517 is used instead. See linkgit:gitignore[5].
519 core.askpass::
520 Some commands (e.g. svn and http interfaces) that interactively
521 ask for a password can be told to use an external program given
522 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
523 environment variable. If not set, fall back to the value of the
524 'SSH_ASKPASS' environment variable or, failing that, a simple password
525 prompt. The external program shall be given a suitable prompt as
526 command line argument and write the password on its STDOUT.
528 core.attributesfile::
529 In addition to '.gitattributes' (per-directory) and
530 '.git/info/attributes', Git looks into this file for attributes
531 (see linkgit:gitattributes[5]). Path expansions are made the same
532 way as for `core.excludesfile`. Its default value is
533 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
534 set or empty, $HOME/.config/git/attributes is used instead.
536 core.editor::
537 Commands such as `commit` and `tag` that lets you edit
538 messages by launching an editor uses the value of this
539 variable when it is set, and the environment variable
540 `GIT_EDITOR` is not set. See linkgit:git-var[1].
542 core.commentchar::
543 Commands such as `commit` and `tag` that lets you edit
544 messages consider a line that begins with this character
545 commented, and removes them after the editor returns
546 (default '#').
548 sequence.editor::
549 Text editor used by `git rebase -i` for editing the rebase instruction file.
550 The value is meant to be interpreted by the shell when it is used.
551 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
552 When not configured the default commit message editor is used instead.
554 core.pager::
555 Text viewer for use by Git commands (e.g., 'less'). The value
556 is meant to be interpreted by the shell. The order of preference
557 is the `$GIT_PAGER` environment variable, then `core.pager`
558 configuration, then `$PAGER`, and then the default chosen at
559 compile time (usually 'less').
560 +
561 When the `LESS` environment variable is unset, Git sets it to `FRSX`
562 (if `LESS` environment variable is set, Git does not change it at
563 all). If you want to selectively override Git's default setting
564 for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
565 be passed to the shell by Git, which will translate the final
566 command to `LESS=FRSX less -+S`. The environment tells the command
567 to set the `S` option to chop long lines but the command line
568 resets it to the default to fold long lines.
569 +
570 Likewise, when the `LV` environment variable is unset, Git sets it
571 to `-c`. You can override this setting by exporting `LV` with
572 another value or setting `core.pager` to `lv +c`.
574 core.whitespace::
575 A comma separated list of common whitespace problems to
576 notice. 'git diff' will use `color.diff.whitespace` to
577 highlight them, and 'git apply --whitespace=error' will
578 consider them as errors. You can prefix `-` to disable
579 any of them (e.g. `-trailing-space`):
580 +
581 * `blank-at-eol` treats trailing whitespaces at the end of the line
582 as an error (enabled by default).
583 * `space-before-tab` treats a space character that appears immediately
584 before a tab character in the initial indent part of the line as an
585 error (enabled by default).
586 * `indent-with-non-tab` treats a line that is indented with space
587 characters instead of the equivalent tabs as an error (not enabled by
588 default).
589 * `tab-in-indent` treats a tab character in the initial indent part of
590 the line as an error (not enabled by default).
591 * `blank-at-eof` treats blank lines added at the end of file as an error
592 (enabled by default).
593 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
594 `blank-at-eof`.
595 * `cr-at-eol` treats a carriage-return at the end of line as
596 part of the line terminator, i.e. with it, `trailing-space`
597 does not trigger if the character before such a carriage-return
598 is not a whitespace (not enabled by default).
599 * `tabwidth=<n>` tells how many character positions a tab occupies; this
600 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
601 errors. The default tab width is 8. Allowed values are 1 to 63.
603 core.fsyncobjectfiles::
604 This boolean will enable 'fsync()' when writing object files.
605 +
606 This is a total waste of time and effort on a filesystem that orders
607 data writes properly, but can be useful for filesystems that do not use
608 journalling (traditional UNIX filesystems) or that only journal metadata
609 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
611 core.preloadindex::
612 Enable parallel index preload for operations like 'git diff'
613 +
614 This can speed up operations like 'git diff' and 'git status' especially
615 on filesystems like NFS that have weak caching semantics and thus
616 relatively high IO latencies. With this set to 'true', Git will do the
617 index comparison to the filesystem data in parallel, allowing
618 overlapping IO's.
620 core.createObject::
621 You can set this to 'link', in which case a hardlink followed by
622 a delete of the source are used to make sure that object creation
623 will not overwrite existing objects.
624 +
625 On some file system/operating system combinations, this is unreliable.
626 Set this config setting to 'rename' there; However, This will remove the
627 check that makes sure that existing object files will not get overwritten.
629 core.notesRef::
630 When showing commit messages, also show notes which are stored in
631 the given ref. The ref must be fully qualified. If the given
632 ref does not exist, it is not an error but means that no
633 notes should be printed.
634 +
635 This setting defaults to "refs/notes/commits", and it can be overridden by
636 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
638 core.sparseCheckout::
639 Enable "sparse checkout" feature. See section "Sparse checkout" in
640 linkgit:git-read-tree[1] for more information.
642 core.abbrev::
643 Set the length object names are abbreviated to. If unspecified,
644 many commands abbreviate to 7 hexdigits, which may not be enough
645 for abbreviated object names to stay unique for sufficiently long
646 time.
648 add.ignore-errors::
649 add.ignoreErrors::
650 Tells 'git add' to continue adding files when some files cannot be
651 added due to indexing errors. Equivalent to the '--ignore-errors'
652 option of linkgit:git-add[1]. Older versions of Git accept only
653 `add.ignore-errors`, which does not follow the usual naming
654 convention for configuration variables. Newer versions of Git
655 honor `add.ignoreErrors` as well.
657 alias.*::
658 Command aliases for the linkgit:git[1] command wrapper - e.g.
659 after defining "alias.last = cat-file commit HEAD", the invocation
660 "git last" is equivalent to "git cat-file commit HEAD". To avoid
661 confusion and troubles with script usage, aliases that
662 hide existing Git commands are ignored. Arguments are split by
663 spaces, the usual shell quoting and escaping is supported.
664 quote pair and a backslash can be used to quote them.
665 +
666 If the alias expansion is prefixed with an exclamation point,
667 it will be treated as a shell command. For example, defining
668 " = !gitk --all --not ORIG_HEAD", the invocation
669 "git new" is equivalent to running the shell command
670 "gitk --all --not ORIG_HEAD". Note that shell commands will be
671 executed from the top-level directory of a repository, which may
672 not necessarily be the current directory.
673 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
674 from the original current directory. See linkgit:git-rev-parse[1].
676 am.keepcr::
677 If true, git-am will call git-mailsplit for patches in mbox format
678 with parameter '--keep-cr'. In this case git-mailsplit will
679 not remove `\r` from lines ending with `\r\n`. Can be overridden
680 by giving '--no-keep-cr' from the command line.
681 See linkgit:git-am[1], linkgit:git-mailsplit[1].
683 apply.ignorewhitespace::
684 When set to 'change', tells 'git apply' to ignore changes in
685 whitespace, in the same way as the '--ignore-space-change'
686 option.
687 When set to one of: no, none, never, false tells 'git apply' to
688 respect all whitespace differences.
689 See linkgit:git-apply[1].
691 apply.whitespace::
692 Tells 'git apply' how to handle whitespaces, in the same way
693 as the '--whitespace' option. See linkgit:git-apply[1].
695 branch.autosetupmerge::
696 Tells 'git branch' and 'git checkout' to set up new branches
697 so that linkgit:git-pull[1] will appropriately merge from the
698 starting point branch. Note that even if this option is not set,
699 this behavior can be chosen per-branch using the `--track`
700 and `--no-track` options. The valid settings are: `false` -- no
701 automatic setup is done; `true` -- automatic setup is done when the
702 starting point is a remote-tracking branch; `always` --
703 automatic setup is done when the starting point is either a
704 local branch or remote-tracking
705 branch. This option defaults to true.
707 branch.autosetuprebase::
708 When a new branch is created with 'git branch' or 'git checkout'
709 that tracks another branch, this variable tells Git to set
710 up pull to rebase instead of merge (see "branch.<name>.rebase").
711 When `never`, rebase is never automatically set to true.
712 When `local`, rebase is set to true for tracked branches of
713 other local branches.
714 When `remote`, rebase is set to true for tracked branches of
715 remote-tracking branches.
716 When `always`, rebase will be set to true for all tracking
717 branches.
718 See "branch.autosetupmerge" for details on how to set up a
719 branch to track another branch.
720 This option defaults to never.
722 branch.<name>.remote::
723 When on branch <name>, it tells 'git fetch' and 'git push'
724 which remote to fetch from/push to. The remote to push to
725 may be overridden with `remote.pushdefault` (for all branches).
726 The remote to push to, for the current branch, may be further
727 overridden by `branch.<name>.pushremote`. If no remote is
728 configured, or if you are not on any branch, it defaults to
729 `origin` for fetching and `remote.pushdefault` for pushing.
730 Additionally, `.` (a period) is the current local repository
731 (a dot-repository), see `branch.<name>.merge`'s final note below.
733 branch.<name>.pushremote::
734 When on branch <name>, it overrides `branch.<name>.remote` for
735 pushing. It also overrides `remote.pushdefault` for pushing
736 from branch <name>. When you pull from one place (e.g. your
737 upstream) and push to another place (e.g. your own publishing
738 repository), you would want to set `remote.pushdefault` to
739 specify the remote to push to for all branches, and use this
740 option to override it for a specific branch.
742 branch.<name>.merge::
743 Defines, together with branch.<name>.remote, the upstream branch
744 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
745 branch to merge and can also affect 'git push' (see push.default).
746 When in branch <name>, it tells 'git fetch' the default
747 refspec to be marked for merging in FETCH_HEAD. The value is
748 handled like the remote part of a refspec, and must match a
749 ref which is fetched from the remote given by
750 "branch.<name>.remote".
751 The merge information is used by 'git pull' (which at first calls
752 'git fetch') to lookup the default branch for merging. Without
753 this option, 'git pull' defaults to merge the first refspec fetched.
754 Specify multiple values to get an octopus merge.
755 If you wish to setup 'git pull' so that it merges into <name> from
756 another branch in the local repository, you can point
757 branch.<name>.merge to the desired branch, and use the relative path
758 setting `.` (a period) for branch.<name>.remote.
760 branch.<name>.mergeoptions::
761 Sets default options for merging into branch <name>. The syntax and
762 supported options are the same as those of linkgit:git-merge[1], but
763 option values containing whitespace characters are currently not
764 supported.
766 branch.<name>.rebase::
767 When true, rebase the branch <name> on top of the fetched branch,
768 instead of merging the default branch from the default remote when
769 "git pull" is run. See "pull.rebase" for doing this in a non
770 branch-specific manner.
771 +
772 When preserve, also pass `--preserve-merges` along to 'git rebase'
773 so that locally committed merge commits will not be flattened
774 by running 'git pull'.
775 +
776 *NOTE*: this is a possibly dangerous operation; do *not* use
777 it unless you understand the implications (see linkgit:git-rebase[1]
778 for details).
780 branch.<name>.description::
781 Branch description, can be edited with
782 `git branch --edit-description`. Branch description is
783 automatically added in the format-patch cover letter or
784 request-pull summary.
786 browser.<tool>.cmd::
787 Specify the command to invoke the specified browser. The
788 specified command is evaluated in shell with the URLs passed
789 as arguments. (See linkgit:git-web{litdd}browse[1].)
791 browser.<tool>.path::
792 Override the path for the given tool that may be used to
793 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
794 working repository in gitweb (see linkgit:git-instaweb[1]).
796 clean.requireForce::
797 A boolean to make git-clean do nothing unless given -f,
798 -i or -n. Defaults to true.
800 color.branch::
801 A boolean to enable/disable color in the output of
802 linkgit:git-branch[1]. May be set to `always`,
803 `false` (or `never`) or `auto` (or `true`), in which case colors are used
804 only when the output is to a terminal. Defaults to false.
806 color.branch.<slot>::
807 Use customized color for branch coloration. `<slot>` is one of
808 `current` (the current branch), `local` (a local branch),
809 `remote` (a remote-tracking branch in refs/remotes/),
810 `upstream` (upstream tracking branch), `plain` (other
811 refs).
812 +
813 The value for these configuration variables is a list of colors (at most
814 two) and attributes (at most one), separated by spaces. The colors
815 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
816 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
817 `blink` and `reverse`. The first color given is the foreground; the
818 second is the background. The position of the attribute, if any,
819 doesn't matter.
821 color.diff::
822 Whether to use ANSI escape sequences to add color to patches.
823 If this is set to `always`, linkgit:git-diff[1],
824 linkgit:git-log[1], and linkgit:git-show[1] will use color
825 for all patches. If it is set to `true` or `auto`, those
826 commands will only use color when output is to the terminal.
827 Defaults to false.
828 +
829 This does not affect linkgit:git-format-patch[1] or the
830 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
831 command line with the `--color[=<when>]` option.
833 color.diff.<slot>::
834 Use customized color for diff colorization. `<slot>` specifies
835 which part of the patch to use the specified color, and is one
836 of `plain` (context text), `meta` (metainformation), `frag`
837 (hunk header), 'func' (function in hunk header), `old` (removed lines),
838 `new` (added lines), `commit` (commit headers), or `whitespace`
839 (highlighting whitespace errors). The values of these variables may be
840 specified as in color.branch.<slot>.
842 color.decorate.<slot>::
843 Use customized color for 'git log --decorate' output. `<slot>` is one
844 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
845 branches, remote-tracking branches, tags, stash and HEAD, respectively.
847 color.grep::
848 When set to `always`, always highlight matches. When `false` (or
849 `never`), never. When set to `true` or `auto`, use color only
850 when the output is written to the terminal. Defaults to `false`.
852 color.grep.<slot>::
853 Use customized color for grep colorization. `<slot>` specifies which
854 part of the line to use the specified color, and is one of
855 +
856 --
857 `context`;;
858 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
859 `filename`;;
860 filename prefix (when not using `-h`)
861 `function`;;
862 function name lines (when using `-p`)
863 `linenumber`;;
864 line number prefix (when using `-n`)
865 `match`;;
866 matching text
867 `selected`;;
868 non-matching text in selected lines
869 `separator`;;
870 separators between fields on a line (`:`, `-`, and `=`)
871 and between hunks (`--`)
872 --
873 +
874 The values of these variables may be specified as in color.branch.<slot>.
876 color.interactive::
877 When set to `always`, always use colors for interactive prompts
878 and displays (such as those used by "git-add --interactive" and
879 "git-clean --interactive"). When false (or `never`), never.
880 When set to `true` or `auto`, use colors only when the output is
881 to the terminal. Defaults to false.
883 color.interactive.<slot>::
884 Use customized color for 'git add --interactive' and 'git clean
885 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
886 or `error`, for four distinct types of normal output from
887 interactive commands. The values of these variables may be
888 specified as in color.branch.<slot>.
890 color.pager::
891 A boolean to enable/disable colored output when the pager is in
892 use (default is true).
894 color.showbranch::
895 A boolean to enable/disable color in the output of
896 linkgit:git-show-branch[1]. May be set to `always`,
897 `false` (or `never`) or `auto` (or `true`), in which case colors are used
898 only when the output is to a terminal. Defaults to false.
900 color.status::
901 A boolean to enable/disable color in the output of
902 linkgit:git-status[1]. May be set to `always`,
903 `false` (or `never`) or `auto` (or `true`), in which case colors are used
904 only when the output is to a terminal. Defaults to false.
906 color.status.<slot>::
907 Use customized color for status colorization. `<slot>` is
908 one of `header` (the header text of the status message),
909 `added` or `updated` (files which are added but not committed),
910 `changed` (files which are changed but not added in the index),
911 `untracked` (files which are not tracked by Git),
912 `branch` (the current branch), or
913 `nobranch` (the color the 'no branch' warning is shown in, defaulting
914 to red). The values of these variables may be specified as in
915 color.branch.<slot>.
917 color.ui::
918 This variable determines the default value for variables such
919 as `color.diff` and `color.grep` that control the use of color
920 per command family. Its scope will expand as more commands learn
921 configuration to set a default for the `--color` option. Set it
922 to `false` or `never` if you prefer Git commands not to use
923 color unless enabled explicitly with some other configuration
924 or the `--color` option. Set it to `always` if you want all
925 output not intended for machine consumption to use color, to
926 `true` or `auto` (this is the default since Git 1.8.4) if you
927 want such output to use color when written to the terminal.
929 column.ui::
930 Specify whether supported commands should output in columns.
931 This variable consists of a list of tokens separated by spaces
932 or commas:
933 +
934 These options control when the feature should be enabled
935 (defaults to 'never'):
936 +
937 --
938 `always`;;
939 always show in columns
940 `never`;;
941 never show in columns
942 `auto`;;
943 show in columns if the output is to the terminal
944 --
945 +
946 These options control layout (defaults to 'column'). Setting any
947 of these implies 'always' if none of 'always', 'never', or 'auto' are
948 specified.
949 +
950 --
951 `column`;;
952 fill columns before rows
953 `row`;;
954 fill rows before columns
955 `plain`;;
956 show in one column
957 --
958 +
959 Finally, these options can be combined with a layout option (defaults
960 to 'nodense'):
961 +
962 --
963 `dense`;;
964 make unequal size columns to utilize more space
965 `nodense`;;
966 make equal size columns
967 --
969 column.branch::
970 Specify whether to output branch listing in `git branch` in columns.
971 See `column.ui` for details.
973 column.clean::
974 Specify the layout when list items in `git clean -i`, which always
975 shows files and directories in columns. See `column.ui` for details.
977 column.status::
978 Specify whether to output untracked files in `git status` in columns.
979 See `column.ui` for details.
981 column.tag::
982 Specify whether to output tag listing in `git tag` in columns.
983 See `column.ui` for details.
985 commit.cleanup::
986 This setting overrides the default of the `--cleanup` option in
987 `git commit`. See linkgit:git-commit[1] for details. Changing the
988 default can be useful when you always want to keep lines that begin
989 with comment character `#` in your log message, in which case you
990 would do `git config commit.cleanup whitespace` (note that you will
991 have to remove the help lines that begin with `#` in the commit log
992 template yourself, if you do this).
994 commit.gpgsign::
996 A boolean to specify whether all commits should be GPG signed.
997 Use of this option when doing operations such as rebase can
998 result in a large number of commits being signed. It may be
999 convenient to use an agent to avoid typing your GPG passphrase
1000 several times.
1002 commit.status::
1003 A boolean to enable/disable inclusion of status information in the
1004 commit message template when using an editor to prepare the commit
1005 message. Defaults to true.
1007 commit.template::
1008 Specify a file to use as the template for new commit messages.
1009 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1010 specified user's home directory.
1012 credential.helper::
1013 Specify an external helper to be called when a username or
1014 password credential is needed; the helper may consult external
1015 storage to avoid prompting the user for the credentials. See
1016 linkgit:gitcredentials[7] for details.
1018 credential.useHttpPath::
1019 When acquiring credentials, consider the "path" component of an http
1020 or https URL to be important. Defaults to false. See
1021 linkgit:gitcredentials[7] for more information.
1023 credential.username::
1024 If no username is set for a network authentication, use this username
1025 by default. See credential.<context>.* below, and
1026 linkgit:gitcredentials[7].
1028 credential.<url>.*::
1029 Any of the credential.* options above can be applied selectively to
1030 some credentials. For example "credential."
1031 would set the default username only for https connections to
1032 See linkgit:gitcredentials[7] for details on how URLs are
1033 matched.
1035 include::diff-config.txt[]
1037 difftool.<tool>.path::
1038 Override the path for the given tool. This is useful in case
1039 your tool is not in the PATH.
1041 difftool.<tool>.cmd::
1042 Specify the command to invoke the specified diff tool.
1043 The specified command is evaluated in shell with the following
1044 variables available: 'LOCAL' is set to the name of the temporary
1045 file containing the contents of the diff pre-image and 'REMOTE'
1046 is set to the name of the temporary file containing the contents
1047 of the diff post-image.
1049 difftool.prompt::
1050 Prompt before each invocation of the diff tool.
1052 fetch.recurseSubmodules::
1053 This option can be either set to a boolean value or to 'on-demand'.
1054 Setting it to a boolean changes the behavior of fetch and pull to
1055 unconditionally recurse into submodules when set to true or to not
1056 recurse at all when set to false. When set to 'on-demand' (the default
1057 value), fetch and pull will only recurse into a populated submodule
1058 when its superproject retrieves a commit that updates the submodule's
1059 reference.
1061 fetch.fsckObjects::
1062 If it is set to true, git-fetch-pack will check all fetched
1063 objects. It will abort in the case of a malformed object or a
1064 broken link. The result of an abort are only dangling objects.
1065 Defaults to false. If not set, the value of `transfer.fsckObjects`
1066 is used instead.
1068 fetch.unpackLimit::
1069 If the number of objects fetched over the Git native
1070 transfer is below this
1071 limit, then the objects will be unpacked into loose object
1072 files. However if the number of received objects equals or
1073 exceeds this limit then the received pack will be stored as
1074 a pack, after adding any missing delta bases. Storing the
1075 pack from a push can make the push operation complete faster,
1076 especially on slow filesystems. If not set, the value of
1077 `transfer.unpackLimit` is used instead.
1079 fetch.prune::
1080 If true, fetch will automatically behave as if the `--prune`
1081 option was given on the command line. See also `remote.<name>.prune`.
1083 format.attach::
1084 Enable multipart/mixed attachments as the default for
1085 'format-patch'. The value can also be a double quoted string
1086 which will enable attachments as the default and set the
1087 value as the boundary. See the --attach option in
1088 linkgit:git-format-patch[1].
1090 format.numbered::
1091 A boolean which can enable or disable sequence numbers in patch
1092 subjects. It defaults to "auto" which enables it only if there
1093 is more than one patch. It can be enabled or disabled for all
1094 messages by setting it to "true" or "false". See --numbered
1095 option in linkgit:git-format-patch[1].
1097 format.headers::
1098 Additional email headers to include in a patch to be submitted
1099 by mail. See linkgit:git-format-patch[1].
1103 Additional recipients to include in a patch to be submitted
1104 by mail. See the --to and --cc options in
1105 linkgit:git-format-patch[1].
1107 format.subjectprefix::
1108 The default for format-patch is to output files with the '[PATCH]'
1109 subject prefix. Use this variable to change that prefix.
1111 format.signature::
1112 The default for format-patch is to output a signature containing
1113 the Git version number. Use this variable to change that default.
1114 Set this variable to the empty string ("") to suppress
1115 signature generation.
1117 format.suffix::
1118 The default for format-patch is to output files with the suffix
1119 `.patch`. Use this variable to change that suffix (make sure to
1120 include the dot if you want it).
1122 format.pretty::
1123 The default pretty format for log/show/whatchanged command,
1124 See linkgit:git-log[1], linkgit:git-show[1],
1125 linkgit:git-whatchanged[1].
1127 format.thread::
1128 The default threading style for 'git format-patch'. Can be
1129 a boolean value, or `shallow` or `deep`. `shallow` threading
1130 makes every mail a reply to the head of the series,
1131 where the head is chosen from the cover letter, the
1132 `--in-reply-to`, and the first patch mail, in this order.
1133 `deep` threading makes every mail a reply to the previous one.
1134 A true boolean value is the same as `shallow`, and a false
1135 value disables threading.
1137 format.signoff::
1138 A boolean value which lets you enable the `-s/--signoff` option of
1139 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1140 patch should be a conscious act and means that you certify you have
1141 the rights to submit this work under the same open source license.
1142 Please see the 'SubmittingPatches' document for further discussion.
1144 format.coverLetter::
1145 A boolean that controls whether to generate a cover-letter when
1146 format-patch is invoked, but in addition can be set to "auto", to
1147 generate a cover-letter only when there's more than one patch.
1149 filter.<driver>.clean::
1150 The command which is used to convert the content of a worktree
1151 file to a blob upon checkin. See linkgit:gitattributes[5] for
1152 details.
1154 filter.<driver>.smudge::
1155 The command which is used to convert the content of a blob
1156 object to a worktree file upon checkout. See
1157 linkgit:gitattributes[5] for details.
1159 gc.aggressiveDepth::
1160 The depth parameter used in the delta compression
1161 algorithm used by 'git gc --aggressive'. This defaults
1162 to 250.
1164 gc.aggressiveWindow::
1165 The window size parameter used in the delta compression
1166 algorithm used by 'git gc --aggressive'. This defaults
1167 to 250.
1170 When there are approximately more than this many loose
1171 objects in the repository, `git gc --auto` will pack them.
1172 Some Porcelain commands use this command to perform a
1173 light-weight garbage collection from time to time. The
1174 default value is 6700. Setting this to 0 disables it.
1176 gc.autopacklimit::
1177 When there are more than this many packs that are not
1178 marked with `*.keep` file in the repository, `git gc
1179 --auto` consolidates them into one larger pack. The
1180 default value is 50. Setting this to 0 disables it.
1182 gc.autodetach::
1183 Make `git gc --auto` return immediately andrun in background
1184 if the system supports it. Default is true.
1186 gc.packrefs::
1187 Running `git pack-refs` in a repository renders it
1188 unclonable by Git versions prior to over dumb
1189 transports such as HTTP. This variable determines whether
1190 'git gc' runs `git pack-refs`. This can be set to `notbare`
1191 to enable it within all non-bare repos or it can be set to a
1192 boolean value. The default is `true`.
1194 gc.pruneexpire::
1195 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1196 Override the grace period with this config variable. The value
1197 "now" may be used to disable this grace period and always prune
1198 unreachable objects immediately.
1200 gc.reflogexpire::
1201 gc.<pattern>.reflogexpire::
1202 'git reflog expire' removes reflog entries older than
1203 this time; defaults to 90 days. With "<pattern>" (e.g.
1204 "refs/stash") in the middle the setting applies only to
1205 the refs that match the <pattern>.
1207 gc.reflogexpireunreachable::
1208 gc.<ref>.reflogexpireunreachable::
1209 'git reflog expire' removes reflog entries older than
1210 this time and are not reachable from the current tip;
1211 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1212 in the middle, the setting applies only to the refs that
1213 match the <pattern>.
1215 gc.rerereresolved::
1216 Records of conflicted merge you resolved earlier are
1217 kept for this many days when 'git rerere gc' is run.
1218 The default is 60 days. See linkgit:git-rerere[1].
1220 gc.rerereunresolved::
1221 Records of conflicted merge you have not resolved are
1222 kept for this many days when 'git rerere gc' is run.
1223 The default is 15 days. See linkgit:git-rerere[1].
1225 gitcvs.commitmsgannotation::
1226 Append this string to each commit message. Set to empty string
1227 to disable this feature. Defaults to "via git-CVS emulator".
1229 gitcvs.enabled::
1230 Whether the CVS server interface is enabled for this repository.
1231 See linkgit:git-cvsserver[1].
1233 gitcvs.logfile::
1234 Path to a log file where the CVS server interface well... logs
1235 various stuff. See linkgit:git-cvsserver[1].
1237 gitcvs.usecrlfattr::
1238 If true, the server will look up the end-of-line conversion
1239 attributes for files to determine the '-k' modes to use. If
1240 the attributes force Git to treat a file as text,
1241 the '-k' mode will be left blank so CVS clients will
1242 treat it as text. If they suppress text conversion, the file
1243 will be set with '-kb' mode, which suppresses any newline munging
1244 the client might otherwise do. If the attributes do not allow
1245 the file type to be determined, then 'gitcvs.allbinary' is
1246 used. See linkgit:gitattributes[5].
1248 gitcvs.allbinary::
1249 This is used if 'gitcvs.usecrlfattr' does not resolve
1250 the correct '-kb' mode to use. If true, all
1251 unresolved files are sent to the client in
1252 mode '-kb'. This causes the client to treat them
1253 as binary files, which suppresses any newline munging it
1254 otherwise might do. Alternatively, if it is set to "guess",
1255 then the contents of the file are examined to decide if
1256 it is binary, similar to 'core.autocrlf'.
1258 gitcvs.dbname::
1259 Database used by git-cvsserver to cache revision information
1260 derived from the Git repository. The exact meaning depends on the
1261 used database driver, for SQLite (which is the default driver) this
1262 is a filename. Supports variable substitution (see
1263 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1264 Default: '%Ggitcvs.%m.sqlite'
1266 gitcvs.dbdriver::
1267 Used Perl DBI driver. You can specify any available driver
1268 for this here, but it might not work. git-cvsserver is tested
1269 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1270 reported *not* to work with 'DBD::mysql'. Experimental feature.
1271 May not contain double colons (`:`). Default: 'SQLite'.
1272 See linkgit:git-cvsserver[1].
1274 gitcvs.dbuser, gitcvs.dbpass::
1275 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1276 since SQLite has no concept of database users and/or passwords.
1277 'gitcvs.dbuser' supports variable substitution (see
1278 linkgit:git-cvsserver[1] for details).
1280 gitcvs.dbTableNamePrefix::
1281 Database table name prefix. Prepended to the names of any
1282 database tables used, allowing a single database to be used
1283 for several repositories. Supports variable substitution (see
1284 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1285 characters will be replaced with underscores.
1287 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1288 'gitcvs.allbinary' can also be specified as
1289 'gitcvs.<access_method>.<varname>' (where 'access_method'
1290 is one of "ext" and "pserver") to make them apply only for the given
1291 access method.
1293 gitweb.category::
1294 gitweb.description::
1295 gitweb.owner::
1296 gitweb.url::
1297 See linkgit:gitweb[1] for description.
1299 gitweb.avatar::
1300 gitweb.blame::
1301 gitweb.grep::
1302 gitweb.highlight::
1303 gitweb.patches::
1304 gitweb.pickaxe::
1305 gitweb.remote_heads::
1306 gitweb.showsizes::
1307 gitweb.snapshot::
1308 See linkgit:gitweb.conf[5] for description.
1310 grep.lineNumber::
1311 If set to true, enable '-n' option by default.
1313 grep.patternType::
1314 Set the default matching behavior. Using a value of 'basic', 'extended',
1315 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1316 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1317 value 'default' will return to the default matching behavior.
1319 grep.extendedRegexp::
1320 If set to true, enable '--extended-regexp' option by default. This
1321 option is ignored when the 'grep.patternType' option is set to a value
1322 other than 'default'.
1324 gpg.program::
1325 Use this custom program instead of "gpg" found on $PATH when
1326 making or verifying a PGP signature. The program must support the
1327 same command line interface as GPG, namely, to verify a detached
1328 signature, "gpg --verify $file - <$signature" is run, and the
1329 program is expected to signal a good signature by exiting with
1330 code 0, and to generate an ascii-armored detached signature, the
1331 standard input of "gpg -bsau $key" is fed with the contents to be
1332 signed, and the program is expected to send the result to its
1333 standard output.
1335 gui.commitmsgwidth::
1336 Defines how wide the commit message window is in the
1337 linkgit:git-gui[1]. "75" is the default.
1339 gui.diffcontext::
1340 Specifies how many context lines should be used in calls to diff
1341 made by the linkgit:git-gui[1]. The default is "5".
1343 gui.encoding::
1344 Specifies the default encoding to use for displaying of
1345 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1346 It can be overridden by setting the 'encoding' attribute
1347 for relevant files (see linkgit:gitattributes[5]).
1348 If this option is not set, the tools default to the
1349 locale encoding.
1351 gui.matchtrackingbranch::
1352 Determines if new branches created with linkgit:git-gui[1] should
1353 default to tracking remote branches with matching names or
1354 not. Default: "false".
1356 gui.newbranchtemplate::
1357 Is used as suggested name when creating new branches using the
1358 linkgit:git-gui[1].
1360 gui.pruneduringfetch::
1361 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1362 performing a fetch. The default value is "false".
1364 gui.trustmtime::
1365 Determines if linkgit:git-gui[1] should trust the file modification
1366 timestamp or not. By default the timestamps are not trusted.
1368 gui.spellingdictionary::
1369 Specifies the dictionary used for spell checking commit messages in
1370 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1371 off.
1373 gui.fastcopyblame::
1374 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1375 location detection. It makes blame significantly faster on huge
1376 repositories at the expense of less thorough copy detection.
1378 gui.copyblamethreshold::
1379 Specifies the threshold to use in 'git gui blame' original location
1380 detection, measured in alphanumeric characters. See the
1381 linkgit:git-blame[1] manual for more information on copy detection.
1383 gui.blamehistoryctx::
1384 Specifies the radius of history context in days to show in
1385 linkgit:gitk[1] for the selected commit, when the `Show History
1386 Context` menu item is invoked from 'git gui blame'. If this
1387 variable is set to zero, the whole history is shown.
1389 guitool.<name>.cmd::
1390 Specifies the shell command line to execute when the corresponding item
1391 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1392 mandatory for every tool. The command is executed from the root of
1393 the working directory, and in the environment it receives the name of
1394 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1395 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1396 the head is detached, 'CUR_BRANCH' is empty).
1398 guitool.<name>.needsfile::
1399 Run the tool only if a diff is selected in the GUI. It guarantees
1400 that 'FILENAME' is not empty.
1402 guitool.<name>.noconsole::
1403 Run the command silently, without creating a window to display its
1404 output.
1406 guitool.<name>.norescan::
1407 Don't rescan the working directory for changes after the tool
1408 finishes execution.
1410 guitool.<name>.confirm::
1411 Show a confirmation dialog before actually running the tool.
1413 guitool.<name>.argprompt::
1414 Request a string argument from the user, and pass it to the tool
1415 through the 'ARGS' environment variable. Since requesting an
1416 argument implies confirmation, the 'confirm' option has no effect
1417 if this is enabled. If the option is set to 'true', 'yes', or '1',
1418 the dialog uses a built-in generic prompt; otherwise the exact
1419 value of the variable is used.
1421 guitool.<name>.revprompt::
1422 Request a single valid revision from the user, and set the
1423 'REVISION' environment variable. In other aspects this option
1424 is similar to 'argprompt', and can be used together with it.
1426 guitool.<name>.revunmerged::
1427 Show only unmerged branches in the 'revprompt' subdialog.
1428 This is useful for tools similar to merge or rebase, but not
1429 for things like checkout or reset.
1431 guitool.<name>.title::
1432 Specifies the title to use for the prompt dialog. The default
1433 is the tool name.
1435 guitool.<name>.prompt::
1436 Specifies the general prompt string to display at the top of
1437 the dialog, before subsections for 'argprompt' and 'revprompt'.
1438 The default value includes the actual command.
1440 help.browser::
1441 Specify the browser that will be used to display help in the
1442 'web' format. See linkgit:git-help[1].
1444 help.format::
1445 Override the default help format used by linkgit:git-help[1].
1446 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1447 the default. 'web' and 'html' are the same.
1449 help.autocorrect::
1450 Automatically correct and execute mistyped commands after
1451 waiting for the given number of deciseconds (0.1 sec). If more
1452 than one command can be deduced from the entered text, nothing
1453 will be executed. If the value of this option is negative,
1454 the corrected command will be executed immediately. If the
1455 value is 0 - the command will be just shown but not executed.
1456 This is the default.
1458 help.htmlpath::
1459 Specify the path where the HTML documentation resides. File system paths
1460 and URLs are supported. HTML pages will be prefixed with this path when
1461 help is displayed in the 'web' format. This defaults to the documentation
1462 path of your Git installation.
1464 http.proxy::
1465 Override the HTTP proxy, normally configured using the 'http_proxy',
1466 'https_proxy', and 'all_proxy' environment variables (see
1467 `curl(1)`). This can be overridden on a per-remote basis; see
1468 remote.<name>.proxy
1470 http.cookiefile::
1471 File containing previously stored cookie lines which should be used
1472 in the Git http session, if they match the server. The file format
1473 of the file to read cookies from should be plain HTTP headers or
1474 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1475 NOTE that the file specified with http.cookiefile is only used as
1476 input unless http.saveCookies is set.
1478 http.savecookies::
1479 If set, store cookies received during requests to the file specified by
1480 http.cookiefile. Has no effect if http.cookiefile is unset.
1482 http.sslVerify::
1483 Whether to verify the SSL certificate when fetching or pushing
1484 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1485 variable.
1487 http.sslCert::
1488 File containing the SSL certificate when fetching or pushing
1489 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1490 variable.
1492 http.sslKey::
1493 File containing the SSL private key when fetching or pushing
1494 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1495 variable.
1497 http.sslCertPasswordProtected::
1498 Enable Git's password prompt for the SSL certificate. Otherwise
1499 OpenSSL will prompt the user, possibly many times, if the
1500 certificate or private key is encrypted. Can be overridden by the
1501 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1503 http.sslCAInfo::
1504 File containing the certificates to verify the peer with when
1505 fetching or pushing over HTTPS. Can be overridden by the
1506 'GIT_SSL_CAINFO' environment variable.
1508 http.sslCAPath::
1509 Path containing files with the CA certificates to verify the peer
1510 with when fetching or pushing over HTTPS. Can be overridden
1511 by the 'GIT_SSL_CAPATH' environment variable.
1513 http.sslTry::
1514 Attempt to use AUTH SSL/TLS and encrypted data transfers
1515 when connecting via regular FTP protocol. This might be needed
1516 if the FTP server requires it for security reasons or you wish
1517 to connect securely whenever remote FTP server supports it.
1518 Default is false since it might trigger certificate verification
1519 errors on misconfigured servers.
1521 http.maxRequests::
1522 How many HTTP requests to launch in parallel. Can be overridden
1523 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1525 http.minSessions::
1526 The number of curl sessions (counted across slots) to be kept across
1527 requests. They will not be ended with curl_easy_cleanup() until
1528 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1529 value will be capped at 1. Defaults to 1.
1531 http.postBuffer::
1532 Maximum size in bytes of the buffer used by smart HTTP
1533 transports when POSTing data to the remote system.
1534 For requests larger than this buffer size, HTTP/1.1 and
1535 Transfer-Encoding: chunked is used to avoid creating a
1536 massive pack file locally. Default is 1 MiB, which is
1537 sufficient for most requests.
1539 http.lowSpeedLimit, http.lowSpeedTime::
1540 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1541 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1542 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1543 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1545 http.noEPSV::
1546 A boolean which disables using of EPSV ftp command by curl.
1547 This can helpful with some "poor" ftp servers which don't
1548 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1549 environment variable. Default is false (curl will use EPSV).
1551 http.useragent::
1552 The HTTP USER_AGENT string presented to an HTTP server. The default
1553 value represents the version of the client Git such as git/1.7.1.
1554 This option allows you to override this value to a more common value
1555 such as Mozilla/4.0. This may be necessary, for instance, if
1556 connecting through a firewall that restricts HTTP connections to a set
1557 of common USER_AGENT strings (but not including those like git/1.7.1).
1558 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1560 http.<url>.*::
1561 Any of the http.* options above can be applied selectively to some urls.
1562 For a config key to match a URL, each element of the config key is
1563 compared to that of the URL, in the following order:
1564 +
1565 --
1566 . Scheme (e.g., `https` in ``). This field
1567 must match exactly between the config key and the URL.
1569 . Host/domain name (e.g., `` in ``).
1570 This field must match exactly between the config key and the URL.
1572 . Port number (e.g., `8080` in ``).
1573 This field must match exactly between the config key and the URL.
1574 Omitted port numbers are automatically converted to the correct
1575 default for the scheme before matching.
1577 . Path (e.g., `repo.git` in ``). The
1578 path field of the config key must match the path field of the URL
1579 either exactly or as a prefix of slash-delimited path elements. This means
1580 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1581 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1582 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1583 key with just path `foo/`).
1585 . User name (e.g., `user` in ``). If
1586 the config key has a user name it must match the user name in the
1587 URL exactly. If the config key does not have a user name, that
1588 config key will match a URL with any user name (including none),
1589 but at a lower precedence than a config key with a user name.
1590 --
1591 +
1592 The list above is ordered by decreasing precedence; a URL that matches
1593 a config key's path is preferred to one that matches its user name. For example,
1594 if the URL is `` a config key match of
1595 `` will be preferred over a config key match of
1596 ``.
1597 +
1598 All URLs are normalized before attempting any matching (the password part,
1599 if embedded in the URL, is always ignored for matching purposes) so that
1600 equivalent urls that are simply spelled differently will match properly.
1601 Environment variable settings always override any matches. The urls that are
1602 matched against are those given directly to Git commands. This means any URLs
1603 visited as a result of a redirection do not participate in matching.
1605 i18n.commitEncoding::
1606 Character encoding the commit messages are stored in; Git itself
1607 does not care per se, but this information is necessary e.g. when
1608 importing commits from emails or in the gitk graphical history
1609 browser (and possibly at other places in the future or in other
1610 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1612 i18n.logOutputEncoding::
1613 Character encoding the commit messages are converted to when
1614 running 'git log' and friends.
1616 imap::
1617 The configuration variables in the 'imap' section are described
1618 in linkgit:git-imap-send[1].
1620 index.version::
1621 Specify the version with which new index files should be
1622 initialized. This does not affect existing repositories.
1624 init.templatedir::
1625 Specify the directory from which templates will be copied.
1626 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1628 instaweb.browser::
1629 Specify the program that will be used to browse your working
1630 repository in gitweb. See linkgit:git-instaweb[1].
1632 instaweb.httpd::
1633 The HTTP daemon command-line to start gitweb on your working
1634 repository. See linkgit:git-instaweb[1].
1636 instaweb.local::
1637 If true the web server started by linkgit:git-instaweb[1] will
1638 be bound to the local IP (
1640 instaweb.modulepath::
1641 The default module path for linkgit:git-instaweb[1] to use
1642 instead of /usr/lib/apache2/modules. Only used if httpd
1643 is Apache.
1645 instaweb.port::
1646 The port number to bind the gitweb httpd to. See
1647 linkgit:git-instaweb[1].
1649 interactive.singlekey::
1650 In interactive commands, allow the user to provide one-letter
1651 input with a single key (i.e., without hitting enter).
1652 Currently this is used by the `--patch` mode of
1653 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1654 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1655 setting is silently ignored if portable keystroke input
1656 is not available; requires the Perl module Term::ReadKey.
1658 log.abbrevCommit::
1659 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1660 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1661 override this option with `--no-abbrev-commit`.
1664 Set the default date-time mode for the 'log' command.
1665 Setting a value for is similar to using 'git log''s
1666 `--date` option. Possible values are `relative`, `local`,
1667 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1668 for details.
1670 log.decorate::
1671 Print out the ref names of any commits that are shown by the log
1672 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1673 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1674 specified, the full ref name (including prefix) will be printed.
1675 This is the same as the log commands '--decorate' option.
1677 log.showroot::
1678 If true, the initial commit will be shown as a big creation event.
1679 This is equivalent to a diff against an empty tree.
1680 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1681 normally hide the root commit will now show it. True by default.
1683 log.mailmap::
1684 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1685 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1687 mailmap.file::
1688 The location of an augmenting mailmap file. The default
1689 mailmap, located in the root of the repository, is loaded
1690 first, then the mailmap file pointed to by this variable.
1691 The location of the mailmap file may be in a repository
1692 subdirectory, or somewhere outside of the repository itself.
1693 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1695 mailmap.blob::
1696 Like `mailmap.file`, but consider the value as a reference to a
1697 blob in the repository. If both `mailmap.file` and
1698 `mailmap.blob` are given, both are parsed, with entries from
1699 `mailmap.file` taking precedence. In a bare repository, this
1700 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1701 defaults to empty.
1703 man.viewer::
1704 Specify the programs that may be used to display help in the
1705 'man' format. See linkgit:git-help[1].
1707 man.<tool>.cmd::
1708 Specify the command to invoke the specified man viewer. The
1709 specified command is evaluated in shell with the man page
1710 passed as argument. (See linkgit:git-help[1].)
1712 man.<tool>.path::
1713 Override the path for the given tool that may be used to
1714 display help in the 'man' format. See linkgit:git-help[1].
1716 include::merge-config.txt[]
1718 mergetool.<tool>.path::
1719 Override the path for the given tool. This is useful in case
1720 your tool is not in the PATH.
1722 mergetool.<tool>.cmd::
1723 Specify the command to invoke the specified merge tool. The
1724 specified command is evaluated in shell with the following
1725 variables available: 'BASE' is the name of a temporary file
1726 containing the common base of the files to be merged, if available;
1727 'LOCAL' is the name of a temporary file containing the contents of
1728 the file on the current branch; 'REMOTE' is the name of a temporary
1729 file containing the contents of the file from the branch being
1730 merged; 'MERGED' contains the name of the file to which the merge
1731 tool should write the results of a successful merge.
1733 mergetool.<tool>.trustExitCode::
1734 For a custom merge command, specify whether the exit code of
1735 the merge command can be used to determine whether the merge was
1736 successful. If this is not set to true then the merge target file
1737 timestamp is checked and the merge assumed to have been successful
1738 if the file has been updated, otherwise the user is prompted to
1739 indicate the success of the merge.
1741 mergetool.keepBackup::
1742 After performing a merge, the original file with conflict markers
1743 can be saved as a file with a `.orig` extension. If this variable
1744 is set to `false` then this file is not preserved. Defaults to
1745 `true` (i.e. keep the backup files).
1747 mergetool.keepTemporaries::
1748 When invoking a custom merge tool, Git uses a set of temporary
1749 files to pass to the tool. If the tool returns an error and this
1750 variable is set to `true`, then these temporary files will be
1751 preserved, otherwise they will be removed after the tool has
1752 exited. Defaults to `false`.
1754 mergetool.prompt::
1755 Prompt before each invocation of the merge resolution program.
1757 notes.displayRef::
1758 The (fully qualified) refname from which to show notes when
1759 showing commit messages. The value of this variable can be set
1760 to a glob, in which case notes from all matching refs will be
1761 shown. You may also specify this configuration variable
1762 several times. A warning will be issued for refs that do not
1763 exist, but a glob that does not match any refs is silently
1764 ignored.
1765 +
1766 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1767 environment variable, which must be a colon separated list of refs or
1768 globs.
1769 +
1770 The effective value of "core.notesRef" (possibly overridden by
1771 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1772 displayed.
1774 notes.rewrite.<command>::
1775 When rewriting commits with <command> (currently `amend` or
1776 `rebase`) and this variable is set to `true`, Git
1777 automatically copies your notes from the original to the
1778 rewritten commit. Defaults to `true`, but see
1779 "notes.rewriteRef" below.
1781 notes.rewriteMode::
1782 When copying notes during a rewrite (see the
1783 "notes.rewrite.<command>" option), determines what to do if
1784 the target commit already has a note. Must be one of
1785 `overwrite`, `concatenate`, or `ignore`. Defaults to
1786 `concatenate`.
1787 +
1788 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1789 environment variable.
1791 notes.rewriteRef::
1792 When copying notes during a rewrite, specifies the (fully
1793 qualified) ref whose notes should be copied. The ref may be a
1794 glob, in which case notes in all matching refs will be copied.
1795 You may also specify this configuration several times.
1796 +
1797 Does not have a default value; you must configure this variable to
1798 enable note rewriting. Set it to `refs/notes/commits` to enable
1799 rewriting for the default commit notes.
1800 +
1801 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1802 environment variable, which must be a colon separated list of refs or
1803 globs.
1805 pack.window::
1806 The size of the window used by linkgit:git-pack-objects[1] when no
1807 window size is given on the command line. Defaults to 10.
1809 pack.depth::
1810 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1811 maximum depth is given on the command line. Defaults to 50.
1813 pack.windowMemory::
1814 The window memory size limit used by linkgit:git-pack-objects[1]
1815 when no limit is given on the command line. The value can be
1816 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1817 limit.
1819 pack.compression::
1820 An integer -1..9, indicating the compression level for objects
1821 in a pack file. -1 is the zlib default. 0 means no
1822 compression, and 1..9 are various speed/size tradeoffs, 9 being
1823 slowest. If not set, defaults to core.compression. If that is
1824 not set, defaults to -1, the zlib default, which is "a default
1825 compromise between speed and compression (currently equivalent
1826 to level 6)."
1827 +
1828 Note that changing the compression level will not automatically recompress
1829 all existing objects. You can force recompression by passing the -F option
1830 to linkgit:git-repack[1].
1832 pack.deltaCacheSize::
1833 The maximum memory in bytes used for caching deltas in
1834 linkgit:git-pack-objects[1] before writing them out to a pack.
1835 This cache is used to speed up the writing object phase by not
1836 having to recompute the final delta result once the best match
1837 for all objects is found. Repacking large repositories on machines
1838 which are tight with memory might be badly impacted by this though,
1839 especially if this cache pushes the system into swapping.
1840 A value of 0 means no limit. The smallest size of 1 byte may be
1841 used to virtually disable this cache. Defaults to 256 MiB.
1843 pack.deltaCacheLimit::
1844 The maximum size of a delta, that is cached in
1845 linkgit:git-pack-objects[1]. This cache is used to speed up the
1846 writing object phase by not having to recompute the final delta
1847 result once the best match for all objects is found. Defaults to 1000.
1849 pack.threads::
1850 Specifies the number of threads to spawn when searching for best
1851 delta matches. This requires that linkgit:git-pack-objects[1]
1852 be compiled with pthreads otherwise this option is ignored with a
1853 warning. This is meant to reduce packing time on multiprocessor
1854 machines. The required amount of memory for the delta search window
1855 is however multiplied by the number of threads.
1856 Specifying 0 will cause Git to auto-detect the number of CPU's
1857 and set the number of threads accordingly.
1859 pack.indexVersion::
1860 Specify the default pack index version. Valid values are 1 for
1861 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1862 the new pack index with capabilities for packs larger than 4 GB
1863 as well as proper protection against the repacking of corrupted
1864 packs. Version 2 is the default. Note that version 2 is enforced
1865 and this config option ignored whenever the corresponding pack is
1866 larger than 2 GB.
1867 +
1868 If you have an old Git that does not understand the version 2 `*.idx` file,
1869 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1870 that will copy both `*.pack` file and corresponding `*.idx` file from the
1871 other side may give you a repository that cannot be accessed with your
1872 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1873 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1874 the `*.idx` file.
1876 pack.packSizeLimit::
1877 The maximum size of a pack. This setting only affects
1878 packing to a file when repacking, i.e. the git:// protocol
1879 is unaffected. It can be overridden by the `--max-pack-size`
1880 option of linkgit:git-repack[1]. The minimum size allowed is
1881 limited to 1 MiB. The default is unlimited.
1882 Common unit suffixes of 'k', 'm', or 'g' are
1883 supported.
1885 pack.useBitmaps::
1886 When true, git will use pack bitmaps (if available) when packing
1887 to stdout (e.g., during the server side of a fetch). Defaults to
1888 true. You should not generally need to turn this off unless
1889 you are debugging pack bitmaps.
1891 pack.writebitmaps::
1892 When true, git will write a bitmap index when packing all
1893 objects to disk (e.g., when `git repack -a` is run). This
1894 index can speed up the "counting objects" phase of subsequent
1895 packs created for clones and fetches, at the cost of some disk
1896 space and extra time spent on the initial repack. Defaults to
1897 false.
1899 pack.writeBitmapHashCache::
1900 When true, git will include a "hash cache" section in the bitmap
1901 index (if one is written). This cache can be used to feed git's
1902 delta heuristics, potentially leading to better deltas between
1903 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1904 between an older, bitmapped pack and objects that have been
1905 pushed since the last gc). The downside is that it consumes 4
1906 bytes per object of disk space, and that JGit's bitmap
1907 implementation does not understand it, causing it to complain if
1908 Git and JGit are used on the same repository. Defaults to false.
1910 pager.<cmd>::
1911 If the value is boolean, turns on or off pagination of the
1912 output of a particular Git subcommand when writing to a tty.
1913 Otherwise, turns on pagination for the subcommand using the
1914 pager specified by the value of `pager.<cmd>`. If `--paginate`
1915 or `--no-pager` is specified on the command line, it takes
1916 precedence over this option. To disable pagination for all
1917 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1919 pretty.<name>::
1920 Alias for a --pretty= format string, as specified in
1921 linkgit:git-log[1]. Any aliases defined here can be used just
1922 as the built-in pretty formats could. For example,
1923 running `git config pretty.changelog "format:* %H %s"`
1924 would cause the invocation `git log --pretty=changelog`
1925 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1926 Note that an alias with the same name as a built-in format
1927 will be silently ignored.
1929 pull.ff::
1930 By default, Git does not create an extra merge commit when merging
1931 a commit that is a descendant of the current commit. Instead, the
1932 tip of the current branch is fast-forwarded. When set to `false`,
1933 this variable tells Git to create an extra merge commit in such
1934 a case (equivalent to giving the `--no-ff` option from the command
1935 line). When set to `only`, only such fast-forward merges are
1936 allowed (equivalent to giving the `--ff-only` option from the
1937 command line).
1939 pull.rebase::
1940 When true, rebase branches on top of the fetched branch, instead
1941 of merging the default branch from the default remote when "git
1942 pull" is run. See "branch.<name>.rebase" for setting this on a
1943 per-branch basis.
1944 +
1945 When preserve, also pass `--preserve-merges` along to 'git rebase'
1946 so that locally committed merge commits will not be flattened
1947 by running 'git pull'.
1948 +
1949 *NOTE*: this is a possibly dangerous operation; do *not* use
1950 it unless you understand the implications (see linkgit:git-rebase[1]
1951 for details).
1953 pull.octopus::
1954 The default merge strategy to use when pulling multiple branches
1955 at once.
1957 pull.twohead::
1958 The default merge strategy to use when pulling a single branch.
1960 push.default::
1961 Defines the action `git push` should take if no refspec is
1962 explicitly given. Different values are well-suited for
1963 specific workflows; for instance, in a purely central workflow
1964 (i.e. the fetch source is equal to the push destination),
1965 `upstream` is probably what you want. Possible values are:
1966 +
1967 --
1969 * `nothing` - do not push anything (error out) unless a refspec is
1970 explicitly given. This is primarily meant for people who want to
1971 avoid mistakes by always being explicit.
1973 * `current` - push the current branch to update a branch with the same
1974 name on the receiving end. Works in both central and non-central
1975 workflows.
1977 * `upstream` - push the current branch back to the branch whose
1978 changes are usually integrated into the current branch (which is
1979 called `@{upstream}`). This mode only makes sense if you are
1980 pushing to the same repository you would normally pull from
1981 (i.e. central workflow).
1983 * `simple` - in centralized workflow, work like `upstream` with an
1984 added safety to refuse to push if the upstream branch's name is
1985 different from the local one.
1986 +
1987 When pushing to a remote that is different from the remote you normally
1988 pull from, work as `current`. This is the safest option and is suited
1989 for beginners.
1990 +
1991 This mode has become the default in Git 2.0.
1993 * `matching` - push all branches having the same name on both ends.
1994 This makes the repository you are pushing to remember the set of
1995 branches that will be pushed out (e.g. if you always push 'maint'
1996 and 'master' there and no other branches, the repository you push
1997 to will have these two branches, and your local 'maint' and
1998 'master' will be pushed there).
1999 +
2000 To use this mode effectively, you have to make sure _all_ the
2001 branches you would push out are ready to be pushed out before
2002 running 'git push', as the whole point of this mode is to allow you
2003 to push all of the branches in one go. If you usually finish work
2004 on only one branch and push out the result, while other branches are
2005 unfinished, this mode is not for you. Also this mode is not
2006 suitable for pushing into a shared central repository, as other
2007 people may add new branches there, or update the tip of existing
2008 branches outside your control.
2009 +
2010 This used to be the default, but not since Git 2.0 (`simple` is the
2011 new default).
2013 --
2015 rebase.stat::
2016 Whether to show a diffstat of what changed upstream since the last
2017 rebase. False by default.
2019 rebase.autosquash::
2020 If set to true enable '--autosquash' option by default.
2022 rebase.autostash::
2023 When set to true, automatically create a temporary stash
2024 before the operation begins, and apply it after the operation
2025 ends. This means that you can run rebase on a dirty worktree.
2026 However, use with care: the final stash application after a
2027 successful rebase might result in non-trivial conflicts.
2028 Defaults to false.
2030 receive.autogc::
2031 By default, git-receive-pack will run "git-gc --auto" after
2032 receiving data from git-push and updating refs. You can stop
2033 it by setting this variable to false.
2035 receive.fsckObjects::
2036 If it is set to true, git-receive-pack will check all received
2037 objects. It will abort in the case of a malformed object or a
2038 broken link. The result of an abort are only dangling objects.
2039 Defaults to false. If not set, the value of `transfer.fsckObjects`
2040 is used instead.
2042 receive.unpackLimit::
2043 If the number of objects received in a push is below this
2044 limit then the objects will be unpacked into loose object
2045 files. However if the number of received objects equals or
2046 exceeds this limit then the received pack will be stored as
2047 a pack, after adding any missing delta bases. Storing the
2048 pack from a push can make the push operation complete faster,
2049 especially on slow filesystems. If not set, the value of
2050 `transfer.unpackLimit` is used instead.
2052 receive.denyDeletes::
2053 If set to true, git-receive-pack will deny a ref update that deletes
2054 the ref. Use this to prevent such a ref deletion via a push.
2056 receive.denyDeleteCurrent::
2057 If set to true, git-receive-pack will deny a ref update that
2058 deletes the currently checked out branch of a non-bare repository.
2060 receive.denyCurrentBranch::
2061 If set to true or "refuse", git-receive-pack will deny a ref update
2062 to the currently checked out branch of a non-bare repository.
2063 Such a push is potentially dangerous because it brings the HEAD
2064 out of sync with the index and working tree. If set to "warn",
2065 print a warning of such a push to stderr, but allow the push to
2066 proceed. If set to false or "ignore", allow such pushes with no
2067 message. Defaults to "refuse".
2069 receive.denyNonFastForwards::
2070 If set to true, git-receive-pack will deny a ref update which is
2071 not a fast-forward. Use this to prevent such an update via a push,
2072 even if that push is forced. This configuration variable is
2073 set when initializing a shared repository.
2075 receive.hiderefs::
2076 String(s) `receive-pack` uses to decide which refs to omit
2077 from its initial advertisement. Use more than one
2078 definitions to specify multiple prefix strings. A ref that
2079 are under the hierarchies listed on the value of this
2080 variable is excluded, and is hidden when responding to `git
2081 push`, and an attempt to update or delete a hidden ref by
2082 `git push` is rejected.
2084 receive.updateserverinfo::
2085 If set to true, git-receive-pack will run git-update-server-info
2086 after receiving data from git-push and updating refs.
2088 receive.shallowupdate::
2089 If set to true, .git/shallow can be updated when new refs
2090 require new shallow roots. Otherwise those refs are rejected.
2092 remote.pushdefault::
2093 The remote to push to by default. Overrides
2094 `branch.<name>.remote` for all branches, and is overridden by
2095 `branch.<name>.pushremote` for specific branches.
2097 remote.<name>.url::
2098 The URL of a remote repository. See linkgit:git-fetch[1] or
2099 linkgit:git-push[1].
2101 remote.<name>.pushurl::
2102 The push URL of a remote repository. See linkgit:git-push[1].
2104 remote.<name>.proxy::
2105 For remotes that require curl (http, https and ftp), the URL to
2106 the proxy to use for that remote. Set to the empty string to
2107 disable proxying for that remote.
2109 remote.<name>.fetch::
2110 The default set of "refspec" for linkgit:git-fetch[1]. See
2111 linkgit:git-fetch[1].
2113 remote.<name>.push::
2114 The default set of "refspec" for linkgit:git-push[1]. See
2115 linkgit:git-push[1].
2117 remote.<name>.mirror::
2118 If true, pushing to this remote will automatically behave
2119 as if the `--mirror` option was given on the command line.
2121 remote.<name>.skipDefaultUpdate::
2122 If true, this remote will be skipped by default when updating
2123 using linkgit:git-fetch[1] or the `update` subcommand of
2124 linkgit:git-remote[1].
2126 remote.<name>.skipFetchAll::
2127 If true, this remote will be skipped by default when updating
2128 using linkgit:git-fetch[1] or the `update` subcommand of
2129 linkgit:git-remote[1].
2131 remote.<name>.receivepack::
2132 The default program to execute on the remote side when pushing. See
2133 option \--receive-pack of linkgit:git-push[1].
2135 remote.<name>.uploadpack::
2136 The default program to execute on the remote side when fetching. See
2137 option \--upload-pack of linkgit:git-fetch-pack[1].
2139 remote.<name>.tagopt::
2140 Setting this value to \--no-tags disables automatic tag following when
2141 fetching from remote <name>. Setting it to \--tags will fetch every
2142 tag from remote <name>, even if they are not reachable from remote
2143 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2144 override this setting. See options \--tags and \--no-tags of
2145 linkgit:git-fetch[1].
2147 remote.<name>.vcs::
2148 Setting this to a value <vcs> will cause Git to interact with
2149 the remote with the git-remote-<vcs> helper.
2151 remote.<name>.prune::
2152 When set to true, fetching from this remote by default will also
2153 remove any remote-tracking references that no longer exist on the
2154 remote (as if the `--prune` option was given on the command line).
2155 Overrides `fetch.prune` settings, if any.
2157 remotes.<group>::
2158 The list of remotes which are fetched by "git remote update
2159 <group>". See linkgit:git-remote[1].
2161 repack.usedeltabaseoffset::
2162 By default, linkgit:git-repack[1] creates packs that use
2163 delta-base offset. If you need to share your repository with
2164 Git older than version 1.4.4, either directly or via a dumb
2165 protocol such as http, then you need to set this option to
2166 "false" and repack. Access from old Git versions over the
2167 native protocol are unaffected by this option.
2169 repack.packKeptObjects::
2170 If set to true, makes `git repack` act as if
2171 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2172 details. Defaults to `false` normally, but `true` if a bitmap
2173 index is being written (either via `--write-bitmap-index` or
2174 `pack.writeBitmaps`).
2176 rerere.autoupdate::
2177 When set to true, `git-rerere` updates the index with the
2178 resulting contents after it cleanly resolves conflicts using
2179 previously recorded resolution. Defaults to false.
2181 rerere.enabled::
2182 Activate recording of resolved conflicts, so that identical
2183 conflict hunks can be resolved automatically, should they be
2184 encountered again. By default, linkgit:git-rerere[1] is
2185 enabled if there is an `rr-cache` directory under the
2186 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2187 repository.
2189 sendemail.identity::
2190 A configuration identity. When given, causes values in the
2191 'sendemail.<identity>' subsection to take precedence over
2192 values in the 'sendemail' section. The default identity is
2193 the value of 'sendemail.identity'.
2195 sendemail.smtpencryption::
2196 See linkgit:git-send-email[1] for description. Note that this
2197 setting is not subject to the 'identity' mechanism.
2199 sendemail.smtpssl::
2200 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2202 sendemail.smtpsslcertpath::
2203 Path to ca-certificates (either a directory or a single file).
2204 Set it to an empty string to disable certificate verification.
2206 sendemail.<identity>.*::
2207 Identity-specific versions of the 'sendemail.*' parameters
2208 found below, taking precedence over those when the this
2209 identity is selected, through command-line or
2210 'sendemail.identity'.
2212 sendemail.aliasesfile::
2213 sendemail.aliasfiletype::
2214 sendemail.annotate::
2215 sendemail.bcc::
2217 sendemail.cccmd::
2218 sendemail.chainreplyto::
2219 sendemail.confirm::
2220 sendemail.envelopesender::
2221 sendemail.from::
2222 sendemail.multiedit::
2223 sendemail.signedoffbycc::
2224 sendemail.smtppass::
2225 sendemail.suppresscc::
2226 sendemail.suppressfrom::
2228 sendemail.smtpdomain::
2229 sendemail.smtpserver::
2230 sendemail.smtpserverport::
2231 sendemail.smtpserveroption::
2232 sendemail.smtpuser::
2233 sendemail.thread::
2234 sendemail.validate::
2235 See linkgit:git-send-email[1] for description.
2237 sendemail.signedoffcc::
2238 Deprecated alias for 'sendemail.signedoffbycc'.
2240 showbranch.default::
2241 The default set of branches for linkgit:git-show-branch[1].
2242 See linkgit:git-show-branch[1].
2244 status.relativePaths::
2245 By default, linkgit:git-status[1] shows paths relative to the
2246 current directory. Setting this variable to `false` shows paths
2247 relative to the repository root (this was the default for Git
2248 prior to v1.5.4).
2250 status.short::
2251 Set to true to enable --short by default in linkgit:git-status[1].
2252 The option --no-short takes precedence over this variable.
2254 status.branch::
2255 Set to true to enable --branch by default in linkgit:git-status[1].
2256 The option --no-branch takes precedence over this variable.
2258 status.displayCommentPrefix::
2259 If set to true, linkgit:git-status[1] will insert a comment
2260 prefix before each output line (starting with
2261 `core.commentChar`, i.e. `#` by default). This was the
2262 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2263 Defaults to false.
2265 status.showUntrackedFiles::
2266 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2267 files which are not currently tracked by Git. Directories which
2268 contain only untracked files, are shown with the directory name
2269 only. Showing untracked files means that Git needs to lstat() all
2270 all the files in the whole repository, which might be slow on some
2271 systems. So, this variable controls how the commands displays
2272 the untracked files. Possible values are:
2273 +
2274 --
2275 * `no` - Show no untracked files.
2276 * `normal` - Show untracked files and directories.
2277 * `all` - Show also individual files in untracked directories.
2278 --
2279 +
2280 If this variable is not specified, it defaults to 'normal'.
2281 This variable can be overridden with the -u|--untracked-files option
2282 of linkgit:git-status[1] and linkgit:git-commit[1].
2284 status.submodulesummary::
2285 Defaults to false.
2286 If this is set to a non zero number or true (identical to -1 or an
2287 unlimited number), the submodule summary will be enabled and a
2288 summary of commits for modified submodules will be shown (see
2289 --summary-limit option of linkgit:git-submodule[1]). Please note
2290 that the summary output command will be suppressed for all
2291 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2292 for those submodules where `submodule.<name>.ignore=all`. To
2293 also view the summary for ignored submodules you can either use
2294 the --ignore-submodules=dirty command line option or the 'git
2295 submodule summary' command, which shows a similar output but does
2296 not honor these settings.
2298 submodule.<name>.path::
2299 submodule.<name>.url::
2300 submodule.<name>.update::
2301 The path within this project, URL, and the updating strategy
2302 for a submodule. These variables are initially populated
2303 by 'git submodule init'; edit them to override the
2304 URL and other values found in the `.gitmodules` file. See
2305 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2307 submodule.<name>.branch::
2308 The remote branch name for a submodule, used by `git submodule
2309 update --remote`. Set this option to override the value found in
2310 the `.gitmodules` file. See linkgit:git-submodule[1] and
2311 linkgit:gitmodules[5] for details.
2313 submodule.<name>.fetchRecurseSubmodules::
2314 This option can be used to control recursive fetching of this
2315 submodule. It can be overridden by using the --[no-]recurse-submodules
2316 command line option to "git fetch" and "git pull".
2317 This setting will override that from in the linkgit:gitmodules[5]
2318 file.
2320 submodule.<name>.ignore::
2321 Defines under what circumstances "git status" and the diff family show
2322 a submodule as modified. When set to "all", it will never be considered
2323 modified, "dirty" will ignore all changes to the submodules work tree and
2324 takes only differences between the HEAD of the submodule and the commit
2325 recorded in the superproject into account. "untracked" will additionally
2326 let submodules with modified tracked files in their work tree show up.
2327 Using "none" (the default when this option is not set) also shows
2328 submodules that have untracked files in their work tree as changed.
2329 This setting overrides any setting made in .gitmodules for this submodule,
2330 both settings can be overridden on the command line by using the
2331 "--ignore-submodules" option. The 'git submodule' commands are not
2332 affected by this setting.
2334 tar.umask::
2335 This variable can be used to restrict the permission bits of
2336 tar archive entries. The default is 0002, which turns off the
2337 world write bit. The special value "user" indicates that the
2338 archiving user's umask will be used instead. See umask(2) and
2339 linkgit:git-archive[1].
2341 transfer.fsckObjects::
2342 When `fetch.fsckObjects` or `receive.fsckObjects` are
2343 not set, the value of this variable is used instead.
2344 Defaults to false.
2346 transfer.hiderefs::
2347 This variable can be used to set both `receive.hiderefs`
2348 and `uploadpack.hiderefs` at the same time to the same
2349 values. See entries for these other variables.
2351 transfer.unpackLimit::
2352 When `fetch.unpackLimit` or `receive.unpackLimit` are
2353 not set, the value of this variable is used instead.
2354 The default value is 100.
2356 uploadarchive.allowUnreachable::
2357 If true, allow clients to use `git archive --remote` to request
2358 any tree, whether reachable from the ref tips or not. See the
2359 discussion in the `SECURITY` section of
2360 linkgit:git-upload-archive[1] for more details. Defaults to
2361 `false`.
2363 uploadpack.hiderefs::
2364 String(s) `upload-pack` uses to decide which refs to omit
2365 from its initial advertisement. Use more than one
2366 definitions to specify multiple prefix strings. A ref that
2367 are under the hierarchies listed on the value of this
2368 variable is excluded, and is hidden from `git ls-remote`,
2369 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2370 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2372 uploadpack.allowtipsha1inwant::
2373 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2374 to accept a fetch request that asks for an object at the tip
2375 of a hidden ref (by default, such a request is rejected).
2376 see also `uploadpack.hiderefs`.
2378 uploadpack.keepalive::
2379 When `upload-pack` has started `pack-objects`, there may be a
2380 quiet period while `pack-objects` prepares the pack. Normally
2381 it would output progress information, but if `--quiet` was used
2382 for the fetch, `pack-objects` will output nothing at all until
2383 the pack data begins. Some clients and networks may consider
2384 the server to be hung and give up. Setting this option instructs
2385 `upload-pack` to send an empty keepalive packet every
2386 `uploadpack.keepalive` seconds. Setting this option to 0
2387 disables keepalive packets entirely. The default is 5 seconds.
2389 url.<base>.insteadOf::
2390 Any URL that starts with this value will be rewritten to
2391 start, instead, with <base>. In cases where some site serves a
2392 large number of repositories, and serves them with multiple
2393 access methods, and some users need to use different access
2394 methods, this feature allows people to specify any of the
2395 equivalent URLs and have Git automatically rewrite the URL to
2396 the best alternative for the particular user, even for a
2397 never-before-seen repository on the site. When more than one
2398 insteadOf strings match a given URL, the longest match is used.
2400 url.<base>.pushInsteadOf::
2401 Any URL that starts with this value will not be pushed to;
2402 instead, it will be rewritten to start with <base>, and the
2403 resulting URL will be pushed to. In cases where some site serves
2404 a large number of repositories, and serves them with multiple
2405 access methods, some of which do not allow push, this feature
2406 allows people to specify a pull-only URL and have Git
2407 automatically use an appropriate URL to push, even for a
2408 never-before-seen repository on the site. When more than one
2409 pushInsteadOf strings match a given URL, the longest match is
2410 used. If a remote has an explicit pushurl, Git will ignore this
2411 setting for that remote.
2414 Your email address to be recorded in any newly created commits.
2415 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2416 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2419 Your full name to be recorded in any newly created commits.
2420 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2421 environment variables. See linkgit:git-commit-tree[1].
2423 user.signingkey::
2424 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2425 key you want it to automatically when creating a signed tag or
2426 commit, you can override the default selection with this variable.
2427 This option is passed unchanged to gpg's --local-user parameter,
2428 so you may specify a key using any method that gpg supports.
2430 web.browser::
2431 Specify a web browser that may be used by some commands.
2432 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2433 may use it.