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; we say then that the variable is
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored. The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
27 The file consists of sections and variables. A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins. Section names are case-insensitive. Only alphanumeric
30 characters, `-` and `.` are allowed in section names. Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
34 Sections can be further divided into subsections. To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
39 [section "subsection"]
43 Subsection names are case sensitive and can contain any characters except
44 newline (doublequote `"` and backslash can be included by escaping them
45 as `\"` and `\\`, respectively). Section headers cannot span multiple
46 lines. Variables may belong directly to a section or to a given subsection.
47 You can have `[section]` if you have `[section "subsection"]`, but you
50 There is also a deprecated `[section.subsection]` syntax. With this
51 syntax, the subsection name is converted to lower-case and is also
52 compared case sensitively. These subsection names follow the same
53 restrictions as section names.
55 All the other lines (and the remainder of the line after the section
56 header) are recognized as setting variables, in the form
57 'name = value' (or just 'name', which is a short-hand to say that
58 the variable is the boolean "true").
59 The variable names are case-insensitive, allow only alphanumeric characters
60 and `-`, and must start with an alphabetic character.
62 A line that defines a value can be continued to the next line by
63 ending it with a `\`; the backquote and the end-of-line are
64 stripped. Leading whitespaces after 'name =', the remainder of the
65 line after the first comment character '#' or ';', and trailing
66 whitespaces of the line are discarded unless they are enclosed in
67 double quotes. Internal whitespaces within the value are retained
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
73 The following escape sequences (beside `\"` and `\\`) are recognized:
74 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
75 and `\b` for backspace (BS). Other char escape sequences (including octal
76 escape sequences) are invalid.
82 You can include one config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 included file is expanded immediately, as if its contents had been
85 found at the location of the include directive. If the value of the
86 `include.path` variable is a relative path, the path is considered to be
87 relative to the configuration file in which the include directive was
88 found. The value of `include.path` is subject to tilde expansion: `~/`
89 is expanded to the value of `$HOME`, and `~user/` to the specified
90 user's home directory. See below for examples.
97 ; Don't trust file modes
102 external = /usr/local/bin/diff-wrapper
107 merge = refs/heads/devel
111 gitProxy="ssh" for "kernel.org"
112 gitProxy=default-proxy ; for the rest
115 path = /path/to/foo.inc ; include by absolute path
116 path = foo ; expand "foo" relative to the current file
117 path = ~/foo ; expand "foo" in your $HOME directory
123 Values of many variables are treated as a simple string, but there
124 are variables that take values of specific types and there are rules
125 as to how to spell them.
129 When a variable is said to take a boolean value, many
130 synonyms are accepted for 'true' and 'false'; these are all
133 true;; Boolean true can be spelled as `yes`, `on`, `true`,
134 or `1`. Also, a variable defined without `= <value>`
137 false;; Boolean false can be spelled as `no`, `off`,
140 When converting value to the canonical form using '--bool' type
141 specifier; 'git config' will ensure that the output is "true" or
142 "false" (spelled in lowercase).
145 The value for many variables that specify various sizes can
146 be suffixed with `k`, `M`,... to mean "scale the number by
147 1024", "by 1024x1024", etc.
150 The value for a variable that takes a color is a list of
151 colors (at most two, one for foreground and one for background)
152 and attributes (as many as you want), separated by spaces.
154 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
155 `blue`, `magenta`, `cyan` and `white`. The first color given is the
156 foreground; the second is the background.
158 Colors may also be given as numbers between 0 and 255; these use ANSI
159 256-color mode (but note that not all terminals may support this). If
160 your terminal supports it, you may also specify 24-bit RGB values as
163 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
164 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
165 The position of any attributes with respect to the colors
166 (before, after, or in between), doesn't matter. Specific attributes may
167 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
170 For git's pre-defined color slots, the attributes are meant to be reset
171 at the beginning of each item in the colored output. So setting
172 `color.decorate.branch` to `black` will paint that branch name in a
173 plain `black`, even if the previous thing on the same output line (e.g.
174 opening parenthesis before the list of branch names in `log --decorate`
175 output) is set to be painted with `bold` or some other attribute.
176 However, custom log formats may do more complicated and layered
177 coloring, and the negated forms may be useful there.
183 Note that this list is non-comprehensive and not necessarily complete.
184 For command-specific variables, you will find a more detailed description
185 in the appropriate manual page.
187 Other git-related tools may and do use their own variables. When
188 inventing new variables for use in your own tool, make sure their
189 names do not conflict with those that are used by Git itself and
190 other popular tools, and describe them in your documentation.
194 These variables control various optional help messages designed to
195 aid new users. All 'advice.*' variables default to 'true', and you
196 can tell Git that you do not need help by setting these to 'false':
200 Set this variable to 'false' if you want to disable
202 'pushNonFFMatching', 'pushAlreadyExists',
203 'pushFetchFirst', and 'pushNeedsForce'
206 Advice shown when linkgit:git-push[1] fails due to a
207 non-fast-forward update to the current branch.
209 Advice shown when you ran linkgit:git-push[1] and pushed
210 'matching refs' explicitly (i.e. you used ':', or
211 specified a refspec that isn't your current branch) and
212 it resulted in a non-fast-forward error.
214 Shown when linkgit:git-push[1] rejects an update that
215 does not qualify for fast-forwarding (e.g., a tag.)
217 Shown when linkgit:git-push[1] rejects an update that
218 tries to overwrite a remote ref that points at an
219 object we do not have.
221 Shown when linkgit:git-push[1] rejects an update that
222 tries to overwrite a remote ref that points at an
223 object that is not a commit-ish, or make the remote
224 ref point at an object that is not a commit-ish.
226 Show directions on how to proceed from the current
227 state in the output of linkgit:git-status[1], in
228 the template shown when writing commit messages in
229 linkgit:git-commit[1], and in the help message shown
230 by linkgit:git-checkout[1] when switching branch.
232 Advise to consider using the `-u` option to linkgit:git-status[1]
233 when the command takes more than 2 seconds to enumerate untracked
236 Advice shown when linkgit:git-merge[1] refuses to
237 merge to avoid overwriting local changes.
239 Advice shown by various commands when conflicts
240 prevent the operation from being performed.
242 Advice on how to set your identity configuration when
243 your information is guessed from the system username and
246 Advice shown when you used linkgit:git-checkout[1] to
247 move to the detach HEAD state, to instruct how to create
248 a local branch after the fact.
250 Advice that shows the location of the patch file when
251 linkgit:git-am[1] fails to apply it.
253 In case of failure in the output of linkgit:git-rm[1],
254 show directions on how to proceed from the current state.
258 Tells Git if the executable bit of files in the working tree
261 Some filesystems lose the executable bit when a file that is
262 marked as executable is checked out, or checks out an
263 non-executable file with executable bit on.
264 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
265 to see if it handles the executable bit correctly
266 and this variable is automatically set as necessary.
268 A repository, however, may be on a filesystem that handles
269 the filemode correctly, and this variable is set to 'true'
270 when created, but later may be made accessible from another
271 environment that loses the filemode (e.g. exporting ext4 via
272 CIFS mount, visiting a Cygwin created repository with
273 Git for Windows or Eclipse).
274 In such a case it may be necessary to set this variable to 'false'.
275 See linkgit:git-update-index[1].
277 The default is true (when core.filemode is not specified in the config file).
280 If true, this option enables various workarounds to enable
281 Git to work better on filesystems that are not case sensitive,
282 like FAT. For example, if a directory listing finds
283 "makefile" when Git expects "Makefile", Git will assume
284 it is really the same file, and continue to remember it as
287 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
288 will probe and set core.ignoreCase true if appropriate when the repository
291 core.precomposeUnicode::
292 This option is only used by Mac OS implementation of Git.
293 When core.precomposeUnicode=true, Git reverts the unicode decomposition
294 of filenames done by Mac OS. This is useful when sharing a repository
295 between Mac OS and Linux or Windows.
296 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
297 When false, file names are handled fully transparent by Git,
298 which is backward compatible with older versions of Git.
301 If set to true, do not allow checkout of paths that would
302 be considered equivalent to `.git` on an HFS+ filesystem.
303 Defaults to `true` on Mac OS, and `false` elsewhere.
306 If set to true, do not allow checkout of paths that would
307 cause problems with the NTFS filesystem, e.g. conflict with
309 Defaults to `true` on Windows, and `false` elsewhere.
312 If false, the ctime differences between the index and the
313 working tree are ignored; useful when the inode change time
314 is regularly modified by something outside Git (file system
315 crawlers and some backup systems).
316 See linkgit:git-update-index[1]. True by default.
319 Determines which stat fields to match between the index
320 and work tree. The user can set this to 'default' or
321 'minimal'. Default (or explicitly 'default'), is to check
322 all fields, including the sub-second part of mtime and ctime.
325 The commands that output paths (e.g. 'ls-files',
326 'diff'), when not given the `-z` option, will quote
327 "unusual" characters in the pathname by enclosing the
328 pathname in a double-quote pair and with backslashes the
329 same way strings in C source code are quoted. If this
330 variable is set to false, the bytes higher than 0x80 are
331 not quoted but output as verbatim. Note that double
332 quote, backslash and control characters are always
333 quoted without `-z` regardless of the setting of this
337 Sets the line ending type to use in the working directory for
338 files that have the `text` property set. Alternatives are
339 'lf', 'crlf' and 'native', which uses the platform's native
340 line ending. The default value is `native`. See
341 linkgit:gitattributes[5] for more information on end-of-line
345 If true, makes Git check if converting `CRLF` is reversible when
346 end-of-line conversion is active. Git will verify if a command
347 modifies a file in the work tree either directly or indirectly.
348 For example, committing a file followed by checking out the
349 same file should yield the original file in the work tree. If
350 this is not the case for the current setting of
351 `core.autocrlf`, Git will reject the file. The variable can
352 be set to "warn", in which case Git will only warn about an
353 irreversible conversion but continue the operation.
355 CRLF conversion bears a slight chance of corrupting data.
356 When it is enabled, Git will convert CRLF to LF during commit and LF to
357 CRLF during checkout. A file that contains a mixture of LF and
358 CRLF before the commit cannot be recreated by Git. For text
359 files this is the right thing to do: it corrects line endings
360 such that we have only LF line endings in the repository.
361 But for binary files that are accidentally classified as text the
362 conversion can corrupt data.
364 If you recognize such corruption early you can easily fix it by
365 setting the conversion type explicitly in .gitattributes. Right
366 after committing you still have the original file in your work
367 tree and this file is not yet corrupted. You can explicitly tell
368 Git that this file is binary and Git will handle the file
371 Unfortunately, the desired effect of cleaning up text files with
372 mixed line endings and the undesired effect of corrupting binary
373 files cannot be distinguished. In both cases CRLFs are removed
374 in an irreversible way. For text files this is the right thing
375 to do because CRLFs are line endings, while for binary files
376 converting CRLFs corrupts data.
378 Note, this safety check does not mean that a checkout will generate a
379 file identical to the original file for a different setting of
380 `core.eol` and `core.autocrlf`, but only for the current one. For
381 example, a text file with `LF` would be accepted with `core.eol=lf`
382 and could later be checked out with `core.eol=crlf`, in which case the
383 resulting file would contain `CRLF`, although the original file
384 contained `LF`. However, in both work trees the line endings would be
385 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
386 file with mixed line endings would be reported by the `core.safecrlf`
390 Setting this variable to "true" is almost the same as setting
391 the `text` attribute to "auto" on all files except that text
392 files are not guaranteed to be normalized: files that contain
393 `CRLF` in the repository will not be touched. Use this
394 setting if you want to have `CRLF` line endings in your
395 working directory even though the repository does not have
396 normalized line endings. This variable can be set to 'input',
397 in which case no output conversion is performed.
400 If false, symbolic links are checked out as small plain files that
401 contain the link text. linkgit:git-update-index[1] and
402 linkgit:git-add[1] will not change the recorded type to regular
403 file. Useful on filesystems like FAT that do not support
406 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
407 will probe and set core.symlinks false if appropriate when the repository
411 A "proxy command" to execute (as 'command host port') instead
412 of establishing direct connection to the remote server when
413 using the Git protocol for fetching. If the variable value is
414 in the "COMMAND for DOMAIN" format, the command is applied only
415 on hostnames ending with the specified domain string. This variable
416 may be set multiple times and is matched in the given order;
417 the first match wins.
419 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
420 (which always applies universally, without the special "for"
423 The special string `none` can be used as the proxy command to
424 specify that no proxy be used for a given domain pattern.
425 This is useful for excluding servers inside a firewall from
426 proxy use, while defaulting to a common proxy for external domains.
429 If true, Git will avoid using lstat() calls to detect if files have
430 changed by setting the "assume-unchanged" bit for those tracked files
431 which it has updated identically in both the index and working tree.
433 When files are modified outside of Git, the user will need to stage
434 the modified files explicitly (e.g. see 'Examples' section in
435 linkgit:git-update-index[1]).
436 Git will not normally detect changes to those files.
438 This is useful on systems where lstat() calls are very slow, such as
439 CIFS/Microsoft Windows.
443 core.preferSymlinkRefs::
444 Instead of the default "symref" format for HEAD
445 and other symbolic reference files, use symbolic links.
446 This is sometimes needed to work with old scripts that
447 expect HEAD to be a symbolic link.
450 If true this repository is assumed to be 'bare' and has no
451 working directory associated with it. If this is the case a
452 number of commands that require a working directory will be
453 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
455 This setting is automatically guessed by linkgit:git-clone[1] or
456 linkgit:git-init[1] when the repository was created. By default a
457 repository that ends in "/.git" is assumed to be not bare (bare =
458 false), while all other repositories are assumed to be bare (bare
462 Set the path to the root of the working tree.
463 This can be overridden by the GIT_WORK_TREE environment
464 variable and the '--work-tree' command-line option.
465 The value can be an absolute path or relative to the path to
466 the .git directory, which is either specified by --git-dir
467 or GIT_DIR, or automatically discovered.
468 If --git-dir or GIT_DIR is specified but none of
469 --work-tree, GIT_WORK_TREE and core.worktree is specified,
470 the current working directory is regarded as the top level
471 of your working tree.
473 Note that this variable is honored even when set in a configuration
474 file in a ".git" subdirectory of a directory and its value differs
475 from the latter directory (e.g. "/path/to/.git/config" has
476 core.worktree set to "/different/path"), which is most likely a
477 misconfiguration. Running Git commands in the "/path/to" directory will
478 still use "/different/path" as the root of the work tree and can cause
479 confusion unless you know what you are doing (e.g. you are creating a
480 read-only snapshot of the same index to a location different from the
481 repository's usual working tree).
483 core.logAllRefUpdates::
484 Enable the reflog. Updates to a ref <ref> is logged to the file
485 "$GIT_DIR/logs/<ref>", by appending the new and old
486 SHA-1, the date/time and the reason of the update, but
487 only when the file exists. If this configuration
488 variable is set to true, missing "$GIT_DIR/logs/<ref>"
489 file is automatically created for branch heads (i.e. under
490 refs/heads/), remote refs (i.e. under refs/remotes/),
491 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
493 This information can be used to determine what commit
494 was the tip of a branch "2 days ago".
496 This value is true by default in a repository that has
497 a working directory associated with it, and false by
498 default in a bare repository.
500 core.repositoryFormatVersion::
501 Internal variable identifying the repository format and layout
504 core.sharedRepository::
505 When 'group' (or 'true'), the repository is made shareable between
506 several users in a group (making sure all the files and objects are
507 group-writable). When 'all' (or 'world' or 'everybody'), the
508 repository will be readable by all users, additionally to being
509 group-shareable. When 'umask' (or 'false'), Git will use permissions
510 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
511 files in the repository will have this mode value. '0xxx' will override
512 user's umask value (whereas the other options will only override
513 requested parts of the user's umask value). Examples: '0660' will make
514 the repo read/write-able for the owner and group, but inaccessible to
515 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
516 repository that is group-readable but not group-writable.
517 See linkgit:git-init[1]. False by default.
519 core.warnAmbiguousRefs::
520 If true, Git will warn you if the ref name you passed it is ambiguous
521 and might match multiple refs in the repository. True by default.
524 An integer -1..9, indicating a default compression level.
525 -1 is the zlib default. 0 means no compression,
526 and 1..9 are various speed/size tradeoffs, 9 being slowest.
527 If set, this provides a default to other compression variables,
528 such as 'core.looseCompression' and 'pack.compression'.
530 core.looseCompression::
531 An integer -1..9, indicating the compression level for objects that
532 are not in a pack file. -1 is the zlib default. 0 means no
533 compression, and 1..9 are various speed/size tradeoffs, 9 being
534 slowest. If not set, defaults to core.compression. If that is
535 not set, defaults to 1 (best speed).
537 core.packedGitWindowSize::
538 Number of bytes of a pack file to map into memory in a
539 single mapping operation. Larger window sizes may allow
540 your system to process a smaller number of large pack files
541 more quickly. Smaller window sizes will negatively affect
542 performance due to increased calls to the operating system's
543 memory manager, but may improve performance when accessing
544 a large number of large pack files.
546 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
547 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
548 be reasonable for all users/operating systems. You probably do
549 not need to adjust this value.
551 Common unit suffixes of 'k', 'm', or 'g' are supported.
553 core.packedGitLimit::
554 Maximum number of bytes to map simultaneously into memory
555 from pack files. If Git needs to access more than this many
556 bytes at once to complete an operation it will unmap existing
557 regions to reclaim virtual address space within the process.
559 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
560 This should be reasonable for all users/operating systems, except on
561 the largest projects. You probably do not need to adjust this value.
563 Common unit suffixes of 'k', 'm', or 'g' are supported.
565 core.deltaBaseCacheLimit::
566 Maximum number of bytes to reserve for caching base objects
567 that may be referenced by multiple deltified objects. By storing the
568 entire decompressed base objects in a cache Git is able
569 to avoid unpacking and decompressing frequently used base
570 objects multiple times.
572 Default is 96 MiB on all platforms. This should be reasonable
573 for all users/operating systems, except on the largest projects.
574 You probably do not need to adjust this value.
576 Common unit suffixes of 'k', 'm', or 'g' are supported.
578 core.bigFileThreshold::
579 Files larger than this size are stored deflated, without
580 attempting delta compression. Storing large files without
581 delta compression avoids excessive memory usage, at the
582 slight expense of increased disk usage. Additionally files
583 larger than this size are always treated as binary.
585 Default is 512 MiB on all platforms. This should be reasonable
586 for most projects as source code and other text files can still
587 be delta compressed, but larger binary media files won't be.
589 Common unit suffixes of 'k', 'm', or 'g' are supported.
592 In addition to '.gitignore' (per-directory) and
593 '.git/info/exclude', Git looks into this file for patterns
594 of files which are not meant to be tracked. "`~/`" is expanded
595 to the value of `$HOME` and "`~user/`" to the specified user's
596 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
597 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
598 is used instead. See linkgit:gitignore[5].
601 Some commands (e.g. svn and http interfaces) that interactively
602 ask for a password can be told to use an external program given
603 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
604 environment variable. If not set, fall back to the value of the
605 'SSH_ASKPASS' environment variable or, failing that, a simple password
606 prompt. The external program shall be given a suitable prompt as
607 command-line argument and write the password on its STDOUT.
609 core.attributesFile::
610 In addition to '.gitattributes' (per-directory) and
611 '.git/info/attributes', Git looks into this file for attributes
612 (see linkgit:gitattributes[5]). Path expansions are made the same
613 way as for `core.excludesFile`. Its default value is
614 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
615 set or empty, $HOME/.config/git/attributes is used instead.
618 Commands such as `commit` and `tag` that lets you edit
619 messages by launching an editor uses the value of this
620 variable when it is set, and the environment variable
621 `GIT_EDITOR` is not set. See linkgit:git-var[1].
624 Commands such as `commit` and `tag` that lets you edit
625 messages consider a line that begins with this character
626 commented, and removes them after the editor returns
629 If set to "auto", `git-commit` would select a character that is not
630 the beginning character of any line in existing commit messages.
633 Text editor used by `git rebase -i` for editing the rebase instruction file.
634 The value is meant to be interpreted by the shell when it is used.
635 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
636 When not configured the default commit message editor is used instead.
639 Text viewer for use by Git commands (e.g., 'less'). The value
640 is meant to be interpreted by the shell. The order of preference
641 is the `$GIT_PAGER` environment variable, then `core.pager`
642 configuration, then `$PAGER`, and then the default chosen at
643 compile time (usually 'less').
645 When the `LESS` environment variable is unset, Git sets it to `FRX`
646 (if `LESS` environment variable is set, Git does not change it at
647 all). If you want to selectively override Git's default setting
648 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
649 be passed to the shell by Git, which will translate the final
650 command to `LESS=FRX less -S`. The environment does not set the
651 `S` option but the command line does, instructing less to truncate
652 long lines. Similarly, setting `core.pager` to `less -+F` will
653 deactivate the `F` option specified by the environment from the
654 command-line, deactivating the "quit if one screen" behavior of
655 `less`. One can specifically activate some flags for particular
656 commands: for example, setting `pager.blame` to `less -S` enables
657 line truncation only for `git blame`.
659 Likewise, when the `LV` environment variable is unset, Git sets it
660 to `-c`. You can override this setting by exporting `LV` with
661 another value or setting `core.pager` to `lv +c`.
664 A comma separated list of common whitespace problems to
665 notice. 'git diff' will use `color.diff.whitespace` to
666 highlight them, and 'git apply --whitespace=error' will
667 consider them as errors. You can prefix `-` to disable
668 any of them (e.g. `-trailing-space`):
670 * `blank-at-eol` treats trailing whitespaces at the end of the line
671 as an error (enabled by default).
672 * `space-before-tab` treats a space character that appears immediately
673 before a tab character in the initial indent part of the line as an
674 error (enabled by default).
675 * `indent-with-non-tab` treats a line that is indented with space
676 characters instead of the equivalent tabs as an error (not enabled by
678 * `tab-in-indent` treats a tab character in the initial indent part of
679 the line as an error (not enabled by default).
680 * `blank-at-eof` treats blank lines added at the end of file as an error
681 (enabled by default).
682 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
684 * `cr-at-eol` treats a carriage-return at the end of line as
685 part of the line terminator, i.e. with it, `trailing-space`
686 does not trigger if the character before such a carriage-return
687 is not a whitespace (not enabled by default).
688 * `tabwidth=<n>` tells how many character positions a tab occupies; this
689 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
690 errors. The default tab width is 8. Allowed values are 1 to 63.
692 core.fsyncObjectFiles::
693 This boolean will enable 'fsync()' when writing object files.
695 This is a total waste of time and effort on a filesystem that orders
696 data writes properly, but can be useful for filesystems that do not use
697 journalling (traditional UNIX filesystems) or that only journal metadata
698 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
701 Enable parallel index preload for operations like 'git diff'
703 This can speed up operations like 'git diff' and 'git status' especially
704 on filesystems like NFS that have weak caching semantics and thus
705 relatively high IO latencies. When enabled, Git will do the
706 index comparison to the filesystem data in parallel, allowing
707 overlapping IO's. Defaults to true.
710 You can set this to 'link', in which case a hardlink followed by
711 a delete of the source are used to make sure that object creation
712 will not overwrite existing objects.
714 On some file system/operating system combinations, this is unreliable.
715 Set this config setting to 'rename' there; However, This will remove the
716 check that makes sure that existing object files will not get overwritten.
719 When showing commit messages, also show notes which are stored in
720 the given ref. The ref must be fully qualified. If the given
721 ref does not exist, it is not an error but means that no
722 notes should be printed.
724 This setting defaults to "refs/notes/commits", and it can be overridden by
725 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
727 core.sparseCheckout::
728 Enable "sparse checkout" feature. See section "Sparse checkout" in
729 linkgit:git-read-tree[1] for more information.
732 Set the length object names are abbreviated to. If unspecified,
733 many commands abbreviate to 7 hexdigits, which may not be enough
734 for abbreviated object names to stay unique for sufficiently long
738 add.ignore-errors (deprecated)::
739 Tells 'git add' to continue adding files when some files cannot be
740 added due to indexing errors. Equivalent to the '--ignore-errors'
741 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
742 as it does not follow the usual naming convention for configuration
746 Command aliases for the linkgit:git[1] command wrapper - e.g.
747 after defining "alias.last = cat-file commit HEAD", the invocation
748 "git last" is equivalent to "git cat-file commit HEAD". To avoid
749 confusion and troubles with script usage, aliases that
750 hide existing Git commands are ignored. Arguments are split by
751 spaces, the usual shell quoting and escaping is supported.
752 A quote pair or a backslash can be used to quote them.
754 If the alias expansion is prefixed with an exclamation point,
755 it will be treated as a shell command. For example, defining
756 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
757 "git new" is equivalent to running the shell command
758 "gitk --all --not ORIG_HEAD". Note that shell commands will be
759 executed from the top-level directory of a repository, which may
760 not necessarily be the current directory.
761 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
762 from the original current directory. See linkgit:git-rev-parse[1].
765 If true, git-am will call git-mailsplit for patches in mbox format
766 with parameter '--keep-cr'. In this case git-mailsplit will
767 not remove `\r` from lines ending with `\r\n`. Can be overridden
768 by giving '--no-keep-cr' from the command line.
769 See linkgit:git-am[1], linkgit:git-mailsplit[1].
771 apply.ignoreWhitespace::
772 When set to 'change', tells 'git apply' to ignore changes in
773 whitespace, in the same way as the '--ignore-space-change'
775 When set to one of: no, none, never, false tells 'git apply' to
776 respect all whitespace differences.
777 See linkgit:git-apply[1].
780 Tells 'git apply' how to handle whitespaces, in the same way
781 as the '--whitespace' option. See linkgit:git-apply[1].
783 branch.autoSetupMerge::
784 Tells 'git branch' and 'git checkout' to set up new branches
785 so that linkgit:git-pull[1] will appropriately merge from the
786 starting point branch. Note that even if this option is not set,
787 this behavior can be chosen per-branch using the `--track`
788 and `--no-track` options. The valid settings are: `false` -- no
789 automatic setup is done; `true` -- automatic setup is done when the
790 starting point is a remote-tracking branch; `always` --
791 automatic setup is done when the starting point is either a
792 local branch or remote-tracking
793 branch. This option defaults to true.
795 branch.autoSetupRebase::
796 When a new branch is created with 'git branch' or 'git checkout'
797 that tracks another branch, this variable tells Git to set
798 up pull to rebase instead of merge (see "branch.<name>.rebase").
799 When `never`, rebase is never automatically set to true.
800 When `local`, rebase is set to true for tracked branches of
801 other local branches.
802 When `remote`, rebase is set to true for tracked branches of
803 remote-tracking branches.
804 When `always`, rebase will be set to true for all tracking
806 See "branch.autoSetupMerge" for details on how to set up a
807 branch to track another branch.
808 This option defaults to never.
810 branch.<name>.remote::
811 When on branch <name>, it tells 'git fetch' and 'git push'
812 which remote to fetch from/push to. The remote to push to
813 may be overridden with `remote.pushDefault` (for all branches).
814 The remote to push to, for the current branch, may be further
815 overridden by `branch.<name>.pushRemote`. If no remote is
816 configured, or if you are not on any branch, it defaults to
817 `origin` for fetching and `remote.pushDefault` for pushing.
818 Additionally, `.` (a period) is the current local repository
819 (a dot-repository), see `branch.<name>.merge`'s final note below.
821 branch.<name>.pushRemote::
822 When on branch <name>, it overrides `branch.<name>.remote` for
823 pushing. It also overrides `remote.pushDefault` for pushing
824 from branch <name>. When you pull from one place (e.g. your
825 upstream) and push to another place (e.g. your own publishing
826 repository), you would want to set `remote.pushDefault` to
827 specify the remote to push to for all branches, and use this
828 option to override it for a specific branch.
830 branch.<name>.merge::
831 Defines, together with branch.<name>.remote, the upstream branch
832 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
833 branch to merge and can also affect 'git push' (see push.default).
834 When in branch <name>, it tells 'git fetch' the default
835 refspec to be marked for merging in FETCH_HEAD. The value is
836 handled like the remote part of a refspec, and must match a
837 ref which is fetched from the remote given by
838 "branch.<name>.remote".
839 The merge information is used by 'git pull' (which at first calls
840 'git fetch') to lookup the default branch for merging. Without
841 this option, 'git pull' defaults to merge the first refspec fetched.
842 Specify multiple values to get an octopus merge.
843 If you wish to setup 'git pull' so that it merges into <name> from
844 another branch in the local repository, you can point
845 branch.<name>.merge to the desired branch, and use the relative path
846 setting `.` (a period) for branch.<name>.remote.
848 branch.<name>.mergeOptions::
849 Sets default options for merging into branch <name>. The syntax and
850 supported options are the same as those of linkgit:git-merge[1], but
851 option values containing whitespace characters are currently not
854 branch.<name>.rebase::
855 When true, rebase the branch <name> on top of the fetched branch,
856 instead of merging the default branch from the default remote when
857 "git pull" is run. See "pull.rebase" for doing this in a non
858 branch-specific manner.
860 When preserve, also pass `--preserve-merges` along to 'git rebase'
861 so that locally committed merge commits will not be flattened
862 by running 'git pull'.
864 *NOTE*: this is a possibly dangerous operation; do *not* use
865 it unless you understand the implications (see linkgit:git-rebase[1]
868 branch.<name>.description::
869 Branch description, can be edited with
870 `git branch --edit-description`. Branch description is
871 automatically added in the format-patch cover letter or
872 request-pull summary.
875 Specify the command to invoke the specified browser. The
876 specified command is evaluated in shell with the URLs passed
877 as arguments. (See linkgit:git-web{litdd}browse[1].)
879 browser.<tool>.path::
880 Override the path for the given tool that may be used to
881 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
882 working repository in gitweb (see linkgit:git-instaweb[1]).
885 A boolean to make git-clean do nothing unless given -f,
886 -i or -n. Defaults to true.
889 A boolean to enable/disable color in the output of
890 linkgit:git-branch[1]. May be set to `always`,
891 `false` (or `never`) or `auto` (or `true`), in which case colors are used
892 only when the output is to a terminal. Defaults to false.
894 color.branch.<slot>::
895 Use customized color for branch coloration. `<slot>` is one of
896 `current` (the current branch), `local` (a local branch),
897 `remote` (a remote-tracking branch in refs/remotes/),
898 `upstream` (upstream tracking branch), `plain` (other
902 Whether to use ANSI escape sequences to add color to patches.
903 If this is set to `always`, linkgit:git-diff[1],
904 linkgit:git-log[1], and linkgit:git-show[1] will use color
905 for all patches. If it is set to `true` or `auto`, those
906 commands will only use color when output is to the terminal.
909 This does not affect linkgit:git-format-patch[1] or the
910 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
911 command line with the `--color[=<when>]` option.
914 Use customized color for diff colorization. `<slot>` specifies
915 which part of the patch to use the specified color, and is one
916 of `context` (context text - `plain` is a historical synonym),
917 `meta` (metainformation), `frag`
918 (hunk header), 'func' (function in hunk header), `old` (removed lines),
919 `new` (added lines), `commit` (commit headers), or `whitespace`
920 (highlighting whitespace errors).
922 color.decorate.<slot>::
923 Use customized color for 'git log --decorate' output. `<slot>` is one
924 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
925 branches, remote-tracking branches, tags, stash and HEAD, respectively.
928 When set to `always`, always highlight matches. When `false` (or
929 `never`), never. When set to `true` or `auto`, use color only
930 when the output is written to the terminal. Defaults to `false`.
933 Use customized color for grep colorization. `<slot>` specifies which
934 part of the line to use the specified color, and is one of
938 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
940 filename prefix (when not using `-h`)
942 function name lines (when using `-p`)
944 line number prefix (when using `-n`)
946 matching text (same as setting `matchContext` and `matchSelected`)
948 matching text in context lines
950 matching text in selected lines
952 non-matching text in selected lines
954 separators between fields on a line (`:`, `-`, and `=`)
955 and between hunks (`--`)
959 When set to `always`, always use colors for interactive prompts
960 and displays (such as those used by "git-add --interactive" and
961 "git-clean --interactive"). When false (or `never`), never.
962 When set to `true` or `auto`, use colors only when the output is
963 to the terminal. Defaults to false.
965 color.interactive.<slot>::
966 Use customized color for 'git add --interactive' and 'git clean
967 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
968 or `error`, for four distinct types of normal output from
969 interactive commands.
972 A boolean to enable/disable colored output when the pager is in
973 use (default is true).
976 A boolean to enable/disable color in the output of
977 linkgit:git-show-branch[1]. May be set to `always`,
978 `false` (or `never`) or `auto` (or `true`), in which case colors are used
979 only when the output is to a terminal. Defaults to false.
982 A boolean to enable/disable color in the output of
983 linkgit:git-status[1]. May be set to `always`,
984 `false` (or `never`) or `auto` (or `true`), in which case colors are used
985 only when the output is to a terminal. Defaults to false.
987 color.status.<slot>::
988 Use customized color for status colorization. `<slot>` is
989 one of `header` (the header text of the status message),
990 `added` or `updated` (files which are added but not committed),
991 `changed` (files which are changed but not added in the index),
992 `untracked` (files which are not tracked by Git),
993 `branch` (the current branch),
994 `nobranch` (the color the 'no branch' warning is shown in, defaulting
996 `unmerged` (files which have unmerged changes).
999 This variable determines the default value for variables such
1000 as `color.diff` and `color.grep` that control the use of color
1001 per command family. Its scope will expand as more commands learn
1002 configuration to set a default for the `--color` option. Set it
1003 to `false` or `never` if you prefer Git commands not to use
1004 color unless enabled explicitly with some other configuration
1005 or the `--color` option. Set it to `always` if you want all
1006 output not intended for machine consumption to use color, to
1007 `true` or `auto` (this is the default since Git 1.8.4) if you
1008 want such output to use color when written to the terminal.
1011 Specify whether supported commands should output in columns.
1012 This variable consists of a list of tokens separated by spaces
1015 These options control when the feature should be enabled
1016 (defaults to 'never'):
1020 always show in columns
1022 never show in columns
1024 show in columns if the output is to the terminal
1027 These options control layout (defaults to 'column'). Setting any
1028 of these implies 'always' if none of 'always', 'never', or 'auto' are
1033 fill columns before rows
1035 fill rows before columns
1040 Finally, these options can be combined with a layout option (defaults
1045 make unequal size columns to utilize more space
1047 make equal size columns
1051 Specify whether to output branch listing in `git branch` in columns.
1052 See `column.ui` for details.
1055 Specify the layout when list items in `git clean -i`, which always
1056 shows files and directories in columns. See `column.ui` for details.
1059 Specify whether to output untracked files in `git status` in columns.
1060 See `column.ui` for details.
1063 Specify whether to output tag listing in `git tag` in columns.
1064 See `column.ui` for details.
1067 This setting overrides the default of the `--cleanup` option in
1068 `git commit`. See linkgit:git-commit[1] for details. Changing the
1069 default can be useful when you always want to keep lines that begin
1070 with comment character `#` in your log message, in which case you
1071 would do `git config commit.cleanup whitespace` (note that you will
1072 have to remove the help lines that begin with `#` in the commit log
1073 template yourself, if you do this).
1077 A boolean to specify whether all commits should be GPG signed.
1078 Use of this option when doing operations such as rebase can
1079 result in a large number of commits being signed. It may be
1080 convenient to use an agent to avoid typing your GPG passphrase
1084 A boolean to enable/disable inclusion of status information in the
1085 commit message template when using an editor to prepare the commit
1086 message. Defaults to true.
1089 Specify a file to use as the template for new commit messages.
1090 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1091 specified user's home directory.
1094 Specify an external helper to be called when a username or
1095 password credential is needed; the helper may consult external
1096 storage to avoid prompting the user for the credentials. See
1097 linkgit:gitcredentials[7] for details.
1099 credential.useHttpPath::
1100 When acquiring credentials, consider the "path" component of an http
1101 or https URL to be important. Defaults to false. See
1102 linkgit:gitcredentials[7] for more information.
1104 credential.username::
1105 If no username is set for a network authentication, use this username
1106 by default. See credential.<context>.* below, and
1107 linkgit:gitcredentials[7].
1109 credential.<url>.*::
1110 Any of the credential.* options above can be applied selectively to
1111 some credentials. For example "credential.https://example.com.username"
1112 would set the default username only for https connections to
1113 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1116 include::diff-config.txt[]
1118 difftool.<tool>.path::
1119 Override the path for the given tool. This is useful in case
1120 your tool is not in the PATH.
1122 difftool.<tool>.cmd::
1123 Specify the command to invoke the specified diff tool.
1124 The specified command is evaluated in shell with the following
1125 variables available: 'LOCAL' is set to the name of the temporary
1126 file containing the contents of the diff pre-image and 'REMOTE'
1127 is set to the name of the temporary file containing the contents
1128 of the diff post-image.
1131 Prompt before each invocation of the diff tool.
1133 fetch.recurseSubmodules::
1134 This option can be either set to a boolean value or to 'on-demand'.
1135 Setting it to a boolean changes the behavior of fetch and pull to
1136 unconditionally recurse into submodules when set to true or to not
1137 recurse at all when set to false. When set to 'on-demand' (the default
1138 value), fetch and pull will only recurse into a populated submodule
1139 when its superproject retrieves a commit that updates the submodule's
1143 If it is set to true, git-fetch-pack will check all fetched
1144 objects. It will abort in the case of a malformed object or a
1145 broken link. The result of an abort are only dangling objects.
1146 Defaults to false. If not set, the value of `transfer.fsckObjects`
1150 If the number of objects fetched over the Git native
1151 transfer is below this
1152 limit, then the objects will be unpacked into loose object
1153 files. However if the number of received objects equals or
1154 exceeds this limit then the received pack will be stored as
1155 a pack, after adding any missing delta bases. Storing the
1156 pack from a push can make the push operation complete faster,
1157 especially on slow filesystems. If not set, the value of
1158 `transfer.unpackLimit` is used instead.
1161 If true, fetch will automatically behave as if the `--prune`
1162 option was given on the command line. See also `remote.<name>.prune`.
1165 Enable multipart/mixed attachments as the default for
1166 'format-patch'. The value can also be a double quoted string
1167 which will enable attachments as the default and set the
1168 value as the boundary. See the --attach option in
1169 linkgit:git-format-patch[1].
1172 A boolean which can enable or disable sequence numbers in patch
1173 subjects. It defaults to "auto" which enables it only if there
1174 is more than one patch. It can be enabled or disabled for all
1175 messages by setting it to "true" or "false". See --numbered
1176 option in linkgit:git-format-patch[1].
1179 Additional email headers to include in a patch to be submitted
1180 by mail. See linkgit:git-format-patch[1].
1184 Additional recipients to include in a patch to be submitted
1185 by mail. See the --to and --cc options in
1186 linkgit:git-format-patch[1].
1188 format.subjectPrefix::
1189 The default for format-patch is to output files with the '[PATCH]'
1190 subject prefix. Use this variable to change that prefix.
1193 The default for format-patch is to output a signature containing
1194 the Git version number. Use this variable to change that default.
1195 Set this variable to the empty string ("") to suppress
1196 signature generation.
1198 format.signatureFile::
1199 Works just like format.signature except the contents of the
1200 file specified by this variable will be used as the signature.
1203 The default for format-patch is to output files with the suffix
1204 `.patch`. Use this variable to change that suffix (make sure to
1205 include the dot if you want it).
1208 The default pretty format for log/show/whatchanged command,
1209 See linkgit:git-log[1], linkgit:git-show[1],
1210 linkgit:git-whatchanged[1].
1213 The default threading style for 'git format-patch'. Can be
1214 a boolean value, or `shallow` or `deep`. `shallow` threading
1215 makes every mail a reply to the head of the series,
1216 where the head is chosen from the cover letter, the
1217 `--in-reply-to`, and the first patch mail, in this order.
1218 `deep` threading makes every mail a reply to the previous one.
1219 A true boolean value is the same as `shallow`, and a false
1220 value disables threading.
1223 A boolean value which lets you enable the `-s/--signoff` option of
1224 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1225 patch should be a conscious act and means that you certify you have
1226 the rights to submit this work under the same open source license.
1227 Please see the 'SubmittingPatches' document for further discussion.
1229 format.coverLetter::
1230 A boolean that controls whether to generate a cover-letter when
1231 format-patch is invoked, but in addition can be set to "auto", to
1232 generate a cover-letter only when there's more than one patch.
1234 filter.<driver>.clean::
1235 The command which is used to convert the content of a worktree
1236 file to a blob upon checkin. See linkgit:gitattributes[5] for
1239 filter.<driver>.smudge::
1240 The command which is used to convert the content of a blob
1241 object to a worktree file upon checkout. See
1242 linkgit:gitattributes[5] for details.
1244 gc.aggressiveDepth::
1245 The depth parameter used in the delta compression
1246 algorithm used by 'git gc --aggressive'. This defaults
1249 gc.aggressiveWindow::
1250 The window size parameter used in the delta compression
1251 algorithm used by 'git gc --aggressive'. This defaults
1255 When there are approximately more than this many loose
1256 objects in the repository, `git gc --auto` will pack them.
1257 Some Porcelain commands use this command to perform a
1258 light-weight garbage collection from time to time. The
1259 default value is 6700. Setting this to 0 disables it.
1262 When there are more than this many packs that are not
1263 marked with `*.keep` file in the repository, `git gc
1264 --auto` consolidates them into one larger pack. The
1265 default value is 50. Setting this to 0 disables it.
1268 Make `git gc --auto` return immediately and run in background
1269 if the system supports it. Default is true.
1272 Running `git pack-refs` in a repository renders it
1273 unclonable by Git versions prior to 1.5.1.2 over dumb
1274 transports such as HTTP. This variable determines whether
1275 'git gc' runs `git pack-refs`. This can be set to `notbare`
1276 to enable it within all non-bare repos or it can be set to a
1277 boolean value. The default is `true`.
1280 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1281 Override the grace period with this config variable. The value
1282 "now" may be used to disable this grace period and always prune
1283 unreachable objects immediately.
1286 gc.<pattern>.reflogExpire::
1287 'git reflog expire' removes reflog entries older than
1288 this time; defaults to 90 days. With "<pattern>" (e.g.
1289 "refs/stash") in the middle the setting applies only to
1290 the refs that match the <pattern>.
1292 gc.reflogExpireUnreachable::
1293 gc.<ref>.reflogExpireUnreachable::
1294 'git reflog expire' removes reflog entries older than
1295 this time and are not reachable from the current tip;
1296 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1297 in the middle, the setting applies only to the refs that
1298 match the <pattern>.
1301 Records of conflicted merge you resolved earlier are
1302 kept for this many days when 'git rerere gc' is run.
1303 The default is 60 days. See linkgit:git-rerere[1].
1305 gc.rerereUnresolved::
1306 Records of conflicted merge you have not resolved are
1307 kept for this many days when 'git rerere gc' is run.
1308 The default is 15 days. See linkgit:git-rerere[1].
1310 gitcvs.commitMsgAnnotation::
1311 Append this string to each commit message. Set to empty string
1312 to disable this feature. Defaults to "via git-CVS emulator".
1315 Whether the CVS server interface is enabled for this repository.
1316 See linkgit:git-cvsserver[1].
1319 Path to a log file where the CVS server interface well... logs
1320 various stuff. See linkgit:git-cvsserver[1].
1322 gitcvs.usecrlfattr::
1323 If true, the server will look up the end-of-line conversion
1324 attributes for files to determine the '-k' modes to use. If
1325 the attributes force Git to treat a file as text,
1326 the '-k' mode will be left blank so CVS clients will
1327 treat it as text. If they suppress text conversion, the file
1328 will be set with '-kb' mode, which suppresses any newline munging
1329 the client might otherwise do. If the attributes do not allow
1330 the file type to be determined, then 'gitcvs.allBinary' is
1331 used. See linkgit:gitattributes[5].
1334 This is used if 'gitcvs.usecrlfattr' does not resolve
1335 the correct '-kb' mode to use. If true, all
1336 unresolved files are sent to the client in
1337 mode '-kb'. This causes the client to treat them
1338 as binary files, which suppresses any newline munging it
1339 otherwise might do. Alternatively, if it is set to "guess",
1340 then the contents of the file are examined to decide if
1341 it is binary, similar to 'core.autocrlf'.
1344 Database used by git-cvsserver to cache revision information
1345 derived from the Git repository. The exact meaning depends on the
1346 used database driver, for SQLite (which is the default driver) this
1347 is a filename. Supports variable substitution (see
1348 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1349 Default: '%Ggitcvs.%m.sqlite'
1352 Used Perl DBI driver. You can specify any available driver
1353 for this here, but it might not work. git-cvsserver is tested
1354 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1355 reported *not* to work with 'DBD::mysql'. Experimental feature.
1356 May not contain double colons (`:`). Default: 'SQLite'.
1357 See linkgit:git-cvsserver[1].
1359 gitcvs.dbUser, gitcvs.dbPass::
1360 Database user and password. Only useful if setting 'gitcvs.dbDriver',
1361 since SQLite has no concept of database users and/or passwords.
1362 'gitcvs.dbUser' supports variable substitution (see
1363 linkgit:git-cvsserver[1] for details).
1365 gitcvs.dbTableNamePrefix::
1366 Database table name prefix. Prepended to the names of any
1367 database tables used, allowing a single database to be used
1368 for several repositories. Supports variable substitution (see
1369 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1370 characters will be replaced with underscores.
1372 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1373 'gitcvs.allBinary' can also be specified as
1374 'gitcvs.<access_method>.<varname>' (where 'access_method'
1375 is one of "ext" and "pserver") to make them apply only for the given
1379 gitweb.description::
1382 See linkgit:gitweb[1] for description.
1390 gitweb.remote_heads::
1393 See linkgit:gitweb.conf[5] for description.
1396 If set to true, enable '-n' option by default.
1399 Set the default matching behavior. Using a value of 'basic', 'extended',
1400 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1401 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1402 value 'default' will return to the default matching behavior.
1404 grep.extendedRegexp::
1405 If set to true, enable '--extended-regexp' option by default. This
1406 option is ignored when the 'grep.patternType' option is set to a value
1407 other than 'default'.
1410 Use this custom program instead of "gpg" found on $PATH when
1411 making or verifying a PGP signature. The program must support the
1412 same command-line interface as GPG, namely, to verify a detached
1413 signature, "gpg --verify $file - <$signature" is run, and the
1414 program is expected to signal a good signature by exiting with
1415 code 0, and to generate an ASCII-armored detached signature, the
1416 standard input of "gpg -bsau $key" is fed with the contents to be
1417 signed, and the program is expected to send the result to its
1420 gui.commitMsgWidth::
1421 Defines how wide the commit message window is in the
1422 linkgit:git-gui[1]. "75" is the default.
1425 Specifies how many context lines should be used in calls to diff
1426 made by the linkgit:git-gui[1]. The default is "5".
1428 gui.displayUntracked::
1429 Determines if linkgit::git-gui[1] shows untracked files
1430 in the file list. The default is "true".
1433 Specifies the default encoding to use for displaying of
1434 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1435 It can be overridden by setting the 'encoding' attribute
1436 for relevant files (see linkgit:gitattributes[5]).
1437 If this option is not set, the tools default to the
1440 gui.matchTrackingBranch::
1441 Determines if new branches created with linkgit:git-gui[1] should
1442 default to tracking remote branches with matching names or
1443 not. Default: "false".
1445 gui.newBranchTemplate::
1446 Is used as suggested name when creating new branches using the
1449 gui.pruneDuringFetch::
1450 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1451 performing a fetch. The default value is "false".
1454 Determines if linkgit:git-gui[1] should trust the file modification
1455 timestamp or not. By default the timestamps are not trusted.
1457 gui.spellingDictionary::
1458 Specifies the dictionary used for spell checking commit messages in
1459 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1463 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1464 location detection. It makes blame significantly faster on huge
1465 repositories at the expense of less thorough copy detection.
1467 gui.copyBlameThreshold::
1468 Specifies the threshold to use in 'git gui blame' original location
1469 detection, measured in alphanumeric characters. See the
1470 linkgit:git-blame[1] manual for more information on copy detection.
1472 gui.blamehistoryctx::
1473 Specifies the radius of history context in days to show in
1474 linkgit:gitk[1] for the selected commit, when the `Show History
1475 Context` menu item is invoked from 'git gui blame'. If this
1476 variable is set to zero, the whole history is shown.
1478 guitool.<name>.cmd::
1479 Specifies the shell command line to execute when the corresponding item
1480 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1481 mandatory for every tool. The command is executed from the root of
1482 the working directory, and in the environment it receives the name of
1483 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1484 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1485 the head is detached, 'CUR_BRANCH' is empty).
1487 guitool.<name>.needsFile::
1488 Run the tool only if a diff is selected in the GUI. It guarantees
1489 that 'FILENAME' is not empty.
1491 guitool.<name>.noConsole::
1492 Run the command silently, without creating a window to display its
1495 guitool.<name>.noRescan::
1496 Don't rescan the working directory for changes after the tool
1499 guitool.<name>.confirm::
1500 Show a confirmation dialog before actually running the tool.
1502 guitool.<name>.argPrompt::
1503 Request a string argument from the user, and pass it to the tool
1504 through the 'ARGS' environment variable. Since requesting an
1505 argument implies confirmation, the 'confirm' option has no effect
1506 if this is enabled. If the option is set to 'true', 'yes', or '1',
1507 the dialog uses a built-in generic prompt; otherwise the exact
1508 value of the variable is used.
1510 guitool.<name>.revPrompt::
1511 Request a single valid revision from the user, and set the
1512 'REVISION' environment variable. In other aspects this option
1513 is similar to 'argPrompt', and can be used together with it.
1515 guitool.<name>.revUnmerged::
1516 Show only unmerged branches in the 'revPrompt' subdialog.
1517 This is useful for tools similar to merge or rebase, but not
1518 for things like checkout or reset.
1520 guitool.<name>.title::
1521 Specifies the title to use for the prompt dialog. The default
1524 guitool.<name>.prompt::
1525 Specifies the general prompt string to display at the top of
1526 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1527 The default value includes the actual command.
1530 Specify the browser that will be used to display help in the
1531 'web' format. See linkgit:git-help[1].
1534 Override the default help format used by linkgit:git-help[1].
1535 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1536 the default. 'web' and 'html' are the same.
1539 Automatically correct and execute mistyped commands after
1540 waiting for the given number of deciseconds (0.1 sec). If more
1541 than one command can be deduced from the entered text, nothing
1542 will be executed. If the value of this option is negative,
1543 the corrected command will be executed immediately. If the
1544 value is 0 - the command will be just shown but not executed.
1545 This is the default.
1548 Specify the path where the HTML documentation resides. File system paths
1549 and URLs are supported. HTML pages will be prefixed with this path when
1550 help is displayed in the 'web' format. This defaults to the documentation
1551 path of your Git installation.
1554 Override the HTTP proxy, normally configured using the 'http_proxy',
1555 'https_proxy', and 'all_proxy' environment variables (see
1556 `curl(1)`). This can be overridden on a per-remote basis; see
1560 File containing previously stored cookie lines which should be used
1561 in the Git http session, if they match the server. The file format
1562 of the file to read cookies from should be plain HTTP headers or
1563 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1564 NOTE that the file specified with http.cookieFile is only used as
1565 input unless http.saveCookies is set.
1568 If set, store cookies received during requests to the file specified by
1569 http.cookieFile. Has no effect if http.cookieFile is unset.
1572 Whether to verify the SSL certificate when fetching or pushing
1573 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1577 File containing the SSL certificate when fetching or pushing
1578 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1582 File containing the SSL private key when fetching or pushing
1583 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1586 http.sslCertPasswordProtected::
1587 Enable Git's password prompt for the SSL certificate. Otherwise
1588 OpenSSL will prompt the user, possibly many times, if the
1589 certificate or private key is encrypted. Can be overridden by the
1590 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1593 File containing the certificates to verify the peer with when
1594 fetching or pushing over HTTPS. Can be overridden by the
1595 'GIT_SSL_CAINFO' environment variable.
1598 Path containing files with the CA certificates to verify the peer
1599 with when fetching or pushing over HTTPS. Can be overridden
1600 by the 'GIT_SSL_CAPATH' environment variable.
1603 Attempt to use AUTH SSL/TLS and encrypted data transfers
1604 when connecting via regular FTP protocol. This might be needed
1605 if the FTP server requires it for security reasons or you wish
1606 to connect securely whenever remote FTP server supports it.
1607 Default is false since it might trigger certificate verification
1608 errors on misconfigured servers.
1611 How many HTTP requests to launch in parallel. Can be overridden
1612 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1615 The number of curl sessions (counted across slots) to be kept across
1616 requests. They will not be ended with curl_easy_cleanup() until
1617 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1618 value will be capped at 1. Defaults to 1.
1621 Maximum size in bytes of the buffer used by smart HTTP
1622 transports when POSTing data to the remote system.
1623 For requests larger than this buffer size, HTTP/1.1 and
1624 Transfer-Encoding: chunked is used to avoid creating a
1625 massive pack file locally. Default is 1 MiB, which is
1626 sufficient for most requests.
1628 http.lowSpeedLimit, http.lowSpeedTime::
1629 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1630 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1631 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1632 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1635 A boolean which disables using of EPSV ftp command by curl.
1636 This can helpful with some "poor" ftp servers which don't
1637 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1638 environment variable. Default is false (curl will use EPSV).
1641 The HTTP USER_AGENT string presented to an HTTP server. The default
1642 value represents the version of the client Git such as git/1.7.1.
1643 This option allows you to override this value to a more common value
1644 such as Mozilla/4.0. This may be necessary, for instance, if
1645 connecting through a firewall that restricts HTTP connections to a set
1646 of common USER_AGENT strings (but not including those like git/1.7.1).
1647 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1650 Any of the http.* options above can be applied selectively to some URLs.
1651 For a config key to match a URL, each element of the config key is
1652 compared to that of the URL, in the following order:
1655 . Scheme (e.g., `https` in `https://example.com/`). This field
1656 must match exactly between the config key and the URL.
1658 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1659 This field must match exactly between the config key and the URL.
1661 . Port number (e.g., `8080` in `http://example.com:8080/`).
1662 This field must match exactly between the config key and the URL.
1663 Omitted port numbers are automatically converted to the correct
1664 default for the scheme before matching.
1666 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1667 path field of the config key must match the path field of the URL
1668 either exactly or as a prefix of slash-delimited path elements. This means
1669 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1670 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1671 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1672 key with just path `foo/`).
1674 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1675 the config key has a user name it must match the user name in the
1676 URL exactly. If the config key does not have a user name, that
1677 config key will match a URL with any user name (including none),
1678 but at a lower precedence than a config key with a user name.
1681 The list above is ordered by decreasing precedence; a URL that matches
1682 a config key's path is preferred to one that matches its user name. For example,
1683 if the URL is `https://user@example.com/foo/bar` a config key match of
1684 `https://example.com/foo` will be preferred over a config key match of
1685 `https://user@example.com`.
1687 All URLs are normalized before attempting any matching (the password part,
1688 if embedded in the URL, is always ignored for matching purposes) so that
1689 equivalent URLs that are simply spelled differently will match properly.
1690 Environment variable settings always override any matches. The URLs that are
1691 matched against are those given directly to Git commands. This means any URLs
1692 visited as a result of a redirection do not participate in matching.
1694 i18n.commitEncoding::
1695 Character encoding the commit messages are stored in; Git itself
1696 does not care per se, but this information is necessary e.g. when
1697 importing commits from emails or in the gitk graphical history
1698 browser (and possibly at other places in the future or in other
1699 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1701 i18n.logOutputEncoding::
1702 Character encoding the commit messages are converted to when
1703 running 'git log' and friends.
1706 The configuration variables in the 'imap' section are described
1707 in linkgit:git-imap-send[1].
1710 Specify the version with which new index files should be
1711 initialized. This does not affect existing repositories.
1714 Specify the directory from which templates will be copied.
1715 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1718 Specify the program that will be used to browse your working
1719 repository in gitweb. See linkgit:git-instaweb[1].
1722 The HTTP daemon command-line to start gitweb on your working
1723 repository. See linkgit:git-instaweb[1].
1726 If true the web server started by linkgit:git-instaweb[1] will
1727 be bound to the local IP (127.0.0.1).
1729 instaweb.modulePath::
1730 The default module path for linkgit:git-instaweb[1] to use
1731 instead of /usr/lib/apache2/modules. Only used if httpd
1735 The port number to bind the gitweb httpd to. See
1736 linkgit:git-instaweb[1].
1738 interactive.singleKey::
1739 In interactive commands, allow the user to provide one-letter
1740 input with a single key (i.e., without hitting enter).
1741 Currently this is used by the `--patch` mode of
1742 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1743 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1744 setting is silently ignored if portable keystroke input
1745 is not available; requires the Perl module Term::ReadKey.
1748 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1749 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1750 override this option with `--no-abbrev-commit`.
1753 Set the default date-time mode for the 'log' command.
1754 Setting a value for log.date is similar to using 'git log''s
1755 `--date` option. Possible values are `relative`, `local`,
1756 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1760 Print out the ref names of any commits that are shown by the log
1761 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1762 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1763 specified, the full ref name (including prefix) will be printed.
1764 This is the same as the log commands '--decorate' option.
1767 If true, the initial commit will be shown as a big creation event.
1768 This is equivalent to a diff against an empty tree.
1769 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1770 normally hide the root commit will now show it. True by default.
1773 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1774 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1777 If true, makes linkgit:git-mailinfo[1] (and therefore
1778 linkgit:git-am[1]) act by default as if the --scissors option
1779 was provided on the command-line. When active, this features
1780 removes everything from the message body before a scissors
1781 line (i.e. consisting mainly of ">8", "8<" and "-").
1784 The location of an augmenting mailmap file. The default
1785 mailmap, located in the root of the repository, is loaded
1786 first, then the mailmap file pointed to by this variable.
1787 The location of the mailmap file may be in a repository
1788 subdirectory, or somewhere outside of the repository itself.
1789 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1792 Like `mailmap.file`, but consider the value as a reference to a
1793 blob in the repository. If both `mailmap.file` and
1794 `mailmap.blob` are given, both are parsed, with entries from
1795 `mailmap.file` taking precedence. In a bare repository, this
1796 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1800 Specify the programs that may be used to display help in the
1801 'man' format. See linkgit:git-help[1].
1804 Specify the command to invoke the specified man viewer. The
1805 specified command is evaluated in shell with the man page
1806 passed as argument. (See linkgit:git-help[1].)
1809 Override the path for the given tool that may be used to
1810 display help in the 'man' format. See linkgit:git-help[1].
1812 include::merge-config.txt[]
1814 mergetool.<tool>.path::
1815 Override the path for the given tool. This is useful in case
1816 your tool is not in the PATH.
1818 mergetool.<tool>.cmd::
1819 Specify the command to invoke the specified merge tool. The
1820 specified command is evaluated in shell with the following
1821 variables available: 'BASE' is the name of a temporary file
1822 containing the common base of the files to be merged, if available;
1823 'LOCAL' is the name of a temporary file containing the contents of
1824 the file on the current branch; 'REMOTE' is the name of a temporary
1825 file containing the contents of the file from the branch being
1826 merged; 'MERGED' contains the name of the file to which the merge
1827 tool should write the results of a successful merge.
1829 mergetool.<tool>.trustExitCode::
1830 For a custom merge command, specify whether the exit code of
1831 the merge command can be used to determine whether the merge was
1832 successful. If this is not set to true then the merge target file
1833 timestamp is checked and the merge assumed to have been successful
1834 if the file has been updated, otherwise the user is prompted to
1835 indicate the success of the merge.
1837 mergetool.meld.hasOutput::
1838 Older versions of `meld` do not support the `--output` option.
1839 Git will attempt to detect whether `meld` supports `--output`
1840 by inspecting the output of `meld --help`. Configuring
1841 `mergetool.meld.hasOutput` will make Git skip these checks and
1842 use the configured value instead. Setting `mergetool.meld.hasOutput`
1843 to `true` tells Git to unconditionally use the `--output` option,
1844 and `false` avoids using `--output`.
1846 mergetool.keepBackup::
1847 After performing a merge, the original file with conflict markers
1848 can be saved as a file with a `.orig` extension. If this variable
1849 is set to `false` then this file is not preserved. Defaults to
1850 `true` (i.e. keep the backup files).
1852 mergetool.keepTemporaries::
1853 When invoking a custom merge tool, Git uses a set of temporary
1854 files to pass to the tool. If the tool returns an error and this
1855 variable is set to `true`, then these temporary files will be
1856 preserved, otherwise they will be removed after the tool has
1857 exited. Defaults to `false`.
1859 mergetool.writeToTemp::
1860 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1861 conflicting files in the worktree by default. Git will attempt
1862 to use a temporary directory for these files when set `true`.
1863 Defaults to `false`.
1866 Prompt before each invocation of the merge resolution program.
1869 The (fully qualified) refname from which to show notes when
1870 showing commit messages. The value of this variable can be set
1871 to a glob, in which case notes from all matching refs will be
1872 shown. You may also specify this configuration variable
1873 several times. A warning will be issued for refs that do not
1874 exist, but a glob that does not match any refs is silently
1877 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1878 environment variable, which must be a colon separated list of refs or
1881 The effective value of "core.notesRef" (possibly overridden by
1882 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1885 notes.rewrite.<command>::
1886 When rewriting commits with <command> (currently `amend` or
1887 `rebase`) and this variable is set to `true`, Git
1888 automatically copies your notes from the original to the
1889 rewritten commit. Defaults to `true`, but see
1890 "notes.rewriteRef" below.
1893 When copying notes during a rewrite (see the
1894 "notes.rewrite.<command>" option), determines what to do if
1895 the target commit already has a note. Must be one of
1896 `overwrite`, `concatenate`, or `ignore`. Defaults to
1899 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1900 environment variable.
1903 When copying notes during a rewrite, specifies the (fully
1904 qualified) ref whose notes should be copied. The ref may be a
1905 glob, in which case notes in all matching refs will be copied.
1906 You may also specify this configuration several times.
1908 Does not have a default value; you must configure this variable to
1909 enable note rewriting. Set it to `refs/notes/commits` to enable
1910 rewriting for the default commit notes.
1912 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1913 environment variable, which must be a colon separated list of refs or
1917 The size of the window used by linkgit:git-pack-objects[1] when no
1918 window size is given on the command line. Defaults to 10.
1921 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1922 maximum depth is given on the command line. Defaults to 50.
1925 The maximum size of memory that is consumed by each thread
1926 in linkgit:git-pack-objects[1] for pack window memory when
1927 no limit is given on the command line. The value can be
1928 suffixed with "k", "m", or "g". When left unconfigured (or
1929 set explicitly to 0), there will be no limit.
1932 An integer -1..9, indicating the compression level for objects
1933 in a pack file. -1 is the zlib default. 0 means no
1934 compression, and 1..9 are various speed/size tradeoffs, 9 being
1935 slowest. If not set, defaults to core.compression. If that is
1936 not set, defaults to -1, the zlib default, which is "a default
1937 compromise between speed and compression (currently equivalent
1940 Note that changing the compression level will not automatically recompress
1941 all existing objects. You can force recompression by passing the -F option
1942 to linkgit:git-repack[1].
1944 pack.deltaCacheSize::
1945 The maximum memory in bytes used for caching deltas in
1946 linkgit:git-pack-objects[1] before writing them out to a pack.
1947 This cache is used to speed up the writing object phase by not
1948 having to recompute the final delta result once the best match
1949 for all objects is found. Repacking large repositories on machines
1950 which are tight with memory might be badly impacted by this though,
1951 especially if this cache pushes the system into swapping.
1952 A value of 0 means no limit. The smallest size of 1 byte may be
1953 used to virtually disable this cache. Defaults to 256 MiB.
1955 pack.deltaCacheLimit::
1956 The maximum size of a delta, that is cached in
1957 linkgit:git-pack-objects[1]. This cache is used to speed up the
1958 writing object phase by not having to recompute the final delta
1959 result once the best match for all objects is found. Defaults to 1000.
1962 Specifies the number of threads to spawn when searching for best
1963 delta matches. This requires that linkgit:git-pack-objects[1]
1964 be compiled with pthreads otherwise this option is ignored with a
1965 warning. This is meant to reduce packing time on multiprocessor
1966 machines. The required amount of memory for the delta search window
1967 is however multiplied by the number of threads.
1968 Specifying 0 will cause Git to auto-detect the number of CPU's
1969 and set the number of threads accordingly.
1972 Specify the default pack index version. Valid values are 1 for
1973 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1974 the new pack index with capabilities for packs larger than 4 GB
1975 as well as proper protection against the repacking of corrupted
1976 packs. Version 2 is the default. Note that version 2 is enforced
1977 and this config option ignored whenever the corresponding pack is
1980 If you have an old Git that does not understand the version 2 `*.idx` file,
1981 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1982 that will copy both `*.pack` file and corresponding `*.idx` file from the
1983 other side may give you a repository that cannot be accessed with your
1984 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1985 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1988 pack.packSizeLimit::
1989 The maximum size of a pack. This setting only affects
1990 packing to a file when repacking, i.e. the git:// protocol
1991 is unaffected. It can be overridden by the `--max-pack-size`
1992 option of linkgit:git-repack[1]. The minimum size allowed is
1993 limited to 1 MiB. The default is unlimited.
1994 Common unit suffixes of 'k', 'm', or 'g' are
1998 When true, git will use pack bitmaps (if available) when packing
1999 to stdout (e.g., during the server side of a fetch). Defaults to
2000 true. You should not generally need to turn this off unless
2001 you are debugging pack bitmaps.
2003 pack.writeBitmaps (deprecated)::
2004 This is a deprecated synonym for `repack.writeBitmaps`.
2006 pack.writeBitmapHashCache::
2007 When true, git will include a "hash cache" section in the bitmap
2008 index (if one is written). This cache can be used to feed git's
2009 delta heuristics, potentially leading to better deltas between
2010 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2011 between an older, bitmapped pack and objects that have been
2012 pushed since the last gc). The downside is that it consumes 4
2013 bytes per object of disk space, and that JGit's bitmap
2014 implementation does not understand it, causing it to complain if
2015 Git and JGit are used on the same repository. Defaults to false.
2018 If the value is boolean, turns on or off pagination of the
2019 output of a particular Git subcommand when writing to a tty.
2020 Otherwise, turns on pagination for the subcommand using the
2021 pager specified by the value of `pager.<cmd>`. If `--paginate`
2022 or `--no-pager` is specified on the command line, it takes
2023 precedence over this option. To disable pagination for all
2024 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2027 Alias for a --pretty= format string, as specified in
2028 linkgit:git-log[1]. Any aliases defined here can be used just
2029 as the built-in pretty formats could. For example,
2030 running `git config pretty.changelog "format:* %H %s"`
2031 would cause the invocation `git log --pretty=changelog`
2032 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2033 Note that an alias with the same name as a built-in format
2034 will be silently ignored.
2037 By default, Git does not create an extra merge commit when merging
2038 a commit that is a descendant of the current commit. Instead, the
2039 tip of the current branch is fast-forwarded. When set to `false`,
2040 this variable tells Git to create an extra merge commit in such
2041 a case (equivalent to giving the `--no-ff` option from the command
2042 line). When set to `only`, only such fast-forward merges are
2043 allowed (equivalent to giving the `--ff-only` option from the
2044 command line). This setting overrides `merge.ff` when pulling.
2047 When true, rebase branches on top of the fetched branch, instead
2048 of merging the default branch from the default remote when "git
2049 pull" is run. See "branch.<name>.rebase" for setting this on a
2052 When preserve, also pass `--preserve-merges` along to 'git rebase'
2053 so that locally committed merge commits will not be flattened
2054 by running 'git pull'.
2056 *NOTE*: this is a possibly dangerous operation; do *not* use
2057 it unless you understand the implications (see linkgit:git-rebase[1]
2061 The default merge strategy to use when pulling multiple branches
2065 The default merge strategy to use when pulling a single branch.
2068 Defines the action `git push` should take if no refspec is
2069 explicitly given. Different values are well-suited for
2070 specific workflows; for instance, in a purely central workflow
2071 (i.e. the fetch source is equal to the push destination),
2072 `upstream` is probably what you want. Possible values are:
2076 * `nothing` - do not push anything (error out) unless a refspec is
2077 explicitly given. This is primarily meant for people who want to
2078 avoid mistakes by always being explicit.
2080 * `current` - push the current branch to update a branch with the same
2081 name on the receiving end. Works in both central and non-central
2084 * `upstream` - push the current branch back to the branch whose
2085 changes are usually integrated into the current branch (which is
2086 called `@{upstream}`). This mode only makes sense if you are
2087 pushing to the same repository you would normally pull from
2088 (i.e. central workflow).
2090 * `simple` - in centralized workflow, work like `upstream` with an
2091 added safety to refuse to push if the upstream branch's name is
2092 different from the local one.
2094 When pushing to a remote that is different from the remote you normally
2095 pull from, work as `current`. This is the safest option and is suited
2098 This mode has become the default in Git 2.0.
2100 * `matching` - push all branches having the same name on both ends.
2101 This makes the repository you are pushing to remember the set of
2102 branches that will be pushed out (e.g. if you always push 'maint'
2103 and 'master' there and no other branches, the repository you push
2104 to will have these two branches, and your local 'maint' and
2105 'master' will be pushed there).
2107 To use this mode effectively, you have to make sure _all_ the
2108 branches you would push out are ready to be pushed out before
2109 running 'git push', as the whole point of this mode is to allow you
2110 to push all of the branches in one go. If you usually finish work
2111 on only one branch and push out the result, while other branches are
2112 unfinished, this mode is not for you. Also this mode is not
2113 suitable for pushing into a shared central repository, as other
2114 people may add new branches there, or update the tip of existing
2115 branches outside your control.
2117 This used to be the default, but not since Git 2.0 (`simple` is the
2123 If set to true enable '--follow-tags' option by default. You
2124 may override this configuration at time of push by specifying
2129 Whether to show a diffstat of what changed upstream since the last
2130 rebase. False by default.
2133 If set to true enable '--autosquash' option by default.
2136 When set to true, automatically create a temporary stash
2137 before the operation begins, and apply it after the operation
2138 ends. This means that you can run rebase on a dirty worktree.
2139 However, use with care: the final stash application after a
2140 successful rebase might result in non-trivial conflicts.
2143 receive.advertiseAtomic::
2144 By default, git-receive-pack will advertise the atomic push
2145 capability to its clients. If you don't want to this capability
2146 to be advertised, set this variable to false.
2149 By default, git-receive-pack will run "git-gc --auto" after
2150 receiving data from git-push and updating refs. You can stop
2151 it by setting this variable to false.
2153 receive.certNonceSeed::
2154 By setting this variable to a string, `git receive-pack`
2155 will accept a `git push --signed` and verifies it by using
2156 a "nonce" protected by HMAC using this string as a secret
2159 receive.certNonceSlop::
2160 When a `git push --signed` sent a push certificate with a
2161 "nonce" that was issued by a receive-pack serving the same
2162 repository within this many seconds, export the "nonce"
2163 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2164 hooks (instead of what the receive-pack asked the sending
2165 side to include). This may allow writing checks in
2166 `pre-receive` and `post-receive` a bit easier. Instead of
2167 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2168 that records by how many seconds the nonce is stale to
2169 decide if they want to accept the certificate, they only
2170 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2172 receive.fsckObjects::
2173 If it is set to true, git-receive-pack will check all received
2174 objects. It will abort in the case of a malformed object or a
2175 broken link. The result of an abort are only dangling objects.
2176 Defaults to false. If not set, the value of `transfer.fsckObjects`
2179 receive.unpackLimit::
2180 If the number of objects received in a push is below this
2181 limit then the objects will be unpacked into loose object
2182 files. However if the number of received objects equals or
2183 exceeds this limit then the received pack will be stored as
2184 a pack, after adding any missing delta bases. Storing the
2185 pack from a push can make the push operation complete faster,
2186 especially on slow filesystems. If not set, the value of
2187 `transfer.unpackLimit` is used instead.
2189 receive.denyDeletes::
2190 If set to true, git-receive-pack will deny a ref update that deletes
2191 the ref. Use this to prevent such a ref deletion via a push.
2193 receive.denyDeleteCurrent::
2194 If set to true, git-receive-pack will deny a ref update that
2195 deletes the currently checked out branch of a non-bare repository.
2197 receive.denyCurrentBranch::
2198 If set to true or "refuse", git-receive-pack will deny a ref update
2199 to the currently checked out branch of a non-bare repository.
2200 Such a push is potentially dangerous because it brings the HEAD
2201 out of sync with the index and working tree. If set to "warn",
2202 print a warning of such a push to stderr, but allow the push to
2203 proceed. If set to false or "ignore", allow such pushes with no
2204 message. Defaults to "refuse".
2206 Another option is "updateInstead" which will update the working
2207 tree if pushing into the current branch. This option is
2208 intended for synchronizing working directories when one side is not easily
2209 accessible via interactive ssh (e.g. a live web site, hence the requirement
2210 that the working directory be clean). This mode also comes in handy when
2211 developing inside a VM to test and fix code on different Operating Systems.
2213 By default, "updateInstead" will refuse the push if the working tree or
2214 the index have any difference from the HEAD, but the `push-to-checkout`
2215 hook can be used to customize this. See linkgit:githooks[5].
2217 receive.denyNonFastForwards::
2218 If set to true, git-receive-pack will deny a ref update which is
2219 not a fast-forward. Use this to prevent such an update via a push,
2220 even if that push is forced. This configuration variable is
2221 set when initializing a shared repository.
2224 String(s) `receive-pack` uses to decide which refs to omit
2225 from its initial advertisement. Use more than one
2226 definitions to specify multiple prefix strings. A ref that
2227 are under the hierarchies listed on the value of this
2228 variable is excluded, and is hidden when responding to `git
2229 push`, and an attempt to update or delete a hidden ref by
2230 `git push` is rejected.
2232 receive.updateServerInfo::
2233 If set to true, git-receive-pack will run git-update-server-info
2234 after receiving data from git-push and updating refs.
2236 receive.shallowUpdate::
2237 If set to true, .git/shallow can be updated when new refs
2238 require new shallow roots. Otherwise those refs are rejected.
2240 remote.pushDefault::
2241 The remote to push to by default. Overrides
2242 `branch.<name>.remote` for all branches, and is overridden by
2243 `branch.<name>.pushRemote` for specific branches.
2246 The URL of a remote repository. See linkgit:git-fetch[1] or
2247 linkgit:git-push[1].
2249 remote.<name>.pushurl::
2250 The push URL of a remote repository. See linkgit:git-push[1].
2252 remote.<name>.proxy::
2253 For remotes that require curl (http, https and ftp), the URL to
2254 the proxy to use for that remote. Set to the empty string to
2255 disable proxying for that remote.
2257 remote.<name>.fetch::
2258 The default set of "refspec" for linkgit:git-fetch[1]. See
2259 linkgit:git-fetch[1].
2261 remote.<name>.push::
2262 The default set of "refspec" for linkgit:git-push[1]. See
2263 linkgit:git-push[1].
2265 remote.<name>.mirror::
2266 If true, pushing to this remote will automatically behave
2267 as if the `--mirror` option was given on the command line.
2269 remote.<name>.skipDefaultUpdate::
2270 If true, this remote will be skipped by default when updating
2271 using linkgit:git-fetch[1] or the `update` subcommand of
2272 linkgit:git-remote[1].
2274 remote.<name>.skipFetchAll::
2275 If true, this remote will be skipped by default when updating
2276 using linkgit:git-fetch[1] or the `update` subcommand of
2277 linkgit:git-remote[1].
2279 remote.<name>.receivepack::
2280 The default program to execute on the remote side when pushing. See
2281 option --receive-pack of linkgit:git-push[1].
2283 remote.<name>.uploadpack::
2284 The default program to execute on the remote side when fetching. See
2285 option --upload-pack of linkgit:git-fetch-pack[1].
2287 remote.<name>.tagOpt::
2288 Setting this value to --no-tags disables automatic tag following when
2289 fetching from remote <name>. Setting it to --tags will fetch every
2290 tag from remote <name>, even if they are not reachable from remote
2291 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2292 override this setting. See options --tags and --no-tags of
2293 linkgit:git-fetch[1].
2296 Setting this to a value <vcs> will cause Git to interact with
2297 the remote with the git-remote-<vcs> helper.
2299 remote.<name>.prune::
2300 When set to true, fetching from this remote by default will also
2301 remove any remote-tracking references that no longer exist on the
2302 remote (as if the `--prune` option was given on the command line).
2303 Overrides `fetch.prune` settings, if any.
2306 The list of remotes which are fetched by "git remote update
2307 <group>". See linkgit:git-remote[1].
2309 repack.useDeltaBaseOffset::
2310 By default, linkgit:git-repack[1] creates packs that use
2311 delta-base offset. If you need to share your repository with
2312 Git older than version 1.4.4, either directly or via a dumb
2313 protocol such as http, then you need to set this option to
2314 "false" and repack. Access from old Git versions over the
2315 native protocol are unaffected by this option.
2317 repack.packKeptObjects::
2318 If set to true, makes `git repack` act as if
2319 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2320 details. Defaults to `false` normally, but `true` if a bitmap
2321 index is being written (either via `--write-bitmap-index` or
2322 `repack.writeBitmaps`).
2324 repack.writeBitmaps::
2325 When true, git will write a bitmap index when packing all
2326 objects to disk (e.g., when `git repack -a` is run). This
2327 index can speed up the "counting objects" phase of subsequent
2328 packs created for clones and fetches, at the cost of some disk
2329 space and extra time spent on the initial repack. Defaults to
2333 When set to true, `git-rerere` updates the index with the
2334 resulting contents after it cleanly resolves conflicts using
2335 previously recorded resolution. Defaults to false.
2338 Activate recording of resolved conflicts, so that identical
2339 conflict hunks can be resolved automatically, should they be
2340 encountered again. By default, linkgit:git-rerere[1] is
2341 enabled if there is an `rr-cache` directory under the
2342 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2345 sendemail.identity::
2346 A configuration identity. When given, causes values in the
2347 'sendemail.<identity>' subsection to take precedence over
2348 values in the 'sendemail' section. The default identity is
2349 the value of 'sendemail.identity'.
2351 sendemail.smtpEncryption::
2352 See linkgit:git-send-email[1] for description. Note that this
2353 setting is not subject to the 'identity' mechanism.
2355 sendemail.smtpssl (deprecated)::
2356 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2358 sendemail.smtpsslcertpath::
2359 Path to ca-certificates (either a directory or a single file).
2360 Set it to an empty string to disable certificate verification.
2362 sendemail.<identity>.*::
2363 Identity-specific versions of the 'sendemail.*' parameters
2364 found below, taking precedence over those when the this
2365 identity is selected, through command-line or
2366 'sendemail.identity'.
2368 sendemail.aliasesFile::
2369 sendemail.aliasFileType::
2370 sendemail.annotate::
2374 sendemail.chainReplyTo::
2376 sendemail.envelopeSender::
2378 sendemail.multiEdit::
2379 sendemail.signedoffbycc::
2380 sendemail.smtpPass::
2381 sendemail.suppresscc::
2382 sendemail.suppressFrom::
2384 sendemail.smtpDomain::
2385 sendemail.smtpServer::
2386 sendemail.smtpServerPort::
2387 sendemail.smtpServerOption::
2388 sendemail.smtpUser::
2390 sendemail.transferEncoding::
2391 sendemail.validate::
2393 See linkgit:git-send-email[1] for description.
2395 sendemail.signedoffcc (deprecated)::
2396 Deprecated alias for 'sendemail.signedoffbycc'.
2398 showbranch.default::
2399 The default set of branches for linkgit:git-show-branch[1].
2400 See linkgit:git-show-branch[1].
2402 status.relativePaths::
2403 By default, linkgit:git-status[1] shows paths relative to the
2404 current directory. Setting this variable to `false` shows paths
2405 relative to the repository root (this was the default for Git
2409 Set to true to enable --short by default in linkgit:git-status[1].
2410 The option --no-short takes precedence over this variable.
2413 Set to true to enable --branch by default in linkgit:git-status[1].
2414 The option --no-branch takes precedence over this variable.
2416 status.displayCommentPrefix::
2417 If set to true, linkgit:git-status[1] will insert a comment
2418 prefix before each output line (starting with
2419 `core.commentChar`, i.e. `#` by default). This was the
2420 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2423 status.showUntrackedFiles::
2424 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2425 files which are not currently tracked by Git. Directories which
2426 contain only untracked files, are shown with the directory name
2427 only. Showing untracked files means that Git needs to lstat() all
2428 the files in the whole repository, which might be slow on some
2429 systems. So, this variable controls how the commands displays
2430 the untracked files. Possible values are:
2433 * `no` - Show no untracked files.
2434 * `normal` - Show untracked files and directories.
2435 * `all` - Show also individual files in untracked directories.
2438 If this variable is not specified, it defaults to 'normal'.
2439 This variable can be overridden with the -u|--untracked-files option
2440 of linkgit:git-status[1] and linkgit:git-commit[1].
2442 status.submoduleSummary::
2444 If this is set to a non zero number or true (identical to -1 or an
2445 unlimited number), the submodule summary will be enabled and a
2446 summary of commits for modified submodules will be shown (see
2447 --summary-limit option of linkgit:git-submodule[1]). Please note
2448 that the summary output command will be suppressed for all
2449 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2450 for those submodules where `submodule.<name>.ignore=all`. The only
2451 exception to that rule is that status and commit will show staged
2452 submodule changes. To
2453 also view the summary for ignored submodules you can either use
2454 the --ignore-submodules=dirty command-line option or the 'git
2455 submodule summary' command, which shows a similar output but does
2456 not honor these settings.
2458 submodule.<name>.path::
2459 submodule.<name>.url::
2460 The path within this project and URL for a submodule. These
2461 variables are initially populated by 'git submodule init'. See
2462 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2465 submodule.<name>.update::
2466 The default update procedure for a submodule. This variable
2467 is populated by `git submodule init` from the
2468 linkgit:gitmodules[5] file. See description of 'update'
2469 command in linkgit:git-submodule[1].
2471 submodule.<name>.branch::
2472 The remote branch name for a submodule, used by `git submodule
2473 update --remote`. Set this option to override the value found in
2474 the `.gitmodules` file. See linkgit:git-submodule[1] and
2475 linkgit:gitmodules[5] for details.
2477 submodule.<name>.fetchRecurseSubmodules::
2478 This option can be used to control recursive fetching of this
2479 submodule. It can be overridden by using the --[no-]recurse-submodules
2480 command-line option to "git fetch" and "git pull".
2481 This setting will override that from in the linkgit:gitmodules[5]
2484 submodule.<name>.ignore::
2485 Defines under what circumstances "git status" and the diff family show
2486 a submodule as modified. When set to "all", it will never be considered
2487 modified (but it will nonetheless show up in the output of status and
2488 commit when it has been staged), "dirty" will ignore all changes
2489 to the submodules work tree and
2490 takes only differences between the HEAD of the submodule and the commit
2491 recorded in the superproject into account. "untracked" will additionally
2492 let submodules with modified tracked files in their work tree show up.
2493 Using "none" (the default when this option is not set) also shows
2494 submodules that have untracked files in their work tree as changed.
2495 This setting overrides any setting made in .gitmodules for this submodule,
2496 both settings can be overridden on the command line by using the
2497 "--ignore-submodules" option. The 'git submodule' commands are not
2498 affected by this setting.
2501 This variable controls the sort ordering of tags when displayed by
2502 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2503 value of this variable will be used as the default.
2506 This variable can be used to restrict the permission bits of
2507 tar archive entries. The default is 0002, which turns off the
2508 world write bit. The special value "user" indicates that the
2509 archiving user's umask will be used instead. See umask(2) and
2510 linkgit:git-archive[1].
2512 transfer.fsckObjects::
2513 When `fetch.fsckObjects` or `receive.fsckObjects` are
2514 not set, the value of this variable is used instead.
2518 This variable can be used to set both `receive.hideRefs`
2519 and `uploadpack.hideRefs` at the same time to the same
2520 values. See entries for these other variables.
2522 transfer.unpackLimit::
2523 When `fetch.unpackLimit` or `receive.unpackLimit` are
2524 not set, the value of this variable is used instead.
2525 The default value is 100.
2527 uploadarchive.allowUnreachable::
2528 If true, allow clients to use `git archive --remote` to request
2529 any tree, whether reachable from the ref tips or not. See the
2530 discussion in the `SECURITY` section of
2531 linkgit:git-upload-archive[1] for more details. Defaults to
2534 uploadpack.hideRefs::
2535 String(s) `upload-pack` uses to decide which refs to omit
2536 from its initial advertisement. Use more than one
2537 definitions to specify multiple prefix strings. A ref that
2538 are under the hierarchies listed on the value of this
2539 variable is excluded, and is hidden from `git ls-remote`,
2540 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2541 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2543 uploadpack.allowtipsha1inwant::
2544 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2545 to accept a fetch request that asks for an object at the tip
2546 of a hidden ref (by default, such a request is rejected).
2547 see also `uploadpack.hideRefs`.
2549 uploadpack.keepAlive::
2550 When `upload-pack` has started `pack-objects`, there may be a
2551 quiet period while `pack-objects` prepares the pack. Normally
2552 it would output progress information, but if `--quiet` was used
2553 for the fetch, `pack-objects` will output nothing at all until
2554 the pack data begins. Some clients and networks may consider
2555 the server to be hung and give up. Setting this option instructs
2556 `upload-pack` to send an empty keepalive packet every
2557 `uploadpack.keepAlive` seconds. Setting this option to 0
2558 disables keepalive packets entirely. The default is 5 seconds.
2560 url.<base>.insteadOf::
2561 Any URL that starts with this value will be rewritten to
2562 start, instead, with <base>. In cases where some site serves a
2563 large number of repositories, and serves them with multiple
2564 access methods, and some users need to use different access
2565 methods, this feature allows people to specify any of the
2566 equivalent URLs and have Git automatically rewrite the URL to
2567 the best alternative for the particular user, even for a
2568 never-before-seen repository on the site. When more than one
2569 insteadOf strings match a given URL, the longest match is used.
2571 url.<base>.pushInsteadOf::
2572 Any URL that starts with this value will not be pushed to;
2573 instead, it will be rewritten to start with <base>, and the
2574 resulting URL will be pushed to. In cases where some site serves
2575 a large number of repositories, and serves them with multiple
2576 access methods, some of which do not allow push, this feature
2577 allows people to specify a pull-only URL and have Git
2578 automatically use an appropriate URL to push, even for a
2579 never-before-seen repository on the site. When more than one
2580 pushInsteadOf strings match a given URL, the longest match is
2581 used. If a remote has an explicit pushurl, Git will ignore this
2582 setting for that remote.
2585 Your email address to be recorded in any newly created commits.
2586 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2587 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2590 Your full name to be recorded in any newly created commits.
2591 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2592 environment variables. See linkgit:git-commit-tree[1].
2595 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2596 key you want it to automatically when creating a signed tag or
2597 commit, you can override the default selection with this variable.
2598 This option is passed unchanged to gpg's --local-user parameter,
2599 so you may specify a key using any method that gpg supports.
2601 versionsort.prereleaseSuffix::
2602 When version sort is used in linkgit:git-tag[1], prerelease
2603 tags (e.g. "1.0-rc1") may appear after the main release
2604 "1.0". By specifying the suffix "-rc" in this variable,
2605 "1.0-rc1" will appear before "1.0".
2607 This variable can be specified multiple times, once per suffix. The
2608 order of suffixes in the config file determines the sorting order
2609 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2610 is sorted before 1.0-rcXX). The sorting order between different
2611 suffixes is undefined if they are in multiple config files.
2614 Specify a web browser that may be used by some commands.
2615 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]