Merge branch 'sm/branch-sort-config'
[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 ""
183 gitProxy=default-proxy ; for the rest
185 [include]
186 path = /path/to/ ; include by absolute path
187 path = ; find "" relative to the current file
188 path = ~/ ; find "" 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/
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/
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 =
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 When missing or is set to `default`, many fields in the stat
466 structure are checked to detect if a file has been modified
467 since Git looked at it. When this configuration variable is
468 set to `minimal`, sub-second part of mtime and ctime, the
469 uid and gid of the owner of the file, the inode number (and
470 the device number, if Git was compiled to use it), are
471 excluded from the check among these fields, leaving only the
472 whole-second part of mtime (and ctime, if `core.trustCtime`
473 is set) and the filesize to be checked.
474 +
475 There are implementations of Git that do not leave usable values in
476 some fields (e.g. JGit); by excluding these fields from the
477 comparison, the `minimal` mode may help interoperability when the
478 same repository is used by these other systems at the same time.
480 core.quotePath::
481 Commands that output paths (e.g. 'ls-files', 'diff'), will
482 quote "unusual" characters in the pathname by enclosing the
483 pathname in double-quotes and escaping those characters with
484 backslashes in the same way C escapes control characters (e.g.
485 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
486 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
487 UTF-8). If this variable is set to false, bytes higher than
488 0x80 are not considered "unusual" any more. Double-quotes,
489 backslash and control characters are always escaped regardless
490 of the setting of this variable. A simple space character is
491 not considered "unusual". Many commands can output pathnames
492 completely verbatim using the `-z` option. The default value
493 is true.
495 core.eol::
496 Sets the line ending type to use in the working directory for
497 files that have the `text` property set when core.autocrlf is false.
498 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
499 native line ending. The default value is `native`. See
500 linkgit:gitattributes[5] for more information on end-of-line
501 conversion.
503 core.safecrlf::
504 If true, makes Git check if converting `CRLF` is reversible when
505 end-of-line conversion is active. Git will verify if a command
506 modifies a file in the work tree either directly or indirectly.
507 For example, committing a file followed by checking out the
508 same file should yield the original file in the work tree. If
509 this is not the case for the current setting of
510 `core.autocrlf`, Git will reject the file. The variable can
511 be set to "warn", in which case Git will only warn about an
512 irreversible conversion but continue the operation.
513 +
514 CRLF conversion bears a slight chance of corrupting data.
515 When it is enabled, Git will convert CRLF to LF during commit and LF to
516 CRLF during checkout. A file that contains a mixture of LF and
517 CRLF before the commit cannot be recreated by Git. For text
518 files this is the right thing to do: it corrects line endings
519 such that we have only LF line endings in the repository.
520 But for binary files that are accidentally classified as text the
521 conversion can corrupt data.
522 +
523 If you recognize such corruption early you can easily fix it by
524 setting the conversion type explicitly in .gitattributes. Right
525 after committing you still have the original file in your work
526 tree and this file is not yet corrupted. You can explicitly tell
527 Git that this file is binary and Git will handle the file
528 appropriately.
529 +
530 Unfortunately, the desired effect of cleaning up text files with
531 mixed line endings and the undesired effect of corrupting binary
532 files cannot be distinguished. In both cases CRLFs are removed
533 in an irreversible way. For text files this is the right thing
534 to do because CRLFs are line endings, while for binary files
535 converting CRLFs corrupts data.
536 +
537 Note, this safety check does not mean that a checkout will generate a
538 file identical to the original file for a different setting of
539 `core.eol` and `core.autocrlf`, but only for the current one. For
540 example, a text file with `LF` would be accepted with `core.eol=lf`
541 and could later be checked out with `core.eol=crlf`, in which case the
542 resulting file would contain `CRLF`, although the original file
543 contained `LF`. However, in both work trees the line endings would be
544 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
545 file with mixed line endings would be reported by the `core.safecrlf`
546 mechanism.
548 core.autocrlf::
549 Setting this variable to "true" is the same as setting
550 the `text` attribute to "auto" on all files and core.eol to "crlf".
551 Set to true if you want to have `CRLF` line endings in your
552 working directory and the repository has LF line endings.
553 This variable can be set to 'input',
554 in which case no output conversion is performed.
556 core.checkRoundtripEncoding::
557 A comma and/or whitespace separated list of encodings that Git
558 performs UTF-8 round trip checks on if they are used in an
559 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
560 The default value is `SHIFT-JIS`.
562 core.symlinks::
563 If false, symbolic links are checked out as small plain files that
564 contain the link text. linkgit:git-update-index[1] and
565 linkgit:git-add[1] will not change the recorded type to regular
566 file. Useful on filesystems like FAT that do not support
567 symbolic links.
568 +
569 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
570 will probe and set core.symlinks false if appropriate when the repository
571 is created.
573 core.gitProxy::
574 A "proxy command" to execute (as 'command host port') instead
575 of establishing direct connection to the remote server when
576 using the Git protocol for fetching. If the variable value is
577 in the "COMMAND for DOMAIN" format, the command is applied only
578 on hostnames ending with the specified domain string. This variable
579 may be set multiple times and is matched in the given order;
580 the first match wins.
581 +
582 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
583 (which always applies universally, without the special "for"
584 handling).
585 +
586 The special string `none` can be used as the proxy command to
587 specify that no proxy be used for a given domain pattern.
588 This is useful for excluding servers inside a firewall from
589 proxy use, while defaulting to a common proxy for external domains.
591 core.sshCommand::
592 If this variable is set, `git fetch` and `git push` will
593 use the specified command instead of `ssh` when they need to
594 connect to a remote system. The command is in the same form as
595 the `GIT_SSH_COMMAND` environment variable and is overridden
596 when the environment variable is set.
598 core.ignoreStat::
599 If true, Git will avoid using lstat() calls to detect if files have
600 changed by setting the "assume-unchanged" bit for those tracked files
601 which it has updated identically in both the index and working tree.
602 +
603 When files are modified outside of Git, the user will need to stage
604 the modified files explicitly (e.g. see 'Examples' section in
605 linkgit:git-update-index[1]).
606 Git will not normally detect changes to those files.
607 +
608 This is useful on systems where lstat() calls are very slow, such as
609 CIFS/Microsoft Windows.
610 +
611 False by default.
613 core.preferSymlinkRefs::
614 Instead of the default "symref" format for HEAD
615 and other symbolic reference files, use symbolic links.
616 This is sometimes needed to work with old scripts that
617 expect HEAD to be a symbolic link.
619 core.bare::
620 If true this repository is assumed to be 'bare' and has no
621 working directory associated with it. If this is the case a
622 number of commands that require a working directory will be
623 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
624 +
625 This setting is automatically guessed by linkgit:git-clone[1] or
626 linkgit:git-init[1] when the repository was created. By default a
627 repository that ends in "/.git" is assumed to be not bare (bare =
628 false), while all other repositories are assumed to be bare (bare
629 = true).
631 core.worktree::
632 Set the path to the root of the working tree.
633 If `GIT_COMMON_DIR` environment variable is set, core.worktree
634 is ignored and not used for determining the root of working tree.
635 This can be overridden by the `GIT_WORK_TREE` environment
636 variable and the `--work-tree` command-line option.
637 The value can be an absolute path or relative to the path to
638 the .git directory, which is either specified by --git-dir
639 or GIT_DIR, or automatically discovered.
640 If --git-dir or GIT_DIR is specified but none of
641 --work-tree, GIT_WORK_TREE and core.worktree is specified,
642 the current working directory is regarded as the top level
643 of your working tree.
644 +
645 Note that this variable is honored even when set in a configuration
646 file in a ".git" subdirectory of a directory and its value differs
647 from the latter directory (e.g. "/path/to/.git/config" has
648 core.worktree set to "/different/path"), which is most likely a
649 misconfiguration. Running Git commands in the "/path/to" directory will
650 still use "/different/path" as the root of the work tree and can cause
651 confusion unless you know what you are doing (e.g. you are creating a
652 read-only snapshot of the same index to a location different from the
653 repository's usual working tree).
655 core.logAllRefUpdates::
656 Enable the reflog. Updates to a ref <ref> is logged to the file
657 "`$GIT_DIR/logs/<ref>`", by appending the new and old
658 SHA-1, the date/time and the reason of the update, but
659 only when the file exists. If this configuration
660 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
661 file is automatically created for branch heads (i.e. under
662 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
663 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
664 If it is set to `always`, then a missing reflog is automatically
665 created for any ref under `refs/`.
666 +
667 This information can be used to determine what commit
668 was the tip of a branch "2 days ago".
669 +
670 This value is true by default in a repository that has
671 a working directory associated with it, and false by
672 default in a bare repository.
674 core.repositoryFormatVersion::
675 Internal variable identifying the repository format and layout
676 version.
678 core.sharedRepository::
679 When 'group' (or 'true'), the repository is made shareable between
680 several users in a group (making sure all the files and objects are
681 group-writable). When 'all' (or 'world' or 'everybody'), the
682 repository will be readable by all users, additionally to being
683 group-shareable. When 'umask' (or 'false'), Git will use permissions
684 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
685 files in the repository will have this mode value. '0xxx' will override
686 user's umask value (whereas the other options will only override
687 requested parts of the user's umask value). Examples: '0660' will make
688 the repo read/write-able for the owner and group, but inaccessible to
689 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
690 repository that is group-readable but not group-writable.
691 See linkgit:git-init[1]. False by default.
693 core.warnAmbiguousRefs::
694 If true, Git will warn you if the ref name you passed it is ambiguous
695 and might match multiple refs in the repository. True by default.
697 core.compression::
698 An integer -1..9, indicating a default compression level.
699 -1 is the zlib default. 0 means no compression,
700 and 1..9 are various speed/size tradeoffs, 9 being slowest.
701 If set, this provides a default to other compression variables,
702 such as `core.looseCompression` and `pack.compression`.
704 core.looseCompression::
705 An integer -1..9, indicating the compression level for objects that
706 are not in a pack file. -1 is the zlib default. 0 means no
707 compression, and 1..9 are various speed/size tradeoffs, 9 being
708 slowest. If not set, defaults to core.compression. If that is
709 not set, defaults to 1 (best speed).
711 core.packedGitWindowSize::
712 Number of bytes of a pack file to map into memory in a
713 single mapping operation. Larger window sizes may allow
714 your system to process a smaller number of large pack files
715 more quickly. Smaller window sizes will negatively affect
716 performance due to increased calls to the operating system's
717 memory manager, but may improve performance when accessing
718 a large number of large pack files.
719 +
720 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
721 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
722 be reasonable for all users/operating systems. You probably do
723 not need to adjust this value.
724 +
725 Common unit suffixes of 'k', 'm', or 'g' are supported.
727 core.packedGitLimit::
728 Maximum number of bytes to map simultaneously into memory
729 from pack files. If Git needs to access more than this many
730 bytes at once to complete an operation it will unmap existing
731 regions to reclaim virtual address space within the process.
732 +
733 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
734 unlimited) on 64 bit platforms.
735 This should be reasonable for all users/operating systems, except on
736 the largest projects. You probably do not need to adjust this value.
737 +
738 Common unit suffixes of 'k', 'm', or 'g' are supported.
740 core.deltaBaseCacheLimit::
741 Maximum number of bytes to reserve for caching base objects
742 that may be referenced by multiple deltified objects. By storing the
743 entire decompressed base objects in a cache Git is able
744 to avoid unpacking and decompressing frequently used base
745 objects multiple times.
746 +
747 Default is 96 MiB on all platforms. This should be reasonable
748 for all users/operating systems, except on the largest projects.
749 You probably do not need to adjust this value.
750 +
751 Common unit suffixes of 'k', 'm', or 'g' are supported.
753 core.bigFileThreshold::
754 Files larger than this size are stored deflated, without
755 attempting delta compression. Storing large files without
756 delta compression avoids excessive memory usage, at the
757 slight expense of increased disk usage. Additionally files
758 larger than this size are always treated as binary.
759 +
760 Default is 512 MiB on all platforms. This should be reasonable
761 for most projects as source code and other text files can still
762 be delta compressed, but larger binary media files won't be.
763 +
764 Common unit suffixes of 'k', 'm', or 'g' are supported.
766 core.excludesFile::
767 Specifies the pathname to the file that contains patterns to
768 describe paths that are not meant to be tracked, in addition
769 to '.gitignore' (per-directory) and '.git/info/exclude'.
770 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
771 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
772 is used instead. See linkgit:gitignore[5].
774 core.askPass::
775 Some commands (e.g. svn and http interfaces) that interactively
776 ask for a password can be told to use an external program given
777 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
778 environment variable. If not set, fall back to the value of the
779 `SSH_ASKPASS` environment variable or, failing that, a simple password
780 prompt. The external program shall be given a suitable prompt as
781 command-line argument and write the password on its STDOUT.
783 core.attributesFile::
784 In addition to '.gitattributes' (per-directory) and
785 '.git/info/attributes', Git looks into this file for attributes
786 (see linkgit:gitattributes[5]). Path expansions are made the same
787 way as for `core.excludesFile`. Its default value is
788 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
789 set or empty, `$HOME/.config/git/attributes` is used instead.
791 core.hooksPath::
792 By default Git will look for your hooks in the
793 '$GIT_DIR/hooks' directory. Set this to different path,
794 e.g. '/etc/git/hooks', and Git will try to find your hooks in
795 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
796 in '$GIT_DIR/hooks/pre-receive'.
797 +
798 The path can be either absolute or relative. A relative path is
799 taken as relative to the directory where the hooks are run (see
800 the "DESCRIPTION" section of linkgit:githooks[5]).
801 +
802 This configuration variable is useful in cases where you'd like to
803 centrally configure your Git hooks instead of configuring them on a
804 per-repository basis, or as a more flexible and centralized
805 alternative to having an `init.templateDir` where you've changed
806 default hooks.
808 core.editor::
809 Commands such as `commit` and `tag` that let you edit
810 messages by launching an editor use the value of this
811 variable when it is set, and the environment variable
812 `GIT_EDITOR` is not set. See linkgit:git-var[1].
814 core.commentChar::
815 Commands such as `commit` and `tag` that let you edit
816 messages consider a line that begins with this character
817 commented, and removes them after the editor returns
818 (default '#').
819 +
820 If set to "auto", `git-commit` would select a character that is not
821 the beginning character of any line in existing commit messages.
823 core.filesRefLockTimeout::
824 The length of time, in milliseconds, to retry when trying to
825 lock an individual reference. Value 0 means not to retry at
826 all; -1 means to try indefinitely. Default is 100 (i.e.,
827 retry for 100ms).
829 core.packedRefsTimeout::
830 The length of time, in milliseconds, to retry when trying to
831 lock the `packed-refs` file. Value 0 means not to retry at
832 all; -1 means to try indefinitely. Default is 1000 (i.e.,
833 retry for 1 second).
835 sequence.editor::
836 Text editor used by `git rebase -i` for editing the rebase instruction file.
837 The value is meant to be interpreted by the shell when it is used.
838 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
839 When not configured the default commit message editor is used instead.
841 core.pager::
842 Text viewer for use by Git commands (e.g., 'less'). The value
843 is meant to be interpreted by the shell. The order of preference
844 is the `$GIT_PAGER` environment variable, then `core.pager`
845 configuration, then `$PAGER`, and then the default chosen at
846 compile time (usually 'less').
847 +
848 When the `LESS` environment variable is unset, Git sets it to `FRX`
849 (if `LESS` environment variable is set, Git does not change it at
850 all). If you want to selectively override Git's default setting
851 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
852 be passed to the shell by Git, which will translate the final
853 command to `LESS=FRX less -S`. The environment does not set the
854 `S` option but the command line does, instructing less to truncate
855 long lines. Similarly, setting `core.pager` to `less -+F` will
856 deactivate the `F` option specified by the environment from the
857 command-line, deactivating the "quit if one screen" behavior of
858 `less`. One can specifically activate some flags for particular
859 commands: for example, setting `pager.blame` to `less -S` enables
860 line truncation only for `git blame`.
861 +
862 Likewise, when the `LV` environment variable is unset, Git sets it
863 to `-c`. You can override this setting by exporting `LV` with
864 another value or setting `core.pager` to `lv +c`.
866 core.whitespace::
867 A comma separated list of common whitespace problems to
868 notice. 'git diff' will use `color.diff.whitespace` to
869 highlight them, and 'git apply --whitespace=error' will
870 consider them as errors. You can prefix `-` to disable
871 any of them (e.g. `-trailing-space`):
872 +
873 * `blank-at-eol` treats trailing whitespaces at the end of the line
874 as an error (enabled by default).
875 * `space-before-tab` treats a space character that appears immediately
876 before a tab character in the initial indent part of the line as an
877 error (enabled by default).
878 * `indent-with-non-tab` treats a line that is indented with space
879 characters instead of the equivalent tabs as an error (not enabled by
880 default).
881 * `tab-in-indent` treats a tab character in the initial indent part of
882 the line as an error (not enabled by default).
883 * `blank-at-eof` treats blank lines added at the end of file as an error
884 (enabled by default).
885 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
886 `blank-at-eof`.
887 * `cr-at-eol` treats a carriage-return at the end of line as
888 part of the line terminator, i.e. with it, `trailing-space`
889 does not trigger if the character before such a carriage-return
890 is not a whitespace (not enabled by default).
891 * `tabwidth=<n>` tells how many character positions a tab occupies; this
892 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
893 errors. The default tab width is 8. Allowed values are 1 to 63.
895 core.fsyncObjectFiles::
896 This boolean will enable 'fsync()' when writing object files.
897 +
898 This is a total waste of time and effort on a filesystem that orders
899 data writes properly, but can be useful for filesystems that do not use
900 journalling (traditional UNIX filesystems) or that only journal metadata
901 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
903 core.preloadIndex::
904 Enable parallel index preload for operations like 'git diff'
905 +
906 This can speed up operations like 'git diff' and 'git status' especially
907 on filesystems like NFS that have weak caching semantics and thus
908 relatively high IO latencies. When enabled, Git will do the
909 index comparison to the filesystem data in parallel, allowing
910 overlapping IO's. Defaults to true.
912 core.createObject::
913 You can set this to 'link', in which case a hardlink followed by
914 a delete of the source are used to make sure that object creation
915 will not overwrite existing objects.
916 +
917 On some file system/operating system combinations, this is unreliable.
918 Set this config setting to 'rename' there; However, This will remove the
919 check that makes sure that existing object files will not get overwritten.
921 core.notesRef::
922 When showing commit messages, also show notes which are stored in
923 the given ref. The ref must be fully qualified. If the given
924 ref does not exist, it is not an error but means that no
925 notes should be printed.
926 +
927 This setting defaults to "refs/notes/commits", and it can be overridden by
928 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
930 gc.commitGraph::
931 If true, then gc will rewrite the commit-graph file when
932 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
933 '--auto' the commit-graph will be updated if housekeeping is
934 required. Default is false. See linkgit:git-commit-graph[1]
935 for details.
937 core.useReplaceRefs::
938 If set to `false`, behave as if the `--no-replace-objects`
939 option was given on the command line. See linkgit:git[1] and
940 linkgit:git-replace[1] for more information.
942 core.sparseCheckout::
943 Enable "sparse checkout" feature. See section "Sparse checkout" in
944 linkgit:git-read-tree[1] for more information.
946 core.abbrev::
947 Set the length object names are abbreviated to. If
948 unspecified or set to "auto", an appropriate value is
949 computed based on the approximate number of packed objects
950 in your repository, which hopefully is enough for
951 abbreviated object names to stay unique for some time.
952 The minimum length is 4.
954 add.ignoreErrors::
955 add.ignore-errors (deprecated)::
956 Tells 'git add' to continue adding files when some files cannot be
957 added due to indexing errors. Equivalent to the `--ignore-errors`
958 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
959 as it does not follow the usual naming convention for configuration
960 variables.
962 alias.*::
963 Command aliases for the linkgit:git[1] command wrapper - e.g.
964 after defining "alias.last = cat-file commit HEAD", the invocation
965 "git last" is equivalent to "git cat-file commit HEAD". To avoid
966 confusion and troubles with script usage, aliases that
967 hide existing Git commands are ignored. Arguments are split by
968 spaces, the usual shell quoting and escaping is supported.
969 A quote pair or a backslash can be used to quote them.
970 +
971 If the alias expansion is prefixed with an exclamation point,
972 it will be treated as a shell command. For example, defining
973 " = !gitk --all --not ORIG_HEAD", the invocation
974 "git new" is equivalent to running the shell command
975 "gitk --all --not ORIG_HEAD". Note that shell commands will be
976 executed from the top-level directory of a repository, which may
977 not necessarily be the current directory.
978 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
979 from the original current directory. See linkgit:git-rev-parse[1].
981 am.keepcr::
982 If true, git-am will call git-mailsplit for patches in mbox format
983 with parameter `--keep-cr`. In this case git-mailsplit will
984 not remove `\r` from lines ending with `\r\n`. Can be overridden
985 by giving `--no-keep-cr` from the command line.
986 See linkgit:git-am[1], linkgit:git-mailsplit[1].
988 am.threeWay::
989 By default, `git am` will fail if the patch does not apply cleanly. When
990 set to true, this setting tells `git am` to fall back on 3-way merge if
991 the patch records the identity of blobs it is supposed to apply to and
992 we have those blobs available locally (equivalent to giving the `--3way`
993 option from the command line). Defaults to `false`.
994 See linkgit:git-am[1].
996 apply.ignoreWhitespace::
997 When set to 'change', tells 'git apply' to ignore changes in
998 whitespace, in the same way as the `--ignore-space-change`
999 option.
1000 When set to one of: no, none, never, false tells 'git apply' to
1001 respect all whitespace differences.
1002 See linkgit:git-apply[1].
1004 apply.whitespace::
1005 Tells 'git apply' how to handle whitespaces, in the same way
1006 as the `--whitespace` option. See linkgit:git-apply[1].
1008 blame.blankBoundary::
1009 Show blank commit object name for boundary commits in
1010 linkgit:git-blame[1]. This option defaults to false.
1012 blame.coloring::
1013 This determines the coloring scheme to be applied to blame
1014 output. It can be 'repeatedLines', 'highlightRecent',
1015 or 'none' which is the default.
1018 Specifies the format used to output dates in linkgit:git-blame[1].
1019 If unset the iso format is used. For supported values,
1020 see the discussion of the `--date` option at linkgit:git-log[1].
1022 blame.showEmail::
1023 Show the author email instead of author name in linkgit:git-blame[1].
1024 This option defaults to false.
1026 blame.showRoot::
1027 Do not treat root commits as boundaries in linkgit:git-blame[1].
1028 This option defaults to false.
1030 branch.autoSetupMerge::
1031 Tells 'git branch' and 'git checkout' to set up new branches
1032 so that linkgit:git-pull[1] will appropriately merge from the
1033 starting point branch. Note that even if this option is not set,
1034 this behavior can be chosen per-branch using the `--track`
1035 and `--no-track` options. The valid settings are: `false` -- no
1036 automatic setup is done; `true` -- automatic setup is done when the
1037 starting point is a remote-tracking branch; `always` --
1038 automatic setup is done when the starting point is either a
1039 local branch or remote-tracking
1040 branch. This option defaults to true.
1042 branch.autoSetupRebase::
1043 When a new branch is created with 'git branch' or 'git checkout'
1044 that tracks another branch, this variable tells Git to set
1045 up pull to rebase instead of merge (see "branch.<name>.rebase").
1046 When `never`, rebase is never automatically set to true.
1047 When `local`, rebase is set to true for tracked branches of
1048 other local branches.
1049 When `remote`, rebase is set to true for tracked branches of
1050 remote-tracking branches.
1051 When `always`, rebase will be set to true for all tracking
1052 branches.
1053 See "branch.autoSetupMerge" for details on how to set up a
1054 branch to track another branch.
1055 This option defaults to never.
1057 branch.sort::
1058 This variable controls the sort ordering of branches when displayed by
1059 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1060 value of this variable will be used as the default.
1061 See linkgit:git-for-each-ref[1] field names for valid values.
1063 branch.<name>.remote::
1064 When on branch <name>, it tells 'git fetch' and 'git push'
1065 which remote to fetch from/push to. The remote to push to
1066 may be overridden with `remote.pushDefault` (for all branches).
1067 The remote to push to, for the current branch, may be further
1068 overridden by `branch.<name>.pushRemote`. If no remote is
1069 configured, or if you are not on any branch, it defaults to
1070 `origin` for fetching and `remote.pushDefault` for pushing.
1071 Additionally, `.` (a period) is the current local repository
1072 (a dot-repository), see `branch.<name>.merge`'s final note below.
1074 branch.<name>.pushRemote::
1075 When on branch <name>, it overrides `branch.<name>.remote` for
1076 pushing. It also overrides `remote.pushDefault` for pushing
1077 from branch <name>. When you pull from one place (e.g. your
1078 upstream) and push to another place (e.g. your own publishing
1079 repository), you would want to set `remote.pushDefault` to
1080 specify the remote to push to for all branches, and use this
1081 option to override it for a specific branch.
1083 branch.<name>.merge::
1084 Defines, together with branch.<name>.remote, the upstream branch
1085 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1086 branch to merge and can also affect 'git push' (see push.default).
1087 When in branch <name>, it tells 'git fetch' the default
1088 refspec to be marked for merging in FETCH_HEAD. The value is
1089 handled like the remote part of a refspec, and must match a
1090 ref which is fetched from the remote given by
1091 "branch.<name>.remote".
1092 The merge information is used by 'git pull' (which at first calls
1093 'git fetch') to lookup the default branch for merging. Without
1094 this option, 'git pull' defaults to merge the first refspec fetched.
1095 Specify multiple values to get an octopus merge.
1096 If you wish to setup 'git pull' so that it merges into <name> from
1097 another branch in the local repository, you can point
1098 branch.<name>.merge to the desired branch, and use the relative path
1099 setting `.` (a period) for branch.<name>.remote.
1101 branch.<name>.mergeOptions::
1102 Sets default options for merging into branch <name>. The syntax and
1103 supported options are the same as those of linkgit:git-merge[1], but
1104 option values containing whitespace characters are currently not
1105 supported.
1107 branch.<name>.rebase::
1108 When true, rebase the branch <name> on top of the fetched branch,
1109 instead of merging the default branch from the default remote when
1110 "git pull" is run. See "pull.rebase" for doing this in a non
1111 branch-specific manner.
1112 +
1113 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1114 so that the local merge commits are included in the rebase (see
1115 linkgit:git-rebase[1] for details).
1116 +
1117 When preserve, also pass `--preserve-merges` along to 'git rebase'
1118 so that locally committed merge commits will not be flattened
1119 by running 'git pull'.
1120 +
1121 When the value is `interactive`, the rebase is run in interactive mode.
1122 +
1123 *NOTE*: this is a possibly dangerous operation; do *not* use
1124 it unless you understand the implications (see linkgit:git-rebase[1]
1125 for details).
1127 branch.<name>.description::
1128 Branch description, can be edited with
1129 `git branch --edit-description`. Branch description is
1130 automatically added in the format-patch cover letter or
1131 request-pull summary.
1133 browser.<tool>.cmd::
1134 Specify the command to invoke the specified browser. The
1135 specified command is evaluated in shell with the URLs passed
1136 as arguments. (See linkgit:git-web{litdd}browse[1].)
1138 browser.<tool>.path::
1139 Override the path for the given tool that may be used to
1140 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1141 working repository in gitweb (see linkgit:git-instaweb[1]).
1143 checkout.defaultRemote::
1144 When you run 'git checkout <something>' and only have one
1145 remote, it may implicitly fall back on checking out and
1146 tracking e.g. 'origin/<something>'. This stops working as soon
1147 as you have more than one remote with a '<something>'
1148 reference. This setting allows for setting the name of a
1149 preferred remote that should always win when it comes to
1150 disambiguation. The typical use-case is to set this to
1151 `origin`.
1152 +
1153 Currently this is used by linkgit:git-checkout[1] when 'git checkout
1154 <something>' will checkout the '<something>' branch on another remote,
1155 and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1156 remote branch. This setting might be used for other checkout-like
1157 commands or functionality in the future.
1159 clean.requireForce::
1160 A boolean to make git-clean do nothing unless given -f,
1161 -i or -n. Defaults to true.
1163 color.advice::
1164 A boolean to enable/disable color in hints (e.g. when a push
1165 failed, see `advice.*` for a list). May be set to `always`,
1166 `false` (or `never`) or `auto` (or `true`), in which case colors
1167 are used only when the error output goes to a terminal. If
1168 unset, then the value of `color.ui` is used (`auto` by default).
1170 color.advice.hint::
1171 Use customized color for hints.
1173 color.blame.highlightRecent::
1174 This can be used to color the metadata of a blame line depending
1175 on age of the line.
1176 +
1177 This setting should be set to a comma-separated list of color and date settings,
1178 starting and ending with a color, the dates should be set from oldest to newest.
1179 The metadata will be colored given the colors if the the line was introduced
1180 before the given timestamp, overwriting older timestamped colors.
1181 +
1182 Instead of an absolute timestamp relative timestamps work as well, e.g.
1183 2.weeks.ago is valid to address anything older than 2 weeks.
1184 +
1185 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1186 everything older than one year blue, recent changes between one month and
1187 one year old are kept white, and lines introduced within the last month are
1188 colored red.
1190 color.blame.repeatedLines::
1191 Use the customized color for the part of git-blame output that
1192 is repeated meta information per line (such as commit id,
1193 author name, date and timezone). Defaults to cyan.
1195 color.branch::
1196 A boolean to enable/disable color in the output of
1197 linkgit:git-branch[1]. May be set to `always`,
1198 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1199 only when the output is to a terminal. If unset, then the
1200 value of `color.ui` is used (`auto` by default).
1202 color.branch.<slot>::
1203 Use customized color for branch coloration. `<slot>` is one of
1204 `current` (the current branch), `local` (a local branch),
1205 `remote` (a remote-tracking branch in refs/remotes/),
1206 `upstream` (upstream tracking branch), `plain` (other
1207 refs).
1209 color.diff::
1210 Whether to use ANSI escape sequences to add color to patches.
1211 If this is set to `always`, linkgit:git-diff[1],
1212 linkgit:git-log[1], and linkgit:git-show[1] will use color
1213 for all patches. If it is set to `true` or `auto`, those
1214 commands will only use color when output is to the terminal.
1215 If unset, then the value of `color.ui` is used (`auto` by
1216 default).
1217 +
1218 This does not affect linkgit:git-format-patch[1] or the
1219 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1220 command line with the `--color[=<when>]` option.
1222 diff.colorMoved::
1223 If set to either a valid `<mode>` or a true value, moved lines
1224 in a diff are colored differently, for details of valid modes
1225 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1226 true the default color mode will be used. When set to false,
1227 moved lines are not colored.
1229 diff.colorMovedWS::
1230 When moved lines are colored using e.g. the `diff.colorMoved` setting,
1231 this option controls the `<mode>` how spaces are treated
1232 for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].
1234 color.diff.<slot>::
1235 Use customized color for diff colorization. `<slot>` specifies
1236 which part of the patch to use the specified color, and is one
1237 of `context` (context text - `plain` is a historical synonym),
1238 `meta` (metainformation), `frag`
1239 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1240 `new` (added lines), `commit` (commit headers), `whitespace`
1241 (highlighting whitespace errors), `oldMoved` (deleted lines),
1242 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1243 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1244 `newMovedAlternativeDimmed` (See the '<mode>'
1245 setting of '--color-moved' in linkgit:git-diff[1] for details),
1246 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1247 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1249 color.decorate.<slot>::
1250 Use customized color for 'git log --decorate' output. `<slot>` is one
1251 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1252 branches, remote-tracking branches, tags, stash and HEAD, respectively
1253 and `grafted` for grafted commits.
1255 color.grep::
1256 When set to `always`, always highlight matches. When `false` (or
1257 `never`), never. When set to `true` or `auto`, use color only
1258 when the output is written to the terminal. If unset, then the
1259 value of `color.ui` is used (`auto` by default).
1261 color.grep.<slot>::
1262 Use customized color for grep colorization. `<slot>` specifies which
1263 part of the line to use the specified color, and is one of
1264 +
1265 --
1266 `context`;;
1267 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1268 `filename`;;
1269 filename prefix (when not using `-h`)
1270 `function`;;
1271 function name lines (when using `-p`)
1272 `lineNumber`;;
1273 line number prefix (when using `-n`)
1274 `column`;;
1275 column number prefix (when using `--column`)
1276 `match`;;
1277 matching text (same as setting `matchContext` and `matchSelected`)
1278 `matchContext`;;
1279 matching text in context lines
1280 `matchSelected`;;
1281 matching text in selected lines
1282 `selected`;;
1283 non-matching text in selected lines
1284 `separator`;;
1285 separators between fields on a line (`:`, `-`, and `=`)
1286 and between hunks (`--`)
1287 --
1289 color.interactive::
1290 When set to `always`, always use colors for interactive prompts
1291 and displays (such as those used by "git-add --interactive" and
1292 "git-clean --interactive"). When false (or `never`), never.
1293 When set to `true` or `auto`, use colors only when the output is
1294 to the terminal. If unset, then the value of `color.ui` is
1295 used (`auto` by default).
1297 color.interactive.<slot>::
1298 Use customized color for 'git add --interactive' and 'git clean
1299 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1300 or `error`, for four distinct types of normal output from
1301 interactive commands.
1303 color.pager::
1304 A boolean to enable/disable colored output when the pager is in
1305 use (default is true).
1307 color.push::
1308 A boolean to enable/disable color in push errors. May be set to
1309 `always`, `false` (or `never`) or `auto` (or `true`), in which
1310 case colors are used only when the error output goes to a terminal.
1311 If unset, then the value of `color.ui` is used (`auto` by default).
1313 color.push.error::
1314 Use customized color for push errors.
1316 color.remote::
1317 If set, keywords at the start of the line are highlighted. The
1318 keywords are "error", "warning", "hint" and "success", and are
1319 matched case-insensitively. May be set to `always`, `false` (or
1320 `never`) or `auto` (or `true`). If unset, then the value of
1321 `color.ui` is used (`auto` by default).
1323 color.remote.<slot>::
1324 Use customized color for each remote keyword. `<slot>` may be
1325 `hint`, `warning`, `success` or `error` which match the
1326 corresponding keyword.
1328 color.showBranch::
1329 A boolean to enable/disable color in the output of
1330 linkgit:git-show-branch[1]. May be set to `always`,
1331 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1332 only when the output is to a terminal. If unset, then the
1333 value of `color.ui` is used (`auto` by default).
1335 color.status::
1336 A boolean to enable/disable color in the output of
1337 linkgit:git-status[1]. May be set to `always`,
1338 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1339 only when the output is to a terminal. If unset, then the
1340 value of `color.ui` is used (`auto` by default).
1342 color.status.<slot>::
1343 Use customized color for status colorization. `<slot>` is
1344 one of `header` (the header text of the status message),
1345 `added` or `updated` (files which are added but not committed),
1346 `changed` (files which are changed but not added in the index),
1347 `untracked` (files which are not tracked by Git),
1348 `branch` (the current branch),
1349 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1350 to red),
1351 `localBranch` or `remoteBranch` (the local and remote branch names,
1352 respectively, when branch and tracking information is displayed in the
1353 status short-format), or
1354 `unmerged` (files which have unmerged changes).
1356 color.transport::
1357 A boolean to enable/disable color when pushes are rejected. May be
1358 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1359 case colors are used only when the error output goes to a terminal.
1360 If unset, then the value of `color.ui` is used (`auto` by default).
1362 color.transport.rejected::
1363 Use customized color when a push was rejected.
1365 color.ui::
1366 This variable determines the default value for variables such
1367 as `color.diff` and `color.grep` that control the use of color
1368 per command family. Its scope will expand as more commands learn
1369 configuration to set a default for the `--color` option. Set it
1370 to `false` or `never` if you prefer Git commands not to use
1371 color unless enabled explicitly with some other configuration
1372 or the `--color` option. Set it to `always` if you want all
1373 output not intended for machine consumption to use color, to
1374 `true` or `auto` (this is the default since Git 1.8.4) if you
1375 want such output to use color when written to the terminal.
1377 column.ui::
1378 Specify whether supported commands should output in columns.
1379 This variable consists of a list of tokens separated by spaces
1380 or commas:
1381 +
1382 These options control when the feature should be enabled
1383 (defaults to 'never'):
1384 +
1385 --
1386 `always`;;
1387 always show in columns
1388 `never`;;
1389 never show in columns
1390 `auto`;;
1391 show in columns if the output is to the terminal
1392 --
1393 +
1394 These options control layout (defaults to 'column'). Setting any
1395 of these implies 'always' if none of 'always', 'never', or 'auto' are
1396 specified.
1397 +
1398 --
1399 `column`;;
1400 fill columns before rows
1401 `row`;;
1402 fill rows before columns
1403 `plain`;;
1404 show in one column
1405 --
1406 +
1407 Finally, these options can be combined with a layout option (defaults
1408 to 'nodense'):
1409 +
1410 --
1411 `dense`;;
1412 make unequal size columns to utilize more space
1413 `nodense`;;
1414 make equal size columns
1415 --
1417 column.branch::
1418 Specify whether to output branch listing in `git branch` in columns.
1419 See `column.ui` for details.
1421 column.clean::
1422 Specify the layout when list items in `git clean -i`, which always
1423 shows files and directories in columns. See `column.ui` for details.
1425 column.status::
1426 Specify whether to output untracked files in `git status` in columns.
1427 See `column.ui` for details.
1429 column.tag::
1430 Specify whether to output tag listing in `git tag` in columns.
1431 See `column.ui` for details.
1433 commit.cleanup::
1434 This setting overrides the default of the `--cleanup` option in
1435 `git commit`. See linkgit:git-commit[1] for details. Changing the
1436 default can be useful when you always want to keep lines that begin
1437 with comment character `#` in your log message, in which case you
1438 would do `git config commit.cleanup whitespace` (note that you will
1439 have to remove the help lines that begin with `#` in the commit log
1440 template yourself, if you do this).
1442 commit.gpgSign::
1444 A boolean to specify whether all commits should be GPG signed.
1445 Use of this option when doing operations such as rebase can
1446 result in a large number of commits being signed. It may be
1447 convenient to use an agent to avoid typing your GPG passphrase
1448 several times.
1450 commit.status::
1451 A boolean to enable/disable inclusion of status information in the
1452 commit message template when using an editor to prepare the commit
1453 message. Defaults to true.
1455 commit.template::
1456 Specify the pathname of a file to use as the template for
1457 new commit messages.
1459 commit.verbose::
1460 A boolean or int to specify the level of verbose with `git commit`.
1461 See linkgit:git-commit[1].
1463 credential.helper::
1464 Specify an external helper to be called when a username or
1465 password credential is needed; the helper may consult external
1466 storage to avoid prompting the user for the credentials. Note
1467 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1468 for details.
1470 credential.useHttpPath::
1471 When acquiring credentials, consider the "path" component of an http
1472 or https URL to be important. Defaults to false. See
1473 linkgit:gitcredentials[7] for more information.
1475 credential.username::
1476 If no username is set for a network authentication, use this username
1477 by default. See credential.<context>.* below, and
1478 linkgit:gitcredentials[7].
1480 credential.<url>.*::
1481 Any of the credential.* options above can be applied selectively to
1482 some credentials. For example "credential."
1483 would set the default username only for https connections to
1484 See linkgit:gitcredentials[7] for details on how URLs are
1485 matched.
1487 credentialCache.ignoreSIGHUP::
1488 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1490 completion.commands::
1491 This is only used by git-completion.bash to add or remove
1492 commands from the list of completed commands. Normally only
1493 porcelain commands and a few select others are completed. You
1494 can add more commands, separated by space, in this
1495 variable. Prefixing the command with '-' will remove it from
1496 the existing list.
1498 include::diff-config.txt[]
1500 difftool.<tool>.path::
1501 Override the path for the given tool. This is useful in case
1502 your tool is not in the PATH.
1504 difftool.<tool>.cmd::
1505 Specify the command to invoke the specified diff tool.
1506 The specified command is evaluated in shell with the following
1507 variables available: 'LOCAL' is set to the name of the temporary
1508 file containing the contents of the diff pre-image and 'REMOTE'
1509 is set to the name of the temporary file containing the contents
1510 of the diff post-image.
1512 difftool.prompt::
1513 Prompt before each invocation of the diff tool.
1515 fastimport.unpackLimit::
1516 If the number of objects imported by linkgit:git-fast-import[1]
1517 is below this limit, then the objects will be unpacked into
1518 loose object files. However if the number of imported objects
1519 equals or exceeds this limit then the pack will be stored as a
1520 pack. Storing the pack from a fast-import can make the import
1521 operation complete faster, especially on slow filesystems. If
1522 not set, the value of `transfer.unpackLimit` is used instead.
1524 fetch.recurseSubmodules::
1525 This option can be either set to a boolean value or to 'on-demand'.
1526 Setting it to a boolean changes the behavior of fetch and pull to
1527 unconditionally recurse into submodules when set to true or to not
1528 recurse at all when set to false. When set to 'on-demand' (the default
1529 value), fetch and pull will only recurse into a populated submodule
1530 when its superproject retrieves a commit that updates the submodule's
1531 reference.
1533 fetch.fsckObjects::
1534 If it is set to true, git-fetch-pack will check all fetched
1535 objects. See `transfer.fsckObjects` for what's
1536 checked. Defaults to false. If not set, the value of
1537 `transfer.fsckObjects` is used instead.
1539 fetch.fsck.<msg-id>::
1540 Acts like `fsck.<msg-id>`, but is used by
1541 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1542 the `fsck.<msg-id>` documentation for details.
1544 fetch.fsck.skipList::
1545 Acts like `fsck.skipList`, but is used by
1546 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1547 the `fsck.skipList` documentation for details.
1549 fetch.unpackLimit::
1550 If the number of objects fetched over the Git native
1551 transfer is below this
1552 limit, then the objects will be unpacked into loose object
1553 files. However if the number of received objects equals or
1554 exceeds this limit then the received pack will be stored as
1555 a pack, after adding any missing delta bases. Storing the
1556 pack from a push can make the push operation complete faster,
1557 especially on slow filesystems. If not set, the value of
1558 `transfer.unpackLimit` is used instead.
1560 fetch.prune::
1561 If true, fetch will automatically behave as if the `--prune`
1562 option was given on the command line. See also `remote.<name>.prune`
1563 and the PRUNING section of linkgit:git-fetch[1].
1565 fetch.pruneTags::
1566 If true, fetch will automatically behave as if the
1567 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1568 if not set already. This allows for setting both this option
1569 and `fetch.prune` to maintain a 1=1 mapping to upstream
1570 refs. See also `remote.<name>.pruneTags` and the PRUNING
1571 section of linkgit:git-fetch[1].
1573 fetch.output::
1574 Control how ref update status is printed. Valid values are
1575 `full` and `compact`. Default value is `full`. See section
1576 OUTPUT in linkgit:git-fetch[1] for detail.
1578 fetch.negotiationAlgorithm::
1579 Control how information about the commits in the local repository is
1580 sent when negotiating the contents of the packfile to be sent by the
1581 server. Set to "skipping" to use an algorithm that skips commits in an
1582 effort to converge faster, but may result in a larger-than-necessary
1583 packfile; The default is "default" which instructs Git to use the default algorithm
1584 that never skips commits (unless the server has acknowledged it or one
1585 of its descendants).
1586 Unknown values will cause 'git fetch' to error out.
1587 +
1588 See also the `--negotiation-tip` option for linkgit:git-fetch[1].
1590 format.attach::
1591 Enable multipart/mixed attachments as the default for
1592 'format-patch'. The value can also be a double quoted string
1593 which will enable attachments as the default and set the
1594 value as the boundary. See the --attach option in
1595 linkgit:git-format-patch[1].
1597 format.from::
1598 Provides the default value for the `--from` option to format-patch.
1599 Accepts a boolean value, or a name and email address. If false,
1600 format-patch defaults to `--no-from`, using commit authors directly in
1601 the "From:" field of patch mails. If true, format-patch defaults to
1602 `--from`, using your committer identity in the "From:" field of patch
1603 mails and including a "From:" field in the body of the patch mail if
1604 different. If set to a non-boolean value, format-patch uses that
1605 value instead of your committer identity. Defaults to false.
1607 format.numbered::
1608 A boolean which can enable or disable sequence numbers in patch
1609 subjects. It defaults to "auto" which enables it only if there
1610 is more than one patch. It can be enabled or disabled for all
1611 messages by setting it to "true" or "false". See --numbered
1612 option in linkgit:git-format-patch[1].
1614 format.headers::
1615 Additional email headers to include in a patch to be submitted
1616 by mail. See linkgit:git-format-patch[1].
1620 Additional recipients to include in a patch to be submitted
1621 by mail. See the --to and --cc options in
1622 linkgit:git-format-patch[1].
1624 format.subjectPrefix::
1625 The default for format-patch is to output files with the '[PATCH]'
1626 subject prefix. Use this variable to change that prefix.
1628 format.signature::
1629 The default for format-patch is to output a signature containing
1630 the Git version number. Use this variable to change that default.
1631 Set this variable to the empty string ("") to suppress
1632 signature generation.
1634 format.signatureFile::
1635 Works just like format.signature except the contents of the
1636 file specified by this variable will be used as the signature.
1638 format.suffix::
1639 The default for format-patch is to output files with the suffix
1640 `.patch`. Use this variable to change that suffix (make sure to
1641 include the dot if you want it).
1643 format.pretty::
1644 The default pretty format for log/show/whatchanged command,
1645 See linkgit:git-log[1], linkgit:git-show[1],
1646 linkgit:git-whatchanged[1].
1648 format.thread::
1649 The default threading style for 'git format-patch'. Can be
1650 a boolean value, or `shallow` or `deep`. `shallow` threading
1651 makes every mail a reply to the head of the series,
1652 where the head is chosen from the cover letter, the
1653 `--in-reply-to`, and the first patch mail, in this order.
1654 `deep` threading makes every mail a reply to the previous one.
1655 A true boolean value is the same as `shallow`, and a false
1656 value disables threading.
1658 format.signOff::
1659 A boolean value which lets you enable the `-s/--signoff` option of
1660 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1661 patch should be a conscious act and means that you certify you have
1662 the rights to submit this work under the same open source license.
1663 Please see the 'SubmittingPatches' document for further discussion.
1665 format.coverLetter::
1666 A boolean that controls whether to generate a cover-letter when
1667 format-patch is invoked, but in addition can be set to "auto", to
1668 generate a cover-letter only when there's more than one patch.
1670 format.outputDirectory::
1671 Set a custom directory to store the resulting files instead of the
1672 current working directory.
1674 format.useAutoBase::
1675 A boolean value which lets you enable the `--base=auto` option of
1676 format-patch by default.
1678 filter.<driver>.clean::
1679 The command which is used to convert the content of a worktree
1680 file to a blob upon checkin. See linkgit:gitattributes[5] for
1681 details.
1683 filter.<driver>.smudge::
1684 The command which is used to convert the content of a blob
1685 object to a worktree file upon checkout. See
1686 linkgit:gitattributes[5] for details.
1688 fsck.<msg-id>::
1689 During fsck git may find issues with legacy data which
1690 wouldn't be generated by current versions of git, and which
1691 wouldn't be sent over the wire if `transfer.fsckObjects` was
1692 set. This feature is intended to support working with legacy
1693 repositories containing such data.
1694 +
1695 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1696 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1697 to clone or fetch it set `fetch.fsck.<msg-id>`.
1698 +
1699 The rest of the documentation discusses `fsck.*` for brevity, but the
1700 same applies for the corresponding `receive.fsck.*` and
1701 `fetch.<msg-id>.*`. variables.
1702 +
1703 Unlike variables like `color.ui` and `core.editor` the
1704 `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1705 fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1706 uniformly configure the same fsck settings in different circumstances
1707 all three of them they must all set to the same values.
1708 +
1709 When `fsck.<msg-id>` is set, errors can be switched to warnings and
1710 vice versa by configuring the `fsck.<msg-id>` setting where the
1711 `<msg-id>` is the fsck message ID and the value is one of `error`,
1712 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
1713 with the message ID, e.g. "missingEmail: invalid author/committer line
1714 - missing email" means that setting `fsck.missingEmail = ignore` will
1715 hide that issue.
1716 +
1717 In general, it is better to enumerate existing objects with problems
1718 with `fsck.skipList`, instead of listing the kind of breakages these
1719 problematic objects share to be ignored, as doing the latter will
1720 allow new instances of the same breakages go unnoticed.
1721 +
1722 Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1723 doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1724 will only cause git to warn.
1726 fsck.skipList::
1727 The path to a sorted list of object names (i.e. one SHA-1 per
1728 line) that are known to be broken in a non-fatal way and should
1729 be ignored. This feature is useful when an established project
1730 should be accepted despite early commits containing errors that
1731 can be safely ignored such as invalid committer email addresses.
1732 Note: corrupt objects cannot be skipped with this setting.
1733 +
1734 Like `fsck.<msg-id>` this variable has corresponding
1735 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1736 +
1737 Unlike variables like `color.ui` and `core.editor` the
1738 `receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1739 fall back on the `fsck.skipList` configuration if they aren't set. To
1740 uniformly configure the same fsck settings in different circumstances
1741 all three of them they must all set to the same values.
1743 gc.aggressiveDepth::
1744 The depth parameter used in the delta compression
1745 algorithm used by 'git gc --aggressive'. This defaults
1746 to 50.
1748 gc.aggressiveWindow::
1749 The window size parameter used in the delta compression
1750 algorithm used by 'git gc --aggressive'. This defaults
1751 to 250.
1754 When there are approximately more than this many loose
1755 objects in the repository, `git gc --auto` will pack them.
1756 Some Porcelain commands use this command to perform a
1757 light-weight garbage collection from time to time. The
1758 default value is 6700. Setting this to 0 disables it.
1760 gc.autoPackLimit::
1761 When there are more than this many packs that are not
1762 marked with `*.keep` file in the repository, `git gc
1763 --auto` consolidates them into one larger pack. The
1764 default value is 50. Setting this to 0 disables it.
1766 gc.autoDetach::
1767 Make `git gc --auto` return immediately and run in background
1768 if the system supports it. Default is true.
1770 gc.bigPackThreshold::
1771 If non-zero, all packs larger than this limit are kept when
1772 `git gc` is run. This is very similar to `--keep-base-pack`
1773 except that all packs that meet the threshold are kept, not
1774 just the base pack. Defaults to zero. Common unit suffixes of
1775 'k', 'm', or 'g' are supported.
1776 +
1777 Note that if the number of kept packs is more than gc.autoPackLimit,
1778 this configuration variable is ignored, all packs except the base pack
1779 will be repacked. After this the number of packs should go below
1780 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1782 gc.logExpiry::
1783 If the file gc.log exists, then `git gc --auto` won't run
1784 unless that file is more than 'gc.logExpiry' old. Default is
1785 "". See `gc.pruneExpire` for more ways to specify its
1786 value.
1788 gc.packRefs::
1789 Running `git pack-refs` in a repository renders it
1790 unclonable by Git versions prior to over dumb
1791 transports such as HTTP. This variable determines whether
1792 'git gc' runs `git pack-refs`. This can be set to `notbare`
1793 to enable it within all non-bare repos or it can be set to a
1794 boolean value. The default is `true`.
1796 gc.pruneExpire::
1797 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1798 Override the grace period with this config variable. The value
1799 "now" may be used to disable this grace period and always prune
1800 unreachable objects immediately, or "never" may be used to
1801 suppress pruning. This feature helps prevent corruption when
1802 'git gc' runs concurrently with another process writing to the
1803 repository; see the "NOTES" section of linkgit:git-gc[1].
1805 gc.worktreePruneExpire::
1806 When 'git gc' is run, it calls
1807 'git worktree prune --expire 3.months.ago'.
1808 This config variable can be used to set a different grace
1809 period. The value "now" may be used to disable the grace
1810 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1811 may be used to suppress pruning.
1813 gc.reflogExpire::
1814 gc.<pattern>.reflogExpire::
1815 'git reflog expire' removes reflog entries older than
1816 this time; defaults to 90 days. The value "now" expires all
1817 entries immediately, and "never" suppresses expiration
1818 altogether. With "<pattern>" (e.g.
1819 "refs/stash") in the middle the setting applies only to
1820 the refs that match the <pattern>.
1822 gc.reflogExpireUnreachable::
1823 gc.<pattern>.reflogExpireUnreachable::
1824 'git reflog expire' removes reflog entries older than
1825 this time and are not reachable from the current tip;
1826 defaults to 30 days. The value "now" expires all entries
1827 immediately, and "never" suppresses expiration altogether.
1828 With "<pattern>" (e.g. "refs/stash")
1829 in the middle, the setting applies only to the refs that
1830 match the <pattern>.
1832 gc.rerereResolved::
1833 Records of conflicted merge you resolved earlier are
1834 kept for this many days when 'git rerere gc' is run.
1835 You can also use more human-readable "1.month.ago", etc.
1836 The default is 60 days. See linkgit:git-rerere[1].
1838 gc.rerereUnresolved::
1839 Records of conflicted merge you have not resolved are
1840 kept for this many days when 'git rerere gc' is run.
1841 You can also use more human-readable "1.month.ago", etc.
1842 The default is 15 days. See linkgit:git-rerere[1].
1844 gitcvs.commitMsgAnnotation::
1845 Append this string to each commit message. Set to empty string
1846 to disable this feature. Defaults to "via git-CVS emulator".
1848 gitcvs.enabled::
1849 Whether the CVS server interface is enabled for this repository.
1850 See linkgit:git-cvsserver[1].
1852 gitcvs.logFile::
1853 Path to a log file where the CVS server interface well... logs
1854 various stuff. See linkgit:git-cvsserver[1].
1856 gitcvs.usecrlfattr::
1857 If true, the server will look up the end-of-line conversion
1858 attributes for files to determine the `-k` modes to use. If
1859 the attributes force Git to treat a file as text,
1860 the `-k` mode will be left blank so CVS clients will
1861 treat it as text. If they suppress text conversion, the file
1862 will be set with '-kb' mode, which suppresses any newline munging
1863 the client might otherwise do. If the attributes do not allow
1864 the file type to be determined, then `gitcvs.allBinary` is
1865 used. See linkgit:gitattributes[5].
1867 gitcvs.allBinary::
1868 This is used if `gitcvs.usecrlfattr` does not resolve
1869 the correct '-kb' mode to use. If true, all
1870 unresolved files are sent to the client in
1871 mode '-kb'. This causes the client to treat them
1872 as binary files, which suppresses any newline munging it
1873 otherwise might do. Alternatively, if it is set to "guess",
1874 then the contents of the file are examined to decide if
1875 it is binary, similar to `core.autocrlf`.
1877 gitcvs.dbName::
1878 Database used by git-cvsserver to cache revision information
1879 derived from the Git repository. The exact meaning depends on the
1880 used database driver, for SQLite (which is the default driver) this
1881 is a filename. Supports variable substitution (see
1882 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1883 Default: '%Ggitcvs.%m.sqlite'
1885 gitcvs.dbDriver::
1886 Used Perl DBI driver. You can specify any available driver
1887 for this here, but it might not work. git-cvsserver is tested
1888 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1889 reported *not* to work with 'DBD::mysql'. Experimental feature.
1890 May not contain double colons (`:`). Default: 'SQLite'.
1891 See linkgit:git-cvsserver[1].
1893 gitcvs.dbUser, gitcvs.dbPass::
1894 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1895 since SQLite has no concept of database users and/or passwords.
1896 'gitcvs.dbUser' supports variable substitution (see
1897 linkgit:git-cvsserver[1] for details).
1899 gitcvs.dbTableNamePrefix::
1900 Database table name prefix. Prepended to the names of any
1901 database tables used, allowing a single database to be used
1902 for several repositories. Supports variable substitution (see
1903 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1904 characters will be replaced with underscores.
1906 All gitcvs variables except for `gitcvs.usecrlfattr` and
1907 `gitcvs.allBinary` can also be specified as
1908 'gitcvs.<access_method>.<varname>' (where 'access_method'
1909 is one of "ext" and "pserver") to make them apply only for the given
1910 access method.
1912 gitweb.category::
1913 gitweb.description::
1914 gitweb.owner::
1915 gitweb.url::
1916 See linkgit:gitweb[1] for description.
1918 gitweb.avatar::
1919 gitweb.blame::
1920 gitweb.grep::
1921 gitweb.highlight::
1922 gitweb.patches::
1923 gitweb.pickaxe::
1924 gitweb.remote_heads::
1925 gitweb.showSizes::
1926 gitweb.snapshot::
1927 See linkgit:gitweb.conf[5] for description.
1929 grep.lineNumber::
1930 If set to true, enable `-n` option by default.
1932 grep.column::
1933 If set to true, enable the `--column` option by default.
1935 grep.patternType::
1936 Set the default matching behavior. Using a value of 'basic', 'extended',
1937 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1938 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1939 value 'default' will return to the default matching behavior.
1941 grep.extendedRegexp::
1942 If set to true, enable `--extended-regexp` option by default. This
1943 option is ignored when the `grep.patternType` option is set to a value
1944 other than 'default'.
1946 grep.threads::
1947 Number of grep worker threads to use.
1948 See `grep.threads` in linkgit:git-grep[1] for more information.
1950 grep.fallbackToNoIndex::
1951 If set to true, fall back to git grep --no-index if git grep
1952 is executed outside of a git repository. Defaults to false.
1954 gpg.program::
1955 Use this custom program instead of "`gpg`" found on `$PATH` when
1956 making or verifying a PGP signature. The program must support the
1957 same command-line interface as GPG, namely, to verify a detached
1958 signature, "`gpg --verify $file - <$signature`" is run, and the
1959 program is expected to signal a good signature by exiting with
1960 code 0, and to generate an ASCII-armored detached signature, the
1961 standard input of "`gpg -bsau $key`" is fed with the contents to be
1962 signed, and the program is expected to send the result to its
1963 standard output.
1965 gpg.format::
1966 Specifies which key format to use when signing with `--gpg-sign`.
1967 Default is "openpgp" and another possible value is "x509".
1969 gpg.<format>.program::
1970 Use this to customize the program used for the signing format you
1971 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1972 be used as a legacy synonym for `gpg.openpgp.program`. The default
1973 value for `gpg.x509.program` is "gpgsm".
1975 gui.commitMsgWidth::
1976 Defines how wide the commit message window is in the
1977 linkgit:git-gui[1]. "75" is the default.
1979 gui.diffContext::
1980 Specifies how many context lines should be used in calls to diff
1981 made by the linkgit:git-gui[1]. The default is "5".
1983 gui.displayUntracked::
1984 Determines if linkgit:git-gui[1] shows untracked files
1985 in the file list. The default is "true".
1987 gui.encoding::
1988 Specifies the default encoding to use for displaying of
1989 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1990 It can be overridden by setting the 'encoding' attribute
1991 for relevant files (see linkgit:gitattributes[5]).
1992 If this option is not set, the tools default to the
1993 locale encoding.
1995 gui.matchTrackingBranch::
1996 Determines if new branches created with linkgit:git-gui[1] should
1997 default to tracking remote branches with matching names or
1998 not. Default: "false".
2000 gui.newBranchTemplate::
2001 Is used as suggested name when creating new branches using the
2002 linkgit:git-gui[1].
2004 gui.pruneDuringFetch::
2005 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
2006 performing a fetch. The default value is "false".
2008 gui.trustmtime::
2009 Determines if linkgit:git-gui[1] should trust the file modification
2010 timestamp or not. By default the timestamps are not trusted.
2012 gui.spellingDictionary::
2013 Specifies the dictionary used for spell checking commit messages in
2014 the linkgit:git-gui[1]. When set to "none" spell checking is turned
2015 off.
2017 gui.fastCopyBlame::
2018 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
2019 location detection. It makes blame significantly faster on huge
2020 repositories at the expense of less thorough copy detection.
2022 gui.copyBlameThreshold::
2023 Specifies the threshold to use in 'git gui blame' original location
2024 detection, measured in alphanumeric characters. See the
2025 linkgit:git-blame[1] manual for more information on copy detection.
2027 gui.blamehistoryctx::
2028 Specifies the radius of history context in days to show in
2029 linkgit:gitk[1] for the selected commit, when the `Show History
2030 Context` menu item is invoked from 'git gui blame'. If this
2031 variable is set to zero, the whole history is shown.
2033 guitool.<name>.cmd::
2034 Specifies the shell command line to execute when the corresponding item
2035 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
2036 mandatory for every tool. The command is executed from the root of
2037 the working directory, and in the environment it receives the name of
2038 the tool as `GIT_GUITOOL`, the name of the currently selected file as
2039 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
2040 the head is detached, 'CUR_BRANCH' is empty).
2042 guitool.<name>.needsFile::
2043 Run the tool only if a diff is selected in the GUI. It guarantees
2044 that 'FILENAME' is not empty.
2046 guitool.<name>.noConsole::
2047 Run the command silently, without creating a window to display its
2048 output.
2050 guitool.<name>.noRescan::
2051 Don't rescan the working directory for changes after the tool
2052 finishes execution.
2054 guitool.<name>.confirm::
2055 Show a confirmation dialog before actually running the tool.
2057 guitool.<name>.argPrompt::
2058 Request a string argument from the user, and pass it to the tool
2059 through the `ARGS` environment variable. Since requesting an
2060 argument implies confirmation, the 'confirm' option has no effect
2061 if this is enabled. If the option is set to 'true', 'yes', or '1',
2062 the dialog uses a built-in generic prompt; otherwise the exact
2063 value of the variable is used.
2065 guitool.<name>.revPrompt::
2066 Request a single valid revision from the user, and set the
2067 `REVISION` environment variable. In other aspects this option
2068 is similar to 'argPrompt', and can be used together with it.
2070 guitool.<name>.revUnmerged::
2071 Show only unmerged branches in the 'revPrompt' subdialog.
2072 This is useful for tools similar to merge or rebase, but not
2073 for things like checkout or reset.
2075 guitool.<name>.title::
2076 Specifies the title to use for the prompt dialog. The default
2077 is the tool name.
2079 guitool.<name>.prompt::
2080 Specifies the general prompt string to display at the top of
2081 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
2082 The default value includes the actual command.
2084 help.browser::
2085 Specify the browser that will be used to display help in the
2086 'web' format. See linkgit:git-help[1].
2088 help.format::
2089 Override the default help format used by linkgit:git-help[1].
2090 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2091 the default. 'web' and 'html' are the same.
2093 help.autoCorrect::
2094 Automatically correct and execute mistyped commands after
2095 waiting for the given number of deciseconds (0.1 sec). If more
2096 than one command can be deduced from the entered text, nothing
2097 will be executed. If the value of this option is negative,
2098 the corrected command will be executed immediately. If the
2099 value is 0 - the command will be just shown but not executed.
2100 This is the default.
2102 help.htmlPath::
2103 Specify the path where the HTML documentation resides. File system paths
2104 and URLs are supported. HTML pages will be prefixed with this path when
2105 help is displayed in the 'web' format. This defaults to the documentation
2106 path of your Git installation.
2108 http.proxy::
2109 Override the HTTP proxy, normally configured using the 'http_proxy',
2110 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2111 addition to the syntax understood by curl, it is possible to specify a
2112 proxy string with a user name but no password, in which case git will
2113 attempt to acquire one in the same way it does for other credentials. See
2114 linkgit:gitcredentials[7] for more information. The syntax thus is
2115 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2116 on a per-remote basis; see remote.<name>.proxy
2118 http.proxyAuthMethod::
2119 Set the method with which to authenticate against the HTTP proxy. This
2120 only takes effect if the configured proxy string contains a user name part
2121 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2122 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2123 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2124 variable. Possible values are:
2125 +
2126 --
2127 * `anyauth` - Automatically pick a suitable authentication method. It is
2128 assumed that the proxy answers an unauthenticated request with a 407
2129 status code and one or more Proxy-authenticate headers with supported
2130 authentication methods. This is the default.
2131 * `basic` - HTTP Basic authentication
2132 * `digest` - HTTP Digest authentication; this prevents the password from being
2133 transmitted to the proxy in clear text
2134 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2135 of `curl(1)`)
2136 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2137 --
2139 http.emptyAuth::
2140 Attempt authentication without seeking a username or password. This
2141 can be used to attempt GSS-Negotiate authentication without specifying
2142 a username in the URL, as libcurl normally requires a username for
2143 authentication.
2145 http.delegation::
2146 Control GSSAPI credential delegation. The delegation is disabled
2147 by default in libcurl since version 7.21.7. Set parameter to tell
2148 the server what it is allowed to delegate when it comes to user
2149 credentials. Used with GSS/kerberos. Possible values are:
2150 +
2151 --
2152 * `none` - Don't allow any delegation.
2153 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2154 Kerberos service ticket, which is a matter of realm policy.
2155 * `always` - Unconditionally allow the server to delegate.
2156 --
2159 http.extraHeader::
2160 Pass an additional HTTP header when communicating with a server. If
2161 more than one such entry exists, all of them are added as extra
2162 headers. To allow overriding the settings inherited from the system
2163 config, an empty value will reset the extra headers to the empty list.
2165 http.cookieFile::
2166 The pathname of a file containing previously stored cookie lines,
2167 which should be used
2168 in the Git http session, if they match the server. The file format
2169 of the file to read cookies from should be plain HTTP headers or
2170 the Netscape/Mozilla cookie file format (see `curl(1)`).
2171 NOTE that the file specified with http.cookieFile is used only as
2172 input unless http.saveCookies is set.
2174 http.saveCookies::
2175 If set, store cookies received during requests to the file specified by
2176 http.cookieFile. Has no effect if http.cookieFile is unset.
2178 http.sslVersion::
2179 The SSL version to use when negotiating an SSL connection, if you
2180 want to force the default. The available and default version
2181 depend on whether libcurl was built against NSS or OpenSSL and the
2182 particular configuration of the crypto library in use. Internally
2183 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2184 documentation for more details on the format of this option and
2185 for the ssl version supported. Actually the possible values of
2186 this option are:
2188 - sslv2
2189 - sslv3
2190 - tlsv1
2191 - tlsv1.0
2192 - tlsv1.1
2193 - tlsv1.2
2194 - tlsv1.3
2196 +
2197 Can be overridden by the `GIT_SSL_VERSION` environment variable.
2198 To force git to use libcurl's default ssl version and ignore any
2199 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2200 empty string.
2202 http.sslCipherList::
2203 A list of SSL ciphers to use when negotiating an SSL connection.
2204 The available ciphers depend on whether libcurl was built against
2205 NSS or OpenSSL and the particular configuration of the crypto
2206 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2207 option; see the libcurl documentation for more details on the format
2208 of this list.
2209 +
2210 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2211 To force git to use libcurl's default cipher list and ignore any
2212 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2213 empty string.
2215 http.sslVerify::
2216 Whether to verify the SSL certificate when fetching or pushing
2217 over HTTPS. Defaults to true. Can be overridden by the
2218 `GIT_SSL_NO_VERIFY` environment variable.
2220 http.sslCert::
2221 File containing the SSL certificate when fetching or pushing
2222 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2223 variable.
2225 http.sslKey::
2226 File containing the SSL private key when fetching or pushing
2227 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2228 variable.
2230 http.sslCertPasswordProtected::
2231 Enable Git's password prompt for the SSL certificate. Otherwise
2232 OpenSSL will prompt the user, possibly many times, if the
2233 certificate or private key is encrypted. Can be overridden by the
2234 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2236 http.sslCAInfo::
2237 File containing the certificates to verify the peer with when
2238 fetching or pushing over HTTPS. Can be overridden by the
2239 `GIT_SSL_CAINFO` environment variable.
2241 http.sslCAPath::
2242 Path containing files with the CA certificates to verify the peer
2243 with when fetching or pushing over HTTPS. Can be overridden
2244 by the `GIT_SSL_CAPATH` environment variable.
2246 http.pinnedpubkey::
2247 Public key of the https service. It may either be the filename of
2248 a PEM or DER encoded public key file or a string starting with
2249 'sha256//' followed by the base64 encoded sha256 hash of the
2250 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2251 exit with an error if this option is set but not supported by
2252 cURL.
2254 http.sslTry::
2255 Attempt to use AUTH SSL/TLS and encrypted data transfers
2256 when connecting via regular FTP protocol. This might be needed
2257 if the FTP server requires it for security reasons or you wish
2258 to connect securely whenever remote FTP server supports it.
2259 Default is false since it might trigger certificate verification
2260 errors on misconfigured servers.
2262 http.maxRequests::
2263 How many HTTP requests to launch in parallel. Can be overridden
2264 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2266 http.minSessions::
2267 The number of curl sessions (counted across slots) to be kept across
2268 requests. They will not be ended with curl_easy_cleanup() until
2269 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2270 value will be capped at 1. Defaults to 1.
2272 http.postBuffer::
2273 Maximum size in bytes of the buffer used by smart HTTP
2274 transports when POSTing data to the remote system.
2275 For requests larger than this buffer size, HTTP/1.1 and
2276 Transfer-Encoding: chunked is used to avoid creating a
2277 massive pack file locally. Default is 1 MiB, which is
2278 sufficient for most requests.
2280 http.lowSpeedLimit, http.lowSpeedTime::
2281 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2282 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2283 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2284 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2286 http.noEPSV::
2287 A boolean which disables using of EPSV ftp command by curl.
2288 This can helpful with some "poor" ftp servers which don't
2289 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2290 environment variable. Default is false (curl will use EPSV).
2292 http.userAgent::
2293 The HTTP USER_AGENT string presented to an HTTP server. The default
2294 value represents the version of the client Git such as git/1.7.1.
2295 This option allows you to override this value to a more common value
2296 such as Mozilla/4.0. This may be necessary, for instance, if
2297 connecting through a firewall that restricts HTTP connections to a set
2298 of common USER_AGENT strings (but not including those like git/1.7.1).
2299 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2301 http.followRedirects::
2302 Whether git should follow HTTP redirects. If set to `true`, git
2303 will transparently follow any redirect issued by a server it
2304 encounters. If set to `false`, git will treat all redirects as
2305 errors. If set to `initial`, git will follow redirects only for
2306 the initial request to a remote, but not for subsequent
2307 follow-up HTTP requests. Since git uses the redirected URL as
2308 the base for the follow-up requests, this is generally
2309 sufficient. The default is `initial`.
2311 http.<url>.*::
2312 Any of the http.* options above can be applied selectively to some URLs.
2313 For a config key to match a URL, each element of the config key is
2314 compared to that of the URL, in the following order:
2315 +
2316 --
2317 . Scheme (e.g., `https` in ``). This field
2318 must match exactly between the config key and the URL.
2320 . Host/domain name (e.g., `` in ``).
2321 This field must match between the config key and the URL. It is
2322 possible to specify a `*` as part of the host name to match all subdomains
2323 at this level. `https://*` for example would match
2324 ``, but not ``.
2326 . Port number (e.g., `8080` in ``).
2327 This field must match exactly between the config key and the URL.
2328 Omitted port numbers are automatically converted to the correct
2329 default for the scheme before matching.
2331 . Path (e.g., `repo.git` in ``). The
2332 path field of the config key must match the path field of the URL
2333 either exactly or as a prefix of slash-delimited path elements. This means
2334 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2335 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2336 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2337 key with just path `foo/`).
2339 . User name (e.g., `user` in ``). If
2340 the config key has a user name it must match the user name in the
2341 URL exactly. If the config key does not have a user name, that
2342 config key will match a URL with any user name (including none),
2343 but at a lower precedence than a config key with a user name.
2344 --
2345 +
2346 The list above is ordered by decreasing precedence; a URL that matches
2347 a config key's path is preferred to one that matches its user name. For example,
2348 if the URL is `` a config key match of
2349 `` will be preferred over a config key match of
2350 ``.
2351 +
2352 All URLs are normalized before attempting any matching (the password part,
2353 if embedded in the URL, is always ignored for matching purposes) so that
2354 equivalent URLs that are simply spelled differently will match properly.
2355 Environment variable settings always override any matches. The URLs that are
2356 matched against are those given directly to Git commands. This means any URLs
2357 visited as a result of a redirection do not participate in matching.
2359 ssh.variant::
2360 By default, Git determines the command line arguments to use
2361 based on the basename of the configured SSH command (configured
2362 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2363 the config setting `core.sshCommand`). If the basename is
2364 unrecognized, Git will attempt to detect support of OpenSSH
2365 options by first invoking the configured SSH command with the
2366 `-G` (print configuration) option and will subsequently use
2367 OpenSSH options (if that is successful) or no options besides
2368 the host and remote command (if it fails).
2369 +
2370 The config variable `ssh.variant` can be set to override this detection.
2371 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2372 `tortoiseplink`, `simple` (no options except the host and remote command).
2373 The default auto-detection can be explicitly requested using the value
2374 `auto`. Any other value is treated as `ssh`. This setting can also be
2375 overridden via the environment variable `GIT_SSH_VARIANT`.
2376 +
2377 The current command-line parameters used for each variant are as
2378 follows:
2379 +
2380 --
2382 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2384 * `simple` - [username@]host command
2386 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2388 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2390 --
2391 +
2392 Except for the `simple` variant, command-line parameters are likely to
2393 change as git gains new features.
2395 i18n.commitEncoding::
2396 Character encoding the commit messages are stored in; Git itself
2397 does not care per se, but this information is necessary e.g. when
2398 importing commits from emails or in the gitk graphical history
2399 browser (and possibly at other places in the future or in other
2400 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2402 i18n.logOutputEncoding::
2403 Character encoding the commit messages are converted to when
2404 running 'git log' and friends.
2406 imap::
2407 The configuration variables in the 'imap' section are described
2408 in linkgit:git-imap-send[1].
2410 index.version::
2411 Specify the version with which new index files should be
2412 initialized. This does not affect existing repositories.
2414 init.templateDir::
2415 Specify the directory from which templates will be copied.
2416 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2418 instaweb.browser::
2419 Specify the program that will be used to browse your working
2420 repository in gitweb. See linkgit:git-instaweb[1].
2422 instaweb.httpd::
2423 The HTTP daemon command-line to start gitweb on your working
2424 repository. See linkgit:git-instaweb[1].
2426 instaweb.local::
2427 If true the web server started by linkgit:git-instaweb[1] will
2428 be bound to the local IP (
2430 instaweb.modulePath::
2431 The default module path for linkgit:git-instaweb[1] to use
2432 instead of /usr/lib/apache2/modules. Only used if httpd
2433 is Apache.
2435 instaweb.port::
2436 The port number to bind the gitweb httpd to. See
2437 linkgit:git-instaweb[1].
2439 interactive.singleKey::
2440 In interactive commands, allow the user to provide one-letter
2441 input with a single key (i.e., without hitting enter).
2442 Currently this is used by the `--patch` mode of
2443 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2444 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2445 setting is silently ignored if portable keystroke input
2446 is not available; requires the Perl module Term::ReadKey.
2448 interactive.diffFilter::
2449 When an interactive command (such as `git add --patch`) shows
2450 a colorized diff, git will pipe the diff through the shell
2451 command defined by this configuration variable. The command may
2452 mark up the diff further for human consumption, provided that it
2453 retains a one-to-one correspondence with the lines in the
2454 original diff. Defaults to disabled (no filtering).
2456 log.abbrevCommit::
2457 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2458 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2459 override this option with `--no-abbrev-commit`.
2462 Set the default date-time mode for the 'log' command.
2463 Setting a value for is similar to using 'git log''s
2464 `--date` option. See linkgit:git-log[1] for details.
2466 log.decorate::
2467 Print out the ref names of any commits that are shown by the log
2468 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2469 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2470 specified, the full ref name (including prefix) will be printed.
2471 If 'auto' is specified, then if the output is going to a terminal,
2472 the ref names are shown as if 'short' were given, otherwise no ref
2473 names are shown. This is the same as the `--decorate` option
2474 of the `git log`.
2476 log.follow::
2477 If `true`, `git log` will act as if the `--follow` option was used when
2478 a single <path> is given. This has the same limitations as `--follow`,
2479 i.e. it cannot be used to follow multiple files and does not work well
2480 on non-linear history.
2482 log.graphColors::
2483 A list of colors, separated by commas, that can be used to draw
2484 history lines in `git log --graph`.
2486 log.showRoot::
2487 If true, the initial commit will be shown as a big creation event.
2488 This is equivalent to a diff against an empty tree.
2489 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2490 normally hide the root commit will now show it. True by default.
2492 log.showSignature::
2493 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2494 linkgit:git-whatchanged[1] assume `--show-signature`.
2496 log.mailmap::
2497 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2498 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2500 mailinfo.scissors::
2501 If true, makes linkgit:git-mailinfo[1] (and therefore
2502 linkgit:git-am[1]) act by default as if the --scissors option
2503 was provided on the command-line. When active, this features
2504 removes everything from the message body before a scissors
2505 line (i.e. consisting mainly of ">8", "8<" and "-").
2507 mailmap.file::
2508 The location of an augmenting mailmap file. The default
2509 mailmap, located in the root of the repository, is loaded
2510 first, then the mailmap file pointed to by this variable.
2511 The location of the mailmap file may be in a repository
2512 subdirectory, or somewhere outside of the repository itself.
2513 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2515 mailmap.blob::
2516 Like `mailmap.file`, but consider the value as a reference to a
2517 blob in the repository. If both `mailmap.file` and
2518 `mailmap.blob` are given, both are parsed, with entries from
2519 `mailmap.file` taking precedence. In a bare repository, this
2520 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2521 defaults to empty.
2523 man.viewer::
2524 Specify the programs that may be used to display help in the
2525 'man' format. See linkgit:git-help[1].
2527 man.<tool>.cmd::
2528 Specify the command to invoke the specified man viewer. The
2529 specified command is evaluated in shell with the man page
2530 passed as argument. (See linkgit:git-help[1].)
2532 man.<tool>.path::
2533 Override the path for the given tool that may be used to
2534 display help in the 'man' format. See linkgit:git-help[1].
2536 include::merge-config.txt[]
2538 mergetool.<tool>.path::
2539 Override the path for the given tool. This is useful in case
2540 your tool is not in the PATH.
2542 mergetool.<tool>.cmd::
2543 Specify the command to invoke the specified merge tool. The
2544 specified command is evaluated in shell with the following
2545 variables available: 'BASE' is the name of a temporary file
2546 containing the common base of the files to be merged, if available;
2547 'LOCAL' is the name of a temporary file containing the contents of
2548 the file on the current branch; 'REMOTE' is the name of a temporary
2549 file containing the contents of the file from the branch being
2550 merged; 'MERGED' contains the name of the file to which the merge
2551 tool should write the results of a successful merge.
2553 mergetool.<tool>.trustExitCode::
2554 For a custom merge command, specify whether the exit code of
2555 the merge command can be used to determine whether the merge was
2556 successful. If this is not set to true then the merge target file
2557 timestamp is checked and the merge assumed to have been successful
2558 if the file has been updated, otherwise the user is prompted to
2559 indicate the success of the merge.
2561 mergetool.meld.hasOutput::
2562 Older versions of `meld` do not support the `--output` option.
2563 Git will attempt to detect whether `meld` supports `--output`
2564 by inspecting the output of `meld --help`. Configuring
2565 `mergetool.meld.hasOutput` will make Git skip these checks and
2566 use the configured value instead. Setting `mergetool.meld.hasOutput`
2567 to `true` tells Git to unconditionally use the `--output` option,
2568 and `false` avoids using `--output`.
2570 mergetool.keepBackup::
2571 After performing a merge, the original file with conflict markers
2572 can be saved as a file with a `.orig` extension. If this variable
2573 is set to `false` then this file is not preserved. Defaults to
2574 `true` (i.e. keep the backup files).
2576 mergetool.keepTemporaries::
2577 When invoking a custom merge tool, Git uses a set of temporary
2578 files to pass to the tool. If the tool returns an error and this
2579 variable is set to `true`, then these temporary files will be
2580 preserved, otherwise they will be removed after the tool has
2581 exited. Defaults to `false`.
2583 mergetool.writeToTemp::
2584 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2585 conflicting files in the worktree by default. Git will attempt
2586 to use a temporary directory for these files when set `true`.
2587 Defaults to `false`.
2589 mergetool.prompt::
2590 Prompt before each invocation of the merge resolution program.
2592 notes.mergeStrategy::
2593 Which merge strategy to choose by default when resolving notes
2594 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2595 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2596 section of linkgit:git-notes[1] for more information on each strategy.
2598 notes.<name>.mergeStrategy::
2599 Which merge strategy to choose when doing a notes merge into
2600 refs/notes/<name>. This overrides the more general
2601 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2602 linkgit:git-notes[1] for more information on the available strategies.
2604 notes.displayRef::
2605 The (fully qualified) refname from which to show notes when
2606 showing commit messages. The value of this variable can be set
2607 to a glob, in which case notes from all matching refs will be
2608 shown. You may also specify this configuration variable
2609 several times. A warning will be issued for refs that do not
2610 exist, but a glob that does not match any refs is silently
2611 ignored.
2612 +
2613 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2614 environment variable, which must be a colon separated list of refs or
2615 globs.
2616 +
2617 The effective value of "core.notesRef" (possibly overridden by
2618 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2619 displayed.
2621 notes.rewrite.<command>::
2622 When rewriting commits with <command> (currently `amend` or
2623 `rebase`) and this variable is set to `true`, Git
2624 automatically copies your notes from the original to the
2625 rewritten commit. Defaults to `true`, but see
2626 "notes.rewriteRef" below.
2628 notes.rewriteMode::
2629 When copying notes during a rewrite (see the
2630 "notes.rewrite.<command>" option), determines what to do if
2631 the target commit already has a note. Must be one of
2632 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2633 Defaults to `concatenate`.
2634 +
2635 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2636 environment variable.
2638 notes.rewriteRef::
2639 When copying notes during a rewrite, specifies the (fully
2640 qualified) ref whose notes should be copied. The ref may be a
2641 glob, in which case notes in all matching refs will be copied.
2642 You may also specify this configuration several times.
2643 +
2644 Does not have a default value; you must configure this variable to
2645 enable note rewriting. Set it to `refs/notes/commits` to enable
2646 rewriting for the default commit notes.
2647 +
2648 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2649 environment variable, which must be a colon separated list of refs or
2650 globs.
2652 pack.window::
2653 The size of the window used by linkgit:git-pack-objects[1] when no
2654 window size is given on the command line. Defaults to 10.
2656 pack.depth::
2657 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2658 maximum depth is given on the command line. Defaults to 50.
2659 Maximum value is 4095.
2661 pack.windowMemory::
2662 The maximum size of memory that is consumed by each thread
2663 in linkgit:git-pack-objects[1] for pack window memory when
2664 no limit is given on the command line. The value can be
2665 suffixed with "k", "m", or "g". When left unconfigured (or
2666 set explicitly to 0), there will be no limit.
2668 pack.compression::
2669 An integer -1..9, indicating the compression level for objects
2670 in a pack file. -1 is the zlib default. 0 means no
2671 compression, and 1..9 are various speed/size tradeoffs, 9 being
2672 slowest. If not set, defaults to core.compression. If that is
2673 not set, defaults to -1, the zlib default, which is "a default
2674 compromise between speed and compression (currently equivalent
2675 to level 6)."
2676 +
2677 Note that changing the compression level will not automatically recompress
2678 all existing objects. You can force recompression by passing the -F option
2679 to linkgit:git-repack[1].
2681 pack.deltaCacheSize::
2682 The maximum memory in bytes used for caching deltas in
2683 linkgit:git-pack-objects[1] before writing them out to a pack.
2684 This cache is used to speed up the writing object phase by not
2685 having to recompute the final delta result once the best match
2686 for all objects is found. Repacking large repositories on machines
2687 which are tight with memory might be badly impacted by this though,
2688 especially if this cache pushes the system into swapping.
2689 A value of 0 means no limit. The smallest size of 1 byte may be
2690 used to virtually disable this cache. Defaults to 256 MiB.
2692 pack.deltaCacheLimit::
2693 The maximum size of a delta, that is cached in
2694 linkgit:git-pack-objects[1]. This cache is used to speed up the
2695 writing object phase by not having to recompute the final delta
2696 result once the best match for all objects is found.
2697 Defaults to 1000. Maximum value is 65535.
2699 pack.threads::
2700 Specifies the number of threads to spawn when searching for best
2701 delta matches. This requires that linkgit:git-pack-objects[1]
2702 be compiled with pthreads otherwise this option is ignored with a
2703 warning. This is meant to reduce packing time on multiprocessor
2704 machines. The required amount of memory for the delta search window
2705 is however multiplied by the number of threads.
2706 Specifying 0 will cause Git to auto-detect the number of CPU's
2707 and set the number of threads accordingly.
2709 pack.indexVersion::
2710 Specify the default pack index version. Valid values are 1 for
2711 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2712 the new pack index with capabilities for packs larger than 4 GB
2713 as well as proper protection against the repacking of corrupted
2714 packs. Version 2 is the default. Note that version 2 is enforced
2715 and this config option ignored whenever the corresponding pack is
2716 larger than 2 GB.
2717 +
2718 If you have an old Git that does not understand the version 2 `*.idx` file,
2719 cloning or fetching over a non native protocol (e.g. "http")
2720 that will copy both `*.pack` file and corresponding `*.idx` file from the
2721 other side may give you a repository that cannot be accessed with your
2722 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2723 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2724 the `*.idx` file.
2726 pack.packSizeLimit::
2727 The maximum size of a pack. This setting only affects
2728 packing to a file when repacking, i.e. the git:// protocol
2729 is unaffected. It can be overridden by the `--max-pack-size`
2730 option of linkgit:git-repack[1]. Reaching this limit results
2731 in the creation of multiple packfiles; which in turn prevents
2732 bitmaps from being created.
2733 The minimum size allowed is limited to 1 MiB.
2734 The default is unlimited.
2735 Common unit suffixes of 'k', 'm', or 'g' are
2736 supported.
2738 pack.useBitmaps::
2739 When true, git will use pack bitmaps (if available) when packing
2740 to stdout (e.g., during the server side of a fetch). Defaults to
2741 true. You should not generally need to turn this off unless
2742 you are debugging pack bitmaps.
2744 pack.writeBitmaps (deprecated)::
2745 This is a deprecated synonym for `repack.writeBitmaps`.
2747 pack.writeBitmapHashCache::
2748 When true, git will include a "hash cache" section in the bitmap
2749 index (if one is written). This cache can be used to feed git's
2750 delta heuristics, potentially leading to better deltas between
2751 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2752 between an older, bitmapped pack and objects that have been
2753 pushed since the last gc). The downside is that it consumes 4
2754 bytes per object of disk space, and that JGit's bitmap
2755 implementation does not understand it, causing it to complain if
2756 Git and JGit are used on the same repository. Defaults to false.
2758 pager.<cmd>::
2759 If the value is boolean, turns on or off pagination of the
2760 output of a particular Git subcommand when writing to a tty.
2761 Otherwise, turns on pagination for the subcommand using the
2762 pager specified by the value of `pager.<cmd>`. If `--paginate`
2763 or `--no-pager` is specified on the command line, it takes
2764 precedence over this option. To disable pagination for all
2765 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2767 pretty.<name>::
2768 Alias for a --pretty= format string, as specified in
2769 linkgit:git-log[1]. Any aliases defined here can be used just
2770 as the built-in pretty formats could. For example,
2771 running `git config pretty.changelog "format:* %H %s"`
2772 would cause the invocation `git log --pretty=changelog`
2773 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2774 Note that an alias with the same name as a built-in format
2775 will be silently ignored.
2777 protocol.allow::
2778 If set, provide a user defined default policy for all protocols which
2779 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2780 if unset, known-safe protocols (http, https, git, ssh, file) have a
2781 default policy of `always`, known-dangerous protocols (ext) have a
2782 default policy of `never`, and all other protocols have a default
2783 policy of `user`. Supported policies:
2784 +
2785 --
2787 * `always` - protocol is always able to be used.
2789 * `never` - protocol is never able to be used.
2791 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2792 either unset or has a value of 1. This policy should be used when you want a
2793 protocol to be directly usable by the user but don't want it used by commands which
2794 execute clone/fetch/push commands without user input, e.g. recursive
2795 submodule initialization.
2797 --
2799 protocol.<name>.allow::
2800 Set a policy to be used by protocol `<name>` with clone/fetch/push
2801 commands. See `protocol.allow` above for the available policies.
2802 +
2803 The protocol names currently used by git are:
2804 +
2805 --
2806 - `file`: any local file-based path (including `file://` URLs,
2807 or local paths)
2809 - `git`: the anonymous git protocol over a direct TCP
2810 connection (or proxy, if configured)
2812 - `ssh`: git over ssh (including `host:path` syntax,
2813 `ssh://`, etc).
2815 - `http`: git over http, both "smart http" and "dumb http".
2816 Note that this does _not_ include `https`; if you want to configure
2817 both, you must do so individually.
2819 - any external helpers are named by their protocol (e.g., use
2820 `hg` to allow the `git-remote-hg` helper)
2821 --
2823 protocol.version::
2824 Experimental. If set, clients will attempt to communicate with a
2825 server using the specified protocol version. If unset, no
2826 attempt will be made by the client to communicate using a
2827 particular protocol version, this results in protocol version 0
2828 being used.
2829 Supported versions:
2830 +
2831 --
2833 * `0` - the original wire protocol.
2835 * `1` - the original wire protocol with the addition of a version string
2836 in the initial response from the server.
2838 --
2840 pull.ff::
2841 By default, Git does not create an extra merge commit when merging
2842 a commit that is a descendant of the current commit. Instead, the
2843 tip of the current branch is fast-forwarded. When set to `false`,
2844 this variable tells Git to create an extra merge commit in such
2845 a case (equivalent to giving the `--no-ff` option from the command
2846 line). When set to `only`, only such fast-forward merges are
2847 allowed (equivalent to giving the `--ff-only` option from the
2848 command line). This setting overrides `merge.ff` when pulling.
2850 pull.rebase::
2851 When true, rebase branches on top of the fetched branch, instead
2852 of merging the default branch from the default remote when "git
2853 pull" is run. See "branch.<name>.rebase" for setting this on a
2854 per-branch basis.
2855 +
2856 When `merges`, pass the `--rebase-merges` option to 'git rebase'
2857 so that the local merge commits are included in the rebase (see
2858 linkgit:git-rebase[1] for details).
2859 +
2860 When preserve, also pass `--preserve-merges` along to 'git rebase'
2861 so that locally committed merge commits will not be flattened
2862 by running 'git pull'.
2863 +
2864 When the value is `interactive`, the rebase is run in interactive mode.
2865 +
2866 *NOTE*: this is a possibly dangerous operation; do *not* use
2867 it unless you understand the implications (see linkgit:git-rebase[1]
2868 for details).
2870 pull.octopus::
2871 The default merge strategy to use when pulling multiple branches
2872 at once.
2874 pull.twohead::
2875 The default merge strategy to use when pulling a single branch.
2877 push.default::
2878 Defines the action `git push` should take if no refspec is
2879 explicitly given. Different values are well-suited for
2880 specific workflows; for instance, in a purely central workflow
2881 (i.e. the fetch source is equal to the push destination),
2882 `upstream` is probably what you want. Possible values are:
2883 +
2884 --
2886 * `nothing` - do not push anything (error out) unless a refspec is
2887 explicitly given. This is primarily meant for people who want to
2888 avoid mistakes by always being explicit.
2890 * `current` - push the current branch to update a branch with the same
2891 name on the receiving end. Works in both central and non-central
2892 workflows.
2894 * `upstream` - push the current branch back to the branch whose
2895 changes are usually integrated into the current branch (which is
2896 called `@{upstream}`). This mode only makes sense if you are
2897 pushing to the same repository you would normally pull from
2898 (i.e. central workflow).
2900 * `tracking` - This is a deprecated synonym for `upstream`.
2902 * `simple` - in centralized workflow, work like `upstream` with an
2903 added safety to refuse to push if the upstream branch's name is
2904 different from the local one.
2905 +
2906 When pushing to a remote that is different from the remote you normally
2907 pull from, work as `current`. This is the safest option and is suited
2908 for beginners.
2909 +
2910 This mode has become the default in Git 2.0.
2912 * `matching` - push all branches having the same name on both ends.
2913 This makes the repository you are pushing to remember the set of
2914 branches that will be pushed out (e.g. if you always push 'maint'
2915 and 'master' there and no other branches, the repository you push
2916 to will have these two branches, and your local 'maint' and
2917 'master' will be pushed there).
2918 +
2919 To use this mode effectively, you have to make sure _all_ the
2920 branches you would push out are ready to be pushed out before
2921 running 'git push', as the whole point of this mode is to allow you
2922 to push all of the branches in one go. If you usually finish work
2923 on only one branch and push out the result, while other branches are
2924 unfinished, this mode is not for you. Also this mode is not
2925 suitable for pushing into a shared central repository, as other
2926 people may add new branches there, or update the tip of existing
2927 branches outside your control.
2928 +
2929 This used to be the default, but not since Git 2.0 (`simple` is the
2930 new default).
2932 --
2934 push.followTags::
2935 If set to true enable `--follow-tags` option by default. You
2936 may override this configuration at time of push by specifying
2937 `--no-follow-tags`.
2939 push.gpgSign::
2940 May be set to a boolean value, or the string 'if-asked'. A true
2941 value causes all pushes to be GPG signed, as if `--signed` is
2942 passed to linkgit:git-push[1]. The string 'if-asked' causes
2943 pushes to be signed if the server supports it, as if
2944 `--signed=if-asked` is passed to 'git push'. A false value may
2945 override a value from a lower-priority config file. An explicit
2946 command-line flag always overrides this config option.
2948 push.pushOption::
2949 When no `--push-option=<option>` argument is given from the
2950 command line, `git push` behaves as if each <value> of
2951 this variable is given as `--push-option=<value>`.
2952 +
2953 This is a multi-valued variable, and an empty value can be used in a
2954 higher priority configuration file (e.g. `.git/config` in a
2955 repository) to clear the values inherited from a lower priority
2956 configuration files (e.g. `$HOME/.gitconfig`).
2957 +
2958 --
2960 Example:
2962 /etc/gitconfig
2963 push.pushoption = a
2964 push.pushoption = b
2966 ~/.gitconfig
2967 push.pushoption = c
2969 repo/.git/config
2970 push.pushoption =
2971 push.pushoption = b
2973 This will result in only b (a and c are cleared).
2975 --
2977 push.recurseSubmodules::
2978 Make sure all submodule commits used by the revisions to be pushed
2979 are available on a remote-tracking branch. If the value is 'check'
2980 then Git will verify that all submodule commits that changed in the
2981 revisions to be pushed are available on at least one remote of the
2982 submodule. If any commits are missing, the push will be aborted and
2983 exit with non-zero status. If the value is 'on-demand' then all
2984 submodules that changed in the revisions to be pushed will be
2985 pushed. If on-demand was not able to push all necessary revisions
2986 it will also be aborted and exit with non-zero status. If the value
2987 is 'no' then default behavior of ignoring submodules when pushing
2988 is retained. You may override this configuration at time of push by
2989 specifying '--recurse-submodules=check|on-demand|no'.
2991 include::rebase-config.txt[]
2993 receive.advertiseAtomic::
2994 By default, git-receive-pack will advertise the atomic push
2995 capability to its clients. If you don't want to advertise this
2996 capability, set this variable to false.
2998 receive.advertisePushOptions::
2999 When set to true, git-receive-pack will advertise the push options
3000 capability to its clients. False by default.
3002 receive.autogc::
3003 By default, git-receive-pack will run "git-gc --auto" after
3004 receiving data from git-push and updating refs. You can stop
3005 it by setting this variable to false.
3007 receive.certNonceSeed::
3008 By setting this variable to a string, `git receive-pack`
3009 will accept a `git push --signed` and verifies it by using
3010 a "nonce" protected by HMAC using this string as a secret
3011 key.
3013 receive.certNonceSlop::
3014 When a `git push --signed` sent a push certificate with a
3015 "nonce" that was issued by a receive-pack serving the same
3016 repository within this many seconds, export the "nonce"
3017 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
3018 hooks (instead of what the receive-pack asked the sending
3019 side to include). This may allow writing checks in
3020 `pre-receive` and `post-receive` a bit easier. Instead of
3021 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
3022 that records by how many seconds the nonce is stale to
3023 decide if they want to accept the certificate, they only
3024 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
3026 receive.fsckObjects::
3027 If it is set to true, git-receive-pack will check all received
3028 objects. See `transfer.fsckObjects` for what's checked.
3029 Defaults to false. If not set, the value of
3030 `transfer.fsckObjects` is used instead.
3032 receive.fsck.<msg-id>::
3033 Acts like `fsck.<msg-id>`, but is used by
3034 linkgit:git-receive-pack[1] instead of
3035 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
3036 details.
3038 receive.fsck.skipList::
3039 Acts like `fsck.skipList`, but is used by
3040 linkgit:git-receive-pack[1] instead of
3041 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
3042 details.
3044 receive.keepAlive::
3045 After receiving the pack from the client, `receive-pack` may
3046 produce no output (if `--quiet` was specified) while processing
3047 the pack, causing some networks to drop the TCP connection.
3048 With this option set, if `receive-pack` does not transmit
3049 any data in this phase for `receive.keepAlive` seconds, it will
3050 send a short keepalive packet. The default is 5 seconds; set
3051 to 0 to disable keepalives entirely.
3053 receive.unpackLimit::
3054 If the number of objects received in a push is below this
3055 limit then the objects will be unpacked into loose object
3056 files. However if the number of received objects equals or
3057 exceeds this limit then the received pack will be stored as
3058 a pack, after adding any missing delta bases. Storing the
3059 pack from a push can make the push operation complete faster,
3060 especially on slow filesystems. If not set, the value of
3061 `transfer.unpackLimit` is used instead.
3063 receive.maxInputSize::
3064 If the size of the incoming pack stream is larger than this
3065 limit, then git-receive-pack will error out, instead of
3066 accepting the pack file. If not set or set to 0, then the size
3067 is unlimited.
3069 receive.denyDeletes::
3070 If set to true, git-receive-pack will deny a ref update that deletes
3071 the ref. Use this to prevent such a ref deletion via a push.
3073 receive.denyDeleteCurrent::
3074 If set to true, git-receive-pack will deny a ref update that
3075 deletes the currently checked out branch of a non-bare repository.
3077 receive.denyCurrentBranch::
3078 If set to true or "refuse", git-receive-pack will deny a ref update
3079 to the currently checked out branch of a non-bare repository.
3080 Such a push is potentially dangerous because it brings the HEAD
3081 out of sync with the index and working tree. If set to "warn",
3082 print a warning of such a push to stderr, but allow the push to
3083 proceed. If set to false or "ignore", allow such pushes with no
3084 message. Defaults to "refuse".
3085 +
3086 Another option is "updateInstead" which will update the working
3087 tree if pushing into the current branch. This option is
3088 intended for synchronizing working directories when one side is not easily
3089 accessible via interactive ssh (e.g. a live web site, hence the requirement
3090 that the working directory be clean). This mode also comes in handy when
3091 developing inside a VM to test and fix code on different Operating Systems.
3092 +
3093 By default, "updateInstead" will refuse the push if the working tree or
3094 the index have any difference from the HEAD, but the `push-to-checkout`
3095 hook can be used to customize this. See linkgit:githooks[5].
3097 receive.denyNonFastForwards::
3098 If set to true, git-receive-pack will deny a ref update which is
3099 not a fast-forward. Use this to prevent such an update via a push,
3100 even if that push is forced. This configuration variable is
3101 set when initializing a shared repository.
3103 receive.hideRefs::
3104 This variable is the same as `transfer.hideRefs`, but applies
3105 only to `receive-pack` (and so affects pushes, but not fetches).
3106 An attempt to update or delete a hidden ref by `git push` is
3107 rejected.
3109 receive.updateServerInfo::
3110 If set to true, git-receive-pack will run git-update-server-info
3111 after receiving data from git-push and updating refs.
3113 receive.shallowUpdate::
3114 If set to true, .git/shallow can be updated when new refs
3115 require new shallow roots. Otherwise those refs are rejected.
3117 remote.pushDefault::
3118 The remote to push to by default. Overrides
3119 `branch.<name>.remote` for all branches, and is overridden by
3120 `branch.<name>.pushRemote` for specific branches.
3122 remote.<name>.url::
3123 The URL of a remote repository. See linkgit:git-fetch[1] or
3124 linkgit:git-push[1].
3126 remote.<name>.pushurl::
3127 The push URL of a remote repository. See linkgit:git-push[1].
3129 remote.<name>.proxy::
3130 For remotes that require curl (http, https and ftp), the URL to
3131 the proxy to use for that remote. Set to the empty string to
3132 disable proxying for that remote.
3134 remote.<name>.proxyAuthMethod::
3135 For remotes that require curl (http, https and ftp), the method to use for
3136 authenticating against the proxy in use (probably set in
3137 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3139 remote.<name>.fetch::
3140 The default set of "refspec" for linkgit:git-fetch[1]. See
3141 linkgit:git-fetch[1].
3143 remote.<name>.push::
3144 The default set of "refspec" for linkgit:git-push[1]. See
3145 linkgit:git-push[1].
3147 remote.<name>.mirror::
3148 If true, pushing to this remote will automatically behave
3149 as if the `--mirror` option was given on the command line.
3151 remote.<name>.skipDefaultUpdate::
3152 If true, this remote will be skipped by default when updating
3153 using linkgit:git-fetch[1] or the `update` subcommand of
3154 linkgit:git-remote[1].
3156 remote.<name>.skipFetchAll::
3157 If true, this remote will be skipped by default when updating
3158 using linkgit:git-fetch[1] or the `update` subcommand of
3159 linkgit:git-remote[1].
3161 remote.<name>.receivepack::
3162 The default program to execute on the remote side when pushing. See
3163 option --receive-pack of linkgit:git-push[1].
3165 remote.<name>.uploadpack::
3166 The default program to execute on the remote side when fetching. See
3167 option --upload-pack of linkgit:git-fetch-pack[1].
3169 remote.<name>.tagOpt::
3170 Setting this value to --no-tags disables automatic tag following when
3171 fetching from remote <name>. Setting it to --tags will fetch every
3172 tag from remote <name>, even if they are not reachable from remote
3173 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3174 override this setting. See options --tags and --no-tags of
3175 linkgit:git-fetch[1].
3177 remote.<name>.vcs::
3178 Setting this to a value <vcs> will cause Git to interact with
3179 the remote with the git-remote-<vcs> helper.
3181 remote.<name>.prune::
3182 When set to true, fetching from this remote by default will also
3183 remove any remote-tracking references that no longer exist on the
3184 remote (as if the `--prune` option was given on the command line).
3185 Overrides `fetch.prune` settings, if any.
3187 remote.<name>.pruneTags::
3188 When set to true, fetching from this remote by default will also
3189 remove any local tags that no longer exist on the remote if pruning
3190 is activated in general via `remote.<name>.prune`, `fetch.prune` or
3191 `--prune`. Overrides `fetch.pruneTags` settings, if any.
3192 +
3193 See also `remote.<name>.prune` and the PRUNING section of
3194 linkgit:git-fetch[1].
3196 remotes.<group>::
3197 The list of remotes which are fetched by "git remote update
3198 <group>". See linkgit:git-remote[1].
3200 repack.useDeltaBaseOffset::
3201 By default, linkgit:git-repack[1] creates packs that use
3202 delta-base offset. If you need to share your repository with
3203 Git older than version 1.4.4, either directly or via a dumb
3204 protocol such as http, then you need to set this option to
3205 "false" and repack. Access from old Git versions over the
3206 native protocol are unaffected by this option.
3208 repack.packKeptObjects::
3209 If set to true, makes `git repack` act as if
3210 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3211 details. Defaults to `false` normally, but `true` if a bitmap
3212 index is being written (either via `--write-bitmap-index` or
3213 `repack.writeBitmaps`).
3215 repack.writeBitmaps::
3216 When true, git will write a bitmap index when packing all
3217 objects to disk (e.g., when `git repack -a` is run). This
3218 index can speed up the "counting objects" phase of subsequent
3219 packs created for clones and fetches, at the cost of some disk
3220 space and extra time spent on the initial repack. This has
3221 no effect if multiple packfiles are created.
3222 Defaults to false.
3224 rerere.autoUpdate::
3225 When set to true, `git-rerere` updates the index with the
3226 resulting contents after it cleanly resolves conflicts using
3227 previously recorded resolution. Defaults to false.
3229 rerere.enabled::
3230 Activate recording of resolved conflicts, so that identical
3231 conflict hunks can be resolved automatically, should they be
3232 encountered again. By default, linkgit:git-rerere[1] is
3233 enabled if there is an `rr-cache` directory under the
3234 `$GIT_DIR`, e.g. if "rerere" was previously used in the
3235 repository.
3237 sendemail.identity::
3238 A configuration identity. When given, causes values in the
3239 'sendemail.<identity>' subsection to take precedence over
3240 values in the 'sendemail' section. The default identity is
3241 the value of `sendemail.identity`.
3243 sendemail.smtpEncryption::
3244 See linkgit:git-send-email[1] for description. Note that this
3245 setting is not subject to the 'identity' mechanism.
3247 sendemail.smtpssl (deprecated)::
3248 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3250 sendemail.smtpsslcertpath::
3251 Path to ca-certificates (either a directory or a single file).
3252 Set it to an empty string to disable certificate verification.
3254 sendemail.<identity>.*::
3255 Identity-specific versions of the 'sendemail.*' parameters
3256 found below, taking precedence over those when this
3257 identity is selected, through either the command-line or
3258 `sendemail.identity`.
3260 sendemail.aliasesFile::
3261 sendemail.aliasFileType::
3262 sendemail.annotate::
3263 sendemail.bcc::
3265 sendemail.ccCmd::
3266 sendemail.chainReplyTo::
3267 sendemail.confirm::
3268 sendemail.envelopeSender::
3269 sendemail.from::
3270 sendemail.multiEdit::
3271 sendemail.signedoffbycc::
3272 sendemail.smtpPass::
3273 sendemail.suppresscc::
3274 sendemail.suppressFrom::
3276 sendemail.tocmd::
3277 sendemail.smtpDomain::
3278 sendemail.smtpServer::
3279 sendemail.smtpServerPort::
3280 sendemail.smtpServerOption::
3281 sendemail.smtpUser::
3282 sendemail.thread::
3283 sendemail.transferEncoding::
3284 sendemail.validate::
3285 sendemail.xmailer::
3286 See linkgit:git-send-email[1] for description.
3288 sendemail.signedoffcc (deprecated)::
3289 Deprecated alias for `sendemail.signedoffbycc`.
3291 sendemail.smtpBatchSize::
3292 Number of messages to be sent per connection, after that a relogin
3293 will happen. If the value is 0 or undefined, send all messages in
3294 one connection.
3295 See also the `--batch-size` option of linkgit:git-send-email[1].
3297 sendemail.smtpReloginDelay::
3298 Seconds wait before reconnecting to smtp server.
3299 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3301 showbranch.default::
3302 The default set of branches for linkgit:git-show-branch[1].
3303 See linkgit:git-show-branch[1].
3305 splitIndex.maxPercentChange::
3306 When the split index feature is used, this specifies the
3307 percent of entries the split index can contain compared to the
3308 total number of entries in both the split index and the shared
3309 index before a new shared index is written.
3310 The value should be between 0 and 100. If the value is 0 then
3311 a new shared index is always written, if it is 100 a new
3312 shared index is never written.
3313 By default the value is 20, so a new shared index is written
3314 if the number of entries in the split index would be greater
3315 than 20 percent of the total number of entries.
3316 See linkgit:git-update-index[1].
3318 splitIndex.sharedIndexExpire::
3319 When the split index feature is used, shared index files that
3320 were not modified since the time this variable specifies will
3321 be removed when a new shared index file is created. The value
3322 "now" expires all entries immediately, and "never" suppresses
3323 expiration altogether.
3324 The default value is "2.weeks.ago".
3325 Note that a shared index file is considered modified (for the
3326 purpose of expiration) each time a new split-index file is
3327 either created based on it or read from it.
3328 See linkgit:git-update-index[1].
3330 status.relativePaths::
3331 By default, linkgit:git-status[1] shows paths relative to the
3332 current directory. Setting this variable to `false` shows paths
3333 relative to the repository root (this was the default for Git
3334 prior to v1.5.4).
3336 status.short::
3337 Set to true to enable --short by default in linkgit:git-status[1].
3338 The option --no-short takes precedence over this variable.
3340 status.branch::
3341 Set to true to enable --branch by default in linkgit:git-status[1].
3342 The option --no-branch takes precedence over this variable.
3344 status.displayCommentPrefix::
3345 If set to true, linkgit:git-status[1] will insert a comment
3346 prefix before each output line (starting with
3347 `core.commentChar`, i.e. `#` by default). This was the
3348 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3349 Defaults to false.
3351 status.renameLimit::
3352 The number of files to consider when performing rename detection
3353 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3354 the value of diff.renameLimit.
3356 status.renames::
3357 Whether and how Git detects renames in linkgit:git-status[1] and
3358 linkgit:git-commit[1] . If set to "false", rename detection is
3359 disabled. If set to "true", basic rename detection is enabled.
3360 If set to "copies" or "copy", Git will detect copies, as well.
3361 Defaults to the value of diff.renames.
3363 status.showStash::
3364 If set to true, linkgit:git-status[1] will display the number of
3365 entries currently stashed away.
3366 Defaults to false.
3368 status.showUntrackedFiles::
3369 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3370 files which are not currently tracked by Git. Directories which
3371 contain only untracked files, are shown with the directory name
3372 only. Showing untracked files means that Git needs to lstat() all
3373 the files in the whole repository, which might be slow on some
3374 systems. So, this variable controls how the commands displays
3375 the untracked files. Possible values are:
3376 +
3377 --
3378 * `no` - Show no untracked files.
3379 * `normal` - Show untracked files and directories.
3380 * `all` - Show also individual files in untracked directories.
3381 --
3382 +
3383 If this variable is not specified, it defaults to 'normal'.
3384 This variable can be overridden with the -u|--untracked-files option
3385 of linkgit:git-status[1] and linkgit:git-commit[1].
3387 status.submoduleSummary::
3388 Defaults to false.
3389 If this is set to a non zero number or true (identical to -1 or an
3390 unlimited number), the submodule summary will be enabled and a
3391 summary of commits for modified submodules will be shown (see
3392 --summary-limit option of linkgit:git-submodule[1]). Please note
3393 that the summary output command will be suppressed for all
3394 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3395 for those submodules where `submodule.<name>.ignore=all`. The only
3396 exception to that rule is that status and commit will show staged
3397 submodule changes. To
3398 also view the summary for ignored submodules you can either use
3399 the --ignore-submodules=dirty command-line option or the 'git
3400 submodule summary' command, which shows a similar output but does
3401 not honor these settings.
3403 stash.showPatch::
3404 If this is set to true, the `git stash show` command without an
3405 option will show the stash entry in patch form. Defaults to false.
3406 See description of 'show' command in linkgit:git-stash[1].
3408 stash.showStat::
3409 If this is set to true, the `git stash show` command without an
3410 option will show diffstat of the stash entry. Defaults to true.
3411 See description of 'show' command in linkgit:git-stash[1].
3413 submodule.<name>.url::
3414 The URL for a submodule. This variable is copied from the .gitmodules
3415 file to the git config via 'git submodule init'. The user can change
3416 the configured URL before obtaining the submodule via 'git submodule
3417 update'. If neither submodule.<name>.active or are
3418 set, the presence of this variable is used as a fallback to indicate
3419 whether the submodule is of interest to git commands.
3420 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3422 submodule.<name>.update::
3423 The method by which a submodule is updated by 'git submodule update',
3424 which is the only affected command, others such as
3425 'git checkout --recurse-submodules' are unaffected. It exists for
3426 historical reasons, when 'git submodule' was the only command to
3427 interact with submodules; settings like ``
3428 and `pull.rebase` are more specific. It is populated by
3429 `git submodule init` from the linkgit:gitmodules[5] file.
3430 See description of 'update' command in linkgit:git-submodule[1].
3432 submodule.<name>.branch::
3433 The remote branch name for a submodule, used by `git submodule
3434 update --remote`. Set this option to override the value found in
3435 the `.gitmodules` file. See linkgit:git-submodule[1] and
3436 linkgit:gitmodules[5] for details.
3438 submodule.<name>.fetchRecurseSubmodules::
3439 This option can be used to control recursive fetching of this
3440 submodule. It can be overridden by using the --[no-]recurse-submodules
3441 command-line option to "git fetch" and "git pull".
3442 This setting will override that from in the linkgit:gitmodules[5]
3443 file.
3445 submodule.<name>.ignore::
3446 Defines under what circumstances "git status" and the diff family show
3447 a submodule as modified. When set to "all", it will never be considered
3448 modified (but it will nonetheless show up in the output of status and
3449 commit when it has been staged), "dirty" will ignore all changes
3450 to the submodules work tree and
3451 takes only differences between the HEAD of the submodule and the commit
3452 recorded in the superproject into account. "untracked" will additionally
3453 let submodules with modified tracked files in their work tree show up.
3454 Using "none" (the default when this option is not set) also shows
3455 submodules that have untracked files in their work tree as changed.
3456 This setting overrides any setting made in .gitmodules for this submodule,
3457 both settings can be overridden on the command line by using the
3458 "--ignore-submodules" option. The 'git submodule' commands are not
3459 affected by this setting.
3461 submodule.<name>.active::
3462 Boolean value indicating if the submodule is of interest to git
3463 commands. This config option takes precedence over the
3464 config option. See linkgit:gitsubmodules[7] for
3465 details.
3468 A repeated field which contains a pathspec used to match against a
3469 submodule's path to determine if the submodule is of interest to git
3470 commands. See linkgit:gitsubmodules[7] for details.
3472 submodule.recurse::
3473 Specifies if commands recurse into submodules by default. This
3474 applies to all commands that have a `--recurse-submodules` option,
3475 except `clone`.
3476 Defaults to false.
3478 submodule.fetchJobs::
3479 Specifies how many submodules are fetched/cloned at the same time.
3480 A positive integer allows up to that number of submodules fetched
3481 in parallel. A value of 0 will give some reasonable default.
3482 If unset, it defaults to 1.
3484 submodule.alternateLocation::
3485 Specifies how the submodules obtain alternates when submodules are
3486 cloned. Possible values are `no`, `superproject`.
3487 By default `no` is assumed, which doesn't add references. When the
3488 value is set to `superproject` the submodule to be cloned computes
3489 its alternates location relative to the superprojects alternate.
3491 submodule.alternateErrorStrategy::
3492 Specifies how to treat errors with the alternates for a submodule
3493 as computed via `submodule.alternateLocation`. Possible values are
3494 `ignore`, `info`, `die`. Default is `die`.
3496 tag.forceSignAnnotated::
3497 A boolean to specify whether annotated tags created should be GPG signed.
3498 If `--annotate` is specified on the command line, it takes
3499 precedence over this option.
3501 tag.sort::
3502 This variable controls the sort ordering of tags when displayed by
3503 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3504 value of this variable will be used as the default.
3506 tar.umask::
3507 This variable can be used to restrict the permission bits of
3508 tar archive entries. The default is 0002, which turns off the
3509 world write bit. The special value "user" indicates that the
3510 archiving user's umask will be used instead. See umask(2) and
3511 linkgit:git-archive[1].
3513 transfer.fsckObjects::
3514 When `fetch.fsckObjects` or `receive.fsckObjects` are
3515 not set, the value of this variable is used instead.
3516 Defaults to false.
3517 +
3518 When set, the fetch or receive will abort in the case of a malformed
3519 object or a link to a nonexistent object. In addition, various other
3520 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
3521 and potential security issues like the existence of a `.GIT` directory
3522 or a malicious `.gitmodules` file (see the release notes for v2.2.1
3523 and v2.17.1 for details). Other sanity and security checks may be
3524 added in future releases.
3525 +
3526 On the receiving side, failing fsckObjects will make those objects
3527 unreachable, see "QUARANTINE ENVIRONMENT" in
3528 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
3529 instead be left unreferenced in the repository.
3530 +
3531 Due to the non-quarantine nature of the `fetch.fsckObjects`
3532 implementation it can not be relied upon to leave the object store
3533 clean like `receive.fsckObjects` can.
3534 +
3535 As objects are unpacked they're written to the object store, so there
3536 can be cases where malicious objects get introduced even though the
3537 "fetch" failed, only to have a subsequent "fetch" succeed because only
3538 new incoming objects are checked, not those that have already been
3539 written to the object store. That difference in behavior should not be
3540 relied upon. In the future, such objects may be quarantined for
3541 "fetch" as well.
3542 +
3543 For now, the paranoid need to find some way to emulate the quarantine
3544 environment if they'd like the same protection as "push". E.g. in the
3545 case of an internal mirror do the mirroring in two steps, one to fetch
3546 the untrusted objects, and then do a second "push" (which will use the
3547 quarantine) to another internal repo, and have internal clients
3548 consume this pushed-to repository, or embargo internal fetches and
3549 only allow them once a full "fsck" has run (and no new fetches have
3550 happened in the meantime).
3552 transfer.hideRefs::
3553 String(s) `receive-pack` and `upload-pack` use to decide which
3554 refs to omit from their initial advertisements. Use more than
3555 one definition to specify multiple prefix strings. A ref that is
3556 under the hierarchies listed in the value of this variable is
3557 excluded, and is hidden when responding to `git push` or `git
3558 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3559 program-specific versions of this config.
3560 +
3561 You may also include a `!` in front of the ref name to negate the entry,
3562 explicitly exposing it, even if an earlier entry marked it as hidden.
3563 If you have multiple hideRefs values, later entries override earlier ones
3564 (and entries in more-specific config files override less-specific ones).
3565 +
3566 If a namespace is in use, the namespace prefix is stripped from each
3567 reference before it is matched against `transfer.hiderefs` patterns.
3568 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3569 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3570 is omitted from the advertisements but `refs/heads/master` and
3571 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3572 "have" lines. In order to match refs before stripping, add a `^` in front of
3573 the ref name. If you combine `!` and `^`, `!` must be specified first.
3574 +
3575 Even if you hide refs, a client may still be able to steal the target
3576 objects via the techniques described in the "SECURITY" section of the
3577 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3578 separate repository.
3580 transfer.unpackLimit::
3581 When `fetch.unpackLimit` or `receive.unpackLimit` are
3582 not set, the value of this variable is used instead.
3583 The default value is 100.
3585 uploadarchive.allowUnreachable::
3586 If true, allow clients to use `git archive --remote` to request
3587 any tree, whether reachable from the ref tips or not. See the
3588 discussion in the "SECURITY" section of
3589 linkgit:git-upload-archive[1] for more details. Defaults to
3590 `false`.
3592 uploadpack.hideRefs::
3593 This variable is the same as `transfer.hideRefs`, but applies
3594 only to `upload-pack` (and so affects only fetches, not pushes).
3595 An attempt to fetch a hidden ref by `git fetch` will fail. See
3596 also `uploadpack.allowTipSHA1InWant`.
3598 uploadpack.allowTipSHA1InWant::
3599 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3600 to accept a fetch request that asks for an object at the tip
3601 of a hidden ref (by default, such a request is rejected).
3602 See also `uploadpack.hideRefs`. Even if this is false, a client
3603 may be able to steal objects via the techniques described in the
3604 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3605 best to keep private data in a separate repository.
3607 uploadpack.allowReachableSHA1InWant::
3608 Allow `upload-pack` to accept a fetch request that asks for an
3609 object that is reachable from any ref tip. However, note that
3610 calculating object reachability is computationally expensive.
3611 Defaults to `false`. Even if this is false, a client may be able
3612 to steal objects via the techniques described in the "SECURITY"
3613 section of the linkgit:gitnamespaces[7] man page; it's best to
3614 keep private data in a separate repository.
3616 uploadpack.allowAnySHA1InWant::
3617 Allow `upload-pack` to accept a fetch request that asks for any
3618 object at all.
3619 Defaults to `false`.
3621 uploadpack.keepAlive::
3622 When `upload-pack` has started `pack-objects`, there may be a
3623 quiet period while `pack-objects` prepares the pack. Normally
3624 it would output progress information, but if `--quiet` was used
3625 for the fetch, `pack-objects` will output nothing at all until
3626 the pack data begins. Some clients and networks may consider
3627 the server to be hung and give up. Setting this option instructs
3628 `upload-pack` to send an empty keepalive packet every
3629 `uploadpack.keepAlive` seconds. Setting this option to 0
3630 disables keepalive packets entirely. The default is 5 seconds.
3632 uploadpack.packObjectsHook::
3633 If this option is set, when `upload-pack` would run
3634 `git pack-objects` to create a packfile for a client, it will
3635 run this shell command instead. The `pack-objects` command and
3636 arguments it _would_ have run (including the `git pack-objects`
3637 at the beginning) are appended to the shell command. The stdin
3638 and stdout of the hook are treated as if `pack-objects` itself
3639 was run. I.e., `upload-pack` will feed input intended for
3640 `pack-objects` to the hook, and expects a completed packfile on
3641 stdout.
3643 uploadpack.allowFilter::
3644 If this option is set, `upload-pack` will support partial
3645 clone and partial fetch object filtering.
3646 +
3647 Note that this configuration variable is ignored if it is seen in the
3648 repository-level config (this is a safety measure against fetching from
3649 untrusted repositories).
3651 uploadpack.allowRefInWant::
3652 If this option is set, `upload-pack` will support the `ref-in-want`
3653 feature of the protocol version 2 `fetch` command. This feature
3654 is intended for the benefit of load-balanced servers which may
3655 not have the same view of what OIDs their refs point to due to
3656 replication delay.
3658 url.<base>.insteadOf::
3659 Any URL that starts with this value will be rewritten to
3660 start, instead, with <base>. In cases where some site serves a
3661 large number of repositories, and serves them with multiple
3662 access methods, and some users need to use different access
3663 methods, this feature allows people to specify any of the
3664 equivalent URLs and have Git automatically rewrite the URL to
3665 the best alternative for the particular user, even for a
3666 never-before-seen repository on the site. When more than one
3667 insteadOf strings match a given URL, the longest match is used.
3668 +
3669 Note that any protocol restrictions will be applied to the rewritten
3670 URL. If the rewrite changes the URL to use a custom protocol or remote
3671 helper, you may need to adjust the `protocol.*.allow` config to permit
3672 the request. In particular, protocols you expect to use for submodules
3673 must be set to `always` rather than the default of `user`. See the
3674 description of `protocol.allow` above.
3676 url.<base>.pushInsteadOf::
3677 Any URL that starts with this value will not be pushed to;
3678 instead, it will be rewritten to start with <base>, and the
3679 resulting URL will be pushed to. In cases where some site serves
3680 a large number of repositories, and serves them with multiple
3681 access methods, some of which do not allow push, this feature
3682 allows people to specify a pull-only URL and have Git
3683 automatically use an appropriate URL to push, even for a
3684 never-before-seen repository on the site. When more than one
3685 pushInsteadOf strings match a given URL, the longest match is
3686 used. If a remote has an explicit pushurl, Git will ignore this
3687 setting for that remote.
3690 Your email address to be recorded in any newly created commits.
3691 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3692 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3695 Your full name to be recorded in any newly created commits.
3696 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3697 environment variables. See linkgit:git-commit-tree[1].
3699 user.useConfigOnly::
3700 Instruct Git to avoid trying to guess defaults for ``
3701 and ``, and instead retrieve the values only from the
3702 configuration. For example, if you have multiple email addresses
3703 and would like to use a different one for each repository, then
3704 with this configuration option set to `true` in the global config
3705 along with a name, Git will prompt you to set up an email before
3706 making new commits in a newly cloned repository.
3707 Defaults to `false`.
3709 user.signingKey::
3710 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3711 key you want it to automatically when creating a signed tag or
3712 commit, you can override the default selection with this variable.
3713 This option is passed unchanged to gpg's --local-user parameter,
3714 so you may specify a key using any method that gpg supports.
3716 versionsort.prereleaseSuffix (deprecated)::
3717 Deprecated alias for `versionsort.suffix`. Ignored if
3718 `versionsort.suffix` is set.
3720 versionsort.suffix::
3721 Even when version sort is used in linkgit:git-tag[1], tagnames
3722 with the same base version but different suffixes are still sorted
3723 lexicographically, resulting e.g. in prerelease tags appearing
3724 after the main release (e.g. "1.0-rc1" after "1.0"). This
3725 variable can be specified to determine the sorting order of tags
3726 with different suffixes.
3727 +
3728 By specifying a single suffix in this variable, any tagname containing
3729 that suffix will appear before the corresponding main release. E.g. if
3730 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3731 "1.0". If specified multiple times, once per suffix, then the order of
3732 suffixes in the configuration will determine the sorting order of tagnames
3733 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3734 configuration, then all "1.0-preX" tags will be listed before any
3735 "1.0-rcX" tags. The placement of the main release tag relative to tags
3736 with various suffixes can be determined by specifying the empty suffix
3737 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3738 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3739 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3740 "v4.8-bfsX".
3741 +
3742 If more than one suffixes match the same tagname, then that tagname will
3743 be sorted according to the suffix which starts at the earliest position in
3744 the tagname. If more than one different matching suffixes start at
3745 that earliest position, then that tagname will be sorted according to the
3746 longest of those suffixes.
3747 The sorting order between different suffixes is undefined if they are
3748 in multiple config files.
3750 web.browser::
3751 Specify a web browser that may be used by some commands.
3752 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3753 may use it.
3755 worktree.guessRemote::
3756 With `add`, if no branch argument, and neither of `-b` nor
3757 `-B` nor `--detach` are given, the command defaults to
3758 creating a new branch from HEAD. If `worktree.guessRemote` is
3759 set to true, `worktree add` tries to find a remote-tracking
3760 branch whose name uniquely matches the new branch name. If
3761 such a branch exists, it is checked out and set as "upstream"
3762 for the new branch. If no such match can be found, it falls
3763 back to creating a new branch from the current HEAD.