range-diff: use dim/bold cues to improve dual color mode
[git/git.git] / Documentation / config.txt
2 ------------------
4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times; we say then that the variable is
18 multivalued.
20 Syntax
21 ~~~~~~
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:
38 --------
39 [section "subsection"]
41 --------
43 Subsection names are case sensitive and can contain any characters except
44 newline and the null byte. Doublequote `"` and backslash can be included
45 by escaping them as `\"` and `\\`, respectively. Backslashes preceding
46 other characters are dropped when reading; for example, `\t` is read as
47 `t` and `\0` is read as `0` Section headers cannot span multiple lines.
48 Variables may belong directly to a section or to a given subsection. You
49 can have `[section]` if you have `[section "subsection"]`, but you don't
50 need to.
52 There is also a deprecated `[section.subsection]` syntax. With this
53 syntax, the subsection name is converted to lower-case and is also
54 compared case sensitively. These subsection names follow the same
55 restrictions as section names.
57 All the other lines (and the remainder of the line after the section
58 header) are recognized as setting variables, in the form
59 'name = value' (or just 'name', which is a short-hand to say that
60 the variable is the boolean "true").
61 The variable names are case-insensitive, allow only alphanumeric characters
62 and `-`, and must start with an alphabetic character.
64 A line that defines a value can be continued to the next line by
65 ending it with a `\`; the backquote and the end-of-line are
66 stripped. Leading whitespaces after 'name =', the remainder of the
67 line after the first comment character '#' or ';', and trailing
68 whitespaces of the line are discarded unless they are enclosed in
69 double quotes. Internal whitespaces within the value are retained
70 verbatim.
72 Inside double quotes, double quote `"` and backslash `\` characters
73 must be escaped: use `\"` for `"` and `\\` for `\`.
75 The following escape sequences (beside `\"` and `\\`) are recognized:
76 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77 and `\b` for backspace (BS). Other char escape sequences (including octal
78 escape sequences) are invalid.
81 Includes
82 ~~~~~~~~
84 The `include` and `includeIf` sections allow you to include config
85 directives from another source. These sections behave identically to
86 each other with the exception that `includeIf` sections may be ignored
87 if their condition does not evaluate to true; see "Conditional includes"
88 below.
90 You can include a config file from another by setting the special
91 `include.path` (or `includeIf.*.path`) variable to the name of the file
92 to be included. The variable takes a pathname as its value, and is
93 subject to tilde expansion. These variables can be given multiple times.
95 The contents of the included file are inserted immediately, as if they
96 had been found at the location of the include directive. If the value of the
97 variable is a relative path, the path is considered to
98 be relative to the configuration file in which the include directive
99 was found. See below for examples.
101 Conditional includes
102 ~~~~~~~~~~~~~~~~~~~~
104 You can include a config file from another conditionally by setting a
105 `includeIf.<condition>.path` variable to the name of the file to be
106 included.
108 The condition starts with a keyword followed by a colon and some data
109 whose format and meaning depends on the keyword. Supported keywords
110 are:
112 `gitdir`::
114 The data that follows the keyword `gitdir:` is used as a glob
115 pattern. If the location of the .git directory matches the
116 pattern, the include condition is met.
117 +
118 The .git location may be auto-discovered, or come from `$GIT_DIR`
119 environment variable. If the repository is auto discovered via a .git
120 file (e.g. from submodules, or a linked worktree), the .git location
121 would be the final location where the .git directory is, not where the
122 .git file is.
123 +
124 The pattern can contain standard globbing wildcards and two additional
125 ones, `**/` and `/**`, that can match multiple path components. Please
126 refer to linkgit:gitignore[5] for details. For convenience:
128 * If the pattern starts with `~/`, `~` will be substituted with the
129 content of the environment variable `HOME`.
131 * If the pattern starts with `./`, it is replaced with the directory
132 containing the current config file.
134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
135 will be automatically prepended. For example, the pattern `foo/bar`
136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
138 * If the pattern ends with `/`, `**` will be automatically added. For
139 example, the pattern `foo/` becomes `foo/**`. In other words, it
140 matches "foo" and everything inside, recursively.
142 `gitdir/i`::
143 This is the same as `gitdir` except that matching is done
144 case-insensitively (e.g. on case-insensitive file sytems)
146 A few more notes on matching via `gitdir` and `gitdir/i`:
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
150 * Both the symlink & realpath versions of paths will be matched
151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
153 will match.
154 +
155 This was not the case in the initial release of this feature in
156 v2.13.0, which only matched the realpath version. Configuration that
157 wants to be compatible with the initial release of this feature needs
158 to either specify only the realpath version, or both versions.
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
163 Example
164 ~~~~~~~
166 # Core variables
167 [core]
168 ; Don't trust file modes
169 filemode = false
171 # Our diff algorithm
172 [diff]
173 external = /usr/local/bin/diff-wrapper
174 renames = true
176 [branch "devel"]
177 remote = origin
178 merge = refs/heads/devel
180 # Proxy settings
181 [core]
182 gitProxy="ssh" for "kernel.org"
183 gitProxy=default-proxy ; for the rest
185 [include]
186 path = /path/to/foo.inc ; include by absolute path
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
202 ; relative paths are always relative to the including
203 ; file (if the condition is true); their location is not
204 ; affected by the condition
205 [includeIf "gitdir:/path/to/group/"]
206 path = foo.inc
208 Values
209 ~~~~~~
211 Values of many variables are treated as a simple string, but there
212 are variables that take values of specific types and there are rules
213 as to how to spell them.
215 boolean::
217 When a variable is said to take a boolean value, many
218 synonyms are accepted for 'true' and 'false'; these are all
219 case-insensitive.
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
223 is taken as true.
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
227 +
228 When converting value to the canonical form using `--bool` type
229 specifier, 'git config' will ensure that the output is "true" or
230 "false" (spelled in lowercase).
232 integer::
233 The value for many variables that specify various sizes can
234 be suffixed with `k`, `M`,... to mean "scale the number by
235 1024", "by 1024x1024", etc.
237 color::
238 The value for a variable that takes a color is a list of
239 colors (at most two, one for foreground and one for background)
240 and attributes (as many as you want), separated by spaces.
241 +
242 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
243 `blue`, `magenta`, `cyan` and `white`. The first color given is the
244 foreground; the second is the background.
245 +
246 Colors may also be given as numbers between 0 and 255; these use ANSI
247 256-color mode (but note that not all terminals may support this). If
248 your terminal supports it, you may also specify 24-bit RGB values as
249 hex, like `#ff0ab3`.
250 +
251 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
252 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
253 The position of any attributes with respect to the colors
254 (before, after, or in between), doesn't matter. Specific attributes may
255 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
256 `no-ul`, etc).
257 +
258 An empty color string produces no color effect at all. This can be used
259 to avoid coloring specific elements without disabling color entirely.
260 +
261 For git's pre-defined color slots, the attributes are meant to be reset
262 at the beginning of each item in the colored output. So setting
263 `color.decorate.branch` to `black` will paint that branch name in a
264 plain `black`, even if the previous thing on the same output line (e.g.
265 opening parenthesis before the list of branch names in `log --decorate`
266 output) is set to be painted with `bold` or some other attribute.
267 However, custom log formats may do more complicated and layered
268 coloring, and the negated forms may be useful there.
270 pathname::
271 A variable that takes a pathname value can be given a
272 string that begins with "`~/`" or "`~user/`", and the usual
273 tilde expansion happens to such a string: `~/`
274 is expanded to the value of `$HOME`, and `~user/` to the
275 specified user's home directory.
278 Variables
279 ~~~~~~~~~
281 Note that this list is non-comprehensive and not necessarily complete.
282 For command-specific variables, you will find a more detailed description
283 in the appropriate manual page.
285 Other git-related tools may and do use their own variables. When
286 inventing new variables for use in your own tool, make sure their
287 names do not conflict with those that are used by Git itself and
288 other popular tools, and describe them in your documentation.
291 advice.*::
292 These variables control various optional help messages designed to
293 aid new users. All 'advice.*' variables default to 'true', and you
294 can tell Git that you do not need help by setting these to 'false':
295 +
296 --
297 pushUpdateRejected::
298 Set this variable to 'false' if you want to disable
299 'pushNonFFCurrent',
300 'pushNonFFMatching', 'pushAlreadyExists',
301 'pushFetchFirst', and 'pushNeedsForce'
302 simultaneously.
303 pushNonFFCurrent::
304 Advice shown when linkgit:git-push[1] fails due to a
305 non-fast-forward update to the current branch.
306 pushNonFFMatching::
307 Advice shown when you ran linkgit:git-push[1] and pushed
308 'matching refs' explicitly (i.e. you used ':', or
309 specified a refspec that isn't your current branch) and
310 it resulted in a non-fast-forward error.
311 pushAlreadyExists::
312 Shown when linkgit:git-push[1] rejects an update that
313 does not qualify for fast-forwarding (e.g., a tag.)
314 pushFetchFirst::
315 Shown when linkgit:git-push[1] rejects an update that
316 tries to overwrite a remote ref that points at an
317 object we do not have.
318 pushNeedsForce::
319 Shown when linkgit:git-push[1] rejects an update that
320 tries to overwrite a remote ref that points at an
321 object that is not a commit-ish, or make the remote
322 ref point at an object that is not a commit-ish.
323 statusHints::
324 Show directions on how to proceed from the current
325 state in the output of linkgit:git-status[1], in
326 the template shown when writing commit messages in
327 linkgit:git-commit[1], and in the help message shown
328 by linkgit:git-checkout[1] when switching branch.
329 statusUoption::
330 Advise to consider using the `-u` option to linkgit:git-status[1]
331 when the command takes more than 2 seconds to enumerate untracked
332 files.
333 commitBeforeMerge::
334 Advice shown when linkgit:git-merge[1] refuses to
335 merge to avoid overwriting local changes.
336 resolveConflict::
337 Advice shown by various commands when conflicts
338 prevent the operation from being performed.
339 implicitIdentity::
340 Advice on how to set your identity configuration when
341 your information is guessed from the system username and
342 domain name.
343 detachedHead::
344 Advice shown when you used linkgit:git-checkout[1] to
345 move to the detach HEAD state, to instruct how to create
346 a local branch after the fact.
347 checkoutAmbiguousRemoteBranchName::
348 Advice shown when the argument to
349 linkgit:git-checkout[1] ambiguously resolves to a
350 remote tracking branch on more than one remote in
351 situations where an unambiguous argument would have
352 otherwise caused a remote-tracking branch to be
353 checked out. See the `checkout.defaultRemote`
354 configuration variable for how to set a given remote
355 to used by default in some situations where this
356 advice would be printed.
357 amWorkDir::
358 Advice that shows the location of the patch file when
359 linkgit:git-am[1] fails to apply it.
360 rmHints::
361 In case of failure in the output of linkgit:git-rm[1],
362 show directions on how to proceed from the current state.
363 addEmbeddedRepo::
364 Advice on what to do when you've accidentally added one
365 git repo inside of another.
366 ignoredHook::
367 Advice shown if a hook is ignored because the hook is not
368 set as executable.
369 waitingForEditor::
370 Print a message to the terminal whenever Git is waiting for
371 editor input from the user.
372 --
374 core.fileMode::
375 Tells Git if the executable bit of files in the working tree
376 is to be honored.
377 +
378 Some filesystems lose the executable bit when a file that is
379 marked as executable is checked out, or checks out a
380 non-executable file with executable bit on.
381 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
382 to see if it handles the executable bit correctly
383 and this variable is automatically set as necessary.
384 +
385 A repository, however, may be on a filesystem that handles
386 the filemode correctly, and this variable is set to 'true'
387 when created, but later may be made accessible from another
388 environment that loses the filemode (e.g. exporting ext4 via
389 CIFS mount, visiting a Cygwin created repository with
390 Git for Windows or Eclipse).
391 In such a case it may be necessary to set this variable to 'false'.
392 See linkgit:git-update-index[1].
393 +
394 The default is true (when core.filemode is not specified in the config file).
396 core.hideDotFiles::
397 (Windows-only) If true, mark newly-created directories and files whose
398 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
399 directory is hidden, but no other files starting with a dot. The
400 default mode is 'dotGitOnly'.
402 core.ignoreCase::
403 Internal variable which enables various workarounds to enable
404 Git to work better on filesystems that are not case sensitive,
405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
406 finds "makefile" when Git expects "Makefile", Git will assume
407 it is really the same file, and continue to remember it as
408 "Makefile".
409 +
410 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
411 will probe and set core.ignoreCase true if appropriate when the repository
412 is created.
413 +
414 Git relies on the proper configuration of this variable for your operating
415 and file system. Modifying this value may result in unexpected behavior.
417 core.precomposeUnicode::
418 This option is only used by Mac OS implementation of Git.
419 When core.precomposeUnicode=true, Git reverts the unicode decomposition
420 of filenames done by Mac OS. This is useful when sharing a repository
421 between Mac OS and Linux or Windows.
422 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
423 When false, file names are handled fully transparent by Git,
424 which is backward compatible with older versions of Git.
426 core.protectHFS::
427 If set to true, do not allow checkout of paths that would
428 be considered equivalent to `.git` on an HFS+ filesystem.
429 Defaults to `true` on Mac OS, and `false` elsewhere.
431 core.protectNTFS::
432 If set to true, do not allow checkout of paths that would
433 cause problems with the NTFS filesystem, e.g. conflict with
434 8.3 "short" names.
435 Defaults to `true` on Windows, and `false` elsewhere.
437 core.fsmonitor::
438 If set, the value of this variable is used as a command which
439 will identify all files that may have changed since the
440 requested date/time. This information is used to speed up git by
441 avoiding unnecessary processing of files that have not changed.
442 See the "fsmonitor-watchman" section of linkgit:githooks[5].
444 core.trustctime::
445 If false, the ctime differences between the index and the
446 working tree are ignored; useful when the inode change time
447 is regularly modified by something outside Git (file system
448 crawlers and some backup systems).
449 See linkgit:git-update-index[1]. True by default.
451 core.splitIndex::
452 If true, the split-index feature of the index will be used.
453 See linkgit:git-update-index[1]. False by default.
455 core.untrackedCache::
456 Determines what to do about the untracked cache feature of the
457 index. It will be kept, if this variable is unset or set to
458 `keep`. It will automatically be added if set to `true`. And
459 it will automatically be removed, if set to `false`. Before
460 setting it to `true`, you should check that mtime is working
461 properly on your system.
462 See linkgit:git-update-index[1]. `keep` by default.
464 core.checkStat::
465 Determines which stat fields to match between the index
466 and work tree. The user can set this to 'default' or
467 'minimal'. Default (or explicitly 'default'), is to check
468 all fields, including the sub-second part of mtime and ctime.
470 core.quotePath::
471 Commands that output paths (e.g. 'ls-files', 'diff'), will
472 quote "unusual" characters in the pathname by enclosing the
473 pathname in double-quotes and escaping those characters with
474 backslashes in the same way C escapes control characters (e.g.
475 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
476 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
477 UTF-8). If this variable is set to false, bytes higher than
478 0x80 are not considered "unusual" any more. Double-quotes,
479 backslash and control characters are always escaped regardless
480 of the setting of this variable. A simple space character is
481 not considered "unusual". Many commands can output pathnames
482 completely verbatim using the `-z` option. The default value
483 is true.
485 core.eol::
486 Sets the line ending type to use in the working directory for
487 files that have the `text` property set when core.autocrlf is false.
488 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
489 native line ending. The default value is `native`. See
490 linkgit:gitattributes[5] for more information on end-of-line
491 conversion.
493 core.safecrlf::
494 If true, makes Git check if converting `CRLF` is reversible when
495 end-of-line conversion is active. Git will verify if a command
496 modifies a file in the work tree either directly or indirectly.
497 For example, committing a file followed by checking out the
498 same file should yield the original file in the work tree. If
499 this is not the case for the current setting of
500 `core.autocrlf`, Git will reject the file. The variable can
501 be set to "warn", in which case Git will only warn about an
502 irreversible conversion but continue the operation.
503 +
504 CRLF conversion bears a slight chance of corrupting data.
505 When it is enabled, Git will convert CRLF to LF during commit and LF to
506 CRLF during checkout. A file that contains a mixture of LF and
507 CRLF before the commit cannot be recreated by Git. For text
508 files this is the right thing to do: it corrects line endings
509 such that we have only LF line endings in the repository.
510 But for binary files that are accidentally classified as text the
511 conversion can corrupt data.
512 +
513 If you recognize such corruption early you can easily fix it by
514 setting the conversion type explicitly in .gitattributes. Right
515 after committing you still have the original file in your work
516 tree and this file is not yet corrupted. You can explicitly tell
517 Git that this file is binary and Git will handle the file
518 appropriately.
519 +
520 Unfortunately, the desired effect of cleaning up text files with
521 mixed line endings and the undesired effect of corrupting binary
522 files cannot be distinguished. In both cases CRLFs are removed
523 in an irreversible way. For text files this is the right thing
524 to do because CRLFs are line endings, while for binary files
525 converting CRLFs corrupts data.
526 +
527 Note, this safety check does not mean that a checkout will generate a
528 file identical to the original file for a different setting of
529 `core.eol` and `core.autocrlf`, but only for the current one. For
530 example, a text file with `LF` would be accepted with `core.eol=lf`
531 and could later be checked out with `core.eol=crlf`, in which case the
532 resulting file would contain `CRLF`, although the original file
533 contained `LF`. However, in both work trees the line endings would be
534 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
535 file with mixed line endings would be reported by the `core.safecrlf`
536 mechanism.
538 core.autocrlf::
539 Setting this variable to "true" is the same as setting
540 the `text` attribute to "auto" on all files and core.eol to "crlf".
541 Set to true if you want to have `CRLF` line endings in your
542 working directory and the repository has LF line endings.
543 This variable can be set to 'input',
544 in which case no output conversion is performed.
546 core.checkRoundtripEncoding::
547 A comma and/or whitespace separated list of encodings that Git
548 performs UTF-8 round trip checks on if they are used in an
549 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
550 The default value is `SHIFT-JIS`.
552 core.symlinks::
553 If false, symbolic links are checked out as small plain files that
554 contain the link text. linkgit:git-update-index[1] and
555 linkgit:git-add[1] will not change the recorded type to regular
556 file. Useful on filesystems like FAT that do not support
557 symbolic links.
558 +
559 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
560 will probe and set core.symlinks false if appropriate when the repository
561 is created.
563 core.gitProxy::
564 A "proxy command" to execute (as 'command host port') instead
565 of establishing direct connection to the remote server when
566 using the Git protocol for fetching. If the variable value is
567 in the "COMMAND for DOMAIN" format, the command is applied only
568 on hostnames ending with the specified domain string. This variable
569 may be set multiple times and is matched in the given order;
570 the first match wins.
571 +
572 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
573 (which always applies universally, without the special "for"
574 handling).
575 +
576 The special string `none` can be used as the proxy command to
577 specify that no proxy be used for a given domain pattern.
578 This is useful for excluding servers inside a firewall from
579 proxy use, while defaulting to a common proxy for external domains.
581 core.sshCommand::
582 If this variable is set, `git fetch` and `git push` will
583 use the specified command instead of `ssh` when they need to
584 connect to a remote system. The command is in the same form as
585 the `GIT_SSH_COMMAND` environment variable and is overridden
586 when the environment variable is set.
588 core.ignoreStat::
589 If true, Git will avoid using lstat() calls to detect if files have
590 changed by setting the "assume-unchanged" bit for those tracked files
591 which it has updated identically in both the index and working tree.
592 +
593 When files are modified outside of Git, the user will need to stage
594 the modified files explicitly (e.g. see 'Examples' section in
595 linkgit:git-update-index[1]).
596 Git will not normally detect changes to those files.
597 +
598 This is useful on systems where lstat() calls are very slow, such as
599 CIFS/Microsoft Windows.
600 +
601 False by default.
603 core.preferSymlinkRefs::
604 Instead of the default "symref" format for HEAD
605 and other symbolic reference files, use symbolic links.
606 This is sometimes needed to work with old scripts that
607 expect HEAD to be a symbolic link.
609 core.bare::
610 If true this repository is assumed to be 'bare' and has no
611 working directory associated with it. If this is the case a
612 number of commands that require a working directory will be
613 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
614 +
615 This setting is automatically guessed by linkgit:git-clone[1] or
616 linkgit:git-init[1] when the repository was created. By default a
617 repository that ends in "/.git" is assumed to be not bare (bare =
618 false), while all other repositories are assumed to be bare (bare
619 = true).
621 core.worktree::
622 Set the path to the root of the working tree.
623 If `GIT_COMMON_DIR` environment variable is set, core.worktree
624 is ignored and not used for determining the root of working tree.
625 This can be overridden by the `GIT_WORK_TREE` environment
626 variable and the `--work-tree` command-line option.
627 The value can be an absolute path or relative to the path to
628 the .git directory, which is either specified by --git-dir
629 or GIT_DIR, or automatically discovered.
630 If --git-dir or GIT_DIR is specified but none of
631 --work-tree, GIT_WORK_TREE and core.worktree is specified,
632 the current working directory is regarded as the top level
633 of your working tree.
634 +
635 Note that this variable is honored even when set in a configuration
636 file in a ".git" subdirectory of a directory and its value differs
637 from the latter directory (e.g. "/path/to/.git/config" has
638 core.worktree set to "/different/path"), which is most likely a
639 misconfiguration. Running Git commands in the "/path/to" directory will
640 still use "/different/path" as the root of the work tree and can cause
641 confusion unless you know what you are doing (e.g. you are creating a
642 read-only snapshot of the same index to a location different from the
643 repository's usual working tree).
645 core.logAllRefUpdates::
646 Enable the reflog. Updates to a ref <ref> is logged to the file
647 "`$GIT_DIR/logs/<ref>`", by appending the new and old
648 SHA-1, the date/time and the reason of the update, but
649 only when the file exists. If this configuration
650 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
651 file is automatically created for branch heads (i.e. under
652 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
653 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
654 If it is set to `always`, then a missing reflog is automatically
655 created for any ref under `refs/`.
656 +
657 This information can be used to determine what commit
658 was the tip of a branch "2 days ago".
659 +
660 This value is true by default in a repository that has
661 a working directory associated with it, and false by
662 default in a bare repository.
664 core.repositoryFormatVersion::
665 Internal variable identifying the repository format and layout
666 version.
668 core.sharedRepository::
669 When 'group' (or 'true'), the repository is made shareable between
670 several users in a group (making sure all the files and objects are
671 group-writable). When 'all' (or 'world' or 'everybody'), the
672 repository will be readable by all users, additionally to being
673 group-shareable. When 'umask' (or 'false'), Git will use permissions
674 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
675 files in the repository will have this mode value. '0xxx' will override
676 user's umask value (whereas the other options will only override
677 requested parts of the user's umask value). Examples: '0660' will make
678 the repo read/write-able for the owner and group, but inaccessible to
679 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
680 repository that is group-readable but not group-writable.
681 See linkgit:git-init[1]. False by default.
683 core.warnAmbiguousRefs::
684 If true, Git will warn you if the ref name you passed it is ambiguous
685 and might match multiple refs in the repository. True by default.
687 core.compression::
688 An integer -1..9, indicating a default compression level.
689 -1 is the zlib default. 0 means no compression,
690 and 1..9 are various speed/size tradeoffs, 9 being slowest.
691 If set, this provides a default to other compression variables,
692 such as `core.looseCompression` and `pack.compression`.
694 core.looseCompression::
695 An integer -1..9, indicating the compression level for objects that
696 are not in a pack file. -1 is the zlib default. 0 means no
697 compression, and 1..9 are various speed/size tradeoffs, 9 being
698 slowest. If not set, defaults to core.compression. If that is
699 not set, defaults to 1 (best speed).
701 core.packedGitWindowSize::
702 Number of bytes of a pack file to map into memory in a
703 single mapping operation. Larger window sizes may allow
704 your system to process a smaller number of large pack files
705 more quickly. Smaller window sizes will negatively affect
706 performance due to increased calls to the operating system's
707 memory manager, but may improve performance when accessing
708 a large number of large pack files.
709 +
710 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
711 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
712 be reasonable for all users/operating systems. You probably do
713 not need to adjust this value.
714 +
715 Common unit suffixes of 'k', 'm', or 'g' are supported.
717 core.packedGitLimit::
718 Maximum number of bytes to map simultaneously into memory
719 from pack files. If Git needs to access more than this many
720 bytes at once to complete an operation it will unmap existing
721 regions to reclaim virtual address space within the process.
722 +
723 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
724 unlimited) on 64 bit platforms.
725 This should be reasonable for all users/operating systems, except on
726 the largest projects. You probably do not need to adjust this value.
727 +
728 Common unit suffixes of 'k', 'm', or 'g' are supported.
730 core.deltaBaseCacheLimit::
731 Maximum number of bytes to reserve for caching base objects
732 that may be referenced by multiple deltified objects. By storing the
733 entire decompressed base objects in a cache Git is able
734 to avoid unpacking and decompressing frequently used base
735 objects multiple times.
736 +
737 Default is 96 MiB on all platforms. This should be reasonable
738 for all users/operating systems, except on the largest projects.
739 You probably do not need to adjust this value.
740 +
741 Common unit suffixes of 'k', 'm', or 'g' are supported.
743 core.bigFileThreshold::
744 Files larger than this size are stored deflated, without
745 attempting delta compression. Storing large files without
746 delta compression avoids excessive memory usage, at the
747 slight expense of increased disk usage. Additionally files
748 larger than this size are always treated as binary.
749 +
750 Default is 512 MiB on all platforms. This should be reasonable
751 for most projects as source code and other text files can still
752 be delta compressed, but larger binary media files won't be.
753 +
754 Common unit suffixes of 'k', 'm', or 'g' are supported.
756 core.excludesFile::
757 Specifies the pathname to the file that contains patterns to
758 describe paths that are not meant to be tracked, in addition
759 to '.gitignore' (per-directory) and '.git/info/exclude'.
760 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
761 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
762 is used instead. See linkgit:gitignore[5].
764 core.askPass::
765 Some commands (e.g. svn and http interfaces) that interactively
766 ask for a password can be told to use an external program given
767 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
768 environment variable. If not set, fall back to the value of the
769 `SSH_ASKPASS` environment variable or, failing that, a simple password
770 prompt. The external program shall be given a suitable prompt as
771 command-line argument and write the password on its STDOUT.
773 core.attributesFile::
774 In addition to '.gitattributes' (per-directory) and
775 '.git/info/attributes', Git looks into this file for attributes
776 (see linkgit:gitattributes[5]). Path expansions are made the same
777 way as for `core.excludesFile`. Its default value is
778 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
779 set or empty, `$HOME/.config/git/attributes` is used instead.
781 core.hooksPath::
782 By default Git will look for your hooks in the
783 '$GIT_DIR/hooks' directory. Set this to different path,
784 e.g. '/etc/git/hooks', and Git will try to find your hooks in
785 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
786 in '$GIT_DIR/hooks/pre-receive'.
787 +
788 The path can be either absolute or relative. A relative path is
789 taken as relative to the directory where the hooks are run (see
790 the "DESCRIPTION" section of linkgit:githooks[5]).
791 +
792 This configuration variable is useful in cases where you'd like to
793 centrally configure your Git hooks instead of configuring them on a
794 per-repository basis, or as a more flexible and centralized
795 alternative to having an `init.templateDir` where you've changed
796 default hooks.
798 core.editor::
799 Commands such as `commit` and `tag` that let you edit
800 messages by launching an editor use the value of this
801 variable when it is set, and the environment variable
802 `GIT_EDITOR` is not set. See linkgit:git-var[1].
804 core.commentChar::
805 Commands such as `commit` and `tag` that let you edit
806 messages consider a line that begins with this character
807 commented, and removes them after the editor returns
808 (default '#').
809 +
810 If set to "auto", `git-commit` would select a character that is not
811 the beginning character of any line in existing commit messages.
813 core.filesRefLockTimeout::
814 The length of time, in milliseconds, to retry when trying to
815 lock an individual reference. Value 0 means not to retry at
816 all; -1 means to try indefinitely. Default is 100 (i.e.,
817 retry for 100ms).
819 core.packedRefsTimeout::
820 The length of time, in milliseconds, to retry when trying to
821 lock the `packed-refs` file. Value 0 means not to retry at
822 all; -1 means to try indefinitely. Default is 1000 (i.e.,
823 retry for 1 second).
825 sequence.editor::
826 Text editor used by `git rebase -i` for editing the rebase instruction file.
827 The value is meant to be interpreted by the shell when it is used.
828 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
829 When not configured the default commit message editor is used instead.
831 core.pager::
832 Text viewer for use by Git commands (e.g., 'less'). The value
833 is meant to be interpreted by the shell. The order of preference
834 is the `$GIT_PAGER` environment variable, then `core.pager`
835 configuration, then `$PAGER`, and then the default chosen at
836 compile time (usually 'less').
837 +
838 When the `LESS` environment variable is unset, Git sets it to `FRX`
839 (if `LESS` environment variable is set, Git does not change it at
840 all). If you want to selectively override Git's default setting
841 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
842 be passed to the shell by Git, which will translate the final
843 command to `LESS=FRX less -S`. The environment does not set the
844 `S` option but the command line does, instructing less to truncate
845 long lines. Similarly, setting `core.pager` to `less -+F` will
846 deactivate the `F` option specified by the environment from the
847 command-line, deactivating the "quit if one screen" behavior of
848 `less`. One can specifically activate some flags for particular
849 commands: for example, setting `pager.blame` to `less -S` enables
850 line truncation only for `git blame`.
851 +
852 Likewise, when the `LV` environment variable is unset, Git sets it
853 to `-c`. You can override this setting by exporting `LV` with
854 another value or setting `core.pager` to `lv +c`.
856 core.whitespace::
857 A comma separated list of common whitespace problems to
858 notice. 'git diff' will use `color.diff.whitespace` to
859 highlight them, and 'git apply --whitespace=error' will
860 consider them as errors. You can prefix `-` to disable
861 any of them (e.g. `-trailing-space`):
862 +
863 * `blank-at-eol` treats trailing whitespaces at the end of the line
864 as an error (enabled by default).
865 * `space-before-tab` treats a space character that appears immediately
866 before a tab character in the initial indent part of the line as an
867 error (enabled by default).
868 * `indent-with-non-tab` treats a line that is indented with space
869 characters instead of the equivalent tabs as an error (not enabled by
870 default).
871 * `tab-in-indent` treats a tab character in the initial indent part of
872 the line as an error (not enabled by default).
873 * `blank-at-eof` treats blank lines added at the end of file as an error
874 (enabled by default).
875 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
876 `blank-at-eof`.
877 * `cr-at-eol` treats a carriage-return at the end of line as
878 part of the line terminator, i.e. with it, `trailing-space`
879 does not trigger if the character before such a carriage-return
880 is not a whitespace (not enabled by default).
881 * `tabwidth=<n>` tells how many character positions a tab occupies; this
882 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
883 errors. The default tab width is 8. Allowed values are 1 to 63.
885 core.fsyncObjectFiles::
886 This boolean will enable 'fsync()' when writing object files.
887 +
888 This is a total waste of time and effort on a filesystem that orders
889 data writes properly, but can be useful for filesystems that do not use
890 journalling (traditional UNIX filesystems) or that only journal metadata
891 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
893 core.preloadIndex::
894 Enable parallel index preload for operations like 'git diff'
895 +
896 This can speed up operations like 'git diff' and 'git status' especially
897 on filesystems like NFS that have weak caching semantics and thus
898 relatively high IO latencies. When enabled, Git will do the
899 index comparison to the filesystem data in parallel, allowing
900 overlapping IO's. Defaults to true.
902 core.createObject::
903 You can set this to 'link', in which case a hardlink followed by
904 a delete of the source are used to make sure that object creation
905 will not overwrite existing objects.
906 +
907 On some file system/operating system combinations, this is unreliable.
908 Set this config setting to 'rename' there; However, This will remove the
909 check that makes sure that existing object files will not get overwritten.
911 core.notesRef::
912 When showing commit messages, also show notes which are stored in
913 the given ref. The ref must be fully qualified. If the given
914 ref does not exist, it is not an error but means that no
915 notes should be printed.
916 +
917 This setting defaults to "refs/notes/commits", and it can be overridden by
918 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
920 gc.commitGraph::
921 If true, then gc will rewrite the commit-graph file when
922 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
923 '--auto' the commit-graph will be updated if housekeeping is
924 required. Default is false. See linkgit:git-commit-graph[1]
925 for details.
927 core.sparseCheckout::
928 Enable "sparse checkout" feature. See section "Sparse checkout" in
929 linkgit:git-read-tree[1] for more information.
931 core.abbrev::
932 Set the length object names are abbreviated to. If
933 unspecified or set to "auto", an appropriate value is
934 computed based on the approximate number of packed objects
935 in your repository, which hopefully is enough for
936 abbreviated object names to stay unique for some time.
937 The minimum length is 4.
939 add.ignoreErrors::
940 add.ignore-errors (deprecated)::
941 Tells 'git add' to continue adding files when some files cannot be
942 added due to indexing errors. Equivalent to the `--ignore-errors`
943 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
944 as it does not follow the usual naming convention for configuration
945 variables.
947 alias.*::
948 Command aliases for the linkgit:git[1] command wrapper - e.g.
949 after defining "alias.last = cat-file commit HEAD", the invocation
950 "git last" is equivalent to "git cat-file commit HEAD". To avoid
951 confusion and troubles with script usage, aliases that
952 hide existing Git commands are ignored. Arguments are split by
953 spaces, the usual shell quoting and escaping is supported.
954 A quote pair or a backslash can be used to quote them.
955 +
956 If the alias expansion is prefixed with an exclamation point,
957 it will be treated as a shell command. For example, defining
958 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
959 "git new" is equivalent to running the shell command
960 "gitk --all --not ORIG_HEAD". Note that shell commands will be
961 executed from the top-level directory of a repository, which may
962 not necessarily be the current directory.
963 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
964 from the original current directory. See linkgit:git-rev-parse[1].
966 am.keepcr::
967 If true, git-am will call git-mailsplit for patches in mbox format
968 with parameter `--keep-cr`. In this case git-mailsplit will
969 not remove `\r` from lines ending with `\r\n`. Can be overridden
970 by giving `--no-keep-cr` from the command line.
971 See linkgit:git-am[1], linkgit:git-mailsplit[1].
973 am.threeWay::
974 By default, `git am` will fail if the patch does not apply cleanly. When
975 set to true, this setting tells `git am` to fall back on 3-way merge if
976 the patch records the identity of blobs it is supposed to apply to and
977 we have those blobs available locally (equivalent to giving the `--3way`
978 option from the command line). Defaults to `false`.
979 See linkgit:git-am[1].
981 apply.ignoreWhitespace::
982 When set to 'change', tells 'git apply' to ignore changes in
983 whitespace, in the same way as the `--ignore-space-change`
984 option.
985 When set to one of: no, none, never, false tells 'git apply' to
986 respect all whitespace differences.
987 See linkgit:git-apply[1].
989 apply.whitespace::
990 Tells 'git apply' how to handle whitespaces, in the same way
991 as the `--whitespace` option. See linkgit:git-apply[1].
993 blame.showRoot::
994 Do not treat root commits as boundaries in linkgit:git-blame[1].
995 This option defaults to false.
997 blame.blankBoundary::
998 Show blank commit object name for boundary commits in
999 linkgit:git-blame[1]. This option defaults to false.
1001 blame.showEmail::
1002 Show the author email instead of author name in linkgit:git-blame[1].
1003 This option defaults to false.
1005 blame.date::
1006 Specifies the format used to output dates in linkgit:git-blame[1].
1007 If unset the iso format is used. For supported values,
1008 see the discussion of the `--date` option at linkgit:git-log[1].
1010 branch.autoSetupMerge::
1011 Tells 'git branch' and 'git checkout' to set up new branches
1012 so that linkgit:git-pull[1] will appropriately merge from the
1013 starting point branch. Note that even if this option is not set,
1014 this behavior can be chosen per-branch using the `--track`
1015 and `--no-track` options. The valid settings are: `false` -- no
1016 automatic setup is done; `true` -- automatic setup is done when the
1017 starting point is a remote-tracking branch; `always` --
1018 automatic setup is done when the starting point is either a
1019 local branch or remote-tracking
1020 branch. This option defaults to true.
1022 branch.autoSetupRebase::
1023 When a new branch is created with 'git branch' or 'git checkout'
1024 that tracks another branch, this variable tells Git to set
1025 up pull to rebase instead of merge (see "branch.<name>.rebase").
1026 When `never`, rebase is never automatically set to true.
1027 When `local`, rebase is set to true for tracked branches of
1028 other local branches.
1029 When `remote`, rebase is set to true for tracked branches of
1030 remote-tracking branches.
1031 When `always`, rebase will be set to true for all tracking
1032 branches.
1033 See "branch.autoSetupMerge" for details on how to set up a
1034 branch to track another branch.
1035 This option defaults to never.
1037 branch.<name>.remote::
1038 When on branch <name>, it tells 'git fetch' and 'git push'
1039 which remote to fetch from/push to. The remote to push to
1040 may be overridden with `remote.pushDefault` (for all branches).
1041 The remote to push to, for the current branch, may be further
1042 overridden by `branch.<name>.pushRemote`. If no remote is
1043 configured, or if you are not on any branch, it defaults to
1044 `origin` for fetching and `remote.pushDefault` for pushing.
1045 Additionally, `.` (a period) is the current local repository
1046 (a dot-repository), see `branch.<name>.merge`'s final note below.
1048 branch.<name>.pushRemote::
1049 When on branch <name>, it overrides `branch.<name>.remote` for
1050 pushing. It also overrides `remote.pushDefault` for pushing
1051 from branch <name>. When you pull from one place (e.g. your
1052 upstream) and push to another place (e.g. your own publishing
1053 repository), you would want to set `remote.pushDefault` to
1054 specify the remote to push to for all branches, and use this
1055 option to override it for a specific branch.
1057 branch.<name>.merge::
1058 Defines, together with branch.<name>.remote, the upstream branch
1059 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1060 branch to merge and can also affect 'git push' (see push.default).
1061 When in branch <name>, it tells 'git fetch' the default
1062 refspec to be marked for merging in FETCH_HEAD. The value is
1063 handled like the remote part of a refspec, and must match a
1064 ref which is fetched from the remote given by
1065 "branch.<name>.remote".
1066 The merge information is used by 'git pull' (which at first calls
1067 'git fetch') to lookup the default branch for merging. Without
1068 this option, 'git pull' defaults to merge the first refspec fetched.
1069 Specify multiple values to get an octopus merge.
1070 If you wish to setup 'git pull' so that it merges into <name> from
1071 another branch in the local repository, you can point
1072 branch.<name>.merge to the desired branch, and use the relative path
1073 setting `.` (a period) for branch.<name>.remote.
1075 branch.<name>.mergeOptions::
1076 Sets default options for merging into branch <name>. The syntax and
1077 supported options are the same as those of linkgit:git-merge[1], but
1078 option values containing whitespace characters are currently not
1079 supported.
1081 branch.<name>.rebase::
1082 When true, rebase the branch <name> on top of the fetched branch,
1083 instead of merging the default branch from the default remote when
1084 "git pull" is run. See "pull.rebase" for doing this in a non
1085 branch-specific manner.
1086 +
1087 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1088 so that the local merge commits are included in the rebase (see
1089 linkgit:git-rebase[1] for details).
1090 +
1091 When preserve, also pass `--preserve-merges` along to 'git rebase'
1092 so that locally committed merge commits will not be flattened
1093 by running 'git pull'.
1094 +
1095 When the value is `interactive`, the rebase is run in interactive mode.
1096 +
1097 *NOTE*: this is a possibly dangerous operation; do *not* use
1098 it unless you understand the implications (see linkgit:git-rebase[1]
1099 for details).
1101 branch.<name>.description::
1102 Branch description, can be edited with
1103 `git branch --edit-description`. Branch description is
1104 automatically added in the format-patch cover letter or
1105 request-pull summary.
1107 browser.<tool>.cmd::
1108 Specify the command to invoke the specified browser. The
1109 specified command is evaluated in shell with the URLs passed
1110 as arguments. (See linkgit:git-web{litdd}browse[1].)
1112 browser.<tool>.path::
1113 Override the path for the given tool that may be used to
1114 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1115 working repository in gitweb (see linkgit:git-instaweb[1]).
1117 checkout.defaultRemote::
1118 When you run 'git checkout <something>' and only have one
1119 remote, it may implicitly fall back on checking out and
1120 tracking e.g. 'origin/<something>'. This stops working as soon
1121 as you have more than one remote with a '<something>'
1122 reference. This setting allows for setting the name of a
1123 preferred remote that should always win when it comes to
1124 disambiguation. The typical use-case is to set this to
1125 `origin`.
1126 +
1127 Currently this is used by linkgit:git-checkout[1] when 'git checkout
1128 <something>' will checkout the '<something>' branch on another remote,
1129 and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1130 remote branch. This setting might be used for other checkout-like
1131 commands or functionality in the future.
1133 clean.requireForce::
1134 A boolean to make git-clean do nothing unless given -f,
1135 -i or -n. Defaults to true.
1137 color.advice::
1138 A boolean to enable/disable color in hints (e.g. when a push
1139 failed, see `advice.*` for a list). May be set to `always`,
1140 `false` (or `never`) or `auto` (or `true`), in which case colors
1141 are used only when the error output goes to a terminal. If
1142 unset, then the value of `color.ui` is used (`auto` by default).
1144 color.advice.hint::
1145 Use customized color for hints.
1147 color.branch::
1148 A boolean to enable/disable color in the output of
1149 linkgit:git-branch[1]. May be set to `always`,
1150 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1151 only when the output is to a terminal. If unset, then the
1152 value of `color.ui` is used (`auto` by default).
1154 color.branch.<slot>::
1155 Use customized color for branch coloration. `<slot>` is one of
1156 `current` (the current branch), `local` (a local branch),
1157 `remote` (a remote-tracking branch in refs/remotes/),
1158 `upstream` (upstream tracking branch), `plain` (other
1159 refs).
1161 color.diff::
1162 Whether to use ANSI escape sequences to add color to patches.
1163 If this is set to `always`, linkgit:git-diff[1],
1164 linkgit:git-log[1], and linkgit:git-show[1] will use color
1165 for all patches. If it is set to `true` or `auto`, those
1166 commands will only use color when output is to the terminal.
1167 If unset, then the value of `color.ui` is used (`auto` by
1168 default).
1169 +
1170 This does not affect linkgit:git-format-patch[1] or the
1171 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1172 command line with the `--color[=<when>]` option.
1174 diff.colorMoved::
1175 If set to either a valid `<mode>` or a true value, moved lines
1176 in a diff are colored differently, for details of valid modes
1177 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1178 true the default color mode will be used. When set to false,
1179 moved lines are not colored.
1181 diff.colorMovedWS::
1182 When moved lines are colored using e.g. the `diff.colorMoved` setting,
1183 this option controls the `<mode>` how spaces are treated
1184 for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].
1186 color.diff.<slot>::
1187 Use customized color for diff colorization. `<slot>` specifies
1188 which part of the patch to use the specified color, and is one
1189 of `context` (context text - `plain` is a historical synonym),
1190 `meta` (metainformation), `frag`
1191 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1192 `new` (added lines), `commit` (commit headers), `whitespace`
1193 (highlighting whitespace errors), `oldMoved` (deleted lines),
1194 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1195 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1196 `newMovedAlternativeDimmed` (See the '<mode>'
1197 setting of '--color-moved' in linkgit:git-diff[1] for details),
1198 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1199 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1201 color.decorate.<slot>::
1202 Use customized color for 'git log --decorate' output. `<slot>` is one
1203 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1204 branches, remote-tracking branches, tags, stash and HEAD, respectively
1205 and `grafted` for grafted commits.
1207 color.grep::
1208 When set to `always`, always highlight matches. When `false` (or
1209 `never`), never. When set to `true` or `auto`, use color only
1210 when the output is written to the terminal. If unset, then the
1211 value of `color.ui` is used (`auto` by default).
1213 color.grep.<slot>::
1214 Use customized color for grep colorization. `<slot>` specifies which
1215 part of the line to use the specified color, and is one of
1216 +
1217 --
1218 `context`;;
1219 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1220 `filename`;;
1221 filename prefix (when not using `-h`)
1222 `function`;;
1223 function name lines (when using `-p`)
1224 `lineNumber`;;
1225 line number prefix (when using `-n`)
1226 `column`;;
1227 column number prefix (when using `--column`)
1228 `match`;;
1229 matching text (same as setting `matchContext` and `matchSelected`)
1230 `matchContext`;;
1231 matching text in context lines
1232 `matchSelected`;;
1233 matching text in selected lines
1234 `selected`;;
1235 non-matching text in selected lines
1236 `separator`;;
1237 separators between fields on a line (`:`, `-`, and `=`)
1238 and between hunks (`--`)
1239 --
1241 color.interactive::
1242 When set to `always`, always use colors for interactive prompts
1243 and displays (such as those used by "git-add --interactive" and
1244 "git-clean --interactive"). When false (or `never`), never.
1245 When set to `true` or `auto`, use colors only when the output is
1246 to the terminal. If unset, then the value of `color.ui` is
1247 used (`auto` by default).
1249 color.interactive.<slot>::
1250 Use customized color for 'git add --interactive' and 'git clean
1251 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1252 or `error`, for four distinct types of normal output from
1253 interactive commands.
1255 color.pager::
1256 A boolean to enable/disable colored output when the pager is in
1257 use (default is true).
1259 color.push::
1260 A boolean to enable/disable color in push errors. May be set to
1261 `always`, `false` (or `never`) or `auto` (or `true`), in which
1262 case colors are used only when the error output goes to a terminal.
1263 If unset, then the value of `color.ui` is used (`auto` by default).
1265 color.push.error::
1266 Use customized color for push errors.
1268 color.showBranch::
1269 A boolean to enable/disable color in the output of
1270 linkgit:git-show-branch[1]. May be set to `always`,
1271 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1272 only when the output is to a terminal. If unset, then the
1273 value of `color.ui` is used (`auto` by default).
1275 color.status::
1276 A boolean to enable/disable color in the output of
1277 linkgit:git-status[1]. May be set to `always`,
1278 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1279 only when the output is to a terminal. If unset, then the
1280 value of `color.ui` is used (`auto` by default).
1282 color.status.<slot>::
1283 Use customized color for status colorization. `<slot>` is
1284 one of `header` (the header text of the status message),
1285 `added` or `updated` (files which are added but not committed),
1286 `changed` (files which are changed but not added in the index),
1287 `untracked` (files which are not tracked by Git),
1288 `branch` (the current branch),
1289 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1290 to red),
1291 `localBranch` or `remoteBranch` (the local and remote branch names,
1292 respectively, when branch and tracking information is displayed in the
1293 status short-format), or
1294 `unmerged` (files which have unmerged changes).
1296 color.blame.repeatedLines::
1297 Use the customized color for the part of git-blame output that
1298 is repeated meta information per line (such as commit id,
1299 author name, date and timezone). Defaults to cyan.
1301 color.blame.highlightRecent::
1302 This can be used to color the metadata of a blame line depending
1303 on age of the line.
1304 +
1305 This setting should be set to a comma-separated list of color and date settings,
1306 starting and ending with a color, the dates should be set from oldest to newest.
1307 The metadata will be colored given the colors if the the line was introduced
1308 before the given timestamp, overwriting older timestamped colors.
1309 +
1310 Instead of an absolute timestamp relative timestamps work as well, e.g.
1311 2.weeks.ago is valid to address anything older than 2 weeks.
1312 +
1313 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1314 everything older than one year blue, recent changes between one month and
1315 one year old are kept white, and lines introduced within the last month are
1316 colored red.
1318 blame.coloring::
1319 This determines the coloring scheme to be applied to blame
1320 output. It can be 'repeatedLines', 'highlightRecent',
1321 or 'none' which is the default.
1323 color.transport::
1324 A boolean to enable/disable color when pushes are rejected. May be
1325 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1326 case colors are used only when the error output goes to a terminal.
1327 If unset, then the value of `color.ui` is used (`auto` by default).
1329 color.transport.rejected::
1330 Use customized color when a push was rejected.
1332 color.ui::
1333 This variable determines the default value for variables such
1334 as `color.diff` and `color.grep` that control the use of color
1335 per command family. Its scope will expand as more commands learn
1336 configuration to set a default for the `--color` option. Set it
1337 to `false` or `never` if you prefer Git commands not to use
1338 color unless enabled explicitly with some other configuration
1339 or the `--color` option. Set it to `always` if you want all
1340 output not intended for machine consumption to use color, to
1341 `true` or `auto` (this is the default since Git 1.8.4) if you
1342 want such output to use color when written to the terminal.
1344 column.ui::
1345 Specify whether supported commands should output in columns.
1346 This variable consists of a list of tokens separated by spaces
1347 or commas:
1348 +
1349 These options control when the feature should be enabled
1350 (defaults to 'never'):
1351 +
1352 --
1353 `always`;;
1354 always show in columns
1355 `never`;;
1356 never show in columns
1357 `auto`;;
1358 show in columns if the output is to the terminal
1359 --
1360 +
1361 These options control layout (defaults to 'column'). Setting any
1362 of these implies 'always' if none of 'always', 'never', or 'auto' are
1363 specified.
1364 +
1365 --
1366 `column`;;
1367 fill columns before rows
1368 `row`;;
1369 fill rows before columns
1370 `plain`;;
1371 show in one column
1372 --
1373 +
1374 Finally, these options can be combined with a layout option (defaults
1375 to 'nodense'):
1376 +
1377 --
1378 `dense`;;
1379 make unequal size columns to utilize more space
1380 `nodense`;;
1381 make equal size columns
1382 --
1384 column.branch::
1385 Specify whether to output branch listing in `git branch` in columns.
1386 See `column.ui` for details.
1388 column.clean::
1389 Specify the layout when list items in `git clean -i`, which always
1390 shows files and directories in columns. See `column.ui` for details.
1392 column.status::
1393 Specify whether to output untracked files in `git status` in columns.
1394 See `column.ui` for details.
1396 column.tag::
1397 Specify whether to output tag listing in `git tag` in columns.
1398 See `column.ui` for details.
1400 commit.cleanup::
1401 This setting overrides the default of the `--cleanup` option in
1402 `git commit`. See linkgit:git-commit[1] for details. Changing the
1403 default can be useful when you always want to keep lines that begin
1404 with comment character `#` in your log message, in which case you
1405 would do `git config commit.cleanup whitespace` (note that you will
1406 have to remove the help lines that begin with `#` in the commit log
1407 template yourself, if you do this).
1409 commit.gpgSign::
1411 A boolean to specify whether all commits should be GPG signed.
1412 Use of this option when doing operations such as rebase can
1413 result in a large number of commits being signed. It may be
1414 convenient to use an agent to avoid typing your GPG passphrase
1415 several times.
1417 commit.status::
1418 A boolean to enable/disable inclusion of status information in the
1419 commit message template when using an editor to prepare the commit
1420 message. Defaults to true.
1422 commit.template::
1423 Specify the pathname of a file to use as the template for
1424 new commit messages.
1426 commit.verbose::
1427 A boolean or int to specify the level of verbose with `git commit`.
1428 See linkgit:git-commit[1].
1430 credential.helper::
1431 Specify an external helper to be called when a username or
1432 password credential is needed; the helper may consult external
1433 storage to avoid prompting the user for the credentials. Note
1434 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1435 for details.
1437 credential.useHttpPath::
1438 When acquiring credentials, consider the "path" component of an http
1439 or https URL to be important. Defaults to false. See
1440 linkgit:gitcredentials[7] for more information.
1442 credential.username::
1443 If no username is set for a network authentication, use this username
1444 by default. See credential.<context>.* below, and
1445 linkgit:gitcredentials[7].
1447 credential.<url>.*::
1448 Any of the credential.* options above can be applied selectively to
1449 some credentials. For example "credential.https://example.com.username"
1450 would set the default username only for https connections to
1451 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1452 matched.
1454 credentialCache.ignoreSIGHUP::
1455 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1457 completion.commands::
1458 This is only used by git-completion.bash to add or remove
1459 commands from the list of completed commands. Normally only
1460 porcelain commands and a few select others are completed. You
1461 can add more commands, separated by space, in this
1462 variable. Prefixing the command with '-' will remove it from
1463 the existing list.
1465 include::diff-config.txt[]
1467 difftool.<tool>.path::
1468 Override the path for the given tool. This is useful in case
1469 your tool is not in the PATH.
1471 difftool.<tool>.cmd::
1472 Specify the command to invoke the specified diff tool.
1473 The specified command is evaluated in shell with the following
1474 variables available: 'LOCAL' is set to the name of the temporary
1475 file containing the contents of the diff pre-image and 'REMOTE'
1476 is set to the name of the temporary file containing the contents
1477 of the diff post-image.
1479 difftool.prompt::
1480 Prompt before each invocation of the diff tool.
1482 fastimport.unpackLimit::
1483 If the number of objects imported by linkgit:git-fast-import[1]
1484 is below this limit, then the objects will be unpacked into
1485 loose object files. However if the number of imported objects
1486 equals or exceeds this limit then the pack will be stored as a
1487 pack. Storing the pack from a fast-import can make the import
1488 operation complete faster, especially on slow filesystems. If
1489 not set, the value of `transfer.unpackLimit` is used instead.
1491 fetch.recurseSubmodules::
1492 This option can be either set to a boolean value or to 'on-demand'.
1493 Setting it to a boolean changes the behavior of fetch and pull to
1494 unconditionally recurse into submodules when set to true or to not
1495 recurse at all when set to false. When set to 'on-demand' (the default
1496 value), fetch and pull will only recurse into a populated submodule
1497 when its superproject retrieves a commit that updates the submodule's
1498 reference.
1500 fetch.fsckObjects::
1501 If it is set to true, git-fetch-pack will check all fetched
1502 objects. It will abort in the case of a malformed object or a
1503 broken link. The result of an abort are only dangling objects.
1504 Defaults to false. If not set, the value of `transfer.fsckObjects`
1505 is used instead.
1507 fetch.unpackLimit::
1508 If the number of objects fetched over the Git native
1509 transfer is below this
1510 limit, then the objects will be unpacked into loose object
1511 files. However if the number of received objects equals or
1512 exceeds this limit then the received pack will be stored as
1513 a pack, after adding any missing delta bases. Storing the
1514 pack from a push can make the push operation complete faster,
1515 especially on slow filesystems. If not set, the value of
1516 `transfer.unpackLimit` is used instead.
1518 fetch.prune::
1519 If true, fetch will automatically behave as if the `--prune`
1520 option was given on the command line. See also `remote.<name>.prune`
1521 and the PRUNING section of linkgit:git-fetch[1].
1523 fetch.pruneTags::
1524 If true, fetch will automatically behave as if the
1525 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1526 if not set already. This allows for setting both this option
1527 and `fetch.prune` to maintain a 1=1 mapping to upstream
1528 refs. See also `remote.<name>.pruneTags` and the PRUNING
1529 section of linkgit:git-fetch[1].
1531 fetch.output::
1532 Control how ref update status is printed. Valid values are
1533 `full` and `compact`. Default value is `full`. See section
1534 OUTPUT in linkgit:git-fetch[1] for detail.
1536 fetch.negotiationAlgorithm::
1537 Control how information about the commits in the local repository is
1538 sent when negotiating the contents of the packfile to be sent by the
1539 server. Set to "skipping" to use an algorithm that skips commits in an
1540 effort to converge faster, but may result in a larger-than-necessary
1541 packfile; any other value instructs Git to use the default algorithm
1542 that never skips commits (unless the server has acknowledged it or one
1543 of its descendants).
1545 format.attach::
1546 Enable multipart/mixed attachments as the default for
1547 'format-patch'. The value can also be a double quoted string
1548 which will enable attachments as the default and set the
1549 value as the boundary. See the --attach option in
1550 linkgit:git-format-patch[1].
1552 format.from::
1553 Provides the default value for the `--from` option to format-patch.
1554 Accepts a boolean value, or a name and email address. If false,
1555 format-patch defaults to `--no-from`, using commit authors directly in
1556 the "From:" field of patch mails. If true, format-patch defaults to
1557 `--from`, using your committer identity in the "From:" field of patch
1558 mails and including a "From:" field in the body of the patch mail if
1559 different. If set to a non-boolean value, format-patch uses that
1560 value instead of your committer identity. Defaults to false.
1562 format.numbered::
1563 A boolean which can enable or disable sequence numbers in patch
1564 subjects. It defaults to "auto" which enables it only if there
1565 is more than one patch. It can be enabled or disabled for all
1566 messages by setting it to "true" or "false". See --numbered
1567 option in linkgit:git-format-patch[1].
1569 format.headers::
1570 Additional email headers to include in a patch to be submitted
1571 by mail. See linkgit:git-format-patch[1].
1573 format.to::
1574 format.cc::
1575 Additional recipients to include in a patch to be submitted
1576 by mail. See the --to and --cc options in
1577 linkgit:git-format-patch[1].
1579 format.subjectPrefix::
1580 The default for format-patch is to output files with the '[PATCH]'
1581 subject prefix. Use this variable to change that prefix.
1583 format.signature::
1584 The default for format-patch is to output a signature containing
1585 the Git version number. Use this variable to change that default.
1586 Set this variable to the empty string ("") to suppress
1587 signature generation.
1589 format.signatureFile::
1590 Works just like format.signature except the contents of the
1591 file specified by this variable will be used as the signature.
1593 format.suffix::
1594 The default for format-patch is to output files with the suffix
1595 `.patch`. Use this variable to change that suffix (make sure to
1596 include the dot if you want it).
1598 format.pretty::
1599 The default pretty format for log/show/whatchanged command,
1600 See linkgit:git-log[1], linkgit:git-show[1],
1601 linkgit:git-whatchanged[1].
1603 format.thread::
1604 The default threading style for 'git format-patch'. Can be
1605 a boolean value, or `shallow` or `deep`. `shallow` threading
1606 makes every mail a reply to the head of the series,
1607 where the head is chosen from the cover letter, the
1608 `--in-reply-to`, and the first patch mail, in this order.
1609 `deep` threading makes every mail a reply to the previous one.
1610 A true boolean value is the same as `shallow`, and a false
1611 value disables threading.
1613 format.signOff::
1614 A boolean value which lets you enable the `-s/--signoff` option of
1615 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1616 patch should be a conscious act and means that you certify you have
1617 the rights to submit this work under the same open source license.
1618 Please see the 'SubmittingPatches' document for further discussion.
1620 format.coverLetter::
1621 A boolean that controls whether to generate a cover-letter when
1622 format-patch is invoked, but in addition can be set to "auto", to
1623 generate a cover-letter only when there's more than one patch.
1625 format.outputDirectory::
1626 Set a custom directory to store the resulting files instead of the
1627 current working directory.
1629 format.useAutoBase::
1630 A boolean value which lets you enable the `--base=auto` option of
1631 format-patch by default.
1633 filter.<driver>.clean::
1634 The command which is used to convert the content of a worktree
1635 file to a blob upon checkin. See linkgit:gitattributes[5] for
1636 details.
1638 filter.<driver>.smudge::
1639 The command which is used to convert the content of a blob
1640 object to a worktree file upon checkout. See
1641 linkgit:gitattributes[5] for details.
1643 fsck.<msg-id>::
1644 Allows overriding the message type (error, warn or ignore) of a
1645 specific message ID such as `missingEmail`.
1646 +
1647 For convenience, fsck prefixes the error/warning with the message ID,
1648 e.g. "missingEmail: invalid author/committer line - missing email" means
1649 that setting `fsck.missingEmail = ignore` will hide that issue.
1650 +
1651 This feature is intended to support working with legacy repositories
1652 which cannot be repaired without disruptive changes.
1654 fsck.skipList::
1655 The path to a sorted list of object names (i.e. one SHA-1 per
1656 line) that are known to be broken in a non-fatal way and should
1657 be ignored. This feature is useful when an established project
1658 should be accepted despite early commits containing errors that
1659 can be safely ignored such as invalid committer email addresses.
1660 Note: corrupt objects cannot be skipped with this setting.
1662 gc.aggressiveDepth::
1663 The depth parameter used in the delta compression
1664 algorithm used by 'git gc --aggressive'. This defaults
1665 to 50.
1667 gc.aggressiveWindow::
1668 The window size parameter used in the delta compression
1669 algorithm used by 'git gc --aggressive'. This defaults
1670 to 250.
1672 gc.auto::
1673 When there are approximately more than this many loose
1674 objects in the repository, `git gc --auto` will pack them.
1675 Some Porcelain commands use this command to perform a
1676 light-weight garbage collection from time to time. The
1677 default value is 6700. Setting this to 0 disables it.
1679 gc.autoPackLimit::
1680 When there are more than this many packs that are not
1681 marked with `*.keep` file in the repository, `git gc
1682 --auto` consolidates them into one larger pack. The
1683 default value is 50. Setting this to 0 disables it.
1685 gc.autoDetach::
1686 Make `git gc --auto` return immediately and run in background
1687 if the system supports it. Default is true.
1689 gc.bigPackThreshold::
1690 If non-zero, all packs larger than this limit are kept when
1691 `git gc` is run. This is very similar to `--keep-base-pack`
1692 except that all packs that meet the threshold are kept, not
1693 just the base pack. Defaults to zero. Common unit suffixes of
1694 'k', 'm', or 'g' are supported.
1695 +
1696 Note that if the number of kept packs is more than gc.autoPackLimit,
1697 this configuration variable is ignored, all packs except the base pack
1698 will be repacked. After this the number of packs should go below
1699 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1701 gc.logExpiry::
1702 If the file gc.log exists, then `git gc --auto` won't run
1703 unless that file is more than 'gc.logExpiry' old. Default is
1704 "1.day". See `gc.pruneExpire` for more ways to specify its
1705 value.
1707 gc.packRefs::
1708 Running `git pack-refs` in a repository renders it
1709 unclonable by Git versions prior to over dumb
1710 transports such as HTTP. This variable determines whether
1711 'git gc' runs `git pack-refs`. This can be set to `notbare`
1712 to enable it within all non-bare repos or it can be set to a
1713 boolean value. The default is `true`.
1715 gc.pruneExpire::
1716 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1717 Override the grace period with this config variable. The value
1718 "now" may be used to disable this grace period and always prune
1719 unreachable objects immediately, or "never" may be used to
1720 suppress pruning. This feature helps prevent corruption when
1721 'git gc' runs concurrently with another process writing to the
1722 repository; see the "NOTES" section of linkgit:git-gc[1].
1724 gc.worktreePruneExpire::
1725 When 'git gc' is run, it calls
1726 'git worktree prune --expire 3.months.ago'.
1727 This config variable can be used to set a different grace
1728 period. The value "now" may be used to disable the grace
1729 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1730 may be used to suppress pruning.
1732 gc.reflogExpire::
1733 gc.<pattern>.reflogExpire::
1734 'git reflog expire' removes reflog entries older than
1735 this time; defaults to 90 days. The value "now" expires all
1736 entries immediately, and "never" suppresses expiration
1737 altogether. With "<pattern>" (e.g.
1738 "refs/stash") in the middle the setting applies only to
1739 the refs that match the <pattern>.
1741 gc.reflogExpireUnreachable::
1742 gc.<pattern>.reflogExpireUnreachable::
1743 'git reflog expire' removes reflog entries older than
1744 this time and are not reachable from the current tip;
1745 defaults to 30 days. The value "now" expires all entries
1746 immediately, and "never" suppresses expiration altogether.
1747 With "<pattern>" (e.g. "refs/stash")
1748 in the middle, the setting applies only to the refs that
1749 match the <pattern>.
1751 gc.rerereResolved::
1752 Records of conflicted merge you resolved earlier are
1753 kept for this many days when 'git rerere gc' is run.
1754 You can also use more human-readable "1.month.ago", etc.
1755 The default is 60 days. See linkgit:git-rerere[1].
1757 gc.rerereUnresolved::
1758 Records of conflicted merge you have not resolved are
1759 kept for this many days when 'git rerere gc' is run.
1760 You can also use more human-readable "1.month.ago", etc.
1761 The default is 15 days. See linkgit:git-rerere[1].
1763 gitcvs.commitMsgAnnotation::
1764 Append this string to each commit message. Set to empty string
1765 to disable this feature. Defaults to "via git-CVS emulator".
1767 gitcvs.enabled::
1768 Whether the CVS server interface is enabled for this repository.
1769 See linkgit:git-cvsserver[1].
1771 gitcvs.logFile::
1772 Path to a log file where the CVS server interface well... logs
1773 various stuff. See linkgit:git-cvsserver[1].
1775 gitcvs.usecrlfattr::
1776 If true, the server will look up the end-of-line conversion
1777 attributes for files to determine the `-k` modes to use. If
1778 the attributes force Git to treat a file as text,
1779 the `-k` mode will be left blank so CVS clients will
1780 treat it as text. If they suppress text conversion, the file
1781 will be set with '-kb' mode, which suppresses any newline munging
1782 the client might otherwise do. If the attributes do not allow
1783 the file type to be determined, then `gitcvs.allBinary` is
1784 used. See linkgit:gitattributes[5].
1786 gitcvs.allBinary::
1787 This is used if `gitcvs.usecrlfattr` does not resolve
1788 the correct '-kb' mode to use. If true, all
1789 unresolved files are sent to the client in
1790 mode '-kb'. This causes the client to treat them
1791 as binary files, which suppresses any newline munging it
1792 otherwise might do. Alternatively, if it is set to "guess",
1793 then the contents of the file are examined to decide if
1794 it is binary, similar to `core.autocrlf`.
1796 gitcvs.dbName::
1797 Database used by git-cvsserver to cache revision information
1798 derived from the Git repository. The exact meaning depends on the
1799 used database driver, for SQLite (which is the default driver) this
1800 is a filename. Supports variable substitution (see
1801 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1802 Default: '%Ggitcvs.%m.sqlite'
1804 gitcvs.dbDriver::
1805 Used Perl DBI driver. You can specify any available driver
1806 for this here, but it might not work. git-cvsserver is tested
1807 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1808 reported *not* to work with 'DBD::mysql'. Experimental feature.
1809 May not contain double colons (`:`). Default: 'SQLite'.
1810 See linkgit:git-cvsserver[1].
1812 gitcvs.dbUser, gitcvs.dbPass::
1813 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1814 since SQLite has no concept of database users and/or passwords.
1815 'gitcvs.dbUser' supports variable substitution (see
1816 linkgit:git-cvsserver[1] for details).
1818 gitcvs.dbTableNamePrefix::
1819 Database table name prefix. Prepended to the names of any
1820 database tables used, allowing a single database to be used
1821 for several repositories. Supports variable substitution (see
1822 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1823 characters will be replaced with underscores.
1825 All gitcvs variables except for `gitcvs.usecrlfattr` and
1826 `gitcvs.allBinary` can also be specified as
1827 'gitcvs.<access_method>.<varname>' (where 'access_method'
1828 is one of "ext" and "pserver") to make them apply only for the given
1829 access method.
1831 gitweb.category::
1832 gitweb.description::
1833 gitweb.owner::
1834 gitweb.url::
1835 See linkgit:gitweb[1] for description.
1837 gitweb.avatar::
1838 gitweb.blame::
1839 gitweb.grep::
1840 gitweb.highlight::
1841 gitweb.patches::
1842 gitweb.pickaxe::
1843 gitweb.remote_heads::
1844 gitweb.showSizes::
1845 gitweb.snapshot::
1846 See linkgit:gitweb.conf[5] for description.
1848 grep.lineNumber::
1849 If set to true, enable `-n` option by default.
1851 grep.column::
1852 If set to true, enable the `--column` option by default.
1854 grep.patternType::
1855 Set the default matching behavior. Using a value of 'basic', 'extended',
1856 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1857 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1858 value 'default' will return to the default matching behavior.
1860 grep.extendedRegexp::
1861 If set to true, enable `--extended-regexp` option by default. This
1862 option is ignored when the `grep.patternType` option is set to a value
1863 other than 'default'.
1865 grep.threads::
1866 Number of grep worker threads to use.
1867 See `grep.threads` in linkgit:git-grep[1] for more information.
1869 grep.fallbackToNoIndex::
1870 If set to true, fall back to git grep --no-index if git grep
1871 is executed outside of a git repository. Defaults to false.
1873 gpg.program::
1874 Use this custom program instead of "`gpg`" found on `$PATH` when
1875 making or verifying a PGP signature. The program must support the
1876 same command-line interface as GPG, namely, to verify a detached
1877 signature, "`gpg --verify $file - <$signature`" is run, and the
1878 program is expected to signal a good signature by exiting with
1879 code 0, and to generate an ASCII-armored detached signature, the
1880 standard input of "`gpg -bsau $key`" is fed with the contents to be
1881 signed, and the program is expected to send the result to its
1882 standard output.
1884 gui.commitMsgWidth::
1885 Defines how wide the commit message window is in the
1886 linkgit:git-gui[1]. "75" is the default.
1888 gui.diffContext::
1889 Specifies how many context lines should be used in calls to diff
1890 made by the linkgit:git-gui[1]. The default is "5".
1892 gui.displayUntracked::
1893 Determines if linkgit:git-gui[1] shows untracked files
1894 in the file list. The default is "true".
1896 gui.encoding::
1897 Specifies the default encoding to use for displaying of
1898 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1899 It can be overridden by setting the 'encoding' attribute
1900 for relevant files (see linkgit:gitattributes[5]).
1901 If this option is not set, the tools default to the
1902 locale encoding.
1904 gui.matchTrackingBranch::
1905 Determines if new branches created with linkgit:git-gui[1] should
1906 default to tracking remote branches with matching names or
1907 not. Default: "false".
1909 gui.newBranchTemplate::
1910 Is used as suggested name when creating new branches using the
1911 linkgit:git-gui[1].
1913 gui.pruneDuringFetch::
1914 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1915 performing a fetch. The default value is "false".
1917 gui.trustmtime::
1918 Determines if linkgit:git-gui[1] should trust the file modification
1919 timestamp or not. By default the timestamps are not trusted.
1921 gui.spellingDictionary::
1922 Specifies the dictionary used for spell checking commit messages in
1923 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1924 off.
1926 gui.fastCopyBlame::
1927 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1928 location detection. It makes blame significantly faster on huge
1929 repositories at the expense of less thorough copy detection.
1931 gui.copyBlameThreshold::
1932 Specifies the threshold to use in 'git gui blame' original location
1933 detection, measured in alphanumeric characters. See the
1934 linkgit:git-blame[1] manual for more information on copy detection.
1936 gui.blamehistoryctx::
1937 Specifies the radius of history context in days to show in
1938 linkgit:gitk[1] for the selected commit, when the `Show History
1939 Context` menu item is invoked from 'git gui blame'. If this
1940 variable is set to zero, the whole history is shown.
1942 guitool.<name>.cmd::
1943 Specifies the shell command line to execute when the corresponding item
1944 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1945 mandatory for every tool. The command is executed from the root of
1946 the working directory, and in the environment it receives the name of
1947 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1948 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1949 the head is detached, 'CUR_BRANCH' is empty).
1951 guitool.<name>.needsFile::
1952 Run the tool only if a diff is selected in the GUI. It guarantees
1953 that 'FILENAME' is not empty.
1955 guitool.<name>.noConsole::
1956 Run the command silently, without creating a window to display its
1957 output.
1959 guitool.<name>.noRescan::
1960 Don't rescan the working directory for changes after the tool
1961 finishes execution.
1963 guitool.<name>.confirm::
1964 Show a confirmation dialog before actually running the tool.
1966 guitool.<name>.argPrompt::
1967 Request a string argument from the user, and pass it to the tool
1968 through the `ARGS` environment variable. Since requesting an
1969 argument implies confirmation, the 'confirm' option has no effect
1970 if this is enabled. If the option is set to 'true', 'yes', or '1',
1971 the dialog uses a built-in generic prompt; otherwise the exact
1972 value of the variable is used.
1974 guitool.<name>.revPrompt::
1975 Request a single valid revision from the user, and set the
1976 `REVISION` environment variable. In other aspects this option
1977 is similar to 'argPrompt', and can be used together with it.
1979 guitool.<name>.revUnmerged::
1980 Show only unmerged branches in the 'revPrompt' subdialog.
1981 This is useful for tools similar to merge or rebase, but not
1982 for things like checkout or reset.
1984 guitool.<name>.title::
1985 Specifies the title to use for the prompt dialog. The default
1986 is the tool name.
1988 guitool.<name>.prompt::
1989 Specifies the general prompt string to display at the top of
1990 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1991 The default value includes the actual command.
1993 help.browser::
1994 Specify the browser that will be used to display help in the
1995 'web' format. See linkgit:git-help[1].
1997 help.format::
1998 Override the default help format used by linkgit:git-help[1].
1999 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2000 the default. 'web' and 'html' are the same.
2002 help.autoCorrect::
2003 Automatically correct and execute mistyped commands after
2004 waiting for the given number of deciseconds (0.1 sec). If more
2005 than one command can be deduced from the entered text, nothing
2006 will be executed. If the value of this option is negative,
2007 the corrected command will be executed immediately. If the
2008 value is 0 - the command will be just shown but not executed.
2009 This is the default.
2011 help.htmlPath::
2012 Specify the path where the HTML documentation resides. File system paths
2013 and URLs are supported. HTML pages will be prefixed with this path when
2014 help is displayed in the 'web' format. This defaults to the documentation
2015 path of your Git installation.
2017 http.proxy::
2018 Override the HTTP proxy, normally configured using the 'http_proxy',
2019 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2020 addition to the syntax understood by curl, it is possible to specify a
2021 proxy string with a user name but no password, in which case git will
2022 attempt to acquire one in the same way it does for other credentials. See
2023 linkgit:gitcredentials[7] for more information. The syntax thus is
2024 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2025 on a per-remote basis; see remote.<name>.proxy
2027 http.proxyAuthMethod::
2028 Set the method with which to authenticate against the HTTP proxy. This
2029 only takes effect if the configured proxy string contains a user name part
2030 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2031 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2032 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2033 variable. Possible values are:
2034 +
2035 --
2036 * `anyauth` - Automatically pick a suitable authentication method. It is
2037 assumed that the proxy answers an unauthenticated request with a 407
2038 status code and one or more Proxy-authenticate headers with supported
2039 authentication methods. This is the default.
2040 * `basic` - HTTP Basic authentication
2041 * `digest` - HTTP Digest authentication; this prevents the password from being
2042 transmitted to the proxy in clear text
2043 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2044 of `curl(1)`)
2045 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2046 --
2048 http.emptyAuth::
2049 Attempt authentication without seeking a username or password. This
2050 can be used to attempt GSS-Negotiate authentication without specifying
2051 a username in the URL, as libcurl normally requires a username for
2052 authentication.
2054 http.delegation::
2055 Control GSSAPI credential delegation. The delegation is disabled
2056 by default in libcurl since version 7.21.7. Set parameter to tell
2057 the server what it is allowed to delegate when it comes to user
2058 credentials. Used with GSS/kerberos. Possible values are:
2059 +
2060 --
2061 * `none` - Don't allow any delegation.
2062 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2063 Kerberos service ticket, which is a matter of realm policy.
2064 * `always` - Unconditionally allow the server to delegate.
2065 --
2068 http.extraHeader::
2069 Pass an additional HTTP header when communicating with a server. If
2070 more than one such entry exists, all of them are added as extra
2071 headers. To allow overriding the settings inherited from the system
2072 config, an empty value will reset the extra headers to the empty list.
2074 http.cookieFile::
2075 The pathname of a file containing previously stored cookie lines,
2076 which should be used
2077 in the Git http session, if they match the server. The file format
2078 of the file to read cookies from should be plain HTTP headers or
2079 the Netscape/Mozilla cookie file format (see `curl(1)`).
2080 NOTE that the file specified with http.cookieFile is used only as
2081 input unless http.saveCookies is set.
2083 http.saveCookies::
2084 If set, store cookies received during requests to the file specified by
2085 http.cookieFile. Has no effect if http.cookieFile is unset.
2087 http.sslVersion::
2088 The SSL version to use when negotiating an SSL connection, if you
2089 want to force the default. The available and default version
2090 depend on whether libcurl was built against NSS or OpenSSL and the
2091 particular configuration of the crypto library in use. Internally
2092 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2093 documentation for more details on the format of this option and
2094 for the ssl version supported. Actually the possible values of
2095 this option are:
2097 - sslv2
2098 - sslv3
2099 - tlsv1
2100 - tlsv1.0
2101 - tlsv1.1
2102 - tlsv1.2
2103 - tlsv1.3
2105 +
2106 Can be overridden by the `GIT_SSL_VERSION` environment variable.
2107 To force git to use libcurl's default ssl version and ignore any
2108 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2109 empty string.
2111 http.sslCipherList::
2112 A list of SSL ciphers to use when negotiating an SSL connection.
2113 The available ciphers depend on whether libcurl was built against
2114 NSS or OpenSSL and the particular configuration of the crypto
2115 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2116 option; see the libcurl documentation for more details on the format
2117 of this list.
2118 +
2119 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2120 To force git to use libcurl's default cipher list and ignore any
2121 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2122 empty string.
2124 http.sslVerify::
2125 Whether to verify the SSL certificate when fetching or pushing
2126 over HTTPS. Defaults to true. Can be overridden by the
2127 `GIT_SSL_NO_VERIFY` environment variable.
2129 http.sslCert::
2130 File containing the SSL certificate when fetching or pushing
2131 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2132 variable.
2134 http.sslKey::
2135 File containing the SSL private key when fetching or pushing
2136 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2137 variable.
2139 http.sslCertPasswordProtected::
2140 Enable Git's password prompt for the SSL certificate. Otherwise
2141 OpenSSL will prompt the user, possibly many times, if the
2142 certificate or private key is encrypted. Can be overridden by the
2143 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2145 http.sslCAInfo::
2146 File containing the certificates to verify the peer with when
2147 fetching or pushing over HTTPS. Can be overridden by the
2148 `GIT_SSL_CAINFO` environment variable.
2150 http.sslCAPath::
2151 Path containing files with the CA certificates to verify the peer
2152 with when fetching or pushing over HTTPS. Can be overridden
2153 by the `GIT_SSL_CAPATH` environment variable.
2155 http.pinnedpubkey::
2156 Public key of the https service. It may either be the filename of
2157 a PEM or DER encoded public key file or a string starting with
2158 'sha256//' followed by the base64 encoded sha256 hash of the
2159 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2160 exit with an error if this option is set but not supported by
2161 cURL.
2163 http.sslTry::
2164 Attempt to use AUTH SSL/TLS and encrypted data transfers
2165 when connecting via regular FTP protocol. This might be needed
2166 if the FTP server requires it for security reasons or you wish
2167 to connect securely whenever remote FTP server supports it.
2168 Default is false since it might trigger certificate verification
2169 errors on misconfigured servers.
2171 http.maxRequests::
2172 How many HTTP requests to launch in parallel. Can be overridden
2173 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2175 http.minSessions::
2176 The number of curl sessions (counted across slots) to be kept across
2177 requests. They will not be ended with curl_easy_cleanup() until
2178 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2179 value will be capped at 1. Defaults to 1.
2181 http.postBuffer::
2182 Maximum size in bytes of the buffer used by smart HTTP
2183 transports when POSTing data to the remote system.
2184 For requests larger than this buffer size, HTTP/1.1 and
2185 Transfer-Encoding: chunked is used to avoid creating a
2186 massive pack file locally. Default is 1 MiB, which is
2187 sufficient for most requests.
2189 http.lowSpeedLimit, http.lowSpeedTime::
2190 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2191 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2192 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2193 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2195 http.noEPSV::
2196 A boolean which disables using of EPSV ftp command by curl.
2197 This can helpful with some "poor" ftp servers which don't
2198 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2199 environment variable. Default is false (curl will use EPSV).
2201 http.userAgent::
2202 The HTTP USER_AGENT string presented to an HTTP server. The default
2203 value represents the version of the client Git such as git/1.7.1.
2204 This option allows you to override this value to a more common value
2205 such as Mozilla/4.0. This may be necessary, for instance, if
2206 connecting through a firewall that restricts HTTP connections to a set
2207 of common USER_AGENT strings (but not including those like git/1.7.1).
2208 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2210 http.followRedirects::
2211 Whether git should follow HTTP redirects. If set to `true`, git
2212 will transparently follow any redirect issued by a server it
2213 encounters. If set to `false`, git will treat all redirects as
2214 errors. If set to `initial`, git will follow redirects only for
2215 the initial request to a remote, but not for subsequent
2216 follow-up HTTP requests. Since git uses the redirected URL as
2217 the base for the follow-up requests, this is generally
2218 sufficient. The default is `initial`.
2220 http.<url>.*::
2221 Any of the http.* options above can be applied selectively to some URLs.
2222 For a config key to match a URL, each element of the config key is
2223 compared to that of the URL, in the following order:
2224 +
2225 --
2226 . Scheme (e.g., `https` in `https://example.com/`). This field
2227 must match exactly between the config key and the URL.
2229 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2230 This field must match between the config key and the URL. It is
2231 possible to specify a `*` as part of the host name to match all subdomains
2232 at this level. `https://*.example.com/` for example would match
2233 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2235 . Port number (e.g., `8080` in `http://example.com:8080/`).
2236 This field must match exactly between the config key and the URL.
2237 Omitted port numbers are automatically converted to the correct
2238 default for the scheme before matching.
2240 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2241 path field of the config key must match the path field of the URL
2242 either exactly or as a prefix of slash-delimited path elements. This means
2243 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2244 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2245 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2246 key with just path `foo/`).
2248 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2249 the config key has a user name it must match the user name in the
2250 URL exactly. If the config key does not have a user name, that
2251 config key will match a URL with any user name (including none),
2252 but at a lower precedence than a config key with a user name.
2253 --
2254 +
2255 The list above is ordered by decreasing precedence; a URL that matches
2256 a config key's path is preferred to one that matches its user name. For example,
2257 if the URL is `https://user@example.com/foo/bar` a config key match of
2258 `https://example.com/foo` will be preferred over a config key match of
2259 `https://user@example.com`.
2260 +
2261 All URLs are normalized before attempting any matching (the password part,
2262 if embedded in the URL, is always ignored for matching purposes) so that
2263 equivalent URLs that are simply spelled differently will match properly.
2264 Environment variable settings always override any matches. The URLs that are
2265 matched against are those given directly to Git commands. This means any URLs
2266 visited as a result of a redirection do not participate in matching.
2268 ssh.variant::
2269 By default, Git determines the command line arguments to use
2270 based on the basename of the configured SSH command (configured
2271 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2272 the config setting `core.sshCommand`). If the basename is
2273 unrecognized, Git will attempt to detect support of OpenSSH
2274 options by first invoking the configured SSH command with the
2275 `-G` (print configuration) option and will subsequently use
2276 OpenSSH options (if that is successful) or no options besides
2277 the host and remote command (if it fails).
2278 +
2279 The config variable `ssh.variant` can be set to override this detection.
2280 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2281 `tortoiseplink`, `simple` (no options except the host and remote command).
2282 The default auto-detection can be explicitly requested using the value
2283 `auto`. Any other value is treated as `ssh`. This setting can also be
2284 overridden via the environment variable `GIT_SSH_VARIANT`.
2285 +
2286 The current command-line parameters used for each variant are as
2287 follows:
2288 +
2289 --
2291 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2293 * `simple` - [username@]host command
2295 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2297 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2299 --
2300 +
2301 Except for the `simple` variant, command-line parameters are likely to
2302 change as git gains new features.
2304 i18n.commitEncoding::
2305 Character encoding the commit messages are stored in; Git itself
2306 does not care per se, but this information is necessary e.g. when
2307 importing commits from emails or in the gitk graphical history
2308 browser (and possibly at other places in the future or in other
2309 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2311 i18n.logOutputEncoding::
2312 Character encoding the commit messages are converted to when
2313 running 'git log' and friends.
2315 imap::
2316 The configuration variables in the 'imap' section are described
2317 in linkgit:git-imap-send[1].
2319 index.version::
2320 Specify the version with which new index files should be
2321 initialized. This does not affect existing repositories.
2323 init.templateDir::
2324 Specify the directory from which templates will be copied.
2325 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2327 instaweb.browser::
2328 Specify the program that will be used to browse your working
2329 repository in gitweb. See linkgit:git-instaweb[1].
2331 instaweb.httpd::
2332 The HTTP daemon command-line to start gitweb on your working
2333 repository. See linkgit:git-instaweb[1].
2335 instaweb.local::
2336 If true the web server started by linkgit:git-instaweb[1] will
2337 be bound to the local IP (
2339 instaweb.modulePath::
2340 The default module path for linkgit:git-instaweb[1] to use
2341 instead of /usr/lib/apache2/modules. Only used if httpd
2342 is Apache.
2344 instaweb.port::
2345 The port number to bind the gitweb httpd to. See
2346 linkgit:git-instaweb[1].
2348 interactive.singleKey::
2349 In interactive commands, allow the user to provide one-letter
2350 input with a single key (i.e., without hitting enter).
2351 Currently this is used by the `--patch` mode of
2352 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2353 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2354 setting is silently ignored if portable keystroke input
2355 is not available; requires the Perl module Term::ReadKey.
2357 interactive.diffFilter::
2358 When an interactive command (such as `git add --patch`) shows
2359 a colorized diff, git will pipe the diff through the shell
2360 command defined by this configuration variable. The command may
2361 mark up the diff further for human consumption, provided that it
2362 retains a one-to-one correspondence with the lines in the
2363 original diff. Defaults to disabled (no filtering).
2365 log.abbrevCommit::
2366 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2367 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2368 override this option with `--no-abbrev-commit`.
2370 log.date::
2371 Set the default date-time mode for the 'log' command.
2372 Setting a value for log.date is similar to using 'git log''s
2373 `--date` option. See linkgit:git-log[1] for details.
2375 log.decorate::
2376 Print out the ref names of any commits that are shown by the log
2377 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2378 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2379 specified, the full ref name (including prefix) will be printed.
2380 If 'auto' is specified, then if the output is going to a terminal,
2381 the ref names are shown as if 'short' were given, otherwise no ref
2382 names are shown. This is the same as the `--decorate` option
2383 of the `git log`.
2385 log.follow::
2386 If `true`, `git log` will act as if the `--follow` option was used when
2387 a single <path> is given. This has the same limitations as `--follow`,
2388 i.e. it cannot be used to follow multiple files and does not work well
2389 on non-linear history.
2391 log.graphColors::
2392 A list of colors, separated by commas, that can be used to draw
2393 history lines in `git log --graph`.
2395 log.showRoot::
2396 If true, the initial commit will be shown as a big creation event.
2397 This is equivalent to a diff against an empty tree.
2398 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2399 normally hide the root commit will now show it. True by default.
2401 log.showSignature::
2402 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2403 linkgit:git-whatchanged[1] assume `--show-signature`.
2405 log.mailmap::
2406 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2407 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2409 mailinfo.scissors::
2410 If true, makes linkgit:git-mailinfo[1] (and therefore
2411 linkgit:git-am[1]) act by default as if the --scissors option
2412 was provided on the command-line. When active, this features
2413 removes everything from the message body before a scissors
2414 line (i.e. consisting mainly of ">8", "8<" and "-").
2416 mailmap.file::
2417 The location of an augmenting mailmap file. The default
2418 mailmap, located in the root of the repository, is loaded
2419 first, then the mailmap file pointed to by this variable.
2420 The location of the mailmap file may be in a repository
2421 subdirectory, or somewhere outside of the repository itself.
2422 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2424 mailmap.blob::
2425 Like `mailmap.file`, but consider the value as a reference to a
2426 blob in the repository. If both `mailmap.file` and
2427 `mailmap.blob` are given, both are parsed, with entries from
2428 `mailmap.file` taking precedence. In a bare repository, this
2429 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2430 defaults to empty.
2432 man.viewer::
2433 Specify the programs that may be used to display help in the
2434 'man' format. See linkgit:git-help[1].
2436 man.<tool>.cmd::
2437 Specify the command to invoke the specified man viewer. The
2438 specified command is evaluated in shell with the man page
2439 passed as argument. (See linkgit:git-help[1].)
2441 man.<tool>.path::
2442 Override the path for the given tool that may be used to
2443 display help in the 'man' format. See linkgit:git-help[1].
2445 include::merge-config.txt[]
2447 mergetool.<tool>.path::
2448 Override the path for the given tool. This is useful in case
2449 your tool is not in the PATH.
2451 mergetool.<tool>.cmd::
2452 Specify the command to invoke the specified merge tool. The
2453 specified command is evaluated in shell with the following
2454 variables available: 'BASE' is the name of a temporary file
2455 containing the common base of the files to be merged, if available;
2456 'LOCAL' is the name of a temporary file containing the contents of
2457 the file on the current branch; 'REMOTE' is the name of a temporary
2458 file containing the contents of the file from the branch being
2459 merged; 'MERGED' contains the name of the file to which the merge
2460 tool should write the results of a successful merge.
2462 mergetool.<tool>.trustExitCode::
2463 For a custom merge command, specify whether the exit code of
2464 the merge command can be used to determine whether the merge was
2465 successful. If this is not set to true then the merge target file
2466 timestamp is checked and the merge assumed to have been successful
2467 if the file has been updated, otherwise the user is prompted to
2468 indicate the success of the merge.
2470 mergetool.meld.hasOutput::
2471 Older versions of `meld` do not support the `--output` option.
2472 Git will attempt to detect whether `meld` supports `--output`
2473 by inspecting the output of `meld --help`. Configuring
2474 `mergetool.meld.hasOutput` will make Git skip these checks and
2475 use the configured value instead. Setting `mergetool.meld.hasOutput`
2476 to `true` tells Git to unconditionally use the `--output` option,
2477 and `false` avoids using `--output`.
2479 mergetool.keepBackup::
2480 After performing a merge, the original file with conflict markers
2481 can be saved as a file with a `.orig` extension. If this variable
2482 is set to `false` then this file is not preserved. Defaults to
2483 `true` (i.e. keep the backup files).
2485 mergetool.keepTemporaries::
2486 When invoking a custom merge tool, Git uses a set of temporary
2487 files to pass to the tool. If the tool returns an error and this
2488 variable is set to `true`, then these temporary files will be
2489 preserved, otherwise they will be removed after the tool has
2490 exited. Defaults to `false`.
2492 mergetool.writeToTemp::
2493 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2494 conflicting files in the worktree by default. Git will attempt
2495 to use a temporary directory for these files when set `true`.
2496 Defaults to `false`.
2498 mergetool.prompt::
2499 Prompt before each invocation of the merge resolution program.
2501 notes.mergeStrategy::
2502 Which merge strategy to choose by default when resolving notes
2503 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2504 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2505 section of linkgit:git-notes[1] for more information on each strategy.
2507 notes.<name>.mergeStrategy::
2508 Which merge strategy to choose when doing a notes merge into
2509 refs/notes/<name>. This overrides the more general
2510 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2511 linkgit:git-notes[1] for more information on the available strategies.
2513 notes.displayRef::
2514 The (fully qualified) refname from which to show notes when
2515 showing commit messages. The value of this variable can be set
2516 to a glob, in which case notes from all matching refs will be
2517 shown. You may also specify this configuration variable
2518 several times. A warning will be issued for refs that do not
2519 exist, but a glob that does not match any refs is silently
2520 ignored.
2521 +
2522 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2523 environment variable, which must be a colon separated list of refs or
2524 globs.
2525 +
2526 The effective value of "core.notesRef" (possibly overridden by
2527 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2528 displayed.
2530 notes.rewrite.<command>::
2531 When rewriting commits with <command> (currently `amend` or
2532 `rebase`) and this variable is set to `true`, Git
2533 automatically copies your notes from the original to the
2534 rewritten commit. Defaults to `true`, but see
2535 "notes.rewriteRef" below.
2537 notes.rewriteMode::
2538 When copying notes during a rewrite (see the
2539 "notes.rewrite.<command>" option), determines what to do if
2540 the target commit already has a note. Must be one of
2541 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2542 Defaults to `concatenate`.
2543 +
2544 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2545 environment variable.
2547 notes.rewriteRef::
2548 When copying notes during a rewrite, specifies the (fully
2549 qualified) ref whose notes should be copied. The ref may be a
2550 glob, in which case notes in all matching refs will be copied.
2551 You may also specify this configuration several times.
2552 +
2553 Does not have a default value; you must configure this variable to
2554 enable note rewriting. Set it to `refs/notes/commits` to enable
2555 rewriting for the default commit notes.
2556 +
2557 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2558 environment variable, which must be a colon separated list of refs or
2559 globs.
2561 pack.window::
2562 The size of the window used by linkgit:git-pack-objects[1] when no
2563 window size is given on the command line. Defaults to 10.
2565 pack.depth::
2566 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2567 maximum depth is given on the command line. Defaults to 50.
2568 Maximum value is 4095.
2570 pack.windowMemory::
2571 The maximum size of memory that is consumed by each thread
2572 in linkgit:git-pack-objects[1] for pack window memory when
2573 no limit is given on the command line. The value can be
2574 suffixed with "k", "m", or "g". When left unconfigured (or
2575 set explicitly to 0), there will be no limit.
2577 pack.compression::
2578 An integer -1..9, indicating the compression level for objects
2579 in a pack file. -1 is the zlib default. 0 means no
2580 compression, and 1..9 are various speed/size tradeoffs, 9 being
2581 slowest. If not set, defaults to core.compression. If that is
2582 not set, defaults to -1, the zlib default, which is "a default
2583 compromise between speed and compression (currently equivalent
2584 to level 6)."
2585 +
2586 Note that changing the compression level will not automatically recompress
2587 all existing objects. You can force recompression by passing the -F option
2588 to linkgit:git-repack[1].
2590 pack.deltaCacheSize::
2591 The maximum memory in bytes used for caching deltas in
2592 linkgit:git-pack-objects[1] before writing them out to a pack.
2593 This cache is used to speed up the writing object phase by not
2594 having to recompute the final delta result once the best match
2595 for all objects is found. Repacking large repositories on machines
2596 which are tight with memory might be badly impacted by this though,
2597 especially if this cache pushes the system into swapping.
2598 A value of 0 means no limit. The smallest size of 1 byte may be
2599 used to virtually disable this cache. Defaults to 256 MiB.
2601 pack.deltaCacheLimit::
2602 The maximum size of a delta, that is cached in
2603 linkgit:git-pack-objects[1]. This cache is used to speed up the
2604 writing object phase by not having to recompute the final delta
2605 result once the best match for all objects is found.
2606 Defaults to 1000. Maximum value is 65535.
2608 pack.threads::
2609 Specifies the number of threads to spawn when searching for best
2610 delta matches. This requires that linkgit:git-pack-objects[1]
2611 be compiled with pthreads otherwise this option is ignored with a
2612 warning. This is meant to reduce packing time on multiprocessor
2613 machines. The required amount of memory for the delta search window
2614 is however multiplied by the number of threads.
2615 Specifying 0 will cause Git to auto-detect the number of CPU's
2616 and set the number of threads accordingly.
2618 pack.indexVersion::
2619 Specify the default pack index version. Valid values are 1 for
2620 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2621 the new pack index with capabilities for packs larger than 4 GB
2622 as well as proper protection against the repacking of corrupted
2623 packs. Version 2 is the default. Note that version 2 is enforced
2624 and this config option ignored whenever the corresponding pack is
2625 larger than 2 GB.
2626 +
2627 If you have an old Git that does not understand the version 2 `*.idx` file,
2628 cloning or fetching over a non native protocol (e.g. "http")
2629 that will copy both `*.pack` file and corresponding `*.idx` file from the
2630 other side may give you a repository that cannot be accessed with your
2631 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2632 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2633 the `*.idx` file.
2635 pack.packSizeLimit::
2636 The maximum size of a pack. This setting only affects
2637 packing to a file when repacking, i.e. the git:// protocol
2638 is unaffected. It can be overridden by the `--max-pack-size`
2639 option of linkgit:git-repack[1]. Reaching this limit results
2640 in the creation of multiple packfiles; which in turn prevents
2641 bitmaps from being created.
2642 The minimum size allowed is limited to 1 MiB.
2643 The default is unlimited.
2644 Common unit suffixes of 'k', 'm', or 'g' are
2645 supported.
2647 pack.useBitmaps::
2648 When true, git will use pack bitmaps (if available) when packing
2649 to stdout (e.g., during the server side of a fetch). Defaults to
2650 true. You should not generally need to turn this off unless
2651 you are debugging pack bitmaps.
2653 pack.writeBitmaps (deprecated)::
2654 This is a deprecated synonym for `repack.writeBitmaps`.
2656 pack.writeBitmapHashCache::
2657 When true, git will include a "hash cache" section in the bitmap
2658 index (if one is written). This cache can be used to feed git's
2659 delta heuristics, potentially leading to better deltas between
2660 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2661 between an older, bitmapped pack and objects that have been
2662 pushed since the last gc). The downside is that it consumes 4
2663 bytes per object of disk space, and that JGit's bitmap
2664 implementation does not understand it, causing it to complain if
2665 Git and JGit are used on the same repository. Defaults to false.
2667 pager.<cmd>::
2668 If the value is boolean, turns on or off pagination of the
2669 output of a particular Git subcommand when writing to a tty.
2670 Otherwise, turns on pagination for the subcommand using the
2671 pager specified by the value of `pager.<cmd>`. If `--paginate`
2672 or `--no-pager` is specified on the command line, it takes
2673 precedence over this option. To disable pagination for all
2674 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2676 pretty.<name>::
2677 Alias for a --pretty= format string, as specified in
2678 linkgit:git-log[1]. Any aliases defined here can be used just
2679 as the built-in pretty formats could. For example,
2680 running `git config pretty.changelog "format:* %H %s"`
2681 would cause the invocation `git log --pretty=changelog`
2682 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2683 Note that an alias with the same name as a built-in format
2684 will be silently ignored.
2686 protocol.allow::
2687 If set, provide a user defined default policy for all protocols which
2688 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2689 if unset, known-safe protocols (http, https, git, ssh, file) have a
2690 default policy of `always`, known-dangerous protocols (ext) have a
2691 default policy of `never`, and all other protocols have a default
2692 policy of `user`. Supported policies:
2693 +
2694 --
2696 * `always` - protocol is always able to be used.
2698 * `never` - protocol is never able to be used.
2700 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2701 either unset or has a value of 1. This policy should be used when you want a
2702 protocol to be directly usable by the user but don't want it used by commands which
2703 execute clone/fetch/push commands without user input, e.g. recursive
2704 submodule initialization.
2706 --
2708 protocol.<name>.allow::
2709 Set a policy to be used by protocol `<name>` with clone/fetch/push
2710 commands. See `protocol.allow` above for the available policies.
2711 +
2712 The protocol names currently used by git are:
2713 +
2714 --
2715 - `file`: any local file-based path (including `file://` URLs,
2716 or local paths)
2718 - `git`: the anonymous git protocol over a direct TCP
2719 connection (or proxy, if configured)
2721 - `ssh`: git over ssh (including `host:path` syntax,
2722 `ssh://`, etc).
2724 - `http`: git over http, both "smart http" and "dumb http".
2725 Note that this does _not_ include `https`; if you want to configure
2726 both, you must do so individually.
2728 - any external helpers are named by their protocol (e.g., use
2729 `hg` to allow the `git-remote-hg` helper)
2730 --
2732 protocol.version::
2733 Experimental. If set, clients will attempt to communicate with a
2734 server using the specified protocol version. If unset, no
2735 attempt will be made by the client to communicate using a
2736 particular protocol version, this results in protocol version 0
2737 being used.
2738 Supported versions:
2739 +
2740 --
2742 * `0` - the original wire protocol.
2744 * `1` - the original wire protocol with the addition of a version string
2745 in the initial response from the server.
2747 --
2749 pull.ff::
2750 By default, Git does not create an extra merge commit when merging
2751 a commit that is a descendant of the current commit. Instead, the
2752 tip of the current branch is fast-forwarded. When set to `false`,
2753 this variable tells Git to create an extra merge commit in such
2754 a case (equivalent to giving the `--no-ff` option from the command
2755 line). When set to `only`, only such fast-forward merges are
2756 allowed (equivalent to giving the `--ff-only` option from the
2757 command line). This setting overrides `merge.ff` when pulling.
2759 pull.rebase::
2760 When true, rebase branches on top of the fetched branch, instead
2761 of merging the default branch from the default remote when "git
2762 pull" is run. See "branch.<name>.rebase" for setting this on a
2763 per-branch basis.
2764 +
2765 When `merges`, pass the `--rebase-merges` option to 'git rebase'
2766 so that the local merge commits are included in the rebase (see
2767 linkgit:git-rebase[1] for details).
2768 +
2769 When preserve, also pass `--preserve-merges` along to 'git rebase'
2770 so that locally committed merge commits will not be flattened
2771 by running 'git pull'.
2772 +
2773 When the value is `interactive`, the rebase is run in interactive mode.
2774 +
2775 *NOTE*: this is a possibly dangerous operation; do *not* use
2776 it unless you understand the implications (see linkgit:git-rebase[1]
2777 for details).
2779 pull.octopus::
2780 The default merge strategy to use when pulling multiple branches
2781 at once.
2783 pull.twohead::
2784 The default merge strategy to use when pulling a single branch.
2786 push.default::
2787 Defines the action `git push` should take if no refspec is
2788 explicitly given. Different values are well-suited for
2789 specific workflows; for instance, in a purely central workflow
2790 (i.e. the fetch source is equal to the push destination),
2791 `upstream` is probably what you want. Possible values are:
2792 +
2793 --
2795 * `nothing` - do not push anything (error out) unless a refspec is
2796 explicitly given. This is primarily meant for people who want to
2797 avoid mistakes by always being explicit.
2799 * `current` - push the current branch to update a branch with the same
2800 name on the receiving end. Works in both central and non-central
2801 workflows.
2803 * `upstream` - push the current branch back to the branch whose
2804 changes are usually integrated into the current branch (which is
2805 called `@{upstream}`). This mode only makes sense if you are
2806 pushing to the same repository you would normally pull from
2807 (i.e. central workflow).
2809 * `tracking` - This is a deprecated synonym for `upstream`.
2811 * `simple` - in centralized workflow, work like `upstream` with an
2812 added safety to refuse to push if the upstream branch's name is
2813 different from the local one.
2814 +
2815 When pushing to a remote that is different from the remote you normally
2816 pull from, work as `current`. This is the safest option and is suited
2817 for beginners.
2818 +
2819 This mode has become the default in Git 2.0.
2821 * `matching` - push all branches having the same name on both ends.
2822 This makes the repository you are pushing to remember the set of
2823 branches that will be pushed out (e.g. if you always push 'maint'
2824 and 'master' there and no other branches, the repository you push
2825 to will have these two branches, and your local 'maint' and
2826 'master' will be pushed there).
2827 +
2828 To use this mode effectively, you have to make sure _all_ the
2829 branches you would push out are ready to be pushed out before
2830 running 'git push', as the whole point of this mode is to allow you
2831 to push all of the branches in one go. If you usually finish work
2832 on only one branch and push out the result, while other branches are
2833 unfinished, this mode is not for you. Also this mode is not
2834 suitable for pushing into a shared central repository, as other
2835 people may add new branches there, or update the tip of existing
2836 branches outside your control.
2837 +
2838 This used to be the default, but not since Git 2.0 (`simple` is the
2839 new default).
2841 --
2843 push.followTags::
2844 If set to true enable `--follow-tags` option by default. You
2845 may override this configuration at time of push by specifying
2846 `--no-follow-tags`.
2848 push.gpgSign::
2849 May be set to a boolean value, or the string 'if-asked'. A true
2850 value causes all pushes to be GPG signed, as if `--signed` is
2851 passed to linkgit:git-push[1]. The string 'if-asked' causes
2852 pushes to be signed if the server supports it, as if
2853 `--signed=if-asked` is passed to 'git push'. A false value may
2854 override a value from a lower-priority config file. An explicit
2855 command-line flag always overrides this config option.
2857 push.pushOption::
2858 When no `--push-option=<option>` argument is given from the
2859 command line, `git push` behaves as if each <value> of
2860 this variable is given as `--push-option=<value>`.
2861 +
2862 This is a multi-valued variable, and an empty value can be used in a
2863 higher priority configuration file (e.g. `.git/config` in a
2864 repository) to clear the values inherited from a lower priority
2865 configuration files (e.g. `$HOME/.gitconfig`).
2866 +
2867 --
2869 Example:
2871 /etc/gitconfig
2872 push.pushoption = a
2873 push.pushoption = b
2875 ~/.gitconfig
2876 push.pushoption = c
2878 repo/.git/config
2879 push.pushoption =
2880 push.pushoption = b
2882 This will result in only b (a and c are cleared).
2884 --
2886 push.recurseSubmodules::
2887 Make sure all submodule commits used by the revisions to be pushed
2888 are available on a remote-tracking branch. If the value is 'check'
2889 then Git will verify that all submodule commits that changed in the
2890 revisions to be pushed are available on at least one remote of the
2891 submodule. If any commits are missing, the push will be aborted and
2892 exit with non-zero status. If the value is 'on-demand' then all
2893 submodules that changed in the revisions to be pushed will be
2894 pushed. If on-demand was not able to push all necessary revisions
2895 it will also be aborted and exit with non-zero status. If the value
2896 is 'no' then default behavior of ignoring submodules when pushing
2897 is retained. You may override this configuration at time of push by
2898 specifying '--recurse-submodules=check|on-demand|no'.
2900 include::rebase-config.txt[]
2902 receive.advertiseAtomic::
2903 By default, git-receive-pack will advertise the atomic push
2904 capability to its clients. If you don't want to advertise this
2905 capability, set this variable to false.
2907 receive.advertisePushOptions::
2908 When set to true, git-receive-pack will advertise the push options
2909 capability to its clients. False by default.
2911 receive.autogc::
2912 By default, git-receive-pack will run "git-gc --auto" after
2913 receiving data from git-push and updating refs. You can stop
2914 it by setting this variable to false.
2916 receive.certNonceSeed::
2917 By setting this variable to a string, `git receive-pack`
2918 will accept a `git push --signed` and verifies it by using
2919 a "nonce" protected by HMAC using this string as a secret
2920 key.
2922 receive.certNonceSlop::
2923 When a `git push --signed` sent a push certificate with a
2924 "nonce" that was issued by a receive-pack serving the same
2925 repository within this many seconds, export the "nonce"
2926 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2927 hooks (instead of what the receive-pack asked the sending
2928 side to include). This may allow writing checks in
2929 `pre-receive` and `post-receive` a bit easier. Instead of
2930 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2931 that records by how many seconds the nonce is stale to
2932 decide if they want to accept the certificate, they only
2933 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2935 receive.fsckObjects::
2936 If it is set to true, git-receive-pack will check all received
2937 objects. It will abort in the case of a malformed object or a
2938 broken link. The result of an abort are only dangling objects.
2939 Defaults to false. If not set, the value of `transfer.fsckObjects`
2940 is used instead.
2942 receive.fsck.<msg-id>::
2943 When `receive.fsckObjects` is set to true, errors can be switched
2944 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2945 setting where the `<msg-id>` is the fsck message ID and the value
2946 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2947 the error/warning with the message ID, e.g. "missingEmail: invalid
2948 author/committer line - missing email" means that setting
2949 `receive.fsck.missingEmail = ignore` will hide that issue.
2950 +
2951 This feature is intended to support working with legacy repositories
2952 which would not pass pushing when `receive.fsckObjects = true`, allowing
2953 the host to accept repositories with certain known issues but still catch
2954 other issues.
2956 receive.fsck.skipList::
2957 The path to a sorted list of object names (i.e. one SHA-1 per
2958 line) that are known to be broken in a non-fatal way and should
2959 be ignored. This feature is useful when an established project
2960 should be accepted despite early commits containing errors that
2961 can be safely ignored such as invalid committer email addresses.
2962 Note: corrupt objects cannot be skipped with this setting.
2964 receive.keepAlive::
2965 After receiving the pack from the client, `receive-pack` may
2966 produce no output (if `--quiet` was specified) while processing
2967 the pack, causing some networks to drop the TCP connection.
2968 With this option set, if `receive-pack` does not transmit
2969 any data in this phase for `receive.keepAlive` seconds, it will
2970 send a short keepalive packet. The default is 5 seconds; set
2971 to 0 to disable keepalives entirely.
2973 receive.unpackLimit::
2974 If the number of objects received in a push is below this
2975 limit then the objects will be unpacked into loose object
2976 files. However if the number of received objects equals or
2977 exceeds this limit then the received pack will be stored as
2978 a pack, after adding any missing delta bases. Storing the
2979 pack from a push can make the push operation complete faster,
2980 especially on slow filesystems. If not set, the value of
2981 `transfer.unpackLimit` is used instead.
2983 receive.maxInputSize::
2984 If the size of the incoming pack stream is larger than this
2985 limit, then git-receive-pack will error out, instead of
2986 accepting the pack file. If not set or set to 0, then the size
2987 is unlimited.
2989 receive.denyDeletes::
2990 If set to true, git-receive-pack will deny a ref update that deletes
2991 the ref. Use this to prevent such a ref deletion via a push.
2993 receive.denyDeleteCurrent::
2994 If set to true, git-receive-pack will deny a ref update that
2995 deletes the currently checked out branch of a non-bare repository.
2997 receive.denyCurrentBranch::
2998 If set to true or "refuse", git-receive-pack will deny a ref update
2999 to the currently checked out branch of a non-bare repository.
3000 Such a push is potentially dangerous because it brings the HEAD
3001 out of sync with the index and working tree. If set to "warn",
3002 print a warning of such a push to stderr, but allow the push to
3003 proceed. If set to false or "ignore", allow such pushes with no
3004 message. Defaults to "refuse".
3005 +
3006 Another option is "updateInstead" which will update the working
3007 tree if pushing into the current branch. This option is
3008 intended for synchronizing working directories when one side is not easily
3009 accessible via interactive ssh (e.g. a live web site, hence the requirement
3010 that the working directory be clean). This mode also comes in handy when
3011 developing inside a VM to test and fix code on different Operating Systems.
3012 +
3013 By default, "updateInstead" will refuse the push if the working tree or
3014 the index have any difference from the HEAD, but the `push-to-checkout`
3015 hook can be used to customize this. See linkgit:githooks[5].
3017 receive.denyNonFastForwards::
3018 If set to true, git-receive-pack will deny a ref update which is
3019 not a fast-forward. Use this to prevent such an update via a push,
3020 even if that push is forced. This configuration variable is
3021 set when initializing a shared repository.
3023 receive.hideRefs::
3024 This variable is the same as `transfer.hideRefs`, but applies
3025 only to `receive-pack` (and so affects pushes, but not fetches).
3026 An attempt to update or delete a hidden ref by `git push` is
3027 rejected.
3029 receive.updateServerInfo::
3030 If set to true, git-receive-pack will run git-update-server-info
3031 after receiving data from git-push and updating refs.
3033 receive.shallowUpdate::
3034 If set to true, .git/shallow can be updated when new refs
3035 require new shallow roots. Otherwise those refs are rejected.
3037 remote.pushDefault::
3038 The remote to push to by default. Overrides
3039 `branch.<name>.remote` for all branches, and is overridden by
3040 `branch.<name>.pushRemote` for specific branches.
3042 remote.<name>.url::
3043 The URL of a remote repository. See linkgit:git-fetch[1] or
3044 linkgit:git-push[1].
3046 remote.<name>.pushurl::
3047 The push URL of a remote repository. See linkgit:git-push[1].
3049 remote.<name>.proxy::
3050 For remotes that require curl (http, https and ftp), the URL to
3051 the proxy to use for that remote. Set to the empty string to
3052 disable proxying for that remote.
3054 remote.<name>.proxyAuthMethod::
3055 For remotes that require curl (http, https and ftp), the method to use for
3056 authenticating against the proxy in use (probably set in
3057 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3059 remote.<name>.fetch::
3060 The default set of "refspec" for linkgit:git-fetch[1]. See
3061 linkgit:git-fetch[1].
3063 remote.<name>.push::
3064 The default set of "refspec" for linkgit:git-push[1]. See
3065 linkgit:git-push[1].
3067 remote.<name>.mirror::
3068 If true, pushing to this remote will automatically behave
3069 as if the `--mirror` option was given on the command line.
3071 remote.<name>.skipDefaultUpdate::
3072 If true, this remote will be skipped by default when updating
3073 using linkgit:git-fetch[1] or the `update` subcommand of
3074 linkgit:git-remote[1].
3076 remote.<name>.skipFetchAll::
3077 If true, this remote will be skipped by default when updating
3078 using linkgit:git-fetch[1] or the `update` subcommand of
3079 linkgit:git-remote[1].
3081 remote.<name>.receivepack::
3082 The default program to execute on the remote side when pushing. See
3083 option --receive-pack of linkgit:git-push[1].
3085 remote.<name>.uploadpack::
3086 The default program to execute on the remote side when fetching. See
3087 option --upload-pack of linkgit:git-fetch-pack[1].
3089 remote.<name>.tagOpt::
3090 Setting this value to --no-tags disables automatic tag following when
3091 fetching from remote <name>. Setting it to --tags will fetch every
3092 tag from remote <name>, even if they are not reachable from remote
3093 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3094 override this setting. See options --tags and --no-tags of
3095 linkgit:git-fetch[1].
3097 remote.<name>.vcs::
3098 Setting this to a value <vcs> will cause Git to interact with
3099 the remote with the git-remote-<vcs> helper.
3101 remote.<name>.prune::
3102 When set to true, fetching from this remote by default will also
3103 remove any remote-tracking references that no longer exist on the
3104 remote (as if the `--prune` option was given on the command line).
3105 Overrides `fetch.prune` settings, if any.
3107 remote.<name>.pruneTags::
3108 When set to true, fetching from this remote by default will also
3109 remove any local tags that no longer exist on the remote if pruning
3110 is activated in general via `remote.<name>.prune`, `fetch.prune` or
3111 `--prune`. Overrides `fetch.pruneTags` settings, if any.
3112 +
3113 See also `remote.<name>.prune` and the PRUNING section of
3114 linkgit:git-fetch[1].
3116 remotes.<group>::
3117 The list of remotes which are fetched by "git remote update
3118 <group>". See linkgit:git-remote[1].
3120 repack.useDeltaBaseOffset::
3121 By default, linkgit:git-repack[1] creates packs that use
3122 delta-base offset. If you need to share your repository with
3123 Git older than version 1.4.4, either directly or via a dumb
3124 protocol such as http, then you need to set this option to
3125 "false" and repack. Access from old Git versions over the
3126 native protocol are unaffected by this option.
3128 repack.packKeptObjects::
3129 If set to true, makes `git repack` act as if
3130 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3131 details. Defaults to `false` normally, but `true` if a bitmap
3132 index is being written (either via `--write-bitmap-index` or
3133 `repack.writeBitmaps`).
3135 repack.writeBitmaps::
3136 When true, git will write a bitmap index when packing all
3137 objects to disk (e.g., when `git repack -a` is run). This
3138 index can speed up the "counting objects" phase of subsequent
3139 packs created for clones and fetches, at the cost of some disk
3140 space and extra time spent on the initial repack. This has
3141 no effect if multiple packfiles are created.
3142 Defaults to false.
3144 rerere.autoUpdate::
3145 When set to true, `git-rerere` updates the index with the
3146 resulting contents after it cleanly resolves conflicts using
3147 previously recorded resolution. Defaults to false.
3149 rerere.enabled::
3150 Activate recording of resolved conflicts, so that identical
3151 conflict hunks can be resolved automatically, should they be
3152 encountered again. By default, linkgit:git-rerere[1] is
3153 enabled if there is an `rr-cache` directory under the
3154 `$GIT_DIR`, e.g. if "rerere" was previously used in the
3155 repository.
3157 sendemail.identity::
3158 A configuration identity. When given, causes values in the
3159 'sendemail.<identity>' subsection to take precedence over
3160 values in the 'sendemail' section. The default identity is
3161 the value of `sendemail.identity`.
3163 sendemail.smtpEncryption::
3164 See linkgit:git-send-email[1] for description. Note that this
3165 setting is not subject to the 'identity' mechanism.
3167 sendemail.smtpssl (deprecated)::
3168 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3170 sendemail.smtpsslcertpath::
3171 Path to ca-certificates (either a directory or a single file).
3172 Set it to an empty string to disable certificate verification.
3174 sendemail.<identity>.*::
3175 Identity-specific versions of the 'sendemail.*' parameters
3176 found below, taking precedence over those when this
3177 identity is selected, through either the command-line or
3178 `sendemail.identity`.
3180 sendemail.aliasesFile::
3181 sendemail.aliasFileType::
3182 sendemail.annotate::
3183 sendemail.bcc::
3184 sendemail.cc::
3185 sendemail.ccCmd::
3186 sendemail.chainReplyTo::
3187 sendemail.confirm::
3188 sendemail.envelopeSender::
3189 sendemail.from::
3190 sendemail.multiEdit::
3191 sendemail.signedoffbycc::
3192 sendemail.smtpPass::
3193 sendemail.suppresscc::
3194 sendemail.suppressFrom::
3195 sendemail.to::
3196 sendemail.tocmd::
3197 sendemail.smtpDomain::
3198 sendemail.smtpServer::
3199 sendemail.smtpServerPort::
3200 sendemail.smtpServerOption::
3201 sendemail.smtpUser::
3202 sendemail.thread::
3203 sendemail.transferEncoding::
3204 sendemail.validate::
3205 sendemail.xmailer::
3206 See linkgit:git-send-email[1] for description.
3208 sendemail.signedoffcc (deprecated)::
3209 Deprecated alias for `sendemail.signedoffbycc`.
3211 sendemail.smtpBatchSize::
3212 Number of messages to be sent per connection, after that a relogin
3213 will happen. If the value is 0 or undefined, send all messages in
3214 one connection.
3215 See also the `--batch-size` option of linkgit:git-send-email[1].
3217 sendemail.smtpReloginDelay::
3218 Seconds wait before reconnecting to smtp server.
3219 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3221 showbranch.default::
3222 The default set of branches for linkgit:git-show-branch[1].
3223 See linkgit:git-show-branch[1].
3225 splitIndex.maxPercentChange::
3226 When the split index feature is used, this specifies the
3227 percent of entries the split index can contain compared to the
3228 total number of entries in both the split index and the shared
3229 index before a new shared index is written.
3230 The value should be between 0 and 100. If the value is 0 then
3231 a new shared index is always written, if it is 100 a new
3232 shared index is never written.
3233 By default the value is 20, so a new shared index is written
3234 if the number of entries in the split index would be greater
3235 than 20 percent of the total number of entries.
3236 See linkgit:git-update-index[1].
3238 splitIndex.sharedIndexExpire::
3239 When the split index feature is used, shared index files that
3240 were not modified since the time this variable specifies will
3241 be removed when a new shared index file is created. The value
3242 "now" expires all entries immediately, and "never" suppresses
3243 expiration altogether.
3244 The default value is "2.weeks.ago".
3245 Note that a shared index file is considered modified (for the
3246 purpose of expiration) each time a new split-index file is
3247 either created based on it or read from it.
3248 See linkgit:git-update-index[1].
3250 status.relativePaths::
3251 By default, linkgit:git-status[1] shows paths relative to the
3252 current directory. Setting this variable to `false` shows paths
3253 relative to the repository root (this was the default for Git
3254 prior to v1.5.4).
3256 status.short::
3257 Set to true to enable --short by default in linkgit:git-status[1].
3258 The option --no-short takes precedence over this variable.
3260 status.branch::
3261 Set to true to enable --branch by default in linkgit:git-status[1].
3262 The option --no-branch takes precedence over this variable.
3264 status.displayCommentPrefix::
3265 If set to true, linkgit:git-status[1] will insert a comment
3266 prefix before each output line (starting with
3267 `core.commentChar`, i.e. `#` by default). This was the
3268 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3269 Defaults to false.
3271 status.renameLimit::
3272 The number of files to consider when performing rename detection
3273 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3274 the value of diff.renameLimit.
3276 status.renames::
3277 Whether and how Git detects renames in linkgit:git-status[1] and
3278 linkgit:git-commit[1] . If set to "false", rename detection is
3279 disabled. If set to "true", basic rename detection is enabled.
3280 If set to "copies" or "copy", Git will detect copies, as well.
3281 Defaults to the value of diff.renames.
3283 status.showStash::
3284 If set to true, linkgit:git-status[1] will display the number of
3285 entries currently stashed away.
3286 Defaults to false.
3288 status.showUntrackedFiles::
3289 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3290 files which are not currently tracked by Git. Directories which
3291 contain only untracked files, are shown with the directory name
3292 only. Showing untracked files means that Git needs to lstat() all
3293 the files in the whole repository, which might be slow on some
3294 systems. So, this variable controls how the commands displays
3295 the untracked files. Possible values are:
3296 +
3297 --
3298 * `no` - Show no untracked files.
3299 * `normal` - Show untracked files and directories.
3300 * `all` - Show also individual files in untracked directories.
3301 --
3302 +
3303 If this variable is not specified, it defaults to 'normal'.
3304 This variable can be overridden with the -u|--untracked-files option
3305 of linkgit:git-status[1] and linkgit:git-commit[1].
3307 status.submoduleSummary::
3308 Defaults to false.
3309 If this is set to a non zero number or true (identical to -1 or an
3310 unlimited number), the submodule summary will be enabled and a
3311 summary of commits for modified submodules will be shown (see
3312 --summary-limit option of linkgit:git-submodule[1]). Please note
3313 that the summary output command will be suppressed for all
3314 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3315 for those submodules where `submodule.<name>.ignore=all`. The only
3316 exception to that rule is that status and commit will show staged
3317 submodule changes. To
3318 also view the summary for ignored submodules you can either use
3319 the --ignore-submodules=dirty command-line option or the 'git
3320 submodule summary' command, which shows a similar output but does
3321 not honor these settings.
3323 stash.showPatch::
3324 If this is set to true, the `git stash show` command without an
3325 option will show the stash entry in patch form. Defaults to false.
3326 See description of 'show' command in linkgit:git-stash[1].
3328 stash.showStat::
3329 If this is set to true, the `git stash show` command without an
3330 option will show diffstat of the stash entry. Defaults to true.
3331 See description of 'show' command in linkgit:git-stash[1].
3333 submodule.<name>.url::
3334 The URL for a submodule. This variable is copied from the .gitmodules
3335 file to the git config via 'git submodule init'. The user can change
3336 the configured URL before obtaining the submodule via 'git submodule
3337 update'. If neither submodule.<name>.active or submodule.active are
3338 set, the presence of this variable is used as a fallback to indicate
3339 whether the submodule is of interest to git commands.
3340 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3342 submodule.<name>.update::
3343 The method by which a submodule is updated by 'git submodule update',
3344 which is the only affected command, others such as
3345 'git checkout --recurse-submodules' are unaffected. It exists for
3346 historical reasons, when 'git submodule' was the only command to
3347 interact with submodules; settings like `submodule.active`
3348 and `pull.rebase` are more specific. It is populated by
3349 `git submodule init` from the linkgit:gitmodules[5] file.
3350 See description of 'update' command in linkgit:git-submodule[1].
3352 submodule.<name>.branch::
3353 The remote branch name for a submodule, used by `git submodule
3354 update --remote`. Set this option to override the value found in
3355 the `.gitmodules` file. See linkgit:git-submodule[1] and
3356 linkgit:gitmodules[5] for details.
3358 submodule.<name>.fetchRecurseSubmodules::
3359 This option can be used to control recursive fetching of this
3360 submodule. It can be overridden by using the --[no-]recurse-submodules
3361 command-line option to "git fetch" and "git pull".
3362 This setting will override that from in the linkgit:gitmodules[5]
3363 file.
3365 submodule.<name>.ignore::
3366 Defines under what circumstances "git status" and the diff family show
3367 a submodule as modified. When set to "all", it will never be considered
3368 modified (but it will nonetheless show up in the output of status and
3369 commit when it has been staged), "dirty" will ignore all changes
3370 to the submodules work tree and
3371 takes only differences between the HEAD of the submodule and the commit
3372 recorded in the superproject into account. "untracked" will additionally
3373 let submodules with modified tracked files in their work tree show up.
3374 Using "none" (the default when this option is not set) also shows
3375 submodules that have untracked files in their work tree as changed.
3376 This setting overrides any setting made in .gitmodules for this submodule,
3377 both settings can be overridden on the command line by using the
3378 "--ignore-submodules" option. The 'git submodule' commands are not
3379 affected by this setting.
3381 submodule.<name>.active::
3382 Boolean value indicating if the submodule is of interest to git
3383 commands. This config option takes precedence over the
3384 submodule.active config option. See linkgit:gitsubmodules[7] for
3385 details.
3387 submodule.active::
3388 A repeated field which contains a pathspec used to match against a
3389 submodule's path to determine if the submodule is of interest to git
3390 commands. See linkgit:gitsubmodules[7] for details.
3392 submodule.recurse::
3393 Specifies if commands recurse into submodules by default. This
3394 applies to all commands that have a `--recurse-submodules` option,
3395 except `clone`.
3396 Defaults to false.
3398 submodule.fetchJobs::
3399 Specifies how many submodules are fetched/cloned at the same time.
3400 A positive integer allows up to that number of submodules fetched
3401 in parallel. A value of 0 will give some reasonable default.
3402 If unset, it defaults to 1.
3404 submodule.alternateLocation::
3405 Specifies how the submodules obtain alternates when submodules are
3406 cloned. Possible values are `no`, `superproject`.
3407 By default `no` is assumed, which doesn't add references. When the
3408 value is set to `superproject` the submodule to be cloned computes
3409 its alternates location relative to the superprojects alternate.
3411 submodule.alternateErrorStrategy::
3412 Specifies how to treat errors with the alternates for a submodule
3413 as computed via `submodule.alternateLocation`. Possible values are
3414 `ignore`, `info`, `die`. Default is `die`.
3416 tag.forceSignAnnotated::
3417 A boolean to specify whether annotated tags created should be GPG signed.
3418 If `--annotate` is specified on the command line, it takes
3419 precedence over this option.
3421 tag.sort::
3422 This variable controls the sort ordering of tags when displayed by
3423 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3424 value of this variable will be used as the default.
3426 tar.umask::
3427 This variable can be used to restrict the permission bits of
3428 tar archive entries. The default is 0002, which turns off the
3429 world write bit. The special value "user" indicates that the
3430 archiving user's umask will be used instead. See umask(2) and
3431 linkgit:git-archive[1].
3433 transfer.fsckObjects::
3434 When `fetch.fsckObjects` or `receive.fsckObjects` are
3435 not set, the value of this variable is used instead.
3436 Defaults to false.
3438 transfer.hideRefs::
3439 String(s) `receive-pack` and `upload-pack` use to decide which
3440 refs to omit from their initial advertisements. Use more than
3441 one definition to specify multiple prefix strings. A ref that is
3442 under the hierarchies listed in the value of this variable is
3443 excluded, and is hidden when responding to `git push` or `git
3444 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3445 program-specific versions of this config.
3446 +
3447 You may also include a `!` in front of the ref name to negate the entry,
3448 explicitly exposing it, even if an earlier entry marked it as hidden.
3449 If you have multiple hideRefs values, later entries override earlier ones
3450 (and entries in more-specific config files override less-specific ones).
3451 +
3452 If a namespace is in use, the namespace prefix is stripped from each
3453 reference before it is matched against `transfer.hiderefs` patterns.
3454 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3455 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3456 is omitted from the advertisements but `refs/heads/master` and
3457 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3458 "have" lines. In order to match refs before stripping, add a `^` in front of
3459 the ref name. If you combine `!` and `^`, `!` must be specified first.
3460 +
3461 Even if you hide refs, a client may still be able to steal the target
3462 objects via the techniques described in the "SECURITY" section of the
3463 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3464 separate repository.
3466 transfer.unpackLimit::
3467 When `fetch.unpackLimit` or `receive.unpackLimit` are
3468 not set, the value of this variable is used instead.
3469 The default value is 100.
3471 uploadarchive.allowUnreachable::
3472 If true, allow clients to use `git archive --remote` to request
3473 any tree, whether reachable from the ref tips or not. See the
3474 discussion in the "SECURITY" section of
3475 linkgit:git-upload-archive[1] for more details. Defaults to
3476 `false`.
3478 uploadpack.hideRefs::
3479 This variable is the same as `transfer.hideRefs`, but applies
3480 only to `upload-pack` (and so affects only fetches, not pushes).
3481 An attempt to fetch a hidden ref by `git fetch` will fail. See
3482 also `uploadpack.allowTipSHA1InWant`.
3484 uploadpack.allowTipSHA1InWant::
3485 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3486 to accept a fetch request that asks for an object at the tip
3487 of a hidden ref (by default, such a request is rejected).
3488 See also `uploadpack.hideRefs`. Even if this is false, a client
3489 may be able to steal objects via the techniques described in the
3490 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3491 best to keep private data in a separate repository.
3493 uploadpack.allowReachableSHA1InWant::
3494 Allow `upload-pack` to accept a fetch request that asks for an
3495 object that is reachable from any ref tip. However, note that
3496 calculating object reachability is computationally expensive.
3497 Defaults to `false`. Even if this is false, a client may be able
3498 to steal objects via the techniques described in the "SECURITY"
3499 section of the linkgit:gitnamespaces[7] man page; it's best to
3500 keep private data in a separate repository.
3502 uploadpack.allowAnySHA1InWant::
3503 Allow `upload-pack` to accept a fetch request that asks for any
3504 object at all.
3505 Defaults to `false`.
3507 uploadpack.keepAlive::
3508 When `upload-pack` has started `pack-objects`, there may be a
3509 quiet period while `pack-objects` prepares the pack. Normally
3510 it would output progress information, but if `--quiet` was used
3511 for the fetch, `pack-objects` will output nothing at all until
3512 the pack data begins. Some clients and networks may consider
3513 the server to be hung and give up. Setting this option instructs
3514 `upload-pack` to send an empty keepalive packet every
3515 `uploadpack.keepAlive` seconds. Setting this option to 0
3516 disables keepalive packets entirely. The default is 5 seconds.
3518 uploadpack.packObjectsHook::
3519 If this option is set, when `upload-pack` would run
3520 `git pack-objects` to create a packfile for a client, it will
3521 run this shell command instead. The `pack-objects` command and
3522 arguments it _would_ have run (including the `git pack-objects`
3523 at the beginning) are appended to the shell command. The stdin
3524 and stdout of the hook are treated as if `pack-objects` itself
3525 was run. I.e., `upload-pack` will feed input intended for
3526 `pack-objects` to the hook, and expects a completed packfile on
3527 stdout.
3529 uploadpack.allowFilter::
3530 If this option is set, `upload-pack` will support partial
3531 clone and partial fetch object filtering.
3532 +
3533 Note that this configuration variable is ignored if it is seen in the
3534 repository-level config (this is a safety measure against fetching from
3535 untrusted repositories).
3537 uploadpack.allowRefInWant::
3538 If this option is set, `upload-pack` will support the `ref-in-want`
3539 feature of the protocol version 2 `fetch` command. This feature
3540 is intended for the benefit of load-balanced servers which may
3541 not have the same view of what OIDs their refs point to due to
3542 replication delay.
3544 url.<base>.insteadOf::
3545 Any URL that starts with this value will be rewritten to
3546 start, instead, with <base>. In cases where some site serves a
3547 large number of repositories, and serves them with multiple
3548 access methods, and some users need to use different access
3549 methods, this feature allows people to specify any of the
3550 equivalent URLs and have Git automatically rewrite the URL to
3551 the best alternative for the particular user, even for a
3552 never-before-seen repository on the site. When more than one
3553 insteadOf strings match a given URL, the longest match is used.
3554 +
3555 Note that any protocol restrictions will be applied to the rewritten
3556 URL. If the rewrite changes the URL to use a custom protocol or remote
3557 helper, you may need to adjust the `protocol.*.allow` config to permit
3558 the request. In particular, protocols you expect to use for submodules
3559 must be set to `always` rather than the default of `user`. See the
3560 description of `protocol.allow` above.
3562 url.<base>.pushInsteadOf::
3563 Any URL that starts with this value will not be pushed to;
3564 instead, it will be rewritten to start with <base>, and the
3565 resulting URL will be pushed to. In cases where some site serves
3566 a large number of repositories, and serves them with multiple
3567 access methods, some of which do not allow push, this feature
3568 allows people to specify a pull-only URL and have Git
3569 automatically use an appropriate URL to push, even for a
3570 never-before-seen repository on the site. When more than one
3571 pushInsteadOf strings match a given URL, the longest match is
3572 used. If a remote has an explicit pushurl, Git will ignore this
3573 setting for that remote.
3575 user.email::
3576 Your email address to be recorded in any newly created commits.
3577 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3578 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3580 user.name::
3581 Your full name to be recorded in any newly created commits.
3582 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3583 environment variables. See linkgit:git-commit-tree[1].
3585 user.useConfigOnly::
3586 Instruct Git to avoid trying to guess defaults for `user.email`
3587 and `user.name`, and instead retrieve the values only from the
3588 configuration. For example, if you have multiple email addresses
3589 and would like to use a different one for each repository, then
3590 with this configuration option set to `true` in the global config
3591 along with a name, Git will prompt you to set up an email before
3592 making new commits in a newly cloned repository.
3593 Defaults to `false`.
3595 user.signingKey::
3596 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3597 key you want it to automatically when creating a signed tag or
3598 commit, you can override the default selection with this variable.
3599 This option is passed unchanged to gpg's --local-user parameter,
3600 so you may specify a key using any method that gpg supports.
3602 versionsort.prereleaseSuffix (deprecated)::
3603 Deprecated alias for `versionsort.suffix`. Ignored if
3604 `versionsort.suffix` is set.
3606 versionsort.suffix::
3607 Even when version sort is used in linkgit:git-tag[1], tagnames
3608 with the same base version but different suffixes are still sorted
3609 lexicographically, resulting e.g. in prerelease tags appearing
3610 after the main release (e.g. "1.0-rc1" after "1.0"). This
3611 variable can be specified to determine the sorting order of tags
3612 with different suffixes.
3613 +
3614 By specifying a single suffix in this variable, any tagname containing
3615 that suffix will appear before the corresponding main release. E.g. if
3616 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3617 "1.0". If specified multiple times, once per suffix, then the order of
3618 suffixes in the configuration will determine the sorting order of tagnames
3619 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3620 configuration, then all "1.0-preX" tags will be listed before any
3621 "1.0-rcX" tags. The placement of the main release tag relative to tags
3622 with various suffixes can be determined by specifying the empty suffix
3623 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3624 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3625 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3626 "v4.8-bfsX".
3627 +
3628 If more than one suffixes match the same tagname, then that tagname will
3629 be sorted according to the suffix which starts at the earliest position in
3630 the tagname. If more than one different matching suffixes start at
3631 that earliest position, then that tagname will be sorted according to the
3632 longest of those suffixes.
3633 The sorting order between different suffixes is undefined if they are
3634 in multiple config files.
3636 web.browser::
3637 Specify a web browser that may be used by some commands.
3638 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3639 may use it.
3641 worktree.guessRemote::
3642 With `add`, if no branch argument, and neither of `-b` nor
3643 `-B` nor `--detach` are given, the command defaults to
3644 creating a new branch from HEAD. If `worktree.guessRemote` is
3645 set to true, `worktree add` tries to find a remote-tracking
3646 branch whose name uniquely matches the new branch name. If
3647 such a branch exists, it is checked out and set as "upstream"
3648 for the new branch. If no such match can be found, it falls
3649 back to creating a new branch from the current HEAD.