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, respectively1166 and `grafted` for grafted commits.11671168color.grep::1169 When set to `always`, always highlight matches. When `false` (or1170 `never`), never. When set to `true` or `auto`, use color only1171 when the output is written to the terminal. If unset, then the1172 value of `color.ui` is used (`auto` by default).11731174color.grep.<slot>::1175 Use customized color for grep colorization. `<slot>` specifies which1176 part of the line to use the specified color, and is one of1177+1178--1179`context`;;1180 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1181`filename`;;1182 filename prefix (when not using `-h`)1183`function`;;1184 function name lines (when using `-p`)1185`linenumber`;;1186 line number prefix (when using `-n`)1187`match`;;1188 matching text (same as setting `matchContext` and `matchSelected`)1189`matchContext`;;1190 matching text in context lines1191`matchSelected`;;1192 matching text in selected lines1193`selected`;;1194 non-matching text in selected lines1195`separator`;;1196 separators between fields on a line (`:`, `-`, and `=`)1197 and between hunks (`--`)1198--11991200color.interactive::1201 When set to `always`, always use colors for interactive prompts1202 and displays (such as those used by "git-add --interactive" and1203 "git-clean --interactive"). When false (or `never`), never.1204 When set to `true` or `auto`, use colors only when the output is1205 to the terminal. If unset, then the value of `color.ui` is1206 used (`auto` by default).12071208color.interactive.<slot>::1209 Use customized color for 'git add --interactive' and 'git clean1210 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1211 or `error`, for four distinct types of normal output from1212 interactive commands.12131214color.pager::1215 A boolean to enable/disable colored output when the pager is in1216 use (default is true).12171218color.push::1219 A boolean to enable/disable color in push errors. May be set to1220 `always`, `false` (or `never`) or `auto` (or `true`), in which1221 case colors are used only when the error output goes to a terminal.1222 If unset, then the value of `color.ui` is used (`auto` by default).12231224color.push.error::1225 Use customized color for push errors.12261227color.showBranch::1228 A boolean to enable/disable color in the output of1229 linkgit:git-show-branch[1]. May be set to `always`,1230 `false` (or `never`) or `auto` (or `true`), in which case colors are used1231 only when the output is to a terminal. If unset, then the1232 value of `color.ui` is used (`auto` by default).12331234color.status::1235 A boolean to enable/disable color in the output of1236 linkgit:git-status[1]. May be set to `always`,1237 `false` (or `never`) or `auto` (or `true`), in which case colors are used1238 only when the output is to a terminal. If unset, then the1239 value of `color.ui` is used (`auto` by default).12401241color.status.<slot>::1242 Use customized color for status colorization. `<slot>` is1243 one of `header` (the header text of the status message),1244 `added` or `updated` (files which are added but not committed),1245 `changed` (files which are changed but not added in the index),1246 `untracked` (files which are not tracked by Git),1247 `branch` (the current branch),1248 `nobranch` (the color the 'no branch' warning is shown in, defaulting1249 to red),1250 `localBranch` or `remoteBranch` (the local and remote branch names,1251 respectively, when branch and tracking information is displayed in the1252 status short-format), or1253 `unmerged` (files which have unmerged changes).12541255color.transport::1256 A boolean to enable/disable color when pushes are rejected. May be1257 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1258 case colors are used only when the error output goes to a terminal.1259 If unset, then the value of `color.ui` is used (`auto` by default).12601261color.transport.rejected::1262 Use customized color when a push was rejected.12631264color.ui::1265 This variable determines the default value for variables such1266 as `color.diff` and `color.grep` that control the use of color1267 per command family. Its scope will expand as more commands learn1268 configuration to set a default for the `--color` option. Set it1269 to `false` or `never` if you prefer Git commands not to use1270 color unless enabled explicitly with some other configuration1271 or the `--color` option. Set it to `always` if you want all1272 output not intended for machine consumption to use color, to1273 `true` or `auto` (this is the default since Git 1.8.4) if you1274 want such output to use color when written to the terminal.12751276column.ui::1277 Specify whether supported commands should output in columns.1278 This variable consists of a list of tokens separated by spaces1279 or commas:1280+1281These options control when the feature should be enabled1282(defaults to 'never'):1283+1284--1285`always`;;1286 always show in columns1287`never`;;1288 never show in columns1289`auto`;;1290 show in columns if the output is to the terminal1291--1292+1293These options control layout (defaults to 'column'). Setting any1294of these implies 'always' if none of 'always', 'never', or 'auto' are1295specified.1296+1297--1298`column`;;1299 fill columns before rows1300`row`;;1301 fill rows before columns1302`plain`;;1303 show in one column1304--1305+1306Finally, these options can be combined with a layout option (defaults1307to 'nodense'):1308+1309--1310`dense`;;1311 make unequal size columns to utilize more space1312`nodense`;;1313 make equal size columns1314--13151316column.branch::1317 Specify whether to output branch listing in `git branch` in columns.1318 See `column.ui` for details.13191320column.clean::1321 Specify the layout when list items in `git clean -i`, which always1322 shows files and directories in columns. See `column.ui` for details.13231324column.status::1325 Specify whether to output untracked files in `git status` in columns.1326 See `column.ui` for details.13271328column.tag::1329 Specify whether to output tag listing in `git tag` in columns.1330 See `column.ui` for details.13311332commit.cleanup::1333 This setting overrides the default of the `--cleanup` option in1334 `git commit`. See linkgit:git-commit[1] for details. Changing the1335 default can be useful when you always want to keep lines that begin1336 with comment character `#` in your log message, in which case you1337 would do `git config commit.cleanup whitespace` (note that you will1338 have to remove the help lines that begin with `#` in the commit log1339 template yourself, if you do this).13401341commit.gpgSign::13421343 A boolean to specify whether all commits should be GPG signed.1344 Use of this option when doing operations such as rebase can1345 result in a large number of commits being signed. It may be1346 convenient to use an agent to avoid typing your GPG passphrase1347 several times.13481349commit.status::1350 A boolean to enable/disable inclusion of status information in the1351 commit message template when using an editor to prepare the commit1352 message. Defaults to true.13531354commit.template::1355 Specify the pathname of a file to use as the template for1356 new commit messages.13571358commit.verbose::1359 A boolean or int to specify the level of verbose with `git commit`.1360 See linkgit:git-commit[1].13611362credential.helper::1363 Specify an external helper to be called when a username or1364 password credential is needed; the helper may consult external1365 storage to avoid prompting the user for the credentials. Note1366 that multiple helpers may be defined. See linkgit:gitcredentials[7]1367 for details.13681369credential.useHttpPath::1370 When acquiring credentials, consider the "path" component of an http1371 or https URL to be important. Defaults to false. See1372 linkgit:gitcredentials[7] for more information.13731374credential.username::1375 If no username is set for a network authentication, use this username1376 by default. See credential.<context>.* below, and1377 linkgit:gitcredentials[7].13781379credential.<url>.*::1380 Any of the credential.* options above can be applied selectively to1381 some credentials. For example "credential.https://example.com.username"1382 would set the default username only for https connections to1383 example.com. See linkgit:gitcredentials[7] for details on how URLs are1384 matched.13851386credentialCache.ignoreSIGHUP::1387 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13881389completion.commands::1390 This is only used by git-completion.bash to add or remove1391 commands from the list of completed commands. Normally only1392 porcelain commands and a few select others are completed. You1393 can add more commands, separated by space, in this1394 variable. Prefixing the command with '-' will remove it from1395 the existing list.13961397include::diff-config.txt[]13981399difftool.<tool>.path::1400 Override the path for the given tool. This is useful in case1401 your tool is not in the PATH.14021403difftool.<tool>.cmd::1404 Specify the command to invoke the specified diff tool.1405 The specified command is evaluated in shell with the following1406 variables available: 'LOCAL' is set to the name of the temporary1407 file containing the contents of the diff pre-image and 'REMOTE'1408 is set to the name of the temporary file containing the contents1409 of the diff post-image.14101411difftool.prompt::1412 Prompt before each invocation of the diff tool.14131414fastimport.unpackLimit::1415 If the number of objects imported by linkgit:git-fast-import[1]1416 is below this limit, then the objects will be unpacked into1417 loose object files. However if the number of imported objects1418 equals or exceeds this limit then the pack will be stored as a1419 pack. Storing the pack from a fast-import can make the import1420 operation complete faster, especially on slow filesystems. If1421 not set, the value of `transfer.unpackLimit` is used instead.14221423fetch.recurseSubmodules::1424 This option can be either set to a boolean value or to 'on-demand'.1425 Setting it to a boolean changes the behavior of fetch and pull to1426 unconditionally recurse into submodules when set to true or to not1427 recurse at all when set to false. When set to 'on-demand' (the default1428 value), fetch and pull will only recurse into a populated submodule1429 when its superproject retrieves a commit that updates the submodule's1430 reference.14311432fetch.fsckObjects::1433 If it is set to true, git-fetch-pack will check all fetched1434 objects. It will abort in the case of a malformed object or a1435 broken link. The result of an abort are only dangling objects.1436 Defaults to false. If not set, the value of `transfer.fsckObjects`1437 is used instead.14381439fetch.unpackLimit::1440 If the number of objects fetched over the Git native1441 transfer is below this1442 limit, then the objects will be unpacked into loose object1443 files. However if the number of received objects equals or1444 exceeds this limit then the received pack will be stored as1445 a pack, after adding any missing delta bases. Storing the1446 pack from a push can make the push operation complete faster,1447 especially on slow filesystems. If not set, the value of1448 `transfer.unpackLimit` is used instead.14491450fetch.prune::1451 If true, fetch will automatically behave as if the `--prune`1452 option was given on the command line. See also `remote.<name>.prune`1453 and the PRUNING section of linkgit:git-fetch[1].14541455fetch.pruneTags::1456 If true, fetch will automatically behave as if the1457 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1458 if not set already. This allows for setting both this option1459 and `fetch.prune` to maintain a 1=1 mapping to upstream1460 refs. See also `remote.<name>.pruneTags` and the PRUNING1461 section of linkgit:git-fetch[1].14621463fetch.output::1464 Control how ref update status is printed. Valid values are1465 `full` and `compact`. Default value is `full`. See section1466 OUTPUT in linkgit:git-fetch[1] for detail.14671468format.attach::1469 Enable multipart/mixed attachments as the default for1470 'format-patch'. The value can also be a double quoted string1471 which will enable attachments as the default and set the1472 value as the boundary. See the --attach option in1473 linkgit:git-format-patch[1].14741475format.from::1476 Provides the default value for the `--from` option to format-patch.1477 Accepts a boolean value, or a name and email address. If false,1478 format-patch defaults to `--no-from`, using commit authors directly in1479 the "From:" field of patch mails. If true, format-patch defaults to1480 `--from`, using your committer identity in the "From:" field of patch1481 mails and including a "From:" field in the body of the patch mail if1482 different. If set to a non-boolean value, format-patch uses that1483 value instead of your committer identity. Defaults to false.14841485format.numbered::1486 A boolean which can enable or disable sequence numbers in patch1487 subjects. It defaults to "auto" which enables it only if there1488 is more than one patch. It can be enabled or disabled for all1489 messages by setting it to "true" or "false". See --numbered1490 option in linkgit:git-format-patch[1].14911492format.headers::1493 Additional email headers to include in a patch to be submitted1494 by mail. See linkgit:git-format-patch[1].14951496format.to::1497format.cc::1498 Additional recipients to include in a patch to be submitted1499 by mail. See the --to and --cc options in1500 linkgit:git-format-patch[1].15011502format.subjectPrefix::1503 The default for format-patch is to output files with the '[PATCH]'1504 subject prefix. Use this variable to change that prefix.15051506format.signature::1507 The default for format-patch is to output a signature containing1508 the Git version number. Use this variable to change that default.1509 Set this variable to the empty string ("") to suppress1510 signature generation.15111512format.signatureFile::1513 Works just like format.signature except the contents of the1514 file specified by this variable will be used as the signature.15151516format.suffix::1517 The default for format-patch is to output files with the suffix1518 `.patch`. Use this variable to change that suffix (make sure to1519 include the dot if you want it).15201521format.pretty::1522 The default pretty format for log/show/whatchanged command,1523 See linkgit:git-log[1], linkgit:git-show[1],1524 linkgit:git-whatchanged[1].15251526format.thread::1527 The default threading style for 'git format-patch'. Can be1528 a boolean value, or `shallow` or `deep`. `shallow` threading1529 makes every mail a reply to the head of the series,1530 where the head is chosen from the cover letter, the1531 `--in-reply-to`, and the first patch mail, in this order.1532 `deep` threading makes every mail a reply to the previous one.1533 A true boolean value is the same as `shallow`, and a false1534 value disables threading.15351536format.signOff::1537 A boolean value which lets you enable the `-s/--signoff` option of1538 format-patch by default. *Note:* Adding the Signed-off-by: line to a1539 patch should be a conscious act and means that you certify you have1540 the rights to submit this work under the same open source license.1541 Please see the 'SubmittingPatches' document for further discussion.15421543format.coverLetter::1544 A boolean that controls whether to generate a cover-letter when1545 format-patch is invoked, but in addition can be set to "auto", to1546 generate a cover-letter only when there's more than one patch.15471548format.outputDirectory::1549 Set a custom directory to store the resulting files instead of the1550 current working directory.15511552format.useAutoBase::1553 A boolean value which lets you enable the `--base=auto` option of1554 format-patch by default.15551556filter.<driver>.clean::1557 The command which is used to convert the content of a worktree1558 file to a blob upon checkin. See linkgit:gitattributes[5] for1559 details.15601561filter.<driver>.smudge::1562 The command which is used to convert the content of a blob1563 object to a worktree file upon checkout. See1564 linkgit:gitattributes[5] for details.15651566fsck.<msg-id>::1567 Allows overriding the message type (error, warn or ignore) of a1568 specific message ID such as `missingEmail`.1569+1570For convenience, fsck prefixes the error/warning with the message ID,1571e.g. "missingEmail: invalid author/committer line - missing email" means1572that setting `fsck.missingEmail = ignore` will hide that issue.1573+1574This feature is intended to support working with legacy repositories1575which cannot be repaired without disruptive changes.15761577fsck.skipList::1578 The path to a sorted list of object names (i.e. one SHA-1 per1579 line) that are known to be broken in a non-fatal way and should1580 be ignored. This feature is useful when an established project1581 should be accepted despite early commits containing errors that1582 can be safely ignored such as invalid committer email addresses.1583 Note: corrupt objects cannot be skipped with this setting.15841585gc.aggressiveDepth::1586 The depth parameter used in the delta compression1587 algorithm used by 'git gc --aggressive'. This defaults1588 to 50.15891590gc.aggressiveWindow::1591 The window size parameter used in the delta compression1592 algorithm used by 'git gc --aggressive'. This defaults1593 to 250.15941595gc.auto::1596 When there are approximately more than this many loose1597 objects in the repository, `git gc --auto` will pack them.1598 Some Porcelain commands use this command to perform a1599 light-weight garbage collection from time to time. The1600 default value is 6700. Setting this to 0 disables it.16011602gc.autoPackLimit::1603 When there are more than this many packs that are not1604 marked with `*.keep` file in the repository, `git gc1605 --auto` consolidates them into one larger pack. The1606 default value is 50. Setting this to 0 disables it.16071608gc.autoDetach::1609 Make `git gc --auto` return immediately and run in background1610 if the system supports it. Default is true.16111612gc.bigPackThreshold::1613 If non-zero, all packs larger than this limit are kept when1614 `git gc` is run. This is very similar to `--keep-base-pack`1615 except that all packs that meet the threshold are kept, not1616 just the base pack. Defaults to zero. Common unit suffixes of1617 'k', 'm', or 'g' are supported.1618+1619Note that if the number of kept packs is more than gc.autoPackLimit,1620this configuration variable is ignored, all packs except the base pack1621will be repacked. After this the number of packs should go below1622gc.autoPackLimit and gc.bigPackThreshold should be respected again.16231624gc.logExpiry::1625 If the file gc.log exists, then `git gc --auto` won't run1626 unless that file is more than 'gc.logExpiry' old. Default is1627 "1.day". See `gc.pruneExpire` for more ways to specify its1628 value.16291630gc.packRefs::1631 Running `git pack-refs` in a repository renders it1632 unclonable by Git versions prior to 1.5.1.2 over dumb1633 transports such as HTTP. This variable determines whether1634 'git gc' runs `git pack-refs`. This can be set to `notbare`1635 to enable it within all non-bare repos or it can be set to a1636 boolean value. The default is `true`.16371638gc.pruneExpire::1639 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1640 Override the grace period with this config variable. The value1641 "now" may be used to disable this grace period and always prune1642 unreachable objects immediately, or "never" may be used to1643 suppress pruning. This feature helps prevent corruption when1644 'git gc' runs concurrently with another process writing to the1645 repository; see the "NOTES" section of linkgit:git-gc[1].16461647gc.worktreePruneExpire::1648 When 'git gc' is run, it calls1649 'git worktree prune --expire 3.months.ago'.1650 This config variable can be used to set a different grace1651 period. The value "now" may be used to disable the grace1652 period and prune `$GIT_DIR/worktrees` immediately, or "never"1653 may be used to suppress pruning.16541655gc.reflogExpire::1656gc.<pattern>.reflogExpire::1657 'git reflog expire' removes reflog entries older than1658 this time; defaults to 90 days. The value "now" expires all1659 entries immediately, and "never" suppresses expiration1660 altogether. With "<pattern>" (e.g.1661 "refs/stash") in the middle the setting applies only to1662 the refs that match the <pattern>.16631664gc.reflogExpireUnreachable::1665gc.<pattern>.reflogExpireUnreachable::1666 'git reflog expire' removes reflog entries older than1667 this time and are not reachable from the current tip;1668 defaults to 30 days. The value "now" expires all entries1669 immediately, and "never" suppresses expiration altogether.1670 With "<pattern>" (e.g. "refs/stash")1671 in the middle, the setting applies only to the refs that1672 match the <pattern>.16731674gc.rerereResolved::1675 Records of conflicted merge you resolved earlier are1676 kept for this many days when 'git rerere gc' is run.1677 You can also use more human-readable "1.month.ago", etc.1678 The default is 60 days. See linkgit:git-rerere[1].16791680gc.rerereUnresolved::1681 Records of conflicted merge you have not resolved are1682 kept for this many days when 'git rerere gc' is run.1683 You can also use more human-readable "1.month.ago", etc.1684 The default is 15 days. See linkgit:git-rerere[1].16851686gitcvs.commitMsgAnnotation::1687 Append this string to each commit message. Set to empty string1688 to disable this feature. Defaults to "via git-CVS emulator".16891690gitcvs.enabled::1691 Whether the CVS server interface is enabled for this repository.1692 See linkgit:git-cvsserver[1].16931694gitcvs.logFile::1695 Path to a log file where the CVS server interface well... logs1696 various stuff. See linkgit:git-cvsserver[1].16971698gitcvs.usecrlfattr::1699 If true, the server will look up the end-of-line conversion1700 attributes for files to determine the `-k` modes to use. If1701 the attributes force Git to treat a file as text,1702 the `-k` mode will be left blank so CVS clients will1703 treat it as text. If they suppress text conversion, the file1704 will be set with '-kb' mode, which suppresses any newline munging1705 the client might otherwise do. If the attributes do not allow1706 the file type to be determined, then `gitcvs.allBinary` is1707 used. See linkgit:gitattributes[5].17081709gitcvs.allBinary::1710 This is used if `gitcvs.usecrlfattr` does not resolve1711 the correct '-kb' mode to use. If true, all1712 unresolved files are sent to the client in1713 mode '-kb'. This causes the client to treat them1714 as binary files, which suppresses any newline munging it1715 otherwise might do. Alternatively, if it is set to "guess",1716 then the contents of the file are examined to decide if1717 it is binary, similar to `core.autocrlf`.17181719gitcvs.dbName::1720 Database used by git-cvsserver to cache revision information1721 derived from the Git repository. The exact meaning depends on the1722 used database driver, for SQLite (which is the default driver) this1723 is a filename. Supports variable substitution (see1724 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1725 Default: '%Ggitcvs.%m.sqlite'17261727gitcvs.dbDriver::1728 Used Perl DBI driver. You can specify any available driver1729 for this here, but it might not work. git-cvsserver is tested1730 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1731 reported *not* to work with 'DBD::mysql'. Experimental feature.1732 May not contain double colons (`:`). Default: 'SQLite'.1733 See linkgit:git-cvsserver[1].17341735gitcvs.dbUser, gitcvs.dbPass::1736 Database user and password. Only useful if setting `gitcvs.dbDriver`,1737 since SQLite has no concept of database users and/or passwords.1738 'gitcvs.dbUser' supports variable substitution (see1739 linkgit:git-cvsserver[1] for details).17401741gitcvs.dbTableNamePrefix::1742 Database table name prefix. Prepended to the names of any1743 database tables used, allowing a single database to be used1744 for several repositories. Supports variable substitution (see1745 linkgit:git-cvsserver[1] for details). Any non-alphabetic1746 characters will be replaced with underscores.17471748All gitcvs variables except for `gitcvs.usecrlfattr` and1749`gitcvs.allBinary` can also be specified as1750'gitcvs.<access_method>.<varname>' (where 'access_method'1751is one of "ext" and "pserver") to make them apply only for the given1752access method.17531754gitweb.category::1755gitweb.description::1756gitweb.owner::1757gitweb.url::1758 See linkgit:gitweb[1] for description.17591760gitweb.avatar::1761gitweb.blame::1762gitweb.grep::1763gitweb.highlight::1764gitweb.patches::1765gitweb.pickaxe::1766gitweb.remote_heads::1767gitweb.showSizes::1768gitweb.snapshot::1769 See linkgit:gitweb.conf[5] for description.17701771grep.lineNumber::1772 If set to true, enable `-n` option by default.17731774grep.patternType::1775 Set the default matching behavior. Using a value of 'basic', 'extended',1776 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1777 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1778 value 'default' will return to the default matching behavior.17791780grep.extendedRegexp::1781 If set to true, enable `--extended-regexp` option by default. This1782 option is ignored when the `grep.patternType` option is set to a value1783 other than 'default'.17841785grep.threads::1786 Number of grep worker threads to use.1787 See `grep.threads` in linkgit:git-grep[1] for more information.17881789grep.fallbackToNoIndex::1790 If set to true, fall back to git grep --no-index if git grep1791 is executed outside of a git repository. Defaults to false.17921793gpg.program::1794 Use this custom program instead of "`gpg`" found on `$PATH` when1795 making or verifying a PGP signature. The program must support the1796 same command-line interface as GPG, namely, to verify a detached1797 signature, "`gpg --verify $file - <$signature`" is run, and the1798 program is expected to signal a good signature by exiting with1799 code 0, and to generate an ASCII-armored detached signature, the1800 standard input of "`gpg -bsau $key`" is fed with the contents to be1801 signed, and the program is expected to send the result to its1802 standard output.18031804gui.commitMsgWidth::1805 Defines how wide the commit message window is in the1806 linkgit:git-gui[1]. "75" is the default.18071808gui.diffContext::1809 Specifies how many context lines should be used in calls to diff1810 made by the linkgit:git-gui[1]. The default is "5".18111812gui.displayUntracked::1813 Determines if linkgit:git-gui[1] shows untracked files1814 in the file list. The default is "true".18151816gui.encoding::1817 Specifies the default encoding to use for displaying of1818 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1819 It can be overridden by setting the 'encoding' attribute1820 for relevant files (see linkgit:gitattributes[5]).1821 If this option is not set, the tools default to the1822 locale encoding.18231824gui.matchTrackingBranch::1825 Determines if new branches created with linkgit:git-gui[1] should1826 default to tracking remote branches with matching names or1827 not. Default: "false".18281829gui.newBranchTemplate::1830 Is used as suggested name when creating new branches using the1831 linkgit:git-gui[1].18321833gui.pruneDuringFetch::1834 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1835 performing a fetch. The default value is "false".18361837gui.trustmtime::1838 Determines if linkgit:git-gui[1] should trust the file modification1839 timestamp or not. By default the timestamps are not trusted.18401841gui.spellingDictionary::1842 Specifies the dictionary used for spell checking commit messages in1843 the linkgit:git-gui[1]. When set to "none" spell checking is turned1844 off.18451846gui.fastCopyBlame::1847 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1848 location detection. It makes blame significantly faster on huge1849 repositories at the expense of less thorough copy detection.18501851gui.copyBlameThreshold::1852 Specifies the threshold to use in 'git gui blame' original location1853 detection, measured in alphanumeric characters. See the1854 linkgit:git-blame[1] manual for more information on copy detection.18551856gui.blamehistoryctx::1857 Specifies the radius of history context in days to show in1858 linkgit:gitk[1] for the selected commit, when the `Show History1859 Context` menu item is invoked from 'git gui blame'. If this1860 variable is set to zero, the whole history is shown.18611862guitool.<name>.cmd::1863 Specifies the shell command line to execute when the corresponding item1864 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1865 mandatory for every tool. The command is executed from the root of1866 the working directory, and in the environment it receives the name of1867 the tool as `GIT_GUITOOL`, the name of the currently selected file as1868 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1869 the head is detached, 'CUR_BRANCH' is empty).18701871guitool.<name>.needsFile::1872 Run the tool only if a diff is selected in the GUI. It guarantees1873 that 'FILENAME' is not empty.18741875guitool.<name>.noConsole::1876 Run the command silently, without creating a window to display its1877 output.18781879guitool.<name>.noRescan::1880 Don't rescan the working directory for changes after the tool1881 finishes execution.18821883guitool.<name>.confirm::1884 Show a confirmation dialog before actually running the tool.18851886guitool.<name>.argPrompt::1887 Request a string argument from the user, and pass it to the tool1888 through the `ARGS` environment variable. Since requesting an1889 argument implies confirmation, the 'confirm' option has no effect1890 if this is enabled. If the option is set to 'true', 'yes', or '1',1891 the dialog uses a built-in generic prompt; otherwise the exact1892 value of the variable is used.18931894guitool.<name>.revPrompt::1895 Request a single valid revision from the user, and set the1896 `REVISION` environment variable. In other aspects this option1897 is similar to 'argPrompt', and can be used together with it.18981899guitool.<name>.revUnmerged::1900 Show only unmerged branches in the 'revPrompt' subdialog.1901 This is useful for tools similar to merge or rebase, but not1902 for things like checkout or reset.19031904guitool.<name>.title::1905 Specifies the title to use for the prompt dialog. The default1906 is the tool name.19071908guitool.<name>.prompt::1909 Specifies the general prompt string to display at the top of1910 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1911 The default value includes the actual command.19121913help.browser::1914 Specify the browser that will be used to display help in the1915 'web' format. See linkgit:git-help[1].19161917help.format::1918 Override the default help format used by linkgit:git-help[1].1919 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1920 the default. 'web' and 'html' are the same.19211922help.autoCorrect::1923 Automatically correct and execute mistyped commands after1924 waiting for the given number of deciseconds (0.1 sec). If more1925 than one command can be deduced from the entered text, nothing1926 will be executed. If the value of this option is negative,1927 the corrected command will be executed immediately. If the1928 value is 0 - the command will be just shown but not executed.1929 This is the default.19301931help.htmlPath::1932 Specify the path where the HTML documentation resides. File system paths1933 and URLs are supported. HTML pages will be prefixed with this path when1934 help is displayed in the 'web' format. This defaults to the documentation1935 path of your Git installation.19361937http.proxy::1938 Override the HTTP proxy, normally configured using the 'http_proxy',1939 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1940 addition to the syntax understood by curl, it is possible to specify a1941 proxy string with a user name but no password, in which case git will1942 attempt to acquire one in the same way it does for other credentials. See1943 linkgit:gitcredentials[7] for more information. The syntax thus is1944 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1945 on a per-remote basis; see remote.<name>.proxy19461947http.proxyAuthMethod::1948 Set the method with which to authenticate against the HTTP proxy. This1949 only takes effect if the configured proxy string contains a user name part1950 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1951 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1952 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1953 variable. Possible values are:1954+1955--1956* `anyauth` - Automatically pick a suitable authentication method. It is1957 assumed that the proxy answers an unauthenticated request with a 4071958 status code and one or more Proxy-authenticate headers with supported1959 authentication methods. This is the default.1960* `basic` - HTTP Basic authentication1961* `digest` - HTTP Digest authentication; this prevents the password from being1962 transmitted to the proxy in clear text1963* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1964 of `curl(1)`)1965* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1966--19671968http.emptyAuth::1969 Attempt authentication without seeking a username or password. This1970 can be used to attempt GSS-Negotiate authentication without specifying1971 a username in the URL, as libcurl normally requires a username for1972 authentication.19731974http.delegation::1975 Control GSSAPI credential delegation. The delegation is disabled1976 by default in libcurl since version 7.21.7. Set parameter to tell1977 the server what it is allowed to delegate when it comes to user1978 credentials. Used with GSS/kerberos. Possible values are:1979+1980--1981* `none` - Don't allow any delegation.1982* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1983 Kerberos service ticket, which is a matter of realm policy.1984* `always` - Unconditionally allow the server to delegate.1985--198619871988http.extraHeader::1989 Pass an additional HTTP header when communicating with a server. If1990 more than one such entry exists, all of them are added as extra1991 headers. To allow overriding the settings inherited from the system1992 config, an empty value will reset the extra headers to the empty list.19931994http.cookieFile::1995 The pathname of a file containing previously stored cookie lines,1996 which should be used1997 in the Git http session, if they match the server. The file format1998 of the file to read cookies from should be plain HTTP headers or1999 the Netscape/Mozilla cookie file format (see `curl(1)`).2000 NOTE that the file specified with http.cookieFile is used only as2001 input unless http.saveCookies is set.20022003http.saveCookies::2004 If set, store cookies received during requests to the file specified by2005 http.cookieFile. Has no effect if http.cookieFile is unset.20062007http.sslVersion::2008 The SSL version to use when negotiating an SSL connection, if you2009 want to force the default. The available and default version2010 depend on whether libcurl was built against NSS or OpenSSL and the2011 particular configuration of the crypto library in use. Internally2012 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2013 documentation for more details on the format of this option and2014 for the ssl version supported. Actually the possible values of2015 this option are:20162017 - sslv22018 - sslv32019 - tlsv12020 - tlsv1.02021 - tlsv1.12022 - tlsv1.22023 - tlsv1.320242025+2026Can be overridden by the `GIT_SSL_VERSION` environment variable.2027To force git to use libcurl's default ssl version and ignore any2028explicit http.sslversion option, set `GIT_SSL_VERSION` to the2029empty string.20302031http.sslCipherList::2032 A list of SSL ciphers to use when negotiating an SSL connection.2033 The available ciphers depend on whether libcurl was built against2034 NSS or OpenSSL and the particular configuration of the crypto2035 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2036 option; see the libcurl documentation for more details on the format2037 of this list.2038+2039Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2040To force git to use libcurl's default cipher list and ignore any2041explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2042empty string.20432044http.sslVerify::2045 Whether to verify the SSL certificate when fetching or pushing2046 over HTTPS. Defaults to true. Can be overridden by the2047 `GIT_SSL_NO_VERIFY` environment variable.20482049http.sslCert::2050 File containing the SSL certificate when fetching or pushing2051 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2052 variable.20532054http.sslKey::2055 File containing the SSL private key when fetching or pushing2056 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2057 variable.20582059http.sslCertPasswordProtected::2060 Enable Git's password prompt for the SSL certificate. Otherwise2061 OpenSSL will prompt the user, possibly many times, if the2062 certificate or private key is encrypted. Can be overridden by the2063 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20642065http.sslCAInfo::2066 File containing the certificates to verify the peer with when2067 fetching or pushing over HTTPS. Can be overridden by the2068 `GIT_SSL_CAINFO` environment variable.20692070http.sslCAPath::2071 Path containing files with the CA certificates to verify the peer2072 with when fetching or pushing over HTTPS. Can be overridden2073 by the `GIT_SSL_CAPATH` environment variable.20742075http.pinnedpubkey::2076 Public key of the https service. It may either be the filename of2077 a PEM or DER encoded public key file or a string starting with2078 'sha256//' followed by the base64 encoded sha256 hash of the2079 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2080 exit with an error if this option is set but not supported by2081 cURL.20822083http.sslTry::2084 Attempt to use AUTH SSL/TLS and encrypted data transfers2085 when connecting via regular FTP protocol. This might be needed2086 if the FTP server requires it for security reasons or you wish2087 to connect securely whenever remote FTP server supports it.2088 Default is false since it might trigger certificate verification2089 errors on misconfigured servers.20902091http.maxRequests::2092 How many HTTP requests to launch in parallel. Can be overridden2093 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20942095http.minSessions::2096 The number of curl sessions (counted across slots) to be kept across2097 requests. They will not be ended with curl_easy_cleanup() until2098 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2099 value will be capped at 1. Defaults to 1.21002101http.postBuffer::2102 Maximum size in bytes of the buffer used by smart HTTP2103 transports when POSTing data to the remote system.2104 For requests larger than this buffer size, HTTP/1.1 and2105 Transfer-Encoding: chunked is used to avoid creating a2106 massive pack file locally. Default is 1 MiB, which is2107 sufficient for most requests.21082109http.lowSpeedLimit, http.lowSpeedTime::2110 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2111 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2112 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2113 `GIT_HTTP_LOW_SPEED_TIME` environment variables.21142115http.noEPSV::2116 A boolean which disables using of EPSV ftp command by curl.2117 This can helpful with some "poor" ftp servers which don't2118 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2119 environment variable. Default is false (curl will use EPSV).21202121http.userAgent::2122 The HTTP USER_AGENT string presented to an HTTP server. The default2123 value represents the version of the client Git such as git/1.7.1.2124 This option allows you to override this value to a more common value2125 such as Mozilla/4.0. This may be necessary, for instance, if2126 connecting through a firewall that restricts HTTP connections to a set2127 of common USER_AGENT strings (but not including those like git/1.7.1).2128 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.21292130http.followRedirects::2131 Whether git should follow HTTP redirects. If set to `true`, git2132 will transparently follow any redirect issued by a server it2133 encounters. If set to `false`, git will treat all redirects as2134 errors. If set to `initial`, git will follow redirects only for2135 the initial request to a remote, but not for subsequent2136 follow-up HTTP requests. Since git uses the redirected URL as2137 the base for the follow-up requests, this is generally2138 sufficient. The default is `initial`.21392140http.<url>.*::2141 Any of the http.* options above can be applied selectively to some URLs.2142 For a config key to match a URL, each element of the config key is2143 compared to that of the URL, in the following order:2144+2145--2146. Scheme (e.g., `https` in `https://example.com/`). This field2147 must match exactly between the config key and the URL.21482149. Host/domain name (e.g., `example.com` in `https://example.com/`).2150 This field must match between the config key and the URL. It is2151 possible to specify a `*` as part of the host name to match all subdomains2152 at this level. `https://*.example.com/` for example would match2153 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21542155. Port number (e.g., `8080` in `http://example.com:8080/`).2156 This field must match exactly between the config key and the URL.2157 Omitted port numbers are automatically converted to the correct2158 default for the scheme before matching.21592160. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2161 path field of the config key must match the path field of the URL2162 either exactly or as a prefix of slash-delimited path elements. This means2163 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2164 match on a slash (`/`) boundary. Longer matches take precedence (so a config2165 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2166 key with just path `foo/`).21672168. User name (e.g., `user` in `https://user@example.com/repo.git`). If2169 the config key has a user name it must match the user name in the2170 URL exactly. If the config key does not have a user name, that2171 config key will match a URL with any user name (including none),2172 but at a lower precedence than a config key with a user name.2173--2174+2175The list above is ordered by decreasing precedence; a URL that matches2176a config key's path is preferred to one that matches its user name. For example,2177if the URL is `https://user@example.com/foo/bar` a config key match of2178`https://example.com/foo` will be preferred over a config key match of2179`https://user@example.com`.2180+2181All URLs are normalized before attempting any matching (the password part,2182if embedded in the URL, is always ignored for matching purposes) so that2183equivalent URLs that are simply spelled differently will match properly.2184Environment variable settings always override any matches. The URLs that are2185matched against are those given directly to Git commands. This means any URLs2186visited as a result of a redirection do not participate in matching.21872188ssh.variant::2189 By default, Git determines the command line arguments to use2190 based on the basename of the configured SSH command (configured2191 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2192 the config setting `core.sshCommand`). If the basename is2193 unrecognized, Git will attempt to detect support of OpenSSH2194 options by first invoking the configured SSH command with the2195 `-G` (print configuration) option and will subsequently use2196 OpenSSH options (if that is successful) or no options besides2197 the host and remote command (if it fails).2198+2199The config variable `ssh.variant` can be set to override this detection.2200Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2201`tortoiseplink`, `simple` (no options except the host and remote command).2202The default auto-detection can be explicitly requested using the value2203`auto`. Any other value is treated as `ssh`. This setting can also be2204overridden via the environment variable `GIT_SSH_VARIANT`.2205+2206The current command-line parameters used for each variant are as2207follows:2208+2209--22102211* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command22122213* `simple` - [username@]host command22142215* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command22162217* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command22182219--2220+2221Except for the `simple` variant, command-line parameters are likely to2222change as git gains new features.22232224i18n.commitEncoding::2225 Character encoding the commit messages are stored in; Git itself2226 does not care per se, but this information is necessary e.g. when2227 importing commits from emails or in the gitk graphical history2228 browser (and possibly at other places in the future or in other2229 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.22302231i18n.logOutputEncoding::2232 Character encoding the commit messages are converted to when2233 running 'git log' and friends.22342235imap::2236 The configuration variables in the 'imap' section are described2237 in linkgit:git-imap-send[1].22382239index.version::2240 Specify the version with which new index files should be2241 initialized. This does not affect existing repositories.22422243init.templateDir::2244 Specify the directory from which templates will be copied.2245 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22462247instaweb.browser::2248 Specify the program that will be used to browse your working2249 repository in gitweb. See linkgit:git-instaweb[1].22502251instaweb.httpd::2252 The HTTP daemon command-line to start gitweb on your working2253 repository. See linkgit:git-instaweb[1].22542255instaweb.local::2256 If true the web server started by linkgit:git-instaweb[1] will2257 be bound to the local IP (127.0.0.1).22582259instaweb.modulePath::2260 The default module path for linkgit:git-instaweb[1] to use2261 instead of /usr/lib/apache2/modules. Only used if httpd2262 is Apache.22632264instaweb.port::2265 The port number to bind the gitweb httpd to. See2266 linkgit:git-instaweb[1].22672268interactive.singleKey::2269 In interactive commands, allow the user to provide one-letter2270 input with a single key (i.e., without hitting enter).2271 Currently this is used by the `--patch` mode of2272 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2273 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2274 setting is silently ignored if portable keystroke input2275 is not available; requires the Perl module Term::ReadKey.22762277interactive.diffFilter::2278 When an interactive command (such as `git add --patch`) shows2279 a colorized diff, git will pipe the diff through the shell2280 command defined by this configuration variable. The command may2281 mark up the diff further for human consumption, provided that it2282 retains a one-to-one correspondence with the lines in the2283 original diff. Defaults to disabled (no filtering).22842285log.abbrevCommit::2286 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2287 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2288 override this option with `--no-abbrev-commit`.22892290log.date::2291 Set the default date-time mode for the 'log' command.2292 Setting a value for log.date is similar to using 'git log''s2293 `--date` option. See linkgit:git-log[1] for details.22942295log.decorate::2296 Print out the ref names of any commits that are shown by the log2297 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2298 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2299 specified, the full ref name (including prefix) will be printed.2300 If 'auto' is specified, then if the output is going to a terminal,2301 the ref names are shown as if 'short' were given, otherwise no ref2302 names are shown. This is the same as the `--decorate` option2303 of the `git log`.23042305log.follow::2306 If `true`, `git log` will act as if the `--follow` option was used when2307 a single <path> is given. This has the same limitations as `--follow`,2308 i.e. it cannot be used to follow multiple files and does not work well2309 on non-linear history.23102311log.graphColors::2312 A list of colors, separated by commas, that can be used to draw2313 history lines in `git log --graph`.23142315log.showRoot::2316 If true, the initial commit will be shown as a big creation event.2317 This is equivalent to a diff against an empty tree.2318 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2319 normally hide the root commit will now show it. True by default.23202321log.showSignature::2322 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2323 linkgit:git-whatchanged[1] assume `--show-signature`.23242325log.mailmap::2326 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2327 linkgit:git-whatchanged[1] assume `--use-mailmap`.23282329mailinfo.scissors::2330 If true, makes linkgit:git-mailinfo[1] (and therefore2331 linkgit:git-am[1]) act by default as if the --scissors option2332 was provided on the command-line. When active, this features2333 removes everything from the message body before a scissors2334 line (i.e. consisting mainly of ">8", "8<" and "-").23352336mailmap.file::2337 The location of an augmenting mailmap file. The default2338 mailmap, located in the root of the repository, is loaded2339 first, then the mailmap file pointed to by this variable.2340 The location of the mailmap file may be in a repository2341 subdirectory, or somewhere outside of the repository itself.2342 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23432344mailmap.blob::2345 Like `mailmap.file`, but consider the value as a reference to a2346 blob in the repository. If both `mailmap.file` and2347 `mailmap.blob` are given, both are parsed, with entries from2348 `mailmap.file` taking precedence. In a bare repository, this2349 defaults to `HEAD:.mailmap`. In a non-bare repository, it2350 defaults to empty.23512352man.viewer::2353 Specify the programs that may be used to display help in the2354 'man' format. See linkgit:git-help[1].23552356man.<tool>.cmd::2357 Specify the command to invoke the specified man viewer. The2358 specified command is evaluated in shell with the man page2359 passed as argument. (See linkgit:git-help[1].)23602361man.<tool>.path::2362 Override the path for the given tool that may be used to2363 display help in the 'man' format. See linkgit:git-help[1].23642365include::merge-config.txt[]23662367mergetool.<tool>.path::2368 Override the path for the given tool. This is useful in case2369 your tool is not in the PATH.23702371mergetool.<tool>.cmd::2372 Specify the command to invoke the specified merge tool. The2373 specified command is evaluated in shell with the following2374 variables available: 'BASE' is the name of a temporary file2375 containing the common base of the files to be merged, if available;2376 'LOCAL' is the name of a temporary file containing the contents of2377 the file on the current branch; 'REMOTE' is the name of a temporary2378 file containing the contents of the file from the branch being2379 merged; 'MERGED' contains the name of the file to which the merge2380 tool should write the results of a successful merge.23812382mergetool.<tool>.trustExitCode::2383 For a custom merge command, specify whether the exit code of2384 the merge command can be used to determine whether the merge was2385 successful. If this is not set to true then the merge target file2386 timestamp is checked and the merge assumed to have been successful2387 if the file has been updated, otherwise the user is prompted to2388 indicate the success of the merge.23892390mergetool.meld.hasOutput::2391 Older versions of `meld` do not support the `--output` option.2392 Git will attempt to detect whether `meld` supports `--output`2393 by inspecting the output of `meld --help`. Configuring2394 `mergetool.meld.hasOutput` will make Git skip these checks and2395 use the configured value instead. Setting `mergetool.meld.hasOutput`2396 to `true` tells Git to unconditionally use the `--output` option,2397 and `false` avoids using `--output`.23982399mergetool.keepBackup::2400 After performing a merge, the original file with conflict markers2401 can be saved as a file with a `.orig` extension. If this variable2402 is set to `false` then this file is not preserved. Defaults to2403 `true` (i.e. keep the backup files).24042405mergetool.keepTemporaries::2406 When invoking a custom merge tool, Git uses a set of temporary2407 files to pass to the tool. If the tool returns an error and this2408 variable is set to `true`, then these temporary files will be2409 preserved, otherwise they will be removed after the tool has2410 exited. Defaults to `false`.24112412mergetool.writeToTemp::2413 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2414 conflicting files in the worktree by default. Git will attempt2415 to use a temporary directory for these files when set `true`.2416 Defaults to `false`.24172418mergetool.prompt::2419 Prompt before each invocation of the merge resolution program.24202421notes.mergeStrategy::2422 Which merge strategy to choose by default when resolving notes2423 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2424 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2425 section of linkgit:git-notes[1] for more information on each strategy.24262427notes.<name>.mergeStrategy::2428 Which merge strategy to choose when doing a notes merge into2429 refs/notes/<name>. This overrides the more general2430 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2431 linkgit:git-notes[1] for more information on the available strategies.24322433notes.displayRef::2434 The (fully qualified) refname from which to show notes when2435 showing commit messages. The value of this variable can be set2436 to a glob, in which case notes from all matching refs will be2437 shown. You may also specify this configuration variable2438 several times. A warning will be issued for refs that do not2439 exist, but a glob that does not match any refs is silently2440 ignored.2441+2442This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2443environment variable, which must be a colon separated list of refs or2444globs.2445+2446The effective value of "core.notesRef" (possibly overridden by2447GIT_NOTES_REF) is also implicitly added to the list of refs to be2448displayed.24492450notes.rewrite.<command>::2451 When rewriting commits with <command> (currently `amend` or2452 `rebase`) and this variable is set to `true`, Git2453 automatically copies your notes from the original to the2454 rewritten commit. Defaults to `true`, but see2455 "notes.rewriteRef" below.24562457notes.rewriteMode::2458 When copying notes during a rewrite (see the2459 "notes.rewrite.<command>" option), determines what to do if2460 the target commit already has a note. Must be one of2461 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2462 Defaults to `concatenate`.2463+2464This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2465environment variable.24662467notes.rewriteRef::2468 When copying notes during a rewrite, specifies the (fully2469 qualified) ref whose notes should be copied. The ref may be a2470 glob, in which case notes in all matching refs will be copied.2471 You may also specify this configuration several times.2472+2473Does not have a default value; you must configure this variable to2474enable note rewriting. Set it to `refs/notes/commits` to enable2475rewriting for the default commit notes.2476+2477This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2478environment variable, which must be a colon separated list of refs or2479globs.24802481pack.window::2482 The size of the window used by linkgit:git-pack-objects[1] when no2483 window size is given on the command line. Defaults to 10.24842485pack.depth::2486 The maximum delta depth used by linkgit:git-pack-objects[1] when no2487 maximum depth is given on the command line. Defaults to 50.2488 Maximum value is 4095.24892490pack.windowMemory::2491 The maximum size of memory that is consumed by each thread2492 in linkgit:git-pack-objects[1] for pack window memory when2493 no limit is given on the command line. The value can be2494 suffixed with "k", "m", or "g". When left unconfigured (or2495 set explicitly to 0), there will be no limit.24962497pack.compression::2498 An integer -1..9, indicating the compression level for objects2499 in a pack file. -1 is the zlib default. 0 means no2500 compression, and 1..9 are various speed/size tradeoffs, 9 being2501 slowest. If not set, defaults to core.compression. If that is2502 not set, defaults to -1, the zlib default, which is "a default2503 compromise between speed and compression (currently equivalent2504 to level 6)."2505+2506Note that changing the compression level will not automatically recompress2507all existing objects. You can force recompression by passing the -F option2508to linkgit:git-repack[1].25092510pack.deltaCacheSize::2511 The maximum memory in bytes used for caching deltas in2512 linkgit:git-pack-objects[1] before writing them out to a pack.2513 This cache is used to speed up the writing object phase by not2514 having to recompute the final delta result once the best match2515 for all objects is found. Repacking large repositories on machines2516 which are tight with memory might be badly impacted by this though,2517 especially if this cache pushes the system into swapping.2518 A value of 0 means no limit. The smallest size of 1 byte may be2519 used to virtually disable this cache. Defaults to 256 MiB.25202521pack.deltaCacheLimit::2522 The maximum size of a delta, that is cached in2523 linkgit:git-pack-objects[1]. This cache is used to speed up the2524 writing object phase by not having to recompute the final delta2525 result once the best match for all objects is found.2526 Defaults to 1000. Maximum value is 65535.25272528pack.threads::2529 Specifies the number of threads to spawn when searching for best2530 delta matches. This requires that linkgit:git-pack-objects[1]2531 be compiled with pthreads otherwise this option is ignored with a2532 warning. This is meant to reduce packing time on multiprocessor2533 machines. The required amount of memory for the delta search window2534 is however multiplied by the number of threads.2535 Specifying 0 will cause Git to auto-detect the number of CPU's2536 and set the number of threads accordingly.25372538pack.indexVersion::2539 Specify the default pack index version. Valid values are 1 for2540 legacy pack index used by Git versions prior to 1.5.2, and 2 for2541 the new pack index with capabilities for packs larger than 4 GB2542 as well as proper protection against the repacking of corrupted2543 packs. Version 2 is the default. Note that version 2 is enforced2544 and this config option ignored whenever the corresponding pack is2545 larger than 2 GB.2546+2547If you have an old Git that does not understand the version 2 `*.idx` file,2548cloning or fetching over a non native protocol (e.g. "http")2549that will copy both `*.pack` file and corresponding `*.idx` file from the2550other side may give you a repository that cannot be accessed with your2551older version of Git. If the `*.pack` file is smaller than 2 GB, however,2552you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2553the `*.idx` file.25542555pack.packSizeLimit::2556 The maximum size of a pack. This setting only affects2557 packing to a file when repacking, i.e. the git:// protocol2558 is unaffected. It can be overridden by the `--max-pack-size`2559 option of linkgit:git-repack[1]. Reaching this limit results2560 in the creation of multiple packfiles; which in turn prevents2561 bitmaps from being created.2562 The minimum size allowed is limited to 1 MiB.2563 The default is unlimited.2564 Common unit suffixes of 'k', 'm', or 'g' are2565 supported.25662567pack.useBitmaps::2568 When true, git will use pack bitmaps (if available) when packing2569 to stdout (e.g., during the server side of a fetch). Defaults to2570 true. You should not generally need to turn this off unless2571 you are debugging pack bitmaps.25722573pack.writeBitmaps (deprecated)::2574 This is a deprecated synonym for `repack.writeBitmaps`.25752576pack.writeBitmapHashCache::2577 When true, git will include a "hash cache" section in the bitmap2578 index (if one is written). This cache can be used to feed git's2579 delta heuristics, potentially leading to better deltas between2580 bitmapped and non-bitmapped objects (e.g., when serving a fetch2581 between an older, bitmapped pack and objects that have been2582 pushed since the last gc). The downside is that it consumes 42583 bytes per object of disk space, and that JGit's bitmap2584 implementation does not understand it, causing it to complain if2585 Git and JGit are used on the same repository. Defaults to false.25862587pager.<cmd>::2588 If the value is boolean, turns on or off pagination of the2589 output of a particular Git subcommand when writing to a tty.2590 Otherwise, turns on pagination for the subcommand using the2591 pager specified by the value of `pager.<cmd>`. If `--paginate`2592 or `--no-pager` is specified on the command line, it takes2593 precedence over this option. To disable pagination for all2594 commands, set `core.pager` or `GIT_PAGER` to `cat`.25952596pretty.<name>::2597 Alias for a --pretty= format string, as specified in2598 linkgit:git-log[1]. Any aliases defined here can be used just2599 as the built-in pretty formats could. For example,2600 running `git config pretty.changelog "format:* %H %s"`2601 would cause the invocation `git log --pretty=changelog`2602 to be equivalent to running `git log "--pretty=format:* %H %s"`.2603 Note that an alias with the same name as a built-in format2604 will be silently ignored.26052606protocol.allow::2607 If set, provide a user defined default policy for all protocols which2608 don't explicitly have a policy (`protocol.<name>.allow`). By default,2609 if unset, known-safe protocols (http, https, git, ssh, file) have a2610 default policy of `always`, known-dangerous protocols (ext) have a2611 default policy of `never`, and all other protocols have a default2612 policy of `user`. Supported policies:2613+2614--26152616* `always` - protocol is always able to be used.26172618* `never` - protocol is never able to be used.26192620* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2621 either unset or has a value of 1. This policy should be used when you want a2622 protocol to be directly usable by the user but don't want it used by commands which2623 execute clone/fetch/push commands without user input, e.g. recursive2624 submodule initialization.26252626--26272628protocol.<name>.allow::2629 Set a policy to be used by protocol `<name>` with clone/fetch/push2630 commands. See `protocol.allow` above for the available policies.2631+2632The protocol names currently used by git are:2633+2634--2635 - `file`: any local file-based path (including `file://` URLs,2636 or local paths)26372638 - `git`: the anonymous git protocol over a direct TCP2639 connection (or proxy, if configured)26402641 - `ssh`: git over ssh (including `host:path` syntax,2642 `ssh://`, etc).26432644 - `http`: git over http, both "smart http" and "dumb http".2645 Note that this does _not_ include `https`; if you want to configure2646 both, you must do so individually.26472648 - any external helpers are named by their protocol (e.g., use2649 `hg` to allow the `git-remote-hg` helper)2650--26512652protocol.version::2653 Experimental. If set, clients will attempt to communicate with a2654 server using the specified protocol version. If unset, no2655 attempt will be made by the client to communicate using a2656 particular protocol version, this results in protocol version 02657 being used.2658 Supported versions:2659+2660--26612662* `0` - the original wire protocol.26632664* `1` - the original wire protocol with the addition of a version string2665 in the initial response from the server.26662667--26682669pull.ff::2670 By default, Git does not create an extra merge commit when merging2671 a commit that is a descendant of the current commit. Instead, the2672 tip of the current branch is fast-forwarded. When set to `false`,2673 this variable tells Git to create an extra merge commit in such2674 a case (equivalent to giving the `--no-ff` option from the command2675 line). When set to `only`, only such fast-forward merges are2676 allowed (equivalent to giving the `--ff-only` option from the2677 command line). This setting overrides `merge.ff` when pulling.26782679pull.rebase::2680 When true, rebase branches on top of the fetched branch, instead2681 of merging the default branch from the default remote when "git2682 pull" is run. See "branch.<name>.rebase" for setting this on a2683 per-branch basis.2684+2685When `merges`, pass the `--rebase-merges` option to 'git rebase'2686so that the local merge commits are included in the rebase (see2687linkgit:git-rebase[1] for details).2688+2689When preserve, also pass `--preserve-merges` along to 'git rebase'2690so that locally committed merge commits will not be flattened2691by running 'git pull'.2692+2693When the value is `interactive`, the rebase is run in interactive mode.2694+2695*NOTE*: this is a possibly dangerous operation; do *not* use2696it unless you understand the implications (see linkgit:git-rebase[1]2697for details).26982699pull.octopus::2700 The default merge strategy to use when pulling multiple branches2701 at once.27022703pull.twohead::2704 The default merge strategy to use when pulling a single branch.27052706push.default::2707 Defines the action `git push` should take if no refspec is2708 explicitly given. Different values are well-suited for2709 specific workflows; for instance, in a purely central workflow2710 (i.e. the fetch source is equal to the push destination),2711 `upstream` is probably what you want. Possible values are:2712+2713--27142715* `nothing` - do not push anything (error out) unless a refspec is2716 explicitly given. This is primarily meant for people who want to2717 avoid mistakes by always being explicit.27182719* `current` - push the current branch to update a branch with the same2720 name on the receiving end. Works in both central and non-central2721 workflows.27222723* `upstream` - push the current branch back to the branch whose2724 changes are usually integrated into the current branch (which is2725 called `@{upstream}`). This mode only makes sense if you are2726 pushing to the same repository you would normally pull from2727 (i.e. central workflow).27282729* `tracking` - This is a deprecated synonym for `upstream`.27302731* `simple` - in centralized workflow, work like `upstream` with an2732 added safety to refuse to push if the upstream branch's name is2733 different from the local one.2734+2735When pushing to a remote that is different from the remote you normally2736pull from, work as `current`. This is the safest option and is suited2737for beginners.2738+2739This mode has become the default in Git 2.0.27402741* `matching` - push all branches having the same name on both ends.2742 This makes the repository you are pushing to remember the set of2743 branches that will be pushed out (e.g. if you always push 'maint'2744 and 'master' there and no other branches, the repository you push2745 to will have these two branches, and your local 'maint' and2746 'master' will be pushed there).2747+2748To use this mode effectively, you have to make sure _all_ the2749branches you would push out are ready to be pushed out before2750running 'git push', as the whole point of this mode is to allow you2751to push all of the branches in one go. If you usually finish work2752on only one branch and push out the result, while other branches are2753unfinished, this mode is not for you. Also this mode is not2754suitable for pushing into a shared central repository, as other2755people may add new branches there, or update the tip of existing2756branches outside your control.2757+2758This used to be the default, but not since Git 2.0 (`simple` is the2759new default).27602761--27622763push.followTags::2764 If set to true enable `--follow-tags` option by default. You2765 may override this configuration at time of push by specifying2766 `--no-follow-tags`.27672768push.gpgSign::2769 May be set to a boolean value, or the string 'if-asked'. A true2770 value causes all pushes to be GPG signed, as if `--signed` is2771 passed to linkgit:git-push[1]. The string 'if-asked' causes2772 pushes to be signed if the server supports it, as if2773 `--signed=if-asked` is passed to 'git push'. A false value may2774 override a value from a lower-priority config file. An explicit2775 command-line flag always overrides this config option.27762777push.pushOption::2778 When no `--push-option=<option>` argument is given from the2779 command line, `git push` behaves as if each <value> of2780 this variable is given as `--push-option=<value>`.2781+2782This is a multi-valued variable, and an empty value can be used in a2783higher priority configuration file (e.g. `.git/config` in a2784repository) to clear the values inherited from a lower priority2785configuration files (e.g. `$HOME/.gitconfig`).2786+2787--27882789Example:27902791/etc/gitconfig2792 push.pushoption = a2793 push.pushoption = b27942795~/.gitconfig2796 push.pushoption = c27972798repo/.git/config2799 push.pushoption =2800 push.pushoption = b28012802This will result in only b (a and c are cleared).28032804--28052806push.recurseSubmodules::2807 Make sure all submodule commits used by the revisions to be pushed2808 are available on a remote-tracking branch. If the value is 'check'2809 then Git will verify that all submodule commits that changed in the2810 revisions to be pushed are available on at least one remote of the2811 submodule. If any commits are missing, the push will be aborted and2812 exit with non-zero status. If the value is 'on-demand' then all2813 submodules that changed in the revisions to be pushed will be2814 pushed. If on-demand was not able to push all necessary revisions2815 it will also be aborted and exit with non-zero status. If the value2816 is 'no' then default behavior of ignoring submodules when pushing2817 is retained. You may override this configuration at time of push by2818 specifying '--recurse-submodules=check|on-demand|no'.28192820include::rebase-config.txt[]28212822receive.advertiseAtomic::2823 By default, git-receive-pack will advertise the atomic push2824 capability to its clients. If you don't want to advertise this2825 capability, set this variable to false.28262827receive.advertisePushOptions::2828 When set to true, git-receive-pack will advertise the push options2829 capability to its clients. False by default.28302831receive.autogc::2832 By default, git-receive-pack will run "git-gc --auto" after2833 receiving data from git-push and updating refs. You can stop2834 it by setting this variable to false.28352836receive.certNonceSeed::2837 By setting this variable to a string, `git receive-pack`2838 will accept a `git push --signed` and verifies it by using2839 a "nonce" protected by HMAC using this string as a secret2840 key.28412842receive.certNonceSlop::2843 When a `git push --signed` sent a push certificate with a2844 "nonce" that was issued by a receive-pack serving the same2845 repository within this many seconds, export the "nonce"2846 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2847 hooks (instead of what the receive-pack asked the sending2848 side to include). This may allow writing checks in2849 `pre-receive` and `post-receive` a bit easier. Instead of2850 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2851 that records by how many seconds the nonce is stale to2852 decide if they want to accept the certificate, they only2853 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.28542855receive.fsckObjects::2856 If it is set to true, git-receive-pack will check all received2857 objects. It will abort in the case of a malformed object or a2858 broken link. The result of an abort are only dangling objects.2859 Defaults to false. If not set, the value of `transfer.fsckObjects`2860 is used instead.28612862receive.fsck.<msg-id>::2863 When `receive.fsckObjects` is set to true, errors can be switched2864 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2865 setting where the `<msg-id>` is the fsck message ID and the value2866 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2867 the error/warning with the message ID, e.g. "missingEmail: invalid2868 author/committer line - missing email" means that setting2869 `receive.fsck.missingEmail = ignore` will hide that issue.2870+2871This feature is intended to support working with legacy repositories2872which would not pass pushing when `receive.fsckObjects = true`, allowing2873the host to accept repositories with certain known issues but still catch2874other issues.28752876receive.fsck.skipList::2877 The path to a sorted list of object names (i.e. one SHA-1 per2878 line) that are known to be broken in a non-fatal way and should2879 be ignored. This feature is useful when an established project2880 should be accepted despite early commits containing errors that2881 can be safely ignored such as invalid committer email addresses.2882 Note: corrupt objects cannot be skipped with this setting.28832884receive.keepAlive::2885 After receiving the pack from the client, `receive-pack` may2886 produce no output (if `--quiet` was specified) while processing2887 the pack, causing some networks to drop the TCP connection.2888 With this option set, if `receive-pack` does not transmit2889 any data in this phase for `receive.keepAlive` seconds, it will2890 send a short keepalive packet. The default is 5 seconds; set2891 to 0 to disable keepalives entirely.28922893receive.unpackLimit::2894 If the number of objects received in a push is below this2895 limit then the objects will be unpacked into loose object2896 files. However if the number of received objects equals or2897 exceeds this limit then the received pack will be stored as2898 a pack, after adding any missing delta bases. Storing the2899 pack from a push can make the push operation complete faster,2900 especially on slow filesystems. If not set, the value of2901 `transfer.unpackLimit` is used instead.29022903receive.maxInputSize::2904 If the size of the incoming pack stream is larger than this2905 limit, then git-receive-pack will error out, instead of2906 accepting the pack file. If not set or set to 0, then the size2907 is unlimited.29082909receive.denyDeletes::2910 If set to true, git-receive-pack will deny a ref update that deletes2911 the ref. Use this to prevent such a ref deletion via a push.29122913receive.denyDeleteCurrent::2914 If set to true, git-receive-pack will deny a ref update that2915 deletes the currently checked out branch of a non-bare repository.29162917receive.denyCurrentBranch::2918 If set to true or "refuse", git-receive-pack will deny a ref update2919 to the currently checked out branch of a non-bare repository.2920 Such a push is potentially dangerous because it brings the HEAD2921 out of sync with the index and working tree. If set to "warn",2922 print a warning of such a push to stderr, but allow the push to2923 proceed. If set to false or "ignore", allow such pushes with no2924 message. Defaults to "refuse".2925+2926Another option is "updateInstead" which will update the working2927tree if pushing into the current branch. This option is2928intended for synchronizing working directories when one side is not easily2929accessible via interactive ssh (e.g. a live web site, hence the requirement2930that the working directory be clean). This mode also comes in handy when2931developing inside a VM to test and fix code on different Operating Systems.2932+2933By default, "updateInstead" will refuse the push if the working tree or2934the index have any difference from the HEAD, but the `push-to-checkout`2935hook can be used to customize this. See linkgit:githooks[5].29362937receive.denyNonFastForwards::2938 If set to true, git-receive-pack will deny a ref update which is2939 not a fast-forward. Use this to prevent such an update via a push,2940 even if that push is forced. This configuration variable is2941 set when initializing a shared repository.29422943receive.hideRefs::2944 This variable is the same as `transfer.hideRefs`, but applies2945 only to `receive-pack` (and so affects pushes, but not fetches).2946 An attempt to update or delete a hidden ref by `git push` is2947 rejected.29482949receive.updateServerInfo::2950 If set to true, git-receive-pack will run git-update-server-info2951 after receiving data from git-push and updating refs.29522953receive.shallowUpdate::2954 If set to true, .git/shallow can be updated when new refs2955 require new shallow roots. Otherwise those refs are rejected.29562957remote.pushDefault::2958 The remote to push to by default. Overrides2959 `branch.<name>.remote` for all branches, and is overridden by2960 `branch.<name>.pushRemote` for specific branches.29612962remote.<name>.url::2963 The URL of a remote repository. See linkgit:git-fetch[1] or2964 linkgit:git-push[1].29652966remote.<name>.pushurl::2967 The push URL of a remote repository. See linkgit:git-push[1].29682969remote.<name>.proxy::2970 For remotes that require curl (http, https and ftp), the URL to2971 the proxy to use for that remote. Set to the empty string to2972 disable proxying for that remote.29732974remote.<name>.proxyAuthMethod::2975 For remotes that require curl (http, https and ftp), the method to use for2976 authenticating against the proxy in use (probably set in2977 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29782979remote.<name>.fetch::2980 The default set of "refspec" for linkgit:git-fetch[1]. See2981 linkgit:git-fetch[1].29822983remote.<name>.push::2984 The default set of "refspec" for linkgit:git-push[1]. See2985 linkgit:git-push[1].29862987remote.<name>.mirror::2988 If true, pushing to this remote will automatically behave2989 as if the `--mirror` option was given on the command line.29902991remote.<name>.skipDefaultUpdate::2992 If true, this remote will be skipped by default when updating2993 using linkgit:git-fetch[1] or the `update` subcommand of2994 linkgit:git-remote[1].29952996remote.<name>.skipFetchAll::2997 If true, this remote will be skipped by default when updating2998 using linkgit:git-fetch[1] or the `update` subcommand of2999 linkgit:git-remote[1].30003001remote.<name>.receivepack::3002 The default program to execute on the remote side when pushing. See3003 option --receive-pack of linkgit:git-push[1].30043005remote.<name>.uploadpack::3006 The default program to execute on the remote side when fetching. See3007 option --upload-pack of linkgit:git-fetch-pack[1].30083009remote.<name>.tagOpt::3010 Setting this value to --no-tags disables automatic tag following when3011 fetching from remote <name>. Setting it to --tags will fetch every3012 tag from remote <name>, even if they are not reachable from remote3013 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3014 override this setting. See options --tags and --no-tags of3015 linkgit:git-fetch[1].30163017remote.<name>.vcs::3018 Setting this to a value <vcs> will cause Git to interact with3019 the remote with the git-remote-<vcs> helper.30203021remote.<name>.prune::3022 When set to true, fetching from this remote by default will also3023 remove any remote-tracking references that no longer exist on the3024 remote (as if the `--prune` option was given on the command line).3025 Overrides `fetch.prune` settings, if any.30263027remote.<name>.pruneTags::3028 When set to true, fetching from this remote by default will also3029 remove any local tags that no longer exist on the remote if pruning3030 is activated in general via `remote.<name>.prune`, `fetch.prune` or3031 `--prune`. Overrides `fetch.pruneTags` settings, if any.3032+3033See also `remote.<name>.prune` and the PRUNING section of3034linkgit:git-fetch[1].30353036remotes.<group>::3037 The list of remotes which are fetched by "git remote update3038 <group>". See linkgit:git-remote[1].30393040repack.useDeltaBaseOffset::3041 By default, linkgit:git-repack[1] creates packs that use3042 delta-base offset. If you need to share your repository with3043 Git older than version 1.4.4, either directly or via a dumb3044 protocol such as http, then you need to set this option to3045 "false" and repack. Access from old Git versions over the3046 native protocol are unaffected by this option.30473048repack.packKeptObjects::3049 If set to true, makes `git repack` act as if3050 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3051 details. Defaults to `false` normally, but `true` if a bitmap3052 index is being written (either via `--write-bitmap-index` or3053 `repack.writeBitmaps`).30543055repack.writeBitmaps::3056 When true, git will write a bitmap index when packing all3057 objects to disk (e.g., when `git repack -a` is run). This3058 index can speed up the "counting objects" phase of subsequent3059 packs created for clones and fetches, at the cost of some disk3060 space and extra time spent on the initial repack. This has3061 no effect if multiple packfiles are created.3062 Defaults to false.30633064rerere.autoUpdate::3065 When set to true, `git-rerere` updates the index with the3066 resulting contents after it cleanly resolves conflicts using3067 previously recorded resolution. Defaults to false.30683069rerere.enabled::3070 Activate recording of resolved conflicts, so that identical3071 conflict hunks can be resolved automatically, should they be3072 encountered again. By default, linkgit:git-rerere[1] is3073 enabled if there is an `rr-cache` directory under the3074 `$GIT_DIR`, e.g. if "rerere" was previously used in the3075 repository.30763077sendemail.identity::3078 A configuration identity. When given, causes values in the3079 'sendemail.<identity>' subsection to take precedence over3080 values in the 'sendemail' section. The default identity is3081 the value of `sendemail.identity`.30823083sendemail.smtpEncryption::3084 See linkgit:git-send-email[1] for description. Note that this3085 setting is not subject to the 'identity' mechanism.30863087sendemail.smtpssl (deprecated)::3088 Deprecated alias for 'sendemail.smtpEncryption = ssl'.30893090sendemail.smtpsslcertpath::3091 Path to ca-certificates (either a directory or a single file).3092 Set it to an empty string to disable certificate verification.30933094sendemail.<identity>.*::3095 Identity-specific versions of the 'sendemail.*' parameters3096 found below, taking precedence over those when this3097 identity is selected, through either the command-line or3098 `sendemail.identity`.30993100sendemail.aliasesFile::3101sendemail.aliasFileType::3102sendemail.annotate::3103sendemail.bcc::3104sendemail.cc::3105sendemail.ccCmd::3106sendemail.chainReplyTo::3107sendemail.confirm::3108sendemail.envelopeSender::3109sendemail.from::3110sendemail.multiEdit::3111sendemail.signedoffbycc::3112sendemail.smtpPass::3113sendemail.suppresscc::3114sendemail.suppressFrom::3115sendemail.to::3116sendemail.tocmd::3117sendemail.smtpDomain::3118sendemail.smtpServer::3119sendemail.smtpServerPort::3120sendemail.smtpServerOption::3121sendemail.smtpUser::3122sendemail.thread::3123sendemail.transferEncoding::3124sendemail.validate::3125sendemail.xmailer::3126 See linkgit:git-send-email[1] for description.31273128sendemail.signedoffcc (deprecated)::3129 Deprecated alias for `sendemail.signedoffbycc`.31303131sendemail.smtpBatchSize::3132 Number of messages to be sent per connection, after that a relogin3133 will happen. If the value is 0 or undefined, send all messages in3134 one connection.3135 See also the `--batch-size` option of linkgit:git-send-email[1].31363137sendemail.smtpReloginDelay::3138 Seconds wait before reconnecting to smtp server.3139 See also the `--relogin-delay` option of linkgit:git-send-email[1].31403141showbranch.default::3142 The default set of branches for linkgit:git-show-branch[1].3143 See linkgit:git-show-branch[1].31443145splitIndex.maxPercentChange::3146 When the split index feature is used, this specifies the3147 percent of entries the split index can contain compared to the3148 total number of entries in both the split index and the shared3149 index before a new shared index is written.3150 The value should be between 0 and 100. If the value is 0 then3151 a new shared index is always written, if it is 100 a new3152 shared index is never written.3153 By default the value is 20, so a new shared index is written3154 if the number of entries in the split index would be greater3155 than 20 percent of the total number of entries.3156 See linkgit:git-update-index[1].31573158splitIndex.sharedIndexExpire::3159 When the split index feature is used, shared index files that3160 were not modified since the time this variable specifies will3161 be removed when a new shared index file is created. The value3162 "now" expires all entries immediately, and "never" suppresses3163 expiration altogether.3164 The default value is "2.weeks.ago".3165 Note that a shared index file is considered modified (for the3166 purpose of expiration) each time a new split-index file is3167 either created based on it or read from it.3168 See linkgit:git-update-index[1].31693170status.relativePaths::3171 By default, linkgit:git-status[1] shows paths relative to the3172 current directory. Setting this variable to `false` shows paths3173 relative to the repository root (this was the default for Git3174 prior to v1.5.4).31753176status.short::3177 Set to true to enable --short by default in linkgit:git-status[1].3178 The option --no-short takes precedence over this variable.31793180status.branch::3181 Set to true to enable --branch by default in linkgit:git-status[1].3182 The option --no-branch takes precedence over this variable.31833184status.displayCommentPrefix::3185 If set to true, linkgit:git-status[1] will insert a comment3186 prefix before each output line (starting with3187 `core.commentChar`, i.e. `#` by default). This was the3188 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3189 Defaults to false.31903191status.showStash::3192 If set to true, linkgit:git-status[1] will display the number of3193 entries currently stashed away.3194 Defaults to false.31953196status.showUntrackedFiles::3197 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3198 files which are not currently tracked by Git. Directories which3199 contain only untracked files, are shown with the directory name3200 only. Showing untracked files means that Git needs to lstat() all3201 the files in the whole repository, which might be slow on some3202 systems. So, this variable controls how the commands displays3203 the untracked files. Possible values are:3204+3205--3206* `no` - Show no untracked files.3207* `normal` - Show untracked files and directories.3208* `all` - Show also individual files in untracked directories.3209--3210+3211If this variable is not specified, it defaults to 'normal'.3212This variable can be overridden with the -u|--untracked-files option3213of linkgit:git-status[1] and linkgit:git-commit[1].32143215status.submoduleSummary::3216 Defaults to false.3217 If this is set to a non zero number or true (identical to -1 or an3218 unlimited number), the submodule summary will be enabled and a3219 summary of commits for modified submodules will be shown (see3220 --summary-limit option of linkgit:git-submodule[1]). Please note3221 that the summary output command will be suppressed for all3222 submodules when `diff.ignoreSubmodules` is set to 'all' or only3223 for those submodules where `submodule.<name>.ignore=all`. The only3224 exception to that rule is that status and commit will show staged3225 submodule changes. To3226 also view the summary for ignored submodules you can either use3227 the --ignore-submodules=dirty command-line option or the 'git3228 submodule summary' command, which shows a similar output but does3229 not honor these settings.32303231stash.showPatch::3232 If this is set to true, the `git stash show` command without an3233 option will show the stash entry in patch form. Defaults to false.3234 See description of 'show' command in linkgit:git-stash[1].32353236stash.showStat::3237 If this is set to true, the `git stash show` command without an3238 option will show diffstat of the stash entry. Defaults to true.3239 See description of 'show' command in linkgit:git-stash[1].32403241submodule.<name>.url::3242 The URL for a submodule. This variable is copied from the .gitmodules3243 file to the git config via 'git submodule init'. The user can change3244 the configured URL before obtaining the submodule via 'git submodule3245 update'. If neither submodule.<name>.active or submodule.active are3246 set, the presence of this variable is used as a fallback to indicate3247 whether the submodule is of interest to git commands.3248 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.32493250submodule.<name>.update::3251 The method by which a submodule is updated by 'git submodule update',3252 which is the only affected command, others such as3253 'git checkout --recurse-submodules' are unaffected. It exists for3254 historical reasons, when 'git submodule' was the only command to3255 interact with submodules; settings like `submodule.active`3256 and `pull.rebase` are more specific. It is populated by3257 `git submodule init` from the linkgit:gitmodules[5] file.3258 See description of 'update' command in linkgit:git-submodule[1].32593260submodule.<name>.branch::3261 The remote branch name for a submodule, used by `git submodule3262 update --remote`. Set this option to override the value found in3263 the `.gitmodules` file. See linkgit:git-submodule[1] and3264 linkgit:gitmodules[5] for details.32653266submodule.<name>.fetchRecurseSubmodules::3267 This option can be used to control recursive fetching of this3268 submodule. It can be overridden by using the --[no-]recurse-submodules3269 command-line option to "git fetch" and "git pull".3270 This setting will override that from in the linkgit:gitmodules[5]3271 file.32723273submodule.<name>.ignore::3274 Defines under what circumstances "git status" and the diff family show3275 a submodule as modified. When set to "all", it will never be considered3276 modified (but it will nonetheless show up in the output of status and3277 commit when it has been staged), "dirty" will ignore all changes3278 to the submodules work tree and3279 takes only differences between the HEAD of the submodule and the commit3280 recorded in the superproject into account. "untracked" will additionally3281 let submodules with modified tracked files in their work tree show up.3282 Using "none" (the default when this option is not set) also shows3283 submodules that have untracked files in their work tree as changed.3284 This setting overrides any setting made in .gitmodules for this submodule,3285 both settings can be overridden on the command line by using the3286 "--ignore-submodules" option. The 'git submodule' commands are not3287 affected by this setting.32883289submodule.<name>.active::3290 Boolean value indicating if the submodule is of interest to git3291 commands. This config option takes precedence over the3292 submodule.active config option.32933294submodule.active::3295 A repeated field which contains a pathspec used to match against a3296 submodule's path to determine if the submodule is of interest to git3297 commands.32983299submodule.recurse::3300 Specifies if commands recurse into submodules by default. This3301 applies to all commands that have a `--recurse-submodules` option,3302 except `clone`.3303 Defaults to false.33043305submodule.fetchJobs::3306 Specifies how many submodules are fetched/cloned at the same time.3307 A positive integer allows up to that number of submodules fetched3308 in parallel. A value of 0 will give some reasonable default.3309 If unset, it defaults to 1.33103311submodule.alternateLocation::3312 Specifies how the submodules obtain alternates when submodules are3313 cloned. Possible values are `no`, `superproject`.3314 By default `no` is assumed, which doesn't add references. When the3315 value is set to `superproject` the submodule to be cloned computes3316 its alternates location relative to the superprojects alternate.33173318submodule.alternateErrorStrategy::3319 Specifies how to treat errors with the alternates for a submodule3320 as computed via `submodule.alternateLocation`. Possible values are3321 `ignore`, `info`, `die`. Default is `die`.33223323tag.forceSignAnnotated::3324 A boolean to specify whether annotated tags created should be GPG signed.3325 If `--annotate` is specified on the command line, it takes3326 precedence over this option.33273328tag.sort::3329 This variable controls the sort ordering of tags when displayed by3330 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3331 value of this variable will be used as the default.33323333tar.umask::3334 This variable can be used to restrict the permission bits of3335 tar archive entries. The default is 0002, which turns off the3336 world write bit. The special value "user" indicates that the3337 archiving user's umask will be used instead. See umask(2) and3338 linkgit:git-archive[1].33393340transfer.fsckObjects::3341 When `fetch.fsckObjects` or `receive.fsckObjects` are3342 not set, the value of this variable is used instead.3343 Defaults to false.33443345transfer.hideRefs::3346 String(s) `receive-pack` and `upload-pack` use to decide which3347 refs to omit from their initial advertisements. Use more than3348 one definition to specify multiple prefix strings. A ref that is3349 under the hierarchies listed in the value of this variable is3350 excluded, and is hidden when responding to `git push` or `git3351 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3352 program-specific versions of this config.3353+3354You may also include a `!` in front of the ref name to negate the entry,3355explicitly exposing it, even if an earlier entry marked it as hidden.3356If you have multiple hideRefs values, later entries override earlier ones3357(and entries in more-specific config files override less-specific ones).3358+3359If a namespace is in use, the namespace prefix is stripped from each3360reference before it is matched against `transfer.hiderefs` patterns.3361For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3362the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3363is omitted from the advertisements but `refs/heads/master` and3364`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3365"have" lines. In order to match refs before stripping, add a `^` in front of3366the ref name. If you combine `!` and `^`, `!` must be specified first.3367+3368Even if you hide refs, a client may still be able to steal the target3369objects via the techniques described in the "SECURITY" section of the3370linkgit:gitnamespaces[7] man page; it's best to keep private data in a3371separate repository.33723373transfer.unpackLimit::3374 When `fetch.unpackLimit` or `receive.unpackLimit` are3375 not set, the value of this variable is used instead.3376 The default value is 100.33773378uploadarchive.allowUnreachable::3379 If true, allow clients to use `git archive --remote` to request3380 any tree, whether reachable from the ref tips or not. See the3381 discussion in the "SECURITY" section of3382 linkgit:git-upload-archive[1] for more details. Defaults to3383 `false`.33843385uploadpack.hideRefs::3386 This variable is the same as `transfer.hideRefs`, but applies3387 only to `upload-pack` (and so affects only fetches, not pushes).3388 An attempt to fetch a hidden ref by `git fetch` will fail. See3389 also `uploadpack.allowTipSHA1InWant`.33903391uploadpack.allowTipSHA1InWant::3392 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3393 to accept a fetch request that asks for an object at the tip3394 of a hidden ref (by default, such a request is rejected).3395 See also `uploadpack.hideRefs`. Even if this is false, a client3396 may be able to steal objects via the techniques described in the3397 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3398 best to keep private data in a separate repository.33993400uploadpack.allowReachableSHA1InWant::3401 Allow `upload-pack` to accept a fetch request that asks for an3402 object that is reachable from any ref tip. However, note that3403 calculating object reachability is computationally expensive.3404 Defaults to `false`. Even if this is false, a client may be able3405 to steal objects via the techniques described in the "SECURITY"3406 section of the linkgit:gitnamespaces[7] man page; it's best to3407 keep private data in a separate repository.34083409uploadpack.allowAnySHA1InWant::3410 Allow `upload-pack` to accept a fetch request that asks for any3411 object at all.3412 Defaults to `false`.34133414uploadpack.keepAlive::3415 When `upload-pack` has started `pack-objects`, there may be a3416 quiet period while `pack-objects` prepares the pack. Normally3417 it would output progress information, but if `--quiet` was used3418 for the fetch, `pack-objects` will output nothing at all until3419 the pack data begins. Some clients and networks may consider3420 the server to be hung and give up. Setting this option instructs3421 `upload-pack` to send an empty keepalive packet every3422 `uploadpack.keepAlive` seconds. Setting this option to 03423 disables keepalive packets entirely. The default is 5 seconds.34243425uploadpack.packObjectsHook::3426 If this option is set, when `upload-pack` would run3427 `git pack-objects` to create a packfile for a client, it will3428 run this shell command instead. The `pack-objects` command and3429 arguments it _would_ have run (including the `git pack-objects`3430 at the beginning) are appended to the shell command. The stdin3431 and stdout of the hook are treated as if `pack-objects` itself3432 was run. I.e., `upload-pack` will feed input intended for3433 `pack-objects` to the hook, and expects a completed packfile on3434 stdout.34353436uploadpack.allowFilter::3437 If this option is set, `upload-pack` will support partial3438 clone and partial fetch object filtering.3439+3440Note that this configuration variable is ignored if it is seen in the3441repository-level config (this is a safety measure against fetching from3442untrusted repositories).34433444url.<base>.insteadOf::3445 Any URL that starts with this value will be rewritten to3446 start, instead, with <base>. In cases where some site serves a3447 large number of repositories, and serves them with multiple3448 access methods, and some users need to use different access3449 methods, this feature allows people to specify any of the3450 equivalent URLs and have Git automatically rewrite the URL to3451 the best alternative for the particular user, even for a3452 never-before-seen repository on the site. When more than one3453 insteadOf strings match a given URL, the longest match is used.3454+3455Note that any protocol restrictions will be applied to the rewritten3456URL. If the rewrite changes the URL to use a custom protocol or remote3457helper, you may need to adjust the `protocol.*.allow` config to permit3458the request. In particular, protocols you expect to use for submodules3459must be set to `always` rather than the default of `user`. See the3460description of `protocol.allow` above.34613462url.<base>.pushInsteadOf::3463 Any URL that starts with this value will not be pushed to;3464 instead, it will be rewritten to start with <base>, and the3465 resulting URL will be pushed to. In cases where some site serves3466 a large number of repositories, and serves them with multiple3467 access methods, some of which do not allow push, this feature3468 allows people to specify a pull-only URL and have Git3469 automatically use an appropriate URL to push, even for a3470 never-before-seen repository on the site. When more than one3471 pushInsteadOf strings match a given URL, the longest match is3472 used. If a remote has an explicit pushurl, Git will ignore this3473 setting for that remote.34743475user.email::3476 Your email address to be recorded in any newly created commits.3477 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3478 `EMAIL` environment variables. See linkgit:git-commit-tree[1].34793480user.name::3481 Your full name to be recorded in any newly created commits.3482 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3483 environment variables. See linkgit:git-commit-tree[1].34843485user.useConfigOnly::3486 Instruct Git to avoid trying to guess defaults for `user.email`3487 and `user.name`, and instead retrieve the values only from the3488 configuration. For example, if you have multiple email addresses3489 and would like to use a different one for each repository, then3490 with this configuration option set to `true` in the global config3491 along with a name, Git will prompt you to set up an email before3492 making new commits in a newly cloned repository.3493 Defaults to `false`.34943495user.signingKey::3496 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3497 key you want it to automatically when creating a signed tag or3498 commit, you can override the default selection with this variable.3499 This option is passed unchanged to gpg's --local-user parameter,3500 so you may specify a key using any method that gpg supports.35013502versionsort.prereleaseSuffix (deprecated)::3503 Deprecated alias for `versionsort.suffix`. Ignored if3504 `versionsort.suffix` is set.35053506versionsort.suffix::3507 Even when version sort is used in linkgit:git-tag[1], tagnames3508 with the same base version but different suffixes are still sorted3509 lexicographically, resulting e.g. in prerelease tags appearing3510 after the main release (e.g. "1.0-rc1" after "1.0"). This3511 variable can be specified to determine the sorting order of tags3512 with different suffixes.3513+3514By specifying a single suffix in this variable, any tagname containing3515that suffix will appear before the corresponding main release. E.g. if3516the variable is set to "-rc", then all "1.0-rcX" tags will appear before3517"1.0". If specified multiple times, once per suffix, then the order of3518suffixes in the configuration will determine the sorting order of tagnames3519with those suffixes. E.g. if "-pre" appears before "-rc" in the3520configuration, then all "1.0-preX" tags will be listed before any3521"1.0-rcX" tags. The placement of the main release tag relative to tags3522with various suffixes can be determined by specifying the empty suffix3523among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3524"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3525are listed first, followed by "v4.8", then "v4.8-ckX" and finally3526"v4.8-bfsX".3527+3528If more than one suffixes match the same tagname, then that tagname will3529be sorted according to the suffix which starts at the earliest position in3530the tagname. If more than one different matching suffixes start at3531that earliest position, then that tagname will be sorted according to the3532longest of those suffixes.3533The sorting order between different suffixes is undefined if they are3534in multiple config files.35353536web.browser::3537 Specify a web browser that may be used by some commands.3538 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3539 may use it.35403541worktree.guessRemote::3542 With `add`, if no branch argument, and neither of `-b` nor3543 `-B` nor `--detach` are given, the command defaults to3544 creating a new branch from HEAD. If `worktree.guessRemote` is3545 set to true, `worktree add` tries to find a remote-tracking3546 branch whose name uniquely matches the new branch name. If3547 such a branch exists, it is checked out and set as "upstream"3548 for the new branch. If no such match can be found, it falls3549 back to creating a new branch from the current HEAD.