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 variable takes a pathname as its value, and is subject to tilde
88 included file is expanded immediately, as if its contents had been
89 found at the location of the include directive. If the value of the
90 `include.path` variable is a relative path, the path is considered to be
91 relative to the configuration file in which the include directive was
92 found. See below for examples.
100 ; Don't trust file modes
105 external = /usr/local/bin/diff-wrapper
110 merge = refs/heads/devel
114 gitProxy="ssh" for "kernel.org"
115 gitProxy=default-proxy ; for the rest
118 path = /path/to/foo.inc ; include by absolute path
119 path = foo ; expand "foo" relative to the current file
120 path = ~/foo ; expand "foo" in your `$HOME` directory
126 Values of many variables are treated as a simple string, but there
127 are variables that take values of specific types and there are rules
128 as to how to spell them.
132 When a variable is said to take a boolean value, many
133 synonyms are accepted for 'true' and 'false'; these are all
136 true;; Boolean true can be spelled as `yes`, `on`, `true`,
137 or `1`. Also, a variable defined without `= <value>`
140 false;; Boolean false can be spelled as `no`, `off`,
143 When converting value to the canonical form using `--bool` type
144 specifier; 'git config' will ensure that the output is "true" or
145 "false" (spelled in lowercase).
148 The value for many variables that specify various sizes can
149 be suffixed with `k`, `M`,... to mean "scale the number by
150 1024", "by 1024x1024", etc.
153 The value for a variable that takes a color is a list of
154 colors (at most two, one for foreground and one for background)
155 and attributes (as many as you want), separated by spaces.
157 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
158 `blue`, `magenta`, `cyan` and `white`. The first color given is the
159 foreground; the second is the background.
161 Colors may also be given as numbers between 0 and 255; these use ANSI
162 256-color mode (but note that not all terminals may support this). If
163 your terminal supports it, you may also specify 24-bit RGB values as
166 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
167 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
168 The position of any attributes with respect to the colors
169 (before, after, or in between), doesn't matter. Specific attributes may
170 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
173 An empty color string produces no color effect at all. This can be used
174 to avoid coloring specific elements without disabling color entirely.
176 For git's pre-defined color slots, the attributes are meant to be reset
177 at the beginning of each item in the colored output. So setting
178 `color.decorate.branch` to `black` will paint that branch name in a
179 plain `black`, even if the previous thing on the same output line (e.g.
180 opening parenthesis before the list of branch names in `log --decorate`
181 output) is set to be painted with `bold` or some other attribute.
182 However, custom log formats may do more complicated and layered
183 coloring, and the negated forms may be useful there.
186 A variable that takes a pathname value can be given a
187 string that begins with "`~/`" or "`~user/`", and the usual
188 tilde expansion happens to such a string: `~/`
189 is expanded to the value of `$HOME`, and `~user/` to the
190 specified user's home directory.
196 Note that this list is non-comprehensive and not necessarily complete.
197 For command-specific variables, you will find a more detailed description
198 in the appropriate manual page.
200 Other git-related tools may and do use their own variables. When
201 inventing new variables for use in your own tool, make sure their
202 names do not conflict with those that are used by Git itself and
203 other popular tools, and describe them in your documentation.
207 These variables control various optional help messages designed to
208 aid new users. All 'advice.*' variables default to 'true', and you
209 can tell Git that you do not need help by setting these to 'false':
213 Set this variable to 'false' if you want to disable
215 'pushNonFFMatching', 'pushAlreadyExists',
216 'pushFetchFirst', and 'pushNeedsForce'
219 Advice shown when linkgit:git-push[1] fails due to a
220 non-fast-forward update to the current branch.
222 Advice shown when you ran linkgit:git-push[1] and pushed
223 'matching refs' explicitly (i.e. you used ':', or
224 specified a refspec that isn't your current branch) and
225 it resulted in a non-fast-forward error.
227 Shown when linkgit:git-push[1] rejects an update that
228 does not qualify for fast-forwarding (e.g., a tag.)
230 Shown when linkgit:git-push[1] rejects an update that
231 tries to overwrite a remote ref that points at an
232 object we do not have.
234 Shown when linkgit:git-push[1] rejects an update that
235 tries to overwrite a remote ref that points at an
236 object that is not a commit-ish, or make the remote
237 ref point at an object that is not a commit-ish.
239 Show directions on how to proceed from the current
240 state in the output of linkgit:git-status[1], in
241 the template shown when writing commit messages in
242 linkgit:git-commit[1], and in the help message shown
243 by linkgit:git-checkout[1] when switching branch.
245 Advise to consider using the `-u` option to linkgit:git-status[1]
246 when the command takes more than 2 seconds to enumerate untracked
249 Advice shown when linkgit:git-merge[1] refuses to
250 merge to avoid overwriting local changes.
252 Advice shown by various commands when conflicts
253 prevent the operation from being performed.
255 Advice on how to set your identity configuration when
256 your information is guessed from the system username and
259 Advice shown when you used linkgit:git-checkout[1] to
260 move to the detach HEAD state, to instruct how to create
261 a local branch after the fact.
263 Advice that shows the location of the patch file when
264 linkgit:git-am[1] fails to apply it.
266 In case of failure in the output of linkgit:git-rm[1],
267 show directions on how to proceed from the current state.
271 Tells Git if the executable bit of files in the working tree
274 Some filesystems lose the executable bit when a file that is
275 marked as executable is checked out, or checks out an
276 non-executable file with executable bit on.
277 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
278 to see if it handles the executable bit correctly
279 and this variable is automatically set as necessary.
281 A repository, however, may be on a filesystem that handles
282 the filemode correctly, and this variable is set to 'true'
283 when created, but later may be made accessible from another
284 environment that loses the filemode (e.g. exporting ext4 via
285 CIFS mount, visiting a Cygwin created repository with
286 Git for Windows or Eclipse).
287 In such a case it may be necessary to set this variable to 'false'.
288 See linkgit:git-update-index[1].
290 The default is true (when core.filemode is not specified in the config file).
293 (Windows-only) If true, mark newly-created directories and files whose
294 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
295 directory is hidden, but no other files starting with a dot. The
296 default mode is 'dotGitOnly'.
299 If true, this option enables various workarounds to enable
300 Git to work better on filesystems that are not case sensitive,
301 like FAT. For example, if a directory listing finds
302 "makefile" when Git expects "Makefile", Git will assume
303 it is really the same file, and continue to remember it as
306 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
307 will probe and set core.ignoreCase true if appropriate when the repository
310 core.precomposeUnicode::
311 This option is only used by Mac OS implementation of Git.
312 When core.precomposeUnicode=true, Git reverts the unicode decomposition
313 of filenames done by Mac OS. This is useful when sharing a repository
314 between Mac OS and Linux or Windows.
315 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
316 When false, file names are handled fully transparent by Git,
317 which is backward compatible with older versions of Git.
320 If set to true, do not allow checkout of paths that would
321 be considered equivalent to `.git` on an HFS+ filesystem.
322 Defaults to `true` on Mac OS, and `false` elsewhere.
325 If set to true, do not allow checkout of paths that would
326 cause problems with the NTFS filesystem, e.g. conflict with
328 Defaults to `true` on Windows, and `false` elsewhere.
331 If false, the ctime differences between the index and the
332 working tree are ignored; useful when the inode change time
333 is regularly modified by something outside Git (file system
334 crawlers and some backup systems).
335 See linkgit:git-update-index[1]. True by default.
337 core.untrackedCache::
338 Determines what to do about the untracked cache feature of the
339 index. It will be kept, if this variable is unset or set to
340 `keep`. It will automatically be added if set to `true`. And
341 it will automatically be removed, if set to `false`. Before
342 setting it to `true`, you should check that mtime is working
343 properly on your system.
344 See linkgit:git-update-index[1]. `keep` by default.
347 Determines which stat fields to match between the index
348 and work tree. The user can set this to 'default' or
349 'minimal'. Default (or explicitly 'default'), is to check
350 all fields, including the sub-second part of mtime and ctime.
353 Commands that output paths (e.g. 'ls-files', 'diff'), will
354 quote "unusual" characters in the pathname by enclosing the
355 pathname in double-quotes and escaping those characters with
356 backslashes in the same way C escapes control characters (e.g.
357 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
358 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
359 UTF-8). If this variable is set to false, bytes higher than
360 0x80 are not considered "unusual" any more. Double-quotes,
361 backslash and control characters are always escaped regardless
362 of the setting of this variable. A simple space character is
363 not considered "unusual". Many commands can output pathnames
364 completely verbatim using the `-z` option. The default value
368 Sets the line ending type to use in the working directory for
369 files that have the `text` property set when core.autocrlf is false.
370 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
371 native line ending. The default value is `native`. See
372 linkgit:gitattributes[5] for more information on end-of-line
376 If true, makes Git check if converting `CRLF` is reversible when
377 end-of-line conversion is active. Git will verify if a command
378 modifies a file in the work tree either directly or indirectly.
379 For example, committing a file followed by checking out the
380 same file should yield the original file in the work tree. If
381 this is not the case for the current setting of
382 `core.autocrlf`, Git will reject the file. The variable can
383 be set to "warn", in which case Git will only warn about an
384 irreversible conversion but continue the operation.
386 CRLF conversion bears a slight chance of corrupting data.
387 When it is enabled, Git will convert CRLF to LF during commit and LF to
388 CRLF during checkout. A file that contains a mixture of LF and
389 CRLF before the commit cannot be recreated by Git. For text
390 files this is the right thing to do: it corrects line endings
391 such that we have only LF line endings in the repository.
392 But for binary files that are accidentally classified as text the
393 conversion can corrupt data.
395 If you recognize such corruption early you can easily fix it by
396 setting the conversion type explicitly in .gitattributes. Right
397 after committing you still have the original file in your work
398 tree and this file is not yet corrupted. You can explicitly tell
399 Git that this file is binary and Git will handle the file
402 Unfortunately, the desired effect of cleaning up text files with
403 mixed line endings and the undesired effect of corrupting binary
404 files cannot be distinguished. In both cases CRLFs are removed
405 in an irreversible way. For text files this is the right thing
406 to do because CRLFs are line endings, while for binary files
407 converting CRLFs corrupts data.
409 Note, this safety check does not mean that a checkout will generate a
410 file identical to the original file for a different setting of
411 `core.eol` and `core.autocrlf`, but only for the current one. For
412 example, a text file with `LF` would be accepted with `core.eol=lf`
413 and could later be checked out with `core.eol=crlf`, in which case the
414 resulting file would contain `CRLF`, although the original file
415 contained `LF`. However, in both work trees the line endings would be
416 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
417 file with mixed line endings would be reported by the `core.safecrlf`
421 Setting this variable to "true" is the same as setting
422 the `text` attribute to "auto" on all files and core.eol to "crlf".
423 Set to true if you want to have `CRLF` line endings in your
424 working directory and the repository has LF line endings.
425 This variable can be set to 'input',
426 in which case no output conversion is performed.
429 If false, symbolic links are checked out as small plain files that
430 contain the link text. linkgit:git-update-index[1] and
431 linkgit:git-add[1] will not change the recorded type to regular
432 file. Useful on filesystems like FAT that do not support
435 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
436 will probe and set core.symlinks false if appropriate when the repository
440 A "proxy command" to execute (as 'command host port') instead
441 of establishing direct connection to the remote server when
442 using the Git protocol for fetching. If the variable value is
443 in the "COMMAND for DOMAIN" format, the command is applied only
444 on hostnames ending with the specified domain string. This variable
445 may be set multiple times and is matched in the given order;
446 the first match wins.
448 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
449 (which always applies universally, without the special "for"
452 The special string `none` can be used as the proxy command to
453 specify that no proxy be used for a given domain pattern.
454 This is useful for excluding servers inside a firewall from
455 proxy use, while defaulting to a common proxy for external domains.
458 If this variable is set, `git fetch` and `git push` will
459 use the specified command instead of `ssh` when they need to
460 connect to a remote system. The command is in the same form as
461 the `GIT_SSH_COMMAND` environment variable and is overridden
462 when the environment variable is set.
465 If true, Git will avoid using lstat() calls to detect if files have
466 changed by setting the "assume-unchanged" bit for those tracked files
467 which it has updated identically in both the index and working tree.
469 When files are modified outside of Git, the user will need to stage
470 the modified files explicitly (e.g. see 'Examples' section in
471 linkgit:git-update-index[1]).
472 Git will not normally detect changes to those files.
474 This is useful on systems where lstat() calls are very slow, such as
475 CIFS/Microsoft Windows.
479 core.preferSymlinkRefs::
480 Instead of the default "symref" format for HEAD
481 and other symbolic reference files, use symbolic links.
482 This is sometimes needed to work with old scripts that
483 expect HEAD to be a symbolic link.
486 If true this repository is assumed to be 'bare' and has no
487 working directory associated with it. If this is the case a
488 number of commands that require a working directory will be
489 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
491 This setting is automatically guessed by linkgit:git-clone[1] or
492 linkgit:git-init[1] when the repository was created. By default a
493 repository that ends in "/.git" is assumed to be not bare (bare =
494 false), while all other repositories are assumed to be bare (bare
498 Set the path to the root of the working tree.
499 If `GIT_COMMON_DIR` environment variable is set, core.worktree
500 is ignored and not used for determining the root of working tree.
501 This can be overridden by the `GIT_WORK_TREE` environment
502 variable and the `--work-tree` command-line option.
503 The value can be an absolute path or relative to the path to
504 the .git directory, which is either specified by --git-dir
505 or GIT_DIR, or automatically discovered.
506 If --git-dir or GIT_DIR is specified but none of
507 --work-tree, GIT_WORK_TREE and core.worktree is specified,
508 the current working directory is regarded as the top level
509 of your working tree.
511 Note that this variable is honored even when set in a configuration
512 file in a ".git" subdirectory of a directory and its value differs
513 from the latter directory (e.g. "/path/to/.git/config" has
514 core.worktree set to "/different/path"), which is most likely a
515 misconfiguration. Running Git commands in the "/path/to" directory will
516 still use "/different/path" as the root of the work tree and can cause
517 confusion unless you know what you are doing (e.g. you are creating a
518 read-only snapshot of the same index to a location different from the
519 repository's usual working tree).
521 core.logAllRefUpdates::
522 Enable the reflog. Updates to a ref <ref> is logged to the file
523 "`$GIT_DIR/logs/<ref>`", by appending the new and old
524 SHA-1, the date/time and the reason of the update, but
525 only when the file exists. If this configuration
526 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
527 file is automatically created for branch heads (i.e. under
528 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
529 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
530 If it is set to `always`, then a missing reflog is automatically
531 created for any ref under `refs/`.
533 This information can be used to determine what commit
534 was the tip of a branch "2 days ago".
536 This value is true by default in a repository that has
537 a working directory associated with it, and false by
538 default in a bare repository.
540 core.repositoryFormatVersion::
541 Internal variable identifying the repository format and layout
544 core.sharedRepository::
545 When 'group' (or 'true'), the repository is made shareable between
546 several users in a group (making sure all the files and objects are
547 group-writable). When 'all' (or 'world' or 'everybody'), the
548 repository will be readable by all users, additionally to being
549 group-shareable. When 'umask' (or 'false'), Git will use permissions
550 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
551 files in the repository will have this mode value. '0xxx' will override
552 user's umask value (whereas the other options will only override
553 requested parts of the user's umask value). Examples: '0660' will make
554 the repo read/write-able for the owner and group, but inaccessible to
555 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
556 repository that is group-readable but not group-writable.
557 See linkgit:git-init[1]. False by default.
559 core.warnAmbiguousRefs::
560 If true, Git will warn you if the ref name you passed it is ambiguous
561 and might match multiple refs in the repository. True by default.
564 An integer -1..9, indicating a default compression level.
565 -1 is the zlib default. 0 means no compression,
566 and 1..9 are various speed/size tradeoffs, 9 being slowest.
567 If set, this provides a default to other compression variables,
568 such as `core.looseCompression` and `pack.compression`.
570 core.looseCompression::
571 An integer -1..9, indicating the compression level for objects that
572 are not in a pack file. -1 is the zlib default. 0 means no
573 compression, and 1..9 are various speed/size tradeoffs, 9 being
574 slowest. If not set, defaults to core.compression. If that is
575 not set, defaults to 1 (best speed).
577 core.packedGitWindowSize::
578 Number of bytes of a pack file to map into memory in a
579 single mapping operation. Larger window sizes may allow
580 your system to process a smaller number of large pack files
581 more quickly. Smaller window sizes will negatively affect
582 performance due to increased calls to the operating system's
583 memory manager, but may improve performance when accessing
584 a large number of large pack files.
586 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
587 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
588 be reasonable for all users/operating systems. You probably do
589 not need to adjust this value.
591 Common unit suffixes of 'k', 'm', or 'g' are supported.
593 core.packedGitLimit::
594 Maximum number of bytes to map simultaneously into memory
595 from pack files. If Git needs to access more than this many
596 bytes at once to complete an operation it will unmap existing
597 regions to reclaim virtual address space within the process.
599 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
600 This should be reasonable for all users/operating systems, except on
601 the largest projects. You probably do not need to adjust this value.
603 Common unit suffixes of 'k', 'm', or 'g' are supported.
605 core.deltaBaseCacheLimit::
606 Maximum number of bytes to reserve for caching base objects
607 that may be referenced by multiple deltified objects. By storing the
608 entire decompressed base objects in a cache Git is able
609 to avoid unpacking and decompressing frequently used base
610 objects multiple times.
612 Default is 96 MiB on all platforms. This should be reasonable
613 for all users/operating systems, except on the largest projects.
614 You probably do not need to adjust this value.
616 Common unit suffixes of 'k', 'm', or 'g' are supported.
618 core.bigFileThreshold::
619 Files larger than this size are stored deflated, without
620 attempting delta compression. Storing large files without
621 delta compression avoids excessive memory usage, at the
622 slight expense of increased disk usage. Additionally files
623 larger than this size are always treated as binary.
625 Default is 512 MiB on all platforms. This should be reasonable
626 for most projects as source code and other text files can still
627 be delta compressed, but larger binary media files won't be.
629 Common unit suffixes of 'k', 'm', or 'g' are supported.
632 Specifies the pathname to the file that contains patterns to
633 describe paths that are not meant to be tracked, in addition
634 to '.gitignore' (per-directory) and '.git/info/exclude'.
635 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
636 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
637 is used instead. See linkgit:gitignore[5].
640 Some commands (e.g. svn and http interfaces) that interactively
641 ask for a password can be told to use an external program given
642 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
643 environment variable. If not set, fall back to the value of the
644 `SSH_ASKPASS` environment variable or, failing that, a simple password
645 prompt. The external program shall be given a suitable prompt as
646 command-line argument and write the password on its STDOUT.
648 core.attributesFile::
649 In addition to '.gitattributes' (per-directory) and
650 '.git/info/attributes', Git looks into this file for attributes
651 (see linkgit:gitattributes[5]). Path expansions are made the same
652 way as for `core.excludesFile`. Its default value is
653 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
654 set or empty, `$HOME/.config/git/attributes` is used instead.
657 By default Git will look for your hooks in the
658 '$GIT_DIR/hooks' directory. Set this to different path,
659 e.g. '/etc/git/hooks', and Git will try to find your hooks in
660 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
661 in '$GIT_DIR/hooks/pre-receive'.
663 The path can be either absolute or relative. A relative path is
664 taken as relative to the directory where the hooks are run (see
665 the "DESCRIPTION" section of linkgit:githooks[5]).
667 This configuration variable is useful in cases where you'd like to
668 centrally configure your Git hooks instead of configuring them on a
669 per-repository basis, or as a more flexible and centralized
670 alternative to having an `init.templateDir` where you've changed
674 Commands such as `commit` and `tag` that lets you edit
675 messages by launching an editor uses the value of this
676 variable when it is set, and the environment variable
677 `GIT_EDITOR` is not set. See linkgit:git-var[1].
680 Commands such as `commit` and `tag` that lets you edit
681 messages consider a line that begins with this character
682 commented, and removes them after the editor returns
685 If set to "auto", `git-commit` would select a character that is not
686 the beginning character of any line in existing commit messages.
688 core.packedRefsTimeout::
689 The length of time, in milliseconds, to retry when trying to
690 lock the `packed-refs` file. Value 0 means not to retry at
691 all; -1 means to try indefinitely. Default is 1000 (i.e.,
695 Text editor used by `git rebase -i` for editing the rebase instruction file.
696 The value is meant to be interpreted by the shell when it is used.
697 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
698 When not configured the default commit message editor is used instead.
701 Text viewer for use by Git commands (e.g., 'less'). The value
702 is meant to be interpreted by the shell. The order of preference
703 is the `$GIT_PAGER` environment variable, then `core.pager`
704 configuration, then `$PAGER`, and then the default chosen at
705 compile time (usually 'less').
707 When the `LESS` environment variable is unset, Git sets it to `FRX`
708 (if `LESS` environment variable is set, Git does not change it at
709 all). If you want to selectively override Git's default setting
710 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
711 be passed to the shell by Git, which will translate the final
712 command to `LESS=FRX less -S`. The environment does not set the
713 `S` option but the command line does, instructing less to truncate
714 long lines. Similarly, setting `core.pager` to `less -+F` will
715 deactivate the `F` option specified by the environment from the
716 command-line, deactivating the "quit if one screen" behavior of
717 `less`. One can specifically activate some flags for particular
718 commands: for example, setting `pager.blame` to `less -S` enables
719 line truncation only for `git blame`.
721 Likewise, when the `LV` environment variable is unset, Git sets it
722 to `-c`. You can override this setting by exporting `LV` with
723 another value or setting `core.pager` to `lv +c`.
726 A comma separated list of common whitespace problems to
727 notice. 'git diff' will use `color.diff.whitespace` to
728 highlight them, and 'git apply --whitespace=error' will
729 consider them as errors. You can prefix `-` to disable
730 any of them (e.g. `-trailing-space`):
732 * `blank-at-eol` treats trailing whitespaces at the end of the line
733 as an error (enabled by default).
734 * `space-before-tab` treats a space character that appears immediately
735 before a tab character in the initial indent part of the line as an
736 error (enabled by default).
737 * `indent-with-non-tab` treats a line that is indented with space
738 characters instead of the equivalent tabs as an error (not enabled by
740 * `tab-in-indent` treats a tab character in the initial indent part of
741 the line as an error (not enabled by default).
742 * `blank-at-eof` treats blank lines added at the end of file as an error
743 (enabled by default).
744 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
746 * `cr-at-eol` treats a carriage-return at the end of line as
747 part of the line terminator, i.e. with it, `trailing-space`
748 does not trigger if the character before such a carriage-return
749 is not a whitespace (not enabled by default).
750 * `tabwidth=<n>` tells how many character positions a tab occupies; this
751 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
752 errors. The default tab width is 8. Allowed values are 1 to 63.
754 core.fsyncObjectFiles::
755 This boolean will enable 'fsync()' when writing object files.
757 This is a total waste of time and effort on a filesystem that orders
758 data writes properly, but can be useful for filesystems that do not use
759 journalling (traditional UNIX filesystems) or that only journal metadata
760 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
763 Enable parallel index preload for operations like 'git diff'
765 This can speed up operations like 'git diff' and 'git status' especially
766 on filesystems like NFS that have weak caching semantics and thus
767 relatively high IO latencies. When enabled, Git will do the
768 index comparison to the filesystem data in parallel, allowing
769 overlapping IO's. Defaults to true.
772 You can set this to 'link', in which case a hardlink followed by
773 a delete of the source are used to make sure that object creation
774 will not overwrite existing objects.
776 On some file system/operating system combinations, this is unreliable.
777 Set this config setting to 'rename' there; However, This will remove the
778 check that makes sure that existing object files will not get overwritten.
781 When showing commit messages, also show notes which are stored in
782 the given ref. The ref must be fully qualified. If the given
783 ref does not exist, it is not an error but means that no
784 notes should be printed.
786 This setting defaults to "refs/notes/commits", and it can be overridden by
787 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
789 core.sparseCheckout::
790 Enable "sparse checkout" feature. See section "Sparse checkout" in
791 linkgit:git-read-tree[1] for more information.
794 Set the length object names are abbreviated to. If
795 unspecified or set to "auto", an appropriate value is
796 computed based on the approximate number of packed objects
797 in your repository, which hopefully is enough for
798 abbreviated object names to stay unique for some time.
801 add.ignore-errors (deprecated)::
802 Tells 'git add' to continue adding files when some files cannot be
803 added due to indexing errors. Equivalent to the `--ignore-errors`
804 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
805 as it does not follow the usual naming convention for configuration
809 Command aliases for the linkgit:git[1] command wrapper - e.g.
810 after defining "alias.last = cat-file commit HEAD", the invocation
811 "git last" is equivalent to "git cat-file commit HEAD". To avoid
812 confusion and troubles with script usage, aliases that
813 hide existing Git commands are ignored. Arguments are split by
814 spaces, the usual shell quoting and escaping is supported.
815 A quote pair or a backslash can be used to quote them.
817 If the alias expansion is prefixed with an exclamation point,
818 it will be treated as a shell command. For example, defining
819 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
820 "git new" is equivalent to running the shell command
821 "gitk --all --not ORIG_HEAD". Note that shell commands will be
822 executed from the top-level directory of a repository, which may
823 not necessarily be the current directory.
824 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
825 from the original current directory. See linkgit:git-rev-parse[1].
828 If true, git-am will call git-mailsplit for patches in mbox format
829 with parameter `--keep-cr`. In this case git-mailsplit will
830 not remove `\r` from lines ending with `\r\n`. Can be overridden
831 by giving `--no-keep-cr` from the command line.
832 See linkgit:git-am[1], linkgit:git-mailsplit[1].
835 By default, `git am` will fail if the patch does not apply cleanly. When
836 set to true, this setting tells `git am` to fall back on 3-way merge if
837 the patch records the identity of blobs it is supposed to apply to and
838 we have those blobs available locally (equivalent to giving the `--3way`
839 option from the command line). Defaults to `false`.
840 See linkgit:git-am[1].
842 apply.ignoreWhitespace::
843 When set to 'change', tells 'git apply' to ignore changes in
844 whitespace, in the same way as the `--ignore-space-change`
846 When set to one of: no, none, never, false tells 'git apply' to
847 respect all whitespace differences.
848 See linkgit:git-apply[1].
851 Tells 'git apply' how to handle whitespaces, in the same way
852 as the `--whitespace` option. See linkgit:git-apply[1].
854 branch.autoSetupMerge::
855 Tells 'git branch' and 'git checkout' to set up new branches
856 so that linkgit:git-pull[1] will appropriately merge from the
857 starting point branch. Note that even if this option is not set,
858 this behavior can be chosen per-branch using the `--track`
859 and `--no-track` options. The valid settings are: `false` -- no
860 automatic setup is done; `true` -- automatic setup is done when the
861 starting point is a remote-tracking branch; `always` --
862 automatic setup is done when the starting point is either a
863 local branch or remote-tracking
864 branch. This option defaults to true.
866 branch.autoSetupRebase::
867 When a new branch is created with 'git branch' or 'git checkout'
868 that tracks another branch, this variable tells Git to set
869 up pull to rebase instead of merge (see "branch.<name>.rebase").
870 When `never`, rebase is never automatically set to true.
871 When `local`, rebase is set to true for tracked branches of
872 other local branches.
873 When `remote`, rebase is set to true for tracked branches of
874 remote-tracking branches.
875 When `always`, rebase will be set to true for all tracking
877 See "branch.autoSetupMerge" for details on how to set up a
878 branch to track another branch.
879 This option defaults to never.
881 branch.<name>.remote::
882 When on branch <name>, it tells 'git fetch' and 'git push'
883 which remote to fetch from/push to. The remote to push to
884 may be overridden with `remote.pushDefault` (for all branches).
885 The remote to push to, for the current branch, may be further
886 overridden by `branch.<name>.pushRemote`. If no remote is
887 configured, or if you are not on any branch, it defaults to
888 `origin` for fetching and `remote.pushDefault` for pushing.
889 Additionally, `.` (a period) is the current local repository
890 (a dot-repository), see `branch.<name>.merge`'s final note below.
892 branch.<name>.pushRemote::
893 When on branch <name>, it overrides `branch.<name>.remote` for
894 pushing. It also overrides `remote.pushDefault` for pushing
895 from branch <name>. When you pull from one place (e.g. your
896 upstream) and push to another place (e.g. your own publishing
897 repository), you would want to set `remote.pushDefault` to
898 specify the remote to push to for all branches, and use this
899 option to override it for a specific branch.
901 branch.<name>.merge::
902 Defines, together with branch.<name>.remote, the upstream branch
903 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
904 branch to merge and can also affect 'git push' (see push.default).
905 When in branch <name>, it tells 'git fetch' the default
906 refspec to be marked for merging in FETCH_HEAD. The value is
907 handled like the remote part of a refspec, and must match a
908 ref which is fetched from the remote given by
909 "branch.<name>.remote".
910 The merge information is used by 'git pull' (which at first calls
911 'git fetch') to lookup the default branch for merging. Without
912 this option, 'git pull' defaults to merge the first refspec fetched.
913 Specify multiple values to get an octopus merge.
914 If you wish to setup 'git pull' so that it merges into <name> from
915 another branch in the local repository, you can point
916 branch.<name>.merge to the desired branch, and use the relative path
917 setting `.` (a period) for branch.<name>.remote.
919 branch.<name>.mergeOptions::
920 Sets default options for merging into branch <name>. The syntax and
921 supported options are the same as those of linkgit:git-merge[1], but
922 option values containing whitespace characters are currently not
925 branch.<name>.rebase::
926 When true, rebase the branch <name> on top of the fetched branch,
927 instead of merging the default branch from the default remote when
928 "git pull" is run. See "pull.rebase" for doing this in a non
929 branch-specific manner.
931 When preserve, also pass `--preserve-merges` along to 'git rebase'
932 so that locally committed merge commits will not be flattened
933 by running 'git pull'.
935 When the value is `interactive`, the rebase is run in interactive mode.
937 *NOTE*: this is a possibly dangerous operation; do *not* use
938 it unless you understand the implications (see linkgit:git-rebase[1]
941 branch.<name>.description::
942 Branch description, can be edited with
943 `git branch --edit-description`. Branch description is
944 automatically added in the format-patch cover letter or
945 request-pull summary.
948 Specify the command to invoke the specified browser. The
949 specified command is evaluated in shell with the URLs passed
950 as arguments. (See linkgit:git-web{litdd}browse[1].)
952 browser.<tool>.path::
953 Override the path for the given tool that may be used to
954 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
955 working repository in gitweb (see linkgit:git-instaweb[1]).
958 A boolean to make git-clean do nothing unless given -f,
959 -i or -n. Defaults to true.
962 A boolean to enable/disable color in the output of
963 linkgit:git-branch[1]. May be set to `always`,
964 `false` (or `never`) or `auto` (or `true`), in which case colors are used
965 only when the output is to a terminal. If unset, then the
966 value of `color.ui` is used (`auto` by default).
968 color.branch.<slot>::
969 Use customized color for branch coloration. `<slot>` is one of
970 `current` (the current branch), `local` (a local branch),
971 `remote` (a remote-tracking branch in refs/remotes/),
972 `upstream` (upstream tracking branch), `plain` (other
976 Whether to use ANSI escape sequences to add color to patches.
977 If this is set to `always`, linkgit:git-diff[1],
978 linkgit:git-log[1], and linkgit:git-show[1] will use color
979 for all patches. If it is set to `true` or `auto`, those
980 commands will only use color when output is to the terminal.
981 If unset, then the value of `color.ui` is used (`auto` by
984 This does not affect linkgit:git-format-patch[1] or the
985 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
986 command line with the `--color[=<when>]` option.
989 Use customized color for diff colorization. `<slot>` specifies
990 which part of the patch to use the specified color, and is one
991 of `context` (context text - `plain` is a historical synonym),
992 `meta` (metainformation), `frag`
993 (hunk header), 'func' (function in hunk header), `old` (removed lines),
994 `new` (added lines), `commit` (commit headers), or `whitespace`
995 (highlighting whitespace errors).
997 color.decorate.<slot>::
998 Use customized color for 'git log --decorate' output. `<slot>` is one
999 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1000 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1003 When set to `always`, always highlight matches. When `false` (or
1004 `never`), never. When set to `true` or `auto`, use color only
1005 when the output is written to the terminal. If unset, then the
1006 value of `color.ui` is used (`auto` by default).
1009 Use customized color for grep colorization. `<slot>` specifies which
1010 part of the line to use the specified color, and is one of
1014 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1016 filename prefix (when not using `-h`)
1018 function name lines (when using `-p`)
1020 line number prefix (when using `-n`)
1022 matching text (same as setting `matchContext` and `matchSelected`)
1024 matching text in context lines
1026 matching text in selected lines
1028 non-matching text in selected lines
1030 separators between fields on a line (`:`, `-`, and `=`)
1031 and between hunks (`--`)
1035 When set to `always`, always use colors for interactive prompts
1036 and displays (such as those used by "git-add --interactive" and
1037 "git-clean --interactive"). When false (or `never`), never.
1038 When set to `true` or `auto`, use colors only when the output is
1039 to the terminal. If unset, then the value of `color.ui` is
1040 used (`auto` by default).
1042 color.interactive.<slot>::
1043 Use customized color for 'git add --interactive' and 'git clean
1044 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1045 or `error`, for four distinct types of normal output from
1046 interactive commands.
1049 A boolean to enable/disable colored output when the pager is in
1050 use (default is true).
1053 A boolean to enable/disable color in the output of
1054 linkgit:git-show-branch[1]. May be set to `always`,
1055 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1056 only when the output is to a terminal. If unset, then the
1057 value of `color.ui` is used (`auto` by default).
1060 A boolean to enable/disable color in the output of
1061 linkgit:git-status[1]. May be set to `always`,
1062 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1063 only when the output is to a terminal. If unset, then the
1064 value of `color.ui` is used (`auto` by default).
1066 color.status.<slot>::
1067 Use customized color for status colorization. `<slot>` is
1068 one of `header` (the header text of the status message),
1069 `added` or `updated` (files which are added but not committed),
1070 `changed` (files which are changed but not added in the index),
1071 `untracked` (files which are not tracked by Git),
1072 `branch` (the current branch),
1073 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1075 `unmerged` (files which have unmerged changes).
1078 This variable determines the default value for variables such
1079 as `color.diff` and `color.grep` that control the use of color
1080 per command family. Its scope will expand as more commands learn
1081 configuration to set a default for the `--color` option. Set it
1082 to `false` or `never` if you prefer Git commands not to use
1083 color unless enabled explicitly with some other configuration
1084 or the `--color` option. Set it to `always` if you want all
1085 output not intended for machine consumption to use color, to
1086 `true` or `auto` (this is the default since Git 1.8.4) if you
1087 want such output to use color when written to the terminal.
1090 Specify whether supported commands should output in columns.
1091 This variable consists of a list of tokens separated by spaces
1094 These options control when the feature should be enabled
1095 (defaults to 'never'):
1099 always show in columns
1101 never show in columns
1103 show in columns if the output is to the terminal
1106 These options control layout (defaults to 'column'). Setting any
1107 of these implies 'always' if none of 'always', 'never', or 'auto' are
1112 fill columns before rows
1114 fill rows before columns
1119 Finally, these options can be combined with a layout option (defaults
1124 make unequal size columns to utilize more space
1126 make equal size columns
1130 Specify whether to output branch listing in `git branch` in columns.
1131 See `column.ui` for details.
1134 Specify the layout when list items in `git clean -i`, which always
1135 shows files and directories in columns. See `column.ui` for details.
1138 Specify whether to output untracked files in `git status` in columns.
1139 See `column.ui` for details.
1142 Specify whether to output tag listing in `git tag` in columns.
1143 See `column.ui` for details.
1146 This setting overrides the default of the `--cleanup` option in
1147 `git commit`. See linkgit:git-commit[1] for details. Changing the
1148 default can be useful when you always want to keep lines that begin
1149 with comment character `#` in your log message, in which case you
1150 would do `git config commit.cleanup whitespace` (note that you will
1151 have to remove the help lines that begin with `#` in the commit log
1152 template yourself, if you do this).
1156 A boolean to specify whether all commits should be GPG signed.
1157 Use of this option when doing operations such as rebase can
1158 result in a large number of commits being signed. It may be
1159 convenient to use an agent to avoid typing your GPG passphrase
1163 A boolean to enable/disable inclusion of status information in the
1164 commit message template when using an editor to prepare the commit
1165 message. Defaults to true.
1168 Specify the pathname of a file to use as the template for
1169 new commit messages.
1172 A boolean or int to specify the level of verbose with `git commit`.
1173 See linkgit:git-commit[1].
1176 Specify an external helper to be called when a username or
1177 password credential is needed; the helper may consult external
1178 storage to avoid prompting the user for the credentials. Note
1179 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1182 credential.useHttpPath::
1183 When acquiring credentials, consider the "path" component of an http
1184 or https URL to be important. Defaults to false. See
1185 linkgit:gitcredentials[7] for more information.
1187 credential.username::
1188 If no username is set for a network authentication, use this username
1189 by default. See credential.<context>.* below, and
1190 linkgit:gitcredentials[7].
1192 credential.<url>.*::
1193 Any of the credential.* options above can be applied selectively to
1194 some credentials. For example "credential.https://example.com.username"
1195 would set the default username only for https connections to
1196 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1199 credentialCache.ignoreSIGHUP::
1200 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1202 include::diff-config.txt[]
1204 difftool.<tool>.path::
1205 Override the path for the given tool. This is useful in case
1206 your tool is not in the PATH.
1208 difftool.<tool>.cmd::
1209 Specify the command to invoke the specified diff tool.
1210 The specified command is evaluated in shell with the following
1211 variables available: 'LOCAL' is set to the name of the temporary
1212 file containing the contents of the diff pre-image and 'REMOTE'
1213 is set to the name of the temporary file containing the contents
1214 of the diff post-image.
1217 Prompt before each invocation of the diff tool.
1219 fastimport.unpackLimit::
1220 If the number of objects imported by linkgit:git-fast-import[1]
1221 is below this limit, then the objects will be unpacked into
1222 loose object files. However if the number of imported objects
1223 equals or exceeds this limit then the pack will be stored as a
1224 pack. Storing the pack from a fast-import can make the import
1225 operation complete faster, especially on slow filesystems. If
1226 not set, the value of `transfer.unpackLimit` is used instead.
1228 fetch.recurseSubmodules::
1229 This option can be either set to a boolean value or to 'on-demand'.
1230 Setting it to a boolean changes the behavior of fetch and pull to
1231 unconditionally recurse into submodules when set to true or to not
1232 recurse at all when set to false. When set to 'on-demand' (the default
1233 value), fetch and pull will only recurse into a populated submodule
1234 when its superproject retrieves a commit that updates the submodule's
1238 If it is set to true, git-fetch-pack will check all fetched
1239 objects. It will abort in the case of a malformed object or a
1240 broken link. The result of an abort are only dangling objects.
1241 Defaults to false. If not set, the value of `transfer.fsckObjects`
1245 If the number of objects fetched over the Git native
1246 transfer is below this
1247 limit, then the objects will be unpacked into loose object
1248 files. However if the number of received objects equals or
1249 exceeds this limit then the received pack will be stored as
1250 a pack, after adding any missing delta bases. Storing the
1251 pack from a push can make the push operation complete faster,
1252 especially on slow filesystems. If not set, the value of
1253 `transfer.unpackLimit` is used instead.
1256 If true, fetch will automatically behave as if the `--prune`
1257 option was given on the command line. See also `remote.<name>.prune`.
1260 Control how ref update status is printed. Valid values are
1261 `full` and `compact`. Default value is `full`. See section
1262 OUTPUT in linkgit:git-fetch[1] for detail.
1265 Enable multipart/mixed attachments as the default for
1266 'format-patch'. The value can also be a double quoted string
1267 which will enable attachments as the default and set the
1268 value as the boundary. See the --attach option in
1269 linkgit:git-format-patch[1].
1272 Provides the default value for the `--from` option to format-patch.
1273 Accepts a boolean value, or a name and email address. If false,
1274 format-patch defaults to `--no-from`, using commit authors directly in
1275 the "From:" field of patch mails. If true, format-patch defaults to
1276 `--from`, using your committer identity in the "From:" field of patch
1277 mails and including a "From:" field in the body of the patch mail if
1278 different. If set to a non-boolean value, format-patch uses that
1279 value instead of your committer identity. Defaults to false.
1282 A boolean which can enable or disable sequence numbers in patch
1283 subjects. It defaults to "auto" which enables it only if there
1284 is more than one patch. It can be enabled or disabled for all
1285 messages by setting it to "true" or "false". See --numbered
1286 option in linkgit:git-format-patch[1].
1289 Additional email headers to include in a patch to be submitted
1290 by mail. See linkgit:git-format-patch[1].
1294 Additional recipients to include in a patch to be submitted
1295 by mail. See the --to and --cc options in
1296 linkgit:git-format-patch[1].
1298 format.subjectPrefix::
1299 The default for format-patch is to output files with the '[PATCH]'
1300 subject prefix. Use this variable to change that prefix.
1303 The default for format-patch is to output a signature containing
1304 the Git version number. Use this variable to change that default.
1305 Set this variable to the empty string ("") to suppress
1306 signature generation.
1308 format.signatureFile::
1309 Works just like format.signature except the contents of the
1310 file specified by this variable will be used as the signature.
1313 The default for format-patch is to output files with the suffix
1314 `.patch`. Use this variable to change that suffix (make sure to
1315 include the dot if you want it).
1318 The default pretty format for log/show/whatchanged command,
1319 See linkgit:git-log[1], linkgit:git-show[1],
1320 linkgit:git-whatchanged[1].
1323 The default threading style for 'git format-patch'. Can be
1324 a boolean value, or `shallow` or `deep`. `shallow` threading
1325 makes every mail a reply to the head of the series,
1326 where the head is chosen from the cover letter, the
1327 `--in-reply-to`, and the first patch mail, in this order.
1328 `deep` threading makes every mail a reply to the previous one.
1329 A true boolean value is the same as `shallow`, and a false
1330 value disables threading.
1333 A boolean value which lets you enable the `-s/--signoff` option of
1334 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1335 patch should be a conscious act and means that you certify you have
1336 the rights to submit this work under the same open source license.
1337 Please see the 'SubmittingPatches' document for further discussion.
1339 format.coverLetter::
1340 A boolean that controls whether to generate a cover-letter when
1341 format-patch is invoked, but in addition can be set to "auto", to
1342 generate a cover-letter only when there's more than one patch.
1344 format.outputDirectory::
1345 Set a custom directory to store the resulting files instead of the
1346 current working directory.
1348 format.useAutoBase::
1349 A boolean value which lets you enable the `--base=auto` option of
1350 format-patch by default.
1352 filter.<driver>.clean::
1353 The command which is used to convert the content of a worktree
1354 file to a blob upon checkin. See linkgit:gitattributes[5] for
1357 filter.<driver>.smudge::
1358 The command which is used to convert the content of a blob
1359 object to a worktree file upon checkout. See
1360 linkgit:gitattributes[5] for details.
1363 Allows overriding the message type (error, warn or ignore) of a
1364 specific message ID such as `missingEmail`.
1366 For convenience, fsck prefixes the error/warning with the message ID,
1367 e.g. "missingEmail: invalid author/committer line - missing email" means
1368 that setting `fsck.missingEmail = ignore` will hide that issue.
1370 This feature is intended to support working with legacy repositories
1371 which cannot be repaired without disruptive changes.
1374 The path to a sorted list of object names (i.e. one SHA-1 per
1375 line) that are known to be broken in a non-fatal way and should
1376 be ignored. This feature is useful when an established project
1377 should be accepted despite early commits containing errors that
1378 can be safely ignored such as invalid committer email addresses.
1379 Note: corrupt objects cannot be skipped with this setting.
1381 gc.aggressiveDepth::
1382 The depth parameter used in the delta compression
1383 algorithm used by 'git gc --aggressive'. This defaults
1386 gc.aggressiveWindow::
1387 The window size parameter used in the delta compression
1388 algorithm used by 'git gc --aggressive'. This defaults
1392 When there are approximately more than this many loose
1393 objects in the repository, `git gc --auto` will pack them.
1394 Some Porcelain commands use this command to perform a
1395 light-weight garbage collection from time to time. The
1396 default value is 6700. Setting this to 0 disables it.
1399 When there are more than this many packs that are not
1400 marked with `*.keep` file in the repository, `git gc
1401 --auto` consolidates them into one larger pack. The
1402 default value is 50. Setting this to 0 disables it.
1405 Make `git gc --auto` return immediately and run in background
1406 if the system supports it. Default is true.
1409 If the file gc.log exists, then `git gc --auto` won't run
1410 unless that file is more than 'gc.logExpiry' old. Default is
1411 "1.day". See `gc.pruneExpire` for more ways to specify its
1415 Running `git pack-refs` in a repository renders it
1416 unclonable by Git versions prior to 1.5.1.2 over dumb
1417 transports such as HTTP. This variable determines whether
1418 'git gc' runs `git pack-refs`. This can be set to `notbare`
1419 to enable it within all non-bare repos or it can be set to a
1420 boolean value. The default is `true`.
1423 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1424 Override the grace period with this config variable. The value
1425 "now" may be used to disable this grace period and always prune
1426 unreachable objects immediately, or "never" may be used to
1427 suppress pruning. This feature helps prevent corruption when
1428 'git gc' runs concurrently with another process writing to the
1429 repository; see the "NOTES" section of linkgit:git-gc[1].
1431 gc.worktreePruneExpire::
1432 When 'git gc' is run, it calls
1433 'git worktree prune --expire 3.months.ago'.
1434 This config variable can be used to set a different grace
1435 period. The value "now" may be used to disable the grace
1436 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1437 may be used to suppress pruning.
1440 gc.<pattern>.reflogExpire::
1441 'git reflog expire' removes reflog entries older than
1442 this time; defaults to 90 days. The value "now" expires all
1443 entries immediately, and "never" suppresses expiration
1444 altogether. With "<pattern>" (e.g.
1445 "refs/stash") in the middle the setting applies only to
1446 the refs that match the <pattern>.
1448 gc.reflogExpireUnreachable::
1449 gc.<pattern>.reflogExpireUnreachable::
1450 'git reflog expire' removes reflog entries older than
1451 this time and are not reachable from the current tip;
1452 defaults to 30 days. The value "now" expires all entries
1453 immediately, and "never" suppresses expiration altogether.
1454 With "<pattern>" (e.g. "refs/stash")
1455 in the middle, the setting applies only to the refs that
1456 match the <pattern>.
1459 Records of conflicted merge you resolved earlier are
1460 kept for this many days when 'git rerere gc' is run.
1461 The default is 60 days. See linkgit:git-rerere[1].
1463 gc.rerereUnresolved::
1464 Records of conflicted merge you have not resolved are
1465 kept for this many days when 'git rerere gc' is run.
1466 The default is 15 days. See linkgit:git-rerere[1].
1468 gitcvs.commitMsgAnnotation::
1469 Append this string to each commit message. Set to empty string
1470 to disable this feature. Defaults to "via git-CVS emulator".
1473 Whether the CVS server interface is enabled for this repository.
1474 See linkgit:git-cvsserver[1].
1477 Path to a log file where the CVS server interface well... logs
1478 various stuff. See linkgit:git-cvsserver[1].
1480 gitcvs.usecrlfattr::
1481 If true, the server will look up the end-of-line conversion
1482 attributes for files to determine the `-k` modes to use. If
1483 the attributes force Git to treat a file as text,
1484 the `-k` mode will be left blank so CVS clients will
1485 treat it as text. If they suppress text conversion, the file
1486 will be set with '-kb' mode, which suppresses any newline munging
1487 the client might otherwise do. If the attributes do not allow
1488 the file type to be determined, then `gitcvs.allBinary` is
1489 used. See linkgit:gitattributes[5].
1492 This is used if `gitcvs.usecrlfattr` does not resolve
1493 the correct '-kb' mode to use. If true, all
1494 unresolved files are sent to the client in
1495 mode '-kb'. This causes the client to treat them
1496 as binary files, which suppresses any newline munging it
1497 otherwise might do. Alternatively, if it is set to "guess",
1498 then the contents of the file are examined to decide if
1499 it is binary, similar to `core.autocrlf`.
1502 Database used by git-cvsserver to cache revision information
1503 derived from the Git repository. The exact meaning depends on the
1504 used database driver, for SQLite (which is the default driver) this
1505 is a filename. Supports variable substitution (see
1506 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1507 Default: '%Ggitcvs.%m.sqlite'
1510 Used Perl DBI driver. You can specify any available driver
1511 for this here, but it might not work. git-cvsserver is tested
1512 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1513 reported *not* to work with 'DBD::mysql'. Experimental feature.
1514 May not contain double colons (`:`). Default: 'SQLite'.
1515 See linkgit:git-cvsserver[1].
1517 gitcvs.dbUser, gitcvs.dbPass::
1518 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1519 since SQLite has no concept of database users and/or passwords.
1520 'gitcvs.dbUser' supports variable substitution (see
1521 linkgit:git-cvsserver[1] for details).
1523 gitcvs.dbTableNamePrefix::
1524 Database table name prefix. Prepended to the names of any
1525 database tables used, allowing a single database to be used
1526 for several repositories. Supports variable substitution (see
1527 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1528 characters will be replaced with underscores.
1530 All gitcvs variables except for `gitcvs.usecrlfattr` and
1531 `gitcvs.allBinary` can also be specified as
1532 'gitcvs.<access_method>.<varname>' (where 'access_method'
1533 is one of "ext" and "pserver") to make them apply only for the given
1537 gitweb.description::
1540 See linkgit:gitweb[1] for description.
1548 gitweb.remote_heads::
1551 See linkgit:gitweb.conf[5] for description.
1554 If set to true, enable `-n` option by default.
1557 Set the default matching behavior. Using a value of 'basic', 'extended',
1558 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1559 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1560 value 'default' will return to the default matching behavior.
1562 grep.extendedRegexp::
1563 If set to true, enable `--extended-regexp` option by default. This
1564 option is ignored when the `grep.patternType` option is set to a value
1565 other than 'default'.
1568 Number of grep worker threads to use.
1569 See `grep.threads` in linkgit:git-grep[1] for more information.
1571 grep.fallbackToNoIndex::
1572 If set to true, fall back to git grep --no-index if git grep
1573 is executed outside of a git repository. Defaults to false.
1576 Use this custom program instead of "`gpg`" found on `$PATH` when
1577 making or verifying a PGP signature. The program must support the
1578 same command-line interface as GPG, namely, to verify a detached
1579 signature, "`gpg --verify $file - <$signature`" is run, and the
1580 program is expected to signal a good signature by exiting with
1581 code 0, and to generate an ASCII-armored detached signature, the
1582 standard input of "`gpg -bsau $key`" is fed with the contents to be
1583 signed, and the program is expected to send the result to its
1586 gui.commitMsgWidth::
1587 Defines how wide the commit message window is in the
1588 linkgit:git-gui[1]. "75" is the default.
1591 Specifies how many context lines should be used in calls to diff
1592 made by the linkgit:git-gui[1]. The default is "5".
1594 gui.displayUntracked::
1595 Determines if linkgit:git-gui[1] shows untracked files
1596 in the file list. The default is "true".
1599 Specifies the default encoding to use for displaying of
1600 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1601 It can be overridden by setting the 'encoding' attribute
1602 for relevant files (see linkgit:gitattributes[5]).
1603 If this option is not set, the tools default to the
1606 gui.matchTrackingBranch::
1607 Determines if new branches created with linkgit:git-gui[1] should
1608 default to tracking remote branches with matching names or
1609 not. Default: "false".
1611 gui.newBranchTemplate::
1612 Is used as suggested name when creating new branches using the
1615 gui.pruneDuringFetch::
1616 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1617 performing a fetch. The default value is "false".
1620 Determines if linkgit:git-gui[1] should trust the file modification
1621 timestamp or not. By default the timestamps are not trusted.
1623 gui.spellingDictionary::
1624 Specifies the dictionary used for spell checking commit messages in
1625 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1629 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1630 location detection. It makes blame significantly faster on huge
1631 repositories at the expense of less thorough copy detection.
1633 gui.copyBlameThreshold::
1634 Specifies the threshold to use in 'git gui blame' original location
1635 detection, measured in alphanumeric characters. See the
1636 linkgit:git-blame[1] manual for more information on copy detection.
1638 gui.blamehistoryctx::
1639 Specifies the radius of history context in days to show in
1640 linkgit:gitk[1] for the selected commit, when the `Show History
1641 Context` menu item is invoked from 'git gui blame'. If this
1642 variable is set to zero, the whole history is shown.
1644 guitool.<name>.cmd::
1645 Specifies the shell command line to execute when the corresponding item
1646 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1647 mandatory for every tool. The command is executed from the root of
1648 the working directory, and in the environment it receives the name of
1649 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1650 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1651 the head is detached, 'CUR_BRANCH' is empty).
1653 guitool.<name>.needsFile::
1654 Run the tool only if a diff is selected in the GUI. It guarantees
1655 that 'FILENAME' is not empty.
1657 guitool.<name>.noConsole::
1658 Run the command silently, without creating a window to display its
1661 guitool.<name>.noRescan::
1662 Don't rescan the working directory for changes after the tool
1665 guitool.<name>.confirm::
1666 Show a confirmation dialog before actually running the tool.
1668 guitool.<name>.argPrompt::
1669 Request a string argument from the user, and pass it to the tool
1670 through the `ARGS` environment variable. Since requesting an
1671 argument implies confirmation, the 'confirm' option has no effect
1672 if this is enabled. If the option is set to 'true', 'yes', or '1',
1673 the dialog uses a built-in generic prompt; otherwise the exact
1674 value of the variable is used.
1676 guitool.<name>.revPrompt::
1677 Request a single valid revision from the user, and set the
1678 `REVISION` environment variable. In other aspects this option
1679 is similar to 'argPrompt', and can be used together with it.
1681 guitool.<name>.revUnmerged::
1682 Show only unmerged branches in the 'revPrompt' subdialog.
1683 This is useful for tools similar to merge or rebase, but not
1684 for things like checkout or reset.
1686 guitool.<name>.title::
1687 Specifies the title to use for the prompt dialog. The default
1690 guitool.<name>.prompt::
1691 Specifies the general prompt string to display at the top of
1692 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1693 The default value includes the actual command.
1696 Specify the browser that will be used to display help in the
1697 'web' format. See linkgit:git-help[1].
1700 Override the default help format used by linkgit:git-help[1].
1701 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1702 the default. 'web' and 'html' are the same.
1705 Automatically correct and execute mistyped commands after
1706 waiting for the given number of deciseconds (0.1 sec). If more
1707 than one command can be deduced from the entered text, nothing
1708 will be executed. If the value of this option is negative,
1709 the corrected command will be executed immediately. If the
1710 value is 0 - the command will be just shown but not executed.
1711 This is the default.
1714 Specify the path where the HTML documentation resides. File system paths
1715 and URLs are supported. HTML pages will be prefixed with this path when
1716 help is displayed in the 'web' format. This defaults to the documentation
1717 path of your Git installation.
1720 Override the HTTP proxy, normally configured using the 'http_proxy',
1721 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1722 addition to the syntax understood by curl, it is possible to specify a
1723 proxy string with a user name but no password, in which case git will
1724 attempt to acquire one in the same way it does for other credentials. See
1725 linkgit:gitcredentials[7] for more information. The syntax thus is
1726 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1727 on a per-remote basis; see remote.<name>.proxy
1729 http.proxyAuthMethod::
1730 Set the method with which to authenticate against the HTTP proxy. This
1731 only takes effect if the configured proxy string contains a user name part
1732 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1733 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1734 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1735 variable. Possible values are:
1738 * `anyauth` - Automatically pick a suitable authentication method. It is
1739 assumed that the proxy answers an unauthenticated request with a 407
1740 status code and one or more Proxy-authenticate headers with supported
1741 authentication methods. This is the default.
1742 * `basic` - HTTP Basic authentication
1743 * `digest` - HTTP Digest authentication; this prevents the password from being
1744 transmitted to the proxy in clear text
1745 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1747 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1751 Attempt authentication without seeking a username or password. This
1752 can be used to attempt GSS-Negotiate authentication without specifying
1753 a username in the URL, as libcurl normally requires a username for
1757 Control GSSAPI credential delegation. The delegation is disabled
1758 by default in libcurl since version 7.21.7. Set parameter to tell
1759 the server what it is allowed to delegate when it comes to user
1760 credentials. Used with GSS/kerberos. Possible values are:
1763 * `none` - Don't allow any delegation.
1764 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1765 Kerberos service ticket, which is a matter of realm policy.
1766 * `always` - Unconditionally allow the server to delegate.
1771 Pass an additional HTTP header when communicating with a server. If
1772 more than one such entry exists, all of them are added as extra
1773 headers. To allow overriding the settings inherited from the system
1774 config, an empty value will reset the extra headers to the empty list.
1777 The pathname of a file containing previously stored cookie lines,
1778 which should be used
1779 in the Git http session, if they match the server. The file format
1780 of the file to read cookies from should be plain HTTP headers or
1781 the Netscape/Mozilla cookie file format (see `curl(1)`).
1782 NOTE that the file specified with http.cookieFile is used only as
1783 input unless http.saveCookies is set.
1786 If set, store cookies received during requests to the file specified by
1787 http.cookieFile. Has no effect if http.cookieFile is unset.
1790 The SSL version to use when negotiating an SSL connection, if you
1791 want to force the default. The available and default version
1792 depend on whether libcurl was built against NSS or OpenSSL and the
1793 particular configuration of the crypto library in use. Internally
1794 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1795 documentation for more details on the format of this option and
1796 for the ssl version supported. Actually the possible values of
1807 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1808 To force git to use libcurl's default ssl version and ignore any
1809 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1812 http.sslCipherList::
1813 A list of SSL ciphers to use when negotiating an SSL connection.
1814 The available ciphers depend on whether libcurl was built against
1815 NSS or OpenSSL and the particular configuration of the crypto
1816 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1817 option; see the libcurl documentation for more details on the format
1820 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1821 To force git to use libcurl's default cipher list and ignore any
1822 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1826 Whether to verify the SSL certificate when fetching or pushing
1827 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1831 File containing the SSL certificate when fetching or pushing
1832 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1836 File containing the SSL private key when fetching or pushing
1837 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1840 http.sslCertPasswordProtected::
1841 Enable Git's password prompt for the SSL certificate. Otherwise
1842 OpenSSL will prompt the user, possibly many times, if the
1843 certificate or private key is encrypted. Can be overridden by the
1844 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1847 File containing the certificates to verify the peer with when
1848 fetching or pushing over HTTPS. Can be overridden by the
1849 `GIT_SSL_CAINFO` environment variable.
1852 Path containing files with the CA certificates to verify the peer
1853 with when fetching or pushing over HTTPS. Can be overridden
1854 by the `GIT_SSL_CAPATH` environment variable.
1857 Public key of the https service. It may either be the filename of
1858 a PEM or DER encoded public key file or a string starting with
1859 'sha256//' followed by the base64 encoded sha256 hash of the
1860 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1861 exit with an error if this option is set but not supported by
1865 Attempt to use AUTH SSL/TLS and encrypted data transfers
1866 when connecting via regular FTP protocol. This might be needed
1867 if the FTP server requires it for security reasons or you wish
1868 to connect securely whenever remote FTP server supports it.
1869 Default is false since it might trigger certificate verification
1870 errors on misconfigured servers.
1873 How many HTTP requests to launch in parallel. Can be overridden
1874 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1877 The number of curl sessions (counted across slots) to be kept across
1878 requests. They will not be ended with curl_easy_cleanup() until
1879 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1880 value will be capped at 1. Defaults to 1.
1883 Maximum size in bytes of the buffer used by smart HTTP
1884 transports when POSTing data to the remote system.
1885 For requests larger than this buffer size, HTTP/1.1 and
1886 Transfer-Encoding: chunked is used to avoid creating a
1887 massive pack file locally. Default is 1 MiB, which is
1888 sufficient for most requests.
1890 http.lowSpeedLimit, http.lowSpeedTime::
1891 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1892 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1893 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1894 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1897 A boolean which disables using of EPSV ftp command by curl.
1898 This can helpful with some "poor" ftp servers which don't
1899 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1900 environment variable. Default is false (curl will use EPSV).
1903 The HTTP USER_AGENT string presented to an HTTP server. The default
1904 value represents the version of the client Git such as git/1.7.1.
1905 This option allows you to override this value to a more common value
1906 such as Mozilla/4.0. This may be necessary, for instance, if
1907 connecting through a firewall that restricts HTTP connections to a set
1908 of common USER_AGENT strings (but not including those like git/1.7.1).
1909 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
1911 http.followRedirects::
1912 Whether git should follow HTTP redirects. If set to `true`, git
1913 will transparently follow any redirect issued by a server it
1914 encounters. If set to `false`, git will treat all redirects as
1915 errors. If set to `initial`, git will follow redirects only for
1916 the initial request to a remote, but not for subsequent
1917 follow-up HTTP requests. Since git uses the redirected URL as
1918 the base for the follow-up requests, this is generally
1919 sufficient. The default is `initial`.
1922 Any of the http.* options above can be applied selectively to some URLs.
1923 For a config key to match a URL, each element of the config key is
1924 compared to that of the URL, in the following order:
1927 . Scheme (e.g., `https` in `https://example.com/`). This field
1928 must match exactly between the config key and the URL.
1930 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1931 This field must match between the config key and the URL. It is
1932 possible to specify a `*` as part of the host name to match all subdomains
1933 at this level. `https://*.example.com/` for example would match
1934 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
1936 . Port number (e.g., `8080` in `http://example.com:8080/`).
1937 This field must match exactly between the config key and the URL.
1938 Omitted port numbers are automatically converted to the correct
1939 default for the scheme before matching.
1941 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1942 path field of the config key must match the path field of the URL
1943 either exactly or as a prefix of slash-delimited path elements. This means
1944 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1945 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1946 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1947 key with just path `foo/`).
1949 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1950 the config key has a user name it must match the user name in the
1951 URL exactly. If the config key does not have a user name, that
1952 config key will match a URL with any user name (including none),
1953 but at a lower precedence than a config key with a user name.
1956 The list above is ordered by decreasing precedence; a URL that matches
1957 a config key's path is preferred to one that matches its user name. For example,
1958 if the URL is `https://user@example.com/foo/bar` a config key match of
1959 `https://example.com/foo` will be preferred over a config key match of
1960 `https://user@example.com`.
1962 All URLs are normalized before attempting any matching (the password part,
1963 if embedded in the URL, is always ignored for matching purposes) so that
1964 equivalent URLs that are simply spelled differently will match properly.
1965 Environment variable settings always override any matches. The URLs that are
1966 matched against are those given directly to Git commands. This means any URLs
1967 visited as a result of a redirection do not participate in matching.
1970 Depending on the value of the environment variables `GIT_SSH` or
1971 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
1972 auto-detects whether to adjust its command-line parameters for use
1973 with plink or tortoiseplink, as opposed to the default (OpenSSH).
1975 The config variable `ssh.variant` can be set to override this auto-detection;
1976 valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
1977 will be treated as normal ssh. This setting can be overridden via the
1978 environment variable `GIT_SSH_VARIANT`.
1980 i18n.commitEncoding::
1981 Character encoding the commit messages are stored in; Git itself
1982 does not care per se, but this information is necessary e.g. when
1983 importing commits from emails or in the gitk graphical history
1984 browser (and possibly at other places in the future or in other
1985 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1987 i18n.logOutputEncoding::
1988 Character encoding the commit messages are converted to when
1989 running 'git log' and friends.
1992 The configuration variables in the 'imap' section are described
1993 in linkgit:git-imap-send[1].
1996 Specify the version with which new index files should be
1997 initialized. This does not affect existing repositories.
2000 Specify the directory from which templates will be copied.
2001 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2004 Specify the program that will be used to browse your working
2005 repository in gitweb. See linkgit:git-instaweb[1].
2008 The HTTP daemon command-line to start gitweb on your working
2009 repository. See linkgit:git-instaweb[1].
2012 If true the web server started by linkgit:git-instaweb[1] will
2013 be bound to the local IP (127.0.0.1).
2015 instaweb.modulePath::
2016 The default module path for linkgit:git-instaweb[1] to use
2017 instead of /usr/lib/apache2/modules. Only used if httpd
2021 The port number to bind the gitweb httpd to. See
2022 linkgit:git-instaweb[1].
2024 interactive.singleKey::
2025 In interactive commands, allow the user to provide one-letter
2026 input with a single key (i.e., without hitting enter).
2027 Currently this is used by the `--patch` mode of
2028 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2029 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2030 setting is silently ignored if portable keystroke input
2031 is not available; requires the Perl module Term::ReadKey.
2033 interactive.diffFilter::
2034 When an interactive command (such as `git add --patch`) shows
2035 a colorized diff, git will pipe the diff through the shell
2036 command defined by this configuration variable. The command may
2037 mark up the diff further for human consumption, provided that it
2038 retains a one-to-one correspondence with the lines in the
2039 original diff. Defaults to disabled (no filtering).
2042 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2043 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2044 override this option with `--no-abbrev-commit`.
2047 Set the default date-time mode for the 'log' command.
2048 Setting a value for log.date is similar to using 'git log''s
2049 `--date` option. See linkgit:git-log[1] for details.
2052 Print out the ref names of any commits that are shown by the log
2053 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2054 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2055 specified, the full ref name (including prefix) will be printed.
2056 If 'auto' is specified, then if the output is going to a terminal,
2057 the ref names are shown as if 'short' were given, otherwise no ref
2058 names are shown. This is the same as the `--decorate` option
2062 If `true`, `git log` will act as if the `--follow` option was used when
2063 a single <path> is given. This has the same limitations as `--follow`,
2064 i.e. it cannot be used to follow multiple files and does not work well
2065 on non-linear history.
2068 A list of colors, separated by commas, that can be used to draw
2069 history lines in `git log --graph`.
2072 If true, the initial commit will be shown as a big creation event.
2073 This is equivalent to a diff against an empty tree.
2074 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2075 normally hide the root commit will now show it. True by default.
2078 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2079 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2082 If true, makes linkgit:git-mailinfo[1] (and therefore
2083 linkgit:git-am[1]) act by default as if the --scissors option
2084 was provided on the command-line. When active, this features
2085 removes everything from the message body before a scissors
2086 line (i.e. consisting mainly of ">8", "8<" and "-").
2089 The location of an augmenting mailmap file. The default
2090 mailmap, located in the root of the repository, is loaded
2091 first, then the mailmap file pointed to by this variable.
2092 The location of the mailmap file may be in a repository
2093 subdirectory, or somewhere outside of the repository itself.
2094 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2097 Like `mailmap.file`, but consider the value as a reference to a
2098 blob in the repository. If both `mailmap.file` and
2099 `mailmap.blob` are given, both are parsed, with entries from
2100 `mailmap.file` taking precedence. In a bare repository, this
2101 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2105 Specify the programs that may be used to display help in the
2106 'man' format. See linkgit:git-help[1].
2109 Specify the command to invoke the specified man viewer. The
2110 specified command is evaluated in shell with the man page
2111 passed as argument. (See linkgit:git-help[1].)
2114 Override the path for the given tool that may be used to
2115 display help in the 'man' format. See linkgit:git-help[1].
2117 include::merge-config.txt[]
2119 mergetool.<tool>.path::
2120 Override the path for the given tool. This is useful in case
2121 your tool is not in the PATH.
2123 mergetool.<tool>.cmd::
2124 Specify the command to invoke the specified merge tool. The
2125 specified command is evaluated in shell with the following
2126 variables available: 'BASE' is the name of a temporary file
2127 containing the common base of the files to be merged, if available;
2128 'LOCAL' is the name of a temporary file containing the contents of
2129 the file on the current branch; 'REMOTE' is the name of a temporary
2130 file containing the contents of the file from the branch being
2131 merged; 'MERGED' contains the name of the file to which the merge
2132 tool should write the results of a successful merge.
2134 mergetool.<tool>.trustExitCode::
2135 For a custom merge command, specify whether the exit code of
2136 the merge command can be used to determine whether the merge was
2137 successful. If this is not set to true then the merge target file
2138 timestamp is checked and the merge assumed to have been successful
2139 if the file has been updated, otherwise the user is prompted to
2140 indicate the success of the merge.
2142 mergetool.meld.hasOutput::
2143 Older versions of `meld` do not support the `--output` option.
2144 Git will attempt to detect whether `meld` supports `--output`
2145 by inspecting the output of `meld --help`. Configuring
2146 `mergetool.meld.hasOutput` will make Git skip these checks and
2147 use the configured value instead. Setting `mergetool.meld.hasOutput`
2148 to `true` tells Git to unconditionally use the `--output` option,
2149 and `false` avoids using `--output`.
2151 mergetool.keepBackup::
2152 After performing a merge, the original file with conflict markers
2153 can be saved as a file with a `.orig` extension. If this variable
2154 is set to `false` then this file is not preserved. Defaults to
2155 `true` (i.e. keep the backup files).
2157 mergetool.keepTemporaries::
2158 When invoking a custom merge tool, Git uses a set of temporary
2159 files to pass to the tool. If the tool returns an error and this
2160 variable is set to `true`, then these temporary files will be
2161 preserved, otherwise they will be removed after the tool has
2162 exited. Defaults to `false`.
2164 mergetool.writeToTemp::
2165 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2166 conflicting files in the worktree by default. Git will attempt
2167 to use a temporary directory for these files when set `true`.
2168 Defaults to `false`.
2171 Prompt before each invocation of the merge resolution program.
2173 notes.mergeStrategy::
2174 Which merge strategy to choose by default when resolving notes
2175 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2176 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2177 section of linkgit:git-notes[1] for more information on each strategy.
2179 notes.<name>.mergeStrategy::
2180 Which merge strategy to choose when doing a notes merge into
2181 refs/notes/<name>. This overrides the more general
2182 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2183 linkgit:git-notes[1] for more information on the available strategies.
2186 The (fully qualified) refname from which to show notes when
2187 showing commit messages. The value of this variable can be set
2188 to a glob, in which case notes from all matching refs will be
2189 shown. You may also specify this configuration variable
2190 several times. A warning will be issued for refs that do not
2191 exist, but a glob that does not match any refs is silently
2194 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2195 environment variable, which must be a colon separated list of refs or
2198 The effective value of "core.notesRef" (possibly overridden by
2199 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2202 notes.rewrite.<command>::
2203 When rewriting commits with <command> (currently `amend` or
2204 `rebase`) and this variable is set to `true`, Git
2205 automatically copies your notes from the original to the
2206 rewritten commit. Defaults to `true`, but see
2207 "notes.rewriteRef" below.
2210 When copying notes during a rewrite (see the
2211 "notes.rewrite.<command>" option), determines what to do if
2212 the target commit already has a note. Must be one of
2213 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2214 Defaults to `concatenate`.
2216 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2217 environment variable.
2220 When copying notes during a rewrite, specifies the (fully
2221 qualified) ref whose notes should be copied. The ref may be a
2222 glob, in which case notes in all matching refs will be copied.
2223 You may also specify this configuration several times.
2225 Does not have a default value; you must configure this variable to
2226 enable note rewriting. Set it to `refs/notes/commits` to enable
2227 rewriting for the default commit notes.
2229 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2230 environment variable, which must be a colon separated list of refs or
2234 The size of the window used by linkgit:git-pack-objects[1] when no
2235 window size is given on the command line. Defaults to 10.
2238 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2239 maximum depth is given on the command line. Defaults to 50.
2242 The maximum size of memory that is consumed by each thread
2243 in linkgit:git-pack-objects[1] for pack window memory when
2244 no limit is given on the command line. The value can be
2245 suffixed with "k", "m", or "g". When left unconfigured (or
2246 set explicitly to 0), there will be no limit.
2249 An integer -1..9, indicating the compression level for objects
2250 in a pack file. -1 is the zlib default. 0 means no
2251 compression, and 1..9 are various speed/size tradeoffs, 9 being
2252 slowest. If not set, defaults to core.compression. If that is
2253 not set, defaults to -1, the zlib default, which is "a default
2254 compromise between speed and compression (currently equivalent
2257 Note that changing the compression level will not automatically recompress
2258 all existing objects. You can force recompression by passing the -F option
2259 to linkgit:git-repack[1].
2261 pack.deltaCacheSize::
2262 The maximum memory in bytes used for caching deltas in
2263 linkgit:git-pack-objects[1] before writing them out to a pack.
2264 This cache is used to speed up the writing object phase by not
2265 having to recompute the final delta result once the best match
2266 for all objects is found. Repacking large repositories on machines
2267 which are tight with memory might be badly impacted by this though,
2268 especially if this cache pushes the system into swapping.
2269 A value of 0 means no limit. The smallest size of 1 byte may be
2270 used to virtually disable this cache. Defaults to 256 MiB.
2272 pack.deltaCacheLimit::
2273 The maximum size of a delta, that is cached in
2274 linkgit:git-pack-objects[1]. This cache is used to speed up the
2275 writing object phase by not having to recompute the final delta
2276 result once the best match for all objects is found. Defaults to 1000.
2279 Specifies the number of threads to spawn when searching for best
2280 delta matches. This requires that linkgit:git-pack-objects[1]
2281 be compiled with pthreads otherwise this option is ignored with a
2282 warning. This is meant to reduce packing time on multiprocessor
2283 machines. The required amount of memory for the delta search window
2284 is however multiplied by the number of threads.
2285 Specifying 0 will cause Git to auto-detect the number of CPU's
2286 and set the number of threads accordingly.
2289 Specify the default pack index version. Valid values are 1 for
2290 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2291 the new pack index with capabilities for packs larger than 4 GB
2292 as well as proper protection against the repacking of corrupted
2293 packs. Version 2 is the default. Note that version 2 is enforced
2294 and this config option ignored whenever the corresponding pack is
2297 If you have an old Git that does not understand the version 2 `*.idx` file,
2298 cloning or fetching over a non native protocol (e.g. "http")
2299 that will copy both `*.pack` file and corresponding `*.idx` file from the
2300 other side may give you a repository that cannot be accessed with your
2301 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2302 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2305 pack.packSizeLimit::
2306 The maximum size of a pack. This setting only affects
2307 packing to a file when repacking, i.e. the git:// protocol
2308 is unaffected. It can be overridden by the `--max-pack-size`
2309 option of linkgit:git-repack[1]. Reaching this limit results
2310 in the creation of multiple packfiles; which in turn prevents
2311 bitmaps from being created.
2312 The minimum size allowed is limited to 1 MiB.
2313 The default is unlimited.
2314 Common unit suffixes of 'k', 'm', or 'g' are
2318 When true, git will use pack bitmaps (if available) when packing
2319 to stdout (e.g., during the server side of a fetch). Defaults to
2320 true. You should not generally need to turn this off unless
2321 you are debugging pack bitmaps.
2323 pack.writeBitmaps (deprecated)::
2324 This is a deprecated synonym for `repack.writeBitmaps`.
2326 pack.writeBitmapHashCache::
2327 When true, git will include a "hash cache" section in the bitmap
2328 index (if one is written). This cache can be used to feed git's
2329 delta heuristics, potentially leading to better deltas between
2330 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2331 between an older, bitmapped pack and objects that have been
2332 pushed since the last gc). The downside is that it consumes 4
2333 bytes per object of disk space, and that JGit's bitmap
2334 implementation does not understand it, causing it to complain if
2335 Git and JGit are used on the same repository. Defaults to false.
2338 If the value is boolean, turns on or off pagination of the
2339 output of a particular Git subcommand when writing to a tty.
2340 Otherwise, turns on pagination for the subcommand using the
2341 pager specified by the value of `pager.<cmd>`. If `--paginate`
2342 or `--no-pager` is specified on the command line, it takes
2343 precedence over this option. To disable pagination for all
2344 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2347 Alias for a --pretty= format string, as specified in
2348 linkgit:git-log[1]. Any aliases defined here can be used just
2349 as the built-in pretty formats could. For example,
2350 running `git config pretty.changelog "format:* %H %s"`
2351 would cause the invocation `git log --pretty=changelog`
2352 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2353 Note that an alias with the same name as a built-in format
2354 will be silently ignored.
2357 If set, provide a user defined default policy for all protocols which
2358 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2359 if unset, known-safe protocols (http, https, git, ssh, file) have a
2360 default policy of `always`, known-dangerous protocols (ext) have a
2361 default policy of `never`, and all other protocols have a default
2362 policy of `user`. Supported policies:
2366 * `always` - protocol is always able to be used.
2368 * `never` - protocol is never able to be used.
2370 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2371 either unset or has a value of 1. This policy should be used when you want a
2372 protocol to be directly usable by the user but don't want it used by commands which
2373 execute clone/fetch/push commands without user input, e.g. recursive
2374 submodule initialization.
2378 protocol.<name>.allow::
2379 Set a policy to be used by protocol `<name>` with clone/fetch/push
2380 commands. See `protocol.allow` above for the available policies.
2382 The protocol names currently used by git are:
2385 - `file`: any local file-based path (including `file://` URLs,
2388 - `git`: the anonymous git protocol over a direct TCP
2389 connection (or proxy, if configured)
2391 - `ssh`: git over ssh (including `host:path` syntax,
2394 - `http`: git over http, both "smart http" and "dumb http".
2395 Note that this does _not_ include `https`; if you want to configure
2396 both, you must do so individually.
2398 - any external helpers are named by their protocol (e.g., use
2399 `hg` to allow the `git-remote-hg` helper)
2403 By default, Git does not create an extra merge commit when merging
2404 a commit that is a descendant of the current commit. Instead, the
2405 tip of the current branch is fast-forwarded. When set to `false`,
2406 this variable tells Git to create an extra merge commit in such
2407 a case (equivalent to giving the `--no-ff` option from the command
2408 line). When set to `only`, only such fast-forward merges are
2409 allowed (equivalent to giving the `--ff-only` option from the
2410 command line). This setting overrides `merge.ff` when pulling.
2413 When true, rebase branches on top of the fetched branch, instead
2414 of merging the default branch from the default remote when "git
2415 pull" is run. See "branch.<name>.rebase" for setting this on a
2418 When preserve, also pass `--preserve-merges` along to 'git rebase'
2419 so that locally committed merge commits will not be flattened
2420 by running 'git pull'.
2422 When the value is `interactive`, the rebase is run in interactive mode.
2424 *NOTE*: this is a possibly dangerous operation; do *not* use
2425 it unless you understand the implications (see linkgit:git-rebase[1]
2429 The default merge strategy to use when pulling multiple branches
2433 The default merge strategy to use when pulling a single branch.
2436 Defines the action `git push` should take if no refspec is
2437 explicitly given. Different values are well-suited for
2438 specific workflows; for instance, in a purely central workflow
2439 (i.e. the fetch source is equal to the push destination),
2440 `upstream` is probably what you want. Possible values are:
2444 * `nothing` - do not push anything (error out) unless a refspec is
2445 explicitly given. This is primarily meant for people who want to
2446 avoid mistakes by always being explicit.
2448 * `current` - push the current branch to update a branch with the same
2449 name on the receiving end. Works in both central and non-central
2452 * `upstream` - push the current branch back to the branch whose
2453 changes are usually integrated into the current branch (which is
2454 called `@{upstream}`). This mode only makes sense if you are
2455 pushing to the same repository you would normally pull from
2456 (i.e. central workflow).
2458 * `simple` - in centralized workflow, work like `upstream` with an
2459 added safety to refuse to push if the upstream branch's name is
2460 different from the local one.
2462 When pushing to a remote that is different from the remote you normally
2463 pull from, work as `current`. This is the safest option and is suited
2466 This mode has become the default in Git 2.0.
2468 * `matching` - push all branches having the same name on both ends.
2469 This makes the repository you are pushing to remember the set of
2470 branches that will be pushed out (e.g. if you always push 'maint'
2471 and 'master' there and no other branches, the repository you push
2472 to will have these two branches, and your local 'maint' and
2473 'master' will be pushed there).
2475 To use this mode effectively, you have to make sure _all_ the
2476 branches you would push out are ready to be pushed out before
2477 running 'git push', as the whole point of this mode is to allow you
2478 to push all of the branches in one go. If you usually finish work
2479 on only one branch and push out the result, while other branches are
2480 unfinished, this mode is not for you. Also this mode is not
2481 suitable for pushing into a shared central repository, as other
2482 people may add new branches there, or update the tip of existing
2483 branches outside your control.
2485 This used to be the default, but not since Git 2.0 (`simple` is the
2491 If set to true enable `--follow-tags` option by default. You
2492 may override this configuration at time of push by specifying
2496 May be set to a boolean value, or the string 'if-asked'. A true
2497 value causes all pushes to be GPG signed, as if `--signed` is
2498 passed to linkgit:git-push[1]. The string 'if-asked' causes
2499 pushes to be signed if the server supports it, as if
2500 `--signed=if-asked` is passed to 'git push'. A false value may
2501 override a value from a lower-priority config file. An explicit
2502 command-line flag always overrides this config option.
2504 push.recurseSubmodules::
2505 Make sure all submodule commits used by the revisions to be pushed
2506 are available on a remote-tracking branch. If the value is 'check'
2507 then Git will verify that all submodule commits that changed in the
2508 revisions to be pushed are available on at least one remote of the
2509 submodule. If any commits are missing, the push will be aborted and
2510 exit with non-zero status. If the value is 'on-demand' then all
2511 submodules that changed in the revisions to be pushed will be
2512 pushed. If on-demand was not able to push all necessary revisions
2513 it will also be aborted and exit with non-zero status. If the value
2514 is 'no' then default behavior of ignoring submodules when pushing
2515 is retained. You may override this configuration at time of push by
2516 specifying '--recurse-submodules=check|on-demand|no'.
2519 Whether to show a diffstat of what changed upstream since the last
2520 rebase. False by default.
2523 If set to true enable `--autosquash` option by default.
2526 When set to true, automatically create a temporary stash
2527 before the operation begins, and apply it after the operation
2528 ends. This means that you can run rebase on a dirty worktree.
2529 However, use with care: the final stash application after a
2530 successful rebase might result in non-trivial conflicts.
2533 rebase.missingCommitsCheck::
2534 If set to "warn", git rebase -i will print a warning if some
2535 commits are removed (e.g. a line was deleted), however the
2536 rebase will still proceed. If set to "error", it will print
2537 the previous warning and stop the rebase, 'git rebase
2538 --edit-todo' can then be used to correct the error. If set to
2539 "ignore", no checking is done.
2540 To drop a commit without warning or error, use the `drop`
2541 command in the todo-list.
2542 Defaults to "ignore".
2544 rebase.instructionFormat::
2545 A format string, as specified in linkgit:git-log[1], to be used for
2546 the instruction list during an interactive rebase. The format will automatically
2547 have the long commit hash prepended to the format.
2549 receive.advertiseAtomic::
2550 By default, git-receive-pack will advertise the atomic push
2551 capability to its clients. If you don't want to advertise this
2552 capability, set this variable to false.
2554 receive.advertisePushOptions::
2555 By default, git-receive-pack will advertise the push options
2556 capability to its clients. If you don't want to advertise this
2557 capability, set this variable to false.
2560 By default, git-receive-pack will run "git-gc --auto" after
2561 receiving data from git-push and updating refs. You can stop
2562 it by setting this variable to false.
2564 receive.certNonceSeed::
2565 By setting this variable to a string, `git receive-pack`
2566 will accept a `git push --signed` and verifies it by using
2567 a "nonce" protected by HMAC using this string as a secret
2570 receive.certNonceSlop::
2571 When a `git push --signed` sent a push certificate with a
2572 "nonce" that was issued by a receive-pack serving the same
2573 repository within this many seconds, export the "nonce"
2574 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2575 hooks (instead of what the receive-pack asked the sending
2576 side to include). This may allow writing checks in
2577 `pre-receive` and `post-receive` a bit easier. Instead of
2578 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2579 that records by how many seconds the nonce is stale to
2580 decide if they want to accept the certificate, they only
2581 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2583 receive.fsckObjects::
2584 If it is set to true, git-receive-pack will check all received
2585 objects. It will abort in the case of a malformed object or a
2586 broken link. The result of an abort are only dangling objects.
2587 Defaults to false. If not set, the value of `transfer.fsckObjects`
2590 receive.fsck.<msg-id>::
2591 When `receive.fsckObjects` is set to true, errors can be switched
2592 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2593 setting where the `<msg-id>` is the fsck message ID and the value
2594 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2595 the error/warning with the message ID, e.g. "missingEmail: invalid
2596 author/committer line - missing email" means that setting
2597 `receive.fsck.missingEmail = ignore` will hide that issue.
2599 This feature is intended to support working with legacy repositories
2600 which would not pass pushing when `receive.fsckObjects = true`, allowing
2601 the host to accept repositories with certain known issues but still catch
2604 receive.fsck.skipList::
2605 The path to a sorted list of object names (i.e. one SHA-1 per
2606 line) that are known to be broken in a non-fatal way and should
2607 be ignored. This feature is useful when an established project
2608 should be accepted despite early commits containing errors that
2609 can be safely ignored such as invalid committer email addresses.
2610 Note: corrupt objects cannot be skipped with this setting.
2613 After receiving the pack from the client, `receive-pack` may
2614 produce no output (if `--quiet` was specified) while processing
2615 the pack, causing some networks to drop the TCP connection.
2616 With this option set, if `receive-pack` does not transmit
2617 any data in this phase for `receive.keepAlive` seconds, it will
2618 send a short keepalive packet. The default is 5 seconds; set
2619 to 0 to disable keepalives entirely.
2621 receive.unpackLimit::
2622 If the number of objects received in a push is below this
2623 limit then the objects will be unpacked into loose object
2624 files. However if the number of received objects equals or
2625 exceeds this limit then the received pack will be stored as
2626 a pack, after adding any missing delta bases. Storing the
2627 pack from a push can make the push operation complete faster,
2628 especially on slow filesystems. If not set, the value of
2629 `transfer.unpackLimit` is used instead.
2631 receive.maxInputSize::
2632 If the size of the incoming pack stream is larger than this
2633 limit, then git-receive-pack will error out, instead of
2634 accepting the pack file. If not set or set to 0, then the size
2637 receive.denyDeletes::
2638 If set to true, git-receive-pack will deny a ref update that deletes
2639 the ref. Use this to prevent such a ref deletion via a push.
2641 receive.denyDeleteCurrent::
2642 If set to true, git-receive-pack will deny a ref update that
2643 deletes the currently checked out branch of a non-bare repository.
2645 receive.denyCurrentBranch::
2646 If set to true or "refuse", git-receive-pack will deny a ref update
2647 to the currently checked out branch of a non-bare repository.
2648 Such a push is potentially dangerous because it brings the HEAD
2649 out of sync with the index and working tree. If set to "warn",
2650 print a warning of such a push to stderr, but allow the push to
2651 proceed. If set to false or "ignore", allow such pushes with no
2652 message. Defaults to "refuse".
2654 Another option is "updateInstead" which will update the working
2655 tree if pushing into the current branch. This option is
2656 intended for synchronizing working directories when one side is not easily
2657 accessible via interactive ssh (e.g. a live web site, hence the requirement
2658 that the working directory be clean). This mode also comes in handy when
2659 developing inside a VM to test and fix code on different Operating Systems.
2661 By default, "updateInstead" will refuse the push if the working tree or
2662 the index have any difference from the HEAD, but the `push-to-checkout`
2663 hook can be used to customize this. See linkgit:githooks[5].
2665 receive.denyNonFastForwards::
2666 If set to true, git-receive-pack will deny a ref update which is
2667 not a fast-forward. Use this to prevent such an update via a push,
2668 even if that push is forced. This configuration variable is
2669 set when initializing a shared repository.
2672 This variable is the same as `transfer.hideRefs`, but applies
2673 only to `receive-pack` (and so affects pushes, but not fetches).
2674 An attempt to update or delete a hidden ref by `git push` is
2677 receive.updateServerInfo::
2678 If set to true, git-receive-pack will run git-update-server-info
2679 after receiving data from git-push and updating refs.
2681 receive.shallowUpdate::
2682 If set to true, .git/shallow can be updated when new refs
2683 require new shallow roots. Otherwise those refs are rejected.
2685 remote.pushDefault::
2686 The remote to push to by default. Overrides
2687 `branch.<name>.remote` for all branches, and is overridden by
2688 `branch.<name>.pushRemote` for specific branches.
2691 The URL of a remote repository. See linkgit:git-fetch[1] or
2692 linkgit:git-push[1].
2694 remote.<name>.pushurl::
2695 The push URL of a remote repository. See linkgit:git-push[1].
2697 remote.<name>.proxy::
2698 For remotes that require curl (http, https and ftp), the URL to
2699 the proxy to use for that remote. Set to the empty string to
2700 disable proxying for that remote.
2702 remote.<name>.proxyAuthMethod::
2703 For remotes that require curl (http, https and ftp), the method to use for
2704 authenticating against the proxy in use (probably set in
2705 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2707 remote.<name>.fetch::
2708 The default set of "refspec" for linkgit:git-fetch[1]. See
2709 linkgit:git-fetch[1].
2711 remote.<name>.push::
2712 The default set of "refspec" for linkgit:git-push[1]. See
2713 linkgit:git-push[1].
2715 remote.<name>.mirror::
2716 If true, pushing to this remote will automatically behave
2717 as if the `--mirror` option was given on the command line.
2719 remote.<name>.skipDefaultUpdate::
2720 If true, this remote will be skipped by default when updating
2721 using linkgit:git-fetch[1] or the `update` subcommand of
2722 linkgit:git-remote[1].
2724 remote.<name>.skipFetchAll::
2725 If true, this remote will be skipped by default when updating
2726 using linkgit:git-fetch[1] or the `update` subcommand of
2727 linkgit:git-remote[1].
2729 remote.<name>.receivepack::
2730 The default program to execute on the remote side when pushing. See
2731 option --receive-pack of linkgit:git-push[1].
2733 remote.<name>.uploadpack::
2734 The default program to execute on the remote side when fetching. See
2735 option --upload-pack of linkgit:git-fetch-pack[1].
2737 remote.<name>.tagOpt::
2738 Setting this value to --no-tags disables automatic tag following when
2739 fetching from remote <name>. Setting it to --tags will fetch every
2740 tag from remote <name>, even if they are not reachable from remote
2741 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2742 override this setting. See options --tags and --no-tags of
2743 linkgit:git-fetch[1].
2746 Setting this to a value <vcs> will cause Git to interact with
2747 the remote with the git-remote-<vcs> helper.
2749 remote.<name>.prune::
2750 When set to true, fetching from this remote by default will also
2751 remove any remote-tracking references that no longer exist on the
2752 remote (as if the `--prune` option was given on the command line).
2753 Overrides `fetch.prune` settings, if any.
2756 The list of remotes which are fetched by "git remote update
2757 <group>". See linkgit:git-remote[1].
2759 repack.useDeltaBaseOffset::
2760 By default, linkgit:git-repack[1] creates packs that use
2761 delta-base offset. If you need to share your repository with
2762 Git older than version 1.4.4, either directly or via a dumb
2763 protocol such as http, then you need to set this option to
2764 "false" and repack. Access from old Git versions over the
2765 native protocol are unaffected by this option.
2767 repack.packKeptObjects::
2768 If set to true, makes `git repack` act as if
2769 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2770 details. Defaults to `false` normally, but `true` if a bitmap
2771 index is being written (either via `--write-bitmap-index` or
2772 `repack.writeBitmaps`).
2774 repack.writeBitmaps::
2775 When true, git will write a bitmap index when packing all
2776 objects to disk (e.g., when `git repack -a` is run). This
2777 index can speed up the "counting objects" phase of subsequent
2778 packs created for clones and fetches, at the cost of some disk
2779 space and extra time spent on the initial repack. This has
2780 no effect if multiple packfiles are created.
2784 When set to true, `git-rerere` updates the index with the
2785 resulting contents after it cleanly resolves conflicts using
2786 previously recorded resolution. Defaults to false.
2789 Activate recording of resolved conflicts, so that identical
2790 conflict hunks can be resolved automatically, should they be
2791 encountered again. By default, linkgit:git-rerere[1] is
2792 enabled if there is an `rr-cache` directory under the
2793 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2796 sendemail.identity::
2797 A configuration identity. When given, causes values in the
2798 'sendemail.<identity>' subsection to take precedence over
2799 values in the 'sendemail' section. The default identity is
2800 the value of `sendemail.identity`.
2802 sendemail.smtpEncryption::
2803 See linkgit:git-send-email[1] for description. Note that this
2804 setting is not subject to the 'identity' mechanism.
2806 sendemail.smtpssl (deprecated)::
2807 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2809 sendemail.smtpsslcertpath::
2810 Path to ca-certificates (either a directory or a single file).
2811 Set it to an empty string to disable certificate verification.
2813 sendemail.<identity>.*::
2814 Identity-specific versions of the 'sendemail.*' parameters
2815 found below, taking precedence over those when the this
2816 identity is selected, through command-line or
2817 `sendemail.identity`.
2819 sendemail.aliasesFile::
2820 sendemail.aliasFileType::
2821 sendemail.annotate::
2825 sendemail.chainReplyTo::
2827 sendemail.envelopeSender::
2829 sendemail.multiEdit::
2830 sendemail.signedoffbycc::
2831 sendemail.smtpPass::
2832 sendemail.suppresscc::
2833 sendemail.suppressFrom::
2835 sendemail.smtpDomain::
2836 sendemail.smtpServer::
2837 sendemail.smtpServerPort::
2838 sendemail.smtpServerOption::
2839 sendemail.smtpUser::
2841 sendemail.transferEncoding::
2842 sendemail.validate::
2844 See linkgit:git-send-email[1] for description.
2846 sendemail.signedoffcc (deprecated)::
2847 Deprecated alias for `sendemail.signedoffbycc`.
2849 showbranch.default::
2850 The default set of branches for linkgit:git-show-branch[1].
2851 See linkgit:git-show-branch[1].
2853 status.relativePaths::
2854 By default, linkgit:git-status[1] shows paths relative to the
2855 current directory. Setting this variable to `false` shows paths
2856 relative to the repository root (this was the default for Git
2860 Set to true to enable --short by default in linkgit:git-status[1].
2861 The option --no-short takes precedence over this variable.
2864 Set to true to enable --branch by default in linkgit:git-status[1].
2865 The option --no-branch takes precedence over this variable.
2867 status.displayCommentPrefix::
2868 If set to true, linkgit:git-status[1] will insert a comment
2869 prefix before each output line (starting with
2870 `core.commentChar`, i.e. `#` by default). This was the
2871 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2874 status.showUntrackedFiles::
2875 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2876 files which are not currently tracked by Git. Directories which
2877 contain only untracked files, are shown with the directory name
2878 only. Showing untracked files means that Git needs to lstat() all
2879 the files in the whole repository, which might be slow on some
2880 systems. So, this variable controls how the commands displays
2881 the untracked files. Possible values are:
2884 * `no` - Show no untracked files.
2885 * `normal` - Show untracked files and directories.
2886 * `all` - Show also individual files in untracked directories.
2889 If this variable is not specified, it defaults to 'normal'.
2890 This variable can be overridden with the -u|--untracked-files option
2891 of linkgit:git-status[1] and linkgit:git-commit[1].
2893 status.submoduleSummary::
2895 If this is set to a non zero number or true (identical to -1 or an
2896 unlimited number), the submodule summary will be enabled and a
2897 summary of commits for modified submodules will be shown (see
2898 --summary-limit option of linkgit:git-submodule[1]). Please note
2899 that the summary output command will be suppressed for all
2900 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2901 for those submodules where `submodule.<name>.ignore=all`. The only
2902 exception to that rule is that status and commit will show staged
2903 submodule changes. To
2904 also view the summary for ignored submodules you can either use
2905 the --ignore-submodules=dirty command-line option or the 'git
2906 submodule summary' command, which shows a similar output but does
2907 not honor these settings.
2910 If this is set to true, the `git stash show` command without an
2911 option will show the stash in patch form. Defaults to false.
2912 See description of 'show' command in linkgit:git-stash[1].
2915 If this is set to true, the `git stash show` command without an
2916 option will show diffstat of the stash. Defaults to true.
2917 See description of 'show' command in linkgit:git-stash[1].
2919 submodule.<name>.url::
2920 The URL for a submodule. This variable is copied from the .gitmodules
2921 file to the git config via 'git submodule init'. The user can change
2922 the configured URL before obtaining the submodule via 'git submodule
2923 update'. After obtaining the submodule, the presence of this variable
2924 is used as a sign whether the submodule is of interest to git commands.
2925 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2927 submodule.<name>.update::
2928 The default update procedure for a submodule. This variable
2929 is populated by `git submodule init` from the
2930 linkgit:gitmodules[5] file. See description of 'update'
2931 command in linkgit:git-submodule[1].
2933 submodule.<name>.branch::
2934 The remote branch name for a submodule, used by `git submodule
2935 update --remote`. Set this option to override the value found in
2936 the `.gitmodules` file. See linkgit:git-submodule[1] and
2937 linkgit:gitmodules[5] for details.
2939 submodule.<name>.fetchRecurseSubmodules::
2940 This option can be used to control recursive fetching of this
2941 submodule. It can be overridden by using the --[no-]recurse-submodules
2942 command-line option to "git fetch" and "git pull".
2943 This setting will override that from in the linkgit:gitmodules[5]
2946 submodule.<name>.ignore::
2947 Defines under what circumstances "git status" and the diff family show
2948 a submodule as modified. When set to "all", it will never be considered
2949 modified (but it will nonetheless show up in the output of status and
2950 commit when it has been staged), "dirty" will ignore all changes
2951 to the submodules work tree and
2952 takes only differences between the HEAD of the submodule and the commit
2953 recorded in the superproject into account. "untracked" will additionally
2954 let submodules with modified tracked files in their work tree show up.
2955 Using "none" (the default when this option is not set) also shows
2956 submodules that have untracked files in their work tree as changed.
2957 This setting overrides any setting made in .gitmodules for this submodule,
2958 both settings can be overridden on the command line by using the
2959 "--ignore-submodules" option. The 'git submodule' commands are not
2960 affected by this setting.
2962 submodule.fetchJobs::
2963 Specifies how many submodules are fetched/cloned at the same time.
2964 A positive integer allows up to that number of submodules fetched
2965 in parallel. A value of 0 will give some reasonable default.
2966 If unset, it defaults to 1.
2968 submodule.alternateLocation::
2969 Specifies how the submodules obtain alternates when submodules are
2970 cloned. Possible values are `no`, `superproject`.
2971 By default `no` is assumed, which doesn't add references. When the
2972 value is set to `superproject` the submodule to be cloned computes
2973 its alternates location relative to the superprojects alternate.
2975 submodule.alternateErrorStrategy::
2976 Specifies how to treat errors with the alternates for a submodule
2977 as computed via `submodule.alternateLocation`. Possible values are
2978 `ignore`, `info`, `die`. Default is `die`.
2980 tag.forceSignAnnotated::
2981 A boolean to specify whether annotated tags created should be GPG signed.
2982 If `--annotate` is specified on the command line, it takes
2983 precedence over this option.
2986 This variable controls the sort ordering of tags when displayed by
2987 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2988 value of this variable will be used as the default.
2991 This variable can be used to restrict the permission bits of
2992 tar archive entries. The default is 0002, which turns off the
2993 world write bit. The special value "user" indicates that the
2994 archiving user's umask will be used instead. See umask(2) and
2995 linkgit:git-archive[1].
2997 transfer.fsckObjects::
2998 When `fetch.fsckObjects` or `receive.fsckObjects` are
2999 not set, the value of this variable is used instead.
3003 String(s) `receive-pack` and `upload-pack` use to decide which
3004 refs to omit from their initial advertisements. Use more than
3005 one definition to specify multiple prefix strings. A ref that is
3006 under the hierarchies listed in the value of this variable is
3007 excluded, and is hidden when responding to `git push` or `git
3008 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3009 program-specific versions of this config.
3011 You may also include a `!` in front of the ref name to negate the entry,
3012 explicitly exposing it, even if an earlier entry marked it as hidden.
3013 If you have multiple hideRefs values, later entries override earlier ones
3014 (and entries in more-specific config files override less-specific ones).
3016 If a namespace is in use, the namespace prefix is stripped from each
3017 reference before it is matched against `transfer.hiderefs` patterns.
3018 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3019 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3020 is omitted from the advertisements but `refs/heads/master` and
3021 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3022 "have" lines. In order to match refs before stripping, add a `^` in front of
3023 the ref name. If you combine `!` and `^`, `!` must be specified first.
3025 Even if you hide refs, a client may still be able to steal the target
3026 objects via the techniques described in the "SECURITY" section of the
3027 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3028 separate repository.
3030 transfer.unpackLimit::
3031 When `fetch.unpackLimit` or `receive.unpackLimit` are
3032 not set, the value of this variable is used instead.
3033 The default value is 100.
3035 uploadarchive.allowUnreachable::
3036 If true, allow clients to use `git archive --remote` to request
3037 any tree, whether reachable from the ref tips or not. See the
3038 discussion in the "SECURITY" section of
3039 linkgit:git-upload-archive[1] for more details. Defaults to
3042 uploadpack.hideRefs::
3043 This variable is the same as `transfer.hideRefs`, but applies
3044 only to `upload-pack` (and so affects only fetches, not pushes).
3045 An attempt to fetch a hidden ref by `git fetch` will fail. See
3046 also `uploadpack.allowTipSHA1InWant`.
3048 uploadpack.allowTipSHA1InWant::
3049 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3050 to accept a fetch request that asks for an object at the tip
3051 of a hidden ref (by default, such a request is rejected).
3052 See also `uploadpack.hideRefs`. Even if this is false, a client
3053 may be able to steal objects via the techniques described in the
3054 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3055 best to keep private data in a separate repository.
3057 uploadpack.allowReachableSHA1InWant::
3058 Allow `upload-pack` to accept a fetch request that asks for an
3059 object that is reachable from any ref tip. However, note that
3060 calculating object reachability is computationally expensive.
3061 Defaults to `false`. Even if this is false, a client may be able
3062 to steal objects via the techniques described in the "SECURITY"
3063 section of the linkgit:gitnamespaces[7] man page; it's best to
3064 keep private data in a separate repository.
3066 uploadpack.allowAnySHA1InWant::
3067 Allow `upload-pack` to accept a fetch request that asks for any
3069 Defaults to `false`.
3071 uploadpack.keepAlive::
3072 When `upload-pack` has started `pack-objects`, there may be a
3073 quiet period while `pack-objects` prepares the pack. Normally
3074 it would output progress information, but if `--quiet` was used
3075 for the fetch, `pack-objects` will output nothing at all until
3076 the pack data begins. Some clients and networks may consider
3077 the server to be hung and give up. Setting this option instructs
3078 `upload-pack` to send an empty keepalive packet every
3079 `uploadpack.keepAlive` seconds. Setting this option to 0
3080 disables keepalive packets entirely. The default is 5 seconds.
3082 uploadpack.packObjectsHook::
3083 If this option is set, when `upload-pack` would run
3084 `git pack-objects` to create a packfile for a client, it will
3085 run this shell command instead. The `pack-objects` command and
3086 arguments it _would_ have run (including the `git pack-objects`
3087 at the beginning) are appended to the shell command. The stdin
3088 and stdout of the hook are treated as if `pack-objects` itself
3089 was run. I.e., `upload-pack` will feed input intended for
3090 `pack-objects` to the hook, and expects a completed packfile on
3093 Note that this configuration variable is ignored if it is seen in the
3094 repository-level config (this is a safety measure against fetching from
3095 untrusted repositories).
3097 url.<base>.insteadOf::
3098 Any URL that starts with this value will be rewritten to
3099 start, instead, with <base>. In cases where some site serves a
3100 large number of repositories, and serves them with multiple
3101 access methods, and some users need to use different access
3102 methods, this feature allows people to specify any of the
3103 equivalent URLs and have Git automatically rewrite the URL to
3104 the best alternative for the particular user, even for a
3105 never-before-seen repository on the site. When more than one
3106 insteadOf strings match a given URL, the longest match is used.
3108 url.<base>.pushInsteadOf::
3109 Any URL that starts with this value will not be pushed to;
3110 instead, it will be rewritten to start with <base>, and the
3111 resulting URL will be pushed to. In cases where some site serves
3112 a large number of repositories, and serves them with multiple
3113 access methods, some of which do not allow push, this feature
3114 allows people to specify a pull-only URL and have Git
3115 automatically use an appropriate URL to push, even for a
3116 never-before-seen repository on the site. When more than one
3117 pushInsteadOf strings match a given URL, the longest match is
3118 used. If a remote has an explicit pushurl, Git will ignore this
3119 setting for that remote.
3122 Your email address to be recorded in any newly created commits.
3123 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3124 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3127 Your full name to be recorded in any newly created commits.
3128 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3129 environment variables. See linkgit:git-commit-tree[1].
3131 user.useConfigOnly::
3132 Instruct Git to avoid trying to guess defaults for `user.email`
3133 and `user.name`, and instead retrieve the values only from the
3134 configuration. For example, if you have multiple email addresses
3135 and would like to use a different one for each repository, then
3136 with this configuration option set to `true` in the global config
3137 along with a name, Git will prompt you to set up an email before
3138 making new commits in a newly cloned repository.
3139 Defaults to `false`.
3142 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3143 key you want it to automatically when creating a signed tag or
3144 commit, you can override the default selection with this variable.
3145 This option is passed unchanged to gpg's --local-user parameter,
3146 so you may specify a key using any method that gpg supports.
3148 versionsort.prereleaseSuffix (deprecated)::
3149 Deprecated alias for `versionsort.suffix`. Ignored if
3150 `versionsort.suffix` is set.
3152 versionsort.suffix::
3153 Even when version sort is used in linkgit:git-tag[1], tagnames
3154 with the same base version but different suffixes are still sorted
3155 lexicographically, resulting e.g. in prerelease tags appearing
3156 after the main release (e.g. "1.0-rc1" after "1.0"). This
3157 variable can be specified to determine the sorting order of tags
3158 with different suffixes.
3160 By specifying a single suffix in this variable, any tagname containing
3161 that suffix will appear before the corresponding main release. E.g. if
3162 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3163 "1.0". If specified multiple times, once per suffix, then the order of
3164 suffixes in the configuration will determine the sorting order of tagnames
3165 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3166 configuration, then all "1.0-preX" tags will be listed before any
3167 "1.0-rcX" tags. The placement of the main release tag relative to tags
3168 with various suffixes can be determined by specifying the empty suffix
3169 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3170 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3171 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3174 If more than one suffixes match the same tagname, then that tagname will
3175 be sorted according to the suffix which starts at the earliest position in
3176 the tagname. If more than one different matching suffixes start at
3177 that earliest position, then that tagname will be sorted according to the
3178 longest of those suffixes.
3179 The sorting order between different suffixes is undefined if they are
3180 in multiple config files.
3183 Specify a web browser that may be used by some commands.
3184 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]