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.symlinks:: 534 If false, symbolic links are checked out as small plain files that 535 contain the link text. linkgit:git-update-index[1] and 536 linkgit:git-add[1] will not change the recorded type to regular 537 file. Useful on filesystems like FAT that do not support 538 symbolic links. 539+ 540The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 541will probe and set core.symlinks false if appropriate when the repository 542is created. 543 544core.gitProxy:: 545 A "proxy command" to execute (as 'command host port') instead 546 of establishing direct connection to the remote server when 547 using the Git protocol for fetching. If the variable value is 548 in the "COMMAND for DOMAIN" format, the command is applied only 549 on hostnames ending with the specified domain string. This variable 550 may be set multiple times and is matched in the given order; 551 the first match wins. 552+ 553Can be overridden by the `GIT_PROXY_COMMAND` environment variable 554(which always applies universally, without the special "for" 555handling). 556+ 557The special string `none` can be used as the proxy command to 558specify that no proxy be used for a given domain pattern. 559This is useful for excluding servers inside a firewall from 560proxy use, while defaulting to a common proxy for external domains. 561 562core.sshCommand:: 563 If this variable is set, `git fetch` and `git push` will 564 use the specified command instead of `ssh` when they need to 565 connect to a remote system. The command is in the same form as 566 the `GIT_SSH_COMMAND` environment variable and is overridden 567 when the environment variable is set. 568 569core.ignoreStat:: 570 If true, Git will avoid using lstat() calls to detect if files have 571 changed by setting the "assume-unchanged" bit for those tracked files 572 which it has updated identically in both the index and working tree. 573+ 574When files are modified outside of Git, the user will need to stage 575the modified files explicitly (e.g. see 'Examples' section in 576linkgit:git-update-index[1]). 577Git will not normally detect changes to those files. 578+ 579This is useful on systems where lstat() calls are very slow, such as 580CIFS/Microsoft Windows. 581+ 582False by default. 583 584core.preferSymlinkRefs:: 585 Instead of the default "symref" format for HEAD 586 and other symbolic reference files, use symbolic links. 587 This is sometimes needed to work with old scripts that 588 expect HEAD to be a symbolic link. 589 590core.bare:: 591 If true this repository is assumed to be 'bare' and has no 592 working directory associated with it. If this is the case a 593 number of commands that require a working directory will be 594 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 595+ 596This setting is automatically guessed by linkgit:git-clone[1] or 597linkgit:git-init[1] when the repository was created. By default a 598repository that ends in "/.git" is assumed to be not bare (bare = 599false), while all other repositories are assumed to be bare (bare 600= true). 601 602core.worktree:: 603 Set the path to the root of the working tree. 604 If `GIT_COMMON_DIR` environment variable is set, core.worktree 605 is ignored and not used for determining the root of working tree. 606 This can be overridden by the `GIT_WORK_TREE` environment 607 variable and the `--work-tree` command-line option. 608 The value can be an absolute path or relative to the path to 609 the .git directory, which is either specified by --git-dir 610 or GIT_DIR, or automatically discovered. 611 If --git-dir or GIT_DIR is specified but none of 612 --work-tree, GIT_WORK_TREE and core.worktree is specified, 613 the current working directory is regarded as the top level 614 of your working tree. 615+ 616Note that this variable is honored even when set in a configuration 617file in a ".git" subdirectory of a directory and its value differs 618from the latter directory (e.g. "/path/to/.git/config" has 619core.worktree set to "/different/path"), which is most likely a 620misconfiguration. Running Git commands in the "/path/to" directory will 621still use "/different/path" as the root of the work tree and can cause 622confusion unless you know what you are doing (e.g. you are creating a 623read-only snapshot of the same index to a location different from the 624repository's usual working tree). 625 626core.logAllRefUpdates:: 627 Enable the reflog. Updates to a ref <ref> is logged to the file 628 "`$GIT_DIR/logs/<ref>`", by appending the new and old 629 SHA-1, the date/time and the reason of the update, but 630 only when the file exists. If this configuration 631 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 632 file is automatically created for branch heads (i.e. under 633 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 634 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 635 If it is set to `always`, then a missing reflog is automatically 636 created for any ref under `refs/`. 637+ 638This information can be used to determine what commit 639was the tip of a branch "2 days ago". 640+ 641This value is true by default in a repository that has 642a working directory associated with it, and false by 643default in a bare repository. 644 645core.repositoryFormatVersion:: 646 Internal variable identifying the repository format and layout 647 version. 648 649core.sharedRepository:: 650 When 'group' (or 'true'), the repository is made shareable between 651 several users in a group (making sure all the files and objects are 652 group-writable). When 'all' (or 'world' or 'everybody'), the 653 repository will be readable by all users, additionally to being 654 group-shareable. When 'umask' (or 'false'), Git will use permissions 655 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 656 files in the repository will have this mode value. '0xxx' will override 657 user's umask value (whereas the other options will only override 658 requested parts of the user's umask value). Examples: '0660' will make 659 the repo read/write-able for the owner and group, but inaccessible to 660 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 661 repository that is group-readable but not group-writable. 662 See linkgit:git-init[1]. False by default. 663 664core.warnAmbiguousRefs:: 665 If true, Git will warn you if the ref name you passed it is ambiguous 666 and might match multiple refs in the repository. True by default. 667 668core.compression:: 669 An integer -1..9, indicating a default compression level. 670 -1 is the zlib default. 0 means no compression, 671 and 1..9 are various speed/size tradeoffs, 9 being slowest. 672 If set, this provides a default to other compression variables, 673 such as `core.looseCompression` and `pack.compression`. 674 675core.looseCompression:: 676 An integer -1..9, indicating the compression level for objects that 677 are not in a pack file. -1 is the zlib default. 0 means no 678 compression, and 1..9 are various speed/size tradeoffs, 9 being 679 slowest. If not set, defaults to core.compression. If that is 680 not set, defaults to 1 (best speed). 681 682core.packedGitWindowSize:: 683 Number of bytes of a pack file to map into memory in a 684 single mapping operation. Larger window sizes may allow 685 your system to process a smaller number of large pack files 686 more quickly. Smaller window sizes will negatively affect 687 performance due to increased calls to the operating system's 688 memory manager, but may improve performance when accessing 689 a large number of large pack files. 690+ 691Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 692MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 693be reasonable for all users/operating systems. You probably do 694not need to adjust this value. 695+ 696Common unit suffixes of 'k', 'm', or 'g' are supported. 697 698core.packedGitLimit:: 699 Maximum number of bytes to map simultaneously into memory 700 from pack files. If Git needs to access more than this many 701 bytes at once to complete an operation it will unmap existing 702 regions to reclaim virtual address space within the process. 703+ 704Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 705unlimited) on 64 bit platforms. 706This should be reasonable for all users/operating systems, except on 707the largest projects. You probably do not need to adjust this value. 708+ 709Common unit suffixes of 'k', 'm', or 'g' are supported. 710 711core.deltaBaseCacheLimit:: 712 Maximum number of bytes to reserve for caching base objects 713 that may be referenced by multiple deltified objects. By storing the 714 entire decompressed base objects in a cache Git is able 715 to avoid unpacking and decompressing frequently used base 716 objects multiple times. 717+ 718Default is 96 MiB on all platforms. This should be reasonable 719for all users/operating systems, except on the largest projects. 720You probably do not need to adjust this value. 721+ 722Common unit suffixes of 'k', 'm', or 'g' are supported. 723 724core.bigFileThreshold:: 725 Files larger than this size are stored deflated, without 726 attempting delta compression. Storing large files without 727 delta compression avoids excessive memory usage, at the 728 slight expense of increased disk usage. Additionally files 729 larger than this size are always treated as binary. 730+ 731Default is 512 MiB on all platforms. This should be reasonable 732for most projects as source code and other text files can still 733be delta compressed, but larger binary media files won't be. 734+ 735Common unit suffixes of 'k', 'm', or 'g' are supported. 736 737core.excludesFile:: 738 Specifies the pathname to the file that contains patterns to 739 describe paths that are not meant to be tracked, in addition 740 to '.gitignore' (per-directory) and '.git/info/exclude'. 741 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 742 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 743 is used instead. See linkgit:gitignore[5]. 744 745core.askPass:: 746 Some commands (e.g. svn and http interfaces) that interactively 747 ask for a password can be told to use an external program given 748 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 749 environment variable. If not set, fall back to the value of the 750 `SSH_ASKPASS` environment variable or, failing that, a simple password 751 prompt. The external program shall be given a suitable prompt as 752 command-line argument and write the password on its STDOUT. 753 754core.attributesFile:: 755 In addition to '.gitattributes' (per-directory) and 756 '.git/info/attributes', Git looks into this file for attributes 757 (see linkgit:gitattributes[5]). Path expansions are made the same 758 way as for `core.excludesFile`. Its default value is 759 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 760 set or empty, `$HOME/.config/git/attributes` is used instead. 761 762core.hooksPath:: 763 By default Git will look for your hooks in the 764 '$GIT_DIR/hooks' directory. Set this to different path, 765 e.g. '/etc/git/hooks', and Git will try to find your hooks in 766 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 767 in '$GIT_DIR/hooks/pre-receive'. 768+ 769The path can be either absolute or relative. A relative path is 770taken as relative to the directory where the hooks are run (see 771the "DESCRIPTION" section of linkgit:githooks[5]). 772+ 773This configuration variable is useful in cases where you'd like to 774centrally configure your Git hooks instead of configuring them on a 775per-repository basis, or as a more flexible and centralized 776alternative to having an `init.templateDir` where you've changed 777default hooks. 778 779core.editor:: 780 Commands such as `commit` and `tag` that let you edit 781 messages by launching an editor use the value of this 782 variable when it is set, and the environment variable 783 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 784 785core.commentChar:: 786 Commands such as `commit` and `tag` that let you edit 787 messages consider a line that begins with this character 788 commented, and removes them after the editor returns 789 (default '#'). 790+ 791If set to "auto", `git-commit` would select a character that is not 792the beginning character of any line in existing commit messages. 793 794core.filesRefLockTimeout:: 795 The length of time, in milliseconds, to retry when trying to 796 lock an individual reference. Value 0 means not to retry at 797 all; -1 means to try indefinitely. Default is 100 (i.e., 798 retry for 100ms). 799 800core.packedRefsTimeout:: 801 The length of time, in milliseconds, to retry when trying to 802 lock the `packed-refs` file. Value 0 means not to retry at 803 all; -1 means to try indefinitely. Default is 1000 (i.e., 804 retry for 1 second). 805 806sequence.editor:: 807 Text editor used by `git rebase -i` for editing the rebase instruction file. 808 The value is meant to be interpreted by the shell when it is used. 809 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 810 When not configured the default commit message editor is used instead. 811 812core.pager:: 813 Text viewer for use by Git commands (e.g., 'less'). The value 814 is meant to be interpreted by the shell. The order of preference 815 is the `$GIT_PAGER` environment variable, then `core.pager` 816 configuration, then `$PAGER`, and then the default chosen at 817 compile time (usually 'less'). 818+ 819When the `LESS` environment variable is unset, Git sets it to `FRX` 820(if `LESS` environment variable is set, Git does not change it at 821all). If you want to selectively override Git's default setting 822for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 823be passed to the shell by Git, which will translate the final 824command to `LESS=FRX less -S`. The environment does not set the 825`S` option but the command line does, instructing less to truncate 826long lines. Similarly, setting `core.pager` to `less -+F` will 827deactivate the `F` option specified by the environment from the 828command-line, deactivating the "quit if one screen" behavior of 829`less`. One can specifically activate some flags for particular 830commands: for example, setting `pager.blame` to `less -S` enables 831line truncation only for `git blame`. 832+ 833Likewise, when the `LV` environment variable is unset, Git sets it 834to `-c`. You can override this setting by exporting `LV` with 835another value or setting `core.pager` to `lv +c`. 836 837core.whitespace:: 838 A comma separated list of common whitespace problems to 839 notice. 'git diff' will use `color.diff.whitespace` to 840 highlight them, and 'git apply --whitespace=error' will 841 consider them as errors. You can prefix `-` to disable 842 any of them (e.g. `-trailing-space`): 843+ 844* `blank-at-eol` treats trailing whitespaces at the end of the line 845 as an error (enabled by default). 846* `space-before-tab` treats a space character that appears immediately 847 before a tab character in the initial indent part of the line as an 848 error (enabled by default). 849* `indent-with-non-tab` treats a line that is indented with space 850 characters instead of the equivalent tabs as an error (not enabled by 851 default). 852* `tab-in-indent` treats a tab character in the initial indent part of 853 the line as an error (not enabled by default). 854* `blank-at-eof` treats blank lines added at the end of file as an error 855 (enabled by default). 856* `trailing-space` is a short-hand to cover both `blank-at-eol` and 857 `blank-at-eof`. 858* `cr-at-eol` treats a carriage-return at the end of line as 859 part of the line terminator, i.e. with it, `trailing-space` 860 does not trigger if the character before such a carriage-return 861 is not a whitespace (not enabled by default). 862* `tabwidth=<n>` tells how many character positions a tab occupies; this 863 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 864 errors. The default tab width is 8. Allowed values are 1 to 63. 865 866core.fsyncObjectFiles:: 867 This boolean will enable 'fsync()' when writing object files. 868+ 869This is a total waste of time and effort on a filesystem that orders 870data writes properly, but can be useful for filesystems that do not use 871journalling (traditional UNIX filesystems) or that only journal metadata 872and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 873 874core.preloadIndex:: 875 Enable parallel index preload for operations like 'git diff' 876+ 877This can speed up operations like 'git diff' and 'git status' especially 878on filesystems like NFS that have weak caching semantics and thus 879relatively high IO latencies. When enabled, Git will do the 880index comparison to the filesystem data in parallel, allowing 881overlapping IO's. Defaults to true. 882 883core.createObject:: 884 You can set this to 'link', in which case a hardlink followed by 885 a delete of the source are used to make sure that object creation 886 will not overwrite existing objects. 887+ 888On some file system/operating system combinations, this is unreliable. 889Set this config setting to 'rename' there; However, This will remove the 890check that makes sure that existing object files will not get overwritten. 891 892core.notesRef:: 893 When showing commit messages, also show notes which are stored in 894 the given ref. The ref must be fully qualified. If the given 895 ref does not exist, it is not an error but means that no 896 notes should be printed. 897+ 898This setting defaults to "refs/notes/commits", and it can be overridden by 899the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 900 901core.sparseCheckout:: 902 Enable "sparse checkout" feature. See section "Sparse checkout" in 903 linkgit:git-read-tree[1] for more information. 904 905core.abbrev:: 906 Set the length object names are abbreviated to. If 907 unspecified or set to "auto", an appropriate value is 908 computed based on the approximate number of packed objects 909 in your repository, which hopefully is enough for 910 abbreviated object names to stay unique for some time. 911 The minimum length is 4. 912 913add.ignoreErrors:: 914add.ignore-errors (deprecated):: 915 Tells 'git add' to continue adding files when some files cannot be 916 added due to indexing errors. Equivalent to the `--ignore-errors` 917 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 918 as it does not follow the usual naming convention for configuration 919 variables. 920 921alias.*:: 922 Command aliases for the linkgit:git[1] command wrapper - e.g. 923 after defining "alias.last = cat-file commit HEAD", the invocation 924 "git last" is equivalent to "git cat-file commit HEAD". To avoid 925 confusion and troubles with script usage, aliases that 926 hide existing Git commands are ignored. Arguments are split by 927 spaces, the usual shell quoting and escaping is supported. 928 A quote pair or a backslash can be used to quote them. 929+ 930If the alias expansion is prefixed with an exclamation point, 931it will be treated as a shell command. For example, defining 932"alias.new = !gitk --all --not ORIG_HEAD", the invocation 933"git new" is equivalent to running the shell command 934"gitk --all --not ORIG_HEAD". Note that shell commands will be 935executed from the top-level directory of a repository, which may 936not necessarily be the current directory. 937`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 938from the original current directory. See linkgit:git-rev-parse[1]. 939 940am.keepcr:: 941 If true, git-am will call git-mailsplit for patches in mbox format 942 with parameter `--keep-cr`. In this case git-mailsplit will 943 not remove `\r` from lines ending with `\r\n`. Can be overridden 944 by giving `--no-keep-cr` from the command line. 945 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 946 947am.threeWay:: 948 By default, `git am` will fail if the patch does not apply cleanly. When 949 set to true, this setting tells `git am` to fall back on 3-way merge if 950 the patch records the identity of blobs it is supposed to apply to and 951 we have those blobs available locally (equivalent to giving the `--3way` 952 option from the command line). Defaults to `false`. 953 See linkgit:git-am[1]. 954 955apply.ignoreWhitespace:: 956 When set to 'change', tells 'git apply' to ignore changes in 957 whitespace, in the same way as the `--ignore-space-change` 958 option. 959 When set to one of: no, none, never, false tells 'git apply' to 960 respect all whitespace differences. 961 See linkgit:git-apply[1]. 962 963apply.whitespace:: 964 Tells 'git apply' how to handle whitespaces, in the same way 965 as the `--whitespace` option. See linkgit:git-apply[1]. 966 967blame.showRoot:: 968 Do not treat root commits as boundaries in linkgit:git-blame[1]. 969 This option defaults to false. 970 971blame.blankBoundary:: 972 Show blank commit object name for boundary commits in 973 linkgit:git-blame[1]. This option defaults to false. 974 975blame.showEmail:: 976 Show the author email instead of author name in linkgit:git-blame[1]. 977 This option defaults to false. 978 979blame.date:: 980 Specifies the format used to output dates in linkgit:git-blame[1]. 981 If unset the iso format is used. For supported values, 982 see the discussion of the `--date` option at linkgit:git-log[1]. 983 984branch.autoSetupMerge:: 985 Tells 'git branch' and 'git checkout' to set up new branches 986 so that linkgit:git-pull[1] will appropriately merge from the 987 starting point branch. Note that even if this option is not set, 988 this behavior can be chosen per-branch using the `--track` 989 and `--no-track` options. The valid settings are: `false` -- no 990 automatic setup is done; `true` -- automatic setup is done when the 991 starting point is a remote-tracking branch; `always` -- 992 automatic setup is done when the starting point is either a 993 local branch or remote-tracking 994 branch. This option defaults to true. 995 996branch.autoSetupRebase:: 997 When a new branch is created with 'git branch' or 'git checkout' 998 that tracks another branch, this variable tells Git to set 999 up pull to rebase instead of merge (see "branch.<name>.rebase").1000 When `never`, rebase is never automatically set to true.1001 When `local`, rebase is set to true for tracked branches of1002 other local branches.1003 When `remote`, rebase is set to true for tracked branches of1004 remote-tracking branches.1005 When `always`, rebase will be set to true for all tracking1006 branches.1007 See "branch.autoSetupMerge" for details on how to set up a1008 branch to track another branch.1009 This option defaults to never.10101011branch.<name>.remote::1012 When on branch <name>, it tells 'git fetch' and 'git push'1013 which remote to fetch from/push to. The remote to push to1014 may be overridden with `remote.pushDefault` (for all branches).1015 The remote to push to, for the current branch, may be further1016 overridden by `branch.<name>.pushRemote`. If no remote is1017 configured, or if you are not on any branch, it defaults to1018 `origin` for fetching and `remote.pushDefault` for pushing.1019 Additionally, `.` (a period) is the current local repository1020 (a dot-repository), see `branch.<name>.merge`'s final note below.10211022branch.<name>.pushRemote::1023 When on branch <name>, it overrides `branch.<name>.remote` for1024 pushing. It also overrides `remote.pushDefault` for pushing1025 from branch <name>. When you pull from one place (e.g. your1026 upstream) and push to another place (e.g. your own publishing1027 repository), you would want to set `remote.pushDefault` to1028 specify the remote to push to for all branches, and use this1029 option to override it for a specific branch.10301031branch.<name>.merge::1032 Defines, together with branch.<name>.remote, the upstream branch1033 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1034 branch to merge and can also affect 'git push' (see push.default).1035 When in branch <name>, it tells 'git fetch' the default1036 refspec to be marked for merging in FETCH_HEAD. The value is1037 handled like the remote part of a refspec, and must match a1038 ref which is fetched from the remote given by1039 "branch.<name>.remote".1040 The merge information is used by 'git pull' (which at first calls1041 'git fetch') to lookup the default branch for merging. Without1042 this option, 'git pull' defaults to merge the first refspec fetched.1043 Specify multiple values to get an octopus merge.1044 If you wish to setup 'git pull' so that it merges into <name> from1045 another branch in the local repository, you can point1046 branch.<name>.merge to the desired branch, and use the relative path1047 setting `.` (a period) for branch.<name>.remote.10481049branch.<name>.mergeOptions::1050 Sets default options for merging into branch <name>. The syntax and1051 supported options are the same as those of linkgit:git-merge[1], but1052 option values containing whitespace characters are currently not1053 supported.10541055branch.<name>.rebase::1056 When true, rebase the branch <name> on top of the fetched branch,1057 instead of merging the default branch from the default remote when1058 "git pull" is run. See "pull.rebase" for doing this in a non1059 branch-specific manner.1060+1061When preserve, also pass `--preserve-merges` along to 'git rebase'1062so that locally committed merge commits will not be flattened1063by running 'git pull'.1064+1065When the value is `interactive`, the rebase is run in interactive mode.1066+1067*NOTE*: this is a possibly dangerous operation; do *not* use1068it unless you understand the implications (see linkgit:git-rebase[1]1069for details).10701071branch.<name>.description::1072 Branch description, can be edited with1073 `git branch --edit-description`. Branch description is1074 automatically added in the format-patch cover letter or1075 request-pull summary.10761077browser.<tool>.cmd::1078 Specify the command to invoke the specified browser. The1079 specified command is evaluated in shell with the URLs passed1080 as arguments. (See linkgit:git-web{litdd}browse[1].)10811082browser.<tool>.path::1083 Override the path for the given tool that may be used to1084 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1085 working repository in gitweb (see linkgit:git-instaweb[1]).10861087clean.requireForce::1088 A boolean to make git-clean do nothing unless given -f,1089 -i or -n. Defaults to true.10901091color.branch::1092 A boolean to enable/disable color in the output of1093 linkgit:git-branch[1]. May be set to `always`,1094 `false` (or `never`) or `auto` (or `true`), in which case colors are used1095 only when the output is to a terminal. If unset, then the1096 value of `color.ui` is used (`auto` by default).10971098color.branch.<slot>::1099 Use customized color for branch coloration. `<slot>` is one of1100 `current` (the current branch), `local` (a local branch),1101 `remote` (a remote-tracking branch in refs/remotes/),1102 `upstream` (upstream tracking branch), `plain` (other1103 refs).11041105color.diff::1106 Whether to use ANSI escape sequences to add color to patches.1107 If this is set to `always`, linkgit:git-diff[1],1108 linkgit:git-log[1], and linkgit:git-show[1] will use color1109 for all patches. If it is set to `true` or `auto`, those1110 commands will only use color when output is to the terminal.1111 If unset, then the value of `color.ui` is used (`auto` by1112 default).1113+1114This does not affect linkgit:git-format-patch[1] or the1115'git-diff-{asterisk}' plumbing commands. Can be overridden on the1116command line with the `--color[=<when>]` option.11171118diff.colorMoved::1119 If set to either a valid `<mode>` or a true value, moved lines1120 in a diff are colored differently, for details of valid modes1121 see '--color-moved' in linkgit:git-diff[1]. If simply set to1122 true the default color mode will be used. When set to false,1123 moved lines are not colored.11241125color.diff.<slot>::1126 Use customized color for diff colorization. `<slot>` specifies1127 which part of the patch to use the specified color, and is one1128 of `context` (context text - `plain` is a historical synonym),1129 `meta` (metainformation), `frag`1130 (hunk header), 'func' (function in hunk header), `old` (removed lines),1131 `new` (added lines), `commit` (commit headers), `whitespace`1132 (highlighting whitespace errors), `oldMoved` (deleted lines),1133 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1134 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1135 and `newMovedAlternativeDimmed` (See the '<mode>'1136 setting of '--color-moved' in linkgit:git-diff[1] for details).11371138color.decorate.<slot>::1139 Use customized color for 'git log --decorate' output. `<slot>` is one1140 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1141 branches, remote-tracking branches, tags, stash and HEAD, respectively.11421143color.grep::1144 When set to `always`, always highlight matches. When `false` (or1145 `never`), never. When set to `true` or `auto`, use color only1146 when the output is written to the terminal. If unset, then the1147 value of `color.ui` is used (`auto` by default).11481149color.grep.<slot>::1150 Use customized color for grep colorization. `<slot>` specifies which1151 part of the line to use the specified color, and is one of1152+1153--1154`context`;;1155 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1156`filename`;;1157 filename prefix (when not using `-h`)1158`function`;;1159 function name lines (when using `-p`)1160`linenumber`;;1161 line number prefix (when using `-n`)1162`match`;;1163 matching text (same as setting `matchContext` and `matchSelected`)1164`matchContext`;;1165 matching text in context lines1166`matchSelected`;;1167 matching text in selected lines1168`selected`;;1169 non-matching text in selected lines1170`separator`;;1171 separators between fields on a line (`:`, `-`, and `=`)1172 and between hunks (`--`)1173--11741175color.interactive::1176 When set to `always`, always use colors for interactive prompts1177 and displays (such as those used by "git-add --interactive" and1178 "git-clean --interactive"). When false (or `never`), never.1179 When set to `true` or `auto`, use colors only when the output is1180 to the terminal. If unset, then the value of `color.ui` is1181 used (`auto` by default).11821183color.interactive.<slot>::1184 Use customized color for 'git add --interactive' and 'git clean1185 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1186 or `error`, for four distinct types of normal output from1187 interactive commands.11881189color.pager::1190 A boolean to enable/disable colored output when the pager is in1191 use (default is true).11921193color.showBranch::1194 A boolean to enable/disable color in the output of1195 linkgit:git-show-branch[1]. May be set to `always`,1196 `false` (or `never`) or `auto` (or `true`), in which case colors are used1197 only when the output is to a terminal. If unset, then the1198 value of `color.ui` is used (`auto` by default).11991200color.status::1201 A boolean to enable/disable color in the output of1202 linkgit:git-status[1]. May be set to `always`,1203 `false` (or `never`) or `auto` (or `true`), in which case colors are used1204 only when the output is to a terminal. If unset, then the1205 value of `color.ui` is used (`auto` by default).12061207color.status.<slot>::1208 Use customized color for status colorization. `<slot>` is1209 one of `header` (the header text of the status message),1210 `added` or `updated` (files which are added but not committed),1211 `changed` (files which are changed but not added in the index),1212 `untracked` (files which are not tracked by Git),1213 `branch` (the current branch),1214 `nobranch` (the color the 'no branch' warning is shown in, defaulting1215 to red),1216 `localBranch` or `remoteBranch` (the local and remote branch names,1217 respectively, when branch and tracking information is displayed in the1218 status short-format), or1219 `unmerged` (files which have unmerged changes).12201221color.ui::1222 This variable determines the default value for variables such1223 as `color.diff` and `color.grep` that control the use of color1224 per command family. Its scope will expand as more commands learn1225 configuration to set a default for the `--color` option. Set it1226 to `false` or `never` if you prefer Git commands not to use1227 color unless enabled explicitly with some other configuration1228 or the `--color` option. Set it to `always` if you want all1229 output not intended for machine consumption to use color, to1230 `true` or `auto` (this is the default since Git 1.8.4) if you1231 want such output to use color when written to the terminal.12321233column.ui::1234 Specify whether supported commands should output in columns.1235 This variable consists of a list of tokens separated by spaces1236 or commas:1237+1238These options control when the feature should be enabled1239(defaults to 'never'):1240+1241--1242`always`;;1243 always show in columns1244`never`;;1245 never show in columns1246`auto`;;1247 show in columns if the output is to the terminal1248--1249+1250These options control layout (defaults to 'column'). Setting any1251of these implies 'always' if none of 'always', 'never', or 'auto' are1252specified.1253+1254--1255`column`;;1256 fill columns before rows1257`row`;;1258 fill rows before columns1259`plain`;;1260 show in one column1261--1262+1263Finally, these options can be combined with a layout option (defaults1264to 'nodense'):1265+1266--1267`dense`;;1268 make unequal size columns to utilize more space1269`nodense`;;1270 make equal size columns1271--12721273column.branch::1274 Specify whether to output branch listing in `git branch` in columns.1275 See `column.ui` for details.12761277column.clean::1278 Specify the layout when list items in `git clean -i`, which always1279 shows files and directories in columns. See `column.ui` for details.12801281column.status::1282 Specify whether to output untracked files in `git status` in columns.1283 See `column.ui` for details.12841285column.tag::1286 Specify whether to output tag listing in `git tag` in columns.1287 See `column.ui` for details.12881289commit.cleanup::1290 This setting overrides the default of the `--cleanup` option in1291 `git commit`. See linkgit:git-commit[1] for details. Changing the1292 default can be useful when you always want to keep lines that begin1293 with comment character `#` in your log message, in which case you1294 would do `git config commit.cleanup whitespace` (note that you will1295 have to remove the help lines that begin with `#` in the commit log1296 template yourself, if you do this).12971298commit.gpgSign::12991300 A boolean to specify whether all commits should be GPG signed.1301 Use of this option when doing operations such as rebase can1302 result in a large number of commits being signed. It may be1303 convenient to use an agent to avoid typing your GPG passphrase1304 several times.13051306commit.status::1307 A boolean to enable/disable inclusion of status information in the1308 commit message template when using an editor to prepare the commit1309 message. Defaults to true.13101311commit.template::1312 Specify the pathname of a file to use as the template for1313 new commit messages.13141315commit.verbose::1316 A boolean or int to specify the level of verbose with `git commit`.1317 See linkgit:git-commit[1].13181319credential.helper::1320 Specify an external helper to be called when a username or1321 password credential is needed; the helper may consult external1322 storage to avoid prompting the user for the credentials. Note1323 that multiple helpers may be defined. See linkgit:gitcredentials[7]1324 for details.13251326credential.useHttpPath::1327 When acquiring credentials, consider the "path" component of an http1328 or https URL to be important. Defaults to false. See1329 linkgit:gitcredentials[7] for more information.13301331credential.username::1332 If no username is set for a network authentication, use this username1333 by default. See credential.<context>.* below, and1334 linkgit:gitcredentials[7].13351336credential.<url>.*::1337 Any of the credential.* options above can be applied selectively to1338 some credentials. For example "credential.https://example.com.username"1339 would set the default username only for https connections to1340 example.com. See linkgit:gitcredentials[7] for details on how URLs are1341 matched.13421343credentialCache.ignoreSIGHUP::1344 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13451346include::diff-config.txt[]13471348difftool.<tool>.path::1349 Override the path for the given tool. This is useful in case1350 your tool is not in the PATH.13511352difftool.<tool>.cmd::1353 Specify the command to invoke the specified diff tool.1354 The specified command is evaluated in shell with the following1355 variables available: 'LOCAL' is set to the name of the temporary1356 file containing the contents of the diff pre-image and 'REMOTE'1357 is set to the name of the temporary file containing the contents1358 of the diff post-image.13591360difftool.prompt::1361 Prompt before each invocation of the diff tool.13621363fastimport.unpackLimit::1364 If the number of objects imported by linkgit:git-fast-import[1]1365 is below this limit, then the objects will be unpacked into1366 loose object files. However if the number of imported objects1367 equals or exceeds this limit then the pack will be stored as a1368 pack. Storing the pack from a fast-import can make the import1369 operation complete faster, especially on slow filesystems. If1370 not set, the value of `transfer.unpackLimit` is used instead.13711372fetch.recurseSubmodules::1373 This option can be either set to a boolean value or to 'on-demand'.1374 Setting it to a boolean changes the behavior of fetch and pull to1375 unconditionally recurse into submodules when set to true or to not1376 recurse at all when set to false. When set to 'on-demand' (the default1377 value), fetch and pull will only recurse into a populated submodule1378 when its superproject retrieves a commit that updates the submodule's1379 reference.13801381fetch.fsckObjects::1382 If it is set to true, git-fetch-pack will check all fetched1383 objects. It will abort in the case of a malformed object or a1384 broken link. The result of an abort are only dangling objects.1385 Defaults to false. If not set, the value of `transfer.fsckObjects`1386 is used instead.13871388fetch.unpackLimit::1389 If the number of objects fetched over the Git native1390 transfer is below this1391 limit, then the objects will be unpacked into loose object1392 files. However if the number of received objects equals or1393 exceeds this limit then the received pack will be stored as1394 a pack, after adding any missing delta bases. Storing the1395 pack from a push can make the push operation complete faster,1396 especially on slow filesystems. If not set, the value of1397 `transfer.unpackLimit` is used instead.13981399fetch.prune::1400 If true, fetch will automatically behave as if the `--prune`1401 option was given on the command line. See also `remote.<name>.prune`1402 and the PRUNING section of linkgit:git-fetch[1].14031404fetch.pruneTags::1405 If true, fetch will automatically behave as if the1406 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1407 if not set already. This allows for setting both this option1408 and `fetch.prune` to maintain a 1=1 mapping to upstream1409 refs. See also `remote.<name>.pruneTags` and the PRUNING1410 section of linkgit:git-fetch[1].14111412fetch.output::1413 Control how ref update status is printed. Valid values are1414 `full` and `compact`. Default value is `full`. See section1415 OUTPUT in linkgit:git-fetch[1] for detail.14161417format.attach::1418 Enable multipart/mixed attachments as the default for1419 'format-patch'. The value can also be a double quoted string1420 which will enable attachments as the default and set the1421 value as the boundary. See the --attach option in1422 linkgit:git-format-patch[1].14231424format.from::1425 Provides the default value for the `--from` option to format-patch.1426 Accepts a boolean value, or a name and email address. If false,1427 format-patch defaults to `--no-from`, using commit authors directly in1428 the "From:" field of patch mails. If true, format-patch defaults to1429 `--from`, using your committer identity in the "From:" field of patch1430 mails and including a "From:" field in the body of the patch mail if1431 different. If set to a non-boolean value, format-patch uses that1432 value instead of your committer identity. Defaults to false.14331434format.numbered::1435 A boolean which can enable or disable sequence numbers in patch1436 subjects. It defaults to "auto" which enables it only if there1437 is more than one patch. It can be enabled or disabled for all1438 messages by setting it to "true" or "false". See --numbered1439 option in linkgit:git-format-patch[1].14401441format.headers::1442 Additional email headers to include in a patch to be submitted1443 by mail. See linkgit:git-format-patch[1].14441445format.to::1446format.cc::1447 Additional recipients to include in a patch to be submitted1448 by mail. See the --to and --cc options in1449 linkgit:git-format-patch[1].14501451format.subjectPrefix::1452 The default for format-patch is to output files with the '[PATCH]'1453 subject prefix. Use this variable to change that prefix.14541455format.signature::1456 The default for format-patch is to output a signature containing1457 the Git version number. Use this variable to change that default.1458 Set this variable to the empty string ("") to suppress1459 signature generation.14601461format.signatureFile::1462 Works just like format.signature except the contents of the1463 file specified by this variable will be used as the signature.14641465format.suffix::1466 The default for format-patch is to output files with the suffix1467 `.patch`. Use this variable to change that suffix (make sure to1468 include the dot if you want it).14691470format.pretty::1471 The default pretty format for log/show/whatchanged command,1472 See linkgit:git-log[1], linkgit:git-show[1],1473 linkgit:git-whatchanged[1].14741475format.thread::1476 The default threading style for 'git format-patch'. Can be1477 a boolean value, or `shallow` or `deep`. `shallow` threading1478 makes every mail a reply to the head of the series,1479 where the head is chosen from the cover letter, the1480 `--in-reply-to`, and the first patch mail, in this order.1481 `deep` threading makes every mail a reply to the previous one.1482 A true boolean value is the same as `shallow`, and a false1483 value disables threading.14841485format.signOff::1486 A boolean value which lets you enable the `-s/--signoff` option of1487 format-patch by default. *Note:* Adding the Signed-off-by: line to a1488 patch should be a conscious act and means that you certify you have1489 the rights to submit this work under the same open source license.1490 Please see the 'SubmittingPatches' document for further discussion.14911492format.coverLetter::1493 A boolean that controls whether to generate a cover-letter when1494 format-patch is invoked, but in addition can be set to "auto", to1495 generate a cover-letter only when there's more than one patch.14961497format.outputDirectory::1498 Set a custom directory to store the resulting files instead of the1499 current working directory.15001501format.useAutoBase::1502 A boolean value which lets you enable the `--base=auto` option of1503 format-patch by default.15041505filter.<driver>.clean::1506 The command which is used to convert the content of a worktree1507 file to a blob upon checkin. See linkgit:gitattributes[5] for1508 details.15091510filter.<driver>.smudge::1511 The command which is used to convert the content of a blob1512 object to a worktree file upon checkout. See1513 linkgit:gitattributes[5] for details.15141515fsck.<msg-id>::1516 Allows overriding the message type (error, warn or ignore) of a1517 specific message ID such as `missingEmail`.1518+1519For convenience, fsck prefixes the error/warning with the message ID,1520e.g. "missingEmail: invalid author/committer line - missing email" means1521that setting `fsck.missingEmail = ignore` will hide that issue.1522+1523This feature is intended to support working with legacy repositories1524which cannot be repaired without disruptive changes.15251526fsck.skipList::1527 The path to a sorted list of object names (i.e. one SHA-1 per1528 line) that are known to be broken in a non-fatal way and should1529 be ignored. This feature is useful when an established project1530 should be accepted despite early commits containing errors that1531 can be safely ignored such as invalid committer email addresses.1532 Note: corrupt objects cannot be skipped with this setting.15331534gc.aggressiveDepth::1535 The depth parameter used in the delta compression1536 algorithm used by 'git gc --aggressive'. This defaults1537 to 50.15381539gc.aggressiveWindow::1540 The window size parameter used in the delta compression1541 algorithm used by 'git gc --aggressive'. This defaults1542 to 250.15431544gc.auto::1545 When there are approximately more than this many loose1546 objects in the repository, `git gc --auto` will pack them.1547 Some Porcelain commands use this command to perform a1548 light-weight garbage collection from time to time. The1549 default value is 6700. Setting this to 0 disables it.15501551gc.autoPackLimit::1552 When there are more than this many packs that are not1553 marked with `*.keep` file in the repository, `git gc1554 --auto` consolidates them into one larger pack. The1555 default value is 50. Setting this to 0 disables it.15561557gc.autoDetach::1558 Make `git gc --auto` return immediately and run in background1559 if the system supports it. Default is true.15601561gc.logExpiry::1562 If the file gc.log exists, then `git gc --auto` won't run1563 unless that file is more than 'gc.logExpiry' old. Default is1564 "1.day". See `gc.pruneExpire` for more ways to specify its1565 value.15661567gc.packRefs::1568 Running `git pack-refs` in a repository renders it1569 unclonable by Git versions prior to 1.5.1.2 over dumb1570 transports such as HTTP. This variable determines whether1571 'git gc' runs `git pack-refs`. This can be set to `notbare`1572 to enable it within all non-bare repos or it can be set to a1573 boolean value. The default is `true`.15741575gc.pruneExpire::1576 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1577 Override the grace period with this config variable. The value1578 "now" may be used to disable this grace period and always prune1579 unreachable objects immediately, or "never" may be used to1580 suppress pruning. This feature helps prevent corruption when1581 'git gc' runs concurrently with another process writing to the1582 repository; see the "NOTES" section of linkgit:git-gc[1].15831584gc.worktreePruneExpire::1585 When 'git gc' is run, it calls1586 'git worktree prune --expire 3.months.ago'.1587 This config variable can be used to set a different grace1588 period. The value "now" may be used to disable the grace1589 period and prune `$GIT_DIR/worktrees` immediately, or "never"1590 may be used to suppress pruning.15911592gc.reflogExpire::1593gc.<pattern>.reflogExpire::1594 'git reflog expire' removes reflog entries older than1595 this time; defaults to 90 days. The value "now" expires all1596 entries immediately, and "never" suppresses expiration1597 altogether. With "<pattern>" (e.g.1598 "refs/stash") in the middle the setting applies only to1599 the refs that match the <pattern>.16001601gc.reflogExpireUnreachable::1602gc.<pattern>.reflogExpireUnreachable::1603 'git reflog expire' removes reflog entries older than1604 this time and are not reachable from the current tip;1605 defaults to 30 days. The value "now" expires all entries1606 immediately, and "never" suppresses expiration altogether.1607 With "<pattern>" (e.g. "refs/stash")1608 in the middle, the setting applies only to the refs that1609 match the <pattern>.16101611gc.rerereResolved::1612 Records of conflicted merge you resolved earlier are1613 kept for this many days when 'git rerere gc' is run.1614 You can also use more human-readable "1.month.ago", etc.1615 The default is 60 days. See linkgit:git-rerere[1].16161617gc.rerereUnresolved::1618 Records of conflicted merge you have not resolved are1619 kept for this many days when 'git rerere gc' is run.1620 You can also use more human-readable "1.month.ago", etc.1621 The default is 15 days. See linkgit:git-rerere[1].16221623gitcvs.commitMsgAnnotation::1624 Append this string to each commit message. Set to empty string1625 to disable this feature. Defaults to "via git-CVS emulator".16261627gitcvs.enabled::1628 Whether the CVS server interface is enabled for this repository.1629 See linkgit:git-cvsserver[1].16301631gitcvs.logFile::1632 Path to a log file where the CVS server interface well... logs1633 various stuff. See linkgit:git-cvsserver[1].16341635gitcvs.usecrlfattr::1636 If true, the server will look up the end-of-line conversion1637 attributes for files to determine the `-k` modes to use. If1638 the attributes force Git to treat a file as text,1639 the `-k` mode will be left blank so CVS clients will1640 treat it as text. If they suppress text conversion, the file1641 will be set with '-kb' mode, which suppresses any newline munging1642 the client might otherwise do. If the attributes do not allow1643 the file type to be determined, then `gitcvs.allBinary` is1644 used. See linkgit:gitattributes[5].16451646gitcvs.allBinary::1647 This is used if `gitcvs.usecrlfattr` does not resolve1648 the correct '-kb' mode to use. If true, all1649 unresolved files are sent to the client in1650 mode '-kb'. This causes the client to treat them1651 as binary files, which suppresses any newline munging it1652 otherwise might do. Alternatively, if it is set to "guess",1653 then the contents of the file are examined to decide if1654 it is binary, similar to `core.autocrlf`.16551656gitcvs.dbName::1657 Database used by git-cvsserver to cache revision information1658 derived from the Git repository. The exact meaning depends on the1659 used database driver, for SQLite (which is the default driver) this1660 is a filename. Supports variable substitution (see1661 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1662 Default: '%Ggitcvs.%m.sqlite'16631664gitcvs.dbDriver::1665 Used Perl DBI driver. You can specify any available driver1666 for this here, but it might not work. git-cvsserver is tested1667 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1668 reported *not* to work with 'DBD::mysql'. Experimental feature.1669 May not contain double colons (`:`). Default: 'SQLite'.1670 See linkgit:git-cvsserver[1].16711672gitcvs.dbUser, gitcvs.dbPass::1673 Database user and password. Only useful if setting `gitcvs.dbDriver`,1674 since SQLite has no concept of database users and/or passwords.1675 'gitcvs.dbUser' supports variable substitution (see1676 linkgit:git-cvsserver[1] for details).16771678gitcvs.dbTableNamePrefix::1679 Database table name prefix. Prepended to the names of any1680 database tables used, allowing a single database to be used1681 for several repositories. Supports variable substitution (see1682 linkgit:git-cvsserver[1] for details). Any non-alphabetic1683 characters will be replaced with underscores.16841685All gitcvs variables except for `gitcvs.usecrlfattr` and1686`gitcvs.allBinary` can also be specified as1687'gitcvs.<access_method>.<varname>' (where 'access_method'1688is one of "ext" and "pserver") to make them apply only for the given1689access method.16901691gitweb.category::1692gitweb.description::1693gitweb.owner::1694gitweb.url::1695 See linkgit:gitweb[1] for description.16961697gitweb.avatar::1698gitweb.blame::1699gitweb.grep::1700gitweb.highlight::1701gitweb.patches::1702gitweb.pickaxe::1703gitweb.remote_heads::1704gitweb.showSizes::1705gitweb.snapshot::1706 See linkgit:gitweb.conf[5] for description.17071708grep.lineNumber::1709 If set to true, enable `-n` option by default.17101711grep.patternType::1712 Set the default matching behavior. Using a value of 'basic', 'extended',1713 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1714 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1715 value 'default' will return to the default matching behavior.17161717grep.extendedRegexp::1718 If set to true, enable `--extended-regexp` option by default. This1719 option is ignored when the `grep.patternType` option is set to a value1720 other than 'default'.17211722grep.threads::1723 Number of grep worker threads to use.1724 See `grep.threads` in linkgit:git-grep[1] for more information.17251726grep.fallbackToNoIndex::1727 If set to true, fall back to git grep --no-index if git grep1728 is executed outside of a git repository. Defaults to false.17291730gpg.program::1731 Use this custom program instead of "`gpg`" found on `$PATH` when1732 making or verifying a PGP signature. The program must support the1733 same command-line interface as GPG, namely, to verify a detached1734 signature, "`gpg --verify $file - <$signature`" is run, and the1735 program is expected to signal a good signature by exiting with1736 code 0, and to generate an ASCII-armored detached signature, the1737 standard input of "`gpg -bsau $key`" is fed with the contents to be1738 signed, and the program is expected to send the result to its1739 standard output.17401741gui.commitMsgWidth::1742 Defines how wide the commit message window is in the1743 linkgit:git-gui[1]. "75" is the default.17441745gui.diffContext::1746 Specifies how many context lines should be used in calls to diff1747 made by the linkgit:git-gui[1]. The default is "5".17481749gui.displayUntracked::1750 Determines if linkgit:git-gui[1] shows untracked files1751 in the file list. The default is "true".17521753gui.encoding::1754 Specifies the default encoding to use for displaying of1755 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1756 It can be overridden by setting the 'encoding' attribute1757 for relevant files (see linkgit:gitattributes[5]).1758 If this option is not set, the tools default to the1759 locale encoding.17601761gui.matchTrackingBranch::1762 Determines if new branches created with linkgit:git-gui[1] should1763 default to tracking remote branches with matching names or1764 not. Default: "false".17651766gui.newBranchTemplate::1767 Is used as suggested name when creating new branches using the1768 linkgit:git-gui[1].17691770gui.pruneDuringFetch::1771 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1772 performing a fetch. The default value is "false".17731774gui.trustmtime::1775 Determines if linkgit:git-gui[1] should trust the file modification1776 timestamp or not. By default the timestamps are not trusted.17771778gui.spellingDictionary::1779 Specifies the dictionary used for spell checking commit messages in1780 the linkgit:git-gui[1]. When set to "none" spell checking is turned1781 off.17821783gui.fastCopyBlame::1784 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1785 location detection. It makes blame significantly faster on huge1786 repositories at the expense of less thorough copy detection.17871788gui.copyBlameThreshold::1789 Specifies the threshold to use in 'git gui blame' original location1790 detection, measured in alphanumeric characters. See the1791 linkgit:git-blame[1] manual for more information on copy detection.17921793gui.blamehistoryctx::1794 Specifies the radius of history context in days to show in1795 linkgit:gitk[1] for the selected commit, when the `Show History1796 Context` menu item is invoked from 'git gui blame'. If this1797 variable is set to zero, the whole history is shown.17981799guitool.<name>.cmd::1800 Specifies the shell command line to execute when the corresponding item1801 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1802 mandatory for every tool. The command is executed from the root of1803 the working directory, and in the environment it receives the name of1804 the tool as `GIT_GUITOOL`, the name of the currently selected file as1805 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1806 the head is detached, 'CUR_BRANCH' is empty).18071808guitool.<name>.needsFile::1809 Run the tool only if a diff is selected in the GUI. It guarantees1810 that 'FILENAME' is not empty.18111812guitool.<name>.noConsole::1813 Run the command silently, without creating a window to display its1814 output.18151816guitool.<name>.noRescan::1817 Don't rescan the working directory for changes after the tool1818 finishes execution.18191820guitool.<name>.confirm::1821 Show a confirmation dialog before actually running the tool.18221823guitool.<name>.argPrompt::1824 Request a string argument from the user, and pass it to the tool1825 through the `ARGS` environment variable. Since requesting an1826 argument implies confirmation, the 'confirm' option has no effect1827 if this is enabled. If the option is set to 'true', 'yes', or '1',1828 the dialog uses a built-in generic prompt; otherwise the exact1829 value of the variable is used.18301831guitool.<name>.revPrompt::1832 Request a single valid revision from the user, and set the1833 `REVISION` environment variable. In other aspects this option1834 is similar to 'argPrompt', and can be used together with it.18351836guitool.<name>.revUnmerged::1837 Show only unmerged branches in the 'revPrompt' subdialog.1838 This is useful for tools similar to merge or rebase, but not1839 for things like checkout or reset.18401841guitool.<name>.title::1842 Specifies the title to use for the prompt dialog. The default1843 is the tool name.18441845guitool.<name>.prompt::1846 Specifies the general prompt string to display at the top of1847 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1848 The default value includes the actual command.18491850help.browser::1851 Specify the browser that will be used to display help in the1852 'web' format. See linkgit:git-help[1].18531854help.format::1855 Override the default help format used by linkgit:git-help[1].1856 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1857 the default. 'web' and 'html' are the same.18581859help.autoCorrect::1860 Automatically correct and execute mistyped commands after1861 waiting for the given number of deciseconds (0.1 sec). If more1862 than one command can be deduced from the entered text, nothing1863 will be executed. If the value of this option is negative,1864 the corrected command will be executed immediately. If the1865 value is 0 - the command will be just shown but not executed.1866 This is the default.18671868help.htmlPath::1869 Specify the path where the HTML documentation resides. File system paths1870 and URLs are supported. HTML pages will be prefixed with this path when1871 help is displayed in the 'web' format. This defaults to the documentation1872 path of your Git installation.18731874http.proxy::1875 Override the HTTP proxy, normally configured using the 'http_proxy',1876 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1877 addition to the syntax understood by curl, it is possible to specify a1878 proxy string with a user name but no password, in which case git will1879 attempt to acquire one in the same way it does for other credentials. See1880 linkgit:gitcredentials[7] for more information. The syntax thus is1881 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1882 on a per-remote basis; see remote.<name>.proxy18831884http.proxyAuthMethod::1885 Set the method with which to authenticate against the HTTP proxy. This1886 only takes effect if the configured proxy string contains a user name part1887 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1888 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1889 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1890 variable. Possible values are:1891+1892--1893* `anyauth` - Automatically pick a suitable authentication method. It is1894 assumed that the proxy answers an unauthenticated request with a 4071895 status code and one or more Proxy-authenticate headers with supported1896 authentication methods. This is the default.1897* `basic` - HTTP Basic authentication1898* `digest` - HTTP Digest authentication; this prevents the password from being1899 transmitted to the proxy in clear text1900* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1901 of `curl(1)`)1902* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1903--19041905http.emptyAuth::1906 Attempt authentication without seeking a username or password. This1907 can be used to attempt GSS-Negotiate authentication without specifying1908 a username in the URL, as libcurl normally requires a username for1909 authentication.19101911http.delegation::1912 Control GSSAPI credential delegation. The delegation is disabled1913 by default in libcurl since version 7.21.7. Set parameter to tell1914 the server what it is allowed to delegate when it comes to user1915 credentials. Used with GSS/kerberos. Possible values are:1916+1917--1918* `none` - Don't allow any delegation.1919* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1920 Kerberos service ticket, which is a matter of realm policy.1921* `always` - Unconditionally allow the server to delegate.1922--192319241925http.extraHeader::1926 Pass an additional HTTP header when communicating with a server. If1927 more than one such entry exists, all of them are added as extra1928 headers. To allow overriding the settings inherited from the system1929 config, an empty value will reset the extra headers to the empty list.19301931http.cookieFile::1932 The pathname of a file containing previously stored cookie lines,1933 which should be used1934 in the Git http session, if they match the server. The file format1935 of the file to read cookies from should be plain HTTP headers or1936 the Netscape/Mozilla cookie file format (see `curl(1)`).1937 NOTE that the file specified with http.cookieFile is used only as1938 input unless http.saveCookies is set.19391940http.saveCookies::1941 If set, store cookies received during requests to the file specified by1942 http.cookieFile. Has no effect if http.cookieFile is unset.19431944http.sslVersion::1945 The SSL version to use when negotiating an SSL connection, if you1946 want to force the default. The available and default version1947 depend on whether libcurl was built against NSS or OpenSSL and the1948 particular configuration of the crypto library in use. Internally1949 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1950 documentation for more details on the format of this option and1951 for the ssl version supported. Actually the possible values of1952 this option are:19531954 - sslv21955 - sslv31956 - tlsv11957 - tlsv1.01958 - tlsv1.11959 - tlsv1.21960 - tlsv1.319611962+1963Can be overridden by the `GIT_SSL_VERSION` environment variable.1964To force git to use libcurl's default ssl version and ignore any1965explicit http.sslversion option, set `GIT_SSL_VERSION` to the1966empty string.19671968http.sslCipherList::1969 A list of SSL ciphers to use when negotiating an SSL connection.1970 The available ciphers depend on whether libcurl was built against1971 NSS or OpenSSL and the particular configuration of the crypto1972 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1973 option; see the libcurl documentation for more details on the format1974 of this list.1975+1976Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1977To force git to use libcurl's default cipher list and ignore any1978explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1979empty string.19801981http.sslVerify::1982 Whether to verify the SSL certificate when fetching or pushing1983 over HTTPS. Defaults to true. Can be overridden by the1984 `GIT_SSL_NO_VERIFY` environment variable.19851986http.sslCert::1987 File containing the SSL certificate when fetching or pushing1988 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1989 variable.19901991http.sslKey::1992 File containing the SSL private key when fetching or pushing1993 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1994 variable.19951996http.sslCertPasswordProtected::1997 Enable Git's password prompt for the SSL certificate. Otherwise1998 OpenSSL will prompt the user, possibly many times, if the1999 certificate or private key is encrypted. Can be overridden by the2000 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20012002http.sslCAInfo::2003 File containing the certificates to verify the peer with when2004 fetching or pushing over HTTPS. Can be overridden by the2005 `GIT_SSL_CAINFO` environment variable.20062007http.sslCAPath::2008 Path containing files with the CA certificates to verify the peer2009 with when fetching or pushing over HTTPS. Can be overridden2010 by the `GIT_SSL_CAPATH` environment variable.20112012http.pinnedpubkey::2013 Public key of the https service. It may either be the filename of2014 a PEM or DER encoded public key file or a string starting with2015 'sha256//' followed by the base64 encoded sha256 hash of the2016 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2017 exit with an error if this option is set but not supported by2018 cURL.20192020http.sslTry::2021 Attempt to use AUTH SSL/TLS and encrypted data transfers2022 when connecting via regular FTP protocol. This might be needed2023 if the FTP server requires it for security reasons or you wish2024 to connect securely whenever remote FTP server supports it.2025 Default is false since it might trigger certificate verification2026 errors on misconfigured servers.20272028http.maxRequests::2029 How many HTTP requests to launch in parallel. Can be overridden2030 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20312032http.minSessions::2033 The number of curl sessions (counted across slots) to be kept across2034 requests. They will not be ended with curl_easy_cleanup() until2035 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2036 value will be capped at 1. Defaults to 1.20372038http.postBuffer::2039 Maximum size in bytes of the buffer used by smart HTTP2040 transports when POSTing data to the remote system.2041 For requests larger than this buffer size, HTTP/1.1 and2042 Transfer-Encoding: chunked is used to avoid creating a2043 massive pack file locally. Default is 1 MiB, which is2044 sufficient for most requests.20452046http.lowSpeedLimit, http.lowSpeedTime::2047 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2048 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2049 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2050 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20512052http.noEPSV::2053 A boolean which disables using of EPSV ftp command by curl.2054 This can helpful with some "poor" ftp servers which don't2055 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2056 environment variable. Default is false (curl will use EPSV).20572058http.userAgent::2059 The HTTP USER_AGENT string presented to an HTTP server. The default2060 value represents the version of the client Git such as git/1.7.1.2061 This option allows you to override this value to a more common value2062 such as Mozilla/4.0. This may be necessary, for instance, if2063 connecting through a firewall that restricts HTTP connections to a set2064 of common USER_AGENT strings (but not including those like git/1.7.1).2065 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20662067http.followRedirects::2068 Whether git should follow HTTP redirects. If set to `true`, git2069 will transparently follow any redirect issued by a server it2070 encounters. If set to `false`, git will treat all redirects as2071 errors. If set to `initial`, git will follow redirects only for2072 the initial request to a remote, but not for subsequent2073 follow-up HTTP requests. Since git uses the redirected URL as2074 the base for the follow-up requests, this is generally2075 sufficient. The default is `initial`.20762077http.<url>.*::2078 Any of the http.* options above can be applied selectively to some URLs.2079 For a config key to match a URL, each element of the config key is2080 compared to that of the URL, in the following order:2081+2082--2083. Scheme (e.g., `https` in `https://example.com/`). This field2084 must match exactly between the config key and the URL.20852086. Host/domain name (e.g., `example.com` in `https://example.com/`).2087 This field must match between the config key and the URL. It is2088 possible to specify a `*` as part of the host name to match all subdomains2089 at this level. `https://*.example.com/` for example would match2090 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20912092. Port number (e.g., `8080` in `http://example.com:8080/`).2093 This field must match exactly between the config key and the URL.2094 Omitted port numbers are automatically converted to the correct2095 default for the scheme before matching.20962097. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2098 path field of the config key must match the path field of the URL2099 either exactly or as a prefix of slash-delimited path elements. This means2100 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2101 match on a slash (`/`) boundary. Longer matches take precedence (so a config2102 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2103 key with just path `foo/`).21042105. User name (e.g., `user` in `https://user@example.com/repo.git`). If2106 the config key has a user name it must match the user name in the2107 URL exactly. If the config key does not have a user name, that2108 config key will match a URL with any user name (including none),2109 but at a lower precedence than a config key with a user name.2110--2111+2112The list above is ordered by decreasing precedence; a URL that matches2113a config key's path is preferred to one that matches its user name. For example,2114if the URL is `https://user@example.com/foo/bar` a config key match of2115`https://example.com/foo` will be preferred over a config key match of2116`https://user@example.com`.2117+2118All URLs are normalized before attempting any matching (the password part,2119if embedded in the URL, is always ignored for matching purposes) so that2120equivalent URLs that are simply spelled differently will match properly.2121Environment variable settings always override any matches. The URLs that are2122matched against are those given directly to Git commands. This means any URLs2123visited as a result of a redirection do not participate in matching.21242125ssh.variant::2126 By default, Git determines the command line arguments to use2127 based on the basename of the configured SSH command (configured2128 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2129 the config setting `core.sshCommand`). If the basename is2130 unrecognized, Git will attempt to detect support of OpenSSH2131 options by first invoking the configured SSH command with the2132 `-G` (print configuration) option and will subsequently use2133 OpenSSH options (if that is successful) or no options besides2134 the host and remote command (if it fails).2135+2136The config variable `ssh.variant` can be set to override this detection.2137Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2138`tortoiseplink`, `simple` (no options except the host and remote command).2139The default auto-detection can be explicitly requested using the value2140`auto`. Any other value is treated as `ssh`. This setting can also be2141overridden via the environment variable `GIT_SSH_VARIANT`.2142+2143The current command-line parameters used for each variant are as2144follows:2145+2146--21472148* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21492150* `simple` - [username@]host command21512152* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21532154* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21552156--2157+2158Except for the `simple` variant, command-line parameters are likely to2159change as git gains new features.21602161i18n.commitEncoding::2162 Character encoding the commit messages are stored in; Git itself2163 does not care per se, but this information is necessary e.g. when2164 importing commits from emails or in the gitk graphical history2165 browser (and possibly at other places in the future or in other2166 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21672168i18n.logOutputEncoding::2169 Character encoding the commit messages are converted to when2170 running 'git log' and friends.21712172imap::2173 The configuration variables in the 'imap' section are described2174 in linkgit:git-imap-send[1].21752176index.version::2177 Specify the version with which new index files should be2178 initialized. This does not affect existing repositories.21792180init.templateDir::2181 Specify the directory from which templates will be copied.2182 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21832184instaweb.browser::2185 Specify the program that will be used to browse your working2186 repository in gitweb. See linkgit:git-instaweb[1].21872188instaweb.httpd::2189 The HTTP daemon command-line to start gitweb on your working2190 repository. See linkgit:git-instaweb[1].21912192instaweb.local::2193 If true the web server started by linkgit:git-instaweb[1] will2194 be bound to the local IP (127.0.0.1).21952196instaweb.modulePath::2197 The default module path for linkgit:git-instaweb[1] to use2198 instead of /usr/lib/apache2/modules. Only used if httpd2199 is Apache.22002201instaweb.port::2202 The port number to bind the gitweb httpd to. See2203 linkgit:git-instaweb[1].22042205interactive.singleKey::2206 In interactive commands, allow the user to provide one-letter2207 input with a single key (i.e., without hitting enter).2208 Currently this is used by the `--patch` mode of2209 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2210 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2211 setting is silently ignored if portable keystroke input2212 is not available; requires the Perl module Term::ReadKey.22132214interactive.diffFilter::2215 When an interactive command (such as `git add --patch`) shows2216 a colorized diff, git will pipe the diff through the shell2217 command defined by this configuration variable. The command may2218 mark up the diff further for human consumption, provided that it2219 retains a one-to-one correspondence with the lines in the2220 original diff. Defaults to disabled (no filtering).22212222log.abbrevCommit::2223 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2224 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2225 override this option with `--no-abbrev-commit`.22262227log.date::2228 Set the default date-time mode for the 'log' command.2229 Setting a value for log.date is similar to using 'git log''s2230 `--date` option. See linkgit:git-log[1] for details.22312232log.decorate::2233 Print out the ref names of any commits that are shown by the log2234 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2235 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2236 specified, the full ref name (including prefix) will be printed.2237 If 'auto' is specified, then if the output is going to a terminal,2238 the ref names are shown as if 'short' were given, otherwise no ref2239 names are shown. This is the same as the `--decorate` option2240 of the `git log`.22412242log.follow::2243 If `true`, `git log` will act as if the `--follow` option was used when2244 a single <path> is given. This has the same limitations as `--follow`,2245 i.e. it cannot be used to follow multiple files and does not work well2246 on non-linear history.22472248log.graphColors::2249 A list of colors, separated by commas, that can be used to draw2250 history lines in `git log --graph`.22512252log.showRoot::2253 If true, the initial commit will be shown as a big creation event.2254 This is equivalent to a diff against an empty tree.2255 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2256 normally hide the root commit will now show it. True by default.22572258log.showSignature::2259 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2260 linkgit:git-whatchanged[1] assume `--show-signature`.22612262log.mailmap::2263 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2264 linkgit:git-whatchanged[1] assume `--use-mailmap`.22652266mailinfo.scissors::2267 If true, makes linkgit:git-mailinfo[1] (and therefore2268 linkgit:git-am[1]) act by default as if the --scissors option2269 was provided on the command-line. When active, this features2270 removes everything from the message body before a scissors2271 line (i.e. consisting mainly of ">8", "8<" and "-").22722273mailmap.file::2274 The location of an augmenting mailmap file. The default2275 mailmap, located in the root of the repository, is loaded2276 first, then the mailmap file pointed to by this variable.2277 The location of the mailmap file may be in a repository2278 subdirectory, or somewhere outside of the repository itself.2279 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22802281mailmap.blob::2282 Like `mailmap.file`, but consider the value as a reference to a2283 blob in the repository. If both `mailmap.file` and2284 `mailmap.blob` are given, both are parsed, with entries from2285 `mailmap.file` taking precedence. In a bare repository, this2286 defaults to `HEAD:.mailmap`. In a non-bare repository, it2287 defaults to empty.22882289man.viewer::2290 Specify the programs that may be used to display help in the2291 'man' format. See linkgit:git-help[1].22922293man.<tool>.cmd::2294 Specify the command to invoke the specified man viewer. The2295 specified command is evaluated in shell with the man page2296 passed as argument. (See linkgit:git-help[1].)22972298man.<tool>.path::2299 Override the path for the given tool that may be used to2300 display help in the 'man' format. See linkgit:git-help[1].23012302include::merge-config.txt[]23032304mergetool.<tool>.path::2305 Override the path for the given tool. This is useful in case2306 your tool is not in the PATH.23072308mergetool.<tool>.cmd::2309 Specify the command to invoke the specified merge tool. The2310 specified command is evaluated in shell with the following2311 variables available: 'BASE' is the name of a temporary file2312 containing the common base of the files to be merged, if available;2313 'LOCAL' is the name of a temporary file containing the contents of2314 the file on the current branch; 'REMOTE' is the name of a temporary2315 file containing the contents of the file from the branch being2316 merged; 'MERGED' contains the name of the file to which the merge2317 tool should write the results of a successful merge.23182319mergetool.<tool>.trustExitCode::2320 For a custom merge command, specify whether the exit code of2321 the merge command can be used to determine whether the merge was2322 successful. If this is not set to true then the merge target file2323 timestamp is checked and the merge assumed to have been successful2324 if the file has been updated, otherwise the user is prompted to2325 indicate the success of the merge.23262327mergetool.meld.hasOutput::2328 Older versions of `meld` do not support the `--output` option.2329 Git will attempt to detect whether `meld` supports `--output`2330 by inspecting the output of `meld --help`. Configuring2331 `mergetool.meld.hasOutput` will make Git skip these checks and2332 use the configured value instead. Setting `mergetool.meld.hasOutput`2333 to `true` tells Git to unconditionally use the `--output` option,2334 and `false` avoids using `--output`.23352336mergetool.keepBackup::2337 After performing a merge, the original file with conflict markers2338 can be saved as a file with a `.orig` extension. If this variable2339 is set to `false` then this file is not preserved. Defaults to2340 `true` (i.e. keep the backup files).23412342mergetool.keepTemporaries::2343 When invoking a custom merge tool, Git uses a set of temporary2344 files to pass to the tool. If the tool returns an error and this2345 variable is set to `true`, then these temporary files will be2346 preserved, otherwise they will be removed after the tool has2347 exited. Defaults to `false`.23482349mergetool.writeToTemp::2350 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2351 conflicting files in the worktree by default. Git will attempt2352 to use a temporary directory for these files when set `true`.2353 Defaults to `false`.23542355mergetool.prompt::2356 Prompt before each invocation of the merge resolution program.23572358notes.mergeStrategy::2359 Which merge strategy to choose by default when resolving notes2360 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2361 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2362 section of linkgit:git-notes[1] for more information on each strategy.23632364notes.<name>.mergeStrategy::2365 Which merge strategy to choose when doing a notes merge into2366 refs/notes/<name>. This overrides the more general2367 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2368 linkgit:git-notes[1] for more information on the available strategies.23692370notes.displayRef::2371 The (fully qualified) refname from which to show notes when2372 showing commit messages. The value of this variable can be set2373 to a glob, in which case notes from all matching refs will be2374 shown. You may also specify this configuration variable2375 several times. A warning will be issued for refs that do not2376 exist, but a glob that does not match any refs is silently2377 ignored.2378+2379This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2380environment variable, which must be a colon separated list of refs or2381globs.2382+2383The effective value of "core.notesRef" (possibly overridden by2384GIT_NOTES_REF) is also implicitly added to the list of refs to be2385displayed.23862387notes.rewrite.<command>::2388 When rewriting commits with <command> (currently `amend` or2389 `rebase`) and this variable is set to `true`, Git2390 automatically copies your notes from the original to the2391 rewritten commit. Defaults to `true`, but see2392 "notes.rewriteRef" below.23932394notes.rewriteMode::2395 When copying notes during a rewrite (see the2396 "notes.rewrite.<command>" option), determines what to do if2397 the target commit already has a note. Must be one of2398 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2399 Defaults to `concatenate`.2400+2401This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2402environment variable.24032404notes.rewriteRef::2405 When copying notes during a rewrite, specifies the (fully2406 qualified) ref whose notes should be copied. The ref may be a2407 glob, in which case notes in all matching refs will be copied.2408 You may also specify this configuration several times.2409+2410Does not have a default value; you must configure this variable to2411enable note rewriting. Set it to `refs/notes/commits` to enable2412rewriting for the default commit notes.2413+2414This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2415environment variable, which must be a colon separated list of refs or2416globs.24172418pack.window::2419 The size of the window used by linkgit:git-pack-objects[1] when no2420 window size is given on the command line. Defaults to 10.24212422pack.depth::2423 The maximum delta depth used by linkgit:git-pack-objects[1] when no2424 maximum depth is given on the command line. Defaults to 50.24252426pack.windowMemory::2427 The maximum size of memory that is consumed by each thread2428 in linkgit:git-pack-objects[1] for pack window memory when2429 no limit is given on the command line. The value can be2430 suffixed with "k", "m", or "g". When left unconfigured (or2431 set explicitly to 0), there will be no limit.24322433pack.compression::2434 An integer -1..9, indicating the compression level for objects2435 in a pack file. -1 is the zlib default. 0 means no2436 compression, and 1..9 are various speed/size tradeoffs, 9 being2437 slowest. If not set, defaults to core.compression. If that is2438 not set, defaults to -1, the zlib default, which is "a default2439 compromise between speed and compression (currently equivalent2440 to level 6)."2441+2442Note that changing the compression level will not automatically recompress2443all existing objects. You can force recompression by passing the -F option2444to linkgit:git-repack[1].24452446pack.deltaCacheSize::2447 The maximum memory in bytes used for caching deltas in2448 linkgit:git-pack-objects[1] before writing them out to a pack.2449 This cache is used to speed up the writing object phase by not2450 having to recompute the final delta result once the best match2451 for all objects is found. Repacking large repositories on machines2452 which are tight with memory might be badly impacted by this though,2453 especially if this cache pushes the system into swapping.2454 A value of 0 means no limit. The smallest size of 1 byte may be2455 used to virtually disable this cache. Defaults to 256 MiB.24562457pack.deltaCacheLimit::2458 The maximum size of a delta, that is cached in2459 linkgit:git-pack-objects[1]. This cache is used to speed up the2460 writing object phase by not having to recompute the final delta2461 result once the best match for all objects is found. Defaults to 1000.24622463pack.threads::2464 Specifies the number of threads to spawn when searching for best2465 delta matches. This requires that linkgit:git-pack-objects[1]2466 be compiled with pthreads otherwise this option is ignored with a2467 warning. This is meant to reduce packing time on multiprocessor2468 machines. The required amount of memory for the delta search window2469 is however multiplied by the number of threads.2470 Specifying 0 will cause Git to auto-detect the number of CPU's2471 and set the number of threads accordingly.24722473pack.indexVersion::2474 Specify the default pack index version. Valid values are 1 for2475 legacy pack index used by Git versions prior to 1.5.2, and 2 for2476 the new pack index with capabilities for packs larger than 4 GB2477 as well as proper protection against the repacking of corrupted2478 packs. Version 2 is the default. Note that version 2 is enforced2479 and this config option ignored whenever the corresponding pack is2480 larger than 2 GB.2481+2482If you have an old Git that does not understand the version 2 `*.idx` file,2483cloning or fetching over a non native protocol (e.g. "http")2484that will copy both `*.pack` file and corresponding `*.idx` file from the2485other side may give you a repository that cannot be accessed with your2486older version of Git. If the `*.pack` file is smaller than 2 GB, however,2487you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2488the `*.idx` file.24892490pack.packSizeLimit::2491 The maximum size of a pack. This setting only affects2492 packing to a file when repacking, i.e. the git:// protocol2493 is unaffected. It can be overridden by the `--max-pack-size`2494 option of linkgit:git-repack[1]. Reaching this limit results2495 in the creation of multiple packfiles; which in turn prevents2496 bitmaps from being created.2497 The minimum size allowed is limited to 1 MiB.2498 The default is unlimited.2499 Common unit suffixes of 'k', 'm', or 'g' are2500 supported.25012502pack.useBitmaps::2503 When true, git will use pack bitmaps (if available) when packing2504 to stdout (e.g., during the server side of a fetch). Defaults to2505 true. You should not generally need to turn this off unless2506 you are debugging pack bitmaps.25072508pack.writeBitmaps (deprecated)::2509 This is a deprecated synonym for `repack.writeBitmaps`.25102511pack.writeBitmapHashCache::2512 When true, git will include a "hash cache" section in the bitmap2513 index (if one is written). This cache can be used to feed git's2514 delta heuristics, potentially leading to better deltas between2515 bitmapped and non-bitmapped objects (e.g., when serving a fetch2516 between an older, bitmapped pack and objects that have been2517 pushed since the last gc). The downside is that it consumes 42518 bytes per object of disk space, and that JGit's bitmap2519 implementation does not understand it, causing it to complain if2520 Git and JGit are used on the same repository. Defaults to false.25212522pager.<cmd>::2523 If the value is boolean, turns on or off pagination of the2524 output of a particular Git subcommand when writing to a tty.2525 Otherwise, turns on pagination for the subcommand using the2526 pager specified by the value of `pager.<cmd>`. If `--paginate`2527 or `--no-pager` is specified on the command line, it takes2528 precedence over this option. To disable pagination for all2529 commands, set `core.pager` or `GIT_PAGER` to `cat`.25302531pretty.<name>::2532 Alias for a --pretty= format string, as specified in2533 linkgit:git-log[1]. Any aliases defined here can be used just2534 as the built-in pretty formats could. For example,2535 running `git config pretty.changelog "format:* %H %s"`2536 would cause the invocation `git log --pretty=changelog`2537 to be equivalent to running `git log "--pretty=format:* %H %s"`.2538 Note that an alias with the same name as a built-in format2539 will be silently ignored.25402541protocol.allow::2542 If set, provide a user defined default policy for all protocols which2543 don't explicitly have a policy (`protocol.<name>.allow`). By default,2544 if unset, known-safe protocols (http, https, git, ssh, file) have a2545 default policy of `always`, known-dangerous protocols (ext) have a2546 default policy of `never`, and all other protocols have a default2547 policy of `user`. Supported policies:2548+2549--25502551* `always` - protocol is always able to be used.25522553* `never` - protocol is never able to be used.25542555* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2556 either unset or has a value of 1. This policy should be used when you want a2557 protocol to be directly usable by the user but don't want it used by commands which2558 execute clone/fetch/push commands without user input, e.g. recursive2559 submodule initialization.25602561--25622563protocol.<name>.allow::2564 Set a policy to be used by protocol `<name>` with clone/fetch/push2565 commands. See `protocol.allow` above for the available policies.2566+2567The protocol names currently used by git are:2568+2569--2570 - `file`: any local file-based path (including `file://` URLs,2571 or local paths)25722573 - `git`: the anonymous git protocol over a direct TCP2574 connection (or proxy, if configured)25752576 - `ssh`: git over ssh (including `host:path` syntax,2577 `ssh://`, etc).25782579 - `http`: git over http, both "smart http" and "dumb http".2580 Note that this does _not_ include `https`; if you want to configure2581 both, you must do so individually.25822583 - any external helpers are named by their protocol (e.g., use2584 `hg` to allow the `git-remote-hg` helper)2585--25862587protocol.version::2588 Experimental. If set, clients will attempt to communicate with a2589 server using the specified protocol version. If unset, no2590 attempt will be made by the client to communicate using a2591 particular protocol version, this results in protocol version 02592 being used.2593 Supported versions:2594+2595--25962597* `0` - the original wire protocol.25982599* `1` - the original wire protocol with the addition of a version string2600 in the initial response from the server.26012602--26032604pull.ff::2605 By default, Git does not create an extra merge commit when merging2606 a commit that is a descendant of the current commit. Instead, the2607 tip of the current branch is fast-forwarded. When set to `false`,2608 this variable tells Git to create an extra merge commit in such2609 a case (equivalent to giving the `--no-ff` option from the command2610 line). When set to `only`, only such fast-forward merges are2611 allowed (equivalent to giving the `--ff-only` option from the2612 command line). This setting overrides `merge.ff` when pulling.26132614pull.rebase::2615 When true, rebase branches on top of the fetched branch, instead2616 of merging the default branch from the default remote when "git2617 pull" is run. See "branch.<name>.rebase" for setting this on a2618 per-branch basis.2619+2620When preserve, also pass `--preserve-merges` along to 'git rebase'2621so that locally committed merge commits will not be flattened2622by running 'git pull'.2623+2624When the value is `interactive`, the rebase is run in interactive mode.2625+2626*NOTE*: this is a possibly dangerous operation; do *not* use2627it unless you understand the implications (see linkgit:git-rebase[1]2628for details).26292630pull.octopus::2631 The default merge strategy to use when pulling multiple branches2632 at once.26332634pull.twohead::2635 The default merge strategy to use when pulling a single branch.26362637push.default::2638 Defines the action `git push` should take if no refspec is2639 explicitly given. Different values are well-suited for2640 specific workflows; for instance, in a purely central workflow2641 (i.e. the fetch source is equal to the push destination),2642 `upstream` is probably what you want. Possible values are:2643+2644--26452646* `nothing` - do not push anything (error out) unless a refspec is2647 explicitly given. This is primarily meant for people who want to2648 avoid mistakes by always being explicit.26492650* `current` - push the current branch to update a branch with the same2651 name on the receiving end. Works in both central and non-central2652 workflows.26532654* `upstream` - push the current branch back to the branch whose2655 changes are usually integrated into the current branch (which is2656 called `@{upstream}`). This mode only makes sense if you are2657 pushing to the same repository you would normally pull from2658 (i.e. central workflow).26592660* `tracking` - This is a deprecated synonym for `upstream`.26612662* `simple` - in centralized workflow, work like `upstream` with an2663 added safety to refuse to push if the upstream branch's name is2664 different from the local one.2665+2666When pushing to a remote that is different from the remote you normally2667pull from, work as `current`. This is the safest option and is suited2668for beginners.2669+2670This mode has become the default in Git 2.0.26712672* `matching` - push all branches having the same name on both ends.2673 This makes the repository you are pushing to remember the set of2674 branches that will be pushed out (e.g. if you always push 'maint'2675 and 'master' there and no other branches, the repository you push2676 to will have these two branches, and your local 'maint' and2677 'master' will be pushed there).2678+2679To use this mode effectively, you have to make sure _all_ the2680branches you would push out are ready to be pushed out before2681running 'git push', as the whole point of this mode is to allow you2682to push all of the branches in one go. If you usually finish work2683on only one branch and push out the result, while other branches are2684unfinished, this mode is not for you. Also this mode is not2685suitable for pushing into a shared central repository, as other2686people may add new branches there, or update the tip of existing2687branches outside your control.2688+2689This used to be the default, but not since Git 2.0 (`simple` is the2690new default).26912692--26932694push.followTags::2695 If set to true enable `--follow-tags` option by default. You2696 may override this configuration at time of push by specifying2697 `--no-follow-tags`.26982699push.gpgSign::2700 May be set to a boolean value, or the string 'if-asked'. A true2701 value causes all pushes to be GPG signed, as if `--signed` is2702 passed to linkgit:git-push[1]. The string 'if-asked' causes2703 pushes to be signed if the server supports it, as if2704 `--signed=if-asked` is passed to 'git push'. A false value may2705 override a value from a lower-priority config file. An explicit2706 command-line flag always overrides this config option.27072708push.pushOption::2709 When no `--push-option=<option>` argument is given from the2710 command line, `git push` behaves as if each <value> of2711 this variable is given as `--push-option=<value>`.2712+2713This is a multi-valued variable, and an empty value can be used in a2714higher priority configuration file (e.g. `.git/config` in a2715repository) to clear the values inherited from a lower priority2716configuration files (e.g. `$HOME/.gitconfig`).2717+2718--27192720Example:27212722/etc/gitconfig2723 push.pushoption = a2724 push.pushoption = b27252726~/.gitconfig2727 push.pushoption = c27282729repo/.git/config2730 push.pushoption =2731 push.pushoption = b27322733This will result in only b (a and c are cleared).27342735--27362737push.recurseSubmodules::2738 Make sure all submodule commits used by the revisions to be pushed2739 are available on a remote-tracking branch. If the value is 'check'2740 then Git will verify that all submodule commits that changed in the2741 revisions to be pushed are available on at least one remote of the2742 submodule. If any commits are missing, the push will be aborted and2743 exit with non-zero status. If the value is 'on-demand' then all2744 submodules that changed in the revisions to be pushed will be2745 pushed. If on-demand was not able to push all necessary revisions2746 it will also be aborted and exit with non-zero status. If the value2747 is 'no' then default behavior of ignoring submodules when pushing2748 is retained. You may override this configuration at time of push by2749 specifying '--recurse-submodules=check|on-demand|no'.27502751include::rebase-config.txt[]27522753receive.advertiseAtomic::2754 By default, git-receive-pack will advertise the atomic push2755 capability to its clients. If you don't want to advertise this2756 capability, set this variable to false.27572758receive.advertisePushOptions::2759 When set to true, git-receive-pack will advertise the push options2760 capability to its clients. False by default.27612762receive.autogc::2763 By default, git-receive-pack will run "git-gc --auto" after2764 receiving data from git-push and updating refs. You can stop2765 it by setting this variable to false.27662767receive.certNonceSeed::2768 By setting this variable to a string, `git receive-pack`2769 will accept a `git push --signed` and verifies it by using2770 a "nonce" protected by HMAC using this string as a secret2771 key.27722773receive.certNonceSlop::2774 When a `git push --signed` sent a push certificate with a2775 "nonce" that was issued by a receive-pack serving the same2776 repository within this many seconds, export the "nonce"2777 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2778 hooks (instead of what the receive-pack asked the sending2779 side to include). This may allow writing checks in2780 `pre-receive` and `post-receive` a bit easier. Instead of2781 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2782 that records by how many seconds the nonce is stale to2783 decide if they want to accept the certificate, they only2784 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27852786receive.fsckObjects::2787 If it is set to true, git-receive-pack will check all received2788 objects. It will abort in the case of a malformed object or a2789 broken link. The result of an abort are only dangling objects.2790 Defaults to false. If not set, the value of `transfer.fsckObjects`2791 is used instead.27922793receive.fsck.<msg-id>::2794 When `receive.fsckObjects` is set to true, errors can be switched2795 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2796 setting where the `<msg-id>` is the fsck message ID and the value2797 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2798 the error/warning with the message ID, e.g. "missingEmail: invalid2799 author/committer line - missing email" means that setting2800 `receive.fsck.missingEmail = ignore` will hide that issue.2801+2802This feature is intended to support working with legacy repositories2803which would not pass pushing when `receive.fsckObjects = true`, allowing2804the host to accept repositories with certain known issues but still catch2805other issues.28062807receive.fsck.skipList::2808 The path to a sorted list of object names (i.e. one SHA-1 per2809 line) that are known to be broken in a non-fatal way and should2810 be ignored. This feature is useful when an established project2811 should be accepted despite early commits containing errors that2812 can be safely ignored such as invalid committer email addresses.2813 Note: corrupt objects cannot be skipped with this setting.28142815receive.keepAlive::2816 After receiving the pack from the client, `receive-pack` may2817 produce no output (if `--quiet` was specified) while processing2818 the pack, causing some networks to drop the TCP connection.2819 With this option set, if `receive-pack` does not transmit2820 any data in this phase for `receive.keepAlive` seconds, it will2821 send a short keepalive packet. The default is 5 seconds; set2822 to 0 to disable keepalives entirely.28232824receive.unpackLimit::2825 If the number of objects received in a push is below this2826 limit then the objects will be unpacked into loose object2827 files. However if the number of received objects equals or2828 exceeds this limit then the received pack will be stored as2829 a pack, after adding any missing delta bases. Storing the2830 pack from a push can make the push operation complete faster,2831 especially on slow filesystems. If not set, the value of2832 `transfer.unpackLimit` is used instead.28332834receive.maxInputSize::2835 If the size of the incoming pack stream is larger than this2836 limit, then git-receive-pack will error out, instead of2837 accepting the pack file. If not set or set to 0, then the size2838 is unlimited.28392840receive.denyDeletes::2841 If set to true, git-receive-pack will deny a ref update that deletes2842 the ref. Use this to prevent such a ref deletion via a push.28432844receive.denyDeleteCurrent::2845 If set to true, git-receive-pack will deny a ref update that2846 deletes the currently checked out branch of a non-bare repository.28472848receive.denyCurrentBranch::2849 If set to true or "refuse", git-receive-pack will deny a ref update2850 to the currently checked out branch of a non-bare repository.2851 Such a push is potentially dangerous because it brings the HEAD2852 out of sync with the index and working tree. If set to "warn",2853 print a warning of such a push to stderr, but allow the push to2854 proceed. If set to false or "ignore", allow such pushes with no2855 message. Defaults to "refuse".2856+2857Another option is "updateInstead" which will update the working2858tree if pushing into the current branch. This option is2859intended for synchronizing working directories when one side is not easily2860accessible via interactive ssh (e.g. a live web site, hence the requirement2861that the working directory be clean). This mode also comes in handy when2862developing inside a VM to test and fix code on different Operating Systems.2863+2864By default, "updateInstead" will refuse the push if the working tree or2865the index have any difference from the HEAD, but the `push-to-checkout`2866hook can be used to customize this. See linkgit:githooks[5].28672868receive.denyNonFastForwards::2869 If set to true, git-receive-pack will deny a ref update which is2870 not a fast-forward. Use this to prevent such an update via a push,2871 even if that push is forced. This configuration variable is2872 set when initializing a shared repository.28732874receive.hideRefs::2875 This variable is the same as `transfer.hideRefs`, but applies2876 only to `receive-pack` (and so affects pushes, but not fetches).2877 An attempt to update or delete a hidden ref by `git push` is2878 rejected.28792880receive.updateServerInfo::2881 If set to true, git-receive-pack will run git-update-server-info2882 after receiving data from git-push and updating refs.28832884receive.shallowUpdate::2885 If set to true, .git/shallow can be updated when new refs2886 require new shallow roots. Otherwise those refs are rejected.28872888remote.pushDefault::2889 The remote to push to by default. Overrides2890 `branch.<name>.remote` for all branches, and is overridden by2891 `branch.<name>.pushRemote` for specific branches.28922893remote.<name>.url::2894 The URL of a remote repository. See linkgit:git-fetch[1] or2895 linkgit:git-push[1].28962897remote.<name>.pushurl::2898 The push URL of a remote repository. See linkgit:git-push[1].28992900remote.<name>.proxy::2901 For remotes that require curl (http, https and ftp), the URL to2902 the proxy to use for that remote. Set to the empty string to2903 disable proxying for that remote.29042905remote.<name>.proxyAuthMethod::2906 For remotes that require curl (http, https and ftp), the method to use for2907 authenticating against the proxy in use (probably set in2908 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29092910remote.<name>.fetch::2911 The default set of "refspec" for linkgit:git-fetch[1]. See2912 linkgit:git-fetch[1].29132914remote.<name>.push::2915 The default set of "refspec" for linkgit:git-push[1]. See2916 linkgit:git-push[1].29172918remote.<name>.mirror::2919 If true, pushing to this remote will automatically behave2920 as if the `--mirror` option was given on the command line.29212922remote.<name>.skipDefaultUpdate::2923 If true, this remote will be skipped by default when updating2924 using linkgit:git-fetch[1] or the `update` subcommand of2925 linkgit:git-remote[1].29262927remote.<name>.skipFetchAll::2928 If true, this remote will be skipped by default when updating2929 using linkgit:git-fetch[1] or the `update` subcommand of2930 linkgit:git-remote[1].29312932remote.<name>.receivepack::2933 The default program to execute on the remote side when pushing. See2934 option --receive-pack of linkgit:git-push[1].29352936remote.<name>.uploadpack::2937 The default program to execute on the remote side when fetching. See2938 option --upload-pack of linkgit:git-fetch-pack[1].29392940remote.<name>.tagOpt::2941 Setting this value to --no-tags disables automatic tag following when2942 fetching from remote <name>. Setting it to --tags will fetch every2943 tag from remote <name>, even if they are not reachable from remote2944 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2945 override this setting. See options --tags and --no-tags of2946 linkgit:git-fetch[1].29472948remote.<name>.vcs::2949 Setting this to a value <vcs> will cause Git to interact with2950 the remote with the git-remote-<vcs> helper.29512952remote.<name>.prune::2953 When set to true, fetching from this remote by default will also2954 remove any remote-tracking references that no longer exist on the2955 remote (as if the `--prune` option was given on the command line).2956 Overrides `fetch.prune` settings, if any.29572958remote.<name>.pruneTags::2959 When set to true, fetching from this remote by default will also2960 remove any local tags that no longer exist on the remote if pruning2961 is activated in general via `remote.<name>.prune`, `fetch.prune` or2962 `--prune`. Overrides `fetch.pruneTags` settings, if any.2963+2964See also `remote.<name>.prune` and the PRUNING section of2965linkgit:git-fetch[1].29662967remotes.<group>::2968 The list of remotes which are fetched by "git remote update2969 <group>". See linkgit:git-remote[1].29702971repack.useDeltaBaseOffset::2972 By default, linkgit:git-repack[1] creates packs that use2973 delta-base offset. If you need to share your repository with2974 Git older than version 1.4.4, either directly or via a dumb2975 protocol such as http, then you need to set this option to2976 "false" and repack. Access from old Git versions over the2977 native protocol are unaffected by this option.29782979repack.packKeptObjects::2980 If set to true, makes `git repack` act as if2981 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2982 details. Defaults to `false` normally, but `true` if a bitmap2983 index is being written (either via `--write-bitmap-index` or2984 `repack.writeBitmaps`).29852986repack.writeBitmaps::2987 When true, git will write a bitmap index when packing all2988 objects to disk (e.g., when `git repack -a` is run). This2989 index can speed up the "counting objects" phase of subsequent2990 packs created for clones and fetches, at the cost of some disk2991 space and extra time spent on the initial repack. This has2992 no effect if multiple packfiles are created.2993 Defaults to false.29942995rerere.autoUpdate::2996 When set to true, `git-rerere` updates the index with the2997 resulting contents after it cleanly resolves conflicts using2998 previously recorded resolution. Defaults to false.29993000rerere.enabled::3001 Activate recording of resolved conflicts, so that identical3002 conflict hunks can be resolved automatically, should they be3003 encountered again. By default, linkgit:git-rerere[1] is3004 enabled if there is an `rr-cache` directory under the3005 `$GIT_DIR`, e.g. if "rerere" was previously used in the3006 repository.30073008sendemail.identity::3009 A configuration identity. When given, causes values in the3010 'sendemail.<identity>' subsection to take precedence over3011 values in the 'sendemail' section. The default identity is3012 the value of `sendemail.identity`.30133014sendemail.smtpEncryption::3015 See linkgit:git-send-email[1] for description. Note that this3016 setting is not subject to the 'identity' mechanism.30173018sendemail.smtpssl (deprecated)::3019 Deprecated alias for 'sendemail.smtpEncryption = ssl'.30203021sendemail.smtpsslcertpath::3022 Path to ca-certificates (either a directory or a single file).3023 Set it to an empty string to disable certificate verification.30243025sendemail.<identity>.*::3026 Identity-specific versions of the 'sendemail.*' parameters3027 found below, taking precedence over those when this3028 identity is selected, through either the command-line or3029 `sendemail.identity`.30303031sendemail.aliasesFile::3032sendemail.aliasFileType::3033sendemail.annotate::3034sendemail.bcc::3035sendemail.cc::3036sendemail.ccCmd::3037sendemail.chainReplyTo::3038sendemail.confirm::3039sendemail.envelopeSender::3040sendemail.from::3041sendemail.multiEdit::3042sendemail.signedoffbycc::3043sendemail.smtpPass::3044sendemail.suppresscc::3045sendemail.suppressFrom::3046sendemail.to::3047sendemail.tocmd::3048sendemail.smtpDomain::3049sendemail.smtpServer::3050sendemail.smtpServerPort::3051sendemail.smtpServerOption::3052sendemail.smtpUser::3053sendemail.thread::3054sendemail.transferEncoding::3055sendemail.validate::3056sendemail.xmailer::3057 See linkgit:git-send-email[1] for description.30583059sendemail.signedoffcc (deprecated)::3060 Deprecated alias for `sendemail.signedoffbycc`.30613062sendemail.smtpBatchSize::3063 Number of messages to be sent per connection, after that a relogin3064 will happen. If the value is 0 or undefined, send all messages in3065 one connection.3066 See also the `--batch-size` option of linkgit:git-send-email[1].30673068sendemail.smtpReloginDelay::3069 Seconds wait before reconnecting to smtp server.3070 See also the `--relogin-delay` option of linkgit:git-send-email[1].30713072showbranch.default::3073 The default set of branches for linkgit:git-show-branch[1].3074 See linkgit:git-show-branch[1].30753076splitIndex.maxPercentChange::3077 When the split index feature is used, this specifies the3078 percent of entries the split index can contain compared to the3079 total number of entries in both the split index and the shared3080 index before a new shared index is written.3081 The value should be between 0 and 100. If the value is 0 then3082 a new shared index is always written, if it is 100 a new3083 shared index is never written.3084 By default the value is 20, so a new shared index is written3085 if the number of entries in the split index would be greater3086 than 20 percent of the total number of entries.3087 See linkgit:git-update-index[1].30883089splitIndex.sharedIndexExpire::3090 When the split index feature is used, shared index files that3091 were not modified since the time this variable specifies will3092 be removed when a new shared index file is created. The value3093 "now" expires all entries immediately, and "never" suppresses3094 expiration altogether.3095 The default value is "2.weeks.ago".3096 Note that a shared index file is considered modified (for the3097 purpose of expiration) each time a new split-index file is3098 either created based on it or read from it.3099 See linkgit:git-update-index[1].31003101status.relativePaths::3102 By default, linkgit:git-status[1] shows paths relative to the3103 current directory. Setting this variable to `false` shows paths3104 relative to the repository root (this was the default for Git3105 prior to v1.5.4).31063107status.short::3108 Set to true to enable --short by default in linkgit:git-status[1].3109 The option --no-short takes precedence over this variable.31103111status.branch::3112 Set to true to enable --branch by default in linkgit:git-status[1].3113 The option --no-branch takes precedence over this variable.31143115status.displayCommentPrefix::3116 If set to true, linkgit:git-status[1] will insert a comment3117 prefix before each output line (starting with3118 `core.commentChar`, i.e. `#` by default). This was the3119 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3120 Defaults to false.31213122status.showStash::3123 If set to true, linkgit:git-status[1] will display the number of3124 entries currently stashed away.3125 Defaults to false.31263127status.showUntrackedFiles::3128 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3129 files which are not currently tracked by Git. Directories which3130 contain only untracked files, are shown with the directory name3131 only. Showing untracked files means that Git needs to lstat() all3132 the files in the whole repository, which might be slow on some3133 systems. So, this variable controls how the commands displays3134 the untracked files. Possible values are:3135+3136--3137* `no` - Show no untracked files.3138* `normal` - Show untracked files and directories.3139* `all` - Show also individual files in untracked directories.3140--3141+3142If this variable is not specified, it defaults to 'normal'.3143This variable can be overridden with the -u|--untracked-files option3144of linkgit:git-status[1] and linkgit:git-commit[1].31453146status.submoduleSummary::3147 Defaults to false.3148 If this is set to a non zero number or true (identical to -1 or an3149 unlimited number), the submodule summary will be enabled and a3150 summary of commits for modified submodules will be shown (see3151 --summary-limit option of linkgit:git-submodule[1]). Please note3152 that the summary output command will be suppressed for all3153 submodules when `diff.ignoreSubmodules` is set to 'all' or only3154 for those submodules where `submodule.<name>.ignore=all`. The only3155 exception to that rule is that status and commit will show staged3156 submodule changes. To3157 also view the summary for ignored submodules you can either use3158 the --ignore-submodules=dirty command-line option or the 'git3159 submodule summary' command, which shows a similar output but does3160 not honor these settings.31613162stash.showPatch::3163 If this is set to true, the `git stash show` command without an3164 option will show the stash entry in patch form. Defaults to false.3165 See description of 'show' command in linkgit:git-stash[1].31663167stash.showStat::3168 If this is set to true, the `git stash show` command without an3169 option will show diffstat of the stash entry. Defaults to true.3170 See description of 'show' command in linkgit:git-stash[1].31713172submodule.<name>.url::3173 The URL for a submodule. This variable is copied from the .gitmodules3174 file to the git config via 'git submodule init'. The user can change3175 the configured URL before obtaining the submodule via 'git submodule3176 update'. If neither submodule.<name>.active or submodule.active are3177 set, the presence of this variable is used as a fallback to indicate3178 whether the submodule is of interest to git commands.3179 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31803181submodule.<name>.update::3182 The method by which a submodule is updated by 'git submodule update',3183 which is the only affected command, others such as3184 'git checkout --recurse-submodules' are unaffected. It exists for3185 historical reasons, when 'git submodule' was the only command to3186 interact with submodules; settings like `submodule.active`3187 and `pull.rebase` are more specific. It is populated by3188 `git submodule init` from the linkgit:gitmodules[5] file.3189 See description of 'update' command in linkgit:git-submodule[1].31903191submodule.<name>.branch::3192 The remote branch name for a submodule, used by `git submodule3193 update --remote`. Set this option to override the value found in3194 the `.gitmodules` file. See linkgit:git-submodule[1] and3195 linkgit:gitmodules[5] for details.31963197submodule.<name>.fetchRecurseSubmodules::3198 This option can be used to control recursive fetching of this3199 submodule. It can be overridden by using the --[no-]recurse-submodules3200 command-line option to "git fetch" and "git pull".3201 This setting will override that from in the linkgit:gitmodules[5]3202 file.32033204submodule.<name>.ignore::3205 Defines under what circumstances "git status" and the diff family show3206 a submodule as modified. When set to "all", it will never be considered3207 modified (but it will nonetheless show up in the output of status and3208 commit when it has been staged), "dirty" will ignore all changes3209 to the submodules work tree and3210 takes only differences between the HEAD of the submodule and the commit3211 recorded in the superproject into account. "untracked" will additionally3212 let submodules with modified tracked files in their work tree show up.3213 Using "none" (the default when this option is not set) also shows3214 submodules that have untracked files in their work tree as changed.3215 This setting overrides any setting made in .gitmodules for this submodule,3216 both settings can be overridden on the command line by using the3217 "--ignore-submodules" option. The 'git submodule' commands are not3218 affected by this setting.32193220submodule.<name>.active::3221 Boolean value indicating if the submodule is of interest to git3222 commands. This config option takes precedence over the3223 submodule.active config option.32243225submodule.active::3226 A repeated field which contains a pathspec used to match against a3227 submodule's path to determine if the submodule is of interest to git3228 commands.32293230submodule.recurse::3231 Specifies if commands recurse into submodules by default. This3232 applies to all commands that have a `--recurse-submodules` option,3233 except `clone`.3234 Defaults to false.32353236submodule.fetchJobs::3237 Specifies how many submodules are fetched/cloned at the same time.3238 A positive integer allows up to that number of submodules fetched3239 in parallel. A value of 0 will give some reasonable default.3240 If unset, it defaults to 1.32413242submodule.alternateLocation::3243 Specifies how the submodules obtain alternates when submodules are3244 cloned. Possible values are `no`, `superproject`.3245 By default `no` is assumed, which doesn't add references. When the3246 value is set to `superproject` the submodule to be cloned computes3247 its alternates location relative to the superprojects alternate.32483249submodule.alternateErrorStrategy::3250 Specifies how to treat errors with the alternates for a submodule3251 as computed via `submodule.alternateLocation`. Possible values are3252 `ignore`, `info`, `die`. Default is `die`.32533254tag.forceSignAnnotated::3255 A boolean to specify whether annotated tags created should be GPG signed.3256 If `--annotate` is specified on the command line, it takes3257 precedence over this option.32583259tag.sort::3260 This variable controls the sort ordering of tags when displayed by3261 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3262 value of this variable will be used as the default.32633264tar.umask::3265 This variable can be used to restrict the permission bits of3266 tar archive entries. The default is 0002, which turns off the3267 world write bit. The special value "user" indicates that the3268 archiving user's umask will be used instead. See umask(2) and3269 linkgit:git-archive[1].32703271transfer.fsckObjects::3272 When `fetch.fsckObjects` or `receive.fsckObjects` are3273 not set, the value of this variable is used instead.3274 Defaults to false.32753276transfer.hideRefs::3277 String(s) `receive-pack` and `upload-pack` use to decide which3278 refs to omit from their initial advertisements. Use more than3279 one definition to specify multiple prefix strings. A ref that is3280 under the hierarchies listed in the value of this variable is3281 excluded, and is hidden when responding to `git push` or `git3282 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3283 program-specific versions of this config.3284+3285You may also include a `!` in front of the ref name to negate the entry,3286explicitly exposing it, even if an earlier entry marked it as hidden.3287If you have multiple hideRefs values, later entries override earlier ones3288(and entries in more-specific config files override less-specific ones).3289+3290If a namespace is in use, the namespace prefix is stripped from each3291reference before it is matched against `transfer.hiderefs` patterns.3292For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3293the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3294is omitted from the advertisements but `refs/heads/master` and3295`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3296"have" lines. In order to match refs before stripping, add a `^` in front of3297the ref name. If you combine `!` and `^`, `!` must be specified first.3298+3299Even if you hide refs, a client may still be able to steal the target3300objects via the techniques described in the "SECURITY" section of the3301linkgit:gitnamespaces[7] man page; it's best to keep private data in a3302separate repository.33033304transfer.unpackLimit::3305 When `fetch.unpackLimit` or `receive.unpackLimit` are3306 not set, the value of this variable is used instead.3307 The default value is 100.33083309uploadarchive.allowUnreachable::3310 If true, allow clients to use `git archive --remote` to request3311 any tree, whether reachable from the ref tips or not. See the3312 discussion in the "SECURITY" section of3313 linkgit:git-upload-archive[1] for more details. Defaults to3314 `false`.33153316uploadpack.hideRefs::3317 This variable is the same as `transfer.hideRefs`, but applies3318 only to `upload-pack` (and so affects only fetches, not pushes).3319 An attempt to fetch a hidden ref by `git fetch` will fail. See3320 also `uploadpack.allowTipSHA1InWant`.33213322uploadpack.allowTipSHA1InWant::3323 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3324 to accept a fetch request that asks for an object at the tip3325 of a hidden ref (by default, such a request is rejected).3326 See also `uploadpack.hideRefs`. Even if this is false, a client3327 may be able to steal objects via the techniques described in the3328 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3329 best to keep private data in a separate repository.33303331uploadpack.allowReachableSHA1InWant::3332 Allow `upload-pack` to accept a fetch request that asks for an3333 object that is reachable from any ref tip. However, note that3334 calculating object reachability is computationally expensive.3335 Defaults to `false`. Even if this is false, a client may be able3336 to steal objects via the techniques described in the "SECURITY"3337 section of the linkgit:gitnamespaces[7] man page; it's best to3338 keep private data in a separate repository.33393340uploadpack.allowAnySHA1InWant::3341 Allow `upload-pack` to accept a fetch request that asks for any3342 object at all.3343 Defaults to `false`.33443345uploadpack.keepAlive::3346 When `upload-pack` has started `pack-objects`, there may be a3347 quiet period while `pack-objects` prepares the pack. Normally3348 it would output progress information, but if `--quiet` was used3349 for the fetch, `pack-objects` will output nothing at all until3350 the pack data begins. Some clients and networks may consider3351 the server to be hung and give up. Setting this option instructs3352 `upload-pack` to send an empty keepalive packet every3353 `uploadpack.keepAlive` seconds. Setting this option to 03354 disables keepalive packets entirely. The default is 5 seconds.33553356uploadpack.packObjectsHook::3357 If this option is set, when `upload-pack` would run3358 `git pack-objects` to create a packfile for a client, it will3359 run this shell command instead. The `pack-objects` command and3360 arguments it _would_ have run (including the `git pack-objects`3361 at the beginning) are appended to the shell command. The stdin3362 and stdout of the hook are treated as if `pack-objects` itself3363 was run. I.e., `upload-pack` will feed input intended for3364 `pack-objects` to the hook, and expects a completed packfile on3365 stdout.33663367uploadpack.allowFilter::3368 If this option is set, `upload-pack` will support partial3369 clone and partial fetch object filtering.3370+3371Note that this configuration variable is ignored if it is seen in the3372repository-level config (this is a safety measure against fetching from3373untrusted repositories).33743375url.<base>.insteadOf::3376 Any URL that starts with this value will be rewritten to3377 start, instead, with <base>. In cases where some site serves a3378 large number of repositories, and serves them with multiple3379 access methods, and some users need to use different access3380 methods, this feature allows people to specify any of the3381 equivalent URLs and have Git automatically rewrite the URL to3382 the best alternative for the particular user, even for a3383 never-before-seen repository on the site. When more than one3384 insteadOf strings match a given URL, the longest match is used.3385+3386Note that any protocol restrictions will be applied to the rewritten3387URL. If the rewrite changes the URL to use a custom protocol or remote3388helper, you may need to adjust the `protocol.*.allow` config to permit3389the request. In particular, protocols you expect to use for submodules3390must be set to `always` rather than the default of `user`. See the3391description of `protocol.allow` above.33923393url.<base>.pushInsteadOf::3394 Any URL that starts with this value will not be pushed to;3395 instead, it will be rewritten to start with <base>, and the3396 resulting URL will be pushed to. In cases where some site serves3397 a large number of repositories, and serves them with multiple3398 access methods, some of which do not allow push, this feature3399 allows people to specify a pull-only URL and have Git3400 automatically use an appropriate URL to push, even for a3401 never-before-seen repository on the site. When more than one3402 pushInsteadOf strings match a given URL, the longest match is3403 used. If a remote has an explicit pushurl, Git will ignore this3404 setting for that remote.34053406user.email::3407 Your email address to be recorded in any newly created commits.3408 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3409 `EMAIL` environment variables. See linkgit:git-commit-tree[1].34103411user.name::3412 Your full name to be recorded in any newly created commits.3413 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3414 environment variables. See linkgit:git-commit-tree[1].34153416user.useConfigOnly::3417 Instruct Git to avoid trying to guess defaults for `user.email`3418 and `user.name`, and instead retrieve the values only from the3419 configuration. For example, if you have multiple email addresses3420 and would like to use a different one for each repository, then3421 with this configuration option set to `true` in the global config3422 along with a name, Git will prompt you to set up an email before3423 making new commits in a newly cloned repository.3424 Defaults to `false`.34253426user.signingKey::3427 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3428 key you want it to automatically when creating a signed tag or3429 commit, you can override the default selection with this variable.3430 This option is passed unchanged to gpg's --local-user parameter,3431 so you may specify a key using any method that gpg supports.34323433versionsort.prereleaseSuffix (deprecated)::3434 Deprecated alias for `versionsort.suffix`. Ignored if3435 `versionsort.suffix` is set.34363437versionsort.suffix::3438 Even when version sort is used in linkgit:git-tag[1], tagnames3439 with the same base version but different suffixes are still sorted3440 lexicographically, resulting e.g. in prerelease tags appearing3441 after the main release (e.g. "1.0-rc1" after "1.0"). This3442 variable can be specified to determine the sorting order of tags3443 with different suffixes.3444+3445By specifying a single suffix in this variable, any tagname containing3446that suffix will appear before the corresponding main release. E.g. if3447the variable is set to "-rc", then all "1.0-rcX" tags will appear before3448"1.0". If specified multiple times, once per suffix, then the order of3449suffixes in the configuration will determine the sorting order of tagnames3450with those suffixes. E.g. if "-pre" appears before "-rc" in the3451configuration, then all "1.0-preX" tags will be listed before any3452"1.0-rcX" tags. The placement of the main release tag relative to tags3453with various suffixes can be determined by specifying the empty suffix3454among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3455"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3456are listed first, followed by "v4.8", then "v4.8-ckX" and finally3457"v4.8-bfsX".3458+3459If more than one suffixes match the same tagname, then that tagname will3460be sorted according to the suffix which starts at the earliest position in3461the tagname. If more than one different matching suffixes start at3462that earliest position, then that tagname will be sorted according to the3463longest of those suffixes.3464The sorting order between different suffixes is undefined if they are3465in multiple config files.34663467web.browser::3468 Specify a web browser that may be used by some commands.3469 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3470 may use it.34713472worktree.guessRemote::3473 With `add`, if no branch argument, and neither of `-b` nor3474 `-B` nor `--detach` are given, the command defaults to3475 creating a new branch from HEAD. If `worktree.guessRemote` is3476 set to true, `worktree add` tries to find a remote-tracking3477 branch whose name uniquely matches the new branch name. If3478 such a branch exists, it is checked out and set as "upstream"3479 for the new branch. If no such match can be found, it falls3480 back to creating a new branch from the current HEAD.