1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline and the null byte. Doublequote `"` and backslash can be included 45by escaping them as `\"` and `\\`, respectively. Backslashes preceding 46other 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. 48Variables may belong directly to a section or to a given subsection. You 49can have `[section]` if you have `[section "subsection"]`, but you don't 50need to. 51 52There is also a deprecated `[section.subsection]` syntax. With this 53syntax, the subsection name is converted to lower-case and is also 54compared case sensitively. These subsection names follow the same 55restrictions as section names. 56 57All the other lines (and the remainder of the line after the section 58header) are recognized as setting variables, in the form 59'name = value' (or just 'name', which is a short-hand to say that 60the variable is the boolean "true"). 61The variable names are case-insensitive, allow only alphanumeric characters 62and `-`, and must start with an alphabetic character. 63 64A line that defines a value can be continued to the next line by 65ending it with a `\`; the backquote and the end-of-line are 66stripped. Leading whitespaces after 'name =', the remainder of the 67line after the first comment character '#' or ';', and trailing 68whitespaces of the line are discarded unless they are enclosed in 69double quotes. Internal whitespaces within the value are retained 70verbatim. 71 72Inside double quotes, double quote `"` and backslash `\` characters 73must be escaped: use `\"` for `"` and `\\` for `\`. 74 75The following escape sequences (beside `\"` and `\\`) are recognized: 76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 77and `\b` for backspace (BS). Other char escape sequences (including octal 78escape sequences) are invalid. 79 80 81Includes 82~~~~~~~~ 83 84The `include` and `includeIf` sections allow you to include config 85directives from another source. These sections behave identically to 86each other with the exception that `includeIf` sections may be ignored 87if their condition does not evaluate to true; see "Conditional includes" 88below. 89 90You can include a config file from another by setting the special 91`include.path` (or `includeIf.*.path`) variable to the name of the file 92to be included. The variable takes a pathname as its value, and is 93subject to tilde expansion. These variables can be given multiple times. 94 95The contents of the included file are inserted immediately, as if they 96had been found at the location of the include directive. If the value of the 97variable is a relative path, the path is considered to 98be relative to the configuration file in which the include directive 99was found. See below for examples. 100 101Conditional includes 102~~~~~~~~~~~~~~~~~~~~ 103 104You can include a config file from another conditionally by setting a 105`includeIf.<condition>.path` variable to the name of the file to be 106included. 107 108The condition starts with a keyword followed by a colon and some data 109whose format and meaning depends on the keyword. Supported keywords 110are: 111 112`gitdir`:: 113 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+ 118The .git location may be auto-discovered, or come from `$GIT_DIR` 119environment variable. If the repository is auto discovered via a .git 120file (e.g. from submodules, or a linked worktree), the .git location 121would be the final location where the .git directory is, not where the 122.git file is. 123+ 124The pattern can contain standard globbing wildcards and two additional 125ones, `**/` and `/**`, that can match multiple path components. Please 126refer to linkgit:gitignore[5] for details. For convenience: 127 128 * If the pattern starts with `~/`, `~` will be substituted with the 129 content of the environment variable `HOME`. 130 131 * If the pattern starts with `./`, it is replaced with the directory 132 containing the current config file. 133 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`. 137 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. 141 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) 145 146A few more notes on matching via `gitdir` and `gitdir/i`: 147 148 * Symlinks in `$GIT_DIR` are not resolved before matching. 149 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+ 155This was not the case in the initial release of this feature in 156v2.13.0, which only matched the realpath version. Configuration that 157wants to be compatible with the initial release of this feature needs 158to either specify only the realpath version, or both versions. 159 160 * Note that "../" is not special and will match literally, which is 161 unlikely what you want. 162 163Example 164~~~~~~~ 165 166 # Core variables 167 [core] 168 ; Don't trust file modes 169 filemode = false 170 171 # Our diff algorithm 172 [diff] 173 external = /usr/local/bin/diff-wrapper 174 renames = true 175 176 [branch "devel"] 177 remote = origin 178 merge = refs/heads/devel 179 180 # Proxy settings 181 [core] 182 gitProxy="ssh" for "kernel.org" 183 gitProxy=default-proxy ; for the rest 184 185 [include] 186 path = /path/to/foo.inc ; include by absolute path 187 path = foo.inc ; find "foo.inc" relative to the current file 188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 189 190 ; include if $GIT_DIR is /path/to/foo/.git 191 [includeIf "gitdir:/path/to/foo/.git"] 192 path = /path/to/foo.inc 193 194 ; include for all repositories inside /path/to/group 195 [includeIf "gitdir:/path/to/group/"] 196 path = /path/to/foo.inc 197 198 ; include for all repositories inside $HOME/to/group 199 [includeIf "gitdir:~/to/group/"] 200 path = /path/to/foo.inc 201 202 ; relative paths are always relative to the including 203 ; file (if the condition is true); their location is not 204 ; affected by the condition 205 [includeIf "gitdir:/path/to/group/"] 206 path = foo.inc 207 208Values 209~~~~~~ 210 211Values of many variables are treated as a simple string, but there 212are variables that take values of specific types and there are rules 213as to how to spell them. 214 215boolean:: 216 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. 220 221 true;; Boolean true literals are `yes`, `on`, `true`, 222 and `1`. Also, a variable defined without `= <value>` 223 is taken as true. 224 225 false;; Boolean false literals are `no`, `off`, `false`, 226 `0` and the empty string. 227+ 228When converting value to the canonical form using `--bool` type 229specifier, 'git config' will ensure that the output is "true" or 230"false" (spelled in lowercase). 231 232integer:: 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. 236 237color:: 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+ 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 243`blue`, `magenta`, `cyan` and `white`. The first color given is the 244foreground; the second is the background. 245+ 246Colors may also be given as numbers between 0 and 255; these use ANSI 247256-color mode (but note that not all terminals may support this). If 248your terminal supports it, you may also specify 24-bit RGB values as 249hex, like `#ff0ab3`. 250+ 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 252`italic`, and `strike` (for crossed-out or "strikethrough" letters). 253The position of any attributes with respect to the colors 254(before, after, or in between), doesn't matter. Specific attributes may 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 256`no-ul`, etc). 257+ 258An empty color string produces no color effect at all. This can be used 259to avoid coloring specific elements without disabling color entirely. 260+ 261For git's pre-defined color slots, the attributes are meant to be reset 262at the beginning of each item in the colored output. So setting 263`color.decorate.branch` to `black` will paint that branch name in a 264plain `black`, even if the previous thing on the same output line (e.g. 265opening parenthesis before the list of branch names in `log --decorate` 266output) is set to be painted with `bold` or some other attribute. 267However, custom log formats may do more complicated and layered 268coloring, and the negated forms may be useful there. 269 270pathname:: 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. 276 277 278Variables 279~~~~~~~~~ 280 281Note that this list is non-comprehensive and not necessarily complete. 282For command-specific variables, you will find a more detailed description 283in the appropriate manual page. 284 285Other git-related tools may and do use their own variables. When 286inventing new variables for use in your own tool, make sure their 287names do not conflict with those that are used by Git itself and 288other popular tools, and describe them in your documentation. 289 290 291advice.*:: 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 amWorkDir:: 348 Advice that shows the location of the patch file when 349 linkgit:git-am[1] fails to apply it. 350 rmHints:: 351 In case of failure in the output of linkgit:git-rm[1], 352 show directions on how to proceed from the current state. 353 addEmbeddedRepo:: 354 Advice on what to do when you've accidentally added one 355 git repo inside of another. 356 ignoredHook:: 357 Advice shown if an hook is ignored because the hook is not 358 set as executable. 359 waitingForEditor:: 360 Print a message to the terminal whenever Git is waiting for 361 editor input from the user. 362-- 363 364core.fileMode:: 365 Tells Git if the executable bit of files in the working tree 366 is to be honored. 367+ 368Some filesystems lose the executable bit when a file that is 369marked as executable is checked out, or checks out a 370non-executable file with executable bit on. 371linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 372to see if it handles the executable bit correctly 373and this variable is automatically set as necessary. 374+ 375A repository, however, may be on a filesystem that handles 376the filemode correctly, and this variable is set to 'true' 377when created, but later may be made accessible from another 378environment that loses the filemode (e.g. exporting ext4 via 379CIFS mount, visiting a Cygwin created repository with 380Git for Windows or Eclipse). 381In such a case it may be necessary to set this variable to 'false'. 382See linkgit:git-update-index[1]. 383+ 384The default is true (when core.filemode is not specified in the config file). 385 386core.hideDotFiles:: 387 (Windows-only) If true, mark newly-created directories and files whose 388 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 389 directory is hidden, but no other files starting with a dot. The 390 default mode is 'dotGitOnly'. 391 392core.ignoreCase:: 393 If true, this option enables various workarounds to enable 394 Git to work better on filesystems that are not case sensitive, 395 like FAT. For example, if a directory listing finds 396 "makefile" when Git expects "Makefile", Git will assume 397 it is really the same file, and continue to remember it as 398 "Makefile". 399+ 400The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 401will probe and set core.ignoreCase true if appropriate when the repository 402is created. 403 404core.precomposeUnicode:: 405 This option is only used by Mac OS implementation of Git. 406 When core.precomposeUnicode=true, Git reverts the unicode decomposition 407 of filenames done by Mac OS. This is useful when sharing a repository 408 between Mac OS and Linux or Windows. 409 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 410 When false, file names are handled fully transparent by Git, 411 which is backward compatible with older versions of Git. 412 413core.protectHFS:: 414 If set to true, do not allow checkout of paths that would 415 be considered equivalent to `.git` on an HFS+ filesystem. 416 Defaults to `true` on Mac OS, and `false` elsewhere. 417 418core.protectNTFS:: 419 If set to true, do not allow checkout of paths that would 420 cause problems with the NTFS filesystem, e.g. conflict with 421 8.3 "short" names. 422 Defaults to `true` on Windows, and `false` elsewhere. 423 424core.fsmonitor:: 425 If set, the value of this variable is used as a command which 426 will identify all files that may have changed since the 427 requested date/time. This information is used to speed up git by 428 avoiding unnecessary processing of files that have not changed. 429 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 430 431core.trustctime:: 432 If false, the ctime differences between the index and the 433 working tree are ignored; useful when the inode change time 434 is regularly modified by something outside Git (file system 435 crawlers and some backup systems). 436 See linkgit:git-update-index[1]. True by default. 437 438core.splitIndex:: 439 If true, the split-index feature of the index will be used. 440 See linkgit:git-update-index[1]. False by default. 441 442core.untrackedCache:: 443 Determines what to do about the untracked cache feature of the 444 index. It will be kept, if this variable is unset or set to 445 `keep`. It will automatically be added if set to `true`. And 446 it will automatically be removed, if set to `false`. Before 447 setting it to `true`, you should check that mtime is working 448 properly on your system. 449 See linkgit:git-update-index[1]. `keep` by default. 450 451core.checkStat:: 452 Determines which stat fields to match between the index 453 and work tree. The user can set this to 'default' or 454 'minimal'. Default (or explicitly 'default'), is to check 455 all fields, including the sub-second part of mtime and ctime. 456 457core.quotePath:: 458 Commands that output paths (e.g. 'ls-files', 'diff'), will 459 quote "unusual" characters in the pathname by enclosing the 460 pathname in double-quotes and escaping those characters with 461 backslashes in the same way C escapes control characters (e.g. 462 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 463 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 464 UTF-8). If this variable is set to false, bytes higher than 465 0x80 are not considered "unusual" any more. Double-quotes, 466 backslash and control characters are always escaped regardless 467 of the setting of this variable. A simple space character is 468 not considered "unusual". Many commands can output pathnames 469 completely verbatim using the `-z` option. The default value 470 is true. 471 472core.eol:: 473 Sets the line ending type to use in the working directory for 474 files that have the `text` property set when core.autocrlf is false. 475 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 476 native line ending. The default value is `native`. See 477 linkgit:gitattributes[5] for more information on end-of-line 478 conversion. 479 480core.safecrlf:: 481 If true, makes Git check if converting `CRLF` is reversible when 482 end-of-line conversion is active. Git will verify if a command 483 modifies a file in the work tree either directly or indirectly. 484 For example, committing a file followed by checking out the 485 same file should yield the original file in the work tree. If 486 this is not the case for the current setting of 487 `core.autocrlf`, Git will reject the file. The variable can 488 be set to "warn", in which case Git will only warn about an 489 irreversible conversion but continue the operation. 490+ 491CRLF conversion bears a slight chance of corrupting data. 492When it is enabled, Git will convert CRLF to LF during commit and LF to 493CRLF during checkout. A file that contains a mixture of LF and 494CRLF before the commit cannot be recreated by Git. For text 495files this is the right thing to do: it corrects line endings 496such that we have only LF line endings in the repository. 497But for binary files that are accidentally classified as text the 498conversion can corrupt data. 499+ 500If you recognize such corruption early you can easily fix it by 501setting the conversion type explicitly in .gitattributes. Right 502after committing you still have the original file in your work 503tree and this file is not yet corrupted. You can explicitly tell 504Git that this file is binary and Git will handle the file 505appropriately. 506+ 507Unfortunately, the desired effect of cleaning up text files with 508mixed line endings and the undesired effect of corrupting binary 509files cannot be distinguished. In both cases CRLFs are removed 510in an irreversible way. For text files this is the right thing 511to do because CRLFs are line endings, while for binary files 512converting CRLFs corrupts data. 513+ 514Note, this safety check does not mean that a checkout will generate a 515file identical to the original file for a different setting of 516`core.eol` and `core.autocrlf`, but only for the current one. For 517example, a text file with `LF` would be accepted with `core.eol=lf` 518and could later be checked out with `core.eol=crlf`, in which case the 519resulting file would contain `CRLF`, although the original file 520contained `LF`. However, in both work trees the line endings would be 521consistent, that is either all `LF` or all `CRLF`, but never mixed. A 522file with mixed line endings would be reported by the `core.safecrlf` 523mechanism. 524 525core.autocrlf:: 526 Setting this variable to "true" is the same as setting 527 the `text` attribute to "auto" on all files and core.eol to "crlf". 528 Set to true if you want to have `CRLF` line endings in your 529 working directory and the repository has LF line endings. 530 This variable can be set to 'input', 531 in which case no output conversion is performed. 532 533core.checkRoundtripEncoding:: 534 A comma and/or whitespace separated list of encodings that Git 535 performs UTF-8 round trip checks on if they are used in an 536 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 537 The default value is `SHIFT-JIS`. 538 539core.symlinks:: 540 If false, symbolic links are checked out as small plain files that 541 contain the link text. linkgit:git-update-index[1] and 542 linkgit:git-add[1] will not change the recorded type to regular 543 file. Useful on filesystems like FAT that do not support 544 symbolic links. 545+ 546The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 547will probe and set core.symlinks false if appropriate when the repository 548is created. 549 550core.gitProxy:: 551 A "proxy command" to execute (as 'command host port') instead 552 of establishing direct connection to the remote server when 553 using the Git protocol for fetching. If the variable value is 554 in the "COMMAND for DOMAIN" format, the command is applied only 555 on hostnames ending with the specified domain string. This variable 556 may be set multiple times and is matched in the given order; 557 the first match wins. 558+ 559Can be overridden by the `GIT_PROXY_COMMAND` environment variable 560(which always applies universally, without the special "for" 561handling). 562+ 563The special string `none` can be used as the proxy command to 564specify that no proxy be used for a given domain pattern. 565This is useful for excluding servers inside a firewall from 566proxy use, while defaulting to a common proxy for external domains. 567 568core.sshCommand:: 569 If this variable is set, `git fetch` and `git push` will 570 use the specified command instead of `ssh` when they need to 571 connect to a remote system. The command is in the same form as 572 the `GIT_SSH_COMMAND` environment variable and is overridden 573 when the environment variable is set. 574 575core.ignoreStat:: 576 If true, Git will avoid using lstat() calls to detect if files have 577 changed by setting the "assume-unchanged" bit for those tracked files 578 which it has updated identically in both the index and working tree. 579+ 580When files are modified outside of Git, the user will need to stage 581the modified files explicitly (e.g. see 'Examples' section in 582linkgit:git-update-index[1]). 583Git will not normally detect changes to those files. 584+ 585This is useful on systems where lstat() calls are very slow, such as 586CIFS/Microsoft Windows. 587+ 588False by default. 589 590core.preferSymlinkRefs:: 591 Instead of the default "symref" format for HEAD 592 and other symbolic reference files, use symbolic links. 593 This is sometimes needed to work with old scripts that 594 expect HEAD to be a symbolic link. 595 596core.bare:: 597 If true this repository is assumed to be 'bare' and has no 598 working directory associated with it. If this is the case a 599 number of commands that require a working directory will be 600 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 601+ 602This setting is automatically guessed by linkgit:git-clone[1] or 603linkgit:git-init[1] when the repository was created. By default a 604repository that ends in "/.git" is assumed to be not bare (bare = 605false), while all other repositories are assumed to be bare (bare 606= true). 607 608core.worktree:: 609 Set the path to the root of the working tree. 610 If `GIT_COMMON_DIR` environment variable is set, core.worktree 611 is ignored and not used for determining the root of working tree. 612 This can be overridden by the `GIT_WORK_TREE` environment 613 variable and the `--work-tree` command-line option. 614 The value can be an absolute path or relative to the path to 615 the .git directory, which is either specified by --git-dir 616 or GIT_DIR, or automatically discovered. 617 If --git-dir or GIT_DIR is specified but none of 618 --work-tree, GIT_WORK_TREE and core.worktree is specified, 619 the current working directory is regarded as the top level 620 of your working tree. 621+ 622Note that this variable is honored even when set in a configuration 623file in a ".git" subdirectory of a directory and its value differs 624from the latter directory (e.g. "/path/to/.git/config" has 625core.worktree set to "/different/path"), which is most likely a 626misconfiguration. Running Git commands in the "/path/to" directory will 627still use "/different/path" as the root of the work tree and can cause 628confusion unless you know what you are doing (e.g. you are creating a 629read-only snapshot of the same index to a location different from the 630repository's usual working tree). 631 632core.logAllRefUpdates:: 633 Enable the reflog. Updates to a ref <ref> is logged to the file 634 "`$GIT_DIR/logs/<ref>`", by appending the new and old 635 SHA-1, the date/time and the reason of the update, but 636 only when the file exists. If this configuration 637 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 638 file is automatically created for branch heads (i.e. under 639 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 640 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 641 If it is set to `always`, then a missing reflog is automatically 642 created for any ref under `refs/`. 643+ 644This information can be used to determine what commit 645was the tip of a branch "2 days ago". 646+ 647This value is true by default in a repository that has 648a working directory associated with it, and false by 649default in a bare repository. 650 651core.repositoryFormatVersion:: 652 Internal variable identifying the repository format and layout 653 version. 654 655core.sharedRepository:: 656 When 'group' (or 'true'), the repository is made shareable between 657 several users in a group (making sure all the files and objects are 658 group-writable). When 'all' (or 'world' or 'everybody'), the 659 repository will be readable by all users, additionally to being 660 group-shareable. When 'umask' (or 'false'), Git will use permissions 661 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 662 files in the repository will have this mode value. '0xxx' will override 663 user's umask value (whereas the other options will only override 664 requested parts of the user's umask value). Examples: '0660' will make 665 the repo read/write-able for the owner and group, but inaccessible to 666 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 667 repository that is group-readable but not group-writable. 668 See linkgit:git-init[1]. False by default. 669 670core.warnAmbiguousRefs:: 671 If true, Git will warn you if the ref name you passed it is ambiguous 672 and might match multiple refs in the repository. True by default. 673 674core.compression:: 675 An integer -1..9, indicating a default compression level. 676 -1 is the zlib default. 0 means no compression, 677 and 1..9 are various speed/size tradeoffs, 9 being slowest. 678 If set, this provides a default to other compression variables, 679 such as `core.looseCompression` and `pack.compression`. 680 681core.looseCompression:: 682 An integer -1..9, indicating the compression level for objects that 683 are not in a pack file. -1 is the zlib default. 0 means no 684 compression, and 1..9 are various speed/size tradeoffs, 9 being 685 slowest. If not set, defaults to core.compression. If that is 686 not set, defaults to 1 (best speed). 687 688core.packedGitWindowSize:: 689 Number of bytes of a pack file to map into memory in a 690 single mapping operation. Larger window sizes may allow 691 your system to process a smaller number of large pack files 692 more quickly. Smaller window sizes will negatively affect 693 performance due to increased calls to the operating system's 694 memory manager, but may improve performance when accessing 695 a large number of large pack files. 696+ 697Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 698MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 699be reasonable for all users/operating systems. You probably do 700not need to adjust this value. 701+ 702Common unit suffixes of 'k', 'm', or 'g' are supported. 703 704core.packedGitLimit:: 705 Maximum number of bytes to map simultaneously into memory 706 from pack files. If Git needs to access more than this many 707 bytes at once to complete an operation it will unmap existing 708 regions to reclaim virtual address space within the process. 709+ 710Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 711unlimited) on 64 bit platforms. 712This should be reasonable for all users/operating systems, except on 713the largest projects. You probably do not need to adjust this value. 714+ 715Common unit suffixes of 'k', 'm', or 'g' are supported. 716 717core.deltaBaseCacheLimit:: 718 Maximum number of bytes to reserve for caching base objects 719 that may be referenced by multiple deltified objects. By storing the 720 entire decompressed base objects in a cache Git is able 721 to avoid unpacking and decompressing frequently used base 722 objects multiple times. 723+ 724Default is 96 MiB on all platforms. This should be reasonable 725for all users/operating systems, except on the largest projects. 726You probably do not need to adjust this value. 727+ 728Common unit suffixes of 'k', 'm', or 'g' are supported. 729 730core.bigFileThreshold:: 731 Files larger than this size are stored deflated, without 732 attempting delta compression. Storing large files without 733 delta compression avoids excessive memory usage, at the 734 slight expense of increased disk usage. Additionally files 735 larger than this size are always treated as binary. 736+ 737Default is 512 MiB on all platforms. This should be reasonable 738for most projects as source code and other text files can still 739be delta compressed, but larger binary media files won't be. 740+ 741Common unit suffixes of 'k', 'm', or 'g' are supported. 742 743core.excludesFile:: 744 Specifies the pathname to the file that contains patterns to 745 describe paths that are not meant to be tracked, in addition 746 to '.gitignore' (per-directory) and '.git/info/exclude'. 747 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 748 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 749 is used instead. See linkgit:gitignore[5]. 750 751core.askPass:: 752 Some commands (e.g. svn and http interfaces) that interactively 753 ask for a password can be told to use an external program given 754 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 755 environment variable. If not set, fall back to the value of the 756 `SSH_ASKPASS` environment variable or, failing that, a simple password 757 prompt. The external program shall be given a suitable prompt as 758 command-line argument and write the password on its STDOUT. 759 760core.attributesFile:: 761 In addition to '.gitattributes' (per-directory) and 762 '.git/info/attributes', Git looks into this file for attributes 763 (see linkgit:gitattributes[5]). Path expansions are made the same 764 way as for `core.excludesFile`. Its default value is 765 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 766 set or empty, `$HOME/.config/git/attributes` is used instead. 767 768core.hooksPath:: 769 By default Git will look for your hooks in the 770 '$GIT_DIR/hooks' directory. Set this to different path, 771 e.g. '/etc/git/hooks', and Git will try to find your hooks in 772 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 773 in '$GIT_DIR/hooks/pre-receive'. 774+ 775The path can be either absolute or relative. A relative path is 776taken as relative to the directory where the hooks are run (see 777the "DESCRIPTION" section of linkgit:githooks[5]). 778+ 779This configuration variable is useful in cases where you'd like to 780centrally configure your Git hooks instead of configuring them on a 781per-repository basis, or as a more flexible and centralized 782alternative to having an `init.templateDir` where you've changed 783default hooks. 784 785core.editor:: 786 Commands such as `commit` and `tag` that let you edit 787 messages by launching an editor use the value of this 788 variable when it is set, and the environment variable 789 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 790 791core.commentChar:: 792 Commands such as `commit` and `tag` that let you edit 793 messages consider a line that begins with this character 794 commented, and removes them after the editor returns 795 (default '#'). 796+ 797If set to "auto", `git-commit` would select a character that is not 798the beginning character of any line in existing commit messages. 799 800core.filesRefLockTimeout:: 801 The length of time, in milliseconds, to retry when trying to 802 lock an individual reference. Value 0 means not to retry at 803 all; -1 means to try indefinitely. Default is 100 (i.e., 804 retry for 100ms). 805 806core.packedRefsTimeout:: 807 The length of time, in milliseconds, to retry when trying to 808 lock the `packed-refs` file. Value 0 means not to retry at 809 all; -1 means to try indefinitely. Default is 1000 (i.e., 810 retry for 1 second). 811 812sequence.editor:: 813 Text editor used by `git rebase -i` for editing the rebase instruction file. 814 The value is meant to be interpreted by the shell when it is used. 815 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 816 When not configured the default commit message editor is used instead. 817 818core.pager:: 819 Text viewer for use by Git commands (e.g., 'less'). The value 820 is meant to be interpreted by the shell. The order of preference 821 is the `$GIT_PAGER` environment variable, then `core.pager` 822 configuration, then `$PAGER`, and then the default chosen at 823 compile time (usually 'less'). 824+ 825When the `LESS` environment variable is unset, Git sets it to `FRX` 826(if `LESS` environment variable is set, Git does not change it at 827all). If you want to selectively override Git's default setting 828for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 829be passed to the shell by Git, which will translate the final 830command to `LESS=FRX less -S`. The environment does not set the 831`S` option but the command line does, instructing less to truncate 832long lines. Similarly, setting `core.pager` to `less -+F` will 833deactivate the `F` option specified by the environment from the 834command-line, deactivating the "quit if one screen" behavior of 835`less`. One can specifically activate some flags for particular 836commands: for example, setting `pager.blame` to `less -S` enables 837line truncation only for `git blame`. 838+ 839Likewise, when the `LV` environment variable is unset, Git sets it 840to `-c`. You can override this setting by exporting `LV` with 841another value or setting `core.pager` to `lv +c`. 842 843core.whitespace:: 844 A comma separated list of common whitespace problems to 845 notice. 'git diff' will use `color.diff.whitespace` to 846 highlight them, and 'git apply --whitespace=error' will 847 consider them as errors. You can prefix `-` to disable 848 any of them (e.g. `-trailing-space`): 849+ 850* `blank-at-eol` treats trailing whitespaces at the end of the line 851 as an error (enabled by default). 852* `space-before-tab` treats a space character that appears immediately 853 before a tab character in the initial indent part of the line as an 854 error (enabled by default). 855* `indent-with-non-tab` treats a line that is indented with space 856 characters instead of the equivalent tabs as an error (not enabled by 857 default). 858* `tab-in-indent` treats a tab character in the initial indent part of 859 the line as an error (not enabled by default). 860* `blank-at-eof` treats blank lines added at the end of file as an error 861 (enabled by default). 862* `trailing-space` is a short-hand to cover both `blank-at-eol` and 863 `blank-at-eof`. 864* `cr-at-eol` treats a carriage-return at the end of line as 865 part of the line terminator, i.e. with it, `trailing-space` 866 does not trigger if the character before such a carriage-return 867 is not a whitespace (not enabled by default). 868* `tabwidth=<n>` tells how many character positions a tab occupies; this 869 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 870 errors. The default tab width is 8. Allowed values are 1 to 63. 871 872core.fsyncObjectFiles:: 873 This boolean will enable 'fsync()' when writing object files. 874+ 875This is a total waste of time and effort on a filesystem that orders 876data writes properly, but can be useful for filesystems that do not use 877journalling (traditional UNIX filesystems) or that only journal metadata 878and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 879 880core.preloadIndex:: 881 Enable parallel index preload for operations like 'git diff' 882+ 883This can speed up operations like 'git diff' and 'git status' especially 884on filesystems like NFS that have weak caching semantics and thus 885relatively high IO latencies. When enabled, Git will do the 886index comparison to the filesystem data in parallel, allowing 887overlapping IO's. Defaults to true. 888 889core.createObject:: 890 You can set this to 'link', in which case a hardlink followed by 891 a delete of the source are used to make sure that object creation 892 will not overwrite existing objects. 893+ 894On some file system/operating system combinations, this is unreliable. 895Set this config setting to 'rename' there; However, This will remove the 896check that makes sure that existing object files will not get overwritten. 897 898core.notesRef:: 899 When showing commit messages, also show notes which are stored in 900 the given ref. The ref must be fully qualified. If the given 901 ref does not exist, it is not an error but means that no 902 notes should be printed. 903+ 904This setting defaults to "refs/notes/commits", and it can be overridden by 905the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 906 907core.commitGraph:: 908 Enable git commit graph feature. Allows reading from the 909 commit-graph file. 910 911core.sparseCheckout:: 912 Enable "sparse checkout" feature. See section "Sparse checkout" in 913 linkgit:git-read-tree[1] for more information. 914 915core.abbrev:: 916 Set the length object names are abbreviated to. If 917 unspecified or set to "auto", an appropriate value is 918 computed based on the approximate number of packed objects 919 in your repository, which hopefully is enough for 920 abbreviated object names to stay unique for some time. 921 The minimum length is 4. 922 923add.ignoreErrors:: 924add.ignore-errors (deprecated):: 925 Tells 'git add' to continue adding files when some files cannot be 926 added due to indexing errors. Equivalent to the `--ignore-errors` 927 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 928 as it does not follow the usual naming convention for configuration 929 variables. 930 931alias.*:: 932 Command aliases for the linkgit:git[1] command wrapper - e.g. 933 after defining "alias.last = cat-file commit HEAD", the invocation 934 "git last" is equivalent to "git cat-file commit HEAD". To avoid 935 confusion and troubles with script usage, aliases that 936 hide existing Git commands are ignored. Arguments are split by 937 spaces, the usual shell quoting and escaping is supported. 938 A quote pair or a backslash can be used to quote them. 939+ 940If the alias expansion is prefixed with an exclamation point, 941it will be treated as a shell command. For example, defining 942"alias.new = !gitk --all --not ORIG_HEAD", the invocation 943"git new" is equivalent to running the shell command 944"gitk --all --not ORIG_HEAD". Note that shell commands will be 945executed from the top-level directory of a repository, which may 946not necessarily be the current directory. 947`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 948from the original current directory. See linkgit:git-rev-parse[1]. 949 950am.keepcr:: 951 If true, git-am will call git-mailsplit for patches in mbox format 952 with parameter `--keep-cr`. In this case git-mailsplit will 953 not remove `\r` from lines ending with `\r\n`. Can be overridden 954 by giving `--no-keep-cr` from the command line. 955 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 956 957am.threeWay:: 958 By default, `git am` will fail if the patch does not apply cleanly. When 959 set to true, this setting tells `git am` to fall back on 3-way merge if 960 the patch records the identity of blobs it is supposed to apply to and 961 we have those blobs available locally (equivalent to giving the `--3way` 962 option from the command line). Defaults to `false`. 963 See linkgit:git-am[1]. 964 965apply.ignoreWhitespace:: 966 When set to 'change', tells 'git apply' to ignore changes in 967 whitespace, in the same way as the `--ignore-space-change` 968 option. 969 When set to one of: no, none, never, false tells 'git apply' to 970 respect all whitespace differences. 971 See linkgit:git-apply[1]. 972 973apply.whitespace:: 974 Tells 'git apply' how to handle whitespaces, in the same way 975 as the `--whitespace` option. See linkgit:git-apply[1]. 976 977blame.showRoot:: 978 Do not treat root commits as boundaries in linkgit:git-blame[1]. 979 This option defaults to false. 980 981blame.blankBoundary:: 982 Show blank commit object name for boundary commits in 983 linkgit:git-blame[1]. This option defaults to false. 984 985blame.showEmail:: 986 Show the author email instead of author name in linkgit:git-blame[1]. 987 This option defaults to false. 988 989blame.date:: 990 Specifies the format used to output dates in linkgit:git-blame[1]. 991 If unset the iso format is used. For supported values, 992 see the discussion of the `--date` option at linkgit:git-log[1]. 993 994branch.autoSetupMerge:: 995 Tells 'git branch' and 'git checkout' to set up new branches 996 so that linkgit:git-pull[1] will appropriately merge from the 997 starting point branch. Note that even if this option is not set, 998 this behavior can be chosen per-branch using the `--track` 999 and `--no-track` options. The valid settings are: `false` -- no1000 automatic setup is done; `true` -- automatic setup is done when the1001 starting point is a remote-tracking branch; `always` --1002 automatic setup is done when the starting point is either a1003 local branch or remote-tracking1004 branch. This option defaults to true.10051006branch.autoSetupRebase::1007 When a new branch is created with 'git branch' or 'git checkout'1008 that tracks another branch, this variable tells Git to set1009 up pull to rebase instead of merge (see "branch.<name>.rebase").1010 When `never`, rebase is never automatically set to true.1011 When `local`, rebase is set to true for tracked branches of1012 other local branches.1013 When `remote`, rebase is set to true for tracked branches of1014 remote-tracking branches.1015 When `always`, rebase will be set to true for all tracking1016 branches.1017 See "branch.autoSetupMerge" for details on how to set up a1018 branch to track another branch.1019 This option defaults to never.10201021branch.<name>.remote::1022 When on branch <name>, it tells 'git fetch' and 'git push'1023 which remote to fetch from/push to. The remote to push to1024 may be overridden with `remote.pushDefault` (for all branches).1025 The remote to push to, for the current branch, may be further1026 overridden by `branch.<name>.pushRemote`. If no remote is1027 configured, or if you are not on any branch, it defaults to1028 `origin` for fetching and `remote.pushDefault` for pushing.1029 Additionally, `.` (a period) is the current local repository1030 (a dot-repository), see `branch.<name>.merge`'s final note below.10311032branch.<name>.pushRemote::1033 When on branch <name>, it overrides `branch.<name>.remote` for1034 pushing. It also overrides `remote.pushDefault` for pushing1035 from branch <name>. When you pull from one place (e.g. your1036 upstream) and push to another place (e.g. your own publishing1037 repository), you would want to set `remote.pushDefault` to1038 specify the remote to push to for all branches, and use this1039 option to override it for a specific branch.10401041branch.<name>.merge::1042 Defines, together with branch.<name>.remote, the upstream branch1043 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1044 branch to merge and can also affect 'git push' (see push.default).1045 When in branch <name>, it tells 'git fetch' the default1046 refspec to be marked for merging in FETCH_HEAD. The value is1047 handled like the remote part of a refspec, and must match a1048 ref which is fetched from the remote given by1049 "branch.<name>.remote".1050 The merge information is used by 'git pull' (which at first calls1051 'git fetch') to lookup the default branch for merging. Without1052 this option, 'git pull' defaults to merge the first refspec fetched.1053 Specify multiple values to get an octopus merge.1054 If you wish to setup 'git pull' so that it merges into <name> from1055 another branch in the local repository, you can point1056 branch.<name>.merge to the desired branch, and use the relative path1057 setting `.` (a period) for branch.<name>.remote.10581059branch.<name>.mergeOptions::1060 Sets default options for merging into branch <name>. The syntax and1061 supported options are the same as those of linkgit:git-merge[1], but1062 option values containing whitespace characters are currently not1063 supported.10641065branch.<name>.rebase::1066 When true, rebase the branch <name> on top of the fetched branch,1067 instead of merging the default branch from the default remote when1068 "git pull" is run. See "pull.rebase" for doing this in a non1069 branch-specific manner.1070+1071When `merges`, pass the `--rebase-merges` option to 'git rebase'1072so that the local merge commits are included in the rebase (see1073linkgit:git-rebase[1] for details).1074+1075When preserve, also pass `--preserve-merges` along to 'git rebase'1076so that locally committed merge commits will not be flattened1077by running 'git pull'.1078+1079When the value is `interactive`, the rebase is run in interactive mode.1080+1081*NOTE*: this is a possibly dangerous operation; do *not* use1082it unless you understand the implications (see linkgit:git-rebase[1]1083for details).10841085branch.<name>.description::1086 Branch description, can be edited with1087 `git branch --edit-description`. Branch description is1088 automatically added in the format-patch cover letter or1089 request-pull summary.10901091browser.<tool>.cmd::1092 Specify the command to invoke the specified browser. The1093 specified command is evaluated in shell with the URLs passed1094 as arguments. (See linkgit:git-web{litdd}browse[1].)10951096browser.<tool>.path::1097 Override the path for the given tool that may be used to1098 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1099 working repository in gitweb (see linkgit:git-instaweb[1]).11001101clean.requireForce::1102 A boolean to make git-clean do nothing unless given -f,1103 -i or -n. Defaults to true.11041105color.advice::1106 A boolean to enable/disable color in hints (e.g. when a push1107 failed, see `advice.*` for a list). May be set to `always`,1108 `false` (or `never`) or `auto` (or `true`), in which case colors1109 are used only when the error output goes to a terminal. If1110 unset, then the value of `color.ui` is used (`auto` by default).11111112color.advice.hint::1113 Use customized color for hints.11141115color.branch::1116 A boolean to enable/disable color in the output of1117 linkgit:git-branch[1]. May be set to `always`,1118 `false` (or `never`) or `auto` (or `true`), in which case colors are used1119 only when the output is to a terminal. If unset, then the1120 value of `color.ui` is used (`auto` by default).11211122color.branch.<slot>::1123 Use customized color for branch coloration. `<slot>` is one of1124 `current` (the current branch), `local` (a local branch),1125 `remote` (a remote-tracking branch in refs/remotes/),1126 `upstream` (upstream tracking branch), `plain` (other1127 refs).11281129color.diff::1130 Whether to use ANSI escape sequences to add color to patches.1131 If this is set to `always`, linkgit:git-diff[1],1132 linkgit:git-log[1], and linkgit:git-show[1] will use color1133 for all patches. If it is set to `true` or `auto`, those1134 commands will only use color when output is to the terminal.1135 If unset, then the value of `color.ui` is used (`auto` by1136 default).1137+1138This does not affect linkgit:git-format-patch[1] or the1139'git-diff-{asterisk}' plumbing commands. Can be overridden on the1140command line with the `--color[=<when>]` option.11411142diff.colorMoved::1143 If set to either a valid `<mode>` or a true value, moved lines1144 in a diff are colored differently, for details of valid modes1145 see '--color-moved' in linkgit:git-diff[1]. If simply set to1146 true the default color mode will be used. When set to false,1147 moved lines are not colored.11481149color.diff.<slot>::1150 Use customized color for diff colorization. `<slot>` specifies1151 which part of the patch to use the specified color, and is one1152 of `context` (context text - `plain` is a historical synonym),1153 `meta` (metainformation), `frag`1154 (hunk header), 'func' (function in hunk header), `old` (removed lines),1155 `new` (added lines), `commit` (commit headers), `whitespace`1156 (highlighting whitespace errors), `oldMoved` (deleted lines),1157 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1158 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1159 and `newMovedAlternativeDimmed` (See the '<mode>'1160 setting of '--color-moved' in linkgit:git-diff[1] for details).11611162color.decorate.<slot>::1163 Use customized color for 'git log --decorate' output. `<slot>` is one1164 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1165 branches, remote-tracking branches, tags, stash and HEAD, respectively.11661167color.grep::1168 When set to `always`, always highlight matches. When `false` (or1169 `never`), never. When set to `true` or `auto`, use color only1170 when the output is written to the terminal. If unset, then the1171 value of `color.ui` is used (`auto` by default).11721173color.grep.<slot>::1174 Use customized color for grep colorization. `<slot>` specifies which1175 part of the line to use the specified color, and is one of1176+1177--1178`context`;;1179 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1180`filename`;;1181 filename prefix (when not using `-h`)1182`function`;;1183 function name lines (when using `-p`)1184`linenumber`;;1185 line number prefix (when using `-n`)1186`match`;;1187 matching text (same as setting `matchContext` and `matchSelected`)1188`matchContext`;;1189 matching text in context lines1190`matchSelected`;;1191 matching text in selected lines1192`selected`;;1193 non-matching text in selected lines1194`separator`;;1195 separators between fields on a line (`:`, `-`, and `=`)1196 and between hunks (`--`)1197--11981199color.interactive::1200 When set to `always`, always use colors for interactive prompts1201 and displays (such as those used by "git-add --interactive" and1202 "git-clean --interactive"). When false (or `never`), never.1203 When set to `true` or `auto`, use colors only when the output is1204 to the terminal. If unset, then the value of `color.ui` is1205 used (`auto` by default).12061207color.interactive.<slot>::1208 Use customized color for 'git add --interactive' and 'git clean1209 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1210 or `error`, for four distinct types of normal output from1211 interactive commands.12121213color.pager::1214 A boolean to enable/disable colored output when the pager is in1215 use (default is true).12161217color.push::1218 A boolean to enable/disable color in push errors. May be set to1219 `always`, `false` (or `never`) or `auto` (or `true`), in which1220 case colors are used only when the error output goes to a terminal.1221 If unset, then the value of `color.ui` is used (`auto` by default).12221223color.push.error::1224 Use customized color for push errors.12251226color.showBranch::1227 A boolean to enable/disable color in the output of1228 linkgit:git-show-branch[1]. May be set to `always`,1229 `false` (or `never`) or `auto` (or `true`), in which case colors are used1230 only when the output is to a terminal. If unset, then the1231 value of `color.ui` is used (`auto` by default).12321233color.status::1234 A boolean to enable/disable color in the output of1235 linkgit:git-status[1]. May be set to `always`,1236 `false` (or `never`) or `auto` (or `true`), in which case colors are used1237 only when the output is to a terminal. If unset, then the1238 value of `color.ui` is used (`auto` by default).12391240color.status.<slot>::1241 Use customized color for status colorization. `<slot>` is1242 one of `header` (the header text of the status message),1243 `added` or `updated` (files which are added but not committed),1244 `changed` (files which are changed but not added in the index),1245 `untracked` (files which are not tracked by Git),1246 `branch` (the current branch),1247 `nobranch` (the color the 'no branch' warning is shown in, defaulting1248 to red),1249 `localBranch` or `remoteBranch` (the local and remote branch names,1250 respectively, when branch and tracking information is displayed in the1251 status short-format), or1252 `unmerged` (files which have unmerged changes).12531254color.transport::1255 A boolean to enable/disable color when pushes are rejected. May be1256 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1257 case colors are used only when the error output goes to a terminal.1258 If unset, then the value of `color.ui` is used (`auto` by default).12591260color.transport.rejected::1261 Use customized color when a push was rejected.12621263color.ui::1264 This variable determines the default value for variables such1265 as `color.diff` and `color.grep` that control the use of color1266 per command family. Its scope will expand as more commands learn1267 configuration to set a default for the `--color` option. Set it1268 to `false` or `never` if you prefer Git commands not to use1269 color unless enabled explicitly with some other configuration1270 or the `--color` option. Set it to `always` if you want all1271 output not intended for machine consumption to use color, to1272 `true` or `auto` (this is the default since Git 1.8.4) if you1273 want such output to use color when written to the terminal.12741275column.ui::1276 Specify whether supported commands should output in columns.1277 This variable consists of a list of tokens separated by spaces1278 or commas:1279+1280These options control when the feature should be enabled1281(defaults to 'never'):1282+1283--1284`always`;;1285 always show in columns1286`never`;;1287 never show in columns1288`auto`;;1289 show in columns if the output is to the terminal1290--1291+1292These options control layout (defaults to 'column'). Setting any1293of these implies 'always' if none of 'always', 'never', or 'auto' are1294specified.1295+1296--1297`column`;;1298 fill columns before rows1299`row`;;1300 fill rows before columns1301`plain`;;1302 show in one column1303--1304+1305Finally, these options can be combined with a layout option (defaults1306to 'nodense'):1307+1308--1309`dense`;;1310 make unequal size columns to utilize more space1311`nodense`;;1312 make equal size columns1313--13141315column.branch::1316 Specify whether to output branch listing in `git branch` in columns.1317 See `column.ui` for details.13181319column.clean::1320 Specify the layout when list items in `git clean -i`, which always1321 shows files and directories in columns. See `column.ui` for details.13221323column.status::1324 Specify whether to output untracked files in `git status` in columns.1325 See `column.ui` for details.13261327column.tag::1328 Specify whether to output tag listing in `git tag` in columns.1329 See `column.ui` for details.13301331commit.cleanup::1332 This setting overrides the default of the `--cleanup` option in1333 `git commit`. See linkgit:git-commit[1] for details. Changing the1334 default can be useful when you always want to keep lines that begin1335 with comment character `#` in your log message, in which case you1336 would do `git config commit.cleanup whitespace` (note that you will1337 have to remove the help lines that begin with `#` in the commit log1338 template yourself, if you do this).13391340commit.gpgSign::13411342 A boolean to specify whether all commits should be GPG signed.1343 Use of this option when doing operations such as rebase can1344 result in a large number of commits being signed. It may be1345 convenient to use an agent to avoid typing your GPG passphrase1346 several times.13471348commit.status::1349 A boolean to enable/disable inclusion of status information in the1350 commit message template when using an editor to prepare the commit1351 message. Defaults to true.13521353commit.template::1354 Specify the pathname of a file to use as the template for1355 new commit messages.13561357commit.verbose::1358 A boolean or int to specify the level of verbose with `git commit`.1359 See linkgit:git-commit[1].13601361credential.helper::1362 Specify an external helper to be called when a username or1363 password credential is needed; the helper may consult external1364 storage to avoid prompting the user for the credentials. Note1365 that multiple helpers may be defined. See linkgit:gitcredentials[7]1366 for details.13671368credential.useHttpPath::1369 When acquiring credentials, consider the "path" component of an http1370 or https URL to be important. Defaults to false. See1371 linkgit:gitcredentials[7] for more information.13721373credential.username::1374 If no username is set for a network authentication, use this username1375 by default. See credential.<context>.* below, and1376 linkgit:gitcredentials[7].13771378credential.<url>.*::1379 Any of the credential.* options above can be applied selectively to1380 some credentials. For example "credential.https://example.com.username"1381 would set the default username only for https connections to1382 example.com. See linkgit:gitcredentials[7] for details on how URLs are1383 matched.13841385credentialCache.ignoreSIGHUP::1386 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13871388include::diff-config.txt[]13891390difftool.<tool>.path::1391 Override the path for the given tool. This is useful in case1392 your tool is not in the PATH.13931394difftool.<tool>.cmd::1395 Specify the command to invoke the specified diff tool.1396 The specified command is evaluated in shell with the following1397 variables available: 'LOCAL' is set to the name of the temporary1398 file containing the contents of the diff pre-image and 'REMOTE'1399 is set to the name of the temporary file containing the contents1400 of the diff post-image.14011402difftool.prompt::1403 Prompt before each invocation of the diff tool.14041405fastimport.unpackLimit::1406 If the number of objects imported by linkgit:git-fast-import[1]1407 is below this limit, then the objects will be unpacked into1408 loose object files. However if the number of imported objects1409 equals or exceeds this limit then the pack will be stored as a1410 pack. Storing the pack from a fast-import can make the import1411 operation complete faster, especially on slow filesystems. If1412 not set, the value of `transfer.unpackLimit` is used instead.14131414fetch.recurseSubmodules::1415 This option can be either set to a boolean value or to 'on-demand'.1416 Setting it to a boolean changes the behavior of fetch and pull to1417 unconditionally recurse into submodules when set to true or to not1418 recurse at all when set to false. When set to 'on-demand' (the default1419 value), fetch and pull will only recurse into a populated submodule1420 when its superproject retrieves a commit that updates the submodule's1421 reference.14221423fetch.fsckObjects::1424 If it is set to true, git-fetch-pack will check all fetched1425 objects. It will abort in the case of a malformed object or a1426 broken link. The result of an abort are only dangling objects.1427 Defaults to false. If not set, the value of `transfer.fsckObjects`1428 is used instead.14291430fetch.unpackLimit::1431 If the number of objects fetched over the Git native1432 transfer is below this1433 limit, then the objects will be unpacked into loose object1434 files. However if the number of received objects equals or1435 exceeds this limit then the received pack will be stored as1436 a pack, after adding any missing delta bases. Storing the1437 pack from a push can make the push operation complete faster,1438 especially on slow filesystems. If not set, the value of1439 `transfer.unpackLimit` is used instead.14401441fetch.prune::1442 If true, fetch will automatically behave as if the `--prune`1443 option was given on the command line. See also `remote.<name>.prune`1444 and the PRUNING section of linkgit:git-fetch[1].14451446fetch.pruneTags::1447 If true, fetch will automatically behave as if the1448 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1449 if not set already. This allows for setting both this option1450 and `fetch.prune` to maintain a 1=1 mapping to upstream1451 refs. See also `remote.<name>.pruneTags` and the PRUNING1452 section of linkgit:git-fetch[1].14531454fetch.output::1455 Control how ref update status is printed. Valid values are1456 `full` and `compact`. Default value is `full`. See section1457 OUTPUT in linkgit:git-fetch[1] for detail.14581459format.attach::1460 Enable multipart/mixed attachments as the default for1461 'format-patch'. The value can also be a double quoted string1462 which will enable attachments as the default and set the1463 value as the boundary. See the --attach option in1464 linkgit:git-format-patch[1].14651466format.from::1467 Provides the default value for the `--from` option to format-patch.1468 Accepts a boolean value, or a name and email address. If false,1469 format-patch defaults to `--no-from`, using commit authors directly in1470 the "From:" field of patch mails. If true, format-patch defaults to1471 `--from`, using your committer identity in the "From:" field of patch1472 mails and including a "From:" field in the body of the patch mail if1473 different. If set to a non-boolean value, format-patch uses that1474 value instead of your committer identity. Defaults to false.14751476format.numbered::1477 A boolean which can enable or disable sequence numbers in patch1478 subjects. It defaults to "auto" which enables it only if there1479 is more than one patch. It can be enabled or disabled for all1480 messages by setting it to "true" or "false". See --numbered1481 option in linkgit:git-format-patch[1].14821483format.headers::1484 Additional email headers to include in a patch to be submitted1485 by mail. See linkgit:git-format-patch[1].14861487format.to::1488format.cc::1489 Additional recipients to include in a patch to be submitted1490 by mail. See the --to and --cc options in1491 linkgit:git-format-patch[1].14921493format.subjectPrefix::1494 The default for format-patch is to output files with the '[PATCH]'1495 subject prefix. Use this variable to change that prefix.14961497format.signature::1498 The default for format-patch is to output a signature containing1499 the Git version number. Use this variable to change that default.1500 Set this variable to the empty string ("") to suppress1501 signature generation.15021503format.signatureFile::1504 Works just like format.signature except the contents of the1505 file specified by this variable will be used as the signature.15061507format.suffix::1508 The default for format-patch is to output files with the suffix1509 `.patch`. Use this variable to change that suffix (make sure to1510 include the dot if you want it).15111512format.pretty::1513 The default pretty format for log/show/whatchanged command,1514 See linkgit:git-log[1], linkgit:git-show[1],1515 linkgit:git-whatchanged[1].15161517format.thread::1518 The default threading style for 'git format-patch'. Can be1519 a boolean value, or `shallow` or `deep`. `shallow` threading1520 makes every mail a reply to the head of the series,1521 where the head is chosen from the cover letter, the1522 `--in-reply-to`, and the first patch mail, in this order.1523 `deep` threading makes every mail a reply to the previous one.1524 A true boolean value is the same as `shallow`, and a false1525 value disables threading.15261527format.signOff::1528 A boolean value which lets you enable the `-s/--signoff` option of1529 format-patch by default. *Note:* Adding the Signed-off-by: line to a1530 patch should be a conscious act and means that you certify you have1531 the rights to submit this work under the same open source license.1532 Please see the 'SubmittingPatches' document for further discussion.15331534format.coverLetter::1535 A boolean that controls whether to generate a cover-letter when1536 format-patch is invoked, but in addition can be set to "auto", to1537 generate a cover-letter only when there's more than one patch.15381539format.outputDirectory::1540 Set a custom directory to store the resulting files instead of the1541 current working directory.15421543format.useAutoBase::1544 A boolean value which lets you enable the `--base=auto` option of1545 format-patch by default.15461547filter.<driver>.clean::1548 The command which is used to convert the content of a worktree1549 file to a blob upon checkin. See linkgit:gitattributes[5] for1550 details.15511552filter.<driver>.smudge::1553 The command which is used to convert the content of a blob1554 object to a worktree file upon checkout. See1555 linkgit:gitattributes[5] for details.15561557fsck.<msg-id>::1558 Allows overriding the message type (error, warn or ignore) of a1559 specific message ID such as `missingEmail`.1560+1561For convenience, fsck prefixes the error/warning with the message ID,1562e.g. "missingEmail: invalid author/committer line - missing email" means1563that setting `fsck.missingEmail = ignore` will hide that issue.1564+1565This feature is intended to support working with legacy repositories1566which cannot be repaired without disruptive changes.15671568fsck.skipList::1569 The path to a sorted list of object names (i.e. one SHA-1 per1570 line) that are known to be broken in a non-fatal way and should1571 be ignored. This feature is useful when an established project1572 should be accepted despite early commits containing errors that1573 can be safely ignored such as invalid committer email addresses.1574 Note: corrupt objects cannot be skipped with this setting.15751576gc.aggressiveDepth::1577 The depth parameter used in the delta compression1578 algorithm used by 'git gc --aggressive'. This defaults1579 to 50.15801581gc.aggressiveWindow::1582 The window size parameter used in the delta compression1583 algorithm used by 'git gc --aggressive'. This defaults1584 to 250.15851586gc.auto::1587 When there are approximately more than this many loose1588 objects in the repository, `git gc --auto` will pack them.1589 Some Porcelain commands use this command to perform a1590 light-weight garbage collection from time to time. The1591 default value is 6700. Setting this to 0 disables it.15921593gc.autoPackLimit::1594 When there are more than this many packs that are not1595 marked with `*.keep` file in the repository, `git gc1596 --auto` consolidates them into one larger pack. The1597 default value is 50. Setting this to 0 disables it.15981599gc.autoDetach::1600 Make `git gc --auto` return immediately and run in background1601 if the system supports it. Default is true.16021603gc.bigPackThreshold::1604 If non-zero, all packs larger than this limit are kept when1605 `git gc` is run. This is very similar to `--keep-base-pack`1606 except that all packs that meet the threshold are kept, not1607 just the base pack. Defaults to zero. Common unit suffixes of1608 'k', 'm', or 'g' are supported.1609+1610Note that if the number of kept packs is more than gc.autoPackLimit,1611this configuration variable is ignored, all packs except the base pack1612will be repacked. After this the number of packs should go below1613gc.autoPackLimit and gc.bigPackThreshold should be respected again.16141615gc.logExpiry::1616 If the file gc.log exists, then `git gc --auto` won't run1617 unless that file is more than 'gc.logExpiry' old. Default is1618 "1.day". See `gc.pruneExpire` for more ways to specify its1619 value.16201621gc.packRefs::1622 Running `git pack-refs` in a repository renders it1623 unclonable by Git versions prior to 1.5.1.2 over dumb1624 transports such as HTTP. This variable determines whether1625 'git gc' runs `git pack-refs`. This can be set to `notbare`1626 to enable it within all non-bare repos or it can be set to a1627 boolean value. The default is `true`.16281629gc.pruneExpire::1630 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1631 Override the grace period with this config variable. The value1632 "now" may be used to disable this grace period and always prune1633 unreachable objects immediately, or "never" may be used to1634 suppress pruning. This feature helps prevent corruption when1635 'git gc' runs concurrently with another process writing to the1636 repository; see the "NOTES" section of linkgit:git-gc[1].16371638gc.worktreePruneExpire::1639 When 'git gc' is run, it calls1640 'git worktree prune --expire 3.months.ago'.1641 This config variable can be used to set a different grace1642 period. The value "now" may be used to disable the grace1643 period and prune `$GIT_DIR/worktrees` immediately, or "never"1644 may be used to suppress pruning.16451646gc.reflogExpire::1647gc.<pattern>.reflogExpire::1648 'git reflog expire' removes reflog entries older than1649 this time; defaults to 90 days. The value "now" expires all1650 entries immediately, and "never" suppresses expiration1651 altogether. With "<pattern>" (e.g.1652 "refs/stash") in the middle the setting applies only to1653 the refs that match the <pattern>.16541655gc.reflogExpireUnreachable::1656gc.<pattern>.reflogExpireUnreachable::1657 'git reflog expire' removes reflog entries older than1658 this time and are not reachable from the current tip;1659 defaults to 30 days. The value "now" expires all entries1660 immediately, and "never" suppresses expiration altogether.1661 With "<pattern>" (e.g. "refs/stash")1662 in the middle, the setting applies only to the refs that1663 match the <pattern>.16641665gc.rerereResolved::1666 Records of conflicted merge you resolved earlier are1667 kept for this many days when 'git rerere gc' is run.1668 You can also use more human-readable "1.month.ago", etc.1669 The default is 60 days. See linkgit:git-rerere[1].16701671gc.rerereUnresolved::1672 Records of conflicted merge you have not resolved are1673 kept for this many days when 'git rerere gc' is run.1674 You can also use more human-readable "1.month.ago", etc.1675 The default is 15 days. See linkgit:git-rerere[1].16761677gitcvs.commitMsgAnnotation::1678 Append this string to each commit message. Set to empty string1679 to disable this feature. Defaults to "via git-CVS emulator".16801681gitcvs.enabled::1682 Whether the CVS server interface is enabled for this repository.1683 See linkgit:git-cvsserver[1].16841685gitcvs.logFile::1686 Path to a log file where the CVS server interface well... logs1687 various stuff. See linkgit:git-cvsserver[1].16881689gitcvs.usecrlfattr::1690 If true, the server will look up the end-of-line conversion1691 attributes for files to determine the `-k` modes to use. If1692 the attributes force Git to treat a file as text,1693 the `-k` mode will be left blank so CVS clients will1694 treat it as text. If they suppress text conversion, the file1695 will be set with '-kb' mode, which suppresses any newline munging1696 the client might otherwise do. If the attributes do not allow1697 the file type to be determined, then `gitcvs.allBinary` is1698 used. See linkgit:gitattributes[5].16991700gitcvs.allBinary::1701 This is used if `gitcvs.usecrlfattr` does not resolve1702 the correct '-kb' mode to use. If true, all1703 unresolved files are sent to the client in1704 mode '-kb'. This causes the client to treat them1705 as binary files, which suppresses any newline munging it1706 otherwise might do. Alternatively, if it is set to "guess",1707 then the contents of the file are examined to decide if1708 it is binary, similar to `core.autocrlf`.17091710gitcvs.dbName::1711 Database used by git-cvsserver to cache revision information1712 derived from the Git repository. The exact meaning depends on the1713 used database driver, for SQLite (which is the default driver) this1714 is a filename. Supports variable substitution (see1715 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1716 Default: '%Ggitcvs.%m.sqlite'17171718gitcvs.dbDriver::1719 Used Perl DBI driver. You can specify any available driver1720 for this here, but it might not work. git-cvsserver is tested1721 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1722 reported *not* to work with 'DBD::mysql'. Experimental feature.1723 May not contain double colons (`:`). Default: 'SQLite'.1724 See linkgit:git-cvsserver[1].17251726gitcvs.dbUser, gitcvs.dbPass::1727 Database user and password. Only useful if setting `gitcvs.dbDriver`,1728 since SQLite has no concept of database users and/or passwords.1729 'gitcvs.dbUser' supports variable substitution (see1730 linkgit:git-cvsserver[1] for details).17311732gitcvs.dbTableNamePrefix::1733 Database table name prefix. Prepended to the names of any1734 database tables used, allowing a single database to be used1735 for several repositories. Supports variable substitution (see1736 linkgit:git-cvsserver[1] for details). Any non-alphabetic1737 characters will be replaced with underscores.17381739All gitcvs variables except for `gitcvs.usecrlfattr` and1740`gitcvs.allBinary` can also be specified as1741'gitcvs.<access_method>.<varname>' (where 'access_method'1742is one of "ext" and "pserver") to make them apply only for the given1743access method.17441745gitweb.category::1746gitweb.description::1747gitweb.owner::1748gitweb.url::1749 See linkgit:gitweb[1] for description.17501751gitweb.avatar::1752gitweb.blame::1753gitweb.grep::1754gitweb.highlight::1755gitweb.patches::1756gitweb.pickaxe::1757gitweb.remote_heads::1758gitweb.showSizes::1759gitweb.snapshot::1760 See linkgit:gitweb.conf[5] for description.17611762grep.lineNumber::1763 If set to true, enable `-n` option by default.17641765grep.patternType::1766 Set the default matching behavior. Using a value of 'basic', 'extended',1767 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1768 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1769 value 'default' will return to the default matching behavior.17701771grep.extendedRegexp::1772 If set to true, enable `--extended-regexp` option by default. This1773 option is ignored when the `grep.patternType` option is set to a value1774 other than 'default'.17751776grep.threads::1777 Number of grep worker threads to use.1778 See `grep.threads` in linkgit:git-grep[1] for more information.17791780grep.fallbackToNoIndex::1781 If set to true, fall back to git grep --no-index if git grep1782 is executed outside of a git repository. Defaults to false.17831784gpg.program::1785 Use this custom program instead of "`gpg`" found on `$PATH` when1786 making or verifying a PGP signature. The program must support the1787 same command-line interface as GPG, namely, to verify a detached1788 signature, "`gpg --verify $file - <$signature`" is run, and the1789 program is expected to signal a good signature by exiting with1790 code 0, and to generate an ASCII-armored detached signature, the1791 standard input of "`gpg -bsau $key`" is fed with the contents to be1792 signed, and the program is expected to send the result to its1793 standard output.17941795gui.commitMsgWidth::1796 Defines how wide the commit message window is in the1797 linkgit:git-gui[1]. "75" is the default.17981799gui.diffContext::1800 Specifies how many context lines should be used in calls to diff1801 made by the linkgit:git-gui[1]. The default is "5".18021803gui.displayUntracked::1804 Determines if linkgit:git-gui[1] shows untracked files1805 in the file list. The default is "true".18061807gui.encoding::1808 Specifies the default encoding to use for displaying of1809 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1810 It can be overridden by setting the 'encoding' attribute1811 for relevant files (see linkgit:gitattributes[5]).1812 If this option is not set, the tools default to the1813 locale encoding.18141815gui.matchTrackingBranch::1816 Determines if new branches created with linkgit:git-gui[1] should1817 default to tracking remote branches with matching names or1818 not. Default: "false".18191820gui.newBranchTemplate::1821 Is used as suggested name when creating new branches using the1822 linkgit:git-gui[1].18231824gui.pruneDuringFetch::1825 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1826 performing a fetch. The default value is "false".18271828gui.trustmtime::1829 Determines if linkgit:git-gui[1] should trust the file modification1830 timestamp or not. By default the timestamps are not trusted.18311832gui.spellingDictionary::1833 Specifies the dictionary used for spell checking commit messages in1834 the linkgit:git-gui[1]. When set to "none" spell checking is turned1835 off.18361837gui.fastCopyBlame::1838 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1839 location detection. It makes blame significantly faster on huge1840 repositories at the expense of less thorough copy detection.18411842gui.copyBlameThreshold::1843 Specifies the threshold to use in 'git gui blame' original location1844 detection, measured in alphanumeric characters. See the1845 linkgit:git-blame[1] manual for more information on copy detection.18461847gui.blamehistoryctx::1848 Specifies the radius of history context in days to show in1849 linkgit:gitk[1] for the selected commit, when the `Show History1850 Context` menu item is invoked from 'git gui blame'. If this1851 variable is set to zero, the whole history is shown.18521853guitool.<name>.cmd::1854 Specifies the shell command line to execute when the corresponding item1855 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1856 mandatory for every tool. The command is executed from the root of1857 the working directory, and in the environment it receives the name of1858 the tool as `GIT_GUITOOL`, the name of the currently selected file as1859 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1860 the head is detached, 'CUR_BRANCH' is empty).18611862guitool.<name>.needsFile::1863 Run the tool only if a diff is selected in the GUI. It guarantees1864 that 'FILENAME' is not empty.18651866guitool.<name>.noConsole::1867 Run the command silently, without creating a window to display its1868 output.18691870guitool.<name>.noRescan::1871 Don't rescan the working directory for changes after the tool1872 finishes execution.18731874guitool.<name>.confirm::1875 Show a confirmation dialog before actually running the tool.18761877guitool.<name>.argPrompt::1878 Request a string argument from the user, and pass it to the tool1879 through the `ARGS` environment variable. Since requesting an1880 argument implies confirmation, the 'confirm' option has no effect1881 if this is enabled. If the option is set to 'true', 'yes', or '1',1882 the dialog uses a built-in generic prompt; otherwise the exact1883 value of the variable is used.18841885guitool.<name>.revPrompt::1886 Request a single valid revision from the user, and set the1887 `REVISION` environment variable. In other aspects this option1888 is similar to 'argPrompt', and can be used together with it.18891890guitool.<name>.revUnmerged::1891 Show only unmerged branches in the 'revPrompt' subdialog.1892 This is useful for tools similar to merge or rebase, but not1893 for things like checkout or reset.18941895guitool.<name>.title::1896 Specifies the title to use for the prompt dialog. The default1897 is the tool name.18981899guitool.<name>.prompt::1900 Specifies the general prompt string to display at the top of1901 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1902 The default value includes the actual command.19031904help.browser::1905 Specify the browser that will be used to display help in the1906 'web' format. See linkgit:git-help[1].19071908help.format::1909 Override the default help format used by linkgit:git-help[1].1910 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1911 the default. 'web' and 'html' are the same.19121913help.autoCorrect::1914 Automatically correct and execute mistyped commands after1915 waiting for the given number of deciseconds (0.1 sec). If more1916 than one command can be deduced from the entered text, nothing1917 will be executed. If the value of this option is negative,1918 the corrected command will be executed immediately. If the1919 value is 0 - the command will be just shown but not executed.1920 This is the default.19211922help.htmlPath::1923 Specify the path where the HTML documentation resides. File system paths1924 and URLs are supported. HTML pages will be prefixed with this path when1925 help is displayed in the 'web' format. This defaults to the documentation1926 path of your Git installation.19271928http.proxy::1929 Override the HTTP proxy, normally configured using the 'http_proxy',1930 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1931 addition to the syntax understood by curl, it is possible to specify a1932 proxy string with a user name but no password, in which case git will1933 attempt to acquire one in the same way it does for other credentials. See1934 linkgit:gitcredentials[7] for more information. The syntax thus is1935 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1936 on a per-remote basis; see remote.<name>.proxy19371938http.proxyAuthMethod::1939 Set the method with which to authenticate against the HTTP proxy. This1940 only takes effect if the configured proxy string contains a user name part1941 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1942 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1943 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1944 variable. Possible values are:1945+1946--1947* `anyauth` - Automatically pick a suitable authentication method. It is1948 assumed that the proxy answers an unauthenticated request with a 4071949 status code and one or more Proxy-authenticate headers with supported1950 authentication methods. This is the default.1951* `basic` - HTTP Basic authentication1952* `digest` - HTTP Digest authentication; this prevents the password from being1953 transmitted to the proxy in clear text1954* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1955 of `curl(1)`)1956* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1957--19581959http.emptyAuth::1960 Attempt authentication without seeking a username or password. This1961 can be used to attempt GSS-Negotiate authentication without specifying1962 a username in the URL, as libcurl normally requires a username for1963 authentication.19641965http.delegation::1966 Control GSSAPI credential delegation. The delegation is disabled1967 by default in libcurl since version 7.21.7. Set parameter to tell1968 the server what it is allowed to delegate when it comes to user1969 credentials. Used with GSS/kerberos. Possible values are:1970+1971--1972* `none` - Don't allow any delegation.1973* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1974 Kerberos service ticket, which is a matter of realm policy.1975* `always` - Unconditionally allow the server to delegate.1976--197719781979http.extraHeader::1980 Pass an additional HTTP header when communicating with a server. If1981 more than one such entry exists, all of them are added as extra1982 headers. To allow overriding the settings inherited from the system1983 config, an empty value will reset the extra headers to the empty list.19841985http.cookieFile::1986 The pathname of a file containing previously stored cookie lines,1987 which should be used1988 in the Git http session, if they match the server. The file format1989 of the file to read cookies from should be plain HTTP headers or1990 the Netscape/Mozilla cookie file format (see `curl(1)`).1991 NOTE that the file specified with http.cookieFile is used only as1992 input unless http.saveCookies is set.19931994http.saveCookies::1995 If set, store cookies received during requests to the file specified by1996 http.cookieFile. Has no effect if http.cookieFile is unset.19971998http.sslVersion::1999 The SSL version to use when negotiating an SSL connection, if you2000 want to force the default. The available and default version2001 depend on whether libcurl was built against NSS or OpenSSL and the2002 particular configuration of the crypto library in use. Internally2003 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2004 documentation for more details on the format of this option and2005 for the ssl version supported. Actually the possible values of2006 this option are:20072008 - sslv22009 - sslv32010 - tlsv12011 - tlsv1.02012 - tlsv1.12013 - tlsv1.22014 - tlsv1.320152016+2017Can be overridden by the `GIT_SSL_VERSION` environment variable.2018To force git to use libcurl's default ssl version and ignore any2019explicit http.sslversion option, set `GIT_SSL_VERSION` to the2020empty string.20212022http.sslCipherList::2023 A list of SSL ciphers to use when negotiating an SSL connection.2024 The available ciphers depend on whether libcurl was built against2025 NSS or OpenSSL and the particular configuration of the crypto2026 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2027 option; see the libcurl documentation for more details on the format2028 of this list.2029+2030Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2031To force git to use libcurl's default cipher list and ignore any2032explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2033empty string.20342035http.sslVerify::2036 Whether to verify the SSL certificate when fetching or pushing2037 over HTTPS. Defaults to true. Can be overridden by the2038 `GIT_SSL_NO_VERIFY` environment variable.20392040http.sslCert::2041 File containing the SSL certificate when fetching or pushing2042 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2043 variable.20442045http.sslKey::2046 File containing the SSL private key when fetching or pushing2047 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2048 variable.20492050http.sslCertPasswordProtected::2051 Enable Git's password prompt for the SSL certificate. Otherwise2052 OpenSSL will prompt the user, possibly many times, if the2053 certificate or private key is encrypted. Can be overridden by the2054 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20552056http.sslCAInfo::2057 File containing the certificates to verify the peer with when2058 fetching or pushing over HTTPS. Can be overridden by the2059 `GIT_SSL_CAINFO` environment variable.20602061http.sslCAPath::2062 Path containing files with the CA certificates to verify the peer2063 with when fetching or pushing over HTTPS. Can be overridden2064 by the `GIT_SSL_CAPATH` environment variable.20652066http.pinnedpubkey::2067 Public key of the https service. It may either be the filename of2068 a PEM or DER encoded public key file or a string starting with2069 'sha256//' followed by the base64 encoded sha256 hash of the2070 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2071 exit with an error if this option is set but not supported by2072 cURL.20732074http.sslTry::2075 Attempt to use AUTH SSL/TLS and encrypted data transfers2076 when connecting via regular FTP protocol. This might be needed2077 if the FTP server requires it for security reasons or you wish2078 to connect securely whenever remote FTP server supports it.2079 Default is false since it might trigger certificate verification2080 errors on misconfigured servers.20812082http.maxRequests::2083 How many HTTP requests to launch in parallel. Can be overridden2084 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20852086http.minSessions::2087 The number of curl sessions (counted across slots) to be kept across2088 requests. They will not be ended with curl_easy_cleanup() until2089 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2090 value will be capped at 1. Defaults to 1.20912092http.postBuffer::2093 Maximum size in bytes of the buffer used by smart HTTP2094 transports when POSTing data to the remote system.2095 For requests larger than this buffer size, HTTP/1.1 and2096 Transfer-Encoding: chunked is used to avoid creating a2097 massive pack file locally. Default is 1 MiB, which is2098 sufficient for most requests.20992100http.lowSpeedLimit, http.lowSpeedTime::2101 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2102 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2103 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2104 `GIT_HTTP_LOW_SPEED_TIME` environment variables.21052106http.noEPSV::2107 A boolean which disables using of EPSV ftp command by curl.2108 This can helpful with some "poor" ftp servers which don't2109 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2110 environment variable. Default is false (curl will use EPSV).21112112http.userAgent::2113 The HTTP USER_AGENT string presented to an HTTP server. The default2114 value represents the version of the client Git such as git/1.7.1.2115 This option allows you to override this value to a more common value2116 such as Mozilla/4.0. This may be necessary, for instance, if2117 connecting through a firewall that restricts HTTP connections to a set2118 of common USER_AGENT strings (but not including those like git/1.7.1).2119 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.21202121http.followRedirects::2122 Whether git should follow HTTP redirects. If set to `true`, git2123 will transparently follow any redirect issued by a server it2124 encounters. If set to `false`, git will treat all redirects as2125 errors. If set to `initial`, git will follow redirects only for2126 the initial request to a remote, but not for subsequent2127 follow-up HTTP requests. Since git uses the redirected URL as2128 the base for the follow-up requests, this is generally2129 sufficient. The default is `initial`.21302131http.<url>.*::2132 Any of the http.* options above can be applied selectively to some URLs.2133 For a config key to match a URL, each element of the config key is2134 compared to that of the URL, in the following order:2135+2136--2137. Scheme (e.g., `https` in `https://example.com/`). This field2138 must match exactly between the config key and the URL.21392140. Host/domain name (e.g., `example.com` in `https://example.com/`).2141 This field must match between the config key and the URL. It is2142 possible to specify a `*` as part of the host name to match all subdomains2143 at this level. `https://*.example.com/` for example would match2144 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21452146. Port number (e.g., `8080` in `http://example.com:8080/`).2147 This field must match exactly between the config key and the URL.2148 Omitted port numbers are automatically converted to the correct2149 default for the scheme before matching.21502151. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2152 path field of the config key must match the path field of the URL2153 either exactly or as a prefix of slash-delimited path elements. This means2154 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2155 match on a slash (`/`) boundary. Longer matches take precedence (so a config2156 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2157 key with just path `foo/`).21582159. User name (e.g., `user` in `https://user@example.com/repo.git`). If2160 the config key has a user name it must match the user name in the2161 URL exactly. If the config key does not have a user name, that2162 config key will match a URL with any user name (including none),2163 but at a lower precedence than a config key with a user name.2164--2165+2166The list above is ordered by decreasing precedence; a URL that matches2167a config key's path is preferred to one that matches its user name. For example,2168if the URL is `https://user@example.com/foo/bar` a config key match of2169`https://example.com/foo` will be preferred over a config key match of2170`https://user@example.com`.2171+2172All URLs are normalized before attempting any matching (the password part,2173if embedded in the URL, is always ignored for matching purposes) so that2174equivalent URLs that are simply spelled differently will match properly.2175Environment variable settings always override any matches. The URLs that are2176matched against are those given directly to Git commands. This means any URLs2177visited as a result of a redirection do not participate in matching.21782179ssh.variant::2180 By default, Git determines the command line arguments to use2181 based on the basename of the configured SSH command (configured2182 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2183 the config setting `core.sshCommand`). If the basename is2184 unrecognized, Git will attempt to detect support of OpenSSH2185 options by first invoking the configured SSH command with the2186 `-G` (print configuration) option and will subsequently use2187 OpenSSH options (if that is successful) or no options besides2188 the host and remote command (if it fails).2189+2190The config variable `ssh.variant` can be set to override this detection.2191Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2192`tortoiseplink`, `simple` (no options except the host and remote command).2193The default auto-detection can be explicitly requested using the value2194`auto`. Any other value is treated as `ssh`. This setting can also be2195overridden via the environment variable `GIT_SSH_VARIANT`.2196+2197The current command-line parameters used for each variant are as2198follows:2199+2200--22012202* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command22032204* `simple` - [username@]host command22052206* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command22072208* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command22092210--2211+2212Except for the `simple` variant, command-line parameters are likely to2213change as git gains new features.22142215i18n.commitEncoding::2216 Character encoding the commit messages are stored in; Git itself2217 does not care per se, but this information is necessary e.g. when2218 importing commits from emails or in the gitk graphical history2219 browser (and possibly at other places in the future or in other2220 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.22212222i18n.logOutputEncoding::2223 Character encoding the commit messages are converted to when2224 running 'git log' and friends.22252226imap::2227 The configuration variables in the 'imap' section are described2228 in linkgit:git-imap-send[1].22292230index.version::2231 Specify the version with which new index files should be2232 initialized. This does not affect existing repositories.22332234init.templateDir::2235 Specify the directory from which templates will be copied.2236 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22372238instaweb.browser::2239 Specify the program that will be used to browse your working2240 repository in gitweb. See linkgit:git-instaweb[1].22412242instaweb.httpd::2243 The HTTP daemon command-line to start gitweb on your working2244 repository. See linkgit:git-instaweb[1].22452246instaweb.local::2247 If true the web server started by linkgit:git-instaweb[1] will2248 be bound to the local IP (127.0.0.1).22492250instaweb.modulePath::2251 The default module path for linkgit:git-instaweb[1] to use2252 instead of /usr/lib/apache2/modules. Only used if httpd2253 is Apache.22542255instaweb.port::2256 The port number to bind the gitweb httpd to. See2257 linkgit:git-instaweb[1].22582259interactive.singleKey::2260 In interactive commands, allow the user to provide one-letter2261 input with a single key (i.e., without hitting enter).2262 Currently this is used by the `--patch` mode of2263 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2264 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2265 setting is silently ignored if portable keystroke input2266 is not available; requires the Perl module Term::ReadKey.22672268interactive.diffFilter::2269 When an interactive command (such as `git add --patch`) shows2270 a colorized diff, git will pipe the diff through the shell2271 command defined by this configuration variable. The command may2272 mark up the diff further for human consumption, provided that it2273 retains a one-to-one correspondence with the lines in the2274 original diff. Defaults to disabled (no filtering).22752276log.abbrevCommit::2277 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2278 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2279 override this option with `--no-abbrev-commit`.22802281log.date::2282 Set the default date-time mode for the 'log' command.2283 Setting a value for log.date is similar to using 'git log''s2284 `--date` option. See linkgit:git-log[1] for details.22852286log.decorate::2287 Print out the ref names of any commits that are shown by the log2288 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2289 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2290 specified, the full ref name (including prefix) will be printed.2291 If 'auto' is specified, then if the output is going to a terminal,2292 the ref names are shown as if 'short' were given, otherwise no ref2293 names are shown. This is the same as the `--decorate` option2294 of the `git log`.22952296log.follow::2297 If `true`, `git log` will act as if the `--follow` option was used when2298 a single <path> is given. This has the same limitations as `--follow`,2299 i.e. it cannot be used to follow multiple files and does not work well2300 on non-linear history.23012302log.graphColors::2303 A list of colors, separated by commas, that can be used to draw2304 history lines in `git log --graph`.23052306log.showRoot::2307 If true, the initial commit will be shown as a big creation event.2308 This is equivalent to a diff against an empty tree.2309 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2310 normally hide the root commit will now show it. True by default.23112312log.showSignature::2313 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2314 linkgit:git-whatchanged[1] assume `--show-signature`.23152316log.mailmap::2317 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2318 linkgit:git-whatchanged[1] assume `--use-mailmap`.23192320mailinfo.scissors::2321 If true, makes linkgit:git-mailinfo[1] (and therefore2322 linkgit:git-am[1]) act by default as if the --scissors option2323 was provided on the command-line. When active, this features2324 removes everything from the message body before a scissors2325 line (i.e. consisting mainly of ">8", "8<" and "-").23262327mailmap.file::2328 The location of an augmenting mailmap file. The default2329 mailmap, located in the root of the repository, is loaded2330 first, then the mailmap file pointed to by this variable.2331 The location of the mailmap file may be in a repository2332 subdirectory, or somewhere outside of the repository itself.2333 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23342335mailmap.blob::2336 Like `mailmap.file`, but consider the value as a reference to a2337 blob in the repository. If both `mailmap.file` and2338 `mailmap.blob` are given, both are parsed, with entries from2339 `mailmap.file` taking precedence. In a bare repository, this2340 defaults to `HEAD:.mailmap`. In a non-bare repository, it2341 defaults to empty.23422343man.viewer::2344 Specify the programs that may be used to display help in the2345 'man' format. See linkgit:git-help[1].23462347man.<tool>.cmd::2348 Specify the command to invoke the specified man viewer. The2349 specified command is evaluated in shell with the man page2350 passed as argument. (See linkgit:git-help[1].)23512352man.<tool>.path::2353 Override the path for the given tool that may be used to2354 display help in the 'man' format. See linkgit:git-help[1].23552356include::merge-config.txt[]23572358mergetool.<tool>.path::2359 Override the path for the given tool. This is useful in case2360 your tool is not in the PATH.23612362mergetool.<tool>.cmd::2363 Specify the command to invoke the specified merge tool. The2364 specified command is evaluated in shell with the following2365 variables available: 'BASE' is the name of a temporary file2366 containing the common base of the files to be merged, if available;2367 'LOCAL' is the name of a temporary file containing the contents of2368 the file on the current branch; 'REMOTE' is the name of a temporary2369 file containing the contents of the file from the branch being2370 merged; 'MERGED' contains the name of the file to which the merge2371 tool should write the results of a successful merge.23722373mergetool.<tool>.trustExitCode::2374 For a custom merge command, specify whether the exit code of2375 the merge command can be used to determine whether the merge was2376 successful. If this is not set to true then the merge target file2377 timestamp is checked and the merge assumed to have been successful2378 if the file has been updated, otherwise the user is prompted to2379 indicate the success of the merge.23802381mergetool.meld.hasOutput::2382 Older versions of `meld` do not support the `--output` option.2383 Git will attempt to detect whether `meld` supports `--output`2384 by inspecting the output of `meld --help`. Configuring2385 `mergetool.meld.hasOutput` will make Git skip these checks and2386 use the configured value instead. Setting `mergetool.meld.hasOutput`2387 to `true` tells Git to unconditionally use the `--output` option,2388 and `false` avoids using `--output`.23892390mergetool.keepBackup::2391 After performing a merge, the original file with conflict markers2392 can be saved as a file with a `.orig` extension. If this variable2393 is set to `false` then this file is not preserved. Defaults to2394 `true` (i.e. keep the backup files).23952396mergetool.keepTemporaries::2397 When invoking a custom merge tool, Git uses a set of temporary2398 files to pass to the tool. If the tool returns an error and this2399 variable is set to `true`, then these temporary files will be2400 preserved, otherwise they will be removed after the tool has2401 exited. Defaults to `false`.24022403mergetool.writeToTemp::2404 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2405 conflicting files in the worktree by default. Git will attempt2406 to use a temporary directory for these files when set `true`.2407 Defaults to `false`.24082409mergetool.prompt::2410 Prompt before each invocation of the merge resolution program.24112412notes.mergeStrategy::2413 Which merge strategy to choose by default when resolving notes2414 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2415 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2416 section of linkgit:git-notes[1] for more information on each strategy.24172418notes.<name>.mergeStrategy::2419 Which merge strategy to choose when doing a notes merge into2420 refs/notes/<name>. This overrides the more general2421 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2422 linkgit:git-notes[1] for more information on the available strategies.24232424notes.displayRef::2425 The (fully qualified) refname from which to show notes when2426 showing commit messages. The value of this variable can be set2427 to a glob, in which case notes from all matching refs will be2428 shown. You may also specify this configuration variable2429 several times. A warning will be issued for refs that do not2430 exist, but a glob that does not match any refs is silently2431 ignored.2432+2433This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2434environment variable, which must be a colon separated list of refs or2435globs.2436+2437The effective value of "core.notesRef" (possibly overridden by2438GIT_NOTES_REF) is also implicitly added to the list of refs to be2439displayed.24402441notes.rewrite.<command>::2442 When rewriting commits with <command> (currently `amend` or2443 `rebase`) and this variable is set to `true`, Git2444 automatically copies your notes from the original to the2445 rewritten commit. Defaults to `true`, but see2446 "notes.rewriteRef" below.24472448notes.rewriteMode::2449 When copying notes during a rewrite (see the2450 "notes.rewrite.<command>" option), determines what to do if2451 the target commit already has a note. Must be one of2452 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2453 Defaults to `concatenate`.2454+2455This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2456environment variable.24572458notes.rewriteRef::2459 When copying notes during a rewrite, specifies the (fully2460 qualified) ref whose notes should be copied. The ref may be a2461 glob, in which case notes in all matching refs will be copied.2462 You may also specify this configuration several times.2463+2464Does not have a default value; you must configure this variable to2465enable note rewriting. Set it to `refs/notes/commits` to enable2466rewriting for the default commit notes.2467+2468This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2469environment variable, which must be a colon separated list of refs or2470globs.24712472pack.window::2473 The size of the window used by linkgit:git-pack-objects[1] when no2474 window size is given on the command line. Defaults to 10.24752476pack.depth::2477 The maximum delta depth used by linkgit:git-pack-objects[1] when no2478 maximum depth is given on the command line. Defaults to 50.2479 Maximum value is 4095.24802481pack.windowMemory::2482 The maximum size of memory that is consumed by each thread2483 in linkgit:git-pack-objects[1] for pack window memory when2484 no limit is given on the command line. The value can be2485 suffixed with "k", "m", or "g". When left unconfigured (or2486 set explicitly to 0), there will be no limit.24872488pack.compression::2489 An integer -1..9, indicating the compression level for objects2490 in a pack file. -1 is the zlib default. 0 means no2491 compression, and 1..9 are various speed/size tradeoffs, 9 being2492 slowest. If not set, defaults to core.compression. If that is2493 not set, defaults to -1, the zlib default, which is "a default2494 compromise between speed and compression (currently equivalent2495 to level 6)."2496+2497Note that changing the compression level will not automatically recompress2498all existing objects. You can force recompression by passing the -F option2499to linkgit:git-repack[1].25002501pack.deltaCacheSize::2502 The maximum memory in bytes used for caching deltas in2503 linkgit:git-pack-objects[1] before writing them out to a pack.2504 This cache is used to speed up the writing object phase by not2505 having to recompute the final delta result once the best match2506 for all objects is found. Repacking large repositories on machines2507 which are tight with memory might be badly impacted by this though,2508 especially if this cache pushes the system into swapping.2509 A value of 0 means no limit. The smallest size of 1 byte may be2510 used to virtually disable this cache. Defaults to 256 MiB.25112512pack.deltaCacheLimit::2513 The maximum size of a delta, that is cached in2514 linkgit:git-pack-objects[1]. This cache is used to speed up the2515 writing object phase by not having to recompute the final delta2516 result once the best match for all objects is found.2517 Defaults to 1000. Maximum value is 65535.25182519pack.threads::2520 Specifies the number of threads to spawn when searching for best2521 delta matches. This requires that linkgit:git-pack-objects[1]2522 be compiled with pthreads otherwise this option is ignored with a2523 warning. This is meant to reduce packing time on multiprocessor2524 machines. The required amount of memory for the delta search window2525 is however multiplied by the number of threads.2526 Specifying 0 will cause Git to auto-detect the number of CPU's2527 and set the number of threads accordingly.25282529pack.indexVersion::2530 Specify the default pack index version. Valid values are 1 for2531 legacy pack index used by Git versions prior to 1.5.2, and 2 for2532 the new pack index with capabilities for packs larger than 4 GB2533 as well as proper protection against the repacking of corrupted2534 packs. Version 2 is the default. Note that version 2 is enforced2535 and this config option ignored whenever the corresponding pack is2536 larger than 2 GB.2537+2538If you have an old Git that does not understand the version 2 `*.idx` file,2539cloning or fetching over a non native protocol (e.g. "http")2540that will copy both `*.pack` file and corresponding `*.idx` file from the2541other side may give you a repository that cannot be accessed with your2542older version of Git. If the `*.pack` file is smaller than 2 GB, however,2543you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2544the `*.idx` file.25452546pack.packSizeLimit::2547 The maximum size of a pack. This setting only affects2548 packing to a file when repacking, i.e. the git:// protocol2549 is unaffected. It can be overridden by the `--max-pack-size`2550 option of linkgit:git-repack[1]. Reaching this limit results2551 in the creation of multiple packfiles; which in turn prevents2552 bitmaps from being created.2553 The minimum size allowed is limited to 1 MiB.2554 The default is unlimited.2555 Common unit suffixes of 'k', 'm', or 'g' are2556 supported.25572558pack.useBitmaps::2559 When true, git will use pack bitmaps (if available) when packing2560 to stdout (e.g., during the server side of a fetch). Defaults to2561 true. You should not generally need to turn this off unless2562 you are debugging pack bitmaps.25632564pack.writeBitmaps (deprecated)::2565 This is a deprecated synonym for `repack.writeBitmaps`.25662567pack.writeBitmapHashCache::2568 When true, git will include a "hash cache" section in the bitmap2569 index (if one is written). This cache can be used to feed git's2570 delta heuristics, potentially leading to better deltas between2571 bitmapped and non-bitmapped objects (e.g., when serving a fetch2572 between an older, bitmapped pack and objects that have been2573 pushed since the last gc). The downside is that it consumes 42574 bytes per object of disk space, and that JGit's bitmap2575 implementation does not understand it, causing it to complain if2576 Git and JGit are used on the same repository. Defaults to false.25772578pager.<cmd>::2579 If the value is boolean, turns on or off pagination of the2580 output of a particular Git subcommand when writing to a tty.2581 Otherwise, turns on pagination for the subcommand using the2582 pager specified by the value of `pager.<cmd>`. If `--paginate`2583 or `--no-pager` is specified on the command line, it takes2584 precedence over this option. To disable pagination for all2585 commands, set `core.pager` or `GIT_PAGER` to `cat`.25862587pretty.<name>::2588 Alias for a --pretty= format string, as specified in2589 linkgit:git-log[1]. Any aliases defined here can be used just2590 as the built-in pretty formats could. For example,2591 running `git config pretty.changelog "format:* %H %s"`2592 would cause the invocation `git log --pretty=changelog`2593 to be equivalent to running `git log "--pretty=format:* %H %s"`.2594 Note that an alias with the same name as a built-in format2595 will be silently ignored.25962597protocol.allow::2598 If set, provide a user defined default policy for all protocols which2599 don't explicitly have a policy (`protocol.<name>.allow`). By default,2600 if unset, known-safe protocols (http, https, git, ssh, file) have a2601 default policy of `always`, known-dangerous protocols (ext) have a2602 default policy of `never`, and all other protocols have a default2603 policy of `user`. Supported policies:2604+2605--26062607* `always` - protocol is always able to be used.26082609* `never` - protocol is never able to be used.26102611* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2612 either unset or has a value of 1. This policy should be used when you want a2613 protocol to be directly usable by the user but don't want it used by commands which2614 execute clone/fetch/push commands without user input, e.g. recursive2615 submodule initialization.26162617--26182619protocol.<name>.allow::2620 Set a policy to be used by protocol `<name>` with clone/fetch/push2621 commands. See `protocol.allow` above for the available policies.2622+2623The protocol names currently used by git are:2624+2625--2626 - `file`: any local file-based path (including `file://` URLs,2627 or local paths)26282629 - `git`: the anonymous git protocol over a direct TCP2630 connection (or proxy, if configured)26312632 - `ssh`: git over ssh (including `host:path` syntax,2633 `ssh://`, etc).26342635 - `http`: git over http, both "smart http" and "dumb http".2636 Note that this does _not_ include `https`; if you want to configure2637 both, you must do so individually.26382639 - any external helpers are named by their protocol (e.g., use2640 `hg` to allow the `git-remote-hg` helper)2641--26422643protocol.version::2644 Experimental. If set, clients will attempt to communicate with a2645 server using the specified protocol version. If unset, no2646 attempt will be made by the client to communicate using a2647 particular protocol version, this results in protocol version 02648 being used.2649 Supported versions:2650+2651--26522653* `0` - the original wire protocol.26542655* `1` - the original wire protocol with the addition of a version string2656 in the initial response from the server.26572658--26592660pull.ff::2661 By default, Git does not create an extra merge commit when merging2662 a commit that is a descendant of the current commit. Instead, the2663 tip of the current branch is fast-forwarded. When set to `false`,2664 this variable tells Git to create an extra merge commit in such2665 a case (equivalent to giving the `--no-ff` option from the command2666 line). When set to `only`, only such fast-forward merges are2667 allowed (equivalent to giving the `--ff-only` option from the2668 command line). This setting overrides `merge.ff` when pulling.26692670pull.rebase::2671 When true, rebase branches on top of the fetched branch, instead2672 of merging the default branch from the default remote when "git2673 pull" is run. See "branch.<name>.rebase" for setting this on a2674 per-branch basis.2675+2676When `merges`, pass the `--rebase-merges` option to 'git rebase'2677so that the local merge commits are included in the rebase (see2678linkgit:git-rebase[1] for details).2679+2680When preserve, also pass `--preserve-merges` along to 'git rebase'2681so that locally committed merge commits will not be flattened2682by running 'git pull'.2683+2684When the value is `interactive`, the rebase is run in interactive mode.2685+2686*NOTE*: this is a possibly dangerous operation; do *not* use2687it unless you understand the implications (see linkgit:git-rebase[1]2688for details).26892690pull.octopus::2691 The default merge strategy to use when pulling multiple branches2692 at once.26932694pull.twohead::2695 The default merge strategy to use when pulling a single branch.26962697push.default::2698 Defines the action `git push` should take if no refspec is2699 explicitly given. Different values are well-suited for2700 specific workflows; for instance, in a purely central workflow2701 (i.e. the fetch source is equal to the push destination),2702 `upstream` is probably what you want. Possible values are:2703+2704--27052706* `nothing` - do not push anything (error out) unless a refspec is2707 explicitly given. This is primarily meant for people who want to2708 avoid mistakes by always being explicit.27092710* `current` - push the current branch to update a branch with the same2711 name on the receiving end. Works in both central and non-central2712 workflows.27132714* `upstream` - push the current branch back to the branch whose2715 changes are usually integrated into the current branch (which is2716 called `@{upstream}`). This mode only makes sense if you are2717 pushing to the same repository you would normally pull from2718 (i.e. central workflow).27192720* `tracking` - This is a deprecated synonym for `upstream`.27212722* `simple` - in centralized workflow, work like `upstream` with an2723 added safety to refuse to push if the upstream branch's name is2724 different from the local one.2725+2726When pushing to a remote that is different from the remote you normally2727pull from, work as `current`. This is the safest option and is suited2728for beginners.2729+2730This mode has become the default in Git 2.0.27312732* `matching` - push all branches having the same name on both ends.2733 This makes the repository you are pushing to remember the set of2734 branches that will be pushed out (e.g. if you always push 'maint'2735 and 'master' there and no other branches, the repository you push2736 to will have these two branches, and your local 'maint' and2737 'master' will be pushed there).2738+2739To use this mode effectively, you have to make sure _all_ the2740branches you would push out are ready to be pushed out before2741running 'git push', as the whole point of this mode is to allow you2742to push all of the branches in one go. If you usually finish work2743on only one branch and push out the result, while other branches are2744unfinished, this mode is not for you. Also this mode is not2745suitable for pushing into a shared central repository, as other2746people may add new branches there, or update the tip of existing2747branches outside your control.2748+2749This used to be the default, but not since Git 2.0 (`simple` is the2750new default).27512752--27532754push.followTags::2755 If set to true enable `--follow-tags` option by default. You2756 may override this configuration at time of push by specifying2757 `--no-follow-tags`.27582759push.gpgSign::2760 May be set to a boolean value, or the string 'if-asked'. A true2761 value causes all pushes to be GPG signed, as if `--signed` is2762 passed to linkgit:git-push[1]. The string 'if-asked' causes2763 pushes to be signed if the server supports it, as if2764 `--signed=if-asked` is passed to 'git push'. A false value may2765 override a value from a lower-priority config file. An explicit2766 command-line flag always overrides this config option.27672768push.pushOption::2769 When no `--push-option=<option>` argument is given from the2770 command line, `git push` behaves as if each <value> of2771 this variable is given as `--push-option=<value>`.2772+2773This is a multi-valued variable, and an empty value can be used in a2774higher priority configuration file (e.g. `.git/config` in a2775repository) to clear the values inherited from a lower priority2776configuration files (e.g. `$HOME/.gitconfig`).2777+2778--27792780Example:27812782/etc/gitconfig2783 push.pushoption = a2784 push.pushoption = b27852786~/.gitconfig2787 push.pushoption = c27882789repo/.git/config2790 push.pushoption =2791 push.pushoption = b27922793This will result in only b (a and c are cleared).27942795--27962797push.recurseSubmodules::2798 Make sure all submodule commits used by the revisions to be pushed2799 are available on a remote-tracking branch. If the value is 'check'2800 then Git will verify that all submodule commits that changed in the2801 revisions to be pushed are available on at least one remote of the2802 submodule. If any commits are missing, the push will be aborted and2803 exit with non-zero status. If the value is 'on-demand' then all2804 submodules that changed in the revisions to be pushed will be2805 pushed. If on-demand was not able to push all necessary revisions2806 it will also be aborted and exit with non-zero status. If the value2807 is 'no' then default behavior of ignoring submodules when pushing2808 is retained. You may override this configuration at time of push by2809 specifying '--recurse-submodules=check|on-demand|no'.28102811include::rebase-config.txt[]28122813receive.advertiseAtomic::2814 By default, git-receive-pack will advertise the atomic push2815 capability to its clients. If you don't want to advertise this2816 capability, set this variable to false.28172818receive.advertisePushOptions::2819 When set to true, git-receive-pack will advertise the push options2820 capability to its clients. False by default.28212822receive.autogc::2823 By default, git-receive-pack will run "git-gc --auto" after2824 receiving data from git-push and updating refs. You can stop2825 it by setting this variable to false.28262827receive.certNonceSeed::2828 By setting this variable to a string, `git receive-pack`2829 will accept a `git push --signed` and verifies it by using2830 a "nonce" protected by HMAC using this string as a secret2831 key.28322833receive.certNonceSlop::2834 When a `git push --signed` sent a push certificate with a2835 "nonce" that was issued by a receive-pack serving the same2836 repository within this many seconds, export the "nonce"2837 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2838 hooks (instead of what the receive-pack asked the sending2839 side to include). This may allow writing checks in2840 `pre-receive` and `post-receive` a bit easier. Instead of2841 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2842 that records by how many seconds the nonce is stale to2843 decide if they want to accept the certificate, they only2844 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.28452846receive.fsckObjects::2847 If it is set to true, git-receive-pack will check all received2848 objects. It will abort in the case of a malformed object or a2849 broken link. The result of an abort are only dangling objects.2850 Defaults to false. If not set, the value of `transfer.fsckObjects`2851 is used instead.28522853receive.fsck.<msg-id>::2854 When `receive.fsckObjects` is set to true, errors can be switched2855 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2856 setting where the `<msg-id>` is the fsck message ID and the value2857 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2858 the error/warning with the message ID, e.g. "missingEmail: invalid2859 author/committer line - missing email" means that setting2860 `receive.fsck.missingEmail = ignore` will hide that issue.2861+2862This feature is intended to support working with legacy repositories2863which would not pass pushing when `receive.fsckObjects = true`, allowing2864the host to accept repositories with certain known issues but still catch2865other issues.28662867receive.fsck.skipList::2868 The path to a sorted list of object names (i.e. one SHA-1 per2869 line) that are known to be broken in a non-fatal way and should2870 be ignored. This feature is useful when an established project2871 should be accepted despite early commits containing errors that2872 can be safely ignored such as invalid committer email addresses.2873 Note: corrupt objects cannot be skipped with this setting.28742875receive.keepAlive::2876 After receiving the pack from the client, `receive-pack` may2877 produce no output (if `--quiet` was specified) while processing2878 the pack, causing some networks to drop the TCP connection.2879 With this option set, if `receive-pack` does not transmit2880 any data in this phase for `receive.keepAlive` seconds, it will2881 send a short keepalive packet. The default is 5 seconds; set2882 to 0 to disable keepalives entirely.28832884receive.unpackLimit::2885 If the number of objects received in a push is below this2886 limit then the objects will be unpacked into loose object2887 files. However if the number of received objects equals or2888 exceeds this limit then the received pack will be stored as2889 a pack, after adding any missing delta bases. Storing the2890 pack from a push can make the push operation complete faster,2891 especially on slow filesystems. If not set, the value of2892 `transfer.unpackLimit` is used instead.28932894receive.maxInputSize::2895 If the size of the incoming pack stream is larger than this2896 limit, then git-receive-pack will error out, instead of2897 accepting the pack file. If not set or set to 0, then the size2898 is unlimited.28992900receive.denyDeletes::2901 If set to true, git-receive-pack will deny a ref update that deletes2902 the ref. Use this to prevent such a ref deletion via a push.29032904receive.denyDeleteCurrent::2905 If set to true, git-receive-pack will deny a ref update that2906 deletes the currently checked out branch of a non-bare repository.29072908receive.denyCurrentBranch::2909 If set to true or "refuse", git-receive-pack will deny a ref update2910 to the currently checked out branch of a non-bare repository.2911 Such a push is potentially dangerous because it brings the HEAD2912 out of sync with the index and working tree. If set to "warn",2913 print a warning of such a push to stderr, but allow the push to2914 proceed. If set to false or "ignore", allow such pushes with no2915 message. Defaults to "refuse".2916+2917Another option is "updateInstead" which will update the working2918tree if pushing into the current branch. This option is2919intended for synchronizing working directories when one side is not easily2920accessible via interactive ssh (e.g. a live web site, hence the requirement2921that the working directory be clean). This mode also comes in handy when2922developing inside a VM to test and fix code on different Operating Systems.2923+2924By default, "updateInstead" will refuse the push if the working tree or2925the index have any difference from the HEAD, but the `push-to-checkout`2926hook can be used to customize this. See linkgit:githooks[5].29272928receive.denyNonFastForwards::2929 If set to true, git-receive-pack will deny a ref update which is2930 not a fast-forward. Use this to prevent such an update via a push,2931 even if that push is forced. This configuration variable is2932 set when initializing a shared repository.29332934receive.hideRefs::2935 This variable is the same as `transfer.hideRefs`, but applies2936 only to `receive-pack` (and so affects pushes, but not fetches).2937 An attempt to update or delete a hidden ref by `git push` is2938 rejected.29392940receive.updateServerInfo::2941 If set to true, git-receive-pack will run git-update-server-info2942 after receiving data from git-push and updating refs.29432944receive.shallowUpdate::2945 If set to true, .git/shallow can be updated when new refs2946 require new shallow roots. Otherwise those refs are rejected.29472948remote.pushDefault::2949 The remote to push to by default. Overrides2950 `branch.<name>.remote` for all branches, and is overridden by2951 `branch.<name>.pushRemote` for specific branches.29522953remote.<name>.url::2954 The URL of a remote repository. See linkgit:git-fetch[1] or2955 linkgit:git-push[1].29562957remote.<name>.pushurl::2958 The push URL of a remote repository. See linkgit:git-push[1].29592960remote.<name>.proxy::2961 For remotes that require curl (http, https and ftp), the URL to2962 the proxy to use for that remote. Set to the empty string to2963 disable proxying for that remote.29642965remote.<name>.proxyAuthMethod::2966 For remotes that require curl (http, https and ftp), the method to use for2967 authenticating against the proxy in use (probably set in2968 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29692970remote.<name>.fetch::2971 The default set of "refspec" for linkgit:git-fetch[1]. See2972 linkgit:git-fetch[1].29732974remote.<name>.push::2975 The default set of "refspec" for linkgit:git-push[1]. See2976 linkgit:git-push[1].29772978remote.<name>.mirror::2979 If true, pushing to this remote will automatically behave2980 as if the `--mirror` option was given on the command line.29812982remote.<name>.skipDefaultUpdate::2983 If true, this remote will be skipped by default when updating2984 using linkgit:git-fetch[1] or the `update` subcommand of2985 linkgit:git-remote[1].29862987remote.<name>.skipFetchAll::2988 If true, this remote will be skipped by default when updating2989 using linkgit:git-fetch[1] or the `update` subcommand of2990 linkgit:git-remote[1].29912992remote.<name>.receivepack::2993 The default program to execute on the remote side when pushing. See2994 option --receive-pack of linkgit:git-push[1].29952996remote.<name>.uploadpack::2997 The default program to execute on the remote side when fetching. See2998 option --upload-pack of linkgit:git-fetch-pack[1].29993000remote.<name>.tagOpt::3001 Setting this value to --no-tags disables automatic tag following when3002 fetching from remote <name>. Setting it to --tags will fetch every3003 tag from remote <name>, even if they are not reachable from remote3004 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3005 override this setting. See options --tags and --no-tags of3006 linkgit:git-fetch[1].30073008remote.<name>.vcs::3009 Setting this to a value <vcs> will cause Git to interact with3010 the remote with the git-remote-<vcs> helper.30113012remote.<name>.prune::3013 When set to true, fetching from this remote by default will also3014 remove any remote-tracking references that no longer exist on the3015 remote (as if the `--prune` option was given on the command line).3016 Overrides `fetch.prune` settings, if any.30173018remote.<name>.pruneTags::3019 When set to true, fetching from this remote by default will also3020 remove any local tags that no longer exist on the remote if pruning3021 is activated in general via `remote.<name>.prune`, `fetch.prune` or3022 `--prune`. Overrides `fetch.pruneTags` settings, if any.3023+3024See also `remote.<name>.prune` and the PRUNING section of3025linkgit:git-fetch[1].30263027remotes.<group>::3028 The list of remotes which are fetched by "git remote update3029 <group>". See linkgit:git-remote[1].30303031repack.useDeltaBaseOffset::3032 By default, linkgit:git-repack[1] creates packs that use3033 delta-base offset. If you need to share your repository with3034 Git older than version 1.4.4, either directly or via a dumb3035 protocol such as http, then you need to set this option to3036 "false" and repack. Access from old Git versions over the3037 native protocol are unaffected by this option.30383039repack.packKeptObjects::3040 If set to true, makes `git repack` act as if3041 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3042 details. Defaults to `false` normally, but `true` if a bitmap3043 index is being written (either via `--write-bitmap-index` or3044 `repack.writeBitmaps`).30453046repack.writeBitmaps::3047 When true, git will write a bitmap index when packing all3048 objects to disk (e.g., when `git repack -a` is run). This3049 index can speed up the "counting objects" phase of subsequent3050 packs created for clones and fetches, at the cost of some disk3051 space and extra time spent on the initial repack. This has3052 no effect if multiple packfiles are created.3053 Defaults to false.30543055rerere.autoUpdate::3056 When set to true, `git-rerere` updates the index with the3057 resulting contents after it cleanly resolves conflicts using3058 previously recorded resolution. Defaults to false.30593060rerere.enabled::3061 Activate recording of resolved conflicts, so that identical3062 conflict hunks can be resolved automatically, should they be3063 encountered again. By default, linkgit:git-rerere[1] is3064 enabled if there is an `rr-cache` directory under the3065 `$GIT_DIR`, e.g. if "rerere" was previously used in the3066 repository.30673068sendemail.identity::3069 A configuration identity. When given, causes values in the3070 'sendemail.<identity>' subsection to take precedence over3071 values in the 'sendemail' section. The default identity is3072 the value of `sendemail.identity`.30733074sendemail.smtpEncryption::3075 See linkgit:git-send-email[1] for description. Note that this3076 setting is not subject to the 'identity' mechanism.30773078sendemail.smtpssl (deprecated)::3079 Deprecated alias for 'sendemail.smtpEncryption = ssl'.30803081sendemail.smtpsslcertpath::3082 Path to ca-certificates (either a directory or a single file).3083 Set it to an empty string to disable certificate verification.30843085sendemail.<identity>.*::3086 Identity-specific versions of the 'sendemail.*' parameters3087 found below, taking precedence over those when this3088 identity is selected, through either the command-line or3089 `sendemail.identity`.30903091sendemail.aliasesFile::3092sendemail.aliasFileType::3093sendemail.annotate::3094sendemail.bcc::3095sendemail.cc::3096sendemail.ccCmd::3097sendemail.chainReplyTo::3098sendemail.confirm::3099sendemail.envelopeSender::3100sendemail.from::3101sendemail.multiEdit::3102sendemail.signedoffbycc::3103sendemail.smtpPass::3104sendemail.suppresscc::3105sendemail.suppressFrom::3106sendemail.to::3107sendemail.tocmd::3108sendemail.smtpDomain::3109sendemail.smtpServer::3110sendemail.smtpServerPort::3111sendemail.smtpServerOption::3112sendemail.smtpUser::3113sendemail.thread::3114sendemail.transferEncoding::3115sendemail.validate::3116sendemail.xmailer::3117 See linkgit:git-send-email[1] for description.31183119sendemail.signedoffcc (deprecated)::3120 Deprecated alias for `sendemail.signedoffbycc`.31213122sendemail.smtpBatchSize::3123 Number of messages to be sent per connection, after that a relogin3124 will happen. If the value is 0 or undefined, send all messages in3125 one connection.3126 See also the `--batch-size` option of linkgit:git-send-email[1].31273128sendemail.smtpReloginDelay::3129 Seconds wait before reconnecting to smtp server.3130 See also the `--relogin-delay` option of linkgit:git-send-email[1].31313132showbranch.default::3133 The default set of branches for linkgit:git-show-branch[1].3134 See linkgit:git-show-branch[1].31353136splitIndex.maxPercentChange::3137 When the split index feature is used, this specifies the3138 percent of entries the split index can contain compared to the3139 total number of entries in both the split index and the shared3140 index before a new shared index is written.3141 The value should be between 0 and 100. If the value is 0 then3142 a new shared index is always written, if it is 100 a new3143 shared index is never written.3144 By default the value is 20, so a new shared index is written3145 if the number of entries in the split index would be greater3146 than 20 percent of the total number of entries.3147 See linkgit:git-update-index[1].31483149splitIndex.sharedIndexExpire::3150 When the split index feature is used, shared index files that3151 were not modified since the time this variable specifies will3152 be removed when a new shared index file is created. The value3153 "now" expires all entries immediately, and "never" suppresses3154 expiration altogether.3155 The default value is "2.weeks.ago".3156 Note that a shared index file is considered modified (for the3157 purpose of expiration) each time a new split-index file is3158 either created based on it or read from it.3159 See linkgit:git-update-index[1].31603161status.relativePaths::3162 By default, linkgit:git-status[1] shows paths relative to the3163 current directory. Setting this variable to `false` shows paths3164 relative to the repository root (this was the default for Git3165 prior to v1.5.4).31663167status.short::3168 Set to true to enable --short by default in linkgit:git-status[1].3169 The option --no-short takes precedence over this variable.31703171status.branch::3172 Set to true to enable --branch by default in linkgit:git-status[1].3173 The option --no-branch takes precedence over this variable.31743175status.displayCommentPrefix::3176 If set to true, linkgit:git-status[1] will insert a comment3177 prefix before each output line (starting with3178 `core.commentChar`, i.e. `#` by default). This was the3179 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3180 Defaults to false.31813182status.showStash::3183 If set to true, linkgit:git-status[1] will display the number of3184 entries currently stashed away.3185 Defaults to false.31863187status.showUntrackedFiles::3188 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3189 files which are not currently tracked by Git. Directories which3190 contain only untracked files, are shown with the directory name3191 only. Showing untracked files means that Git needs to lstat() all3192 the files in the whole repository, which might be slow on some3193 systems. So, this variable controls how the commands displays3194 the untracked files. Possible values are:3195+3196--3197* `no` - Show no untracked files.3198* `normal` - Show untracked files and directories.3199* `all` - Show also individual files in untracked directories.3200--3201+3202If this variable is not specified, it defaults to 'normal'.3203This variable can be overridden with the -u|--untracked-files option3204of linkgit:git-status[1] and linkgit:git-commit[1].32053206status.submoduleSummary::3207 Defaults to false.3208 If this is set to a non zero number or true (identical to -1 or an3209 unlimited number), the submodule summary will be enabled and a3210 summary of commits for modified submodules will be shown (see3211 --summary-limit option of linkgit:git-submodule[1]). Please note3212 that the summary output command will be suppressed for all3213 submodules when `diff.ignoreSubmodules` is set to 'all' or only3214 for those submodules where `submodule.<name>.ignore=all`. The only3215 exception to that rule is that status and commit will show staged3216 submodule changes. To3217 also view the summary for ignored submodules you can either use3218 the --ignore-submodules=dirty command-line option or the 'git3219 submodule summary' command, which shows a similar output but does3220 not honor these settings.32213222stash.showPatch::3223 If this is set to true, the `git stash show` command without an3224 option will show the stash entry in patch form. Defaults to false.3225 See description of 'show' command in linkgit:git-stash[1].32263227stash.showStat::3228 If this is set to true, the `git stash show` command without an3229 option will show diffstat of the stash entry. Defaults to true.3230 See description of 'show' command in linkgit:git-stash[1].32313232submodule.<name>.url::3233 The URL for a submodule. This variable is copied from the .gitmodules3234 file to the git config via 'git submodule init'. The user can change3235 the configured URL before obtaining the submodule via 'git submodule3236 update'. If neither submodule.<name>.active or submodule.active are3237 set, the presence of this variable is used as a fallback to indicate3238 whether the submodule is of interest to git commands.3239 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.32403241submodule.<name>.update::3242 The method by which a submodule is updated by 'git submodule update',3243 which is the only affected command, others such as3244 'git checkout --recurse-submodules' are unaffected. It exists for3245 historical reasons, when 'git submodule' was the only command to3246 interact with submodules; settings like `submodule.active`3247 and `pull.rebase` are more specific. It is populated by3248 `git submodule init` from the linkgit:gitmodules[5] file.3249 See description of 'update' command in linkgit:git-submodule[1].32503251submodule.<name>.branch::3252 The remote branch name for a submodule, used by `git submodule3253 update --remote`. Set this option to override the value found in3254 the `.gitmodules` file. See linkgit:git-submodule[1] and3255 linkgit:gitmodules[5] for details.32563257submodule.<name>.fetchRecurseSubmodules::3258 This option can be used to control recursive fetching of this3259 submodule. It can be overridden by using the --[no-]recurse-submodules3260 command-line option to "git fetch" and "git pull".3261 This setting will override that from in the linkgit:gitmodules[5]3262 file.32633264submodule.<name>.ignore::3265 Defines under what circumstances "git status" and the diff family show3266 a submodule as modified. When set to "all", it will never be considered3267 modified (but it will nonetheless show up in the output of status and3268 commit when it has been staged), "dirty" will ignore all changes3269 to the submodules work tree and3270 takes only differences between the HEAD of the submodule and the commit3271 recorded in the superproject into account. "untracked" will additionally3272 let submodules with modified tracked files in their work tree show up.3273 Using "none" (the default when this option is not set) also shows3274 submodules that have untracked files in their work tree as changed.3275 This setting overrides any setting made in .gitmodules for this submodule,3276 both settings can be overridden on the command line by using the3277 "--ignore-submodules" option. The 'git submodule' commands are not3278 affected by this setting.32793280submodule.<name>.active::3281 Boolean value indicating if the submodule is of interest to git3282 commands. This config option takes precedence over the3283 submodule.active config option.32843285submodule.active::3286 A repeated field which contains a pathspec used to match against a3287 submodule's path to determine if the submodule is of interest to git3288 commands.32893290submodule.recurse::3291 Specifies if commands recurse into submodules by default. This3292 applies to all commands that have a `--recurse-submodules` option,3293 except `clone`.3294 Defaults to false.32953296submodule.fetchJobs::3297 Specifies how many submodules are fetched/cloned at the same time.3298 A positive integer allows up to that number of submodules fetched3299 in parallel. A value of 0 will give some reasonable default.3300 If unset, it defaults to 1.33013302submodule.alternateLocation::3303 Specifies how the submodules obtain alternates when submodules are3304 cloned. Possible values are `no`, `superproject`.3305 By default `no` is assumed, which doesn't add references. When the3306 value is set to `superproject` the submodule to be cloned computes3307 its alternates location relative to the superprojects alternate.33083309submodule.alternateErrorStrategy::3310 Specifies how to treat errors with the alternates for a submodule3311 as computed via `submodule.alternateLocation`. Possible values are3312 `ignore`, `info`, `die`. Default is `die`.33133314tag.forceSignAnnotated::3315 A boolean to specify whether annotated tags created should be GPG signed.3316 If `--annotate` is specified on the command line, it takes3317 precedence over this option.33183319tag.sort::3320 This variable controls the sort ordering of tags when displayed by3321 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3322 value of this variable will be used as the default.33233324tar.umask::3325 This variable can be used to restrict the permission bits of3326 tar archive entries. The default is 0002, which turns off the3327 world write bit. The special value "user" indicates that the3328 archiving user's umask will be used instead. See umask(2) and3329 linkgit:git-archive[1].33303331transfer.fsckObjects::3332 When `fetch.fsckObjects` or `receive.fsckObjects` are3333 not set, the value of this variable is used instead.3334 Defaults to false.33353336transfer.hideRefs::3337 String(s) `receive-pack` and `upload-pack` use to decide which3338 refs to omit from their initial advertisements. Use more than3339 one definition to specify multiple prefix strings. A ref that is3340 under the hierarchies listed in the value of this variable is3341 excluded, and is hidden when responding to `git push` or `git3342 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3343 program-specific versions of this config.3344+3345You may also include a `!` in front of the ref name to negate the entry,3346explicitly exposing it, even if an earlier entry marked it as hidden.3347If you have multiple hideRefs values, later entries override earlier ones3348(and entries in more-specific config files override less-specific ones).3349+3350If a namespace is in use, the namespace prefix is stripped from each3351reference before it is matched against `transfer.hiderefs` patterns.3352For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3353the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3354is omitted from the advertisements but `refs/heads/master` and3355`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3356"have" lines. In order to match refs before stripping, add a `^` in front of3357the ref name. If you combine `!` and `^`, `!` must be specified first.3358+3359Even if you hide refs, a client may still be able to steal the target3360objects via the techniques described in the "SECURITY" section of the3361linkgit:gitnamespaces[7] man page; it's best to keep private data in a3362separate repository.33633364transfer.unpackLimit::3365 When `fetch.unpackLimit` or `receive.unpackLimit` are3366 not set, the value of this variable is used instead.3367 The default value is 100.33683369uploadarchive.allowUnreachable::3370 If true, allow clients to use `git archive --remote` to request3371 any tree, whether reachable from the ref tips or not. See the3372 discussion in the "SECURITY" section of3373 linkgit:git-upload-archive[1] for more details. Defaults to3374 `false`.33753376uploadpack.hideRefs::3377 This variable is the same as `transfer.hideRefs`, but applies3378 only to `upload-pack` (and so affects only fetches, not pushes).3379 An attempt to fetch a hidden ref by `git fetch` will fail. See3380 also `uploadpack.allowTipSHA1InWant`.33813382uploadpack.allowTipSHA1InWant::3383 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3384 to accept a fetch request that asks for an object at the tip3385 of a hidden ref (by default, such a request is rejected).3386 See also `uploadpack.hideRefs`. Even if this is false, a client3387 may be able to steal objects via the techniques described in the3388 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3389 best to keep private data in a separate repository.33903391uploadpack.allowReachableSHA1InWant::3392 Allow `upload-pack` to accept a fetch request that asks for an3393 object that is reachable from any ref tip. However, note that3394 calculating object reachability is computationally expensive.3395 Defaults to `false`. Even if this is false, a client may be able3396 to steal objects via the techniques described in the "SECURITY"3397 section of the linkgit:gitnamespaces[7] man page; it's best to3398 keep private data in a separate repository.33993400uploadpack.allowAnySHA1InWant::3401 Allow `upload-pack` to accept a fetch request that asks for any3402 object at all.3403 Defaults to `false`.34043405uploadpack.keepAlive::3406 When `upload-pack` has started `pack-objects`, there may be a3407 quiet period while `pack-objects` prepares the pack. Normally3408 it would output progress information, but if `--quiet` was used3409 for the fetch, `pack-objects` will output nothing at all until3410 the pack data begins. Some clients and networks may consider3411 the server to be hung and give up. Setting this option instructs3412 `upload-pack` to send an empty keepalive packet every3413 `uploadpack.keepAlive` seconds. Setting this option to 03414 disables keepalive packets entirely. The default is 5 seconds.34153416uploadpack.packObjectsHook::3417 If this option is set, when `upload-pack` would run3418 `git pack-objects` to create a packfile for a client, it will3419 run this shell command instead. The `pack-objects` command and3420 arguments it _would_ have run (including the `git pack-objects`3421 at the beginning) are appended to the shell command. The stdin3422 and stdout of the hook are treated as if `pack-objects` itself3423 was run. I.e., `upload-pack` will feed input intended for3424 `pack-objects` to the hook, and expects a completed packfile on3425 stdout.34263427uploadpack.allowFilter::3428 If this option is set, `upload-pack` will support partial3429 clone and partial fetch object filtering.3430+3431Note that this configuration variable is ignored if it is seen in the3432repository-level config (this is a safety measure against fetching from3433untrusted repositories).34343435url.<base>.insteadOf::3436 Any URL that starts with this value will be rewritten to3437 start, instead, with <base>. In cases where some site serves a3438 large number of repositories, and serves them with multiple3439 access methods, and some users need to use different access3440 methods, this feature allows people to specify any of the3441 equivalent URLs and have Git automatically rewrite the URL to3442 the best alternative for the particular user, even for a3443 never-before-seen repository on the site. When more than one3444 insteadOf strings match a given URL, the longest match is used.3445+3446Note that any protocol restrictions will be applied to the rewritten3447URL. If the rewrite changes the URL to use a custom protocol or remote3448helper, you may need to adjust the `protocol.*.allow` config to permit3449the request. In particular, protocols you expect to use for submodules3450must be set to `always` rather than the default of `user`. See the3451description of `protocol.allow` above.34523453url.<base>.pushInsteadOf::3454 Any URL that starts with this value will not be pushed to;3455 instead, it will be rewritten to start with <base>, and the3456 resulting URL will be pushed to. In cases where some site serves3457 a large number of repositories, and serves them with multiple3458 access methods, some of which do not allow push, this feature3459 allows people to specify a pull-only URL and have Git3460 automatically use an appropriate URL to push, even for a3461 never-before-seen repository on the site. When more than one3462 pushInsteadOf strings match a given URL, the longest match is3463 used. If a remote has an explicit pushurl, Git will ignore this3464 setting for that remote.34653466user.email::3467 Your email address to be recorded in any newly created commits.3468 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3469 `EMAIL` environment variables. See linkgit:git-commit-tree[1].34703471user.name::3472 Your full name to be recorded in any newly created commits.3473 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3474 environment variables. See linkgit:git-commit-tree[1].34753476user.useConfigOnly::3477 Instruct Git to avoid trying to guess defaults for `user.email`3478 and `user.name`, and instead retrieve the values only from the3479 configuration. For example, if you have multiple email addresses3480 and would like to use a different one for each repository, then3481 with this configuration option set to `true` in the global config3482 along with a name, Git will prompt you to set up an email before3483 making new commits in a newly cloned repository.3484 Defaults to `false`.34853486user.signingKey::3487 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3488 key you want it to automatically when creating a signed tag or3489 commit, you can override the default selection with this variable.3490 This option is passed unchanged to gpg's --local-user parameter,3491 so you may specify a key using any method that gpg supports.34923493versionsort.prereleaseSuffix (deprecated)::3494 Deprecated alias for `versionsort.suffix`. Ignored if3495 `versionsort.suffix` is set.34963497versionsort.suffix::3498 Even when version sort is used in linkgit:git-tag[1], tagnames3499 with the same base version but different suffixes are still sorted3500 lexicographically, resulting e.g. in prerelease tags appearing3501 after the main release (e.g. "1.0-rc1" after "1.0"). This3502 variable can be specified to determine the sorting order of tags3503 with different suffixes.3504+3505By specifying a single suffix in this variable, any tagname containing3506that suffix will appear before the corresponding main release. E.g. if3507the variable is set to "-rc", then all "1.0-rcX" tags will appear before3508"1.0". If specified multiple times, once per suffix, then the order of3509suffixes in the configuration will determine the sorting order of tagnames3510with those suffixes. E.g. if "-pre" appears before "-rc" in the3511configuration, then all "1.0-preX" tags will be listed before any3512"1.0-rcX" tags. The placement of the main release tag relative to tags3513with various suffixes can be determined by specifying the empty suffix3514among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3515"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3516are listed first, followed by "v4.8", then "v4.8-ckX" and finally3517"v4.8-bfsX".3518+3519If more than one suffixes match the same tagname, then that tagname will3520be sorted according to the suffix which starts at the earliest position in3521the tagname. If more than one different matching suffixes start at3522that earliest position, then that tagname will be sorted according to the3523longest of those suffixes.3524The sorting order between different suffixes is undefined if they are3525in multiple config files.35263527web.browser::3528 Specify a web browser that may be used by some commands.3529 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3530 may use it.35313532worktree.guessRemote::3533 With `add`, if no branch argument, and neither of `-b` nor3534 `-B` nor `--detach` are given, the command defaults to3535 creating a new branch from HEAD. If `worktree.guessRemote` is3536 set to true, `worktree add` tries to find a remote-tracking3537 branch whose name uniquely matches the new branch name. If3538 such a branch exists, it is checked out and set as "upstream"3539 for the new branch. If no such match can be found, it falls3540 back to creating a new branch from the current HEAD.