[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 core.commitGraph::
931 If true, then git will read the commit-graph file (if it exists)
932 to parse the graph structure of commits. Defaults to false. See
933 linkgit:git-commit-graph[1] for more information.
935 core.useReplaceRefs::
936 If set to `false`, behave as if the `--no-replace-objects`
937 option was given on the command line. See linkgit:git[1] and
938 linkgit:git-replace[1] for more information.
940 core.multiPackIndex::
941 Use the multi-pack-index file to track multiple packfiles using a
942 single index. See link:technical/multi-pack-index.html[the
943 multi-pack-index design document].
945 core.sparseCheckout::
946 Enable "sparse checkout" feature. See section "Sparse checkout" in
947 linkgit:git-read-tree[1] for more information.
949 core.abbrev::
950 Set the length object names are abbreviated to. If
951 unspecified or set to "auto", an appropriate value is
952 computed based on the approximate number of packed objects
953 in your repository, which hopefully is enough for
954 abbreviated object names to stay unique for some time.
955 The minimum length is 4.
957 add.ignoreErrors::
958 add.ignore-errors (deprecated)::
959 Tells 'git add' to continue adding files when some files cannot be
960 added due to indexing errors. Equivalent to the `--ignore-errors`
961 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
962 as it does not follow the usual naming convention for configuration
963 variables.
965 alias.*::
966 Command aliases for the linkgit:git[1] command wrapper - e.g.
967 after defining "alias.last = cat-file commit HEAD", the invocation
968 "git last" is equivalent to "git cat-file commit HEAD". To avoid
969 confusion and troubles with script usage, aliases that
970 hide existing Git commands are ignored. Arguments are split by
971 spaces, the usual shell quoting and escaping is supported.
972 A quote pair or a backslash can be used to quote them.
973 +
974 If the alias expansion is prefixed with an exclamation point,
975 it will be treated as a shell command. For example, defining
976 " = !gitk --all --not ORIG_HEAD", the invocation
977 "git new" is equivalent to running the shell command
978 "gitk --all --not ORIG_HEAD". Note that shell commands will be
979 executed from the top-level directory of a repository, which may
980 not necessarily be the current directory.
981 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
982 from the original current directory. See linkgit:git-rev-parse[1].
984 am.keepcr::
985 If true, git-am will call git-mailsplit for patches in mbox format
986 with parameter `--keep-cr`. In this case git-mailsplit will
987 not remove `\r` from lines ending with `\r\n`. Can be overridden
988 by giving `--no-keep-cr` from the command line.
989 See linkgit:git-am[1], linkgit:git-mailsplit[1].
991 am.threeWay::
992 By default, `git am` will fail if the patch does not apply cleanly. When
993 set to true, this setting tells `git am` to fall back on 3-way merge if
994 the patch records the identity of blobs it is supposed to apply to and
995 we have those blobs available locally (equivalent to giving the `--3way`
996 option from the command line). Defaults to `false`.
997 See linkgit:git-am[1].
999 apply.ignoreWhitespace::
1000 When set to 'change', tells 'git apply' to ignore changes in
1001 whitespace, in the same way as the `--ignore-space-change`
1002 option.
1003 When set to one of: no, none, never, false tells 'git apply' to
1004 respect all whitespace differences.
1005 See linkgit:git-apply[1].
1007 apply.whitespace::
1008 Tells 'git apply' how to handle whitespaces, in the same way
1009 as the `--whitespace` option. See linkgit:git-apply[1].
1011 blame.blankBoundary::
1012 Show blank commit object name for boundary commits in
1013 linkgit:git-blame[1]. This option defaults to false.
1015 blame.coloring::
1016 This determines the coloring scheme to be applied to blame
1017 output. It can be 'repeatedLines', 'highlightRecent',
1018 or 'none' which is the default.
1021 Specifies the format used to output dates in linkgit:git-blame[1].
1022 If unset the iso format is used. For supported values,
1023 see the discussion of the `--date` option at linkgit:git-log[1].
1025 blame.showEmail::
1026 Show the author email instead of author name in linkgit:git-blame[1].
1027 This option defaults to false.
1029 blame.showRoot::
1030 Do not treat root commits as boundaries in linkgit:git-blame[1].
1031 This option defaults to false.
1033 branch.autoSetupMerge::
1034 Tells 'git branch' and 'git checkout' to set up new branches
1035 so that linkgit:git-pull[1] will appropriately merge from the
1036 starting point branch. Note that even if this option is not set,
1037 this behavior can be chosen per-branch using the `--track`
1038 and `--no-track` options. The valid settings are: `false` -- no
1039 automatic setup is done; `true` -- automatic setup is done when the
1040 starting point is a remote-tracking branch; `always` --
1041 automatic setup is done when the starting point is either a
1042 local branch or remote-tracking
1043 branch. This option defaults to true.
1045 branch.autoSetupRebase::
1046 When a new branch is created with 'git branch' or 'git checkout'
1047 that tracks another branch, this variable tells Git to set
1048 up pull to rebase instead of merge (see "branch.<name>.rebase").
1049 When `never`, rebase is never automatically set to true.
1050 When `local`, rebase is set to true for tracked branches of
1051 other local branches.
1052 When `remote`, rebase is set to true for tracked branches of
1053 remote-tracking branches.
1054 When `always`, rebase will be set to true for all tracking
1055 branches.
1056 See "branch.autoSetupMerge" for details on how to set up a
1057 branch to track another branch.
1058 This option defaults to never.
1060 branch.sort::
1061 This variable controls the sort ordering of branches when displayed by
1062 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1063 value of this variable will be used as the default.
1064 See linkgit:git-for-each-ref[1] field names for valid values.
1066 branch.<name>.remote::
1067 When on branch <name>, it tells 'git fetch' and 'git push'
1068 which remote to fetch from/push to. The remote to push to
1069 may be overridden with `remote.pushDefault` (for all branches).
1070 The remote to push to, for the current branch, may be further
1071 overridden by `branch.<name>.pushRemote`. If no remote is
1072 configured, or if you are not on any branch, it defaults to
1073 `origin` for fetching and `remote.pushDefault` for pushing.
1074 Additionally, `.` (a period) is the current local repository
1075 (a dot-repository), see `branch.<name>.merge`'s final note below.
1077 branch.<name>.pushRemote::
1078 When on branch <name>, it overrides `branch.<name>.remote` for
1079 pushing. It also overrides `remote.pushDefault` for pushing
1080 from branch <name>. When you pull from one place (e.g. your
1081 upstream) and push to another place (e.g. your own publishing
1082 repository), you would want to set `remote.pushDefault` to
1083 specify the remote to push to for all branches, and use this
1084 option to override it for a specific branch.
1086 branch.<name>.merge::
1087 Defines, together with branch.<name>.remote, the upstream branch
1088 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1089 branch to merge and can also affect 'git push' (see push.default).
1090 When in branch <name>, it tells 'git fetch' the default
1091 refspec to be marked for merging in FETCH_HEAD. The value is
1092 handled like the remote part of a refspec, and must match a
1093 ref which is fetched from the remote given by
1094 "branch.<name>.remote".
1095 The merge information is used by 'git pull' (which at first calls
1096 'git fetch') to lookup the default branch for merging. Without
1097 this option, 'git pull' defaults to merge the first refspec fetched.
1098 Specify multiple values to get an octopus merge.
1099 If you wish to setup 'git pull' so that it merges into <name> from
1100 another branch in the local repository, you can point
1101 branch.<name>.merge to the desired branch, and use the relative path
1102 setting `.` (a period) for branch.<name>.remote.
1104 branch.<name>.mergeOptions::
1105 Sets default options for merging into branch <name>. The syntax and
1106 supported options are the same as those of linkgit:git-merge[1], but
1107 option values containing whitespace characters are currently not
1108 supported.
1110 branch.<name>.rebase::
1111 When true, rebase the branch <name> on top of the fetched branch,
1112 instead of merging the default branch from the default remote when
1113 "git pull" is run. See "pull.rebase" for doing this in a non
1114 branch-specific manner.
1115 +
1116 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1117 so that the local merge commits are included in the rebase (see
1118 linkgit:git-rebase[1] for details).
1119 +
1120 When preserve, also pass `--preserve-merges` along to 'git rebase'
1121 so that locally committed merge commits will not be flattened
1122 by running 'git pull'.
1123 +
1124 When the value is `interactive`, the rebase is run in interactive mode.
1125 +
1126 *NOTE*: this is a possibly dangerous operation; do *not* use
1127 it unless you understand the implications (see linkgit:git-rebase[1]
1128 for details).
1130 branch.<name>.description::
1131 Branch description, can be edited with
1132 `git branch --edit-description`. Branch description is
1133 automatically added in the format-patch cover letter or
1134 request-pull summary.
1136 browser.<tool>.cmd::
1137 Specify the command to invoke the specified browser. The
1138 specified command is evaluated in shell with the URLs passed
1139 as arguments. (See linkgit:git-web{litdd}browse[1].)
1141 browser.<tool>.path::
1142 Override the path for the given tool that may be used to
1143 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1144 working repository in gitweb (see linkgit:git-instaweb[1]).
1146 checkout.defaultRemote::
1147 When you run 'git checkout <something>' and only have one
1148 remote, it may implicitly fall back on checking out and
1149 tracking e.g. 'origin/<something>'. This stops working as soon
1150 as you have more than one remote with a '<something>'
1151 reference. This setting allows for setting the name of a
1152 preferred remote that should always win when it comes to
1153 disambiguation. The typical use-case is to set this to
1154 `origin`.
1155 +
1156 Currently this is used by linkgit:git-checkout[1] when 'git checkout
1157 <something>' will checkout the '<something>' branch on another remote,
1158 and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1159 remote branch. This setting might be used for other checkout-like
1160 commands or functionality in the future.
1162 checkout.optimizeNewBranch::
1163 Optimizes the performance of "git checkout -b <new_branch>" when
1164 using sparse-checkout. When set to true, git will not update the
1165 repo based on the current sparse-checkout settings. This means it
1166 will not update the skip-worktree bit in the index nor add/remove
1167 files in the working directory to reflect the current sparse checkout
1168 settings nor will it show the local changes.
1170 clean.requireForce::
1171 A boolean to make git-clean do nothing unless given -f,
1172 -i or -n. Defaults to true.
1174 color.advice::
1175 A boolean to enable/disable color in hints (e.g. when a push
1176 failed, see `advice.*` for a list). May be set to `always`,
1177 `false` (or `never`) or `auto` (or `true`), in which case colors
1178 are used only when the error output goes to a terminal. If
1179 unset, then the value of `color.ui` is used (`auto` by default).
1181 color.advice.hint::
1182 Use customized color for hints.
1184 color.blame.highlightRecent::
1185 This can be used to color the metadata of a blame line depending
1186 on age of the line.
1187 +
1188 This setting should be set to a comma-separated list of color and date settings,
1189 starting and ending with a color, the dates should be set from oldest to newest.
1190 The metadata will be colored given the colors if the the line was introduced
1191 before the given timestamp, overwriting older timestamped colors.
1192 +
1193 Instead of an absolute timestamp relative timestamps work as well, e.g.
1194 2.weeks.ago is valid to address anything older than 2 weeks.
1195 +
1196 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1197 everything older than one year blue, recent changes between one month and
1198 one year old are kept white, and lines introduced within the last month are
1199 colored red.
1201 color.blame.repeatedLines::
1202 Use the customized color for the part of git-blame output that
1203 is repeated meta information per line (such as commit id,
1204 author name, date and timezone). Defaults to cyan.
1206 color.branch::
1207 A boolean to enable/disable color in the output of
1208 linkgit:git-branch[1]. May be set to `always`,
1209 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1210 only when the output is to a terminal. If unset, then the
1211 value of `color.ui` is used (`auto` by default).
1213 color.branch.<slot>::
1214 Use customized color for branch coloration. `<slot>` is one of
1215 `current` (the current branch), `local` (a local branch),
1216 `remote` (a remote-tracking branch in refs/remotes/),
1217 `upstream` (upstream tracking branch), `plain` (other
1218 refs).
1220 color.diff::
1221 Whether to use ANSI escape sequences to add color to patches.
1222 If this is set to `always`, linkgit:git-diff[1],
1223 linkgit:git-log[1], and linkgit:git-show[1] will use color
1224 for all patches. If it is set to `true` or `auto`, those
1225 commands will only use color when output is to the terminal.
1226 If unset, then the value of `color.ui` is used (`auto` by
1227 default).
1228 +
1229 This does not affect linkgit:git-format-patch[1] or the
1230 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1231 command line with the `--color[=<when>]` option.
1233 color.diff.<slot>::
1234 Use customized color for diff colorization. `<slot>` specifies
1235 which part of the patch to use the specified color, and is one
1236 of `context` (context text - `plain` is a historical synonym),
1237 `meta` (metainformation), `frag`
1238 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1239 `new` (added lines), `commit` (commit headers), `whitespace`
1240 (highlighting whitespace errors), `oldMoved` (deleted lines),
1241 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1242 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1243 `newMovedAlternativeDimmed` (See the '<mode>'
1244 setting of '--color-moved' in linkgit:git-diff[1] for details),
1245 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1246 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1248 color.decorate.<slot>::
1249 Use customized color for 'git log --decorate' output. `<slot>` is one
1250 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1251 branches, remote-tracking branches, tags, stash and HEAD, respectively
1252 and `grafted` for grafted commits.
1254 color.grep::
1255 When set to `always`, always highlight matches. When `false` (or
1256 `never`), never. When set to `true` or `auto`, use color only
1257 when the output is written to the terminal. If unset, then the
1258 value of `color.ui` is used (`auto` by default).
1260 color.grep.<slot>::
1261 Use customized color for grep colorization. `<slot>` specifies which
1262 part of the line to use the specified color, and is one of
1263 +
1264 --
1265 `context`;;
1266 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1267 `filename`;;
1268 filename prefix (when not using `-h`)
1269 `function`;;
1270 function name lines (when using `-p`)
1271 `lineNumber`;;
1272 line number prefix (when using `-n`)
1273 `column`;;
1274 column number prefix (when using `--column`)
1275 `match`;;
1276 matching text (same as setting `matchContext` and `matchSelected`)
1277 `matchContext`;;
1278 matching text in context lines
1279 `matchSelected`;;
1280 matching text in selected lines
1281 `selected`;;
1282 non-matching text in selected lines
1283 `separator`;;
1284 separators between fields on a line (`:`, `-`, and `=`)
1285 and between hunks (`--`)
1286 --
1288 color.interactive::
1289 When set to `always`, always use colors for interactive prompts
1290 and displays (such as those used by "git-add --interactive" and
1291 "git-clean --interactive"). When false (or `never`), never.
1292 When set to `true` or `auto`, use colors only when the output is
1293 to the terminal. If unset, then the value of `color.ui` is
1294 used (`auto` by default).
1296 color.interactive.<slot>::
1297 Use customized color for 'git add --interactive' and 'git clean
1298 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1299 or `error`, for four distinct types of normal output from
1300 interactive commands.
1302 color.pager::
1303 A boolean to enable/disable colored output when the pager is in
1304 use (default is true).
1306 color.push::
1307 A boolean to enable/disable color in push errors. May be set to
1308 `always`, `false` (or `never`) or `auto` (or `true`), in which
1309 case colors are used only when the error output goes to a terminal.
1310 If unset, then the value of `color.ui` is used (`auto` by default).
1312 color.push.error::
1313 Use customized color for push errors.
1315 color.remote::
1316 If set, keywords at the start of the line are highlighted. The
1317 keywords are "error", "warning", "hint" and "success", and are
1318 matched case-insensitively. May be set to `always`, `false` (or
1319 `never`) or `auto` (or `true`). If unset, then the value of
1320 `color.ui` is used (`auto` by default).
1322 color.remote.<slot>::
1323 Use customized color for each remote keyword. `<slot>` may be
1324 `hint`, `warning`, `success` or `error` which match the
1325 corresponding keyword.
1327 color.showBranch::
1328 A boolean to enable/disable color in the output of
1329 linkgit:git-show-branch[1]. May be set to `always`,
1330 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1331 only when the output is to a terminal. If unset, then the
1332 value of `color.ui` is used (`auto` by default).
1334 color.status::
1335 A boolean to enable/disable color in the output of
1336 linkgit:git-status[1]. May be set to `always`,
1337 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1338 only when the output is to a terminal. If unset, then the
1339 value of `color.ui` is used (`auto` by default).
1341 color.status.<slot>::
1342 Use customized color for status colorization. `<slot>` is
1343 one of `header` (the header text of the status message),
1344 `added` or `updated` (files which are added but not committed),
1345 `changed` (files which are changed but not added in the index),
1346 `untracked` (files which are not tracked by Git),
1347 `branch` (the current branch),
1348 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1349 to red),
1350 `localBranch` or `remoteBranch` (the local and remote branch names,
1351 respectively, when branch and tracking information is displayed in the
1352 status short-format), or
1353 `unmerged` (files which have unmerged changes).
1355 color.transport::
1356 A boolean to enable/disable color when pushes are rejected. May be
1357 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1358 case colors are used only when the error output goes to a terminal.
1359 If unset, then the value of `color.ui` is used (`auto` by default).
1361 color.transport.rejected::
1362 Use customized color when a push was rejected.
1364 color.ui::
1365 This variable determines the default value for variables such
1366 as `color.diff` and `color.grep` that control the use of color
1367 per command family. Its scope will expand as more commands learn
1368 configuration to set a default for the `--color` option. Set it
1369 to `false` or `never` if you prefer Git commands not to use
1370 color unless enabled explicitly with some other configuration
1371 or the `--color` option. Set it to `always` if you want all
1372 output not intended for machine consumption to use color, to
1373 `true` or `auto` (this is the default since Git 1.8.4) if you
1374 want such output to use color when written to the terminal.
1376 column.ui::
1377 Specify whether supported commands should output in columns.
1378 This variable consists of a list of tokens separated by spaces
1379 or commas:
1380 +
1381 These options control when the feature should be enabled
1382 (defaults to 'never'):
1383 +
1384 --
1385 `always`;;
1386 always show in columns
1387 `never`;;
1388 never show in columns
1389 `auto`;;
1390 show in columns if the output is to the terminal
1391 --
1392 +
1393 These options control layout (defaults to 'column'). Setting any
1394 of these implies 'always' if none of 'always', 'never', or 'auto' are
1395 specified.
1396 +
1397 --
1398 `column`;;
1399 fill columns before rows
1400 `row`;;
1401 fill rows before columns
1402 `plain`;;
1403 show in one column
1404 --
1405 +
1406 Finally, these options can be combined with a layout option (defaults
1407 to 'nodense'):
1408 +
1409 --
1410 `dense`;;
1411 make unequal size columns to utilize more space
1412 `nodense`;;
1413 make equal size columns
1414 --
1416 column.branch::
1417 Specify whether to output branch listing in `git branch` in columns.
1418 See `column.ui` for details.
1420 column.clean::
1421 Specify the layout when list items in `git clean -i`, which always
1422 shows files and directories in columns. See `column.ui` for details.
1424 column.status::
1425 Specify whether to output untracked files in `git status` in columns.
1426 See `column.ui` for details.
1428 column.tag::
1429 Specify whether to output tag listing in `git tag` in columns.
1430 See `column.ui` for details.
1432 commit.cleanup::
1433 This setting overrides the default of the `--cleanup` option in
1434 `git commit`. See linkgit:git-commit[1] for details. Changing the
1435 default can be useful when you always want to keep lines that begin
1436 with comment character `#` in your log message, in which case you
1437 would do `git config commit.cleanup whitespace` (note that you will
1438 have to remove the help lines that begin with `#` in the commit log
1439 template yourself, if you do this).
1441 commit.gpgSign::
1443 A boolean to specify whether all commits should be GPG signed.
1444 Use of this option when doing operations such as rebase can
1445 result in a large number of commits being signed. It may be
1446 convenient to use an agent to avoid typing your GPG passphrase
1447 several times.
1449 commit.status::
1450 A boolean to enable/disable inclusion of status information in the
1451 commit message template when using an editor to prepare the commit
1452 message. Defaults to true.
1454 commit.template::
1455 Specify the pathname of a file to use as the template for
1456 new commit messages.
1458 commit.verbose::
1459 A boolean or int to specify the level of verbose with `git commit`.
1460 See linkgit:git-commit[1].
1462 credential.helper::
1463 Specify an external helper to be called when a username or
1464 password credential is needed; the helper may consult external
1465 storage to avoid prompting the user for the credentials. Note
1466 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1467 for details.
1469 credential.useHttpPath::
1470 When acquiring credentials, consider the "path" component of an http
1471 or https URL to be important. Defaults to false. See
1472 linkgit:gitcredentials[7] for more information.
1474 credential.username::
1475 If no username is set for a network authentication, use this username
1476 by default. See credential.<context>.* below, and
1477 linkgit:gitcredentials[7].
1479 credential.<url>.*::
1480 Any of the credential.* options above can be applied selectively to
1481 some credentials. For example "credential."
1482 would set the default username only for https connections to
1483 See linkgit:gitcredentials[7] for details on how URLs are
1484 matched.
1486 credentialCache.ignoreSIGHUP::
1487 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1489 completion.commands::
1490 This is only used by git-completion.bash to add or remove
1491 commands from the list of completed commands. Normally only
1492 porcelain commands and a few select others are completed. You
1493 can add more commands, separated by space, in this
1494 variable. Prefixing the command with '-' will remove it from
1495 the existing list.
1497 include::diff-config.txt[]
1499 difftool.<tool>.path::
1500 Override the path for the given tool. This is useful in case
1501 your tool is not in the PATH.
1503 difftool.<tool>.cmd::
1504 Specify the command to invoke the specified diff tool.
1505 The specified command is evaluated in shell with the following
1506 variables available: 'LOCAL' is set to the name of the temporary
1507 file containing the contents of the diff pre-image and 'REMOTE'
1508 is set to the name of the temporary file containing the contents
1509 of the diff post-image.
1511 difftool.prompt::
1512 Prompt before each invocation of the diff tool.
1514 fastimport.unpackLimit::
1515 If the number of objects imported by linkgit:git-fast-import[1]
1516 is below this limit, then the objects will be unpacked into
1517 loose object files. However if the number of imported objects
1518 equals or exceeds this limit then the pack will be stored as a
1519 pack. Storing the pack from a fast-import can make the import
1520 operation complete faster, especially on slow filesystems. If
1521 not set, the value of `transfer.unpackLimit` is used instead.
1523 fetch.recurseSubmodules::
1524 This option can be either set to a boolean value or to 'on-demand'.
1525 Setting it to a boolean changes the behavior of fetch and pull to
1526 unconditionally recurse into submodules when set to true or to not
1527 recurse at all when set to false. When set to 'on-demand' (the default
1528 value), fetch and pull will only recurse into a populated submodule
1529 when its superproject retrieves a commit that updates the submodule's
1530 reference.
1532 fetch.fsckObjects::
1533 If it is set to true, git-fetch-pack will check all fetched
1534 objects. See `transfer.fsckObjects` for what's
1535 checked. Defaults to false. If not set, the value of
1536 `transfer.fsckObjects` is used instead.
1538 fetch.fsck.<msg-id>::
1539 Acts like `fsck.<msg-id>`, but is used by
1540 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1541 the `fsck.<msg-id>` documentation for details.
1543 fetch.fsck.skipList::
1544 Acts like `fsck.skipList`, but is used by
1545 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1546 the `fsck.skipList` documentation for details.
1548 fetch.unpackLimit::
1549 If the number of objects fetched over the Git native
1550 transfer is below this
1551 limit, then the objects will be unpacked into loose object
1552 files. However if the number of received objects equals or
1553 exceeds this limit then the received pack will be stored as
1554 a pack, after adding any missing delta bases. Storing the
1555 pack from a push can make the push operation complete faster,
1556 especially on slow filesystems. If not set, the value of
1557 `transfer.unpackLimit` is used instead.
1559 fetch.prune::
1560 If true, fetch will automatically behave as if the `--prune`
1561 option was given on the command line. See also `remote.<name>.prune`
1562 and the PRUNING section of linkgit:git-fetch[1].
1564 fetch.pruneTags::
1565 If true, fetch will automatically behave as if the
1566 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1567 if not set already. This allows for setting both this option
1568 and `fetch.prune` to maintain a 1=1 mapping to upstream
1569 refs. See also `remote.<name>.pruneTags` and the PRUNING
1570 section of linkgit:git-fetch[1].
1572 fetch.output::
1573 Control how ref update status is printed. Valid values are
1574 `full` and `compact`. Default value is `full`. See section
1575 OUTPUT in linkgit:git-fetch[1] for detail.
1577 fetch.negotiationAlgorithm::
1578 Control how information about the commits in the local repository is
1579 sent when negotiating the contents of the packfile to be sent by the
1580 server. Set to "skipping" to use an algorithm that skips commits in an
1581 effort to converge faster, but may result in a larger-than-necessary
1582 packfile; The default is "default" which instructs Git to use the default algorithm
1583 that never skips commits (unless the server has acknowledged it or one
1584 of its descendants).
1585 Unknown values will cause 'git fetch' to error out.
1586 +
1587 See also the `--negotiation-tip` option for linkgit:git-fetch[1].
1589 format.attach::
1590 Enable multipart/mixed attachments as the default for
1591 'format-patch'. The value can also be a double quoted string
1592 which will enable attachments as the default and set the
1593 value as the boundary. See the --attach option in
1594 linkgit:git-format-patch[1].
1596 format.from::
1597 Provides the default value for the `--from` option to format-patch.
1598 Accepts a boolean value, or a name and email address. If false,
1599 format-patch defaults to `--no-from`, using commit authors directly in
1600 the "From:" field of patch mails. If true, format-patch defaults to
1601 `--from`, using your committer identity in the "From:" field of patch
1602 mails and including a "From:" field in the body of the patch mail if
1603 different. If set to a non-boolean value, format-patch uses that
1604 value instead of your committer identity. Defaults to false.
1606 format.numbered::
1607 A boolean which can enable or disable sequence numbers in patch
1608 subjects. It defaults to "auto" which enables it only if there
1609 is more than one patch. It can be enabled or disabled for all
1610 messages by setting it to "true" or "false". See --numbered
1611 option in linkgit:git-format-patch[1].
1613 format.headers::
1614 Additional email headers to include in a patch to be submitted
1615 by mail. See linkgit:git-format-patch[1].
1619 Additional recipients to include in a patch to be submitted
1620 by mail. See the --to and --cc options in
1621 linkgit:git-format-patch[1].
1623 format.subjectPrefix::
1624 The default for format-patch is to output files with the '[PATCH]'
1625 subject prefix. Use this variable to change that prefix.
1627 format.signature::
1628 The default for format-patch is to output a signature containing
1629 the Git version number. Use this variable to change that default.
1630 Set this variable to the empty string ("") to suppress
1631 signature generation.
1633 format.signatureFile::
1634 Works just like format.signature except the contents of the
1635 file specified by this variable will be used as the signature.
1637 format.suffix::
1638 The default for format-patch is to output files with the suffix
1639 `.patch`. Use this variable to change that suffix (make sure to
1640 include the dot if you want it).
1642 format.pretty::
1643 The default pretty format for log/show/whatchanged command,
1644 See linkgit:git-log[1], linkgit:git-show[1],
1645 linkgit:git-whatchanged[1].
1647 format.thread::
1648 The default threading style for 'git format-patch'. Can be
1649 a boolean value, or `shallow` or `deep`. `shallow` threading
1650 makes every mail a reply to the head of the series,
1651 where the head is chosen from the cover letter, the
1652 `--in-reply-to`, and the first patch mail, in this order.
1653 `deep` threading makes every mail a reply to the previous one.
1654 A true boolean value is the same as `shallow`, and a false
1655 value disables threading.
1657 format.signOff::
1658 A boolean value which lets you enable the `-s/--signoff` option of
1659 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1660 patch should be a conscious act and means that you certify you have
1661 the rights to submit this work under the same open source license.
1662 Please see the 'SubmittingPatches' document for further discussion.
1664 format.coverLetter::
1665 A boolean that controls whether to generate a cover-letter when
1666 format-patch is invoked, but in addition can be set to "auto", to
1667 generate a cover-letter only when there's more than one patch.
1669 format.outputDirectory::
1670 Set a custom directory to store the resulting files instead of the
1671 current working directory.
1673 format.useAutoBase::
1674 A boolean value which lets you enable the `--base=auto` option of
1675 format-patch by default.
1677 filter.<driver>.clean::
1678 The command which is used to convert the content of a worktree
1679 file to a blob upon checkin. See linkgit:gitattributes[5] for
1680 details.
1682 filter.<driver>.smudge::
1683 The command which is used to convert the content of a blob
1684 object to a worktree file upon checkout. See
1685 linkgit:gitattributes[5] for details.
1687 fsck.<msg-id>::
1688 During fsck git may find issues with legacy data which
1689 wouldn't be generated by current versions of git, and which
1690 wouldn't be sent over the wire if `transfer.fsckObjects` was
1691 set. This feature is intended to support working with legacy
1692 repositories containing such data.
1693 +
1694 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1695 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1696 to clone or fetch it set `fetch.fsck.<msg-id>`.
1697 +
1698 The rest of the documentation discusses `fsck.*` for brevity, but the
1699 same applies for the corresponding `receive.fsck.*` and
1700 `fetch.<msg-id>.*`. variables.
1701 +
1702 Unlike variables like `color.ui` and `core.editor` the
1703 `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1704 fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1705 uniformly configure the same fsck settings in different circumstances
1706 all three of them they must all set to the same values.
1707 +
1708 When `fsck.<msg-id>` is set, errors can be switched to warnings and
1709 vice versa by configuring the `fsck.<msg-id>` setting where the
1710 `<msg-id>` is the fsck message ID and the value is one of `error`,
1711 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
1712 with the message ID, e.g. "missingEmail: invalid author/committer line
1713 - missing email" means that setting `fsck.missingEmail = ignore` will
1714 hide that issue.
1715 +
1716 In general, it is better to enumerate existing objects with problems
1717 with `fsck.skipList`, instead of listing the kind of breakages these
1718 problematic objects share to be ignored, as doing the latter will
1719 allow new instances of the same breakages go unnoticed.
1720 +
1721 Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1722 doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1723 will only cause git to warn.
1725 fsck.skipList::
1726 The path to a sorted list of object names (i.e. one SHA-1 per
1727 line) that are known to be broken in a non-fatal way and should
1728 be ignored. This feature is useful when an established project
1729 should be accepted despite early commits containing errors that
1730 can be safely ignored such as invalid committer email addresses.
1731 Note: corrupt objects cannot be skipped with this setting.
1732 +
1733 Like `fsck.<msg-id>` this variable has corresponding
1734 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1735 +
1736 Unlike variables like `color.ui` and `core.editor` the
1737 `receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1738 fall back on the `fsck.skipList` configuration if they aren't set. To
1739 uniformly configure the same fsck settings in different circumstances
1740 all three of them they must all set to the same values.
1742 gc.aggressiveDepth::
1743 The depth parameter used in the delta compression
1744 algorithm used by 'git gc --aggressive'. This defaults
1745 to 50.
1747 gc.aggressiveWindow::
1748 The window size parameter used in the delta compression
1749 algorithm used by 'git gc --aggressive'. This defaults
1750 to 250.
1753 When there are approximately more than this many loose
1754 objects in the repository, `git gc --auto` will pack them.
1755 Some Porcelain commands use this command to perform a
1756 light-weight garbage collection from time to time. The
1757 default value is 6700. Setting this to 0 disables it.
1759 gc.autoPackLimit::
1760 When there are more than this many packs that are not
1761 marked with `*.keep` file in the repository, `git gc
1762 --auto` consolidates them into one larger pack. The
1763 default value is 50. Setting this to 0 disables it.
1765 gc.autoDetach::
1766 Make `git gc --auto` return immediately and run in background
1767 if the system supports it. Default is true.
1769 gc.bigPackThreshold::
1770 If non-zero, all packs larger than this limit are kept when
1771 `git gc` is run. This is very similar to `--keep-base-pack`
1772 except that all packs that meet the threshold are kept, not
1773 just the base pack. Defaults to zero. Common unit suffixes of
1774 'k', 'm', or 'g' are supported.
1775 +
1776 Note that if the number of kept packs is more than gc.autoPackLimit,
1777 this configuration variable is ignored, all packs except the base pack
1778 will be repacked. After this the number of packs should go below
1779 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1781 gc.writeCommitGraph::
1782 If true, then gc will rewrite the commit-graph file when
1783 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1784 '--auto' the commit-graph will be updated if housekeeping is
1785 required. Default is false. See linkgit:git-commit-graph[1]
1786 for details.
1788 gc.logExpiry::
1789 If the file gc.log exists, then `git gc --auto` won't run
1790 unless that file is more than 'gc.logExpiry' old. Default is
1791 "". See `gc.pruneExpire` for more ways to specify its
1792 value.
1794 gc.packRefs::
1795 Running `git pack-refs` in a repository renders it
1796 unclonable by Git versions prior to over dumb
1797 transports such as HTTP. This variable determines whether
1798 'git gc' runs `git pack-refs`. This can be set to `notbare`
1799 to enable it within all non-bare repos or it can be set to a
1800 boolean value. The default is `true`.
1802 gc.pruneExpire::
1803 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1804 Override the grace period with this config variable. The value
1805 "now" may be used to disable this grace period and always prune
1806 unreachable objects immediately, or "never" may be used to
1807 suppress pruning. This feature helps prevent corruption when
1808 'git gc' runs concurrently with another process writing to the
1809 repository; see the "NOTES" section of linkgit:git-gc[1].
1811 gc.worktreePruneExpire::
1812 When 'git gc' is run, it calls
1813 'git worktree prune --expire 3.months.ago'.
1814 This config variable can be used to set a different grace
1815 period. The value "now" may be used to disable the grace
1816 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1817 may be used to suppress pruning.
1819 gc.reflogExpire::
1820 gc.<pattern>.reflogExpire::
1821 'git reflog expire' removes reflog entries older than
1822 this time; defaults to 90 days. The value "now" expires all
1823 entries immediately, and "never" suppresses expiration
1824 altogether. With "<pattern>" (e.g.
1825 "refs/stash") in the middle the setting applies only to
1826 the refs that match the <pattern>.
1828 gc.reflogExpireUnreachable::
1829 gc.<pattern>.reflogExpireUnreachable::
1830 'git reflog expire' removes reflog entries older than
1831 this time and are not reachable from the current tip;
1832 defaults to 30 days. The value "now" expires all entries
1833 immediately, and "never" suppresses expiration altogether.
1834 With "<pattern>" (e.g. "refs/stash")
1835 in the middle, the setting applies only to the refs that
1836 match the <pattern>.
1838 gc.rerereResolved::
1839 Records of conflicted merge you resolved earlier 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 60 days. See linkgit:git-rerere[1].
1844 gc.rerereUnresolved::
1845 Records of conflicted merge you have not resolved are
1846 kept for this many days when 'git rerere gc' is run.
1847 You can also use more human-readable "1.month.ago", etc.
1848 The default is 15 days. See linkgit:git-rerere[1].
1850 gitcvs.commitMsgAnnotation::
1851 Append this string to each commit message. Set to empty string
1852 to disable this feature. Defaults to "via git-CVS emulator".
1854 gitcvs.enabled::
1855 Whether the CVS server interface is enabled for this repository.
1856 See linkgit:git-cvsserver[1].
1858 gitcvs.logFile::
1859 Path to a log file where the CVS server interface well... logs
1860 various stuff. See linkgit:git-cvsserver[1].
1862 gitcvs.usecrlfattr::
1863 If true, the server will look up the end-of-line conversion
1864 attributes for files to determine the `-k` modes to use. If
1865 the attributes force Git to treat a file as text,
1866 the `-k` mode will be left blank so CVS clients will
1867 treat it as text. If they suppress text conversion, the file
1868 will be set with '-kb' mode, which suppresses any newline munging
1869 the client might otherwise do. If the attributes do not allow
1870 the file type to be determined, then `gitcvs.allBinary` is
1871 used. See linkgit:gitattributes[5].
1873 gitcvs.allBinary::
1874 This is used if `gitcvs.usecrlfattr` does not resolve
1875 the correct '-kb' mode to use. If true, all
1876 unresolved files are sent to the client in
1877 mode '-kb'. This causes the client to treat them
1878 as binary files, which suppresses any newline munging it
1879 otherwise might do. Alternatively, if it is set to "guess",
1880 then the contents of the file are examined to decide if
1881 it is binary, similar to `core.autocrlf`.
1883 gitcvs.dbName::
1884 Database used by git-cvsserver to cache revision information
1885 derived from the Git repository. The exact meaning depends on the
1886 used database driver, for SQLite (which is the default driver) this
1887 is a filename. Supports variable substitution (see
1888 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1889 Default: '%Ggitcvs.%m.sqlite'
1891 gitcvs.dbDriver::
1892 Used Perl DBI driver. You can specify any available driver
1893 for this here, but it might not work. git-cvsserver is tested
1894 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1895 reported *not* to work with 'DBD::mysql'. Experimental feature.
1896 May not contain double colons (`:`). Default: 'SQLite'.
1897 See linkgit:git-cvsserver[1].
1899 gitcvs.dbUser, gitcvs.dbPass::
1900 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1901 since SQLite has no concept of database users and/or passwords.
1902 'gitcvs.dbUser' supports variable substitution (see
1903 linkgit:git-cvsserver[1] for details).
1905 gitcvs.dbTableNamePrefix::
1906 Database table name prefix. Prepended to the names of any
1907 database tables used, allowing a single database to be used
1908 for several repositories. Supports variable substitution (see
1909 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1910 characters will be replaced with underscores.
1912 All gitcvs variables except for `gitcvs.usecrlfattr` and
1913 `gitcvs.allBinary` can also be specified as
1914 'gitcvs.<access_method>.<varname>' (where 'access_method'
1915 is one of "ext" and "pserver") to make them apply only for the given
1916 access method.
1918 gitweb.category::
1919 gitweb.description::
1920 gitweb.owner::
1921 gitweb.url::
1922 See linkgit:gitweb[1] for description.
1924 gitweb.avatar::
1925 gitweb.blame::
1926 gitweb.grep::
1927 gitweb.highlight::
1928 gitweb.patches::
1929 gitweb.pickaxe::
1930 gitweb.remote_heads::
1931 gitweb.showSizes::
1932 gitweb.snapshot::
1933 See linkgit:gitweb.conf[5] for description.
1935 grep.lineNumber::
1936 If set to true, enable `-n` option by default.
1938 grep.column::
1939 If set to true, enable the `--column` option by default.
1941 grep.patternType::
1942 Set the default matching behavior. Using a value of 'basic', 'extended',
1943 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1944 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1945 value 'default' will return to the default matching behavior.
1947 grep.extendedRegexp::
1948 If set to true, enable `--extended-regexp` option by default. This
1949 option is ignored when the `grep.patternType` option is set to a value
1950 other than 'default'.
1952 grep.threads::
1953 Number of grep worker threads to use.
1954 See `grep.threads` in linkgit:git-grep[1] for more information.
1956 grep.fallbackToNoIndex::
1957 If set to true, fall back to git grep --no-index if git grep
1958 is executed outside of a git repository. Defaults to false.
1960 gpg.program::
1961 Use this custom program instead of "`gpg`" found on `$PATH` when
1962 making or verifying a PGP signature. The program must support the
1963 same command-line interface as GPG, namely, to verify a detached
1964 signature, "`gpg --verify $file - <$signature`" is run, and the
1965 program is expected to signal a good signature by exiting with
1966 code 0, and to generate an ASCII-armored detached signature, the
1967 standard input of "`gpg -bsau $key`" is fed with the contents to be
1968 signed, and the program is expected to send the result to its
1969 standard output.
1971 gpg.format::
1972 Specifies which key format to use when signing with `--gpg-sign`.
1973 Default is "openpgp" and another possible value is "x509".
1975 gpg.<format>.program::
1976 Use this to customize the program used for the signing format you
1977 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1978 be used as a legacy synonym for `gpg.openpgp.program`. The default
1979 value for `gpg.x509.program` is "gpgsm".
1981 gui.commitMsgWidth::
1982 Defines how wide the commit message window is in the
1983 linkgit:git-gui[1]. "75" is the default.
1985 gui.diffContext::
1986 Specifies how many context lines should be used in calls to diff
1987 made by the linkgit:git-gui[1]. The default is "5".
1989 gui.displayUntracked::
1990 Determines if linkgit:git-gui[1] shows untracked files
1991 in the file list. The default is "true".
1993 gui.encoding::
1994 Specifies the default encoding to use for displaying of
1995 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1996 It can be overridden by setting the 'encoding' attribute
1997 for relevant files (see linkgit:gitattributes[5]).
1998 If this option is not set, the tools default to the
1999 locale encoding.
2001 gui.matchTrackingBranch::
2002 Determines if new branches created with linkgit:git-gui[1] should
2003 default to tracking remote branches with matching names or
2004 not. Default: "false".
2006 gui.newBranchTemplate::
2007 Is used as suggested name when creating new branches using the
2008 linkgit:git-gui[1].
2010 gui.pruneDuringFetch::
2011 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
2012 performing a fetch. The default value is "false".
2014 gui.trustmtime::
2015 Determines if linkgit:git-gui[1] should trust the file modification
2016 timestamp or not. By default the timestamps are not trusted.
2018 gui.spellingDictionary::
2019 Specifies the dictionary used for spell checking commit messages in
2020 the linkgit:git-gui[1]. When set to "none" spell checking is turned
2021 off.
2023 gui.fastCopyBlame::
2024 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
2025 location detection. It makes blame significantly faster on huge
2026 repositories at the expense of less thorough copy detection.
2028 gui.copyBlameThreshold::
2029 Specifies the threshold to use in 'git gui blame' original location
2030 detection, measured in alphanumeric characters. See the
2031 linkgit:git-blame[1] manual for more information on copy detection.
2033 gui.blamehistoryctx::
2034 Specifies the radius of history context in days to show in
2035 linkgit:gitk[1] for the selected commit, when the `Show History
2036 Context` menu item is invoked from 'git gui blame'. If this
2037 variable is set to zero, the whole history is shown.
2039 guitool.<name>.cmd::
2040 Specifies the shell command line to execute when the corresponding item
2041 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
2042 mandatory for every tool. The command is executed from the root of
2043 the working directory, and in the environment it receives the name of
2044 the tool as `GIT_GUITOOL`, the name of the currently selected file as
2045 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
2046 the head is detached, 'CUR_BRANCH' is empty).
2048 guitool.<name>.needsFile::
2049 Run the tool only if a diff is selected in the GUI. It guarantees
2050 that 'FILENAME' is not empty.
2052 guitool.<name>.noConsole::
2053 Run the command silently, without creating a window to display its
2054 output.
2056 guitool.<name>.noRescan::
2057 Don't rescan the working directory for changes after the tool
2058 finishes execution.
2060 guitool.<name>.confirm::
2061 Show a confirmation dialog before actually running the tool.
2063 guitool.<name>.argPrompt::
2064 Request a string argument from the user, and pass it to the tool
2065 through the `ARGS` environment variable. Since requesting an
2066 argument implies confirmation, the 'confirm' option has no effect
2067 if this is enabled. If the option is set to 'true', 'yes', or '1',
2068 the dialog uses a built-in generic prompt; otherwise the exact
2069 value of the variable is used.
2071 guitool.<name>.revPrompt::
2072 Request a single valid revision from the user, and set the
2073 `REVISION` environment variable. In other aspects this option
2074 is similar to 'argPrompt', and can be used together with it.
2076 guitool.<name>.revUnmerged::
2077 Show only unmerged branches in the 'revPrompt' subdialog.
2078 This is useful for tools similar to merge or rebase, but not
2079 for things like checkout or reset.
2081 guitool.<name>.title::
2082 Specifies the title to use for the prompt dialog. The default
2083 is the tool name.
2085 guitool.<name>.prompt::
2086 Specifies the general prompt string to display at the top of
2087 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
2088 The default value includes the actual command.
2090 help.browser::
2091 Specify the browser that will be used to display help in the
2092 'web' format. See linkgit:git-help[1].
2094 help.format::
2095 Override the default help format used by linkgit:git-help[1].
2096 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2097 the default. 'web' and 'html' are the same.
2099 help.autoCorrect::
2100 Automatically correct and execute mistyped commands after
2101 waiting for the given number of deciseconds (0.1 sec). If more
2102 than one command can be deduced from the entered text, nothing
2103 will be executed. If the value of this option is negative,
2104 the corrected command will be executed immediately. If the
2105 value is 0 - the command will be just shown but not executed.
2106 This is the default.
2108 help.htmlPath::
2109 Specify the path where the HTML documentation resides. File system paths
2110 and URLs are supported. HTML pages will be prefixed with this path when
2111 help is displayed in the 'web' format. This defaults to the documentation
2112 path of your Git installation.
2114 http.proxy::
2115 Override the HTTP proxy, normally configured using the 'http_proxy',
2116 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2117 addition to the syntax understood by curl, it is possible to specify a
2118 proxy string with a user name but no password, in which case git will
2119 attempt to acquire one in the same way it does for other credentials. See
2120 linkgit:gitcredentials[7] for more information. The syntax thus is
2121 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2122 on a per-remote basis; see remote.<name>.proxy
2124 http.proxyAuthMethod::
2125 Set the method with which to authenticate against the HTTP proxy. This
2126 only takes effect if the configured proxy string contains a user name part
2127 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2128 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2129 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2130 variable. Possible values are:
2131 +
2132 --
2133 * `anyauth` - Automatically pick a suitable authentication method. It is
2134 assumed that the proxy answers an unauthenticated request with a 407
2135 status code and one or more Proxy-authenticate headers with supported
2136 authentication methods. This is the default.
2137 * `basic` - HTTP Basic authentication
2138 * `digest` - HTTP Digest authentication; this prevents the password from being
2139 transmitted to the proxy in clear text
2140 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2141 of `curl(1)`)
2142 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2143 --
2145 http.emptyAuth::
2146 Attempt authentication without seeking a username or password. This
2147 can be used to attempt GSS-Negotiate authentication without specifying
2148 a username in the URL, as libcurl normally requires a username for
2149 authentication.
2151 http.delegation::
2152 Control GSSAPI credential delegation. The delegation is disabled
2153 by default in libcurl since version 7.21.7. Set parameter to tell
2154 the server what it is allowed to delegate when it comes to user
2155 credentials. Used with GSS/kerberos. Possible values are:
2156 +
2157 --
2158 * `none` - Don't allow any delegation.
2159 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2160 Kerberos service ticket, which is a matter of realm policy.
2161 * `always` - Unconditionally allow the server to delegate.
2162 --
2165 http.extraHeader::
2166 Pass an additional HTTP header when communicating with a server. If
2167 more than one such entry exists, all of them are added as extra
2168 headers. To allow overriding the settings inherited from the system
2169 config, an empty value will reset the extra headers to the empty list.
2171 http.cookieFile::
2172 The pathname of a file containing previously stored cookie lines,
2173 which should be used
2174 in the Git http session, if they match the server. The file format
2175 of the file to read cookies from should be plain HTTP headers or
2176 the Netscape/Mozilla cookie file format (see `curl(1)`).
2177 NOTE that the file specified with http.cookieFile is used only as
2178 input unless http.saveCookies is set.
2180 http.saveCookies::
2181 If set, store cookies received during requests to the file specified by
2182 http.cookieFile. Has no effect if http.cookieFile is unset.
2184 http.sslVersion::
2185 The SSL version to use when negotiating an SSL connection, if you
2186 want to force the default. The available and default version
2187 depend on whether libcurl was built against NSS or OpenSSL and the
2188 particular configuration of the crypto library in use. Internally
2189 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2190 documentation for more details on the format of this option and
2191 for the ssl version supported. Actually the possible values of
2192 this option are:
2194 - sslv2
2195 - sslv3
2196 - tlsv1
2197 - tlsv1.0
2198 - tlsv1.1
2199 - tlsv1.2
2200 - tlsv1.3
2202 +
2203 Can be overridden by the `GIT_SSL_VERSION` environment variable.
2204 To force git to use libcurl's default ssl version and ignore any
2205 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2206 empty string.
2208 http.sslCipherList::
2209 A list of SSL ciphers to use when negotiating an SSL connection.
2210 The available ciphers depend on whether libcurl was built against
2211 NSS or OpenSSL and the particular configuration of the crypto
2212 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2213 option; see the libcurl documentation for more details on the format
2214 of this list.
2215 +
2216 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2217 To force git to use libcurl's default cipher list and ignore any
2218 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2219 empty string.
2221 http.sslVerify::
2222 Whether to verify the SSL certificate when fetching or pushing
2223 over HTTPS. Defaults to true. Can be overridden by the
2224 `GIT_SSL_NO_VERIFY` environment variable.
2226 http.sslCert::
2227 File containing the SSL certificate when fetching or pushing
2228 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2229 variable.
2231 http.sslKey::
2232 File containing the SSL private key when fetching or pushing
2233 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2234 variable.
2236 http.sslCertPasswordProtected::
2237 Enable Git's password prompt for the SSL certificate. Otherwise
2238 OpenSSL will prompt the user, possibly many times, if the
2239 certificate or private key is encrypted. Can be overridden by the
2240 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2242 http.sslCAInfo::
2243 File containing the certificates to verify the peer with when
2244 fetching or pushing over HTTPS. Can be overridden by the
2245 `GIT_SSL_CAINFO` environment variable.
2247 http.sslCAPath::
2248 Path containing files with the CA certificates to verify the peer
2249 with when fetching or pushing over HTTPS. Can be overridden
2250 by the `GIT_SSL_CAPATH` environment variable.
2252 http.pinnedpubkey::
2253 Public key of the https service. It may either be the filename of
2254 a PEM or DER encoded public key file or a string starting with
2255 'sha256//' followed by the base64 encoded sha256 hash of the
2256 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2257 exit with an error if this option is set but not supported by
2258 cURL.
2260 http.sslTry::
2261 Attempt to use AUTH SSL/TLS and encrypted data transfers
2262 when connecting via regular FTP protocol. This might be needed
2263 if the FTP server requires it for security reasons or you wish
2264 to connect securely whenever remote FTP server supports it.
2265 Default is false since it might trigger certificate verification
2266 errors on misconfigured servers.
2268 http.maxRequests::
2269 How many HTTP requests to launch in parallel. Can be overridden
2270 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2272 http.minSessions::
2273 The number of curl sessions (counted across slots) to be kept across
2274 requests. They will not be ended with curl_easy_cleanup() until
2275 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2276 value will be capped at 1. Defaults to 1.
2278 http.postBuffer::
2279 Maximum size in bytes of the buffer used by smart HTTP
2280 transports when POSTing data to the remote system.
2281 For requests larger than this buffer size, HTTP/1.1 and
2282 Transfer-Encoding: chunked is used to avoid creating a
2283 massive pack file locally. Default is 1 MiB, which is
2284 sufficient for most requests.
2286 http.lowSpeedLimit, http.lowSpeedTime::
2287 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2288 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2289 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2290 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2292 http.noEPSV::
2293 A boolean which disables using of EPSV ftp command by curl.
2294 This can helpful with some "poor" ftp servers which don't
2295 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2296 environment variable. Default is false (curl will use EPSV).
2298 http.userAgent::
2299 The HTTP USER_AGENT string presented to an HTTP server. The default
2300 value represents the version of the client Git such as git/1.7.1.
2301 This option allows you to override this value to a more common value
2302 such as Mozilla/4.0. This may be necessary, for instance, if
2303 connecting through a firewall that restricts HTTP connections to a set
2304 of common USER_AGENT strings (but not including those like git/1.7.1).
2305 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2307 http.followRedirects::
2308 Whether git should follow HTTP redirects. If set to `true`, git
2309 will transparently follow any redirect issued by a server it
2310 encounters. If set to `false`, git will treat all redirects as
2311 errors. If set to `initial`, git will follow redirects only for
2312 the initial request to a remote, but not for subsequent
2313 follow-up HTTP requests. Since git uses the redirected URL as
2314 the base for the follow-up requests, this is generally
2315 sufficient. The default is `initial`.
2317 http.<url>.*::
2318 Any of the http.* options above can be applied selectively to some URLs.
2319 For a config key to match a URL, each element of the config key is
2320 compared to that of the URL, in the following order:
2321 +
2322 --
2323 . Scheme (e.g., `https` in ``). This field
2324 must match exactly between the config key and the URL.
2326 . Host/domain name (e.g., `` in ``).
2327 This field must match between the config key and the URL. It is
2328 possible to specify a `*` as part of the host name to match all subdomains
2329 at this level. `https://*` for example would match
2330 ``, but not ``.
2332 . Port number (e.g., `8080` in ``).
2333 This field must match exactly between the config key and the URL.
2334 Omitted port numbers are automatically converted to the correct
2335 default for the scheme before matching.
2337 . Path (e.g., `repo.git` in ``). The
2338 path field of the config key must match the path field of the URL
2339 either exactly or as a prefix of slash-delimited path elements. This means
2340 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2341 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2342 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2343 key with just path `foo/`).
2345 . User name (e.g., `user` in ``). If
2346 the config key has a user name it must match the user name in the
2347 URL exactly. If the config key does not have a user name, that
2348 config key will match a URL with any user name (including none),
2349 but at a lower precedence than a config key with a user name.
2350 --
2351 +
2352 The list above is ordered by decreasing precedence; a URL that matches
2353 a config key's path is preferred to one that matches its user name. For example,
2354 if the URL is `` a config key match of
2355 `` will be preferred over a config key match of
2356 ``.
2357 +
2358 All URLs are normalized before attempting any matching (the password part,
2359 if embedded in the URL, is always ignored for matching purposes) so that
2360 equivalent URLs that are simply spelled differently will match properly.
2361 Environment variable settings always override any matches. The URLs that are
2362 matched against are those given directly to Git commands. This means any URLs
2363 visited as a result of a redirection do not participate in matching.
2365 ssh.variant::
2366 By default, Git determines the command line arguments to use
2367 based on the basename of the configured SSH command (configured
2368 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2369 the config setting `core.sshCommand`). If the basename is
2370 unrecognized, Git will attempt to detect support of OpenSSH
2371 options by first invoking the configured SSH command with the
2372 `-G` (print configuration) option and will subsequently use
2373 OpenSSH options (if that is successful) or no options besides
2374 the host and remote command (if it fails).
2375 +
2376 The config variable `ssh.variant` can be set to override this detection.
2377 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2378 `tortoiseplink`, `simple` (no options except the host and remote command).
2379 The default auto-detection can be explicitly requested using the value
2380 `auto`. Any other value is treated as `ssh`. This setting can also be
2381 overridden via the environment variable `GIT_SSH_VARIANT`.
2382 +
2383 The current command-line parameters used for each variant are as
2384 follows:
2385 +
2386 --
2388 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2390 * `simple` - [username@]host command
2392 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2394 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2396 --
2397 +
2398 Except for the `simple` variant, command-line parameters are likely to
2399 change as git gains new features.
2401 i18n.commitEncoding::
2402 Character encoding the commit messages are stored in; Git itself
2403 does not care per se, but this information is necessary e.g. when
2404 importing commits from emails or in the gitk graphical history
2405 browser (and possibly at other places in the future or in other
2406 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2408 i18n.logOutputEncoding::
2409 Character encoding the commit messages are converted to when
2410 running 'git log' and friends.
2412 imap::
2413 The configuration variables in the 'imap' section are described
2414 in linkgit:git-imap-send[1].
2416 index.version::
2417 Specify the version with which new index files should be
2418 initialized. This does not affect existing repositories.
2420 init.templateDir::
2421 Specify the directory from which templates will be copied.
2422 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2424 instaweb.browser::
2425 Specify the program that will be used to browse your working
2426 repository in gitweb. See linkgit:git-instaweb[1].
2428 instaweb.httpd::
2429 The HTTP daemon command-line to start gitweb on your working
2430 repository. See linkgit:git-instaweb[1].
2432 instaweb.local::
2433 If true the web server started by linkgit:git-instaweb[1] will
2434 be bound to the local IP (
2436 instaweb.modulePath::
2437 The default module path for linkgit:git-instaweb[1] to use
2438 instead of /usr/lib/apache2/modules. Only used if httpd
2439 is Apache.
2441 instaweb.port::
2442 The port number to bind the gitweb httpd to. See
2443 linkgit:git-instaweb[1].
2445 interactive.singleKey::
2446 In interactive commands, allow the user to provide one-letter
2447 input with a single key (i.e., without hitting enter).
2448 Currently this is used by the `--patch` mode of
2449 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2450 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2451 setting is silently ignored if portable keystroke input
2452 is not available; requires the Perl module Term::ReadKey.
2454 interactive.diffFilter::
2455 When an interactive command (such as `git add --patch`) shows
2456 a colorized diff, git will pipe the diff through the shell
2457 command defined by this configuration variable. The command may
2458 mark up the diff further for human consumption, provided that it
2459 retains a one-to-one correspondence with the lines in the
2460 original diff. Defaults to disabled (no filtering).
2462 log.abbrevCommit::
2463 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2464 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2465 override this option with `--no-abbrev-commit`.
2468 Set the default date-time mode for the 'log' command.
2469 Setting a value for is similar to using 'git log''s
2470 `--date` option. See linkgit:git-log[1] for details.
2472 log.decorate::
2473 Print out the ref names of any commits that are shown by the log
2474 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2475 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2476 specified, the full ref name (including prefix) will be printed.
2477 If 'auto' is specified, then if the output is going to a terminal,
2478 the ref names are shown as if 'short' were given, otherwise no ref
2479 names are shown. This is the same as the `--decorate` option
2480 of the `git log`.
2482 log.follow::
2483 If `true`, `git log` will act as if the `--follow` option was used when
2484 a single <path> is given. This has the same limitations as `--follow`,
2485 i.e. it cannot be used to follow multiple files and does not work well
2486 on non-linear history.
2488 log.graphColors::
2489 A list of colors, separated by commas, that can be used to draw
2490 history lines in `git log --graph`.
2492 log.showRoot::
2493 If true, the initial commit will be shown as a big creation event.
2494 This is equivalent to a diff against an empty tree.
2495 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2496 normally hide the root commit will now show it. True by default.
2498 log.showSignature::
2499 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2500 linkgit:git-whatchanged[1] assume `--show-signature`.
2502 log.mailmap::
2503 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2504 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2506 mailinfo.scissors::
2507 If true, makes linkgit:git-mailinfo[1] (and therefore
2508 linkgit:git-am[1]) act by default as if the --scissors option
2509 was provided on the command-line. When active, this features
2510 removes everything from the message body before a scissors
2511 line (i.e. consisting mainly of ">8", "8<" and "-").
2513 mailmap.file::
2514 The location of an augmenting mailmap file. The default
2515 mailmap, located in the root of the repository, is loaded
2516 first, then the mailmap file pointed to by this variable.
2517 The location of the mailmap file may be in a repository
2518 subdirectory, or somewhere outside of the repository itself.
2519 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2521 mailmap.blob::
2522 Like `mailmap.file`, but consider the value as a reference to a
2523 blob in the repository. If both `mailmap.file` and
2524 `mailmap.blob` are given, both are parsed, with entries from
2525 `mailmap.file` taking precedence. In a bare repository, this
2526 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2527 defaults to empty.
2529 man.viewer::
2530 Specify the programs that may be used to display help in the
2531 'man' format. See linkgit:git-help[1].
2533 man.<tool>.cmd::
2534 Specify the command to invoke the specified man viewer. The
2535 specified command is evaluated in shell with the man page
2536 passed as argument. (See linkgit:git-help[1].)
2538 man.<tool>.path::
2539 Override the path for the given tool that may be used to
2540 display help in the 'man' format. See linkgit:git-help[1].
2542 include::merge-config.txt[]
2544 mergetool.<tool>.path::
2545 Override the path for the given tool. This is useful in case
2546 your tool is not in the PATH.
2548 mergetool.<tool>.cmd::
2549 Specify the command to invoke the specified merge tool. The
2550 specified command is evaluated in shell with the following
2551 variables available: 'BASE' is the name of a temporary file
2552 containing the common base of the files to be merged, if available;
2553 'LOCAL' is the name of a temporary file containing the contents of
2554 the file on the current branch; 'REMOTE' is the name of a temporary
2555 file containing the contents of the file from the branch being
2556 merged; 'MERGED' contains the name of the file to which the merge
2557 tool should write the results of a successful merge.
2559 mergetool.<tool>.trustExitCode::
2560 For a custom merge command, specify whether the exit code of
2561 the merge command can be used to determine whether the merge was
2562 successful. If this is not set to true then the merge target file
2563 timestamp is checked and the merge assumed to have been successful
2564 if the file has been updated, otherwise the user is prompted to
2565 indicate the success of the merge.
2567 mergetool.meld.hasOutput::
2568 Older versions of `meld` do not support the `--output` option.
2569 Git will attempt to detect whether `meld` supports `--output`
2570 by inspecting the output of `meld --help`. Configuring
2571 `mergetool.meld.hasOutput` will make Git skip these checks and
2572 use the configured value instead. Setting `mergetool.meld.hasOutput`
2573 to `true` tells Git to unconditionally use the `--output` option,
2574 and `false` avoids using `--output`.
2576 mergetool.keepBackup::
2577 After performing a merge, the original file with conflict markers
2578 can be saved as a file with a `.orig` extension. If this variable
2579 is set to `false` then this file is not preserved. Defaults to
2580 `true` (i.e. keep the backup files).
2582 mergetool.keepTemporaries::
2583 When invoking a custom merge tool, Git uses a set of temporary
2584 files to pass to the tool. If the tool returns an error and this
2585 variable is set to `true`, then these temporary files will be
2586 preserved, otherwise they will be removed after the tool has
2587 exited. Defaults to `false`.
2589 mergetool.writeToTemp::
2590 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2591 conflicting files in the worktree by default. Git will attempt
2592 to use a temporary directory for these files when set `true`.
2593 Defaults to `false`.
2595 mergetool.prompt::
2596 Prompt before each invocation of the merge resolution program.
2598 notes.mergeStrategy::
2599 Which merge strategy to choose by default when resolving notes
2600 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2601 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2602 section of linkgit:git-notes[1] for more information on each strategy.
2604 notes.<name>.mergeStrategy::
2605 Which merge strategy to choose when doing a notes merge into
2606 refs/notes/<name>. This overrides the more general
2607 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2608 linkgit:git-notes[1] for more information on the available strategies.
2610 notes.displayRef::
2611 The (fully qualified) refname from which to show notes when
2612 showing commit messages. The value of this variable can be set
2613 to a glob, in which case notes from all matching refs will be
2614 shown. You may also specify this configuration variable
2615 several times. A warning will be issued for refs that do not
2616 exist, but a glob that does not match any refs is silently
2617 ignored.
2618 +
2619 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2620 environment variable, which must be a colon separated list of refs or
2621 globs.
2622 +
2623 The effective value of "core.notesRef" (possibly overridden by
2624 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2625 displayed.
2627 notes.rewrite.<command>::
2628 When rewriting commits with <command> (currently `amend` or
2629 `rebase`) and this variable is set to `true`, Git
2630 automatically copies your notes from the original to the
2631 rewritten commit. Defaults to `true`, but see
2632 "notes.rewriteRef" below.
2634 notes.rewriteMode::
2635 When copying notes during a rewrite (see the
2636 "notes.rewrite.<command>" option), determines what to do if
2637 the target commit already has a note. Must be one of
2638 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2639 Defaults to `concatenate`.
2640 +
2641 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2642 environment variable.
2644 notes.rewriteRef::
2645 When copying notes during a rewrite, specifies the (fully
2646 qualified) ref whose notes should be copied. The ref may be a
2647 glob, in which case notes in all matching refs will be copied.
2648 You may also specify this configuration several times.
2649 +
2650 Does not have a default value; you must configure this variable to
2651 enable note rewriting. Set it to `refs/notes/commits` to enable
2652 rewriting for the default commit notes.
2653 +
2654 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2655 environment variable, which must be a colon separated list of refs or
2656 globs.
2658 pack.window::
2659 The size of the window used by linkgit:git-pack-objects[1] when no
2660 window size is given on the command line. Defaults to 10.
2662 pack.depth::
2663 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2664 maximum depth is given on the command line. Defaults to 50.
2665 Maximum value is 4095.
2667 pack.windowMemory::
2668 The maximum size of memory that is consumed by each thread
2669 in linkgit:git-pack-objects[1] for pack window memory when
2670 no limit is given on the command line. The value can be
2671 suffixed with "k", "m", or "g". When left unconfigured (or
2672 set explicitly to 0), there will be no limit.
2674 pack.compression::
2675 An integer -1..9, indicating the compression level for objects
2676 in a pack file. -1 is the zlib default. 0 means no
2677 compression, and 1..9 are various speed/size tradeoffs, 9 being
2678 slowest. If not set, defaults to core.compression. If that is
2679 not set, defaults to -1, the zlib default, which is "a default
2680 compromise between speed and compression (currently equivalent
2681 to level 6)."
2682 +
2683 Note that changing the compression level will not automatically recompress
2684 all existing objects. You can force recompression by passing the -F option
2685 to linkgit:git-repack[1].
2687 pack.island::
2688 An extended regular expression configuring a set of delta
2689 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
2690 for details.
2692 pack.islandCore::
2693 Specify an island name which gets to have its objects be
2694 packed first. This creates a kind of pseudo-pack at the front
2695 of one pack, so that the objects from the specified island are
2696 hopefully faster to copy into any pack that should be served
2697 to a user requesting these objects. In practice this means
2698 that the island specified should likely correspond to what is
2699 the most commonly cloned in the repo. See also "DELTA ISLANDS"
2700 in linkgit:git-pack-objects[1].
2702 pack.deltaCacheSize::
2703 The maximum memory in bytes used for caching deltas in
2704 linkgit:git-pack-objects[1] before writing them out to a pack.
2705 This cache is used to speed up the writing object phase by not
2706 having to recompute the final delta result once the best match
2707 for all objects is found. Repacking large repositories on machines
2708 which are tight with memory might be badly impacted by this though,
2709 especially if this cache pushes the system into swapping.
2710 A value of 0 means no limit. The smallest size of 1 byte may be
2711 used to virtually disable this cache. Defaults to 256 MiB.
2713 pack.deltaCacheLimit::
2714 The maximum size of a delta, that is cached in
2715 linkgit:git-pack-objects[1]. This cache is used to speed up the
2716 writing object phase by not having to recompute the final delta
2717 result once the best match for all objects is found.
2718 Defaults to 1000. Maximum value is 65535.
2720 pack.threads::
2721 Specifies the number of threads to spawn when searching for best
2722 delta matches. This requires that linkgit:git-pack-objects[1]
2723 be compiled with pthreads otherwise this option is ignored with a
2724 warning. This is meant to reduce packing time on multiprocessor
2725 machines. The required amount of memory for the delta search window
2726 is however multiplied by the number of threads.
2727 Specifying 0 will cause Git to auto-detect the number of CPU's
2728 and set the number of threads accordingly.
2730 pack.indexVersion::
2731 Specify the default pack index version. Valid values are 1 for
2732 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2733 the new pack index with capabilities for packs larger than 4 GB
2734 as well as proper protection against the repacking of corrupted
2735 packs. Version 2 is the default. Note that version 2 is enforced
2736 and this config option ignored whenever the corresponding pack is
2737 larger than 2 GB.
2738 +
2739 If you have an old Git that does not understand the version 2 `*.idx` file,
2740 cloning or fetching over a non native protocol (e.g. "http")
2741 that will copy both `*.pack` file and corresponding `*.idx` file from the
2742 other side may give you a repository that cannot be accessed with your
2743 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2744 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2745 the `*.idx` file.
2747 pack.packSizeLimit::
2748 The maximum size of a pack. This setting only affects
2749 packing to a file when repacking, i.e. the git:// protocol
2750 is unaffected. It can be overridden by the `--max-pack-size`
2751 option of linkgit:git-repack[1]. Reaching this limit results
2752 in the creation of multiple packfiles; which in turn prevents
2753 bitmaps from being created.
2754 The minimum size allowed is limited to 1 MiB.
2755 The default is unlimited.
2756 Common unit suffixes of 'k', 'm', or 'g' are
2757 supported.
2759 pack.useBitmaps::
2760 When true, git will use pack bitmaps (if available) when packing
2761 to stdout (e.g., during the server side of a fetch). Defaults to
2762 true. You should not generally need to turn this off unless
2763 you are debugging pack bitmaps.
2765 pack.writeBitmaps (deprecated)::
2766 This is a deprecated synonym for `repack.writeBitmaps`.
2768 pack.writeBitmapHashCache::
2769 When true, git will include a "hash cache" section in the bitmap
2770 index (if one is written). This cache can be used to feed git's
2771 delta heuristics, potentially leading to better deltas between
2772 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2773 between an older, bitmapped pack and objects that have been
2774 pushed since the last gc). The downside is that it consumes 4
2775 bytes per object of disk space, and that JGit's bitmap
2776 implementation does not understand it, causing it to complain if
2777 Git and JGit are used on the same repository. Defaults to false.
2779 pager.<cmd>::
2780 If the value is boolean, turns on or off pagination of the
2781 output of a particular Git subcommand when writing to a tty.
2782 Otherwise, turns on pagination for the subcommand using the
2783 pager specified by the value of `pager.<cmd>`. If `--paginate`
2784 or `--no-pager` is specified on the command line, it takes
2785 precedence over this option. To disable pagination for all
2786 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2788 pretty.<name>::
2789 Alias for a --pretty= format string, as specified in
2790 linkgit:git-log[1]. Any aliases defined here can be used just
2791 as the built-in pretty formats could. For example,
2792 running `git config pretty.changelog "format:* %H %s"`
2793 would cause the invocation `git log --pretty=changelog`
2794 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2795 Note that an alias with the same name as a built-in format
2796 will be silently ignored.
2798 protocol.allow::
2799 If set, provide a user defined default policy for all protocols which
2800 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2801 if unset, known-safe protocols (http, https, git, ssh, file) have a
2802 default policy of `always`, known-dangerous protocols (ext) have a
2803 default policy of `never`, and all other protocols have a default
2804 policy of `user`. Supported policies:
2805 +
2806 --
2808 * `always` - protocol is always able to be used.
2810 * `never` - protocol is never able to be used.
2812 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2813 either unset or has a value of 1. This policy should be used when you want a
2814 protocol to be directly usable by the user but don't want it used by commands which
2815 execute clone/fetch/push commands without user input, e.g. recursive
2816 submodule initialization.
2818 --
2820 protocol.<name>.allow::
2821 Set a policy to be used by protocol `<name>` with clone/fetch/push
2822 commands. See `protocol.allow` above for the available policies.
2823 +
2824 The protocol names currently used by git are:
2825 +
2826 --
2827 - `file`: any local file-based path (including `file://` URLs,
2828 or local paths)
2830 - `git`: the anonymous git protocol over a direct TCP
2831 connection (or proxy, if configured)
2833 - `ssh`: git over ssh (including `host:path` syntax,
2834 `ssh://`, etc).
2836 - `http`: git over http, both "smart http" and "dumb http".
2837 Note that this does _not_ include `https`; if you want to configure
2838 both, you must do so individually.
2840 - any external helpers are named by their protocol (e.g., use
2841 `hg` to allow the `git-remote-hg` helper)
2842 --
2844 protocol.version::
2845 Experimental. If set, clients will attempt to communicate with a
2846 server using the specified protocol version. If unset, no
2847 attempt will be made by the client to communicate using a
2848 particular protocol version, this results in protocol version 0
2849 being used.
2850 Supported versions:
2851 +
2852 --
2854 * `0` - the original wire protocol.
2856 * `1` - the original wire protocol with the addition of a version string
2857 in the initial response from the server.
2859 * `2` - link:technical/protocol-v2.html[wire protocol version 2].
2861 --
2863 pull.ff::
2864 By default, Git does not create an extra merge commit when merging
2865 a commit that is a descendant of the current commit. Instead, the
2866 tip of the current branch is fast-forwarded. When set to `false`,
2867 this variable tells Git to create an extra merge commit in such
2868 a case (equivalent to giving the `--no-ff` option from the command
2869 line). When set to `only`, only such fast-forward merges are
2870 allowed (equivalent to giving the `--ff-only` option from the
2871 command line). This setting overrides `merge.ff` when pulling.
2873 pull.rebase::
2874 When true, rebase branches on top of the fetched branch, instead
2875 of merging the default branch from the default remote when "git
2876 pull" is run. See "branch.<name>.rebase" for setting this on a
2877 per-branch basis.
2878 +
2879 When `merges`, pass the `--rebase-merges` option to 'git rebase'
2880 so that the local merge commits are included in the rebase (see
2881 linkgit:git-rebase[1] for details).
2882 +
2883 When preserve, also pass `--preserve-merges` along to 'git rebase'
2884 so that locally committed merge commits will not be flattened
2885 by running 'git pull'.
2886 +
2887 When the value is `interactive`, the rebase is run in interactive mode.
2888 +
2889 *NOTE*: this is a possibly dangerous operation; do *not* use
2890 it unless you understand the implications (see linkgit:git-rebase[1]
2891 for details).
2893 pull.octopus::
2894 The default merge strategy to use when pulling multiple branches
2895 at once.
2897 pull.twohead::
2898 The default merge strategy to use when pulling a single branch.
2900 push.default::
2901 Defines the action `git push` should take if no refspec is
2902 explicitly given. Different values are well-suited for
2903 specific workflows; for instance, in a purely central workflow
2904 (i.e. the fetch source is equal to the push destination),
2905 `upstream` is probably what you want. Possible values are:
2906 +
2907 --
2909 * `nothing` - do not push anything (error out) unless a refspec is
2910 explicitly given. This is primarily meant for people who want to
2911 avoid mistakes by always being explicit.
2913 * `current` - push the current branch to update a branch with the same
2914 name on the receiving end. Works in both central and non-central
2915 workflows.
2917 * `upstream` - push the current branch back to the branch whose
2918 changes are usually integrated into the current branch (which is
2919 called `@{upstream}`). This mode only makes sense if you are
2920 pushing to the same repository you would normally pull from
2921 (i.e. central workflow).
2923 * `tracking` - This is a deprecated synonym for `upstream`.
2925 * `simple` - in centralized workflow, work like `upstream` with an
2926 added safety to refuse to push if the upstream branch's name is
2927 different from the local one.
2928 +
2929 When pushing to a remote that is different from the remote you normally
2930 pull from, work as `current`. This is the safest option and is suited
2931 for beginners.
2932 +
2933 This mode has become the default in Git 2.0.
2935 * `matching` - push all branches having the same name on both ends.
2936 This makes the repository you are pushing to remember the set of
2937 branches that will be pushed out (e.g. if you always push 'maint'
2938 and 'master' there and no other branches, the repository you push
2939 to will have these two branches, and your local 'maint' and
2940 'master' will be pushed there).
2941 +
2942 To use this mode effectively, you have to make sure _all_ the
2943 branches you would push out are ready to be pushed out before
2944 running 'git push', as the whole point of this mode is to allow you
2945 to push all of the branches in one go. If you usually finish work
2946 on only one branch and push out the result, while other branches are
2947 unfinished, this mode is not for you. Also this mode is not
2948 suitable for pushing into a shared central repository, as other
2949 people may add new branches there, or update the tip of existing
2950 branches outside your control.
2951 +
2952 This used to be the default, but not since Git 2.0 (`simple` is the
2953 new default).
2955 --
2957 push.followTags::
2958 If set to true enable `--follow-tags` option by default. You
2959 may override this configuration at time of push by specifying
2960 `--no-follow-tags`.
2962 push.gpgSign::
2963 May be set to a boolean value, or the string 'if-asked'. A true
2964 value causes all pushes to be GPG signed, as if `--signed` is
2965 passed to linkgit:git-push[1]. The string 'if-asked' causes
2966 pushes to be signed if the server supports it, as if
2967 `--signed=if-asked` is passed to 'git push'. A false value may
2968 override a value from a lower-priority config file. An explicit
2969 command-line flag always overrides this config option.
2971 push.pushOption::
2972 When no `--push-option=<option>` argument is given from the
2973 command line, `git push` behaves as if each <value> of
2974 this variable is given as `--push-option=<value>`.
2975 +
2976 This is a multi-valued variable, and an empty value can be used in a
2977 higher priority configuration file (e.g. `.git/config` in a
2978 repository) to clear the values inherited from a lower priority
2979 configuration files (e.g. `$HOME/.gitconfig`).
2980 +
2981 --
2983 Example:
2985 /etc/gitconfig
2986 push.pushoption = a
2987 push.pushoption = b
2989 ~/.gitconfig
2990 push.pushoption = c
2992 repo/.git/config
2993 push.pushoption =
2994 push.pushoption = b
2996 This will result in only b (a and c are cleared).
2998 --
3000 push.recurseSubmodules::
3001 Make sure all submodule commits used by the revisions to be pushed
3002 are available on a remote-tracking branch. If the value is 'check'
3003 then Git will verify that all submodule commits that changed in the
3004 revisions to be pushed are available on at least one remote of the
3005 submodule. If any commits are missing, the push will be aborted and
3006 exit with non-zero status. If the value is 'on-demand' then all
3007 submodules that changed in the revisions to be pushed will be
3008 pushed. If on-demand was not able to push all necessary revisions
3009 it will also be aborted and exit with non-zero status. If the value
3010 is 'no' then default behavior of ignoring submodules when pushing
3011 is retained. You may override this configuration at time of push by
3012 specifying '--recurse-submodules=check|on-demand|no'.
3014 include::rebase-config.txt[]
3016 receive.advertiseAtomic::
3017 By default, git-receive-pack will advertise the atomic push
3018 capability to its clients. If you don't want to advertise this
3019 capability, set this variable to false.
3021 receive.advertisePushOptions::
3022 When set to true, git-receive-pack will advertise the push options
3023 capability to its clients. False by default.
3025 receive.autogc::
3026 By default, git-receive-pack will run "git-gc --auto" after
3027 receiving data from git-push and updating refs. You can stop
3028 it by setting this variable to false.
3030 receive.certNonceSeed::
3031 By setting this variable to a string, `git receive-pack`
3032 will accept a `git push --signed` and verifies it by using
3033 a "nonce" protected by HMAC using this string as a secret
3034 key.
3036 receive.certNonceSlop::
3037 When a `git push --signed` sent a push certificate with a
3038 "nonce" that was issued by a receive-pack serving the same
3039 repository within this many seconds, export the "nonce"
3040 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
3041 hooks (instead of what the receive-pack asked the sending
3042 side to include). This may allow writing checks in
3043 `pre-receive` and `post-receive` a bit easier. Instead of
3044 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
3045 that records by how many seconds the nonce is stale to
3046 decide if they want to accept the certificate, they only
3047 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
3049 receive.fsckObjects::
3050 If it is set to true, git-receive-pack will check all received
3051 objects. See `transfer.fsckObjects` for what's checked.
3052 Defaults to false. If not set, the value of
3053 `transfer.fsckObjects` is used instead.
3055 receive.fsck.<msg-id>::
3056 Acts like `fsck.<msg-id>`, but is used by
3057 linkgit:git-receive-pack[1] instead of
3058 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
3059 details.
3061 receive.fsck.skipList::
3062 Acts like `fsck.skipList`, but is used by
3063 linkgit:git-receive-pack[1] instead of
3064 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
3065 details.
3067 receive.keepAlive::
3068 After receiving the pack from the client, `receive-pack` may
3069 produce no output (if `--quiet` was specified) while processing
3070 the pack, causing some networks to drop the TCP connection.
3071 With this option set, if `receive-pack` does not transmit
3072 any data in this phase for `receive.keepAlive` seconds, it will
3073 send a short keepalive packet. The default is 5 seconds; set
3074 to 0 to disable keepalives entirely.
3076 receive.unpackLimit::
3077 If the number of objects received in a push is below this
3078 limit then the objects will be unpacked into loose object
3079 files. However if the number of received objects equals or
3080 exceeds this limit then the received pack will be stored as
3081 a pack, after adding any missing delta bases. Storing the
3082 pack from a push can make the push operation complete faster,
3083 especially on slow filesystems. If not set, the value of
3084 `transfer.unpackLimit` is used instead.
3086 receive.maxInputSize::
3087 If the size of the incoming pack stream is larger than this
3088 limit, then git-receive-pack will error out, instead of
3089 accepting the pack file. If not set or set to 0, then the size
3090 is unlimited.
3092 receive.denyDeletes::
3093 If set to true, git-receive-pack will deny a ref update that deletes
3094 the ref. Use this to prevent such a ref deletion via a push.
3096 receive.denyDeleteCurrent::
3097 If set to true, git-receive-pack will deny a ref update that
3098 deletes the currently checked out branch of a non-bare repository.
3100 receive.denyCurrentBranch::
3101 If set to true or "refuse", git-receive-pack will deny a ref update
3102 to the currently checked out branch of a non-bare repository.
3103 Such a push is potentially dangerous because it brings the HEAD
3104 out of sync with the index and working tree. If set to "warn",
3105 print a warning of such a push to stderr, but allow the push to
3106 proceed. If set to false or "ignore", allow such pushes with no
3107 message. Defaults to "refuse".
3108 +
3109 Another option is "updateInstead" which will update the working
3110 tree if pushing into the current branch. This option is
3111 intended for synchronizing working directories when one side is not easily
3112 accessible via interactive ssh (e.g. a live web site, hence the requirement
3113 that the working directory be clean). This mode also comes in handy when
3114 developing inside a VM to test and fix code on different Operating Systems.
3115 +
3116 By default, "updateInstead" will refuse the push if the working tree or
3117 the index have any difference from the HEAD, but the `push-to-checkout`
3118 hook can be used to customize this. See linkgit:githooks[5].
3120 receive.denyNonFastForwards::
3121 If set to true, git-receive-pack will deny a ref update which is
3122 not a fast-forward. Use this to prevent such an update via a push,
3123 even if that push is forced. This configuration variable is
3124 set when initializing a shared repository.
3126 receive.hideRefs::
3127 This variable is the same as `transfer.hideRefs`, but applies
3128 only to `receive-pack` (and so affects pushes, but not fetches).
3129 An attempt to update or delete a hidden ref by `git push` is
3130 rejected.
3132 receive.updateServerInfo::
3133 If set to true, git-receive-pack will run git-update-server-info
3134 after receiving data from git-push and updating refs.
3136 receive.shallowUpdate::
3137 If set to true, .git/shallow can be updated when new refs
3138 require new shallow roots. Otherwise those refs are rejected.
3140 remote.pushDefault::
3141 The remote to push to by default. Overrides
3142 `branch.<name>.remote` for all branches, and is overridden by
3143 `branch.<name>.pushRemote` for specific branches.
3145 remote.<name>.url::
3146 The URL of a remote repository. See linkgit:git-fetch[1] or
3147 linkgit:git-push[1].
3149 remote.<name>.pushurl::
3150 The push URL of a remote repository. See linkgit:git-push[1].
3152 remote.<name>.proxy::
3153 For remotes that require curl (http, https and ftp), the URL to
3154 the proxy to use for that remote. Set to the empty string to
3155 disable proxying for that remote.
3157 remote.<name>.proxyAuthMethod::
3158 For remotes that require curl (http, https and ftp), the method to use for
3159 authenticating against the proxy in use (probably set in
3160 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3162 remote.<name>.fetch::
3163 The default set of "refspec" for linkgit:git-fetch[1]. See
3164 linkgit:git-fetch[1].
3166 remote.<name>.push::
3167 The default set of "refspec" for linkgit:git-push[1]. See
3168 linkgit:git-push[1].
3170 remote.<name>.mirror::
3171 If true, pushing to this remote will automatically behave
3172 as if the `--mirror` option was given on the command line.
3174 remote.<name>.skipDefaultUpdate::
3175 If true, this remote will be skipped by default when updating
3176 using linkgit:git-fetch[1] or the `update` subcommand of
3177 linkgit:git-remote[1].
3179 remote.<name>.skipFetchAll::
3180 If true, this remote will be skipped by default when updating
3181 using linkgit:git-fetch[1] or the `update` subcommand of
3182 linkgit:git-remote[1].
3184 remote.<name>.receivepack::
3185 The default program to execute on the remote side when pushing. See
3186 option --receive-pack of linkgit:git-push[1].
3188 remote.<name>.uploadpack::
3189 The default program to execute on the remote side when fetching. See
3190 option --upload-pack of linkgit:git-fetch-pack[1].
3192 remote.<name>.tagOpt::
3193 Setting this value to --no-tags disables automatic tag following when
3194 fetching from remote <name>. Setting it to --tags will fetch every
3195 tag from remote <name>, even if they are not reachable from remote
3196 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3197 override this setting. See options --tags and --no-tags of
3198 linkgit:git-fetch[1].
3200 remote.<name>.vcs::
3201 Setting this to a value <vcs> will cause Git to interact with
3202 the remote with the git-remote-<vcs> helper.
3204 remote.<name>.prune::
3205 When set to true, fetching from this remote by default will also
3206 remove any remote-tracking references that no longer exist on the
3207 remote (as if the `--prune` option was given on the command line).
3208 Overrides `fetch.prune` settings, if any.
3210 remote.<name>.pruneTags::
3211 When set to true, fetching from this remote by default will also
3212 remove any local tags that no longer exist on the remote if pruning
3213 is activated in general via `remote.<name>.prune`, `fetch.prune` or
3214 `--prune`. Overrides `fetch.pruneTags` settings, if any.
3215 +
3216 See also `remote.<name>.prune` and the PRUNING section of
3217 linkgit:git-fetch[1].
3219 remotes.<group>::
3220 The list of remotes which are fetched by "git remote update
3221 <group>". See linkgit:git-remote[1].
3223 repack.useDeltaBaseOffset::
3224 By default, linkgit:git-repack[1] creates packs that use
3225 delta-base offset. If you need to share your repository with
3226 Git older than version 1.4.4, either directly or via a dumb
3227 protocol such as http, then you need to set this option to
3228 "false" and repack. Access from old Git versions over the
3229 native protocol are unaffected by this option.
3231 repack.packKeptObjects::
3232 If set to true, makes `git repack` act as if
3233 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3234 details. Defaults to `false` normally, but `true` if a bitmap
3235 index is being written (either via `--write-bitmap-index` or
3236 `repack.writeBitmaps`).
3238 repack.useDeltaIslands::
3239 If set to true, makes `git repack` act as if `--delta-islands`
3240 was passed. Defaults to `false`.
3242 repack.writeBitmaps::
3243 When true, git will write a bitmap index when packing all
3244 objects to disk (e.g., when `git repack -a` is run). This
3245 index can speed up the "counting objects" phase of subsequent
3246 packs created for clones and fetches, at the cost of some disk
3247 space and extra time spent on the initial repack. This has
3248 no effect if multiple packfiles are created.
3249 Defaults to false.
3251 rerere.autoUpdate::
3252 When set to true, `git-rerere` updates the index with the
3253 resulting contents after it cleanly resolves conflicts using
3254 previously recorded resolution. Defaults to false.
3256 rerere.enabled::
3257 Activate recording of resolved conflicts, so that identical
3258 conflict hunks can be resolved automatically, should they be
3259 encountered again. By default, linkgit:git-rerere[1] is
3260 enabled if there is an `rr-cache` directory under the
3261 `$GIT_DIR`, e.g. if "rerere" was previously used in the
3262 repository.
3264 sendemail.identity::
3265 A configuration identity. When given, causes values in the
3266 'sendemail.<identity>' subsection to take precedence over
3267 values in the 'sendemail' section. The default identity is
3268 the value of `sendemail.identity`.
3270 sendemail.smtpEncryption::
3271 See linkgit:git-send-email[1] for description. Note that this
3272 setting is not subject to the 'identity' mechanism.
3274 sendemail.smtpssl (deprecated)::
3275 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3277 sendemail.smtpsslcertpath::
3278 Path to ca-certificates (either a directory or a single file).
3279 Set it to an empty string to disable certificate verification.
3281 sendemail.<identity>.*::
3282 Identity-specific versions of the 'sendemail.*' parameters
3283 found below, taking precedence over those when this
3284 identity is selected, through either the command-line or
3285 `sendemail.identity`.
3287 sendemail.aliasesFile::
3288 sendemail.aliasFileType::
3289 sendemail.annotate::
3290 sendemail.bcc::
3292 sendemail.ccCmd::
3293 sendemail.chainReplyTo::
3294 sendemail.confirm::
3295 sendemail.envelopeSender::
3296 sendemail.from::
3297 sendemail.multiEdit::
3298 sendemail.signedoffbycc::
3299 sendemail.smtpPass::
3300 sendemail.suppresscc::
3301 sendemail.suppressFrom::
3303 sendemail.tocmd::
3304 sendemail.smtpDomain::
3305 sendemail.smtpServer::
3306 sendemail.smtpServerPort::
3307 sendemail.smtpServerOption::
3308 sendemail.smtpUser::
3309 sendemail.thread::
3310 sendemail.transferEncoding::
3311 sendemail.validate::
3312 sendemail.xmailer::
3313 See linkgit:git-send-email[1] for description.
3315 sendemail.signedoffcc (deprecated)::
3316 Deprecated alias for `sendemail.signedoffbycc`.
3318 sendemail.smtpBatchSize::
3319 Number of messages to be sent per connection, after that a relogin
3320 will happen. If the value is 0 or undefined, send all messages in
3321 one connection.
3322 See also the `--batch-size` option of linkgit:git-send-email[1].
3324 sendemail.smtpReloginDelay::
3325 Seconds wait before reconnecting to smtp server.
3326 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3328 showbranch.default::
3329 The default set of branches for linkgit:git-show-branch[1].
3330 See linkgit:git-show-branch[1].
3332 splitIndex.maxPercentChange::
3333 When the split index feature is used, this specifies the
3334 percent of entries the split index can contain compared to the
3335 total number of entries in both the split index and the shared
3336 index before a new shared index is written.
3337 The value should be between 0 and 100. If the value is 0 then
3338 a new shared index is always written, if it is 100 a new
3339 shared index is never written.
3340 By default the value is 20, so a new shared index is written
3341 if the number of entries in the split index would be greater
3342 than 20 percent of the total number of entries.
3343 See linkgit:git-update-index[1].
3345 splitIndex.sharedIndexExpire::
3346 When the split index feature is used, shared index files that
3347 were not modified since the time this variable specifies will
3348 be removed when a new shared index file is created. The value
3349 "now" expires all entries immediately, and "never" suppresses
3350 expiration altogether.
3351 The default value is "2.weeks.ago".
3352 Note that a shared index file is considered modified (for the
3353 purpose of expiration) each time a new split-index file is
3354 either created based on it or read from it.
3355 See linkgit:git-update-index[1].
3357 status.relativePaths::
3358 By default, linkgit:git-status[1] shows paths relative to the
3359 current directory. Setting this variable to `false` shows paths
3360 relative to the repository root (this was the default for Git
3361 prior to v1.5.4).
3363 status.short::
3364 Set to true to enable --short by default in linkgit:git-status[1].
3365 The option --no-short takes precedence over this variable.
3367 status.branch::
3368 Set to true to enable --branch by default in linkgit:git-status[1].
3369 The option --no-branch takes precedence over this variable.
3371 status.displayCommentPrefix::
3372 If set to true, linkgit:git-status[1] will insert a comment
3373 prefix before each output line (starting with
3374 `core.commentChar`, i.e. `#` by default). This was the
3375 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3376 Defaults to false.
3378 status.renameLimit::
3379 The number of files to consider when performing rename detection
3380 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3381 the value of diff.renameLimit.
3383 status.renames::
3384 Whether and how Git detects renames in linkgit:git-status[1] and
3385 linkgit:git-commit[1] . If set to "false", rename detection is
3386 disabled. If set to "true", basic rename detection is enabled.
3387 If set to "copies" or "copy", Git will detect copies, as well.
3388 Defaults to the value of diff.renames.
3390 status.showStash::
3391 If set to true, linkgit:git-status[1] will display the number of
3392 entries currently stashed away.
3393 Defaults to false.
3395 status.showUntrackedFiles::
3396 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3397 files which are not currently tracked by Git. Directories which
3398 contain only untracked files, are shown with the directory name
3399 only. Showing untracked files means that Git needs to lstat() all
3400 the files in the whole repository, which might be slow on some
3401 systems. So, this variable controls how the commands displays
3402 the untracked files. Possible values are:
3403 +
3404 --
3405 * `no` - Show no untracked files.
3406 * `normal` - Show untracked files and directories.
3407 * `all` - Show also individual files in untracked directories.
3408 --
3409 +
3410 If this variable is not specified, it defaults to 'normal'.
3411 This variable can be overridden with the -u|--untracked-files option
3412 of linkgit:git-status[1] and linkgit:git-commit[1].
3414 status.submoduleSummary::
3415 Defaults to false.
3416 If this is set to a non zero number or true (identical to -1 or an
3417 unlimited number), the submodule summary will be enabled and a
3418 summary of commits for modified submodules will be shown (see
3419 --summary-limit option of linkgit:git-submodule[1]). Please note
3420 that the summary output command will be suppressed for all
3421 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3422 for those submodules where `submodule.<name>.ignore=all`. The only
3423 exception to that rule is that status and commit will show staged
3424 submodule changes. To
3425 also view the summary for ignored submodules you can either use
3426 the --ignore-submodules=dirty command-line option or the 'git
3427 submodule summary' command, which shows a similar output but does
3428 not honor these settings.
3430 stash.showPatch::
3431 If this is set to true, the `git stash show` command without an
3432 option will show the stash entry in patch form. Defaults to false.
3433 See description of 'show' command in linkgit:git-stash[1].
3435 stash.showStat::
3436 If this is set to true, the `git stash show` command without an
3437 option will show diffstat of the stash entry. Defaults to true.
3438 See description of 'show' command in linkgit:git-stash[1].
3440 submodule.<name>.url::
3441 The URL for a submodule. This variable is copied from the .gitmodules
3442 file to the git config via 'git submodule init'. The user can change
3443 the configured URL before obtaining the submodule via 'git submodule
3444 update'. If neither submodule.<name>.active or are
3445 set, the presence of this variable is used as a fallback to indicate
3446 whether the submodule is of interest to git commands.
3447 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3449 submodule.<name>.update::
3450 The method by which a submodule is updated by 'git submodule update',
3451 which is the only affected command, others such as
3452 'git checkout --recurse-submodules' are unaffected. It exists for
3453 historical reasons, when 'git submodule' was the only command to
3454 interact with submodules; settings like ``
3455 and `pull.rebase` are more specific. It is populated by
3456 `git submodule init` from the linkgit:gitmodules[5] file.
3457 See description of 'update' command in linkgit:git-submodule[1].
3459 submodule.<name>.branch::
3460 The remote branch name for a submodule, used by `git submodule
3461 update --remote`. Set this option to override the value found in
3462 the `.gitmodules` file. See linkgit:git-submodule[1] and
3463 linkgit:gitmodules[5] for details.
3465 submodule.<name>.fetchRecurseSubmodules::
3466 This option can be used to control recursive fetching of this
3467 submodule. It can be overridden by using the --[no-]recurse-submodules
3468 command-line option to "git fetch" and "git pull".
3469 This setting will override that from in the linkgit:gitmodules[5]
3470 file.
3472 submodule.<name>.ignore::
3473 Defines under what circumstances "git status" and the diff family show
3474 a submodule as modified. When set to "all", it will never be considered
3475 modified (but it will nonetheless show up in the output of status and
3476 commit when it has been staged), "dirty" will ignore all changes
3477 to the submodules work tree and
3478 takes only differences between the HEAD of the submodule and the commit
3479 recorded in the superproject into account. "untracked" will additionally
3480 let submodules with modified tracked files in their work tree show up.
3481 Using "none" (the default when this option is not set) also shows
3482 submodules that have untracked files in their work tree as changed.
3483 This setting overrides any setting made in .gitmodules for this submodule,
3484 both settings can be overridden on the command line by using the
3485 "--ignore-submodules" option. The 'git submodule' commands are not
3486 affected by this setting.
3488 submodule.<name>.active::
3489 Boolean value indicating if the submodule is of interest to git
3490 commands. This config option takes precedence over the
3491 config option. See linkgit:gitsubmodules[7] for
3492 details.
3495 A repeated field which contains a pathspec used to match against a
3496 submodule's path to determine if the submodule is of interest to git
3497 commands. See linkgit:gitsubmodules[7] for details.
3499 submodule.recurse::
3500 Specifies if commands recurse into submodules by default. This
3501 applies to all commands that have a `--recurse-submodules` option,
3502 except `clone`.
3503 Defaults to false.
3505 submodule.fetchJobs::
3506 Specifies how many submodules are fetched/cloned at the same time.
3507 A positive integer allows up to that number of submodules fetched
3508 in parallel. A value of 0 will give some reasonable default.
3509 If unset, it defaults to 1.
3511 submodule.alternateLocation::
3512 Specifies how the submodules obtain alternates when submodules are
3513 cloned. Possible values are `no`, `superproject`.
3514 By default `no` is assumed, which doesn't add references. When the
3515 value is set to `superproject` the submodule to be cloned computes
3516 its alternates location relative to the superprojects alternate.
3518 submodule.alternateErrorStrategy::
3519 Specifies how to treat errors with the alternates for a submodule
3520 as computed via `submodule.alternateLocation`. Possible values are
3521 `ignore`, `info`, `die`. Default is `die`.
3523 tag.forceSignAnnotated::
3524 A boolean to specify whether annotated tags created should be GPG signed.
3525 If `--annotate` is specified on the command line, it takes
3526 precedence over this option.
3528 tag.sort::
3529 This variable controls the sort ordering of tags when displayed by
3530 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3531 value of this variable will be used as the default.
3533 tar.umask::
3534 This variable can be used to restrict the permission bits of
3535 tar archive entries. The default is 0002, which turns off the
3536 world write bit. The special value "user" indicates that the
3537 archiving user's umask will be used instead. See umask(2) and
3538 linkgit:git-archive[1].
3540 transfer.fsckObjects::
3541 When `fetch.fsckObjects` or `receive.fsckObjects` are
3542 not set, the value of this variable is used instead.
3543 Defaults to false.
3544 +
3545 When set, the fetch or receive will abort in the case of a malformed
3546 object or a link to a nonexistent object. In addition, various other
3547 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
3548 and potential security issues like the existence of a `.GIT` directory
3549 or a malicious `.gitmodules` file (see the release notes for v2.2.1
3550 and v2.17.1 for details). Other sanity and security checks may be
3551 added in future releases.
3552 +
3553 On the receiving side, failing fsckObjects will make those objects
3554 unreachable, see "QUARANTINE ENVIRONMENT" in
3555 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
3556 instead be left unreferenced in the repository.
3557 +
3558 Due to the non-quarantine nature of the `fetch.fsckObjects`
3559 implementation it can not be relied upon to leave the object store
3560 clean like `receive.fsckObjects` can.
3561 +
3562 As objects are unpacked they're written to the object store, so there
3563 can be cases where malicious objects get introduced even though the
3564 "fetch" failed, only to have a subsequent "fetch" succeed because only
3565 new incoming objects are checked, not those that have already been
3566 written to the object store. That difference in behavior should not be
3567 relied upon. In the future, such objects may be quarantined for
3568 "fetch" as well.
3569 +
3570 For now, the paranoid need to find some way to emulate the quarantine
3571 environment if they'd like the same protection as "push". E.g. in the
3572 case of an internal mirror do the mirroring in two steps, one to fetch
3573 the untrusted objects, and then do a second "push" (which will use the
3574 quarantine) to another internal repo, and have internal clients
3575 consume this pushed-to repository, or embargo internal fetches and
3576 only allow them once a full "fsck" has run (and no new fetches have
3577 happened in the meantime).
3579 transfer.hideRefs::
3580 String(s) `receive-pack` and `upload-pack` use to decide which
3581 refs to omit from their initial advertisements. Use more than
3582 one definition to specify multiple prefix strings. A ref that is
3583 under the hierarchies listed in the value of this variable is
3584 excluded, and is hidden when responding to `git push` or `git
3585 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3586 program-specific versions of this config.
3587 +
3588 You may also include a `!` in front of the ref name to negate the entry,
3589 explicitly exposing it, even if an earlier entry marked it as hidden.
3590 If you have multiple hideRefs values, later entries override earlier ones
3591 (and entries in more-specific config files override less-specific ones).
3592 +
3593 If a namespace is in use, the namespace prefix is stripped from each
3594 reference before it is matched against `transfer.hiderefs` patterns.
3595 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3596 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3597 is omitted from the advertisements but `refs/heads/master` and
3598 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3599 "have" lines. In order to match refs before stripping, add a `^` in front of
3600 the ref name. If you combine `!` and `^`, `!` must be specified first.
3601 +
3602 Even if you hide refs, a client may still be able to steal the target
3603 objects via the techniques described in the "SECURITY" section of the
3604 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3605 separate repository.
3607 transfer.unpackLimit::
3608 When `fetch.unpackLimit` or `receive.unpackLimit` are
3609 not set, the value of this variable is used instead.
3610 The default value is 100.
3612 uploadarchive.allowUnreachable::
3613 If true, allow clients to use `git archive --remote` to request
3614 any tree, whether reachable from the ref tips or not. See the
3615 discussion in the "SECURITY" section of
3616 linkgit:git-upload-archive[1] for more details. Defaults to
3617 `false`.
3619 uploadpack.hideRefs::
3620 This variable is the same as `transfer.hideRefs`, but applies
3621 only to `upload-pack` (and so affects only fetches, not pushes).
3622 An attempt to fetch a hidden ref by `git fetch` will fail. See
3623 also `uploadpack.allowTipSHA1InWant`.
3625 uploadpack.allowTipSHA1InWant::
3626 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3627 to accept a fetch request that asks for an object at the tip
3628 of a hidden ref (by default, such a request is rejected).
3629 See also `uploadpack.hideRefs`. Even if this is false, a client
3630 may be able to steal objects via the techniques described in the
3631 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3632 best to keep private data in a separate repository.
3634 uploadpack.allowReachableSHA1InWant::
3635 Allow `upload-pack` to accept a fetch request that asks for an
3636 object that is reachable from any ref tip. However, note that
3637 calculating object reachability is computationally expensive.
3638 Defaults to `false`. Even if this is false, a client may be able
3639 to steal objects via the techniques described in the "SECURITY"
3640 section of the linkgit:gitnamespaces[7] man page; it's best to
3641 keep private data in a separate repository.
3643 uploadpack.allowAnySHA1InWant::
3644 Allow `upload-pack` to accept a fetch request that asks for any
3645 object at all.
3646 Defaults to `false`.
3648 uploadpack.keepAlive::
3649 When `upload-pack` has started `pack-objects`, there may be a
3650 quiet period while `pack-objects` prepares the pack. Normally
3651 it would output progress information, but if `--quiet` was used
3652 for the fetch, `pack-objects` will output nothing at all until
3653 the pack data begins. Some clients and networks may consider
3654 the server to be hung and give up. Setting this option instructs
3655 `upload-pack` to send an empty keepalive packet every
3656 `uploadpack.keepAlive` seconds. Setting this option to 0
3657 disables keepalive packets entirely. The default is 5 seconds.
3659 uploadpack.packObjectsHook::
3660 If this option is set, when `upload-pack` would run
3661 `git pack-objects` to create a packfile for a client, it will
3662 run this shell command instead. The `pack-objects` command and
3663 arguments it _would_ have run (including the `git pack-objects`
3664 at the beginning) are appended to the shell command. The stdin
3665 and stdout of the hook are treated as if `pack-objects` itself
3666 was run. I.e., `upload-pack` will feed input intended for
3667 `pack-objects` to the hook, and expects a completed packfile on
3668 stdout.
3670 uploadpack.allowFilter::
3671 If this option is set, `upload-pack` will support partial
3672 clone and partial fetch object filtering.
3673 +
3674 Note that this configuration variable is ignored if it is seen in the
3675 repository-level config (this is a safety measure against fetching from
3676 untrusted repositories).
3678 uploadpack.allowRefInWant::
3679 If this option is set, `upload-pack` will support the `ref-in-want`
3680 feature of the protocol version 2 `fetch` command. This feature
3681 is intended for the benefit of load-balanced servers which may
3682 not have the same view of what OIDs their refs point to due to
3683 replication delay.
3685 url.<base>.insteadOf::
3686 Any URL that starts with this value will be rewritten to
3687 start, instead, with <base>. In cases where some site serves a
3688 large number of repositories, and serves them with multiple
3689 access methods, and some users need to use different access
3690 methods, this feature allows people to specify any of the
3691 equivalent URLs and have Git automatically rewrite the URL to
3692 the best alternative for the particular user, even for a
3693 never-before-seen repository on the site. When more than one
3694 insteadOf strings match a given URL, the longest match is used.
3695 +
3696 Note that any protocol restrictions will be applied to the rewritten
3697 URL. If the rewrite changes the URL to use a custom protocol or remote
3698 helper, you may need to adjust the `protocol.*.allow` config to permit
3699 the request. In particular, protocols you expect to use for submodules
3700 must be set to `always` rather than the default of `user`. See the
3701 description of `protocol.allow` above.
3703 url.<base>.pushInsteadOf::
3704 Any URL that starts with this value will not be pushed to;
3705 instead, it will be rewritten to start with <base>, and the
3706 resulting URL will be pushed to. In cases where some site serves
3707 a large number of repositories, and serves them with multiple
3708 access methods, some of which do not allow push, this feature
3709 allows people to specify a pull-only URL and have Git
3710 automatically use an appropriate URL to push, even for a
3711 never-before-seen repository on the site. When more than one
3712 pushInsteadOf strings match a given URL, the longest match is
3713 used. If a remote has an explicit pushurl, Git will ignore this
3714 setting for that remote.
3717 Your email address to be recorded in any newly created commits.
3718 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3719 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3722 Your full name to be recorded in any newly created commits.
3723 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3724 environment variables. See linkgit:git-commit-tree[1].
3726 user.useConfigOnly::
3727 Instruct Git to avoid trying to guess defaults for ``
3728 and ``, and instead retrieve the values only from the
3729 configuration. For example, if you have multiple email addresses
3730 and would like to use a different one for each repository, then
3731 with this configuration option set to `true` in the global config
3732 along with a name, Git will prompt you to set up an email before
3733 making new commits in a newly cloned repository.
3734 Defaults to `false`.
3736 user.signingKey::
3737 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3738 key you want it to automatically when creating a signed tag or
3739 commit, you can override the default selection with this variable.
3740 This option is passed unchanged to gpg's --local-user parameter,
3741 so you may specify a key using any method that gpg supports.
3743 versionsort.prereleaseSuffix (deprecated)::
3744 Deprecated alias for `versionsort.suffix`. Ignored if
3745 `versionsort.suffix` is set.
3747 versionsort.suffix::
3748 Even when version sort is used in linkgit:git-tag[1], tagnames
3749 with the same base version but different suffixes are still sorted
3750 lexicographically, resulting e.g. in prerelease tags appearing
3751 after the main release (e.g. "1.0-rc1" after "1.0"). This
3752 variable can be specified to determine the sorting order of tags
3753 with different suffixes.
3754 +
3755 By specifying a single suffix in this variable, any tagname containing
3756 that suffix will appear before the corresponding main release. E.g. if
3757 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3758 "1.0". If specified multiple times, once per suffix, then the order of
3759 suffixes in the configuration will determine the sorting order of tagnames
3760 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3761 configuration, then all "1.0-preX" tags will be listed before any
3762 "1.0-rcX" tags. The placement of the main release tag relative to tags
3763 with various suffixes can be determined by specifying the empty suffix
3764 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3765 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3766 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3767 "v4.8-bfsX".
3768 +
3769 If more than one suffixes match the same tagname, then that tagname will
3770 be sorted according to the suffix which starts at the earliest position in
3771 the tagname. If more than one different matching suffixes start at
3772 that earliest position, then that tagname will be sorted according to the
3773 longest of those suffixes.
3774 The sorting order between different suffixes is undefined if they are
3775 in multiple config files.
3777 web.browser::
3778 Specify a web browser that may be used by some commands.
3779 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3780 may use it.
3782 worktree.guessRemote::
3783 With `add`, if no branch argument, and neither of `-b` nor
3784 `-B` nor `--detach` are given, the command defaults to
3785 creating a new branch from HEAD. If `worktree.guessRemote` is
3786 set to true, `worktree add` tries to find a remote-tracking
3787 branch whose name uniquely matches the new branch name. If
3788 such a branch exists, it is checked out and set as "upstream"
3789 for the new branch. If no such match can be found, it falls
3790 back to creating a new branch from the current HEAD.