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 variables that takes a color is a list of
154 colors (at most two) and attributes (at most one), separated
155 by spaces. The colors accepted are `normal`, `black`,
156 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
157 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
158 `reverse`. The first color given is the foreground; the
159 second is the background. The position of the attribute, if
160 any, doesn't matter. Attributes may be turned off specifically
161 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
163 Colors (foreground and background) may also be given as numbers between
164 0 and 255; these use ANSI 256-color mode (but note that not all
165 terminals may support this). If your terminal supports it, you may also
166 specify 24-bit RGB values as hex, like `#ff0ab3`.
168 The attributes are meant to be reset at the beginning of each item
169 in the colored output, so setting color.decorate.branch to `black`
170 will paint that branch name in a plain `black`, even if the previous
171 thing on the same output line (e.g. opening parenthesis before the
172 list of branch names in `log --decorate` output) is set to be
173 painted with `bold` or some other attribute.
176 A variable that takes a pathname value can be given a
177 string that begins with "`~/`" or "`~user/`", and the usual
178 tilde expansion happens to such a string: `~/`
179 is expanded to the value of `$HOME`, and `~user/` to the
180 specified user's home directory.
186 Note that this list is non-comprehensive and not necessarily complete.
187 For command-specific variables, you will find a more detailed description
188 in the appropriate manual page.
190 Other git-related tools may and do use their own variables. When
191 inventing new variables for use in your own tool, make sure their
192 names do not conflict with those that are used by Git itself and
193 other popular tools, and describe them in your documentation.
197 These variables control various optional help messages designed to
198 aid new users. All 'advice.*' variables default to 'true', and you
199 can tell Git that you do not need help by setting these to 'false':
203 Set this variable to 'false' if you want to disable
205 'pushNonFFMatching', 'pushAlreadyExists',
206 'pushFetchFirst', and 'pushNeedsForce'
209 Advice shown when linkgit:git-push[1] fails due to a
210 non-fast-forward update to the current branch.
212 Advice shown when you ran linkgit:git-push[1] and pushed
213 'matching refs' explicitly (i.e. you used ':', or
214 specified a refspec that isn't your current branch) and
215 it resulted in a non-fast-forward error.
217 Shown when linkgit:git-push[1] rejects an update that
218 does not qualify for fast-forwarding (e.g., a tag.)
220 Shown when linkgit:git-push[1] rejects an update that
221 tries to overwrite a remote ref that points at an
222 object we do not have.
224 Shown when linkgit:git-push[1] rejects an update that
225 tries to overwrite a remote ref that points at an
226 object that is not a commit-ish, or make the remote
227 ref point at an object that is not a commit-ish.
229 Show directions on how to proceed from the current
230 state in the output of linkgit:git-status[1], in
231 the template shown when writing commit messages in
232 linkgit:git-commit[1], and in the help message shown
233 by linkgit:git-checkout[1] when switching branch.
235 Advise to consider using the `-u` option to linkgit:git-status[1]
236 when the command takes more than 2 seconds to enumerate untracked
239 Advice shown when linkgit:git-merge[1] refuses to
240 merge to avoid overwriting local changes.
242 Advice shown by various commands when conflicts
243 prevent the operation from being performed.
245 Advice on how to set your identity configuration when
246 your information is guessed from the system username and
249 Advice shown when you used linkgit:git-checkout[1] to
250 move to the detach HEAD state, to instruct how to create
251 a local branch after the fact.
253 Advice that shows the location of the patch file when
254 linkgit:git-am[1] fails to apply it.
256 In case of failure in the output of linkgit:git-rm[1],
257 show directions on how to proceed from the current state.
261 Tells Git if the executable bit of files in the working tree
264 Some filesystems lose the executable bit when a file that is
265 marked as executable is checked out, or checks out an
266 non-executable file with executable bit on.
267 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
268 to see if it handles the executable bit correctly
269 and this variable is automatically set as necessary.
271 A repository, however, may be on a filesystem that handles
272 the filemode correctly, and this variable is set to 'true'
273 when created, but later may be made accessible from another
274 environment that loses the filemode (e.g. exporting ext4 via
275 CIFS mount, visiting a Cygwin created repository with
276 Git for Windows or Eclipse).
277 In such a case it may be necessary to set this variable to 'false'.
278 See linkgit:git-update-index[1].
280 The default is true (when core.filemode is not specified in the config file).
283 If true, this option enables various workarounds to enable
284 Git to work better on filesystems that are not case sensitive,
285 like FAT. For example, if a directory listing finds
286 "makefile" when Git expects "Makefile", Git will assume
287 it is really the same file, and continue to remember it as
290 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
291 will probe and set core.ignoreCase true if appropriate when the repository
294 core.precomposeUnicode::
295 This option is only used by Mac OS implementation of Git.
296 When core.precomposeUnicode=true, Git reverts the unicode decomposition
297 of filenames done by Mac OS. This is useful when sharing a repository
298 between Mac OS and Linux or Windows.
299 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
300 When false, file names are handled fully transparent by Git,
301 which is backward compatible with older versions of Git.
304 If set to true, do not allow checkout of paths that would
305 be considered equivalent to `.git` on an HFS+ filesystem.
306 Defaults to `true` on Mac OS, and `false` elsewhere.
309 If set to true, do not allow checkout of paths that would
310 cause problems with the NTFS filesystem, e.g. conflict with
312 Defaults to `true` on Windows, and `false` elsewhere.
315 If false, the ctime differences between the index and the
316 working tree are ignored; useful when the inode change time
317 is regularly modified by something outside Git (file system
318 crawlers and some backup systems).
319 See linkgit:git-update-index[1]. True by default.
321 core.untrackedCache::
322 Determines what to do about the untracked cache feature of the
323 index. It will be kept, if this variable is unset or set to
324 `keep`. It will automatically be added if set to `true`. And
325 it will automatically be removed, if set to `false`. Before
326 setting it to `true`, you should check that mtime is working
327 properly on your system.
328 See linkgit:git-update-index[1]. `keep` by default.
331 Determines which stat fields to match between the index
332 and work tree. The user can set this to 'default' or
333 'minimal'. Default (or explicitly 'default'), is to check
334 all fields, including the sub-second part of mtime and ctime.
337 The commands that output paths (e.g. 'ls-files',
338 'diff'), when not given the `-z` option, will quote
339 "unusual" characters in the pathname by enclosing the
340 pathname in a double-quote pair and with backslashes the
341 same way strings in C source code are quoted. If this
342 variable is set to false, the bytes higher than 0x80 are
343 not quoted but output as verbatim. Note that double
344 quote, backslash and control characters are always
345 quoted without `-z` regardless of the setting of this
349 Sets the line ending type to use in the working directory for
350 files that have the `text` property set. Alternatives are
351 'lf', 'crlf' and 'native', which uses the platform's native
352 line ending. The default value is `native`. See
353 linkgit:gitattributes[5] for more information on end-of-line
357 If true, makes Git check if converting `CRLF` is reversible when
358 end-of-line conversion is active. Git will verify if a command
359 modifies a file in the work tree either directly or indirectly.
360 For example, committing a file followed by checking out the
361 same file should yield the original file in the work tree. If
362 this is not the case for the current setting of
363 `core.autocrlf`, Git will reject the file. The variable can
364 be set to "warn", in which case Git will only warn about an
365 irreversible conversion but continue the operation.
367 CRLF conversion bears a slight chance of corrupting data.
368 When it is enabled, Git will convert CRLF to LF during commit and LF to
369 CRLF during checkout. A file that contains a mixture of LF and
370 CRLF before the commit cannot be recreated by Git. For text
371 files this is the right thing to do: it corrects line endings
372 such that we have only LF line endings in the repository.
373 But for binary files that are accidentally classified as text the
374 conversion can corrupt data.
376 If you recognize such corruption early you can easily fix it by
377 setting the conversion type explicitly in .gitattributes. Right
378 after committing you still have the original file in your work
379 tree and this file is not yet corrupted. You can explicitly tell
380 Git that this file is binary and Git will handle the file
383 Unfortunately, the desired effect of cleaning up text files with
384 mixed line endings and the undesired effect of corrupting binary
385 files cannot be distinguished. In both cases CRLFs are removed
386 in an irreversible way. For text files this is the right thing
387 to do because CRLFs are line endings, while for binary files
388 converting CRLFs corrupts data.
390 Note, this safety check does not mean that a checkout will generate a
391 file identical to the original file for a different setting of
392 `core.eol` and `core.autocrlf`, but only for the current one. For
393 example, a text file with `LF` would be accepted with `core.eol=lf`
394 and could later be checked out with `core.eol=crlf`, in which case the
395 resulting file would contain `CRLF`, although the original file
396 contained `LF`. However, in both work trees the line endings would be
397 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
398 file with mixed line endings would be reported by the `core.safecrlf`
402 Setting this variable to "true" is almost the same as setting
403 the `text` attribute to "auto" on all files except that text
404 files are not guaranteed to be normalized: files that contain
405 `CRLF` in the repository will not be touched. Use this
406 setting if you want to have `CRLF` line endings in your
407 working directory even though the repository does not have
408 normalized line endings. This variable can be set to 'input',
409 in which case no output conversion is performed.
412 If false, symbolic links are checked out as small plain files that
413 contain the link text. linkgit:git-update-index[1] and
414 linkgit:git-add[1] will not change the recorded type to regular
415 file. Useful on filesystems like FAT that do not support
418 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
419 will probe and set core.symlinks false if appropriate when the repository
423 A "proxy command" to execute (as 'command host port') instead
424 of establishing direct connection to the remote server when
425 using the Git protocol for fetching. If the variable value is
426 in the "COMMAND for DOMAIN" format, the command is applied only
427 on hostnames ending with the specified domain string. This variable
428 may be set multiple times and is matched in the given order;
429 the first match wins.
431 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
432 (which always applies universally, without the special "for"
435 The special string `none` can be used as the proxy command to
436 specify that no proxy be used for a given domain pattern.
437 This is useful for excluding servers inside a firewall from
438 proxy use, while defaulting to a common proxy for external domains.
441 If true, Git will avoid using lstat() calls to detect if files have
442 changed by setting the "assume-unchanged" bit for those tracked files
443 which it has updated identically in both the index and working tree.
445 When files are modified outside of Git, the user will need to stage
446 the modified files explicitly (e.g. see 'Examples' section in
447 linkgit:git-update-index[1]).
448 Git will not normally detect changes to those files.
450 This is useful on systems where lstat() calls are very slow, such as
451 CIFS/Microsoft Windows.
455 core.preferSymlinkRefs::
456 Instead of the default "symref" format for HEAD
457 and other symbolic reference files, use symbolic links.
458 This is sometimes needed to work with old scripts that
459 expect HEAD to be a symbolic link.
462 If true this repository is assumed to be 'bare' and has no
463 working directory associated with it. If this is the case a
464 number of commands that require a working directory will be
465 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
467 This setting is automatically guessed by linkgit:git-clone[1] or
468 linkgit:git-init[1] when the repository was created. By default a
469 repository that ends in "/.git" is assumed to be not bare (bare =
470 false), while all other repositories are assumed to be bare (bare
474 Set the path to the root of the working tree.
475 If GIT_COMMON_DIR environment variable is set, core.worktree
476 is ignored and not used for determining the root of working tree.
477 This can be overridden by the GIT_WORK_TREE environment
478 variable and the '--work-tree' command-line option.
479 The value can be an absolute path or relative to the path to
480 the .git directory, which is either specified by --git-dir
481 or GIT_DIR, or automatically discovered.
482 If --git-dir or GIT_DIR is specified but none of
483 --work-tree, GIT_WORK_TREE and core.worktree is specified,
484 the current working directory is regarded as the top level
485 of your working tree.
487 Note that this variable is honored even when set in a configuration
488 file in a ".git" subdirectory of a directory and its value differs
489 from the latter directory (e.g. "/path/to/.git/config" has
490 core.worktree set to "/different/path"), which is most likely a
491 misconfiguration. Running Git commands in the "/path/to" directory will
492 still use "/different/path" as the root of the work tree and can cause
493 confusion unless you know what you are doing (e.g. you are creating a
494 read-only snapshot of the same index to a location different from the
495 repository's usual working tree).
497 core.logAllRefUpdates::
498 Enable the reflog. Updates to a ref <ref> is logged to the file
499 "`$GIT_DIR/logs/<ref>`", by appending the new and old
500 SHA-1, the date/time and the reason of the update, but
501 only when the file exists. If this configuration
502 variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
503 file is automatically created for branch heads (i.e. under
504 refs/heads/), remote refs (i.e. under refs/remotes/),
505 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
507 This information can be used to determine what commit
508 was the tip of a branch "2 days ago".
510 This value is true by default in a repository that has
511 a working directory associated with it, and false by
512 default in a bare repository.
514 core.repositoryFormatVersion::
515 Internal variable identifying the repository format and layout
518 core.sharedRepository::
519 When 'group' (or 'true'), the repository is made shareable between
520 several users in a group (making sure all the files and objects are
521 group-writable). When 'all' (or 'world' or 'everybody'), the
522 repository will be readable by all users, additionally to being
523 group-shareable. When 'umask' (or 'false'), Git will use permissions
524 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
525 files in the repository will have this mode value. '0xxx' will override
526 user's umask value (whereas the other options will only override
527 requested parts of the user's umask value). Examples: '0660' will make
528 the repo read/write-able for the owner and group, but inaccessible to
529 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
530 repository that is group-readable but not group-writable.
531 See linkgit:git-init[1]. False by default.
533 core.warnAmbiguousRefs::
534 If true, Git will warn you if the ref name you passed it is ambiguous
535 and might match multiple refs in the repository. True by default.
538 An integer -1..9, indicating a default compression level.
539 -1 is the zlib default. 0 means no compression,
540 and 1..9 are various speed/size tradeoffs, 9 being slowest.
541 If set, this provides a default to other compression variables,
542 such as 'core.looseCompression' and 'pack.compression'.
544 core.looseCompression::
545 An integer -1..9, indicating the compression level for objects that
546 are not in a pack file. -1 is the zlib default. 0 means no
547 compression, and 1..9 are various speed/size tradeoffs, 9 being
548 slowest. If not set, defaults to core.compression. If that is
549 not set, defaults to 1 (best speed).
551 core.packedGitWindowSize::
552 Number of bytes of a pack file to map into memory in a
553 single mapping operation. Larger window sizes may allow
554 your system to process a smaller number of large pack files
555 more quickly. Smaller window sizes will negatively affect
556 performance due to increased calls to the operating system's
557 memory manager, but may improve performance when accessing
558 a large number of large pack files.
560 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
561 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
562 be reasonable for all users/operating systems. You probably do
563 not need to adjust this value.
565 Common unit suffixes of 'k', 'm', or 'g' are supported.
567 core.packedGitLimit::
568 Maximum number of bytes to map simultaneously into memory
569 from pack files. If Git needs to access more than this many
570 bytes at once to complete an operation it will unmap existing
571 regions to reclaim virtual address space within the process.
573 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
574 This should be reasonable for all users/operating systems, except on
575 the largest projects. You probably do not need to adjust this value.
577 Common unit suffixes of 'k', 'm', or 'g' are supported.
579 core.deltaBaseCacheLimit::
580 Maximum number of bytes to reserve for caching base objects
581 that may be referenced by multiple deltified objects. By storing the
582 entire decompressed base objects in a cache Git is able
583 to avoid unpacking and decompressing frequently used base
584 objects multiple times.
586 Default is 96 MiB on all platforms. This should be reasonable
587 for all users/operating systems, except on the largest projects.
588 You probably do not need to adjust this value.
590 Common unit suffixes of 'k', 'm', or 'g' are supported.
592 core.bigFileThreshold::
593 Files larger than this size are stored deflated, without
594 attempting delta compression. Storing large files without
595 delta compression avoids excessive memory usage, at the
596 slight expense of increased disk usage. Additionally files
597 larger than this size are always treated as binary.
599 Default is 512 MiB on all platforms. This should be reasonable
600 for most projects as source code and other text files can still
601 be delta compressed, but larger binary media files won't be.
603 Common unit suffixes of 'k', 'm', or 'g' are supported.
606 Specifies the pathname to the file that contains patterns to
607 describe paths that are not meant to be tracked, in addition
608 to '.gitignore' (per-directory) and '.git/info/exclude'.
609 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
610 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
611 is used instead. See linkgit:gitignore[5].
614 Some commands (e.g. svn and http interfaces) that interactively
615 ask for a password can be told to use an external program given
616 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
617 environment variable. If not set, fall back to the value of the
618 'SSH_ASKPASS' environment variable or, failing that, a simple password
619 prompt. The external program shall be given a suitable prompt as
620 command-line argument and write the password on its STDOUT.
622 core.attributesFile::
623 In addition to '.gitattributes' (per-directory) and
624 '.git/info/attributes', Git looks into this file for attributes
625 (see linkgit:gitattributes[5]). Path expansions are made the same
626 way as for `core.excludesFile`. Its default value is
627 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
628 set or empty, `$HOME/.config/git/attributes` is used instead.
631 By default Git will look for your hooks in the
632 '$GIT_DIR/hooks' directory. Set this to different path,
633 e.g. '/etc/git/hooks', and Git will try to find your hooks in
634 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
635 in '$GIT_DIR/hooks/pre-receive'.
637 The path can be either absolute or relative. A relative path is
638 taken as relative to the directory where the hooks are run (see
639 the "DESCRIPTION" section of linkgit:githooks[5]).
641 This configuration variable is useful in cases where you'd like to
642 centrally configure your Git hooks instead of configuring them on a
643 per-repository basis, or as a more flexible and centralized
644 alternative to having an `init.templateDir` where you've changed
648 Commands such as `commit` and `tag` that lets you edit
649 messages by launching an editor uses the value of this
650 variable when it is set, and the environment variable
651 `GIT_EDITOR` is not set. See linkgit:git-var[1].
654 Commands such as `commit` and `tag` that lets you edit
655 messages consider a line that begins with this character
656 commented, and removes them after the editor returns
659 If set to "auto", `git-commit` would select a character that is not
660 the beginning character of any line in existing commit messages.
662 core.packedRefsTimeout::
663 The length of time, in milliseconds, to retry when trying to
664 lock the `packed-refs` file. Value 0 means not to retry at
665 all; -1 means to try indefinitely. Default is 1000 (i.e.,
669 Text editor used by `git rebase -i` for editing the rebase instruction file.
670 The value is meant to be interpreted by the shell when it is used.
671 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
672 When not configured the default commit message editor is used instead.
675 Text viewer for use by Git commands (e.g., 'less'). The value
676 is meant to be interpreted by the shell. The order of preference
677 is the `$GIT_PAGER` environment variable, then `core.pager`
678 configuration, then `$PAGER`, and then the default chosen at
679 compile time (usually 'less').
681 When the `LESS` environment variable is unset, Git sets it to `FRX`
682 (if `LESS` environment variable is set, Git does not change it at
683 all). If you want to selectively override Git's default setting
684 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
685 be passed to the shell by Git, which will translate the final
686 command to `LESS=FRX less -S`. The environment does not set the
687 `S` option but the command line does, instructing less to truncate
688 long lines. Similarly, setting `core.pager` to `less -+F` will
689 deactivate the `F` option specified by the environment from the
690 command-line, deactivating the "quit if one screen" behavior of
691 `less`. One can specifically activate some flags for particular
692 commands: for example, setting `pager.blame` to `less -S` enables
693 line truncation only for `git blame`.
695 Likewise, when the `LV` environment variable is unset, Git sets it
696 to `-c`. You can override this setting by exporting `LV` with
697 another value or setting `core.pager` to `lv +c`.
700 A comma separated list of common whitespace problems to
701 notice. 'git diff' will use `color.diff.whitespace` to
702 highlight them, and 'git apply --whitespace=error' will
703 consider them as errors. You can prefix `-` to disable
704 any of them (e.g. `-trailing-space`):
706 * `blank-at-eol` treats trailing whitespaces at the end of the line
707 as an error (enabled by default).
708 * `space-before-tab` treats a space character that appears immediately
709 before a tab character in the initial indent part of the line as an
710 error (enabled by default).
711 * `indent-with-non-tab` treats a line that is indented with space
712 characters instead of the equivalent tabs as an error (not enabled by
714 * `tab-in-indent` treats a tab character in the initial indent part of
715 the line as an error (not enabled by default).
716 * `blank-at-eof` treats blank lines added at the end of file as an error
717 (enabled by default).
718 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
720 * `cr-at-eol` treats a carriage-return at the end of line as
721 part of the line terminator, i.e. with it, `trailing-space`
722 does not trigger if the character before such a carriage-return
723 is not a whitespace (not enabled by default).
724 * `tabwidth=<n>` tells how many character positions a tab occupies; this
725 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
726 errors. The default tab width is 8. Allowed values are 1 to 63.
728 core.fsyncObjectFiles::
729 This boolean will enable 'fsync()' when writing object files.
731 This is a total waste of time and effort on a filesystem that orders
732 data writes properly, but can be useful for filesystems that do not use
733 journalling (traditional UNIX filesystems) or that only journal metadata
734 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
737 Enable parallel index preload for operations like 'git diff'
739 This can speed up operations like 'git diff' and 'git status' especially
740 on filesystems like NFS that have weak caching semantics and thus
741 relatively high IO latencies. When enabled, Git will do the
742 index comparison to the filesystem data in parallel, allowing
743 overlapping IO's. Defaults to true.
746 You can set this to 'link', in which case a hardlink followed by
747 a delete of the source are used to make sure that object creation
748 will not overwrite existing objects.
750 On some file system/operating system combinations, this is unreliable.
751 Set this config setting to 'rename' there; However, This will remove the
752 check that makes sure that existing object files will not get overwritten.
755 When showing commit messages, also show notes which are stored in
756 the given ref. The ref must be fully qualified. If the given
757 ref does not exist, it is not an error but means that no
758 notes should be printed.
760 This setting defaults to "refs/notes/commits", and it can be overridden by
761 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
763 core.sparseCheckout::
764 Enable "sparse checkout" feature. See section "Sparse checkout" in
765 linkgit:git-read-tree[1] for more information.
768 Set the length object names are abbreviated to. If unspecified,
769 many commands abbreviate to 7 hexdigits, which may not be enough
770 for abbreviated object names to stay unique for sufficiently long
774 add.ignore-errors (deprecated)::
775 Tells 'git add' to continue adding files when some files cannot be
776 added due to indexing errors. Equivalent to the '--ignore-errors'
777 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
778 as it does not follow the usual naming convention for configuration
782 Command aliases for the linkgit:git[1] command wrapper - e.g.
783 after defining "alias.last = cat-file commit HEAD", the invocation
784 "git last" is equivalent to "git cat-file commit HEAD". To avoid
785 confusion and troubles with script usage, aliases that
786 hide existing Git commands are ignored. Arguments are split by
787 spaces, the usual shell quoting and escaping is supported.
788 A quote pair or a backslash can be used to quote them.
790 If the alias expansion is prefixed with an exclamation point,
791 it will be treated as a shell command. For example, defining
792 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
793 "git new" is equivalent to running the shell command
794 "gitk --all --not ORIG_HEAD". Note that shell commands will be
795 executed from the top-level directory of a repository, which may
796 not necessarily be the current directory.
797 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
798 from the original current directory. See linkgit:git-rev-parse[1].
801 If true, git-am will call git-mailsplit for patches in mbox format
802 with parameter '--keep-cr'. In this case git-mailsplit will
803 not remove `\r` from lines ending with `\r\n`. Can be overridden
804 by giving '--no-keep-cr' from the command line.
805 See linkgit:git-am[1], linkgit:git-mailsplit[1].
808 By default, `git am` will fail if the patch does not apply cleanly. When
809 set to true, this setting tells `git am` to fall back on 3-way merge if
810 the patch records the identity of blobs it is supposed to apply to and
811 we have those blobs available locally (equivalent to giving the `--3way`
812 option from the command line). Defaults to `false`.
813 See linkgit:git-am[1].
815 apply.ignoreWhitespace::
816 When set to 'change', tells 'git apply' to ignore changes in
817 whitespace, in the same way as the '--ignore-space-change'
819 When set to one of: no, none, never, false tells 'git apply' to
820 respect all whitespace differences.
821 See linkgit:git-apply[1].
824 Tells 'git apply' how to handle whitespaces, in the same way
825 as the '--whitespace' option. See linkgit:git-apply[1].
827 branch.autoSetupMerge::
828 Tells 'git branch' and 'git checkout' to set up new branches
829 so that linkgit:git-pull[1] will appropriately merge from the
830 starting point branch. Note that even if this option is not set,
831 this behavior can be chosen per-branch using the `--track`
832 and `--no-track` options. The valid settings are: `false` -- no
833 automatic setup is done; `true` -- automatic setup is done when the
834 starting point is a remote-tracking branch; `always` --
835 automatic setup is done when the starting point is either a
836 local branch or remote-tracking
837 branch. This option defaults to true.
839 branch.autoSetupRebase::
840 When a new branch is created with 'git branch' or 'git checkout'
841 that tracks another branch, this variable tells Git to set
842 up pull to rebase instead of merge (see "branch.<name>.rebase").
843 When `never`, rebase is never automatically set to true.
844 When `local`, rebase is set to true for tracked branches of
845 other local branches.
846 When `remote`, rebase is set to true for tracked branches of
847 remote-tracking branches.
848 When `always`, rebase will be set to true for all tracking
850 See "branch.autoSetupMerge" for details on how to set up a
851 branch to track another branch.
852 This option defaults to never.
854 branch.<name>.remote::
855 When on branch <name>, it tells 'git fetch' and 'git push'
856 which remote to fetch from/push to. The remote to push to
857 may be overridden with `remote.pushDefault` (for all branches).
858 The remote to push to, for the current branch, may be further
859 overridden by `branch.<name>.pushRemote`. If no remote is
860 configured, or if you are not on any branch, it defaults to
861 `origin` for fetching and `remote.pushDefault` for pushing.
862 Additionally, `.` (a period) is the current local repository
863 (a dot-repository), see `branch.<name>.merge`'s final note below.
865 branch.<name>.pushRemote::
866 When on branch <name>, it overrides `branch.<name>.remote` for
867 pushing. It also overrides `remote.pushDefault` for pushing
868 from branch <name>. When you pull from one place (e.g. your
869 upstream) and push to another place (e.g. your own publishing
870 repository), you would want to set `remote.pushDefault` to
871 specify the remote to push to for all branches, and use this
872 option to override it for a specific branch.
874 branch.<name>.merge::
875 Defines, together with branch.<name>.remote, the upstream branch
876 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
877 branch to merge and can also affect 'git push' (see push.default).
878 When in branch <name>, it tells 'git fetch' the default
879 refspec to be marked for merging in FETCH_HEAD. The value is
880 handled like the remote part of a refspec, and must match a
881 ref which is fetched from the remote given by
882 "branch.<name>.remote".
883 The merge information is used by 'git pull' (which at first calls
884 'git fetch') to lookup the default branch for merging. Without
885 this option, 'git pull' defaults to merge the first refspec fetched.
886 Specify multiple values to get an octopus merge.
887 If you wish to setup 'git pull' so that it merges into <name> from
888 another branch in the local repository, you can point
889 branch.<name>.merge to the desired branch, and use the relative path
890 setting `.` (a period) for branch.<name>.remote.
892 branch.<name>.mergeOptions::
893 Sets default options for merging into branch <name>. The syntax and
894 supported options are the same as those of linkgit:git-merge[1], but
895 option values containing whitespace characters are currently not
898 branch.<name>.rebase::
899 When true, rebase the branch <name> on top of the fetched branch,
900 instead of merging the default branch from the default remote when
901 "git pull" is run. See "pull.rebase" for doing this in a non
902 branch-specific manner.
904 When preserve, also pass `--preserve-merges` along to 'git rebase'
905 so that locally committed merge commits will not be flattened
906 by running 'git pull'.
908 When the value is `interactive`, the rebase is run in interactive mode.
910 *NOTE*: this is a possibly dangerous operation; do *not* use
911 it unless you understand the implications (see linkgit:git-rebase[1]
914 branch.<name>.description::
915 Branch description, can be edited with
916 `git branch --edit-description`. Branch description is
917 automatically added in the format-patch cover letter or
918 request-pull summary.
921 Specify the command to invoke the specified browser. The
922 specified command is evaluated in shell with the URLs passed
923 as arguments. (See linkgit:git-web{litdd}browse[1].)
925 browser.<tool>.path::
926 Override the path for the given tool that may be used to
927 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
928 working repository in gitweb (see linkgit:git-instaweb[1]).
931 A boolean to make git-clean do nothing unless given -f,
932 -i or -n. Defaults to true.
935 A boolean to enable/disable color in the output of
936 linkgit:git-branch[1]. May be set to `always`,
937 `false` (or `never`) or `auto` (or `true`), in which case colors are used
938 only when the output is to a terminal. Defaults to false.
940 color.branch.<slot>::
941 Use customized color for branch coloration. `<slot>` is one of
942 `current` (the current branch), `local` (a local branch),
943 `remote` (a remote-tracking branch in refs/remotes/),
944 `upstream` (upstream tracking branch), `plain` (other
948 Whether to use ANSI escape sequences to add color to patches.
949 If this is set to `always`, linkgit:git-diff[1],
950 linkgit:git-log[1], and linkgit:git-show[1] will use color
951 for all patches. If it is set to `true` or `auto`, those
952 commands will only use color when output is to the terminal.
955 This does not affect linkgit:git-format-patch[1] or the
956 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
957 command line with the `--color[=<when>]` option.
960 Use customized color for diff colorization. `<slot>` specifies
961 which part of the patch to use the specified color, and is one
962 of `context` (context text - `plain` is a historical synonym),
963 `meta` (metainformation), `frag`
964 (hunk header), 'func' (function in hunk header), `old` (removed lines),
965 `new` (added lines), `commit` (commit headers), or `whitespace`
966 (highlighting whitespace errors).
968 color.decorate.<slot>::
969 Use customized color for 'git log --decorate' output. `<slot>` is one
970 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
971 branches, remote-tracking branches, tags, stash and HEAD, respectively.
974 When set to `always`, always highlight matches. When `false` (or
975 `never`), never. When set to `true` or `auto`, use color only
976 when the output is written to the terminal. Defaults to `false`.
979 Use customized color for grep colorization. `<slot>` specifies which
980 part of the line to use the specified color, and is one of
984 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
986 filename prefix (when not using `-h`)
988 function name lines (when using `-p`)
990 line number prefix (when using `-n`)
992 matching text (same as setting `matchContext` and `matchSelected`)
994 matching text in context lines
996 matching text in selected lines
998 non-matching text in selected lines
1000 separators between fields on a line (`:`, `-`, and `=`)
1001 and between hunks (`--`)
1005 When set to `always`, always use colors for interactive prompts
1006 and displays (such as those used by "git-add --interactive" and
1007 "git-clean --interactive"). When false (or `never`), never.
1008 When set to `true` or `auto`, use colors only when the output is
1009 to the terminal. Defaults to false.
1011 color.interactive.<slot>::
1012 Use customized color for 'git add --interactive' and 'git clean
1013 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1014 or `error`, for four distinct types of normal output from
1015 interactive commands.
1018 A boolean to enable/disable colored output when the pager is in
1019 use (default is true).
1022 A boolean to enable/disable color in the output of
1023 linkgit:git-show-branch[1]. May be set to `always`,
1024 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1025 only when the output is to a terminal. Defaults to false.
1028 A boolean to enable/disable color in the output of
1029 linkgit:git-status[1]. May be set to `always`,
1030 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1031 only when the output is to a terminal. Defaults to false.
1033 color.status.<slot>::
1034 Use customized color for status colorization. `<slot>` is
1035 one of `header` (the header text of the status message),
1036 `added` or `updated` (files which are added but not committed),
1037 `changed` (files which are changed but not added in the index),
1038 `untracked` (files which are not tracked by Git),
1039 `branch` (the current branch),
1040 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1042 `unmerged` (files which have unmerged changes).
1045 This variable determines the default value for variables such
1046 as `color.diff` and `color.grep` that control the use of color
1047 per command family. Its scope will expand as more commands learn
1048 configuration to set a default for the `--color` option. Set it
1049 to `false` or `never` if you prefer Git commands not to use
1050 color unless enabled explicitly with some other configuration
1051 or the `--color` option. Set it to `always` if you want all
1052 output not intended for machine consumption to use color, to
1053 `true` or `auto` (this is the default since Git 1.8.4) if you
1054 want such output to use color when written to the terminal.
1057 Specify whether supported commands should output in columns.
1058 This variable consists of a list of tokens separated by spaces
1061 These options control when the feature should be enabled
1062 (defaults to 'never'):
1066 always show in columns
1068 never show in columns
1070 show in columns if the output is to the terminal
1073 These options control layout (defaults to 'column'). Setting any
1074 of these implies 'always' if none of 'always', 'never', or 'auto' are
1079 fill columns before rows
1081 fill rows before columns
1086 Finally, these options can be combined with a layout option (defaults
1091 make unequal size columns to utilize more space
1093 make equal size columns
1097 Specify whether to output branch listing in `git branch` in columns.
1098 See `column.ui` for details.
1101 Specify the layout when list items in `git clean -i`, which always
1102 shows files and directories in columns. See `column.ui` for details.
1105 Specify whether to output untracked files in `git status` in columns.
1106 See `column.ui` for details.
1109 Specify whether to output tag listing in `git tag` in columns.
1110 See `column.ui` for details.
1113 This setting overrides the default of the `--cleanup` option in
1114 `git commit`. See linkgit:git-commit[1] for details. Changing the
1115 default can be useful when you always want to keep lines that begin
1116 with comment character `#` in your log message, in which case you
1117 would do `git config commit.cleanup whitespace` (note that you will
1118 have to remove the help lines that begin with `#` in the commit log
1119 template yourself, if you do this).
1123 A boolean to specify whether all commits should be GPG signed.
1124 Use of this option when doing operations such as rebase can
1125 result in a large number of commits being signed. It may be
1126 convenient to use an agent to avoid typing your GPG passphrase
1130 A boolean to enable/disable inclusion of status information in the
1131 commit message template when using an editor to prepare the commit
1132 message. Defaults to true.
1135 Specify the pathname of a file to use as the template for
1136 new commit messages.
1139 Specify an external helper to be called when a username or
1140 password credential is needed; the helper may consult external
1141 storage to avoid prompting the user for the credentials. Note
1142 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1145 credential.useHttpPath::
1146 When acquiring credentials, consider the "path" component of an http
1147 or https URL to be important. Defaults to false. See
1148 linkgit:gitcredentials[7] for more information.
1150 credential.username::
1151 If no username is set for a network authentication, use this username
1152 by default. See credential.<context>.* below, and
1153 linkgit:gitcredentials[7].
1155 credential.<url>.*::
1156 Any of the credential.* options above can be applied selectively to
1157 some credentials. For example "credential.https://example.com.username"
1158 would set the default username only for https connections to
1159 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1162 credentialCache.ignoreSIGHUP::
1163 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1165 include::diff-config.txt[]
1167 difftool.<tool>.path::
1168 Override the path for the given tool. This is useful in case
1169 your tool is not in the PATH.
1171 difftool.<tool>.cmd::
1172 Specify the command to invoke the specified diff tool.
1173 The specified command is evaluated in shell with the following
1174 variables available: 'LOCAL' is set to the name of the temporary
1175 file containing the contents of the diff pre-image and 'REMOTE'
1176 is set to the name of the temporary file containing the contents
1177 of the diff post-image.
1180 Prompt before each invocation of the diff tool.
1182 fetch.recurseSubmodules::
1183 This option can be either set to a boolean value or to 'on-demand'.
1184 Setting it to a boolean changes the behavior of fetch and pull to
1185 unconditionally recurse into submodules when set to true or to not
1186 recurse at all when set to false. When set to 'on-demand' (the default
1187 value), fetch and pull will only recurse into a populated submodule
1188 when its superproject retrieves a commit that updates the submodule's
1192 If it is set to true, git-fetch-pack will check all fetched
1193 objects. It will abort in the case of a malformed object or a
1194 broken link. The result of an abort are only dangling objects.
1195 Defaults to false. If not set, the value of `transfer.fsckObjects`
1199 If the number of objects fetched over the Git native
1200 transfer is below this
1201 limit, then the objects will be unpacked into loose object
1202 files. However if the number of received objects equals or
1203 exceeds this limit then the received pack will be stored as
1204 a pack, after adding any missing delta bases. Storing the
1205 pack from a push can make the push operation complete faster,
1206 especially on slow filesystems. If not set, the value of
1207 `transfer.unpackLimit` is used instead.
1210 If true, fetch will automatically behave as if the `--prune`
1211 option was given on the command line. See also `remote.<name>.prune`.
1214 Enable multipart/mixed attachments as the default for
1215 'format-patch'. The value can also be a double quoted string
1216 which will enable attachments as the default and set the
1217 value as the boundary. See the --attach option in
1218 linkgit:git-format-patch[1].
1221 A boolean which can enable or disable sequence numbers in patch
1222 subjects. It defaults to "auto" which enables it only if there
1223 is more than one patch. It can be enabled or disabled for all
1224 messages by setting it to "true" or "false". See --numbered
1225 option in linkgit:git-format-patch[1].
1228 Additional email headers to include in a patch to be submitted
1229 by mail. See linkgit:git-format-patch[1].
1233 Additional recipients to include in a patch to be submitted
1234 by mail. See the --to and --cc options in
1235 linkgit:git-format-patch[1].
1237 format.subjectPrefix::
1238 The default for format-patch is to output files with the '[PATCH]'
1239 subject prefix. Use this variable to change that prefix.
1242 The default for format-patch is to output a signature containing
1243 the Git version number. Use this variable to change that default.
1244 Set this variable to the empty string ("") to suppress
1245 signature generation.
1247 format.signatureFile::
1248 Works just like format.signature except the contents of the
1249 file specified by this variable will be used as the signature.
1252 The default for format-patch is to output files with the suffix
1253 `.patch`. Use this variable to change that suffix (make sure to
1254 include the dot if you want it).
1257 The default pretty format for log/show/whatchanged command,
1258 See linkgit:git-log[1], linkgit:git-show[1],
1259 linkgit:git-whatchanged[1].
1262 The default threading style for 'git format-patch'. Can be
1263 a boolean value, or `shallow` or `deep`. `shallow` threading
1264 makes every mail a reply to the head of the series,
1265 where the head is chosen from the cover letter, the
1266 `--in-reply-to`, and the first patch mail, in this order.
1267 `deep` threading makes every mail a reply to the previous one.
1268 A true boolean value is the same as `shallow`, and a false
1269 value disables threading.
1272 A boolean value which lets you enable the `-s/--signoff` option of
1273 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1274 patch should be a conscious act and means that you certify you have
1275 the rights to submit this work under the same open source license.
1276 Please see the 'SubmittingPatches' document for further discussion.
1278 format.coverLetter::
1279 A boolean that controls whether to generate a cover-letter when
1280 format-patch is invoked, but in addition can be set to "auto", to
1281 generate a cover-letter only when there's more than one patch.
1283 format.outputDirectory::
1284 Set a custom directory to store the resulting files instead of the
1285 current working directory.
1287 filter.<driver>.clean::
1288 The command which is used to convert the content of a worktree
1289 file to a blob upon checkin. See linkgit:gitattributes[5] for
1292 filter.<driver>.smudge::
1293 The command which is used to convert the content of a blob
1294 object to a worktree file upon checkout. See
1295 linkgit:gitattributes[5] for details.
1298 Allows overriding the message type (error, warn or ignore) of a
1299 specific message ID such as `missingEmail`.
1301 For convenience, fsck prefixes the error/warning with the message ID,
1302 e.g. "missingEmail: invalid author/committer line - missing email" means
1303 that setting `fsck.missingEmail = ignore` will hide that issue.
1305 This feature is intended to support working with legacy repositories
1306 which cannot be repaired without disruptive changes.
1309 The path to a sorted list of object names (i.e. one SHA-1 per
1310 line) that are known to be broken in a non-fatal way and should
1311 be ignored. This feature is useful when an established project
1312 should be accepted despite early commits containing errors that
1313 can be safely ignored such as invalid committer email addresses.
1314 Note: corrupt objects cannot be skipped with this setting.
1316 gc.aggressiveDepth::
1317 The depth parameter used in the delta compression
1318 algorithm used by 'git gc --aggressive'. This defaults
1321 gc.aggressiveWindow::
1322 The window size parameter used in the delta compression
1323 algorithm used by 'git gc --aggressive'. This defaults
1327 When there are approximately more than this many loose
1328 objects in the repository, `git gc --auto` will pack them.
1329 Some Porcelain commands use this command to perform a
1330 light-weight garbage collection from time to time. The
1331 default value is 6700. Setting this to 0 disables it.
1334 When there are more than this many packs that are not
1335 marked with `*.keep` file in the repository, `git gc
1336 --auto` consolidates them into one larger pack. The
1337 default value is 50. Setting this to 0 disables it.
1340 Make `git gc --auto` return immediately and run in background
1341 if the system supports it. Default is true.
1344 Running `git pack-refs` in a repository renders it
1345 unclonable by Git versions prior to 1.5.1.2 over dumb
1346 transports such as HTTP. This variable determines whether
1347 'git gc' runs `git pack-refs`. This can be set to `notbare`
1348 to enable it within all non-bare repos or it can be set to a
1349 boolean value. The default is `true`.
1352 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1353 Override the grace period with this config variable. The value
1354 "now" may be used to disable this grace period and always prune
1355 unreachable objects immediately, or "never" may be used to
1358 gc.worktreePruneExpire::
1359 When 'git gc' is run, it calls
1360 'git worktree prune --expire 3.months.ago'.
1361 This config variable can be used to set a different grace
1362 period. The value "now" may be used to disable the grace
1363 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1364 may be used to suppress pruning.
1367 gc.<pattern>.reflogExpire::
1368 'git reflog expire' removes reflog entries older than
1369 this time; defaults to 90 days. The value "now" expires all
1370 entries immediately, and "never" suppresses expiration
1371 altogether. With "<pattern>" (e.g.
1372 "refs/stash") in the middle the setting applies only to
1373 the refs that match the <pattern>.
1375 gc.reflogExpireUnreachable::
1376 gc.<pattern>.reflogExpireUnreachable::
1377 'git reflog expire' removes reflog entries older than
1378 this time and are not reachable from the current tip;
1379 defaults to 30 days. The value "now" expires all entries
1380 immediately, and "never" suppresses expiration altogether.
1381 With "<pattern>" (e.g. "refs/stash")
1382 in the middle, the setting applies only to the refs that
1383 match the <pattern>.
1386 Records of conflicted merge you resolved earlier are
1387 kept for this many days when 'git rerere gc' is run.
1388 The default is 60 days. See linkgit:git-rerere[1].
1390 gc.rerereUnresolved::
1391 Records of conflicted merge you have not resolved are
1392 kept for this many days when 'git rerere gc' is run.
1393 The default is 15 days. See linkgit:git-rerere[1].
1395 gitcvs.commitMsgAnnotation::
1396 Append this string to each commit message. Set to empty string
1397 to disable this feature. Defaults to "via git-CVS emulator".
1400 Whether the CVS server interface is enabled for this repository.
1401 See linkgit:git-cvsserver[1].
1404 Path to a log file where the CVS server interface well... logs
1405 various stuff. See linkgit:git-cvsserver[1].
1407 gitcvs.usecrlfattr::
1408 If true, the server will look up the end-of-line conversion
1409 attributes for files to determine the '-k' modes to use. If
1410 the attributes force Git to treat a file as text,
1411 the '-k' mode will be left blank so CVS clients will
1412 treat it as text. If they suppress text conversion, the file
1413 will be set with '-kb' mode, which suppresses any newline munging
1414 the client might otherwise do. If the attributes do not allow
1415 the file type to be determined, then 'gitcvs.allBinary' is
1416 used. See linkgit:gitattributes[5].
1419 This is used if 'gitcvs.usecrlfattr' does not resolve
1420 the correct '-kb' mode to use. If true, all
1421 unresolved files are sent to the client in
1422 mode '-kb'. This causes the client to treat them
1423 as binary files, which suppresses any newline munging it
1424 otherwise might do. Alternatively, if it is set to "guess",
1425 then the contents of the file are examined to decide if
1426 it is binary, similar to 'core.autocrlf'.
1429 Database used by git-cvsserver to cache revision information
1430 derived from the Git repository. The exact meaning depends on the
1431 used database driver, for SQLite (which is the default driver) this
1432 is a filename. Supports variable substitution (see
1433 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1434 Default: '%Ggitcvs.%m.sqlite'
1437 Used Perl DBI driver. You can specify any available driver
1438 for this here, but it might not work. git-cvsserver is tested
1439 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1440 reported *not* to work with 'DBD::mysql'. Experimental feature.
1441 May not contain double colons (`:`). Default: 'SQLite'.
1442 See linkgit:git-cvsserver[1].
1444 gitcvs.dbUser, gitcvs.dbPass::
1445 Database user and password. Only useful if setting 'gitcvs.dbDriver',
1446 since SQLite has no concept of database users and/or passwords.
1447 'gitcvs.dbUser' supports variable substitution (see
1448 linkgit:git-cvsserver[1] for details).
1450 gitcvs.dbTableNamePrefix::
1451 Database table name prefix. Prepended to the names of any
1452 database tables used, allowing a single database to be used
1453 for several repositories. Supports variable substitution (see
1454 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1455 characters will be replaced with underscores.
1457 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1458 'gitcvs.allBinary' can also be specified as
1459 'gitcvs.<access_method>.<varname>' (where 'access_method'
1460 is one of "ext" and "pserver") to make them apply only for the given
1464 gitweb.description::
1467 See linkgit:gitweb[1] for description.
1475 gitweb.remote_heads::
1478 See linkgit:gitweb.conf[5] for description.
1481 If set to true, enable '-n' option by default.
1484 Set the default matching behavior. Using a value of 'basic', 'extended',
1485 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1486 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1487 value 'default' will return to the default matching behavior.
1489 grep.extendedRegexp::
1490 If set to true, enable '--extended-regexp' option by default. This
1491 option is ignored when the 'grep.patternType' option is set to a value
1492 other than 'default'.
1495 Number of grep worker threads to use.
1496 See `grep.threads` in linkgit:git-grep[1] for more information.
1498 grep.fallbackToNoIndex::
1499 If set to true, fall back to git grep --no-index if git grep
1500 is executed outside of a git repository. Defaults to false.
1503 Use this custom program instead of "`gpg`" found on `$PATH` when
1504 making or verifying a PGP signature. The program must support the
1505 same command-line interface as GPG, namely, to verify a detached
1506 signature, "`gpg --verify $file - <$signature`" is run, and the
1507 program is expected to signal a good signature by exiting with
1508 code 0, and to generate an ASCII-armored detached signature, the
1509 standard input of "`gpg -bsau $key`" is fed with the contents to be
1510 signed, and the program is expected to send the result to its
1513 gui.commitMsgWidth::
1514 Defines how wide the commit message window is in the
1515 linkgit:git-gui[1]. "75" is the default.
1518 Specifies how many context lines should be used in calls to diff
1519 made by the linkgit:git-gui[1]. The default is "5".
1521 gui.displayUntracked::
1522 Determines if linkgit:git-gui[1] shows untracked files
1523 in the file list. The default is "true".
1526 Specifies the default encoding to use for displaying of
1527 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1528 It can be overridden by setting the 'encoding' attribute
1529 for relevant files (see linkgit:gitattributes[5]).
1530 If this option is not set, the tools default to the
1533 gui.matchTrackingBranch::
1534 Determines if new branches created with linkgit:git-gui[1] should
1535 default to tracking remote branches with matching names or
1536 not. Default: "false".
1538 gui.newBranchTemplate::
1539 Is used as suggested name when creating new branches using the
1542 gui.pruneDuringFetch::
1543 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1544 performing a fetch. The default value is "false".
1547 Determines if linkgit:git-gui[1] should trust the file modification
1548 timestamp or not. By default the timestamps are not trusted.
1550 gui.spellingDictionary::
1551 Specifies the dictionary used for spell checking commit messages in
1552 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1556 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1557 location detection. It makes blame significantly faster on huge
1558 repositories at the expense of less thorough copy detection.
1560 gui.copyBlameThreshold::
1561 Specifies the threshold to use in 'git gui blame' original location
1562 detection, measured in alphanumeric characters. See the
1563 linkgit:git-blame[1] manual for more information on copy detection.
1565 gui.blamehistoryctx::
1566 Specifies the radius of history context in days to show in
1567 linkgit:gitk[1] for the selected commit, when the `Show History
1568 Context` menu item is invoked from 'git gui blame'. If this
1569 variable is set to zero, the whole history is shown.
1571 guitool.<name>.cmd::
1572 Specifies the shell command line to execute when the corresponding item
1573 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1574 mandatory for every tool. The command is executed from the root of
1575 the working directory, and in the environment it receives the name of
1576 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1577 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1578 the head is detached, 'CUR_BRANCH' is empty).
1580 guitool.<name>.needsFile::
1581 Run the tool only if a diff is selected in the GUI. It guarantees
1582 that 'FILENAME' is not empty.
1584 guitool.<name>.noConsole::
1585 Run the command silently, without creating a window to display its
1588 guitool.<name>.noRescan::
1589 Don't rescan the working directory for changes after the tool
1592 guitool.<name>.confirm::
1593 Show a confirmation dialog before actually running the tool.
1595 guitool.<name>.argPrompt::
1596 Request a string argument from the user, and pass it to the tool
1597 through the 'ARGS' environment variable. Since requesting an
1598 argument implies confirmation, the 'confirm' option has no effect
1599 if this is enabled. If the option is set to 'true', 'yes', or '1',
1600 the dialog uses a built-in generic prompt; otherwise the exact
1601 value of the variable is used.
1603 guitool.<name>.revPrompt::
1604 Request a single valid revision from the user, and set the
1605 'REVISION' environment variable. In other aspects this option
1606 is similar to 'argPrompt', and can be used together with it.
1608 guitool.<name>.revUnmerged::
1609 Show only unmerged branches in the 'revPrompt' subdialog.
1610 This is useful for tools similar to merge or rebase, but not
1611 for things like checkout or reset.
1613 guitool.<name>.title::
1614 Specifies the title to use for the prompt dialog. The default
1617 guitool.<name>.prompt::
1618 Specifies the general prompt string to display at the top of
1619 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1620 The default value includes the actual command.
1623 Specify the browser that will be used to display help in the
1624 'web' format. See linkgit:git-help[1].
1627 Override the default help format used by linkgit:git-help[1].
1628 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1629 the default. 'web' and 'html' are the same.
1632 Automatically correct and execute mistyped commands after
1633 waiting for the given number of deciseconds (0.1 sec). If more
1634 than one command can be deduced from the entered text, nothing
1635 will be executed. If the value of this option is negative,
1636 the corrected command will be executed immediately. If the
1637 value is 0 - the command will be just shown but not executed.
1638 This is the default.
1641 Specify the path where the HTML documentation resides. File system paths
1642 and URLs are supported. HTML pages will be prefixed with this path when
1643 help is displayed in the 'web' format. This defaults to the documentation
1644 path of your Git installation.
1647 Override the HTTP proxy, normally configured using the 'http_proxy',
1648 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1649 addition to the syntax understood by curl, it is possible to specify a
1650 proxy string with a user name but no password, in which case git will
1651 attempt to acquire one in the same way it does for other credentials. See
1652 linkgit:gitcredentials[7] for more information. The syntax thus is
1653 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1654 on a per-remote basis; see remote.<name>.proxy
1656 http.proxyAuthMethod::
1657 Set the method with which to authenticate against the HTTP proxy. This
1658 only takes effect if the configured proxy string contains a user name part
1659 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1660 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1661 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1662 variable. Possible values are:
1665 * `anyauth` - Automatically pick a suitable authentication method. It is
1666 assumed that the proxy answers an unauthenticated request with a 407
1667 status code and one or more Proxy-authenticate headers with supported
1668 authentication methods. This is the default.
1669 * `basic` - HTTP Basic authentication
1670 * `digest` - HTTP Digest authentication; this prevents the password from being
1671 transmitted to the proxy in clear text
1672 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1674 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1678 Attempt authentication without seeking a username or password. This
1679 can be used to attempt GSS-Negotiate authentication without specifying
1680 a username in the URL, as libcurl normally requires a username for
1684 Pass an additional HTTP header when communicating with a server. If
1685 more than one such entry exists, all of them are added as extra
1686 headers. To allow overriding the settings inherited from the system
1687 config, an empty value will reset the extra headers to the empty list.
1690 The pathname of a file containing previously stored cookie lines,
1691 which should be used
1692 in the Git http session, if they match the server. The file format
1693 of the file to read cookies from should be plain HTTP headers or
1694 the Netscape/Mozilla cookie file format (see `curl(1)`).
1695 NOTE that the file specified with http.cookieFile is used only as
1696 input unless http.saveCookies is set.
1699 If set, store cookies received during requests to the file specified by
1700 http.cookieFile. Has no effect if http.cookieFile is unset.
1703 The SSL version to use when negotiating an SSL connection, if you
1704 want to force the default. The available and default version
1705 depend on whether libcurl was built against NSS or OpenSSL and the
1706 particular configuration of the crypto library in use. Internally
1707 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1708 documentation for more details on the format of this option and
1709 for the ssl version supported. Actually the possible values of
1720 Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1721 To force git to use libcurl's default ssl version and ignore any
1722 explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1725 http.sslCipherList::
1726 A list of SSL ciphers to use when negotiating an SSL connection.
1727 The available ciphers depend on whether libcurl was built against
1728 NSS or OpenSSL and the particular configuration of the crypto
1729 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1730 option; see the libcurl documentation for more details on the format
1733 Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1734 To force git to use libcurl's default cipher list and ignore any
1735 explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1739 Whether to verify the SSL certificate when fetching or pushing
1740 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1744 File containing the SSL certificate when fetching or pushing
1745 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1749 File containing the SSL private key when fetching or pushing
1750 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1753 http.sslCertPasswordProtected::
1754 Enable Git's password prompt for the SSL certificate. Otherwise
1755 OpenSSL will prompt the user, possibly many times, if the
1756 certificate or private key is encrypted. Can be overridden by the
1757 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1760 File containing the certificates to verify the peer with when
1761 fetching or pushing over HTTPS. Can be overridden by the
1762 'GIT_SSL_CAINFO' environment variable.
1765 Path containing files with the CA certificates to verify the peer
1766 with when fetching or pushing over HTTPS. Can be overridden
1767 by the 'GIT_SSL_CAPATH' environment variable.
1770 Public key of the https service. It may either be the filename of
1771 a PEM or DER encoded public key file or a string starting with
1772 'sha256//' followed by the base64 encoded sha256 hash of the
1773 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1774 exit with an error if this option is set but not supported by
1778 Attempt to use AUTH SSL/TLS and encrypted data transfers
1779 when connecting via regular FTP protocol. This might be needed
1780 if the FTP server requires it for security reasons or you wish
1781 to connect securely whenever remote FTP server supports it.
1782 Default is false since it might trigger certificate verification
1783 errors on misconfigured servers.
1786 How many HTTP requests to launch in parallel. Can be overridden
1787 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1790 The number of curl sessions (counted across slots) to be kept across
1791 requests. They will not be ended with curl_easy_cleanup() until
1792 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1793 value will be capped at 1. Defaults to 1.
1796 Maximum size in bytes of the buffer used by smart HTTP
1797 transports when POSTing data to the remote system.
1798 For requests larger than this buffer size, HTTP/1.1 and
1799 Transfer-Encoding: chunked is used to avoid creating a
1800 massive pack file locally. Default is 1 MiB, which is
1801 sufficient for most requests.
1803 http.lowSpeedLimit, http.lowSpeedTime::
1804 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1805 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1806 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1807 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1810 A boolean which disables using of EPSV ftp command by curl.
1811 This can helpful with some "poor" ftp servers which don't
1812 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1813 environment variable. Default is false (curl will use EPSV).
1816 The HTTP USER_AGENT string presented to an HTTP server. The default
1817 value represents the version of the client Git such as git/1.7.1.
1818 This option allows you to override this value to a more common value
1819 such as Mozilla/4.0. This may be necessary, for instance, if
1820 connecting through a firewall that restricts HTTP connections to a set
1821 of common USER_AGENT strings (but not including those like git/1.7.1).
1822 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1825 Any of the http.* options above can be applied selectively to some URLs.
1826 For a config key to match a URL, each element of the config key is
1827 compared to that of the URL, in the following order:
1830 . Scheme (e.g., `https` in `https://example.com/`). This field
1831 must match exactly between the config key and the URL.
1833 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1834 This field must match exactly between the config key and the URL.
1836 . Port number (e.g., `8080` in `http://example.com:8080/`).
1837 This field must match exactly between the config key and the URL.
1838 Omitted port numbers are automatically converted to the correct
1839 default for the scheme before matching.
1841 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1842 path field of the config key must match the path field of the URL
1843 either exactly or as a prefix of slash-delimited path elements. This means
1844 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1845 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1846 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1847 key with just path `foo/`).
1849 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1850 the config key has a user name it must match the user name in the
1851 URL exactly. If the config key does not have a user name, that
1852 config key will match a URL with any user name (including none),
1853 but at a lower precedence than a config key with a user name.
1856 The list above is ordered by decreasing precedence; a URL that matches
1857 a config key's path is preferred to one that matches its user name. For example,
1858 if the URL is `https://user@example.com/foo/bar` a config key match of
1859 `https://example.com/foo` will be preferred over a config key match of
1860 `https://user@example.com`.
1862 All URLs are normalized before attempting any matching (the password part,
1863 if embedded in the URL, is always ignored for matching purposes) so that
1864 equivalent URLs that are simply spelled differently will match properly.
1865 Environment variable settings always override any matches. The URLs that are
1866 matched against are those given directly to Git commands. This means any URLs
1867 visited as a result of a redirection do not participate in matching.
1869 i18n.commitEncoding::
1870 Character encoding the commit messages are stored in; Git itself
1871 does not care per se, but this information is necessary e.g. when
1872 importing commits from emails or in the gitk graphical history
1873 browser (and possibly at other places in the future or in other
1874 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1876 i18n.logOutputEncoding::
1877 Character encoding the commit messages are converted to when
1878 running 'git log' and friends.
1881 The configuration variables in the 'imap' section are described
1882 in linkgit:git-imap-send[1].
1885 Specify the version with which new index files should be
1886 initialized. This does not affect existing repositories.
1889 Specify the directory from which templates will be copied.
1890 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1893 Specify the program that will be used to browse your working
1894 repository in gitweb. See linkgit:git-instaweb[1].
1897 The HTTP daemon command-line to start gitweb on your working
1898 repository. See linkgit:git-instaweb[1].
1901 If true the web server started by linkgit:git-instaweb[1] will
1902 be bound to the local IP (127.0.0.1).
1904 instaweb.modulePath::
1905 The default module path for linkgit:git-instaweb[1] to use
1906 instead of /usr/lib/apache2/modules. Only used if httpd
1910 The port number to bind the gitweb httpd to. See
1911 linkgit:git-instaweb[1].
1913 interactive.singleKey::
1914 In interactive commands, allow the user to provide one-letter
1915 input with a single key (i.e., without hitting enter).
1916 Currently this is used by the `--patch` mode of
1917 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1918 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1919 setting is silently ignored if portable keystroke input
1920 is not available; requires the Perl module Term::ReadKey.
1922 interactive.diffFilter::
1923 When an interactive command (such as `git add --patch`) shows
1924 a colorized diff, git will pipe the diff through the shell
1925 command defined by this configuration variable. The command may
1926 mark up the diff further for human consumption, provided that it
1927 retains a one-to-one correspondence with the lines in the
1928 original diff. Defaults to disabled (no filtering).
1931 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1932 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1933 override this option with `--no-abbrev-commit`.
1936 Set the default date-time mode for the 'log' command.
1937 Setting a value for log.date is similar to using 'git log''s
1938 `--date` option. See linkgit:git-log[1] for details.
1941 Print out the ref names of any commits that are shown by the log
1942 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1943 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1944 specified, the full ref name (including prefix) will be printed.
1945 This is the same as the log commands '--decorate' option.
1948 If `true`, `git log` will act as if the `--follow` option was used when
1949 a single <path> is given. This has the same limitations as `--follow`,
1950 i.e. it cannot be used to follow multiple files and does not work well
1951 on non-linear history.
1954 If true, the initial commit will be shown as a big creation event.
1955 This is equivalent to a diff against an empty tree.
1956 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1957 normally hide the root commit will now show it. True by default.
1960 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1961 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1964 If true, makes linkgit:git-mailinfo[1] (and therefore
1965 linkgit:git-am[1]) act by default as if the --scissors option
1966 was provided on the command-line. When active, this features
1967 removes everything from the message body before a scissors
1968 line (i.e. consisting mainly of ">8", "8<" and "-").
1971 The location of an augmenting mailmap file. The default
1972 mailmap, located in the root of the repository, is loaded
1973 first, then the mailmap file pointed to by this variable.
1974 The location of the mailmap file may be in a repository
1975 subdirectory, or somewhere outside of the repository itself.
1976 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1979 Like `mailmap.file`, but consider the value as a reference to a
1980 blob in the repository. If both `mailmap.file` and
1981 `mailmap.blob` are given, both are parsed, with entries from
1982 `mailmap.file` taking precedence. In a bare repository, this
1983 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1987 Specify the programs that may be used to display help in the
1988 'man' format. See linkgit:git-help[1].
1991 Specify the command to invoke the specified man viewer. The
1992 specified command is evaluated in shell with the man page
1993 passed as argument. (See linkgit:git-help[1].)
1996 Override the path for the given tool that may be used to
1997 display help in the 'man' format. See linkgit:git-help[1].
1999 include::merge-config.txt[]
2001 mergetool.<tool>.path::
2002 Override the path for the given tool. This is useful in case
2003 your tool is not in the PATH.
2005 mergetool.<tool>.cmd::
2006 Specify the command to invoke the specified merge tool. The
2007 specified command is evaluated in shell with the following
2008 variables available: 'BASE' is the name of a temporary file
2009 containing the common base of the files to be merged, if available;
2010 'LOCAL' is the name of a temporary file containing the contents of
2011 the file on the current branch; 'REMOTE' is the name of a temporary
2012 file containing the contents of the file from the branch being
2013 merged; 'MERGED' contains the name of the file to which the merge
2014 tool should write the results of a successful merge.
2016 mergetool.<tool>.trustExitCode::
2017 For a custom merge command, specify whether the exit code of
2018 the merge command can be used to determine whether the merge was
2019 successful. If this is not set to true then the merge target file
2020 timestamp is checked and the merge assumed to have been successful
2021 if the file has been updated, otherwise the user is prompted to
2022 indicate the success of the merge.
2024 mergetool.meld.hasOutput::
2025 Older versions of `meld` do not support the `--output` option.
2026 Git will attempt to detect whether `meld` supports `--output`
2027 by inspecting the output of `meld --help`. Configuring
2028 `mergetool.meld.hasOutput` will make Git skip these checks and
2029 use the configured value instead. Setting `mergetool.meld.hasOutput`
2030 to `true` tells Git to unconditionally use the `--output` option,
2031 and `false` avoids using `--output`.
2033 mergetool.keepBackup::
2034 After performing a merge, the original file with conflict markers
2035 can be saved as a file with a `.orig` extension. If this variable
2036 is set to `false` then this file is not preserved. Defaults to
2037 `true` (i.e. keep the backup files).
2039 mergetool.keepTemporaries::
2040 When invoking a custom merge tool, Git uses a set of temporary
2041 files to pass to the tool. If the tool returns an error and this
2042 variable is set to `true`, then these temporary files will be
2043 preserved, otherwise they will be removed after the tool has
2044 exited. Defaults to `false`.
2046 mergetool.writeToTemp::
2047 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2048 conflicting files in the worktree by default. Git will attempt
2049 to use a temporary directory for these files when set `true`.
2050 Defaults to `false`.
2053 Prompt before each invocation of the merge resolution program.
2055 notes.mergeStrategy::
2056 Which merge strategy to choose by default when resolving notes
2057 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2058 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2059 section of linkgit:git-notes[1] for more information on each strategy.
2061 notes.<name>.mergeStrategy::
2062 Which merge strategy to choose when doing a notes merge into
2063 refs/notes/<name>. This overrides the more general
2064 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2065 linkgit:git-notes[1] for more information on the available strategies.
2068 The (fully qualified) refname from which to show notes when
2069 showing commit messages. The value of this variable can be set
2070 to a glob, in which case notes from all matching refs will be
2071 shown. You may also specify this configuration variable
2072 several times. A warning will be issued for refs that do not
2073 exist, but a glob that does not match any refs is silently
2076 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2077 environment variable, which must be a colon separated list of refs or
2080 The effective value of "core.notesRef" (possibly overridden by
2081 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2084 notes.rewrite.<command>::
2085 When rewriting commits with <command> (currently `amend` or
2086 `rebase`) and this variable is set to `true`, Git
2087 automatically copies your notes from the original to the
2088 rewritten commit. Defaults to `true`, but see
2089 "notes.rewriteRef" below.
2092 When copying notes during a rewrite (see the
2093 "notes.rewrite.<command>" option), determines what to do if
2094 the target commit already has a note. Must be one of
2095 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2096 Defaults to `concatenate`.
2098 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2099 environment variable.
2102 When copying notes during a rewrite, specifies the (fully
2103 qualified) ref whose notes should be copied. The ref may be a
2104 glob, in which case notes in all matching refs will be copied.
2105 You may also specify this configuration several times.
2107 Does not have a default value; you must configure this variable to
2108 enable note rewriting. Set it to `refs/notes/commits` to enable
2109 rewriting for the default commit notes.
2111 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2112 environment variable, which must be a colon separated list of refs or
2116 The size of the window used by linkgit:git-pack-objects[1] when no
2117 window size is given on the command line. Defaults to 10.
2120 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2121 maximum depth is given on the command line. Defaults to 50.
2124 The maximum size of memory that is consumed by each thread
2125 in linkgit:git-pack-objects[1] for pack window memory when
2126 no limit is given on the command line. The value can be
2127 suffixed with "k", "m", or "g". When left unconfigured (or
2128 set explicitly to 0), there will be no limit.
2131 An integer -1..9, indicating the compression level for objects
2132 in a pack file. -1 is the zlib default. 0 means no
2133 compression, and 1..9 are various speed/size tradeoffs, 9 being
2134 slowest. If not set, defaults to core.compression. If that is
2135 not set, defaults to -1, the zlib default, which is "a default
2136 compromise between speed and compression (currently equivalent
2139 Note that changing the compression level will not automatically recompress
2140 all existing objects. You can force recompression by passing the -F option
2141 to linkgit:git-repack[1].
2143 pack.deltaCacheSize::
2144 The maximum memory in bytes used for caching deltas in
2145 linkgit:git-pack-objects[1] before writing them out to a pack.
2146 This cache is used to speed up the writing object phase by not
2147 having to recompute the final delta result once the best match
2148 for all objects is found. Repacking large repositories on machines
2149 which are tight with memory might be badly impacted by this though,
2150 especially if this cache pushes the system into swapping.
2151 A value of 0 means no limit. The smallest size of 1 byte may be
2152 used to virtually disable this cache. Defaults to 256 MiB.
2154 pack.deltaCacheLimit::
2155 The maximum size of a delta, that is cached in
2156 linkgit:git-pack-objects[1]. This cache is used to speed up the
2157 writing object phase by not having to recompute the final delta
2158 result once the best match for all objects is found. Defaults to 1000.
2161 Specifies the number of threads to spawn when searching for best
2162 delta matches. This requires that linkgit:git-pack-objects[1]
2163 be compiled with pthreads otherwise this option is ignored with a
2164 warning. This is meant to reduce packing time on multiprocessor
2165 machines. The required amount of memory for the delta search window
2166 is however multiplied by the number of threads.
2167 Specifying 0 will cause Git to auto-detect the number of CPU's
2168 and set the number of threads accordingly.
2171 Specify the default pack index version. Valid values are 1 for
2172 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2173 the new pack index with capabilities for packs larger than 4 GB
2174 as well as proper protection against the repacking of corrupted
2175 packs. Version 2 is the default. Note that version 2 is enforced
2176 and this config option ignored whenever the corresponding pack is
2179 If you have an old Git that does not understand the version 2 `*.idx` file,
2180 cloning or fetching over a non native protocol (e.g. "http")
2181 that will copy both `*.pack` file and corresponding `*.idx` file from the
2182 other side may give you a repository that cannot be accessed with your
2183 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2184 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2187 pack.packSizeLimit::
2188 The maximum size of a pack. This setting only affects
2189 packing to a file when repacking, i.e. the git:// protocol
2190 is unaffected. It can be overridden by the `--max-pack-size`
2191 option of linkgit:git-repack[1]. Reaching this limit results
2192 in the creation of multiple packfiles; which in turn prevents
2193 bitmaps from being created.
2194 The minimum size allowed is limited to 1 MiB.
2195 The default is unlimited.
2196 Common unit suffixes of 'k', 'm', or 'g' are
2200 When true, git will use pack bitmaps (if available) when packing
2201 to stdout (e.g., during the server side of a fetch). Defaults to
2202 true. You should not generally need to turn this off unless
2203 you are debugging pack bitmaps.
2205 pack.writeBitmaps (deprecated)::
2206 This is a deprecated synonym for `repack.writeBitmaps`.
2208 pack.writeBitmapHashCache::
2209 When true, git will include a "hash cache" section in the bitmap
2210 index (if one is written). This cache can be used to feed git's
2211 delta heuristics, potentially leading to better deltas between
2212 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2213 between an older, bitmapped pack and objects that have been
2214 pushed since the last gc). The downside is that it consumes 4
2215 bytes per object of disk space, and that JGit's bitmap
2216 implementation does not understand it, causing it to complain if
2217 Git and JGit are used on the same repository. Defaults to false.
2220 If the value is boolean, turns on or off pagination of the
2221 output of a particular Git subcommand when writing to a tty.
2222 Otherwise, turns on pagination for the subcommand using the
2223 pager specified by the value of `pager.<cmd>`. If `--paginate`
2224 or `--no-pager` is specified on the command line, it takes
2225 precedence over this option. To disable pagination for all
2226 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2229 Alias for a --pretty= format string, as specified in
2230 linkgit:git-log[1]. Any aliases defined here can be used just
2231 as the built-in pretty formats could. For example,
2232 running `git config pretty.changelog "format:* %H %s"`
2233 would cause the invocation `git log --pretty=changelog`
2234 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2235 Note that an alias with the same name as a built-in format
2236 will be silently ignored.
2239 By default, Git does not create an extra merge commit when merging
2240 a commit that is a descendant of the current commit. Instead, the
2241 tip of the current branch is fast-forwarded. When set to `false`,
2242 this variable tells Git to create an extra merge commit in such
2243 a case (equivalent to giving the `--no-ff` option from the command
2244 line). When set to `only`, only such fast-forward merges are
2245 allowed (equivalent to giving the `--ff-only` option from the
2246 command line). This setting overrides `merge.ff` when pulling.
2249 When true, rebase branches on top of the fetched branch, instead
2250 of merging the default branch from the default remote when "git
2251 pull" is run. See "branch.<name>.rebase" for setting this on a
2254 When preserve, also pass `--preserve-merges` along to 'git rebase'
2255 so that locally committed merge commits will not be flattened
2256 by running 'git pull'.
2258 When the value is `interactive`, the rebase is run in interactive mode.
2260 *NOTE*: this is a possibly dangerous operation; do *not* use
2261 it unless you understand the implications (see linkgit:git-rebase[1]
2265 The default merge strategy to use when pulling multiple branches
2269 The default merge strategy to use when pulling a single branch.
2272 Defines the action `git push` should take if no refspec is
2273 explicitly given. Different values are well-suited for
2274 specific workflows; for instance, in a purely central workflow
2275 (i.e. the fetch source is equal to the push destination),
2276 `upstream` is probably what you want. Possible values are:
2280 * `nothing` - do not push anything (error out) unless a refspec is
2281 explicitly given. This is primarily meant for people who want to
2282 avoid mistakes by always being explicit.
2284 * `current` - push the current branch to update a branch with the same
2285 name on the receiving end. Works in both central and non-central
2288 * `upstream` - push the current branch back to the branch whose
2289 changes are usually integrated into the current branch (which is
2290 called `@{upstream}`). This mode only makes sense if you are
2291 pushing to the same repository you would normally pull from
2292 (i.e. central workflow).
2294 * `simple` - in centralized workflow, work like `upstream` with an
2295 added safety to refuse to push if the upstream branch's name is
2296 different from the local one.
2298 When pushing to a remote that is different from the remote you normally
2299 pull from, work as `current`. This is the safest option and is suited
2302 This mode has become the default in Git 2.0.
2304 * `matching` - push all branches having the same name on both ends.
2305 This makes the repository you are pushing to remember the set of
2306 branches that will be pushed out (e.g. if you always push 'maint'
2307 and 'master' there and no other branches, the repository you push
2308 to will have these two branches, and your local 'maint' and
2309 'master' will be pushed there).
2311 To use this mode effectively, you have to make sure _all_ the
2312 branches you would push out are ready to be pushed out before
2313 running 'git push', as the whole point of this mode is to allow you
2314 to push all of the branches in one go. If you usually finish work
2315 on only one branch and push out the result, while other branches are
2316 unfinished, this mode is not for you. Also this mode is not
2317 suitable for pushing into a shared central repository, as other
2318 people may add new branches there, or update the tip of existing
2319 branches outside your control.
2321 This used to be the default, but not since Git 2.0 (`simple` is the
2327 If set to true enable '--follow-tags' option by default. You
2328 may override this configuration at time of push by specifying
2332 May be set to a boolean value, or the string 'if-asked'. A true
2333 value causes all pushes to be GPG signed, as if '--signed' is
2334 passed to linkgit:git-push[1]. The string 'if-asked' causes
2335 pushes to be signed if the server supports it, as if
2336 '--signed=if-asked' is passed to 'git push'. A false value may
2337 override a value from a lower-priority config file. An explicit
2338 command-line flag always overrides this config option.
2340 push.recurseSubmodules::
2341 Make sure all submodule commits used by the revisions to be pushed
2342 are available on a remote-tracking branch. If the value is 'check'
2343 then Git will verify that all submodule commits that changed in the
2344 revisions to be pushed are available on at least one remote of the
2345 submodule. If any commits are missing, the push will be aborted and
2346 exit with non-zero status. If the value is 'on-demand' then all
2347 submodules that changed in the revisions to be pushed will be
2348 pushed. If on-demand was not able to push all necessary revisions
2349 it will also be aborted and exit with non-zero status. If the value
2350 is 'no' then default behavior of ignoring submodules when pushing
2351 is retained. You may override this configuration at time of push by
2352 specifying '--recurse-submodules=check|on-demand|no'.
2355 Whether to show a diffstat of what changed upstream since the last
2356 rebase. False by default.
2359 If set to true enable '--autosquash' option by default.
2362 When set to true, automatically create a temporary stash
2363 before the operation begins, and apply it after the operation
2364 ends. This means that you can run rebase on a dirty worktree.
2365 However, use with care: the final stash application after a
2366 successful rebase might result in non-trivial conflicts.
2369 rebase.missingCommitsCheck::
2370 If set to "warn", git rebase -i will print a warning if some
2371 commits are removed (e.g. a line was deleted), however the
2372 rebase will still proceed. If set to "error", it will print
2373 the previous warning and stop the rebase, 'git rebase
2374 --edit-todo' can then be used to correct the error. If set to
2375 "ignore", no checking is done.
2376 To drop a commit without warning or error, use the `drop`
2377 command in the todo-list.
2378 Defaults to "ignore".
2380 rebase.instructionFormat
2381 A format string, as specified in linkgit:git-log[1], to be used for
2382 the instruction list during an interactive rebase. The format will automatically
2383 have the long commit hash prepended to the format.
2385 receive.advertiseAtomic::
2386 By default, git-receive-pack will advertise the atomic push
2387 capability to its clients. If you don't want to this capability
2388 to be advertised, set this variable to false.
2391 By default, git-receive-pack will run "git-gc --auto" after
2392 receiving data from git-push and updating refs. You can stop
2393 it by setting this variable to false.
2395 receive.certNonceSeed::
2396 By setting this variable to a string, `git receive-pack`
2397 will accept a `git push --signed` and verifies it by using
2398 a "nonce" protected by HMAC using this string as a secret
2401 receive.certNonceSlop::
2402 When a `git push --signed` sent a push certificate with a
2403 "nonce" that was issued by a receive-pack serving the same
2404 repository within this many seconds, export the "nonce"
2405 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2406 hooks (instead of what the receive-pack asked the sending
2407 side to include). This may allow writing checks in
2408 `pre-receive` and `post-receive` a bit easier. Instead of
2409 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2410 that records by how many seconds the nonce is stale to
2411 decide if they want to accept the certificate, they only
2412 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2414 receive.fsckObjects::
2415 If it is set to true, git-receive-pack will check all received
2416 objects. It will abort in the case of a malformed object or a
2417 broken link. The result of an abort are only dangling objects.
2418 Defaults to false. If not set, the value of `transfer.fsckObjects`
2421 receive.fsck.<msg-id>::
2422 When `receive.fsckObjects` is set to true, errors can be switched
2423 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2424 setting where the `<msg-id>` is the fsck message ID and the value
2425 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2426 the error/warning with the message ID, e.g. "missingEmail: invalid
2427 author/committer line - missing email" means that setting
2428 `receive.fsck.missingEmail = ignore` will hide that issue.
2430 This feature is intended to support working with legacy repositories
2431 which would not pass pushing when `receive.fsckObjects = true`, allowing
2432 the host to accept repositories with certain known issues but still catch
2435 receive.fsck.skipList::
2436 The path to a sorted list of object names (i.e. one SHA-1 per
2437 line) that are known to be broken in a non-fatal way and should
2438 be ignored. This feature is useful when an established project
2439 should be accepted despite early commits containing errors that
2440 can be safely ignored such as invalid committer email addresses.
2441 Note: corrupt objects cannot be skipped with this setting.
2443 receive.unpackLimit::
2444 If the number of objects received in a push is below this
2445 limit then the objects will be unpacked into loose object
2446 files. However if the number of received objects equals or
2447 exceeds this limit then the received pack will be stored as
2448 a pack, after adding any missing delta bases. Storing the
2449 pack from a push can make the push operation complete faster,
2450 especially on slow filesystems. If not set, the value of
2451 `transfer.unpackLimit` is used instead.
2453 receive.denyDeletes::
2454 If set to true, git-receive-pack will deny a ref update that deletes
2455 the ref. Use this to prevent such a ref deletion via a push.
2457 receive.denyDeleteCurrent::
2458 If set to true, git-receive-pack will deny a ref update that
2459 deletes the currently checked out branch of a non-bare repository.
2461 receive.denyCurrentBranch::
2462 If set to true or "refuse", git-receive-pack will deny a ref update
2463 to the currently checked out branch of a non-bare repository.
2464 Such a push is potentially dangerous because it brings the HEAD
2465 out of sync with the index and working tree. If set to "warn",
2466 print a warning of such a push to stderr, but allow the push to
2467 proceed. If set to false or "ignore", allow such pushes with no
2468 message. Defaults to "refuse".
2470 Another option is "updateInstead" which will update the working
2471 tree if pushing into the current branch. This option is
2472 intended for synchronizing working directories when one side is not easily
2473 accessible via interactive ssh (e.g. a live web site, hence the requirement
2474 that the working directory be clean). This mode also comes in handy when
2475 developing inside a VM to test and fix code on different Operating Systems.
2477 By default, "updateInstead" will refuse the push if the working tree or
2478 the index have any difference from the HEAD, but the `push-to-checkout`
2479 hook can be used to customize this. See linkgit:githooks[5].
2481 receive.denyNonFastForwards::
2482 If set to true, git-receive-pack will deny a ref update which is
2483 not a fast-forward. Use this to prevent such an update via a push,
2484 even if that push is forced. This configuration variable is
2485 set when initializing a shared repository.
2488 This variable is the same as `transfer.hideRefs`, but applies
2489 only to `receive-pack` (and so affects pushes, but not fetches).
2490 An attempt to update or delete a hidden ref by `git push` is
2493 receive.updateServerInfo::
2494 If set to true, git-receive-pack will run git-update-server-info
2495 after receiving data from git-push and updating refs.
2497 receive.shallowUpdate::
2498 If set to true, .git/shallow can be updated when new refs
2499 require new shallow roots. Otherwise those refs are rejected.
2501 remote.pushDefault::
2502 The remote to push to by default. Overrides
2503 `branch.<name>.remote` for all branches, and is overridden by
2504 `branch.<name>.pushRemote` for specific branches.
2507 The URL of a remote repository. See linkgit:git-fetch[1] or
2508 linkgit:git-push[1].
2510 remote.<name>.pushurl::
2511 The push URL of a remote repository. See linkgit:git-push[1].
2513 remote.<name>.proxy::
2514 For remotes that require curl (http, https and ftp), the URL to
2515 the proxy to use for that remote. Set to the empty string to
2516 disable proxying for that remote.
2518 remote.<name>.proxyAuthMethod::
2519 For remotes that require curl (http, https and ftp), the method to use for
2520 authenticating against the proxy in use (probably set in
2521 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2523 remote.<name>.fetch::
2524 The default set of "refspec" for linkgit:git-fetch[1]. See
2525 linkgit:git-fetch[1].
2527 remote.<name>.push::
2528 The default set of "refspec" for linkgit:git-push[1]. See
2529 linkgit:git-push[1].
2531 remote.<name>.mirror::
2532 If true, pushing to this remote will automatically behave
2533 as if the `--mirror` option was given on the command line.
2535 remote.<name>.skipDefaultUpdate::
2536 If true, this remote will be skipped by default when updating
2537 using linkgit:git-fetch[1] or the `update` subcommand of
2538 linkgit:git-remote[1].
2540 remote.<name>.skipFetchAll::
2541 If true, this remote will be skipped by default when updating
2542 using linkgit:git-fetch[1] or the `update` subcommand of
2543 linkgit:git-remote[1].
2545 remote.<name>.receivepack::
2546 The default program to execute on the remote side when pushing. See
2547 option --receive-pack of linkgit:git-push[1].
2549 remote.<name>.uploadpack::
2550 The default program to execute on the remote side when fetching. See
2551 option --upload-pack of linkgit:git-fetch-pack[1].
2553 remote.<name>.tagOpt::
2554 Setting this value to --no-tags disables automatic tag following when
2555 fetching from remote <name>. Setting it to --tags will fetch every
2556 tag from remote <name>, even if they are not reachable from remote
2557 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2558 override this setting. See options --tags and --no-tags of
2559 linkgit:git-fetch[1].
2562 Setting this to a value <vcs> will cause Git to interact with
2563 the remote with the git-remote-<vcs> helper.
2565 remote.<name>.prune::
2566 When set to true, fetching from this remote by default will also
2567 remove any remote-tracking references that no longer exist on the
2568 remote (as if the `--prune` option was given on the command line).
2569 Overrides `fetch.prune` settings, if any.
2572 The list of remotes which are fetched by "git remote update
2573 <group>". See linkgit:git-remote[1].
2575 repack.useDeltaBaseOffset::
2576 By default, linkgit:git-repack[1] creates packs that use
2577 delta-base offset. If you need to share your repository with
2578 Git older than version 1.4.4, either directly or via a dumb
2579 protocol such as http, then you need to set this option to
2580 "false" and repack. Access from old Git versions over the
2581 native protocol are unaffected by this option.
2583 repack.packKeptObjects::
2584 If set to true, makes `git repack` act as if
2585 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2586 details. Defaults to `false` normally, but `true` if a bitmap
2587 index is being written (either via `--write-bitmap-index` or
2588 `repack.writeBitmaps`).
2590 repack.writeBitmaps::
2591 When true, git will write a bitmap index when packing all
2592 objects to disk (e.g., when `git repack -a` is run). This
2593 index can speed up the "counting objects" phase of subsequent
2594 packs created for clones and fetches, at the cost of some disk
2595 space and extra time spent on the initial repack. This has
2596 no effect if multiple packfiles are created.
2600 When set to true, `git-rerere` updates the index with the
2601 resulting contents after it cleanly resolves conflicts using
2602 previously recorded resolution. Defaults to false.
2605 Activate recording of resolved conflicts, so that identical
2606 conflict hunks can be resolved automatically, should they be
2607 encountered again. By default, linkgit:git-rerere[1] is
2608 enabled if there is an `rr-cache` directory under the
2609 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2612 sendemail.identity::
2613 A configuration identity. When given, causes values in the
2614 'sendemail.<identity>' subsection to take precedence over
2615 values in the 'sendemail' section. The default identity is
2616 the value of 'sendemail.identity'.
2618 sendemail.smtpEncryption::
2619 See linkgit:git-send-email[1] for description. Note that this
2620 setting is not subject to the 'identity' mechanism.
2622 sendemail.smtpssl (deprecated)::
2623 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2625 sendemail.smtpsslcertpath::
2626 Path to ca-certificates (either a directory or a single file).
2627 Set it to an empty string to disable certificate verification.
2629 sendemail.<identity>.*::
2630 Identity-specific versions of the 'sendemail.*' parameters
2631 found below, taking precedence over those when the this
2632 identity is selected, through command-line or
2633 'sendemail.identity'.
2635 sendemail.aliasesFile::
2636 sendemail.aliasFileType::
2637 sendemail.annotate::
2641 sendemail.chainReplyTo::
2643 sendemail.envelopeSender::
2645 sendemail.multiEdit::
2646 sendemail.signedoffbycc::
2647 sendemail.smtpPass::
2648 sendemail.suppresscc::
2649 sendemail.suppressFrom::
2651 sendemail.smtpDomain::
2652 sendemail.smtpServer::
2653 sendemail.smtpServerPort::
2654 sendemail.smtpServerOption::
2655 sendemail.smtpUser::
2657 sendemail.transferEncoding::
2658 sendemail.validate::
2660 See linkgit:git-send-email[1] for description.
2662 sendemail.signedoffcc (deprecated)::
2663 Deprecated alias for 'sendemail.signedoffbycc'.
2665 showbranch.default::
2666 The default set of branches for linkgit:git-show-branch[1].
2667 See linkgit:git-show-branch[1].
2669 status.relativePaths::
2670 By default, linkgit:git-status[1] shows paths relative to the
2671 current directory. Setting this variable to `false` shows paths
2672 relative to the repository root (this was the default for Git
2676 Set to true to enable --short by default in linkgit:git-status[1].
2677 The option --no-short takes precedence over this variable.
2680 Set to true to enable --branch by default in linkgit:git-status[1].
2681 The option --no-branch takes precedence over this variable.
2683 status.displayCommentPrefix::
2684 If set to true, linkgit:git-status[1] will insert a comment
2685 prefix before each output line (starting with
2686 `core.commentChar`, i.e. `#` by default). This was the
2687 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2690 status.showUntrackedFiles::
2691 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2692 files which are not currently tracked by Git. Directories which
2693 contain only untracked files, are shown with the directory name
2694 only. Showing untracked files means that Git needs to lstat() all
2695 the files in the whole repository, which might be slow on some
2696 systems. So, this variable controls how the commands displays
2697 the untracked files. Possible values are:
2700 * `no` - Show no untracked files.
2701 * `normal` - Show untracked files and directories.
2702 * `all` - Show also individual files in untracked directories.
2705 If this variable is not specified, it defaults to 'normal'.
2706 This variable can be overridden with the -u|--untracked-files option
2707 of linkgit:git-status[1] and linkgit:git-commit[1].
2709 status.submoduleSummary::
2711 If this is set to a non zero number or true (identical to -1 or an
2712 unlimited number), the submodule summary will be enabled and a
2713 summary of commits for modified submodules will be shown (see
2714 --summary-limit option of linkgit:git-submodule[1]). Please note
2715 that the summary output command will be suppressed for all
2716 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2717 for those submodules where `submodule.<name>.ignore=all`. The only
2718 exception to that rule is that status and commit will show staged
2719 submodule changes. To
2720 also view the summary for ignored submodules you can either use
2721 the --ignore-submodules=dirty command-line option or the 'git
2722 submodule summary' command, which shows a similar output but does
2723 not honor these settings.
2726 If this is set to true, the `git stash show` command without an
2727 option will show the stash in patch form. Defaults to false.
2728 See description of 'show' command in linkgit:git-stash[1].
2731 If this is set to true, the `git stash show` command without an
2732 option will show diffstat of the stash. Defaults to true.
2733 See description of 'show' command in linkgit:git-stash[1].
2735 submodule.<name>.path::
2736 submodule.<name>.url::
2737 The path within this project and URL for a submodule. These
2738 variables are initially populated by 'git submodule init'. See
2739 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2742 submodule.<name>.update::
2743 The default update procedure for a submodule. This variable
2744 is populated by `git submodule init` from the
2745 linkgit:gitmodules[5] file. See description of 'update'
2746 command in linkgit:git-submodule[1].
2748 submodule.<name>.branch::
2749 The remote branch name for a submodule, used by `git submodule
2750 update --remote`. Set this option to override the value found in
2751 the `.gitmodules` file. See linkgit:git-submodule[1] and
2752 linkgit:gitmodules[5] for details.
2754 submodule.<name>.fetchRecurseSubmodules::
2755 This option can be used to control recursive fetching of this
2756 submodule. It can be overridden by using the --[no-]recurse-submodules
2757 command-line option to "git fetch" and "git pull".
2758 This setting will override that from in the linkgit:gitmodules[5]
2761 submodule.<name>.ignore::
2762 Defines under what circumstances "git status" and the diff family show
2763 a submodule as modified. When set to "all", it will never be considered
2764 modified (but it will nonetheless show up in the output of status and
2765 commit when it has been staged), "dirty" will ignore all changes
2766 to the submodules work tree and
2767 takes only differences between the HEAD of the submodule and the commit
2768 recorded in the superproject into account. "untracked" will additionally
2769 let submodules with modified tracked files in their work tree show up.
2770 Using "none" (the default when this option is not set) also shows
2771 submodules that have untracked files in their work tree as changed.
2772 This setting overrides any setting made in .gitmodules for this submodule,
2773 both settings can be overridden on the command line by using the
2774 "--ignore-submodules" option. The 'git submodule' commands are not
2775 affected by this setting.
2777 submodule.fetchJobs::
2778 Specifies how many submodules are fetched/cloned at the same time.
2779 A positive integer allows up to that number of submodules fetched
2780 in parallel. A value of 0 will give some reasonable default.
2781 If unset, it defaults to 1.
2783 tag.forceSignAnnotated::
2784 A boolean to specify whether annotated tags created should be GPG signed.
2785 If `--annotate` is specified on the command line, it takes
2786 precedence over this option.
2789 This variable controls the sort ordering of tags when displayed by
2790 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2791 value of this variable will be used as the default.
2794 This variable can be used to restrict the permission bits of
2795 tar archive entries. The default is 0002, which turns off the
2796 world write bit. The special value "user" indicates that the
2797 archiving user's umask will be used instead. See umask(2) and
2798 linkgit:git-archive[1].
2800 transfer.fsckObjects::
2801 When `fetch.fsckObjects` or `receive.fsckObjects` are
2802 not set, the value of this variable is used instead.
2806 String(s) `receive-pack` and `upload-pack` use to decide which
2807 refs to omit from their initial advertisements. Use more than
2808 one definition to specify multiple prefix strings. A ref that is
2809 under the hierarchies listed in the value of this variable is
2810 excluded, and is hidden when responding to `git push` or `git
2811 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2812 program-specific versions of this config.
2814 You may also include a `!` in front of the ref name to negate the entry,
2815 explicitly exposing it, even if an earlier entry marked it as hidden.
2816 If you have multiple hideRefs values, later entries override earlier ones
2817 (and entries in more-specific config files override less-specific ones).
2819 If a namespace is in use, the namespace prefix is stripped from each
2820 reference before it is matched against `transfer.hiderefs` patterns.
2821 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2822 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2823 is omitted from the advertisements but `refs/heads/master` and
2824 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2825 "have" lines. In order to match refs before stripping, add a `^` in front of
2826 the ref name. If you combine `!` and `^`, `!` must be specified first.
2828 transfer.unpackLimit::
2829 When `fetch.unpackLimit` or `receive.unpackLimit` are
2830 not set, the value of this variable is used instead.
2831 The default value is 100.
2833 uploadarchive.allowUnreachable::
2834 If true, allow clients to use `git archive --remote` to request
2835 any tree, whether reachable from the ref tips or not. See the
2836 discussion in the `SECURITY` section of
2837 linkgit:git-upload-archive[1] for more details. Defaults to
2840 uploadpack.hideRefs::
2841 This variable is the same as `transfer.hideRefs`, but applies
2842 only to `upload-pack` (and so affects only fetches, not pushes).
2843 An attempt to fetch a hidden ref by `git fetch` will fail. See
2844 also `uploadpack.allowTipSHA1InWant`.
2846 uploadpack.allowTipSHA1InWant::
2847 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2848 to accept a fetch request that asks for an object at the tip
2849 of a hidden ref (by default, such a request is rejected).
2850 see also `uploadpack.hideRefs`.
2852 uploadpack.allowReachableSHA1InWant::
2853 Allow `upload-pack` to accept a fetch request that asks for an
2854 object that is reachable from any ref tip. However, note that
2855 calculating object reachability is computationally expensive.
2856 Defaults to `false`.
2858 uploadpack.keepAlive::
2859 When `upload-pack` has started `pack-objects`, there may be a
2860 quiet period while `pack-objects` prepares the pack. Normally
2861 it would output progress information, but if `--quiet` was used
2862 for the fetch, `pack-objects` will output nothing at all until
2863 the pack data begins. Some clients and networks may consider
2864 the server to be hung and give up. Setting this option instructs
2865 `upload-pack` to send an empty keepalive packet every
2866 `uploadpack.keepAlive` seconds. Setting this option to 0
2867 disables keepalive packets entirely. The default is 5 seconds.
2869 url.<base>.insteadOf::
2870 Any URL that starts with this value will be rewritten to
2871 start, instead, with <base>. In cases where some site serves a
2872 large number of repositories, and serves them with multiple
2873 access methods, and some users need to use different access
2874 methods, this feature allows people to specify any of the
2875 equivalent URLs and have Git automatically rewrite the URL to
2876 the best alternative for the particular user, even for a
2877 never-before-seen repository on the site. When more than one
2878 insteadOf strings match a given URL, the longest match is used.
2880 url.<base>.pushInsteadOf::
2881 Any URL that starts with this value will not be pushed to;
2882 instead, it will be rewritten to start with <base>, and the
2883 resulting URL will be pushed to. In cases where some site serves
2884 a large number of repositories, and serves them with multiple
2885 access methods, some of which do not allow push, this feature
2886 allows people to specify a pull-only URL and have Git
2887 automatically use an appropriate URL to push, even for a
2888 never-before-seen repository on the site. When more than one
2889 pushInsteadOf strings match a given URL, the longest match is
2890 used. If a remote has an explicit pushurl, Git will ignore this
2891 setting for that remote.
2894 Your email address to be recorded in any newly created commits.
2895 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2896 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2899 Your full name to be recorded in any newly created commits.
2900 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2901 environment variables. See linkgit:git-commit-tree[1].
2903 user.useConfigOnly::
2904 Instruct Git to avoid trying to guess defaults for 'user.email'
2905 and 'user.name', and instead retrieve the values only from the
2906 configuration. For example, if you have multiple email addresses
2907 and would like to use a different one for each repository, then
2908 with this configuration option set to `true` in the global config
2909 along with a name, Git will prompt you to set up an email before
2910 making new commits in a newly cloned repository.
2911 Defaults to `false`.
2914 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2915 key you want it to automatically when creating a signed tag or
2916 commit, you can override the default selection with this variable.
2917 This option is passed unchanged to gpg's --local-user parameter,
2918 so you may specify a key using any method that gpg supports.
2920 versionsort.prereleaseSuffix::
2921 When version sort is used in linkgit:git-tag[1], prerelease
2922 tags (e.g. "1.0-rc1") may appear after the main release
2923 "1.0". By specifying the suffix "-rc" in this variable,
2924 "1.0-rc1" will appear before "1.0".
2926 This variable can be specified multiple times, once per suffix. The
2927 order of suffixes in the config file determines the sorting order
2928 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2929 is sorted before 1.0-rcXX). The sorting order between different
2930 suffixes is undefined if they are in multiple config files.
2933 Specify a web browser that may be used by some commands.
2934 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]